From: Vincent Mailhol Date: Thu, 25 Dec 2025 12:47:37 +0000 (+0100) Subject: doc-guide: kernel-doc: specify that W=n does not check header files X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=90f1d896d59f77080e87915dfbd6d9703a37a820;p=thirdparty%2Fkernel%2Flinux.git 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 Signed-off-by: Jonathan Corbet Message-ID: <20251225-doc-format-check-v1-1-dff637a4d275@kernel.org> --- diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 0de0e344e10d5..b56128d7f5c3a 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -56,11 +56,14 @@ documentation comments. For example:: scripts/kernel-doc -v -none drivers/foo/bar.c -The documentation format is verified by the kernel build when it is -requested to perform extra gcc checks:: +The documentation format of ``.c`` files is also verified by the kernel build +when it is requested to perform extra gcc checks:: make W=n +However, the above command does not verify header files. These should be checked +separately using ``kernel-doc``. + Function documentation ----------------------