diff options
| author | Vincent Mailhol <mailhol@kernel.org> | 2025-12-25 13:47:37 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2026-01-06 14:42:31 -0700 |
| commit | 90f1d896d59f77080e87915dfbd6d9703a37a820 (patch) | |
| tree | 1b156633c6192e875e902f8b8e24a269049acf09 /Documentation/doc-guide | |
| parent | 5ce70894f6cade9dc4d7c2a376724c0d8083ff8a (diff) | |
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>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index 0de0e344e10d..b56128d7f5c3 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 ---------------------- |