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
607 "%m %d %Y",607 "%m %d %Y",
608 ]608 ]
609 609
610 def emit_th(self, name, modulename = None, manual=None):610 def emit_th(self, name, modulename = None):
611 """Emit a title header line."""611 """Emit a title header line."""
612 name = name.strip()612 name = name.strip()
613 613
614 if not manual:
615 manual = self.manual
616
617 if not modulename:614 if not modulename:
618 modulename = self.modulename615 modulename = self.modulename
619 616
620 self.data += f'.TH "{modulename}" {self.section} "{name}" '617 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'
622 619
623 def __init__(self, modulename, section="9", manual="API Manual"):620 def __init__(self, modulename, section="9", manual="Kernel API Manual"):
624 """621 """
625 Creates class variables.622 Creates class variables.
626 623
@@ -751,8 +748,7 @@ class ManFormat(OutputFormat): · 124 unmodified lines
751 748
752 out_name = self.arg_name(args, name)749 out_name = self.arg_name(args, name)
753 750
754 self.emit_th(out_name, modulename = name,751 self.emit_th(out_name, modulename = name)
755 manual="Kernel Hacker\'s Manual")
756 752
757 self.data += ".SH NAME\n"753 self.data += ".SH NAME\n"
758 self.data += f"{name} \\- {args['purpose']}\n"754 self.data += f"{name} \\- {args['purpose']}\n"