History

docs: kdoc_output: use a single manual for everything

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

Mauro Carvalho Chehab committed 8 months ago

Commit 31938f11 parent 43874041 file · +4 −8Browse files

Showing the changes to tools/lib/python (1 of 1 file). Show all

Unified · Split

tools/lib/python/kdoc/kdoc_output.py+4−8
@@ -607,20 +607,17 @@ class ManFormat(OutputFormat): · 606 unmodified lines
607607 "%m %d %Y",
608608 ]
609609
610− def emit_th(self, name, modulename = None, manual=None):
610+ def emit_th(self, name, modulename = None):
611611 """Emit a title header line."""
612612 name = name.strip()
613613
614− if not manual:
615− manual = self.manual
616−
617614 if not modulename:
618615 modulename = self.modulename
619616
620617 self.data += f'.TH "{modulename}" {self.section} "{name}" '
621− self.data += f'"{self.date}" "{manual}"\n'
618+ self.data += f'"{self.date}" "{self.manual}"\n'
622619
623− def __init__(self, modulename, section="9", manual="API Manual"):
620+ def __init__(self, modulename, section="9", manual="Kernel API Manual"):
624621 """
625622 Creates class variables.
626623
@@ -751,8 +748,7 @@ class ManFormat(OutputFormat): · 124 unmodified lines
751748
752749 out_name = self.arg_name(args, name)
753750
754− self.emit_th(out_name, modulename = name,
755− manual="Kernel Hacker\'s Manual")
751+ self.emit_th(out_name, modulename = name)
756752
757753 self.data += ".SH NAME\n"
758754 self.data += f"{name} \\- {args['purpose']}\n"