mirrors/linux
2
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2026-05-16 10:11:38 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: kdoc_output: pick a better default for modulename

Browse Source 
Instead of placing the same data for modulename for all generated
man pages, use the directory from the filename used to produce
kernel docs as basis.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <8a5d91c93c0b9b34c2f60e389f4464742804d0d6.1772810752.git.mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab
2026-03-06 16:45:47 +01:00
committed by Jonathan Corbet
parent 26b4fdefc0
commit e4dadcf510
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
tools/docs/kernel-doc
View File

@@ -210,7 +210,6 @@ def main():
help="Enable debug messages")
parser.add_argument("-M", "-modulename", "--modulename",
default="Kernel API",
help="Allow setting a module name at the output.")
parser.add_argument("-l", "-enable-lineno", "--enable_lineno",

7
tools/lib/python/kdoc/kdoc_output.py
View File

@@ -589,7 +589,8 @@ class ManFormat(OutputFormat):
``modulename``
Defines the module name to be used at the troff ``.TH`` output.
This argument is mandatory.
This argument is optional. If not specified, it will be filled
with the directory which contains the documented file.
``section``
Usually a numeric value from 0 to 9, but man pages also accept
@@ -645,8 +646,8 @@ class ManFormat(OutputFormat):
title = name.strip()
module = self.modulename(args)
self.data += f'.TH "{name}" {self.section} "{self.date}" '
self.data += f'"{self.modulename}" "{self.manual}"\n'
self.data += f'.TH "{title}" {self.section} "{self.date}" '
self.data += f'"{module}" "{self.manual}"\n'
def __init__(self, modulename=None, section="9", manual="Kernel API Manual"):
"""