From patchwork Tue May 21 21:17:12 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 164747 Delivered-To: patch@linaro.org Received: by 2002:a92:9e1a:0:0:0:0:0 with SMTP id q26csp53778ili; Tue, 21 May 2019 14:17:29 -0700 (PDT) X-Google-Smtp-Source: APXvYqxoZ6kyianjsv+4sUJw10ONZw9y35XV/nywpZJPArXjrzFcNkQqM7SoUpIrHheWJGf3fgG6 X-Received: by 2002:a17:902:2d:: with SMTP id 42mr86922711pla.34.1558473449195; Tue, 21 May 2019 14:17:29 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1558473449; cv=none; d=google.com; s=arc-20160816; b=y66aNpHiZEgQpiDXJSdyZQAoeDSaPQWoI1cJUUdgFDa4mhKsXx2bcHuUwj43T7FfWN QzmAiHU5BgOR38EtegQteUcUEmgc+YQtEMkZCQAzXfCBXduvWJgBkZnYF/gTvj1+c13f RmzTWU+0wtrQX10FggNzcjRhp4QeS57qhHZD5RjX7h4vW9NQbodlbLOfyeYPrRRi0pmO 2KgtWSrD8q9yUFcaSUIv9gMhYhcN7omg1oHvL32lO8rWE/9N7xZ44eOCadBcfxpCpwPH Fw5ut4U6JcDRW1Nwhvxgrx+yKOJsflrOt5IF7QtFdeWpmzFrvRU54jXYV8DL4YwEFaGB Nu9g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from; bh=weXISG8K/ufGGeqrQZ/EGbvpauLjGOdEmbXc32VIvxc=; b=0yjMJY4r/yJSmIZSliEXOwLuWoz9fUMl8d+ExszTpORgTS8QM7X22n4OQMSILSx9FV Gv2gOCqfJiZl2VENHzF5D7kpdAZb+7onEn7Jlbk7V7P9uB7f04pLyAYJ6wcEyjvRpIR2 vpBU808+wFrHNVRdWl1CB97ktvMHQZKwQqJm36RuJYpN4MbAWSwqhFu5e2GqmMcjQA1y QRgCrhYtv+ZpE95BCCGm/SkKNtzVEa34uagjPsPRM377TFW6xqRRwmqjjBdlmvOrI2q+ UFqA9yRfzHqyChFiR2AQCQ0GFSh64KMxRccov3ah1cbqQMoxC3gyTmqlrMq3qwBDfjm1 xTQw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id 129si14300580pfe.140.2019.05.21.14.17.28; Tue, 21 May 2019 14:17:29 -0700 (PDT) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727838AbfEUVR2 (ORCPT + 30 others); Tue, 21 May 2019 17:17:28 -0400 Received: from ms.lwn.net ([45.79.88.28]:42952 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726907AbfEUVR1 (ORCPT ); Tue, 21 May 2019 17:17:27 -0400 Received: from meer.lwn.net (localhost [127.0.0.1]) by ms.lwn.net (Postfix) with ESMTPA id 09C8A6D9; Tue, 21 May 2019 21:17:27 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Jani Nikula , Markus Heiser , Mauro Carvalho Chehab , Jonathan Corbet Subject: [PATCH RFC 0/2] docs: Deal with some Sphinx deprecation warnings Date: Tue, 21 May 2019 15:17:12 -0600 Message-Id: <20190521211714.1395-1-corbet@lwn.net> X-Mailer: git-send-email 2.21.0 MIME-Version: 1.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org The Sphinx folks are deprecating some interfaces in the upcoming 2.0 release; one immediate result of that is a bunch of warnings that show up when building with 1.8. These two patches make those warnings go away, but at a cost: - It introduces a couple of Sphinx version checks, which are always ugly, but the alternative would be to stop supporting versions before 1.7. For now, I think we can carry that cruft. - The second patch causes the build to fail horribly on newer Sphinx installations. The change to switch_source_input() seems to make the parser much more finicky, increasing warnings and eventually failing the build altogether. In particular, it will scream about problems in .rst files that are not included in the TOC tree at all. The complaints appear to be legitimate, but it's a bunch of stuff to clean up. I've tested these with 1.4 and 1.8, but not various versions in between. Jonathan Corbet (2): doc: Cope with Sphinx logging deprecations doc: Cope with the deprecation of AutoReporter Documentation/sphinx/kerneldoc.py | 48 ++++++++++++++++++++++++------- Documentation/sphinx/kernellog.py | 28 ++++++++++++++++++ Documentation/sphinx/kfigure.py | 38 +++++++++++++----------- 3 files changed, 87 insertions(+), 27 deletions(-) create mode 100644 Documentation/sphinx/kernellog.py -- 2.21.0 Signed-off-by: Mauro Carvalho Chehab