Re: [PATCH 5/8] doc: kerneldoc.py: convert to sphinx.util.logging

[Mauro Carvalho Chehab <mchehab@kernel.org>]

Em Mon,  5 Feb 2024 18:51:30 +0100
Vegard Nossum <vegard.nossum@oracle.com> escreveu:

> As of commit 3e893e16af55 ("docs: Raise the minimum Sphinx requirement
> to 2.4.4"), we can use Sphinx's built-in logging facilities.
> 
> Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>

LGTM.

Reviewed-by: Mauro Carvalho Chehab <mchehab@kernel.org>

> ---
>  Documentation/sphinx/kerneldoc.py | 14 +++++++-------
>  1 file changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py
> index 7acf09963daa..c74a3e417cea 100644
> --- a/Documentation/sphinx/kerneldoc.py
> +++ b/Documentation/sphinx/kerneldoc.py
> @@ -38,11 +38,13 @@ from docutils import nodes, statemachine
>  from docutils.statemachine import ViewList
>  from docutils.parsers.rst import directives, Directive
>  import sphinx
> +from sphinx.util import logging
>  from sphinx.util.docutils import switch_source_input
> -import kernellog
>  
>  __version__  = '1.0'
>  
> +logger = logging.getLogger(__name__)
> +
>  class KernelDocDirective(Directive):
>      """Extract kernel-doc comments from the specified file"""
>      required_argument = 1
> @@ -109,8 +111,7 @@ class KernelDocDirective(Directive):
>          cmd += [filename]
>  
>          try:
> -            kernellog.verbose(env.app,
> -                              'calling kernel-doc \'%s\'' % (" ".join(cmd)))
> +            logger.verbose('calling kernel-doc \'%s\'', " ".join(cmd))
>  
>              p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
>              out, err = p.communicate()
> @@ -120,8 +121,7 @@ class KernelDocDirective(Directive):
>              if p.returncode != 0:
>                  sys.stderr.write(err)
>  
> -                kernellog.warn(env.app,
> -                               'kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode))
> +                logger.warning('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)
> @@ -148,8 +148,8 @@ class KernelDocDirective(Directive):
>              return node.children
>  
>          except Exception as e:  # pylint: disable=W0703
> -            kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: %s' %
> -                           (" ".join(cmd), str(e)))
> +            logger.warning('kernel-doc \'%s\' processing failed with: %s',
> +                           " ".join(cmd), str(e))
>              return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
>  
>      def do_parse(self, result, node):



Thanks,
Mauro