]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
doc-guide: kernel-doc: specify that W=n does not check header files
authorVincent Mailhol <mailhol@kernel.org>
Thu, 25 Dec 2025 12:47:37 +0000 (13:47 +0100)
committerJonathan Corbet <corbet@lwn.net>
Tue, 6 Jan 2026 21:42:31 +0000 (14:42 -0700)
commit90f1d896d59f77080e87915dfbd6d9703a37a820
tree1b156633c6192e875e902f8b8e24a269049acf09
parent5ce70894f6cade9dc4d7c2a376724c0d8083ff8a
doc-guide: kernel-doc: specify that W=n does not check header files

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
Signed-off-by: Vincent Mailhol <mailhol@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251225-doc-format-check-v1-1-dff637a4d275@kernel.org>
Documentation/doc-guide/kernel-doc.rst