diff options
| author |   Mike Rapoport <rppt@linux.vnet.ibm.com> | 2018-02-20 20:36:25 +0200 |
|---|---|---|
| committer |   Jonathan Corbet <corbet@lwn.net> | 2018-02-23 08:06:15 -0700 |
| commit | 8fcce5803afd4615188fb7017f1d4c6404ca647e (patch) | |
| tree | eb603feaf43aaba2cf5c5c6165bbf6133502a9e6 /Documentation/doc-guide | |
| parent | doc: module-signing.rst: Fix reST formatting (diff) | |
| download | wireguard-linux-8fcce5803afd4615188fb7017f1d4c6404ca647e.tar.xz wireguard-linux-8fcce5803afd4615188fb7017f1d4c6404ca647e.zip | |
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 <rppt@linux.vnet.ibm.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/doc-guide')
| -rw-r--r-- | Documentation/doc-guide/kernel-doc.rst | 11 |
1 files changed, 11 insertions, 0 deletions
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 ---------------------- |