Messages in this thread | | | Date | Wed, 12 Sep 2018 11:31:16 +0200 | From | Johan Hovold <> | Subject | Re: [PATCH 2/3] tty_port: Fix function name and brief desc |
| |
On Wed, Sep 12, 2018 at 05:50:43PM +1000, Tobin C. Harding wrote: > File contains kernel-doc function comments that are not in the correct > style. > > - Add '()' to function names > - Capitalise brief description and append a full stop.
Cleaning up these comments may not be a bad idea, but I have my doubts about this particular item. Many descriptions aren't full sentences and still won't be even if you capitalise and slap a full stop there, for example:
> - * tty_port_hangup - hangup helper > + * tty_port_hangup() - Hangup helper.
There's no requirement to use full sentences, and the old kernel-doc nano doc uses incomplete ones, as do most (?) kernel-doc comments throughout the kernel.
I'd just drop this part of the patch.
> - Use correct spacing for function name / brief description as per the > kernel docs (Documentation/doc-guide/kernel-doc.rst) > > /** > * function_name() - Brief description of function. > * @arg1: Describe the first argument. > > - Fix spacing for kernel-doc function comments (no tab space after '*'). > > These changes all touch the same lines so do them in a single patch. > > Signed-off-by: Tobin C. Harding <me@tobin.cc>
Thanks, Johan
| |