Messages in this thread | | | Date | Tue, 20 Feb 2018 07:03:06 -0800 | From | Matthew Wilcox <> | Subject | Re: [PATCH] doc-guide: kernel-doc: add comment about formatting verification |
| |
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/kernel-doc -v -none drivers/foo/bar.c > + > Function documentation > ----------------------
And that's not exactly true. "make W=1" will run that exact command. For example:
$ make W=1 net/ipv4/ (...) CC net/ipv4/tcp_input.o net/ipv4/tcp_input.c:4279: warning: Excess function parameter 'dest' description in 'tcp_try_coalesce' CC net/ipv4/tcp_output.o net/ipv4/tcp_output.c:3177: warning: Function parameter or member 'sk' not described in 'tcp_make_synack' (...)
perhaps sneak that information in there somewhere.
Also it'll prompt people to run with W=1, so perhaps they'll fix their more-easily-fixed warnings ;-)
| |