tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

docs: sphinx: remove kernellog.py file

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 <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/48bf16f199250d7048ca164d1b90773861915157.1739182025.git.mchehab+huawei@kernel.org

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet 3d89178b 2b087edf

+53 -69
+3 -2
Documentation/sphinx/kernel_abi.py
··· 37 37 import subprocess 38 38 import sys 39 39 import re 40 - import kernellog 41 40 42 41 from docutils import nodes, statemachine 43 42 from docutils.statemachine import ViewList 44 43 from docutils.parsers.rst import directives, Directive 45 44 from docutils.utils.error_reporting import ErrorString 46 45 from sphinx.util.docutils import switch_source_input 46 + from sphinx.util import logging 47 47 48 48 __version__ = '1.0' 49 49 ··· 64 64 optional_arguments = 2 65 65 has_content = False 66 66 final_argument_whitespace = True 67 + logger = logging.getLogger('kernel_abi') 67 68 68 69 option_spec = { 69 70 "debug" : directives.flag, ··· 130 129 else: 131 130 content.append(line, f, ln) 132 131 133 - kernellog.info(self.state.document.settings.env.app, "%s: parsed %i lines" % (fname, n)) 132 + self.logger.info("%s: parsed %i lines" % (fname, n)) 134 133 135 134 if content: 136 135 self.do_parse(content, node)
+7 -7
Documentation/sphinx/kerneldoc.py
··· 39 39 from docutils.parsers.rst import directives, Directive 40 40 import sphinx 41 41 from sphinx.util.docutils import switch_source_input 42 - import kernellog 42 + from sphinx.util import logging 43 43 44 44 __version__ = '1.0' 45 45 ··· 56 56 'functions': directives.unchanged, 57 57 } 58 58 has_content = False 59 + logger = logging.getLogger('kerneldoc') 59 60 60 61 def run(self): 61 62 env = self.state.document.settings.env ··· 110 109 cmd += [filename] 111 110 112 111 try: 113 - kernellog.verbose(env.app, 114 - 'calling kernel-doc \'%s\'' % (" ".join(cmd))) 112 + self.logger.verbose("calling kernel-doc '%s'" % (" ".join(cmd))) 115 113 116 114 p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE) 117 115 out, err = p.communicate() ··· 120 120 if p.returncode != 0: 121 121 sys.stderr.write(err) 122 122 123 - kernellog.warn(env.app, 124 - 'kernel-doc \'%s\' failed with return code %d' % (" ".join(cmd), p.returncode)) 123 + self.logger.warning("kernel-doc '%s' failed with return code %d" 124 + % (" ".join(cmd), p.returncode)) 125 125 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] 126 126 elif env.config.kerneldoc_verbosity > 0: 127 127 sys.stderr.write(err) ··· 148 148 return node.children 149 149 150 150 except Exception as e: # pylint: disable=W0703 151 - kernellog.warn(env.app, 'kernel-doc \'%s\' processing failed with: %s' % 152 - (" ".join(cmd), str(e))) 151 + self.logger.warning("kernel-doc '%s' processing failed with: %s" % 152 + (" ".join(cmd), str(e))) 153 153 return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))] 154 154 155 155 def do_parse(self, result, node):
-22
Documentation/sphinx/kernellog.py
··· 1 - # SPDX-License-Identifier: GPL-2.0 2 - # 3 - # Sphinx has deprecated its older logging interface, but the replacement 4 - # only goes back to 1.6. So here's a wrapper layer to keep around for 5 - # as long as we support 1.4. 6 - # 7 - # We don't support 1.4 anymore, but we'll keep the wrappers around until 8 - # we change all the code to not use them anymore :) 9 - # 10 - import sphinx 11 - from sphinx.util import logging 12 - 13 - logger = logging.getLogger('kerneldoc') 14 - 15 - def warn(app, message): 16 - logger.warning(message) 17 - 18 - def verbose(app, message): 19 - logger.verbose(message) 20 - 21 - def info(app, message): 22 - logger.info(message)
+43 -38
Documentation/sphinx/kfigure.py
··· 59 59 from docutils.parsers.rst.directives import images 60 60 import sphinx 61 61 from sphinx.util.nodes import clean_astext 62 - import kernellog 62 + from sphinx.util import logging 63 63 64 64 Figure = images.Figure 65 65 66 66 __version__ = '1.0.0' 67 + 68 + logger = logging.getLogger('kfigure') 67 69 68 70 # simple helper 69 71 # ------------- ··· 172 170 """ 173 171 global dot_cmd, dot_Tpdf, convert_cmd, rsvg_convert_cmd # pylint: disable=W0603 174 172 global inkscape_cmd, inkscape_ver_one # pylint: disable=W0603 175 - kernellog.verbose(app, "kfigure: check installed tools ...") 173 + logger.verbose("kfigure: check installed tools ...") 176 174 177 175 dot_cmd = which('dot') 178 176 convert_cmd = which('convert') ··· 180 178 inkscape_cmd = which('inkscape') 181 179 182 180 if dot_cmd: 183 - kernellog.verbose(app, "use dot(1) from: " + dot_cmd) 181 + logger.verbose("use dot(1) from: " + dot_cmd) 184 182 185 183 try: 186 184 dot_Thelp_list = subprocess.check_output([dot_cmd, '-Thelp'], ··· 192 190 dot_Tpdf_ptn = b'pdf' 193 191 dot_Tpdf = re.search(dot_Tpdf_ptn, dot_Thelp_list) 194 192 else: 195 - kernellog.warn(app, "dot(1) not found, for better output quality install " 196 - "graphviz from https://www.graphviz.org") 193 + logger.warning( 194 + "dot(1) not found, for better output quality install graphviz from https://www.graphviz.org" 195 + ) 197 196 if inkscape_cmd: 198 - kernellog.verbose(app, "use inkscape(1) from: " + inkscape_cmd) 197 + logger.verbose("use inkscape(1) from: " + inkscape_cmd) 199 198 inkscape_ver = subprocess.check_output([inkscape_cmd, '--version'], 200 199 stderr=subprocess.DEVNULL) 201 200 ver_one_ptn = b'Inkscape 1' ··· 207 204 208 205 else: 209 206 if convert_cmd: 210 - kernellog.verbose(app, "use convert(1) from: " + convert_cmd) 207 + logger.verbose("use convert(1) from: " + convert_cmd) 211 208 else: 212 - kernellog.verbose(app, 209 + logger.verbose( 213 210 "Neither inkscape(1) nor convert(1) found.\n" 214 - "For SVG to PDF conversion, " 215 - "install either Inkscape (https://inkscape.org/) (preferred) or\n" 216 - "ImageMagick (https://www.imagemagick.org)") 211 + "For SVG to PDF conversion, install either Inkscape (https://inkscape.org/) (preferred) or\n" 212 + "ImageMagick (https://www.imagemagick.org)" 213 + ) 217 214 218 215 if rsvg_convert_cmd: 219 - kernellog.verbose(app, "use rsvg-convert(1) from: " + rsvg_convert_cmd) 220 - kernellog.verbose(app, "use 'dot -Tsvg' and rsvg-convert(1) for DOT -> PDF conversion") 216 + logger.verbose("use rsvg-convert(1) from: " + rsvg_convert_cmd) 217 + logger.verbose("use 'dot -Tsvg' and rsvg-convert(1) for DOT -> PDF conversion") 221 218 dot_Tpdf = False 222 219 else: 223 - kernellog.verbose(app, 220 + logger.verbose( 224 221 "rsvg-convert(1) not found.\n" 225 - " SVG rendering of convert(1) is done by ImageMagick-native renderer.") 222 + " SVG rendering of convert(1) is done by ImageMagick-native renderer." 223 + ) 226 224 if dot_Tpdf: 227 - kernellog.verbose(app, "use 'dot -Tpdf' for DOT -> PDF conversion") 225 + logger.verbose("use 'dot -Tpdf' for DOT -> PDF conversion") 228 226 else: 229 - kernellog.verbose(app, "use 'dot -Tsvg' and convert(1) for DOT -> PDF conversion") 227 + logger.verbose("use 'dot -Tsvg' and convert(1) for DOT -> PDF conversion") 230 228 231 229 232 230 # integrate conversion tools ··· 261 257 262 258 # in kernel builds, use 'make SPHINXOPTS=-v' to see verbose messages 263 259 264 - kernellog.verbose(app, 'assert best format for: ' + img_node['uri']) 260 + logger.verbose('assert best format for: ' + img_node['uri']) 265 261 266 262 if in_ext == '.dot': 267 263 268 264 if not dot_cmd: 269 - kernellog.verbose(app, 270 - "dot from graphviz not available / include DOT raw.") 265 + logger.verbose("dot from graphviz not available / include DOT raw.") 271 266 img_node.replace_self(file2literal(src_fname)) 272 267 273 268 elif translator.builder.format == 'latex': ··· 293 290 294 291 if translator.builder.format == 'latex': 295 292 if not inkscape_cmd and convert_cmd is None: 296 - kernellog.warn(app, 297 - "no SVG to PDF conversion available / include SVG raw." 298 - "\nIncluding large raw SVGs can cause xelatex error." 299 - "\nInstall Inkscape (preferred) or ImageMagick.") 293 + logger.warning( 294 + "no SVG to PDF conversion available / include SVG raw.\n" 295 + "Including large raw SVGs can cause xelatex error.\n" 296 + "Install Inkscape (preferred) or ImageMagick." 297 + ) 300 298 img_node.replace_self(file2literal(src_fname)) 301 299 else: 302 300 dst_fname = path.join(translator.builder.outdir, fname + '.pdf') ··· 310 306 _name = dst_fname[len(str(translator.builder.outdir)) + 1:] 311 307 312 308 if isNewer(dst_fname, src_fname): 313 - kernellog.verbose(app, 314 - "convert: {out}/%s already exists and is newer" % _name) 309 + logger.verbose("convert: {out}/%s already exists and is newer" % _name) 315 310 316 311 else: 317 312 ok = False 318 313 mkdir(path.dirname(dst_fname)) 319 314 320 315 if in_ext == '.dot': 321 - kernellog.verbose(app, 'convert DOT to: {out}/' + _name) 316 + logger.verbose('convert DOT to: {out}/' + _name) 322 317 if translator.builder.format == 'latex' and not dot_Tpdf: 323 318 svg_fname = path.join(translator.builder.outdir, fname + '.svg') 324 319 ok1 = dot2format(app, src_fname, svg_fname) ··· 328 325 ok = dot2format(app, src_fname, dst_fname) 329 326 330 327 elif in_ext == '.svg': 331 - kernellog.verbose(app, 'convert SVG to: {out}/' + _name) 328 + logger.verbose('convert SVG to: {out}/' + _name) 332 329 ok = svg2pdf(app, src_fname, dst_fname) 333 330 334 331 if not ok: ··· 357 354 with open(out_fname, "w") as out: 358 355 exit_code = subprocess.call(cmd, stdout = out) 359 356 if exit_code != 0: 360 - kernellog.warn(app, 357 + logger.warning( 361 358 "Error #%d when calling: %s" % (exit_code, " ".join(cmd))) 362 359 return bool(exit_code == 0) 363 360 ··· 391 388 pass 392 389 393 390 if exit_code != 0: 394 - kernellog.warn(app, "Error #%d when calling: %s" % (exit_code, " ".join(cmd))) 391 + logger.warning("Error #%d when calling: %s" % 392 + (exit_code, " ".join(cmd))) 395 393 if warning_msg: 396 - kernellog.warn(app, "Warning msg from %s: %s" 397 - % (cmd_name, str(warning_msg, 'utf-8'))) 394 + logger.warning( "Warning msg from %s: %s" % 395 + (cmd_name, str(warning_msg, 'utf-8'))) 398 396 elif warning_msg: 399 - kernellog.verbose(app, "Warning msg from %s (likely harmless):\n%s" 400 - % (cmd_name, str(warning_msg, 'utf-8'))) 397 + logger.verbose("Warning msg from %s (likely harmless):\n%s" % 398 + (cmd_name, str(warning_msg, 'utf-8'))) 401 399 402 400 return bool(exit_code == 0) 403 401 ··· 422 418 # use stdout and stderr from parent 423 419 exit_code = subprocess.call(cmd) 424 420 if exit_code != 0: 425 - kernellog.warn(app, "Error #%d when calling: %s" % (exit_code, " ".join(cmd))) 421 + logger.warning("Error #%d when calling: %s" % 422 + (exit_code, " ".join(cmd))) 426 423 ok = bool(exit_code == 0) 427 424 428 425 return ok ··· 518 513 app = self.builder.app 519 514 srclang = node.get('srclang') 520 515 521 - kernellog.verbose(app, 'visit kernel-render node lang: "%s"' % (srclang)) 516 + logger.verbose('visit kernel-render node lang: "%s"' % srclang) 522 517 523 518 tmp_ext = RENDER_MARKUP_EXT.get(srclang, None) 524 519 if tmp_ext is None: 525 - kernellog.warn(app, 'kernel-render: "%s" unknown / include raw.' % (srclang)) 520 + logger.warning( 'kernel-render: "%s" unknown / include raw.' % srclang) 526 521 return 527 522 528 523 if not dot_cmd and tmp_ext == '.dot': 529 - kernellog.verbose(app, "dot from graphviz not available / include raw.") 524 + logger.verbose("dot from graphviz not available / include raw.") 530 525 return 531 526 532 527 literal_block = node[0]