[PATCH] docs: kdoc_parser: add data/function attributes to ignore

[PATCH] docs: kdoc_parser: add data/function attributes to ignore

[Randy Dunlap]

Recognize and ignore __rcu (in struct members), __private (in struct
members), and __always_unused (in function parameters) to prevent
kernel-doc warnings:

  Warning: include/linux/rethook.h:38 struct member 'void (__rcu *handler' not described in 'rethook'
  Warning: include/linux/hrtimer_types.h:47 Invalid param: enum hrtimer_restart (*__private function)(struct hrtimer *)
  Warning: security/ipe/hooks.c:81 function parameter '__always_unused' not described in 'ipe_mmap_file'
  Warning: security/ipe/hooks.c:109 function parameter '__always_unused' not described in 'ipe_file_mprotect'

There are more of these (in compiler_types.h, compiler_attributes.h)
that can be added as needed.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: linux-doc@vger.kernel.org
---
 tools/lib/python/kdoc/kdoc_parser.py |    3 +++
 1 file changed, 3 insertions(+)

--- linux-next-20251127.orig/tools/lib/python/kdoc/kdoc_parser.py
+++ linux-next-20251127/tools/lib/python/kdoc/kdoc_parser.py
@@ -86,6 +86,8 @@ struct_xforms = [
     (KernRe(r'\s*__counted_by_(le|be)\s*\([^;]*\)', re.S), ' '),
     (KernRe(r'\s*__packed\s*', re.S), ' '),
     (KernRe(r'\s*CRYPTO_MINALIGN_ATTR', re.S), ' '),
+    (KernRe(r'\s*__private', re.S), ' '),
+    (KernRe(r'\s*__rcu', re.S), ' '),
     (KernRe(r'\s*____cacheline_aligned_in_smp', re.S), ' '),
     (KernRe(r'\s*____cacheline_aligned', re.S), ' '),
     (KernRe(r'\s*__cacheline_group_(begin|end)\([^\)]+\);'), ''),
@@ -183,6 +185,7 @@ function_xforms  = [
     (KernRe(r"__weak +"), ""),
     (KernRe(r"__sched +"), ""),
     (KernRe(r"_noprof"), ""),
+    (KernRe(r"__always_unused *"), ""),
     (KernRe(r"__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +"), ""),
     (KernRe(r"__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +"), ""),
     (KernRe(r"__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +"), ""),

Re: [PATCH] docs: kdoc_parser: add data/function attributes to ignore

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> Recognize and ignore __rcu (in struct members), __private (in struct
> members), and __always_unused (in function parameters) to prevent
> kernel-doc warnings:
>
>   Warning: include/linux/rethook.h:38 struct member 'void (__rcu *handler' not described in 'rethook'
>   Warning: include/linux/hrtimer_types.h:47 Invalid param: enum hrtimer_restart (*__private function)(struct hrtimer *)
>   Warning: security/ipe/hooks.c:81 function parameter '__always_unused' not described in 'ipe_mmap_file'
>   Warning: security/ipe/hooks.c:109 function parameter '__always_unused' not described in 'ipe_file_mprotect'
>
> There are more of these (in compiler_types.h, compiler_attributes.h)
> that can be added as needed.
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
> Cc: linux-doc@vger.kernel.org
> ---
>  tools/lib/python/kdoc/kdoc_parser.py |    3 +++
>  1 file changed, 3 insertions(+)

Applied, thanks.

jon