raspi/linux
1
0
Fork 1
mirror of https://github.com/raspberrypi/linux.git synced 2025-12-06 18:09:56 +00:00
Code Issues Projects Releases Wiki Activity

docs: kdoc: extract output formatting from dump_struct()

Browse Source 
The last thing done in dump_struct() is to format the structure for
printing.  That, too, is a separate activity; split it out into its own
function.

dump_struct() now fits in a single, full-hight editor screen.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250807211639.47286-12-corbet@lwn.net
This commit is contained in:
Jonathan Corbet
2025-08-07 15:16:38 -06:00
parent e6dd4e2a5c
commit 23c47b0931
1 changed files with 37 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
scripts/lib/kdoc/kdoc_parser.py
View File

@@ -739,6 +739,42 @@ class KernelDoc:
tuples = struct_members.findall(members)
return members
#
# Format the struct declaration into a standard form for inclusion in the
# resulting docs.
#
def format_struct_decl(self, declaration):
#
# Insert newlines, get rid of extra spaces.
#
declaration = KernRe(r'([\{;])').sub(r'\1\n', declaration)
declaration = KernRe(r'\}\s+;').sub('};', declaration)
#
# Format inline enums with each member on its own line.
#
r = KernRe(r'(enum\s+\{[^\}]+),([^\n])')
while r.search(declaration):
declaration = r.sub(r'\1,\n\2', declaration)
#
# Now go through and supply the right number of tabs
# for each line.
#
def_args = declaration.split('\n')
level = 1
declaration = ""
for clause in def_args:
clause = KernRe(r'\s+').sub(' ', clause.strip(), count=1)
if clause:
if '}' in clause and level > 1:
level -= 1
if not clause.startswith('#'):
declaration += "\t" * level
declaration += "\t" + clause + "\n"
if "{" in clause and "}" not in clause:
level += 1
return declaration
def dump_struct(self, ln, proto):
"""
Store an entry for an struct or union
@@ -777,42 +813,8 @@ class KernelDoc:
self.create_parameter_list(ln, decl_type, members, ';',
declaration_name)
self.check_sections(ln, declaration_name, decl_type)
# Adjust declaration for better display
declaration = KernRe(r'([\{;])').sub(r'\1\n', declaration)
declaration = KernRe(r'\}\s+;').sub('};', declaration)
# Better handle inlined enums
while True:
r = KernRe(r'(enum\s+\{[^\}]+),([^\n])')
if not r.search(declaration):
break
declaration = r.sub(r'\1,\n\2', declaration)
def_args = declaration.split('\n')
level = 1
declaration = ""
for clause in def_args:
clause = clause.strip()
clause = KernRe(r'\s+').sub(' ', clause, count=1)
if not clause:
continue
if '}' in clause and level > 1:
level -= 1
if not KernRe(r'^\s*#').match(clause):
declaration += "\t" * level
declaration += "\t" + clause + "\n"
if "{" in clause and "}" not in clause:
level += 1
self.output_declaration(decl_type, declaration_name,
definition=declaration,
definition=self.format_struct_decl(declaration),
purpose=self.entry.declaration_purpose)
def dump_enum(self, ln, proto):