On Tue, 20 Feb 2018 20:36:25 +0200
Mike Rapoport wrote:
> 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 Ra
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
---
v2:
* fix typo
* add a sentence about using 'make W=n'
On Tue, Feb 20, 2018 at 04:54:44PM +0200, Mike Rapoport wrote:
> level.
>
> +Running the ``kernel-doc`` tool with increased verbosity and without actual
> +output generation may be used to verify proper formating of the
"formatting"
> +documentation comments. For example::
> +
> + scripts/
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
---
Documentation/doc-guide/kernel-doc.rst | 6 ++
1 fi