]> asedeno.scripts.mit.edu Git - linux.git/commit
doc-guide: kernel-doc: add comment about formatting verification
authorMike Rapoport <rppt@linux.vnet.ibm.com>
Tue, 20 Feb 2018 18:36:25 +0000 (20:36 +0200)
committerJonathan Corbet <corbet@lwn.net>
Fri, 23 Feb 2018 15:06:15 +0000 (08:06 -0700)
commit8fcce5803afd4615188fb7017f1d4c6404ca647e
treeeb603feaf43aaba2cf5c5c6165bbf6133502a9e6
parent29b26ae47031e5c8d6cd4ad20b3eaac79c3bf017
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>
Documentation/doc-guide/kernel-doc.rst