github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-12 16:18:45 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc-guide: kernel-doc: specify that W=n does not check header files

Browse Source 
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 3a025e1d1c ("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>
This commit is contained in:
Vincent Mailhol 2025-12-25 13:47:37 +01:00 committed by Jonathan Corbet
parent 5ce70894f6
commit 90f1d896d5
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/doc-guide/kernel-doc.rst
View File

@ -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
----------------------