Re: [B.A.T.M.A.N.] [PATCHv2 next 03/11] batman-adv: fix multicast kerneldoc

[Antonio Quartulli <antonio@meshcoding.com>]

[-- Attachment #1: Type: text/plain, Size: 1523 bytes --]

Hi Linus,

On 19/03/14 10:03, Linus Lüssing wrote:
> Hi Antonio,
> 
> Two things are confusing me, firstly:
> 
> On Wed, Mar 19, 2014 at 09:08:44AM +0100, Antonio Quartulli wrote:
>> The kerneldoc should always use the third person singular in
>> the long function description.
>> Moreover it should always try use up to 80 chars per line.
> 
> vs.
> 
> On Sun, May 12, 2013 at 12:55:25AM +0200, Antonio Quartulli wrote:
>> For some reason we agreed on not using the third person while describing the
>> function. For consistency I'd suggest you to do the same your kernel doc.

I think the situation is a little confusing because there is no clear
statement anywhere.
We agreed on not using the third person in the function description, but
we use it in the function "long" description (the one after the arguments).

>>
> 
> Secondly:
> 
> Why do you only change it in multicast.{c,h}, why not changing
> things everywhere? For instance translation-table.c sometimes uses
> "Returns", sometimes "Return".

Because these patches are meant to be squashed with what you already
sent before I send them to David (this is why I have create dos many
patches with different Introduced-by clauses and this is also why the
patches are targeting next). They are not going to be sent ad a
standalone set of changes.

Yes, we could "fix" all the kernel docs, but this should be done as a
separated change. If you are willing to do that, please do :)


Cheers,


-- 
Antonio Quartulli


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 901 bytes --]