linux-kernel - [PATCH 1/3] docs: Sphinx: kerneldoc: only initialize kernel-doc classes once

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <b00788f26e161512858a6e01a673c34743c954df.1745564565.git.mchehab+huawei@kernel.org>
Date: Fri, 25 Apr 2025 15:13:38 +0800
From: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To: Linux Doc Mailing List <linux-doc@...r.kernel.org>,
	Jonathan Corbet <corbet@....net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
	Kees Cook <kees@...nel.org>,
	linux-kernel@...r.kernel.org
Subject: [PATCH 1/3] docs: Sphinx: kerneldoc: only initialize kernel-doc classes once

Instead of re-creating the objects every time, initialize it
just once.

This allows caching previously parsed objects.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
---
 Documentation/sphinx/kerneldoc.py | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py
index 27baf28fb754..b713a2c4a615 100644
--- a/Documentation/sphinx/kerneldoc.py
+++ b/Documentation/sphinx/kerneldoc.py
@@ -48,7 +48,8 @@ from kdoc_files import KernelFiles
 from kdoc_output import RestFormat
 
 __version__  = '1.0'
-use_kfiles = False
+kfiles = None
+logger = logging.getLogger('kerneldoc')
 
 def cmd_str(cmd):
     """
@@ -86,7 +87,6 @@ class KernelDocDirective(Directive):
         'functions': directives.unchanged,
     }
     has_content = False
-    logger = logging.getLogger('kerneldoc')
     verbose = 0
 
     parse_args = {}
@@ -204,7 +204,7 @@ class KernelDocDirective(Directive):
         node = nodes.section()
 
         try:
-            self.logger.verbose("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()
@@ -214,14 +214,14 @@ class KernelDocDirective(Directive):
             if p.returncode != 0:
                 sys.stderr.write(err)
 
-                self.logger.warning("kernel-doc '%s' failed with return code %d"
+                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)
 
         except Exception as e:  # pylint: disable=W0703
-            self.logger.warning("kernel-doc '%s' processing failed with: %s" %
+            logger.warning("kernel-doc '%s' processing failed with: %s" %
                                 (" ".join(cmd), str(e)))
             return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 
@@ -261,7 +261,7 @@ class KernelDocDirective(Directive):
             self.do_parse(result, node)
 
         except Exception as e:  # pylint: disable=W0703
-            self.logger.warning("kernel-doc '%s' processing failed with: %s" %
+            logger.warning("kernel-doc '%s' processing failed with: %s" %
                                 (cmd_str(cmd), str(e)))
             return [nodes.error(None, nodes.paragraph(text = "kernel-doc missing"))]
 
@@ -292,11 +292,9 @@ class KernelDocDirective(Directive):
         return node.children
 
     def run(self):
-        global use_kfiles
+        global kfiles
 
-        if use_kfiles:
-            out_style = RestFormat()
-            kfiles = KernelFiles(out_style=out_style, logger=self.logger)
+        if kfiles:
             return self.run_kdoc(kfiles)
         else:
             return self.run_cmd()
@@ -306,13 +304,14 @@ class KernelDocDirective(Directive):
             self.state.nested_parse(result, 0, node, match_titles=1)
 
 def setup_kfiles(app):
-    global use_kfiles
+    global kfiles
 
     kerneldoc_bin = app.env.config.kerneldoc_bin
 
     if kerneldoc_bin and kerneldoc_bin.endswith("kernel-doc.py"):
         print("Using Python kernel-doc")
-        use_kfiles = True
+        out_style = RestFormat()
+        kfiles = KernelFiles(out_style=out_style, logger=logger)
     else:
         print(f"Using {kerneldoc_bin}")
 
-- 
2.49.0