linux-kernel - Re: [PATCH] doc-guide: kernel-doc: specify that W=n does not check header files

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: <874ioye7ty.fsf@trenco.lwn.net>
Date: Tue, 06 Jan 2026 14:42:49 -0700
From: Jonathan Corbet <corbet@....net>
To: Vincent Mailhol <mailhol@...nel.org>, Mike Rapoport
 <rppt@...ux.vnet.ibm.com>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, Vincent Mailhol
 <mailhol@...nel.org>
Subject: Re: [PATCH] doc-guide: kernel-doc: specify that W=n does not check
 header files

Vincent Mailhol <mailhol@...nel.org> writes:

> The documentation states that:
>
>   make W=n
>
> can be used to verify the documentation format. This is true for .c
> files but not for headers [1].
>
> Modify the documentation to specify that headers files are not covered
> by make W=n and that these need to be checked separately with
> scripts/kernel-doc.
>
> [1] commit 3a025e1d1c2e ("Add optional check for bad kernel-doc comments")
> Link: https://git.kernel.org/torvalds/c/3a025e1d1c2e
>
> Fixes: 8fcce5803afd ("doc-guide: kernel-doc: add comment about formatting verification")
> Signed-off-by: Vincent Mailhol <mailhol@...nel.org>
> ---
> This is a resend of a patch which I sent more than two years ago, on
> which I got no answers and which I then forgot about.
>
> Link: https://lore.kernel.org/all/20230531093951.358769-1-mailhol.vincent@wanadoo.fr/
> ---
>  Documentation/doc-guide/kernel-doc.rst | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)

Applied, thanks.

jon