From: Mike Rapoport Date: Tue, 20 Feb 2018 18:36:25 +0000 (+0200) Subject: doc-guide: kernel-doc: add comment about formatting verification X-Git-Tag: v4.17-rc1~149^2~53 X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=8fcce5803afd4615188fb7017f1d4c6404ca647e;p=users%2Fwilly%2Flinux.git 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 '. Mention the possibility to run kernel-doc to verify formatting of the comments in the kernel-doc guide. Signed-off-by: Mike Rapoport Signed-off-by: Jonathan Corbet --- diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst index c6c329708d8a..80383b1a574a 100644 --- a/Documentation/doc-guide/kernel-doc.rst +++ b/Documentation/doc-guide/kernel-doc.rst @@ -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 ----------------------