linux-kernel - RE: [Intel-wired-lan] [PATCH v3 12/30] docs: kdoc_parser: ignore context analysis and lock attributes

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: <IA3PR11MB8986C0CEB5C55C242A799FA4E59EA@IA3PR11MB8986.namprd11.prod.outlook.com>
Date: Thu, 29 Jan 2026 10:30:16 +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: Randy Dunlap <rdunlap@...radead.org>, "bpf@...r.kernel.org"
	<bpf@...r.kernel.org>, "intel-wired-lan@...ts.osuosl.org"
	<intel-wired-lan@...ts.osuosl.org>, "linux-hardening@...r.kernel.org"
	<linux-hardening@...r.kernel.org>, "linux-kernel@...r.kernel.org"
	<linux-kernel@...r.kernel.org>, "netdev@...r.kernel.org"
	<netdev@...r.kernel.org>, Mauro Carvalho Chehab <mchehab@...nel.org>, Stephen
 Rothwell <sfr@...b.auug.org.au>
Subject: RE: [Intel-wired-lan] [PATCH v3 12/30] docs: kdoc_parser: ignore
 context analysis and lock attributes



> -----Original Message-----
> From: Intel-wired-lan <intel-wired-lan-bounces@...osl.org> On Behalf
> Of Mauro Carvalho Chehab
> Sent: Thursday, January 29, 2026 9:08 AM
> To: Jonathan Corbet <corbet@....net>; Linux Doc Mailing List <linux-
> doc@...r.kernel.org>
> Cc: Randy Dunlap <rdunlap@...radead.org>; bpf@...r.kernel.org; intel-
> wired-lan@...ts.osuosl.org; linux-hardening@...r.kernel.org; linux-
> kernel@...r.kernel.org; netdev@...r.kernel.org; Mauro Carvalho Chehab
> <mchehab@...nel.org>; Stephen Rothwell <sfr@...b.auug.org.au>; Mauro
> Carvalho Chehab <mchehab+huawei@...nel.org>
> Subject: [Intel-wired-lan] [PATCH v3 12/30] docs: kdoc_parser: ignore
> context analysis and lock attributes
> 
> From: Randy Dunlap <rdunlap@...radead.org>
> 
> Drop all context analysis and lock (tracking) attributes to avoid
> kernel-doc warnings.
> 
> Documentation/core-api/kref:328: ../include/linux/kref.h:72: WARNING:
> Invalid C declaration: Expected end of definition. [error at 96]
>   int kref_put_mutex (struct kref *kref, void (*release)(struct kref
> *kref), struct mutex *mutex) __cond_acquires(true# mutex)
>   --------------------------------------------------------------------
> ----------------------------^
> Documentation/core-api/kref:328: ../include/linux/kref.h:94: WARNING:
> Invalid C declaration: Expected end of definition. [error at 92]
>   int kref_put_lock (struct kref *kref, void (*release)(struct kref
> *kref), spinlock_t *lock) __cond_acquires(true# lock)
>   --------------------------------------------------------------------
> ------------------------^
> 
> The regex is suggested by Mauro; mine was too greedy. Thanks.
> Updated context analysis and lock macros list provided by PeterZ.
> Thanks.
> 
> Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
> Closes:
> https://lore.kernel.org/all/20260107161548.45530e1c@canb.auug.org.au/
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
> ---
>  tools/lib/python/kdoc/kdoc_parser.py | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
> 
> diff --git a/tools/lib/python/kdoc/kdoc_parser.py
> b/tools/lib/python/kdoc/kdoc_parser.py
> index 21cc4e19a1e8..92b550189988 100644
> --- a/tools/lib/python/kdoc/kdoc_parser.py
> +++ b/tools/lib/python/kdoc/kdoc_parser.py
> @@ -81,6 +81,8 @@ struct_xforms = [
>      (KernRe(r'\s*__aligned\s*\([^;]*\)', re.S), ' '),
>      (KernRe(r'\s*__counted_by\s*\([^;]*\)', re.S), ' '),
>      (KernRe(r'\s*__counted_by_(le|be)\s*\([^;]*\)', re.S), ' '),
> +    (KernRe(r'\s*__guarded_by\s*\([^\)]*\)', re.S), ' '),
> +    (KernRe(r'\s*__pt_guarded_by\s*\([^\)]*\)', re.S), ' '),
>      (KernRe(r'\s*__packed\s*', re.S), ' '),
>      (KernRe(r'\s*CRYPTO_MINALIGN_ATTR', re.S), ' '),
>      (KernRe(r'\s*__private', re.S), ' '), @@ -165,6 +167,16 @@
> struct_nested_prefixes = [  # the start delimiter.
>  #
>  function_nested_prefixes = [
> +    (re.compile(r"__cond_acquires\s*\("), ""),
> +    (re.compile(r"__cond_releases\s*\("), ""),
> +    (re.compile(r"__acquires\s*\("), ""),
> +    (re.compile(r"__releases\s*\("), ""),
> +    (re.compile(r"__must_hold\s*\("), ""),
> +    (re.compile(r"__must_not_hold\s*\("), ""),
> +    (re.compile(r"__must_hold_shared\s*\("), ""),
> +    (re.compile(r"__cond_acquires_shared\s*\("), ""),
> +    (re.compile(r"__acquires_shared\s*\("), ""),
> +    (re.compile(r"__releases_shared\s*\("), ""),
>      (re.compile(r"__attribute__\s*\("), ""),  ]
> 
> @@ -195,6 +207,7 @@ function_xforms = [
>      (KernRe(r"__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +"),
> ""),
>      (KernRe(r"__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +"), ""),
>      (KernRe(r"DECL_BUCKET_PARAMS\s*\(\s*(\S+)\s*,\s*(\S+)\s*\)"),
> r"\1, \2"),
> +    (KernRe(r"__no_context_analysis\s*"), ""),
>      (KernRe(r"__attribute_const__ +"), ""),  ]
> 
> @@ -204,6 +217,8 @@ function_xforms = [
>  var_xforms = [
>      (KernRe(r"__read_mostly"), ""),
>      (KernRe(r"__ro_after_init"), ""),
> +    (KernRe(r'\s*__guarded_by\s*\([^\)]*\)', re.S), ""),
> +    (KernRe(r'\s*__pt_guarded_by\s*\([^\)]*\)', re.S), ""),
>      (KernRe(r"(?://.*)$"), ""),
>      (KernRe(r"(?:/\*.*\*/)"), ""),
>      (KernRe(r";$"), ""),
> --
> 2.52.0


Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@...el.com>