bybrooklyn/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-04-18 14:53:58 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: kdoc_output: use a single manual for everything

Browse Source 
There's no reason why functions will be on a different manual.
Unify its name, calling it as "Kernel API Manual".

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <000e1174a551e97ad4710ad4f3750b22017bedd5.1772810752.git.mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab
2026-03-06 16:45:43 +01:00
committed by Jonathan Corbet
parent 43874045fa
commit 31938f120f
1 changed files with 4 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -607,20 +607,17 @@ class ManFormat(OutputFormat):
"%m %d %Y",
]
def emit_th(self, name, modulename = None, manual=None):
def emit_th(self, name, modulename = None):
"""Emit a title header line."""
name = name.strip()
if not manual:
manual = self.manual
if not modulename:
modulename = self.modulename
self.data += f'.TH "{modulename}" {self.section} "{name}" '
self.data += f'"{self.date}" "{manual}"\n'
self.data += f'"{self.date}" "{self.manual}"\n'
def __init__(self, modulename, section="9", manual="API Manual"):
def __init__(self, modulename, section="9", manual="Kernel API Manual"):
"""
Creates class variables.
@@ -751,8 +748,7 @@ class ManFormat(OutputFormat):
out_name = self.arg_name(args, name)
self.emit_th(out_name, modulename = name,
manual="Kernel Hacker\'s Manual")
self.emit_th(out_name, modulename = name)
self.data += ".SH NAME\n"
self.data += f"{name} \\- {args['purpose']}\n"