mirror-linux/Documentation/doc-guide
Vincent Mailhol 90f1d896d5 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 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>
2026-01-06 14:42:31 -07:00
..
checktransupdate.rst docs: move checktransupdate.py to tools/docs 2025-10-28 16:01:13 -06:00
contributing.rst docs: move find-unused-docs.sh to tools/docs 2025-10-28 16:01:27 -06:00
hello.dot docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00
index.rst doc-guide: add help documentation checktransupdate.rst 2024-07-30 07:56:22 -06:00
kernel-doc.rst doc-guide: kernel-doc: specify that W=n does not check header files 2026-01-06 14:42:31 -07:00
maintainer-profile.rst docs: add blurb about target audience to maintainer-profile 2024-01-30 13:16:46 -07:00
parse-headers.rst docs: parse-headers.rst: Fix a typo 2025-11-18 09:13:40 -07:00
sphinx.rst docs: move test_doc_build.py to tools/docs 2025-10-28 16:01:24 -06:00
svg_image.svg docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00