linux-kernel - RE: [Intel-wired-lan] [PATCH v2 04/25] docs: kdoc_parser: don't mangle with function defines

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <IA3PR11MB89860FEA17F5958C21A2D6E9E591A@IA3PR11MB8986.namprd11.prod.outlook.com>
Date: Wed, 28 Jan 2026 17:45:08 +0000
From: "Loktionov, Aleksandr" <aleksandr.loktionov@...el.com>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Jonathan Corbet
	<corbet@....net>, Linux Doc Mailing List <linux-doc@...r.kernel.org>
CC: "bpf@...r.kernel.org" <bpf@...r.kernel.org>,
	"intel-wired-lan@...ts.osuosl.org" <intel-wired-lan@...ts.osuosl.org>,
	"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
	"netdev@...r.kernel.org" <netdev@...r.kernel.org>, Peter Zijlstra
	<peterz@...radead.org>, Randy Dunlap <rdunlap@...radead.org>, "Stephen
 Rothwell" <sfr@...b.auug.org.au>
Subject: RE: [Intel-wired-lan] [PATCH v2 04/25] docs: kdoc_parser: don't
 mangle with function defines



> -----Original Message-----
> From: Intel-wired-lan <intel-wired-lan-bounces@...osl.org> On Behalf
> Of Mauro Carvalho Chehab
> Sent: Wednesday, January 28, 2026 5:50 PM
> To: Jonathan Corbet <corbet@....net>; Linux Doc Mailing List <linux-
> doc@...r.kernel.org>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>;
> bpf@...r.kernel.org; intel-wired-lan@...ts.osuosl.org; linux-
> kernel@...r.kernel.org; netdev@...r.kernel.org; Peter Zijlstra
> <peterz@...radead.org>; Randy Dunlap <rdunlap@...radead.org>; Stephen
> Rothwell <sfr@...b.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@...nel.org>
> Acked-by: Randy Dunlap <rdunlap@...radead.org>
> Tested-by: Randy Dunlap <rdunlap@...radead.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@...el.com>