doc-guide: kernel-doc: add comment about formatting verification
PATCH 1/1 doc-guide: kernel-doc: add comment about formatting verification
Currently there is no automated checking for kernel-doc comments except running 'kernel-doc -v -none <filename>'. Mention the possibility to run kernel-doc to verify formatting of the comments in the kernel-doc guide.
Signed-off-by Mike Rapoport <[email protected]>
---
v2:
* fix typo
* add a sentence about using 'make W=n'
Documentation/doc-guide/kernel-doc.rst | 11 +++++++++++ 1 file changed, 11 insertions(+)
Documentation/doc-guide/kernel-doc.rst +11 -0
@@ -44,6 +44,17 @@ that somebody changing the code will also change the documentation. The overview kernel-doc comments may be placed anywhere at the top indentation level. +Running the ``kernel-doc`` tool with increased verbosity and without actual +output generation may be used to verify proper formatting of the +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:: + + make W=n + Function documentation ----------------------
Signature · 1 line
2.7.4
Quoted 5 lines · On Tue, 20 Feb 2018 20:36:25 +0200 Mike Rapoport <[email protected]>…
Currently there is no automated checking for kernel-doc comments except running 'kernel-doc -v -none <filename>'. Mention the possibility to run kernel-doc to verify formatting of the comments in the kernel-doc guide.
Signed-off-by Mike Rapoport <[email protected]>
Applied, thanks.
jon