public-mirrors/linux
1
0
Fork 0
mirror of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-09-18 22:14:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: kdoc: some tweaks to process_proto_function()

Browse source 
Add a set of comments to process_proto_function and reorganize the logic
slightly; no functional change.

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tested-by: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250703184403.274408-6-corbet@lwn.net
This commit is contained in:
Jonathan Corbet 2025-07-03 12:44:01 -06:00
parent b8ac0259f8
commit 414ccf92ae
1 changed files with 24 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1553,39 +1553,44 @@ class KernelDoc:
"""Ancillary routine to process a function prototype"""
# strip C99-style comments to end of line
r = KernRe(r"\/\/.*$", re.S)
line = r.sub('', line)
line = KernRe(r"\/\/.*$", re.S).sub('', line)
#
# Soak up the line's worth of prototype text, stopping at { or ; if present.
#
if KernRe(r'\s*#\s*define').match(line):
self.entry.prototype = line
elif line.startswith('#'):
# Strip other macros like #ifdef/#ifndef/#endif/...
pass
else:
elif not line.startswith('#'): # skip other preprocessor stuff
r = KernRe(r'([^\{]*)')
if r.match(line):
self.entry.prototype += r.group(1) + " "
#
# If we now have the whole prototype, clean it up and declare victory.
#
if '{' in line or ';' in line or KernRe(r'\s*#\s*define').match(line):
# strip comments and surrounding spaces
r = KernRe(r'/\*.*\*/')
self.entry.prototype = r.sub('', self.entry.prototype).strip()
self.entry.prototype = KernRe(r'/\*.*\*/').sub('', self.entry.prototype).strip()
#
# Handle self.entry.prototypes for function pointers like:
# int (*pcs_config)(struct foo)
# by turning it into
# int pcs_config(struct foo)
#
r = KernRe(r'^(\S+\s+)\(\s*\*(\S+)\)')
self.entry.prototype = r.sub(r'\1\2', self.entry.prototype)
#
# Handle special declaration syntaxes
#
if 'SYSCALL_DEFINE' in self.entry.prototype:
self.entry.prototype = self.syscall_munge(ln,
self.entry.prototype)
r = KernRe(r'TRACE_EVENT|DEFINE_EVENT|DEFINE_SINGLE_EVENT')
if r.search(self.entry.prototype):
self.entry.prototype = self.tracepoint_munge(ln,
self.entry.prototype)
else:
r = KernRe(r'TRACE_EVENT|DEFINE_EVENT|DEFINE_SINGLE_EVENT')
if r.search(self.entry.prototype):
self.entry.prototype = self.tracepoint_munge(ln,
self.entry.prototype)
#
# ... and we're done
#
self.dump_function(ln, self.entry.prototype)
self.reset_state(ln)