raspi/linux
1
0
Fork 1
mirror of https://github.com/raspberrypi/linux.git synced 2025-12-07 02:19:54 +00:00
Code Issues Projects Releases Wiki Activity

docs: kdoc: further rewrite_struct_members() cleanup

Browse Source 
Get rid of some redundant checks, and generally tighten up the code; no
logical change.

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-11-corbet@lwn.net
This commit is contained in:
Jonathan Corbet
2025-08-07 15:16:37 -06:00
parent a8c4b0a8f1
commit e6dd4e2a5c
1 changed files with 41 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -673,73 +673,69 @@ class KernelDoc:
while tuples:
for t in tuples:
newmember = ""
maintype = t[0]
s_ids = t[5]
content = t[3]
oldmember = "".join(t)
for s_id in s_ids.split(','):
oldmember = "".join(t) # Reconstruct the original formatting
dtype, name, lbr, content, rbr, rest, semi = t
#
# Pass through each field name, normalizing the form and formatting.
#
for s_id in rest.split(','):
s_id = s_id.strip()
newmember += f"{maintype} {s_id}; "
newmember += f"{dtype} {s_id}; "
#
# Remove bitfield/array/pointer info, getting the bare name.
#
s_id = KernRe(r'[:\[].*').sub('', s_id)
s_id = KernRe(r'^\s*\**(\S+)\s*').sub(r'\1', s_id)
#
# Pass through the members of this inner structure/union.
#
for arg in content.split(';'):
arg = arg.strip()
if not arg:
continue
#
# Look for (type)(*name)(args) - pointer to function
#
r = KernRe(r'^([^\(]+\(\*?\s*)([\w.]*)(\s*\).*)')
if r.match(arg):
dtype, name, extra = r.group(1), r.group(2), r.group(3)
# Pointer-to-function
dtype = r.group(1)
name = r.group(2)
extra = r.group(3)
if not name:
continue
if not s_id:
# Anonymous struct/union
newmember += f"{dtype}{name}{extra}; "
else:
newmember += f"{dtype}{s_id}.{name}{extra}; "
#
# Otherwise a non-function member.
#
else:
# Handle bitmaps
#
# Remove bitmap and array portions and spaces around commas
#
arg = KernRe(r':\s*\d+\s*').sub('', arg)
# Handle arrays
arg = KernRe(r'\[.*\]').sub('', arg)
# Handle multiple IDs
arg = KernRe(r'\s*,\s*').sub(',', arg)
#
# Look for a normal decl - "type name[,name...]"
#
r = KernRe(r'(.*)\s+([\S+,]+)')
if r.search(arg):
dtype = r.group(1)
names = r.group(2)
for name in r.group(2).split(','):
name = KernRe(r'^\s*\**(\S+)\s*').sub(r'\1', name)
if not s_id:
# Anonymous struct/union
newmember += f"{r.group(1)} {name}; "
else:
newmember += f"{r.group(1)} {s_id}.{name}; "
else:
newmember += f"{arg}; "
continue
for name in names.split(','):
name = KernRe(r'^\s*\**(\S+)\s*').sub(r'\1', name).strip()
if not name:
continue
if not s_id:
# Anonymous struct/union
newmember += f"{dtype} {name}; "
else:
newmember += f"{dtype} {s_id}.{name}; "
#
# At the end of the s_id loop, replace the original declaration with
# the munged version.
#
members = members.replace(oldmember, newmember)
#
# End of the tuple loop - search again and see if there are outer members
# that now turn up.
#
tuples = struct_members.findall(members)
return members