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

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] [day] [month] [year] [list]

Message-ID: <877bv8rh4p.fsf@trenco.lwn.net>
Date: Sat, 29 Nov 2025 08:30:14 -0700
From: Jonathan Corbet <corbet@....net>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>, Mauro Carvalho Chehab
 <mchehab@...nel.org>, linux-doc@...r.kernel.org
Subject: Re: [PATCH] docs: kdoc_parser: add data/function attributes to ignore

Randy Dunlap <rdunlap@...radead.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@...radead.org>
> ---
> Cc: Jonathan Corbet <corbet@....net>
> Cc: Mauro Carvalho Chehab <mchehab@...nel.org>
> Cc: linux-doc@...r.kernel.org
> ---
>  tools/lib/python/kdoc/kdoc_parser.py |    3 +++
>  1 file changed, 3 insertions(+)

Applied, thanks.

jon