qiurui
/
linux-kernelorg-stable
mirror of https://kernel.googlesource.com/pub/scm/linux/kernel/git/stable/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: kdoc: split top-level prototype parsing out of dump_struct() 

Move the initial split of the prototype into its own function in the
ongoing effort to cut dump_struct() down to size.

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-6-corbet@lwn.net
This commit is contained in:
Jonathan Corbet 2025-08-07 15:16:32 -06:00
parent 64cf83bcd3
commit 0f73441294
1 changed files with 20 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -624,13 +624,11 @@ class KernelDoc:
self.emit_msg(ln,
f"No description found for return value of '{declaration_name}'")
def dump_struct(self, ln, proto):
"""
Store an entry for an struct or union
"""
#
# Split apart a structure prototype; returns (struct|union, name, members) or None
#
def split_struct_proto(self, proto):
type_pattern = r'(struct|union)'
qualifiers = [
"__attribute__",
"__packed",
@ -638,34 +636,33 @@ class KernelDoc:
"____cacheline_aligned_in_smp",
"____cacheline_aligned",
]
definition_body = r'\{(.*)\}\s*' + "(?:" + '|'.join(qualifiers) + ")?"
# Extract struct/union definition
members = None
declaration_name = None
decl_type = None
r = KernRe(type_pattern + r'\s+(\w+)\s*' + definition_body)
if r.search(proto):
decl_type = r.group(1)
declaration_name = r.group(2)
members = r.group(3)
return (r.group(1), r.group(2), r.group(3))
else:
r = KernRe(r'typedef\s+' + type_pattern + r'\s*' + definition_body + r'\s*(\w+)\s*;')
if r.search(proto):
decl_type = r.group(1)
declaration_name = r.group(3)
members = r.group(2)
return (r.group(1), r.group(3), r.group(2))
return None
if not 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}. Prototype was for {decl_type} {declaration_name} instead\n")
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.
@ -695,7 +692,7 @@ class KernelDoc:
# So, we need to have an extra loop on Python to override such
# re limitation.
struct_members = KernRe(type_pattern + r'([^\{\};]+)(\{)([^\{\}]*)(\})([^\{\};]*)(;)')
struct_members = KernRe(r'(struct|union)([^\{\};]+)(\{)([^\{\}]*)(\})([^\{\};]*)(;)')
while True:
tuples = struct_members.findall(members)
if not tuples: