Commit 096ea522 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

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: default avatarJonathan Corbet <corbet@lwn.net>
parent a65fd4f0

Documentation/sphinx/kerneldoc.py

+8 −4
Original line number Diff line number Diff line
@@ -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,7 +136,7 @@ class KernelDocDirective(Directive): 
            return node.children



        except Exception as e:  # pylint: disable=W0703

            env.app.warn('kernel-doc \'%s\' processing failed with: %s' %

            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"))]

Documentation/sphinx/kernellog.py

0 → 100644
+28 −0
Original line number Diff line number Diff line 
# 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)

Documentation/sphinx/kfigure.py

+23 −17
Original line number Diff line number Diff line
@@ -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 "

        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]

CRA Git | Maintained and supported by SUSTech CRA and CCSE