[PATCH v2 04/25] docs: kdoc_parser: don't mangle with function defines

Mauro Carvalho Chehab posted 25 patches 1 week, 3 days ago
There is a newer version of this series
[PATCH v2 04/25] docs: kdoc_parser: don't mangle with function defines
Posted by Mauro Carvalho Chehab 1 week, 3 days ago
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 <mchehab+huawei@kernel.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
---
 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
RE: [Intel-wired-lan] [PATCH v2 04/25] docs: kdoc_parser: don't mangle with function defines
Posted by Loktionov, Aleksandr 1 week, 3 days ago

> -----Original Message-----
> From: Intel-wired-lan <intel-wired-lan-bounces@osuosl.org> On Behalf
> Of Mauro Carvalho Chehab
> Sent: Wednesday, January 28, 2026 5:50 PM
> To: Jonathan Corbet <corbet@lwn.net>; Linux Doc Mailing List <linux-
> doc@vger.kernel.org>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>;
> bpf@vger.kernel.org; intel-wired-lan@lists.osuosl.org; linux-
> kernel@vger.kernel.org; netdev@vger.kernel.org; Peter Zijlstra
> <peterz@infradead.org>; Randy Dunlap <rdunlap@infradead.org>; Stephen
> Rothwell <sfr@canb.auug.org.au>
> Subject: [Intel-wired-lan] [PATCH v2 04/25] 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 <mchehab+huawei@kernel.org>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>
> ---
>  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 <aleksandr.loktionov@intel.com>