From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-3.0 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 569A3C072B5 for ; Tue, 21 May 2019 21:17:29 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 27E9A2182B for ; Tue, 21 May 2019 21:17:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727838AbfEUVR2 (ORCPT ); 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 Content-Transfer-Encoding: 8bit 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