> -----Original Message----- > From: Intel-wired-lan <[email protected]> On Behalf > Of Mauro Carvalho Chehab > Sent: Thursday, January 29, 2026 9:08 AM > To: Jonathan Corbet <[email protected]>; Linux Doc Mailing List <linux- > [email protected]> > Cc: Mauro Carvalho Chehab <[email protected]>; > [email protected]; [email protected]; linux- > [email protected]; [email protected]; > [email protected]; Mauro Carvalho Chehab <[email protected]>; > Randy Dunlap <[email protected]> > Subject: [Intel-wired-lan] [PATCH v3 04/30] docs: kdoc_parser: don't > mangle with function defines > > Mangling with #defines is not nice, as we may end removing the macro > names, preventing several macros from being properly documented. > > Also, on defines, we have something like: > > #define foo(a1, a2, a3, ...) \ > /* some real implementation */ > > The prototype part (first line on this example) won't contain any > macros, so no need to apply any regexes on it. > > With that, move the apply_transforms() logic to ensure that it will be > called only on functions. > > Signed-off-by: Mauro Carvalho Chehab <[email protected]> > Acked-by: Randy Dunlap <[email protected]> > Tested-by: Randy Dunlap <[email protected]> > --- > tools/lib/python/kdoc/kdoc_parser.py | 12 +++++++----- > 1 file changed, 7 insertions(+), 5 deletions(-) > > diff --git a/tools/lib/python/kdoc/kdoc_parser.py > b/tools/lib/python/kdoc/kdoc_parser.py > index 0b68b140cd02..3ba2cda2487a 100644 > --- a/tools/lib/python/kdoc/kdoc_parser.py > +++ b/tools/lib/python/kdoc/kdoc_parser.py > @@ -163,7 +163,7 @@ struct_nested_prefixes = [ # # Transforms for > function prototypes # -function_xforms = [ > +function_xforms = [ > (KernRe(r"^static +"), ""), > (KernRe(r"^extern +"), ""), > (KernRe(r"^asmlinkage +"), ""), > @@ -1065,10 +1065,7 @@ class KernelDoc: > found = func_macro = False > return_type = '' > decl_type = 'function' > - # > - # Apply the initial transformations. > - # > - prototype = apply_transforms(function_xforms, prototype) > + > # > # If we have a macro, remove the "#define" at the front. > # > @@ -1087,6 +1084,11 @@ class KernelDoc: > declaration_name = r.group(1) > func_macro = True > found = True > + else: > + # > + # Apply the initial transformations. > + # > + prototype = apply_transforms(function_xforms, prototype) > > # Yes, this truly is vile. We are looking for: > # 1. Return type (may be nothing if we're looking at a macro) > -- > 2.52.0
Reviewed-by: Aleksandr Loktionov <[email protected]>
