diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2019-07-14 10:35:45 +0200 |
|---|---|---|
| committer | Tom Rini <trini@konsulko.com> | 2019-07-24 14:15:35 -0400 |
| commit | 61779ce0a1f0ad020e28d2154d8fe3ddbec05ce6 (patch) | |
| tree | be5b3da09d5926a1d85967681d047431c13d2762 /doc/sphinx/kerneldoc.py | |
| parent | edd31084f2560008b7aed6c9654b014a90ebd33e (diff) | |
| download | u-boot-61779ce0a1f0ad020e28d2154d8fe3ddbec05ce6.zip u-boot-61779ce0a1f0ad020e28d2154d8fe3ddbec05ce6.tar.gz u-boot-61779ce0a1f0ad020e28d2154d8fe3ddbec05ce6.tar.bz2 | |
doc: Cope with Sphinx logging deprecations
Recent versions of sphinx will emit messages like:
doc/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.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Rebased for U-Boot
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'doc/sphinx/kerneldoc.py')
| -rw-r--r-- | doc/sphinx/kerneldoc.py | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/sphinx/kerneldoc.py b/doc/sphinx/kerneldoc.py index fbedcc3..e536360 100644 --- a/doc/sphinx/kerneldoc.py +++ b/doc/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): @@ -86,7 +88,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() @@ -96,7 +99,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) @@ -128,8 +132,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): |