kernel-doc: output source file name at SEE ALSO

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

Mauro Carvalho Chehab committed 1 year ago

Commit 2bd22191 parent 0a4cd1c3 files · +9 −5Browse files

Showing the changes to scripts (3 of 3 files). Show all

Unified · Split

3 files

 #
 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 = {}

         """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)

 class KernelEntry:
-    def __init__(self, config, ln):
+    def __init__(self, config, fname, ln):
         self.config = config
+        self.fname = fname
         self._contents = []
         self.prototype = ""
         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
         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