rjmcmahon
/
umber-kernel
1
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

docs: kdoc: add a couple more comments in create_parameter_list() 

Make what the final code is doing a bit more clear to slow readers like me.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250814154035.328769-5-corbet@lwn.net
This commit is contained in:
Jonathan Corbet 2025-08-14 09:40:32 -06:00
parent 05d72fe072
commit 8f05fbc5af
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -568,12 +568,18 @@ class KernelDoc:
bitfield_re = KernRe(r'(.*?):(\w+)') bitfield_re = KernRe(r'(.*?):(\w+)')
for param in args: for param in args:
#
# For pointers, shift the star(s) from the variable name to the
# type declaration.
#
r = KernRe(r'^(\*+)\s*(.*)') r = KernRe(r'^(\*+)\s*(.*)')
if r.match(param): if r.match(param):
self.push_parameter(ln, decl_type, r.group(2), self.push_parameter(ln, decl_type, r.group(2),
f"{dtype} {r.group(1)}", f"{dtype} {r.group(1)}",
arg, declaration_name) arg, declaration_name)
#
# Perform a similar shift for bitfields.
#
elif bitfield_re.search(param): elif bitfield_re.search(param):
if dtype != "": # Skip unnamed bit-fields if dtype != "": # Skip unnamed bit-fields
self.push_parameter(ln, decl_type, bitfield_re.group(1), self.push_parameter(ln, decl_type, bitfield_re.group(1),