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: split struct-member rewriting out of dump_struct()

Browse Source 
The massive loop that massages struct members shares no data with the rest
of dump_struct(); split it out into its own function.  Code movement only,
no other changes.

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-7-corbet@lwn.net
This commit is contained in:
Jonathan Corbet
2025-08-07 15:16:33 -06:00
parent 0f73441294
commit 77e3c875f0
1 changed files with 34 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -647,37 +647,7 @@ class KernelDoc:
return (r.group(1), r.group(3), r.group(2))
return None
def dump_struct(self, ln, proto):
"""
Store an entry for an struct or union
"""
#
# Do the basic parse to get the pieces of the declaration.
#
struct_parts = self.split_struct_proto(proto)
if not struct_parts:
self.emit_msg(ln, f"{proto} error: Cannot parse struct or union!")
return
decl_type, declaration_name, members = struct_parts
if self.entry.identifier != declaration_name:
self.emit_msg(ln, f"expecting prototype for {decl_type} {self.entry.identifier}. "
f"Prototype was for {decl_type} {declaration_name} instead\n")
return
#
# Go through the list of members applying all of our transformations.
#
members = trim_private_members(members)
for search, sub in struct_prefixes:
members = search.sub(sub, members)
nested = NestedMatch()
for search, sub in struct_nested_prefixes:
members = nested.sub(search, sub, members)
# Keeps the original declaration as-is
declaration = members
def rewrite_struct_members(self, members):
# Split nested struct/union elements
#
# This loop was simpler at the original kernel-doc perl version, as
@@ -768,6 +738,39 @@ class KernelDoc:
newmember += f"{dtype} {s_id}.{name}; "
members = members.replace(oldmember, newmember)
return members
def dump_struct(self, ln, proto):
"""
Store an entry for an struct or union
"""
#
# Do the basic parse to get the pieces of the declaration.
#
struct_parts = self.split_struct_proto(proto)
if not struct_parts:
self.emit_msg(ln, f"{proto} error: Cannot parse struct or union!")
return
decl_type, declaration_name, members = struct_parts
if self.entry.identifier != declaration_name:
self.emit_msg(ln, f"expecting prototype for {decl_type} {self.entry.identifier}. "
f"Prototype was for {decl_type} {declaration_name} instead\n")
return
#
# Go through the list of members applying all of our transformations.
#
members = trim_private_members(members)
for search, sub in struct_prefixes:
members = search.sub(sub, members)
nested = NestedMatch()
for search, sub in struct_nested_prefixes:
members = nested.sub(search, sub, members)
# Keeps the original declaration as-is
declaration = members
members = self.rewrite_struct_members(members)
# Ignore other nested elements, like enums
members = re.sub(r'(\{[^\{\}]*\})', '', members)