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

scripts/kernel-doc.py: better handle empty sections

Browse Source 
While doing the conversion, we opted to skip empty sections
(description, return), but this makes harder to see the differences
between kernel-doc (Perl) and kernel-doc.py.

Also, the logic doesn't always work properly. So, change the
way this is done by adding an extra step to remove such
sections, doing it only for Return and Description.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/1b057092a48ba61d92a411f4f6d505b802913785.1744106241.git.mchehab+huawei@kernel.org
This commit is contained in:
Mauro Carvalho Chehab
2025-04-08 18:09:08 +08:00
committed by Jonathan Corbet
parent 0a4e24128f
commit 3592385668
1 changed files with 28 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
scripts/kernel-doc.py
View File

@@ -317,6 +317,19 @@ class KernelDoc:
name = self.entry.section
contents = self.entry.contents
# TODO: we can prevent dumping empty sections here with:
#
# if self.entry.contents.strip("\n"):
# if start_new:
# self.entry.section = self.section_default
# self.entry.contents = ""
#
# return
#
# But, as we want to be producing the same output of the
# venerable kernel-doc Perl tool, let's just output everything,
# at least for now
if type_param.match(name):
name = type_param.group(1)
@@ -373,6 +386,19 @@ class KernelDoc:
args["type"] = dtype
# TODO: use colletions.OrderedDict
sections = args.get('sections', {})
sectionlist = args.get('sectionlist', [])
# Drop empty sections
# TODO: improve it to emit warnings
for section in [ "Description", "Return" ]:
if section in sectionlist:
if not sections[section].rstrip():
del sections[section]
sectionlist.remove(section)
self.entries.append((name, args))
self.config.log.debug("Output: %s:%s = %s", dtype, name, pformat(args))
@@ -476,7 +502,7 @@ class KernelDoc:
# to ignore "[blah" in a parameter string.
self.entry.parameterlist.append(param)
org_arg = Re(r'\s\s+').sub(' ', org_arg, count=1)
org_arg = Re(r'\s\s+').sub(' ', org_arg)
self.entry.parametertypes[param] = org_arg
def save_struct_actual(self, actual):
@@ -1384,8 +1410,7 @@ class KernelDoc:
return
if doc_end.search(line):
if self.entry.contents.strip("\n"):
self.dump_section()
self.dump_section()
# Look for doc_com + <text> + doc_end:
r = Re(r'\s*\*\s*[a-zA-Z_0-9:\.]+\*/')