Skip to contentSkip to conversation

Make easier to use kernel-doc outside Kernel tree

PATCH New Mauro Carvalho Chehab 1 participant 2 messages Jan 29 Documentation

lore
Share & tools
lore

Mauro Carvalho Chehab

author
#0 lore raw

cover Make easier to use kernel-doc outside Kernel tree

Hi Jon,

This small patch comes after this series:

	https://lore.kernel.org/linux-doc/[email protected]/T/#t

It is goal is to help syncing kernel-doc with QEMU, as we're using it there as well for documentations. Yet, QEMU needs to have their own set of function macros. This change makes easy to override it at the caller script.

Mauro Carvalho Chehab (1):
docs: kdoc_files: allows the caller to use a different xforms class

 tools/lib/python/kdoc/kdoc_files.py | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
Signature · 1 line
2.52.0
author
#1 lore raw

PATCH 1/1 docs: kdoc_files: allows the caller to use a different xforms class

While the main goal for kernel-doc is to be used inside the Linux Kernel, other open source projects could benefit for it. That's currently the case of QEMU, which has a fork, mainly due to two reasons:

- they need an extra C function transform rule;
- they handle the html output a little bit different.

Add an extra optional argument to make easier for the code to be shared, as, with that, QEMU can just create a new derivated class that will contain its specific rulesets, and just copy the remaining kernel-doc files as-is.

Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 tools/lib/python/kdoc/kdoc_files.py | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)
tools/lib/python/kdoc/kdoc_files.py +7 -2
index 7357c97a4b01..c35e033cf123 100644
@@ -118,7 +118,7 @@ class KernelFiles():
         if fname in self.files:
             return
 
-        doc = KernelDoc(self.config, fname, CTransforms)
+        doc = KernelDoc(self.config, fname, self.xforms)
         export_table, entries = doc.parse_kdoc()
 
         self.export_table[fname] = export_table

@@ -154,7 +154,7 @@ class KernelFiles():
 
         self.error(f"Cannot find file {fname}")
 
-    def __init__(self, verbose=False, out_style=None,
+    def __init__(self, verbose=False, out_style=None, xforms=None,
                  werror=False, wreturn=False, wshort_desc=False,
                  wcontents_before_sections=False,
                  logger=None):

@@ -193,6 +193,11 @@ class KernelFiles():
         self.config.wshort_desc = wshort_desc
         self.config.wcontents_before_sections = wcontents_before_sections
 
+        if xforms:
+            self.xforms = xforms
+        else:
+            self.xforms = CTransforms()
+
         if not logger:
             self.config.log = logging.getLogger("kernel-doc")
         else:
Signature · 1 line
2.52.0