diff options
author | Paul Gortmaker <paul.gortmaker@windriver.com> | 2019-09-10 15:21:27 -0400 |
---|---|---|
committer | Paul Gortmaker <paul.gortmaker@windriver.com> | 2019-09-10 15:21:27 -0400 |
commit | ff1cad11710053a54f7d4562c4f82c5b0f4dc86f (patch) | |
tree | 0523641f0c071d3c9a499d3a5af9a751dea5a9ce | |
parent | 29736ccb06e3c20f4f295b847ca02c09e4e96b5e (diff) | |
download | longterm-queue-4.18-ff1cad11710053a54f7d4562c4f82c5b0f4dc86f.tar.gz |
doc: drop sphinx changes n/a for 4.18
Signed-off-by: Paul Gortmaker <paul.gortmaker@windriver.com>
-rw-r--r-- | queue/doc-Cope-with-Sphinx-logging-deprecations.patch | 228 | ||||
-rw-r--r-- | queue/doc-Cope-with-the-deprecation-of-AutoReporter.patch | 81 | ||||
-rw-r--r-- | queue/docs-Fix-conf.py-for-Sphinx-2.0.patch | 30 | ||||
-rw-r--r-- | queue/series | 3 |
4 files changed, 0 insertions, 342 deletions
diff --git a/queue/doc-Cope-with-Sphinx-logging-deprecations.patch b/queue/doc-Cope-with-Sphinx-logging-deprecations.patch deleted file mode 100644 index 34cadbb..0000000 --- a/queue/doc-Cope-with-Sphinx-logging-deprecations.patch +++ /dev/null @@ -1,228 +0,0 @@ -From 096ea522e84ea68f8e6c41e5e7294731a81e29bc Mon Sep 17 00:00:00 2001 -From: Jonathan Corbet <corbet@lwn.net> -Date: Tue, 21 May 2019 14:23:43 -0600 -Subject: [PATCH] doc: Cope with Sphinx logging deprecations - -commit 096ea522e84ea68f8e6c41e5e7294731a81e29bc upstream. - -Recent versions of sphinx will emit messages like: - - Documentation/sphinx/kerneldoc.py:103: - RemovedInSphinx20Warning: app.warning() is now deprecated. - Use sphinx.util.logging instead. - -Switch to sphinx.util.logging to make this unsightly message go away. -Alas, that interface was only added in version 1.6, so we have to add a -version check to keep things working with older sphinxes. - -Cc: stable@vger.kernel.org -Signed-off-by: Jonathan Corbet <corbet@lwn.net> - -diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py -index 9d0a7f08f93b..200c8aa4a04f 100644 ---- a/Documentation/sphinx/kerneldoc.py -+++ b/Documentation/sphinx/kerneldoc.py -@@ -39,6 +39,8 @@ from docutils.statemachine import ViewList - from docutils.parsers.rst import directives, Directive - from sphinx.ext.autodoc import AutodocReporter - -+import kernellog -+ - __version__ = '1.0' - - class KernelDocDirective(Directive): -@@ -90,7 +92,8 @@ class KernelDocDirective(Directive): - cmd += [filename] - - try: -- env.app.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd))) -+ kernellog.verbose(env.app, -+ 'calling kernel-doc \'%s\'' % (" ".join(cmd))) - - p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE) - out, err = p.communicate() -@@ -100,7 +103,8 @@ class KernelDocDirective(Directive): - if p.returncode != 0: - sys.stderr.write(err) - -- env.app.warn('kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode)) -+ kernellog.warn(env.app, -+ 'kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode)) - return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] - elif env.config.kerneldoc_verbosity > 0: - sys.stderr.write(err) -@@ -132,8 +136,8 @@ class KernelDocDirective(Directive): - return node.children - - except Exception as e: # pylint: disable=W0703 -- env.app.warn('kernel-doc \'%s\' processing failed with: %s' % -- (" ".join(cmd), str(e))) -+ kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: %s' % -+ (" ".join(cmd), str(e))) - return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] - - def setup(app): -diff --git a/Documentation/sphinx/kernellog.py b/Documentation/sphinx/kernellog.py -new file mode 100644 -index 000000000000..af924f51a7dc ---- /dev/null -+++ b/Documentation/sphinx/kernellog.py -@@ -0,0 +1,28 @@ -+# SPDX-License-Identifier: GPL-2.0 -+# -+# Sphinx has deprecated its older logging interface, but the replacement -+# only goes back to 1.6. So here's a wrapper layer to keep around for -+# as long as we support 1.4. -+# -+import sphinx -+ -+if sphinx.__version__[:3] >= '1.6': -+ UseLogging = True -+ from sphinx.util import logging -+ logger = logging.getLogger('kerneldoc') -+else: -+ UseLogging = False -+ -+def warn(app, message): -+ if UseLogging: -+ logger.warning(message) -+ else: -+ app.warn(message) -+ -+def verbose(app, message): -+ if UseLogging: -+ logger.verbose(message) -+ else: -+ app.verbose(message) -+ -+ -diff --git a/Documentation/sphinx/kfigure.py b/Documentation/sphinx/kfigure.py -index b97228d2cc0e..fbfe6693bb60 100644 ---- a/Documentation/sphinx/kfigure.py -+++ b/Documentation/sphinx/kfigure.py -@@ -60,6 +60,8 @@ import sphinx - from sphinx.util.nodes import clean_astext - from six import iteritems - -+import kernellog -+ - PY3 = sys.version_info[0] == 3 - - if PY3: -@@ -171,20 +173,20 @@ def setupTools(app): - This function is called once, when the builder is initiated. - """ - global dot_cmd, convert_cmd # pylint: disable=W0603 -- app.verbose("kfigure: check installed tools ...") -+ kernellog.verbose(app, "kfigure: check installed tools ...") - - dot_cmd = which('dot') - convert_cmd = which('convert') - - if dot_cmd: -- app.verbose("use dot(1) from: " + dot_cmd) -+ kernellog.verbose(app, "use dot(1) from: " + dot_cmd) - else: -- app.warn("dot(1) not found, for better output quality install " -- "graphviz from http://www.graphviz.org") -+ kernellog.warn(app, "dot(1) not found, for better output quality install " -+ "graphviz from http://www.graphviz.org") - if convert_cmd: -- app.verbose("use convert(1) from: " + convert_cmd) -+ kernellog.verbose(app, "use convert(1) from: " + convert_cmd) - else: -- app.warn( -+ kernellog.warn(app, - "convert(1) not found, for SVG to PDF conversion install " - "ImageMagick (https://www.imagemagick.org)") - -@@ -220,12 +222,13 @@ def convert_image(img_node, translator, src_fname=None): - - # in kernel builds, use 'make SPHINXOPTS=-v' to see verbose messages - -- app.verbose('assert best format for: ' + img_node['uri']) -+ kernellog.verbose(app, 'assert best format for: ' + img_node['uri']) - - if in_ext == '.dot': - - if not dot_cmd: -- app.verbose("dot from graphviz not available / include DOT raw.") -+ kernellog.verbose(app, -+ "dot from graphviz not available / include DOT raw.") - img_node.replace_self(file2literal(src_fname)) - - elif translator.builder.format == 'latex': -@@ -252,7 +255,8 @@ def convert_image(img_node, translator, src_fname=None): - - if translator.builder.format == 'latex': - if convert_cmd is None: -- app.verbose("no SVG to PDF conversion available / include SVG raw.") -+ kernellog.verbose(app, -+ "no SVG to PDF conversion available / include SVG raw.") - img_node.replace_self(file2literal(src_fname)) - else: - dst_fname = path.join(translator.builder.outdir, fname + '.pdf') -@@ -265,18 +269,19 @@ def convert_image(img_node, translator, src_fname=None): - _name = dst_fname[len(translator.builder.outdir) + 1:] - - if isNewer(dst_fname, src_fname): -- app.verbose("convert: {out}/%s already exists and is newer" % _name) -+ kernellog.verbose(app, -+ "convert: {out}/%s already exists and is newer" % _name) - - else: - ok = False - mkdir(path.dirname(dst_fname)) - - if in_ext == '.dot': -- app.verbose('convert DOT to: {out}/' + _name) -+ kernellog.verbose(app, 'convert DOT to: {out}/' + _name) - ok = dot2format(app, src_fname, dst_fname) - - elif in_ext == '.svg': -- app.verbose('convert SVG to: {out}/' + _name) -+ kernellog.verbose(app, 'convert SVG to: {out}/' + _name) - ok = svg2pdf(app, src_fname, dst_fname) - - if not ok: -@@ -305,7 +310,8 @@ def dot2format(app, dot_fname, out_fname): - with open(out_fname, "w") as out: - exit_code = subprocess.call(cmd, stdout = out) - if exit_code != 0: -- app.warn("Error #%d when calling: %s" % (exit_code, " ".join(cmd))) -+ kernellog.warn(app, -+ "Error #%d when calling: %s" % (exit_code, " ".join(cmd))) - return bool(exit_code == 0) - - def svg2pdf(app, svg_fname, pdf_fname): -@@ -322,7 +328,7 @@ def svg2pdf(app, svg_fname, pdf_fname): - # use stdout and stderr from parent - exit_code = subprocess.call(cmd) - if exit_code != 0: -- app.warn("Error #%d when calling: %s" % (exit_code, " ".join(cmd))) -+ kernellog.warn(app, "Error #%d when calling: %s" % (exit_code, " ".join(cmd))) - return bool(exit_code == 0) - - -@@ -415,15 +421,15 @@ def visit_kernel_render(self, node): - app = self.builder.app - srclang = node.get('srclang') - -- app.verbose('visit kernel-render node lang: "%s"' % (srclang)) -+ kernellog.verbose(app, 'visit kernel-render node lang: "%s"' % (srclang)) - - tmp_ext = RENDER_MARKUP_EXT.get(srclang, None) - if tmp_ext is None: -- app.warn('kernel-render: "%s" unknown / include raw.' % (srclang)) -+ kernellog.warn(app, 'kernel-render: "%s" unknown / include raw.' % (srclang)) - return - - if not dot_cmd and tmp_ext == '.dot': -- app.verbose("dot from graphviz not available / include raw.") -+ kernellog.verbose(app, "dot from graphviz not available / include raw.") - return - - literal_block = node[0] --- -2.9.5 - diff --git a/queue/doc-Cope-with-the-deprecation-of-AutoReporter.patch b/queue/doc-Cope-with-the-deprecation-of-AutoReporter.patch deleted file mode 100644 index 6f85b00..0000000 --- a/queue/doc-Cope-with-the-deprecation-of-AutoReporter.patch +++ /dev/null @@ -1,81 +0,0 @@ -From 2404dad1f67f8917e30fc22a85e0dbcc85b99955 Mon Sep 17 00:00:00 2001 -From: Jonathan Corbet <corbet@lwn.net> -Date: Tue, 21 May 2019 14:42:34 -0600 -Subject: [PATCH] doc: Cope with the deprecation of AutoReporter - -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 <corbet@lwn.net> - -diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py -index 200c8aa4a04f..1159405cb920 100644 ---- 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 - - import kernellog - -@@ -125,13 +135,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 - -@@ -140,6 +144,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') --- -2.9.5 - diff --git a/queue/docs-Fix-conf.py-for-Sphinx-2.0.patch b/queue/docs-Fix-conf.py-for-Sphinx-2.0.patch deleted file mode 100644 index 5bcd5b9..0000000 --- a/queue/docs-Fix-conf.py-for-Sphinx-2.0.patch +++ /dev/null @@ -1,30 +0,0 @@ -From 3bc8088464712fdcb078eefb68837ccfcc413c88 Mon Sep 17 00:00:00 2001 -From: Jonathan Corbet <corbet@lwn.net> -Date: Wed, 22 May 2019 14:30:45 -0600 -Subject: [PATCH] docs: Fix conf.py for Sphinx 2.0 - -commit 3bc8088464712fdcb078eefb68837ccfcc413c88 upstream. - -Our version check in Documentation/conf.py never envisioned a world where -Sphinx moved beyond 1.x. Now that the unthinkable has happened, fix our -version check to handle higher version numbers correctly. - -Cc: stable@vger.kernel.org -Signed-off-by: Jonathan Corbet <corbet@lwn.net> - -diff --git a/Documentation/conf.py b/Documentation/conf.py -index 72647a38b5c2..7ace3f8852bd 100644 ---- a/Documentation/conf.py -+++ b/Documentation/conf.py -@@ -37,7 +37,7 @@ needs_sphinx = '1.3' - extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain', 'kfigure', 'sphinx.ext.ifconfig'] - - # The name of the math extension changed on Sphinx 1.4 --if major == 1 and minor > 3: -+if (major == 1 and minor > 3) or (major > 1): - extensions.append("sphinx.ext.imgmath") - else: - extensions.append("sphinx.ext.pngmath") --- -2.9.5 - diff --git a/queue/series b/queue/series index 52591a6..8c42044 100644 --- a/queue/series +++ b/queue/series @@ -62,9 +62,6 @@ tty-max310x-Fix-external-crystal-register-setup.patch memcg-make-it-work-on-sparse-non-0-node-systems.patch kernel-signal.c-trace_signal_deliver-when-signal_gro.patch arm64-Fix-the-arm64_personality-syscall-wrapper-redi.patch -docs-Fix-conf.py-for-Sphinx-2.0.patch -doc-Cope-with-the-deprecation-of-AutoReporter.patch -doc-Cope-with-Sphinx-logging-deprecations.patch ima-show-rules-with-IMA_INMASK-correctly.patch evm-check-hash-algorithm-passed-to-init_desc.patch vt-fbcon-deinitialize-resources-in-visual_init-after.patch |