From: "Linus Lüssing" <linus.luessing@web.de>
To: Antonio Quartulli <antonio@meshcoding.com>
Cc: b.a.t.m.a.n@lists.open-mesh.org
Subject: Re: [B.A.T.M.A.N.] [PATCHv2 next 03/11] batman-adv: fix multicast kerneldoc
Date: Wed, 19 Mar 2014 10:03:16 +0100 [thread overview]
Message-ID: <20140319090316.GH5208@Linus-Debian> (raw)
In-Reply-To: <1395216532-31099-3-git-send-email-antonio@meshcoding.com>
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.
>
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".
Or functions in translation-table.c using first person in their
description:
* batadv_tt_prepare_tvlv_global_data()
* batadv_tt_prepare_tvlv_local_data()
* batadv_tt_global_add()
* batadv_tt_global_del_orig_entry()
* batadv_tt_global_del_orig_node()
* batadv_send_roam_adv()
* batadv_tt_local_resize_to_mtu()
While these using the third one:
* batadv_transtable_best_orig()
* batadv_tt_global_print_entry()
* batadv_tt_global_crc()
* batadv_tt_check_roam_count()
Cheers, Linus
next prev parent reply other threads:[~2014-03-19 9:03 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-19 8:08 [B.A.T.M.A.N.] [PATCHv2 next 01/11] batman-adv: remove useless goto Antonio Quartulli
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 02/11] batman-adv: don't mess up with the netdev refcounting if not needed Antonio Quartulli
2014-03-19 10:02 ` Linus Lüssing
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 03/11] batman-adv: fix multicast kerneldoc Antonio Quartulli
2014-03-19 9:03 ` Linus Lüssing [this message]
2014-03-19 9:12 ` Antonio Quartulli
2014-03-19 9:38 ` Linus Lüssing
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 04/11] " Antonio Quartulli
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 05/11] " Antonio Quartulli
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 06/11] " Antonio Quartulli
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 07/11] " Antonio Quartulli
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 08/11] batman-adv: adjust copyright disclaimer in multicast files Antonio Quartulli
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 09/11] batman-adv: fix code style Antonio Quartulli
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 10/11] batman-adv: fix more " Antonio Quartulli
2014-03-19 8:08 ` [B.A.T.M.A.N.] [PATCHv2 next 11/11] " Antonio Quartulli
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20140319090316.GH5208@Linus-Debian \
--to=linus.luessing@web.de \
--cc=antonio@meshcoding.com \
--cc=b.a.t.m.a.n@lists.open-mesh.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox