Skip to contentSkip to conversation

man pages: Add a SEE ALSO pointing to Kernel source

PATCH In review Mauro Carvalho Chehab 2 participants 3 messages Oct 1, 2025 Documentation

lore
Share & tools
lore

Mauro Carvalho Chehab

author
#0 lore raw

cover man pages: Add a SEE ALSO pointing to Kernel source

It is interesting to point to what Kernel file contains documented item at kernel-doc man pages.

Mauro Carvalho Chehab (1):
kernel-doc: output source file name at SEE ALSO

 scripts/lib/kdoc/kdoc_item.py   | 3 ++-
 scripts/lib/kdoc/kdoc_output.py | 3 ++-
 scripts/lib/kdoc/kdoc_parser.py | 8 +++++---
 3 files changed, 9 insertions(+), 5 deletions(-)
Signature · 1 line
2.51.0
author
#1 lore raw

PATCH 1/1 kernel-doc: output source file name at SEE ALSO

for man pages, it is helpful to know from where the man page were generated.

Signed-off-by Mauro Carvalho Chehab <[email protected]>
---
 scripts/lib/kdoc/kdoc_item.py   | 3 ++-
 scripts/lib/kdoc/kdoc_output.py | 3 ++-
 scripts/lib/kdoc/kdoc_parser.py | 8 +++++---
 3 files changed, 9 insertions(+), 5 deletions(-)
scripts/lib/kdoc/kdoc_item.py +2 -1
index b3b225764550..19805301cb2c 100644
@@ -5,8 +5,9 @@
 #
 
 class KdocItem:
-    def __init__(self, name, type, start_line, **other_stuff):
+    def __init__(self, name, fname, type, start_line, **other_stuff):
         self.name = name
+        self.fname = fname
         self.type = type
         self.declaration_start_line = start_line
         self.sections = {}
scripts/lib/kdoc/kdoc_output.py +2 -1
index 1eca9a918558..58f115059e93 100644
@@ -630,10 +630,11 @@ class ManFormat(OutputFormat):
         """Adds a tail for all man pages"""
 
         # SEE ALSO section
+        self.data += f'.SH "SEE ALSO"' + "\n.PP\n"
+        self.data += (f"Kernel file \\fB{args.fname}\\fR\n")
         if len(self.symbols) >= 2:
             cur_name = self.arg_name(args, name)
 
-            self.data += f'.SH "SEE ALSO"' + "\n.PP\n"
             related = []
             for arg in self.symbols:
                 out_name = self.arg_name(arg, arg.name)
scripts/lib/kdoc/kdoc_parser.py +5 -3
index 89d920e0b65c..6e5c115cbdf3 100644
@@ -254,8 +254,9 @@ SECTION_DEFAULT = "Description"  # default section
 
 class KernelEntry:
 
-    def __init__(self, config, ln):
+    def __init__(self, config, fname, ln):
         self.config = config
+        self.fname = fname
 
         self._contents = []
         self.prototype = ""

@@ -422,7 +423,8 @@ class KernelDoc:
         The actual output and output filters will be handled elsewhere
         """
 
-        item = KdocItem(name, dtype, self.entry.declaration_start_line, **args)
+        item = KdocItem(name, self.fname, dtype,
+                        self.entry.declaration_start_line, **args)
         item.warnings = self.entry.warnings
 
         # Drop empty sections

@@ -445,7 +447,7 @@ class KernelDoc:
         variables used by the state machine.
         """
 
-        self.entry = KernelEntry(self.config, ln)
+        self.entry = KernelEntry(self.config, self.fname, ln)
 
         # State flags
         self.state = state.NORMAL
Signature · 1 line
2.51.0
maintainer
#2 lore raw
In reply to Mauro Carvalho Chehab
Quoted 10 lines · Mauro Carvalho Chehab

It is interesting to point to what Kernel file contains documented item at kernel-doc man pages.

Mauro Carvalho Chehab (1):
kernel-doc: output source file name at SEE ALSO

 scripts/lib/kdoc/kdoc_item.py   | 3 ++-
 scripts/lib/kdoc/kdoc_output.py | 3 ++-
 scripts/lib/kdoc/kdoc_parser.py | 8 +++++---
 3 files changed, 9 insertions(+), 5 deletions(-)

Applied (to build-script), thanks.

jon