From nobody Thu Dec 18 01:52:58 2025 Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 2A2FE1773A; Tue, 28 Jan 2025 00:06:37 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=10.30.226.201 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738022797; cv=none; b=mYtTQX8yuaM4LXoCKAqoVQv9OBJkGmKeSkpCtthLqLpJhRiJPkD3Abf4TDKP7vvCqFJoLoNRL/OxVm6H7IUHwGVddi/d/W+Sogi2x2gGvkJjrvMudcqRiJWaAM0bSLUYNYxZI2Tp2svZNFP0zdZZmgaGriTmAUoBbU0fOolTUYk= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1738022797; c=relaxed/simple; bh=OOogPGxX0Vy45ilzrAOiFUxIeadBVZaAODgzfVd0odE=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version; b=tfbYkYV0FwP8wgzJbPcmEVDSlKMSekIhCiUx3XERl6JxgxgTCLiMMzoiBe6SaxpoTvWa2apkpbS9wxnIH9OAnAiPPwHdlfi91QOHkT65QFjhN40WfyfR9YrIuTPjpMJx3/SodobCiX4DHtuePi1UUoENXy38Z9uVWoNYmRvOHCI= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b=ticind3S; arc=none smtp.client-ip=10.30.226.201 Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="ticind3S" Received: by smtp.kernel.org (Postfix) with ESMTPSA id 9FCDEC4CEE2; Tue, 28 Jan 2025 00:06:35 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1738022796; bh=OOogPGxX0Vy45ilzrAOiFUxIeadBVZaAODgzfVd0odE=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=ticind3ShbVvYuMJe5rf4O+ul6j5PgQ2w16ywEV0VOXoGUDRnU2WDV0W40g73EK9m Ds51LfoOlb4FXF+28W8CGFMTwLHLlxHsok0mFhsnDDygim5u6hGt4SN8UExLXHP805 ogkDDVoPfhweOtEgjUg6JU5vGk44iJxIy5CAaBBWB7LolxZ5B8c2qhXc7zQaCbjgTp Sk4alcYgCTCwZoM5L0ri3PWdQ1dSF9ZiJ/Nm62DMlQDeUavYvWtF6Wh2BqTm6KjAjd lDE2YOLyR1c1CyB0MELhu8f5VqHcjcPX0Nv3GSyaYEQWhdioQYvxgX0fbJx1oItTs6 9RUYQBNWcZlWw== Received: from mchehab by mail.kernel.org with local (Exim 4.98) (envelope-from ) id 1tcZ7h-0000000DRKd-2ozq; Tue, 28 Jan 2025 01:06:33 +0100 From: Mauro Carvalho Chehab To: Linux Doc Mailing List , Jonathan Corbet , Greg Kroah-Hartman Cc: Mauro Carvalho Chehab , "Mauro Carvalho Chehab" , Randy Dunlap , Vegard Nossum , linux-kernel@vger.kernel.org Subject: [RFC v2 04/38] docs: sphinx: remove kernellog.py file Date: Tue, 28 Jan 2025 01:05:53 +0100 Message-ID: <5a84d6e5fa5d56170024b244e8e374c9dccbf299.1738020236.git.mchehab+huawei@kernel.org> X-Mailer: git-send-email 2.48.1 In-Reply-To: References: Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Sender: Mauro Carvalho Chehab Content-Type: text/plain; charset="utf-8" In the past, there was a need for a wrapper due to different Sphinx versions support (before Sphinx 1.6). This is long gone, and now it is just a wrapper. Get rig of it to simplify the code. Signed-off-by: Mauro Carvalho Chehab --- Documentation/sphinx/kernel_abi.py | 5 +- Documentation/sphinx/kerneldoc.py | 14 +++--- Documentation/sphinx/kernellog.py | 22 -------- Documentation/sphinx/kfigure.py | 81 ++++++++++++++++-------------- 4 files changed, 53 insertions(+), 69 deletions(-) delete mode 100644 Documentation/sphinx/kernellog.py diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kern= el_abi.py index 5911bd0d7965..8401562cb5d9 100644 --- a/Documentation/sphinx/kernel_abi.py +++ b/Documentation/sphinx/kernel_abi.py @@ -37,13 +37,13 @@ import os import subprocess import sys import re -import kernellog =20 from docutils import nodes, statemachine from docutils.statemachine import ViewList from docutils.parsers.rst import directives, Directive from docutils.utils.error_reporting import ErrorString from sphinx.util.docutils import switch_source_input +from sphinx.util import logging =20 __version__ =3D '1.0' =20 @@ -64,6 +64,7 @@ class KernelCmd(Directive): optional_arguments =3D 2 has_content =3D False final_argument_whitespace =3D True + logger =3D logging.getLogger('kernel_abi') =20 option_spec =3D { "debug" : directives.flag, @@ -129,7 +130,7 @@ class KernelCmd(Directive): else: content.append(line, f, ln) =20 - kernellog.info(self.state.document.settings.env.app, "%s: parsed %= i lines" % (fname, n)) + self.logger.info("%s: parsed %i lines" % (fname, n)) =20 if content: self.do_parse(content, node) diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerne= ldoc.py index ec1ddfff1863..be5b8fbf373f 100644 --- a/Documentation/sphinx/kerneldoc.py +++ b/Documentation/sphinx/kerneldoc.py @@ -39,7 +39,7 @@ from docutils.statemachine import ViewList from docutils.parsers.rst import directives, Directive import sphinx from sphinx.util.docutils import switch_source_input -import kernellog +from sphinx.util import logging =20 __version__ =3D '1.0' =20 @@ -56,6 +56,7 @@ class KernelDocDirective(Directive): 'functions': directives.unchanged, } has_content =3D False + logger =3D logging.getLogger('kerneldoc') =20 def run(self): env =3D self.state.document.settings.env @@ -109,8 +110,7 @@ class KernelDocDirective(Directive): cmd +=3D [filename] =20 try: - kernellog.verbose(env.app, - 'calling kernel-doc \'%s\'' % (" ".join(cmd)= )) + self.logger.verbose("calling kernel-doc '%s'" % (" ".join(cmd)= )) =20 p =3D subprocess.Popen(cmd, stdout=3Dsubprocess.PIPE, stderr= =3Dsubprocess.PIPE) out, err =3D p.communicate() @@ -120,8 +120,8 @@ class KernelDocDirective(Directive): if p.returncode !=3D 0: sys.stderr.write(err) =20 - kernellog.warn(env.app, - 'kernel-doc \'%s\' failed with return code = %d' % (" ".join(cmd), p.returncode)) + self.logger.warning("kernel-doc '%s' failed with return co= de %d" + % (" ".join(cmd), p.returncode)) return [nodes.error(None, nodes.paragraph(text =3D "kernel= -doc missing"))] elif env.config.kerneldoc_verbosity > 0: sys.stderr.write(err) @@ -148,8 +148,8 @@ class KernelDocDirective(Directive): return node.children =20 except Exception as e: # pylint: disable=3DW0703 - kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed w= ith: %s' % - (" ".join(cmd), str(e))) + self.logger.warning("kernel-doc '%s' processing failed with: %= s" % + (" ".join(cmd), str(e))) return [nodes.error(None, nodes.paragraph(text =3D "kernel-doc= missing"))] =20 def do_parse(self, result, node): diff --git a/Documentation/sphinx/kernellog.py b/Documentation/sphinx/kerne= llog.py deleted file mode 100644 index 0bc00c138cad..000000000000 --- a/Documentation/sphinx/kernellog.py +++ /dev/null @@ -1,22 +0,0 @@ -# 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. -# -# We don't support 1.4 anymore, but we'll keep the wrappers around until -# we change all the code to not use them anymore :) -# -import sphinx -from sphinx.util import logging - -logger =3D logging.getLogger('kerneldoc') - -def warn(app, message): - logger.warning(message) - -def verbose(app, message): - logger.verbose(message) - -def info(app, message): - logger.info(message) diff --git a/Documentation/sphinx/kfigure.py b/Documentation/sphinx/kfigure= .py index 97166333b727..383f9a695b08 100644 --- a/Documentation/sphinx/kfigure.py +++ b/Documentation/sphinx/kfigure.py @@ -59,12 +59,14 @@ from docutils.parsers.rst import directives from docutils.parsers.rst.directives import images import sphinx from sphinx.util.nodes import clean_astext -import kernellog +from sphinx.util import logging =20 Figure =3D images.Figure =20 __version__ =3D '1.0.0' =20 +logger =3D logging.getLogger('kfigure') + # simple helper # ------------- =20 @@ -170,7 +172,7 @@ def setupTools(app): """ global dot_cmd, dot_Tpdf, convert_cmd, rsvg_convert_cmd # pylint: di= sable=3DW0603 global inkscape_cmd, inkscape_ver_one # pylint: disable=3DW0603 - kernellog.verbose(app, "kfigure: check installed tools ...") + logger.verbose("kfigure: check installed tools ...") =20 dot_cmd =3D which('dot') convert_cmd =3D which('convert') @@ -178,7 +180,7 @@ def setupTools(app): inkscape_cmd =3D which('inkscape') =20 if dot_cmd: - kernellog.verbose(app, "use dot(1) from: " + dot_cmd) + logger.verbose("use dot(1) from: " + dot_cmd) =20 try: dot_Thelp_list =3D subprocess.check_output([dot_cmd, '-Thelp'], @@ -190,10 +192,11 @@ def setupTools(app): dot_Tpdf_ptn =3D b'pdf' dot_Tpdf =3D re.search(dot_Tpdf_ptn, dot_Thelp_list) else: - kernellog.warn(app, "dot(1) not found, for better output quality i= nstall " - "graphviz from https://www.graphviz.org") + logger.warning( + "dot(1) not found, for better output quality install graphviz = from https://www.graphviz.org" + ) if inkscape_cmd: - kernellog.verbose(app, "use inkscape(1) from: " + inkscape_cmd) + logger.verbose("use inkscape(1) from: " + inkscape_cmd) inkscape_ver =3D subprocess.check_output([inkscape_cmd, '--version= '], stderr=3Dsubprocess.DEVNULL) ver_one_ptn =3D b'Inkscape 1' @@ -204,26 +207,27 @@ def setupTools(app): =20 else: if convert_cmd: - kernellog.verbose(app, "use convert(1) from: " + convert_cmd) + logger.verbose("use convert(1) from: " + convert_cmd) else: - kernellog.verbose(app, + logger.verbose( "Neither inkscape(1) nor convert(1) found.\n" - "For SVG to PDF conversion, " - "install either Inkscape (https://inkscape.org/) (preferre= d) or\n" - "ImageMagick (https://www.imagemagick.org)") + "For SVG to PDF conversion, install either Inkscape (https= ://inkscape.org/) (preferred) or\n" + "ImageMagick (https://www.imagemagick.org)" + ) =20 if rsvg_convert_cmd: - kernellog.verbose(app, "use rsvg-convert(1) from: " + rsvg_con= vert_cmd) - kernellog.verbose(app, "use 'dot -Tsvg' and rsvg-convert(1) fo= r DOT -> PDF conversion") + logger.verbose("use rsvg-convert(1) from: " + rsvg_convert_cmd) + logger.verbose("use 'dot -Tsvg' and rsvg-convert(1) for DOT ->= PDF conversion") dot_Tpdf =3D False else: - kernellog.verbose(app, + logger.verbose( "rsvg-convert(1) not found.\n" - " SVG rendering of convert(1) is done by ImageMagick-nati= ve renderer.") + " SVG rendering of convert(1) is done by ImageMagick-nati= ve renderer." + ) if dot_Tpdf: - kernellog.verbose(app, "use 'dot -Tpdf' for DOT -> PDF con= version") + logger.verbose("use 'dot -Tpdf' for DOT -> PDF conversion") else: - kernellog.verbose(app, "use 'dot -Tsvg' and convert(1) for= DOT -> PDF conversion") + logger.verbose("use 'dot -Tsvg' and convert(1) for DOT -> = PDF conversion") =20 =20 # integrate conversion tools @@ -257,13 +261,12 @@ def convert_image(img_node, translator, src_fname=3DN= one): =20 # in kernel builds, use 'make SPHINXOPTS=3D-v' to see verbose messages =20 - kernellog.verbose(app, 'assert best format for: ' + img_node['uri']) + logger.verbose('assert best format for: ' + img_node['uri']) =20 if in_ext =3D=3D '.dot': =20 if not dot_cmd: - kernellog.verbose(app, - "dot from graphviz not available / include D= OT raw.") + logger.verbose("dot from graphviz not available / include DOT = raw.") img_node.replace_self(file2literal(src_fname)) =20 elif translator.builder.format =3D=3D 'latex': @@ -290,10 +293,11 @@ def convert_image(img_node, translator, src_fname=3DN= one): =20 if translator.builder.format =3D=3D 'latex': if not inkscape_cmd and convert_cmd is None: - kernellog.warn(app, - "no SVG to PDF conversion available / in= clude SVG raw." - "\nIncluding large raw SVGs can cause xe= latex error." - "\nInstall Inkscape (preferred) or Image= Magick.") + logger.warning( + "no SVG to PDF conversion available / include SVG raw.= \n" + "Including large raw SVGs can cause xelatex error.\n" + "Install Inkscape (preferred) or ImageMagick." + ) img_node.replace_self(file2literal(src_fname)) else: dst_fname =3D path.join(translator.builder.outdir, fname += '.pdf') @@ -306,15 +310,14 @@ def convert_image(img_node, translator, src_fname=3DN= one): _name =3D dst_fname[len(str(translator.builder.outdir)) + 1:] =20 if isNewer(dst_fname, src_fname): - kernellog.verbose(app, - "convert: {out}/%s already exists and is new= er" % _name) + logger.verbose("convert: {out}/%s already exists and is newer"= % _name) =20 else: ok =3D False mkdir(path.dirname(dst_fname)) =20 if in_ext =3D=3D '.dot': - kernellog.verbose(app, 'convert DOT to: {out}/' + _name) + logger.verbose('convert DOT to: {out}/' + _name) if translator.builder.format =3D=3D 'latex' and not dot_Tp= df: svg_fname =3D path.join(translator.builder.outdir, fna= me + '.svg') ok1 =3D dot2format(app, src_fname, svg_fname) @@ -325,7 +328,7 @@ def convert_image(img_node, translator, src_fname=3DNon= e): ok =3D dot2format(app, src_fname, dst_fname) =20 elif in_ext =3D=3D '.svg': - kernellog.verbose(app, 'convert SVG to: {out}/' + _name) + logger.verbose('convert SVG to: {out}/' + _name) ok =3D svg2pdf(app, src_fname, dst_fname) =20 if not ok: @@ -354,7 +357,7 @@ def dot2format(app, dot_fname, out_fname): with open(out_fname, "w") as out: exit_code =3D subprocess.call(cmd, stdout =3D out) if exit_code !=3D 0: - kernellog.warn(app, + logger.warning( "Error #%d when calling: %s" % (exit_code, " ".j= oin(cmd))) return bool(exit_code =3D=3D 0) =20 @@ -388,13 +391,14 @@ def svg2pdf(app, svg_fname, pdf_fname): pass =20 if exit_code !=3D 0: - kernellog.warn(app, "Error #%d when calling: %s" % (exit_code, " "= .join(cmd))) + logger.warning("Error #%d when calling: %s" % + (exit_code, " ".join(cmd))) if warning_msg: - kernellog.warn(app, "Warning msg from %s: %s" - % (cmd_name, str(warning_msg, 'utf-8'))) + logger.warning( "Warning msg from %s: %s" % + (cmd_name, str(warning_msg, 'utf-8'))) elif warning_msg: - kernellog.verbose(app, "Warning msg from %s (likely harmless):\n%s" - % (cmd_name, str(warning_msg, 'utf-8'))) + logger.verbose("Warning msg from %s (likely harmless):\n%s" % + (cmd_name, str(warning_msg, 'utf-8'))) =20 return bool(exit_code =3D=3D 0) =20 @@ -418,7 +422,8 @@ def svg2pdf_by_rsvg(app, svg_fname, pdf_fname): # use stdout and stderr from parent exit_code =3D subprocess.call(cmd) if exit_code !=3D 0: - kernellog.warn(app, "Error #%d when calling: %s" % (exit_code,= " ".join(cmd))) + logger.warning("Error #%d when calling: %s" % + (exit_code, " ".join(cmd))) ok =3D bool(exit_code =3D=3D 0) =20 return ok @@ -513,15 +518,15 @@ def visit_kernel_render(self, node): app =3D self.builder.app srclang =3D node.get('srclang') =20 - kernellog.verbose(app, 'visit kernel-render node lang: "%s"' % (srclan= g)) + logger.verbose('visit kernel-render node lang: "%s"' % srclang) =20 tmp_ext =3D RENDER_MARKUP_EXT.get(srclang, None) if tmp_ext is None: - kernellog.warn(app, 'kernel-render: "%s" unknown / include raw.' %= (srclang)) + logger.warning( 'kernel-render: "%s" unknown / include raw.' % src= lang) return =20 if not dot_cmd and tmp_ext =3D=3D '.dot': - kernellog.verbose(app, "dot from graphviz not available / include = raw.") + logger.verbose("dot from graphviz not available / include raw.") return =20 literal_block =3D node[0] --=20 2.48.1