diff options
| author | Vincent Mailhol <mailhol@kernel.org> | 2025-12-25 15:47:37 +0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2026-01-07 00:42:31 +0300 |
| commit | 90f1d896d59f77080e87915dfbd6d9703a37a820 (patch) | |
| tree | 1b156633c6192e875e902f8b8e24a269049acf09 /tools/lib/python/kdoc/__init__.py | |
| parent | 5ce70894f6cade9dc4d7c2a376724c0d8083ff8a (diff) | |
| download | linux-90f1d896d59f77080e87915dfbd6d9703a37a820.tar.xz | |
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 'tools/lib/python/kdoc/__init__.py')
0 files changed, 0 insertions, 0 deletions