Re: [PATCH 2/3] tty_port: Fix function name and brief desc
From: Tobin C. Harding
Date: Wed Sep 12 2018 - 17:08:35 EST
On Wed, Sep 12, 2018 at 11:31:16AM +0200, Johan Hovold wrote:
> 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
> > - * 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.
Ok, sounds good to me. Thanks for the review.