From patchwork Fri Jun 7 15:39:41 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Greg Kroah-Hartman X-Patchwork-Id: 166165 Delivered-To: patch@linaro.org Received: by 2002:a92:9e1a:0:0:0:0:0 with SMTP id q26csp803173ili; Fri, 7 Jun 2019 08:49:26 -0700 (PDT) X-Google-Smtp-Source: APXvYqzOZ9A0K7P3k/ewwkcrA/aqFAvHh5LU606Jryw3cg7KdDPD+i+82DTiZ+8SMJxTFDHXE9DK X-Received: by 2002:a63:7e43:: with SMTP id o3mr3470362pgn.450.1559922566702; Fri, 07 Jun 2019 08:49:26 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1559922566; cv=none; d=google.com; s=arc-20160816; b=Dwcv1sC+TKD9ON/zxHu7Y3WPIazX2b1wt1ARtkM6JOPrPW4K8qITk5O1OMyHmWRkb8 nFcDUrfhN3ABtqBnnuAAj2C/rWTEHpN9aGwhivj3RXFAwGfM/8Zv5fTg7QfWGN2rfqWi whnAg7po8hNzTiMI1PxLR7IFsX4/BIbVZHSBQM4B405BPLjUI9CiAUMDpRrlyQBEZkER TJye8qPJ/k/OymLHEhOGtJT1YqWleMHD8Mjhby3fqThdnUpxrOG6AcJCYlWIGUhJeLSi 914erVkUOFEOeIGy9tnGb9vz6qzBtb6lqZcS4gHBiU2sOMenAFH2RgX8hspmhQ+M6kFv ddnQ== 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 :user-agent:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=Dx+xx4M2UTtoUNae+utChSz46p8ENhfOC+gJr/9qCqM=; b=y3fQvNstIhh5co64aGBDcVgFM29SqlWFQRUNCxJQCKEDhZ9BfYDakUD+fEVf/WKBGK 93TJRmvXR8CPnWODo8udkwwtqEXPE7HZroIm27fxWJK1yYJrZ5W+KciE68MgqAyWOAg4 BAgwq6yRK59uqp7j8W+FIpbpseKsqXIPY7aUkJbaHOjz+c2iCL51MaLLiK9tWelW5qfJ LHBffdmz8RbkTAPvQbGvxyVdh9ZpBKXxkg5p1GEDB1h8QWQB1GyHFOZw+UiUbn4jG8BP l9z31KysuqWYzaMRDoNmr+jGsLmmqdG9ra4usq/fJiZQ98KpI8Vlre1u/m7Ln3fggcEd o2kA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b=ftwywd6o; 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 v9si2074187pgs.312.2019.06.07.08.49.26; Fri, 07 Jun 2019 08:49:26 -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; dkim=pass header.i=@kernel.org header.s=default header.b=ftwywd6o; 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 S1731953AbfFGPtZ (ORCPT + 30 others); Fri, 7 Jun 2019 11:49:25 -0400 Received: from mail.kernel.org ([198.145.29.99]:35276 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1731937AbfFGPtX (ORCPT ); Fri, 7 Jun 2019 11:49:23 -0400 Received: from localhost (83-86-89-107.cable.dynamic.v4.ziggo.nl [83.86.89.107]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id B6557214C6; Fri, 7 Jun 2019 15:49:21 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1559922562; bh=W6EXKwO2WLwrLah4By7DIUZSSEhhHmOZCXmMzKqlDxo=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=ftwywd6o58e5lUzPgj9PtmnbSAEuCuYQXEcdkGhZksoSv2HKGdeDZYt3aYRmT7Xco UHDq8NJixtv7S+YvzunvyXXH1XNrUAR2xoGEhNT4gbdoaCZQ3+H0c7AtDGh/q79UVR wkkSFXIh7WmnuhMM57uDhmWiUQiyUdNEG4KhVjmk= From: Greg Kroah-Hartman To: linux-kernel@vger.kernel.org Cc: Greg Kroah-Hartman , stable@vger.kernel.org, Jonathan Corbet Subject: [PATCH 5.1 56/85] doc: Cope with the deprecation of AutoReporter Date: Fri, 7 Jun 2019 17:39:41 +0200 Message-Id: <20190607153855.717899507@linuxfoundation.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190607153849.101321647@linuxfoundation.org> References: <20190607153849.101321647@linuxfoundation.org> User-Agent: quilt/0.66 MIME-Version: 1.0 Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Jonathan Corbet commit 2404dad1f67f8917e30fc22a85e0dbcc85b99955 upstream. AutoReporter is going away; recent versions of sphinx emit a warning like: Documentation/sphinx/kerneldoc.py:125: RemovedInSphinx20Warning: AutodocReporter is now deprecated. Use sphinx.util.docutils.switch_source_input() instead. Make the switch. But switch_source_input() only showed up in 1.7, so we have to do ugly version checks to keep things working in older versions. Cc: stable@vger.kernel.org Signed-off-by: Jonathan Corbet Signed-off-by: Greg Kroah-Hartman --- Documentation/sphinx/kerneldoc.py | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) --- a/Documentation/sphinx/kerneldoc.py +++ b/Documentation/sphinx/kerneldoc.py @@ -37,7 +37,17 @@ import glob from docutils import nodes, statemachine from docutils.statemachine import ViewList from docutils.parsers.rst import directives, Directive -from sphinx.ext.autodoc import AutodocReporter + +# +# AutodocReporter is only good up to Sphinx 1.7 +# +import sphinx + +Use_SSI = sphinx.__version__[:3] >= '1.7' +if Use_SSI: + from sphinx.util.docutils import switch_source_input +else: + from sphinx.ext.autodoc import AutodocReporter __version__ = '1.0' @@ -121,13 +131,7 @@ class KernelDocDirective(Directive): lineoffset += 1 node = nodes.section() - buf = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter - self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter) - self.state.memo.title_styles, self.state.memo.section_level = [], 0 - try: - self.state.nested_parse(result, 0, node, match_titles=1) - finally: - self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = buf + self.do_parse(result, node) return node.children @@ -136,6 +140,20 @@ class KernelDocDirective(Directive): (" ".join(cmd), str(e))) return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] + def do_parse(self, result, node): + if Use_SSI: + with switch_source_input(self.state, result): + self.state.nested_parse(result, 0, node, match_titles=1) + else: + save = self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter + self.state.memo.reporter = AutodocReporter(result, self.state.memo.reporter) + self.state.memo.title_styles, self.state.memo.section_level = [], 0 + try: + self.state.nested_parse(result, 0, node, match_titles=1) + finally: + self.state.memo.title_styles, self.state.memo.section_level, self.state.memo.reporter = save + + def setup(app): app.add_config_value('kerneldoc_bin', None, 'env') app.add_config_value('kerneldoc_srctree', None, 'env')