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

[Jonathan Corbet]

Vincent Mailhol <mailhol@xxxxxxxxxx> 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@xxxxxxxxxx>
> ---
> 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@xxxxxxxxxx/
> ---
>  Documentation/doc-guide/kernel-doc.rst | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)

Applied, thanks.

jon