diff options
author | Jonathan Corbet <corbet@lwn.net> | 2019-05-21 16:23:43 -0400 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2019-05-23 11:22:00 -0400 |
commit | 096ea522e84ea68f8e6c41e5e7294731a81e29bc (patch) | |
tree | 09d55c2c5ce3c65cf73bb26ade3000969f702eeb /Documentation/sphinx/kerneldoc.py | |
parent | a65fd4f0def56f59822b2c49522d36319bc8da8b (diff) |
doc: Cope with Sphinx logging deprecations
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>
Diffstat (limited to 'Documentation/sphinx/kerneldoc.py')
-rw-r--r-- | Documentation/sphinx/kerneldoc.py | 12 |
1 files changed, 8 insertions, 4 deletions
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 | |||
39 | from docutils.parsers.rst import directives, Directive | 39 | from docutils.parsers.rst import directives, Directive |
40 | from sphinx.ext.autodoc import AutodocReporter | 40 | from sphinx.ext.autodoc import AutodocReporter |
41 | 41 | ||
42 | import kernellog | ||
43 | |||
42 | __version__ = '1.0' | 44 | __version__ = '1.0' |
43 | 45 | ||
44 | class KernelDocDirective(Directive): | 46 | class KernelDocDirective(Directive): |
@@ -90,7 +92,8 @@ class KernelDocDirective(Directive): | |||
90 | cmd += [filename] | 92 | cmd += [filename] |
91 | 93 | ||
92 | try: | 94 | try: |
93 | env.app.verbose('calling kernel-doc \'%s\'' % (" ".join(cmd))) | 95 | kernellog.verbose(env.app, |
96 | 'calling kernel-doc \'%s\'' % (" ".join(cmd))) | ||
94 | 97 | ||
95 | p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE) | 98 | p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE) |
96 | out, err = p.communicate() | 99 | out, err = p.communicate() |
@@ -100,7 +103,8 @@ class KernelDocDirective(Directive): | |||
100 | if p.returncode != 0: | 103 | if p.returncode != 0: |
101 | sys.stderr.write(err) | 104 | sys.stderr.write(err) |
102 | 105 | ||
103 | env.app.warn('kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode)) | 106 | kernellog.warn(env.app, |
107 | 'kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode)) | ||
104 | return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] | 108 | return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] |
105 | elif env.config.kerneldoc_verbosity > 0: | 109 | elif env.config.kerneldoc_verbosity > 0: |
106 | sys.stderr.write(err) | 110 | sys.stderr.write(err) |
@@ -132,8 +136,8 @@ class KernelDocDirective(Directive): | |||
132 | return node.children | 136 | return node.children |
133 | 137 | ||
134 | except Exception as e: # pylint: disable=W0703 | 138 | except Exception as e: # pylint: disable=W0703 |
135 | env.app.warn('kernel-doc \'%s\' processing failed with: %s' % | 139 | kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: %s' % |
136 | (" ".join(cmd), str(e))) | 140 | (" ".join(cmd), str(e))) |
137 | return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] | 141 | return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] |
138 | 142 | ||
139 | def setup(app): | 143 | def setup(app): |