From patchwork Fri Jun 7 15:39:34 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: 166170 Delivered-To: patch@linaro.org Received: by 2002:a92:9e1a:0:0:0:0:0 with SMTP id q26csp813452ili; Fri, 7 Jun 2019 08:58:46 -0700 (PDT) X-Google-Smtp-Source: APXvYqxDv2UfgaBhjaATFm37zoev492elahMHGsT68nnkuWD0bWdPOZrfJnz0WN404DLeKGk55iW X-Received: by 2002:a17:90a:cb97:: with SMTP id a23mr6147516pju.67.1559923126319; Fri, 07 Jun 2019 08:58:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1559923126; cv=none; d=google.com; s=arc-20160816; b=IlKGC5VYaOGwlKdn9gQpbMaB0hTI5cT7XlPAPxkYoxzE/VTmszJYso0hr057O+5fLQ fk9K3vs/x+oHIGKU/8G/lOedYFDrcbHezz9t4AfoK7OvITr1y/7KQx6GsRtg2QV+aisq Ve0p76qyBTUxT8mBczNpBOcEdj2zcTGZy/cGZDSQSAqL8GiJeJ/KVeWovuINLaSbo36s +L15LybBDzmnXRbhce5I6Q8ffL8oqMVDQfmcZCVOypchQMaiNcUP4KNECQwdeY8nQ89y QwCnb7XJPNsveLxUfVW9SdZwa/O1gJhMTpX/8bat/478joY12vw478ukoqbyXcFQ5Huw B8Ig== 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=9TKJWUo9fsrCabcjKTsQlEz/tNSaaXeHqfHT3Zq/wYE=; b=gNbewepFREBeaWE8kUH0XUX8mALn5MZ1DHNOkygvNUiU/ickk1sIJMjvE8lo1lNj8H lfGSlF7u3g2oerGOb/sW2zrwEFaa3SeKhswmexRqjw4UB9flM4MMXVq1xJFvR2nVaoOQ XWgtHOSOev7ESQ5I8bbEJKcpls9KhYuV44L0GkQUi6HYqms/ZVS3ecyJNTGn1cJ3gF5/ sg61ZqFsZuApVQ9pD8whZvYnF8F/2RPjKVDNjr7o7FoQ+pyAcnAbl/THXC1OpzegvhVb mn6QqWgGfK8etfIdu2pX+IAeaWZwOJGaB8FeXX9ZdVWiy/BcYFsi8iAak/TL+9UQI1Vn 6Vcg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=default header.b="hT72/HQY"; 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 b24si2051535pfd.156.2019.06.07.08.58.46; Fri, 07 Jun 2019 08:58:46 -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="hT72/HQY"; 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 S1730579AbfFGPm2 (ORCPT + 30 others); Fri, 7 Jun 2019 11:42:28 -0400 Received: from mail.kernel.org ([198.145.29.99]:53066 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730561AbfFGPmZ (ORCPT ); Fri, 7 Jun 2019 11:42:25 -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 02E162147A; Fri, 7 Jun 2019 15:42:23 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1559922144; bh=Mk5P4fya3KDDGfujSsNIgINShNzGSC6TdI4Mp4kjOcc=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=hT72/HQYU8RzCOYfsRNUECSnZ2QlV+FAevqlXOVNWajyv512lNbzx6KQU3oTOP4yJ hxIRBbz25s0eXsQ2tmKZT/G5MNM913VDPC85GpbHH78V+9Fy9Ydf+OsM36xeVQ8x8I QqrI/nP0A6W1SDC4zbz4YyyzMCv8m/1Ax+5vqYBk= From: Greg Kroah-Hartman To: linux-kernel@vger.kernel.org Cc: Greg Kroah-Hartman , stable@vger.kernel.org, Jonathan Corbet Subject: [PATCH 4.14 53/69] doc: Cope with the deprecation of AutoReporter Date: Fri, 7 Jun 2019 17:39:34 +0200 Message-Id: <20190607153854.768374834@linuxfoundation.org> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190607153848.271562617@linuxfoundation.org> References: <20190607153848.271562617@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' @@ -117,13 +127,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 @@ -132,6 +136,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')