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: tighten up the array-of-pointers case

Browse Source 
Simplify one gnarly regex and remove another altogether; add a comment
describing what is going on.  There will be no #-substituted commas in this
case, so don't bother trying to put them back.

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-6-corbet@lwn.net
This commit is contained in:
Jonathan Corbet
2025-08-14 09:40:33 -06:00
parent 8f05fbc5af
commit bf6b310d1b
1 changed files with 9 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -527,23 +527,21 @@ class KernelDoc:
dtype = KernRe(r'([^\(]+\(\*?)\s*' + re.escape(param)).sub(r'\1', arg)
self.push_parameter(ln, decl_type, param, dtype,
arg, declaration_name)
#
# The array-of-pointers case. Dig the parameter name out from the middle
# of the declaration.
#
elif KernRe(r'\(.+\)\s*\[').search(arg):
# Array-of-pointers
arg = arg.replace('#', ',')
r = KernRe(r'[^\(]+\(\s*\*\s*([\w\[\].]*?)\s*(\s*\[\s*[\w]+\s*\]\s*)*\)')
r = KernRe(r'[^\(]+\(\s*\*\s*' # Up to "(" and maybe "*"
r'([\w.]*?)' # The actual pointer name
r'\s*(\[\s*\w+\s*\]\s*)*\)') # The [array portion]
if r.match(arg):
param = r.group(1)
else:
self.emit_msg(ln, f"Invalid param: {arg}")
param = arg
dtype = KernRe(r'([^\(]+\(\*?)\s*' + re.escape(param)).sub(r'\1', arg)
self.push_parameter(ln, decl_type, param, dtype,
arg, declaration_name)
dtype = arg.replace(param, '')
self.push_parameter(ln, decl_type, param, dtype, arg, declaration_name)
elif arg:
#
# Clean up extraneous spaces and split the string at commas; the first