From: Antonio Quartulli <antonio@meshcoding.com>
To: b.a.t.m.a.n@lists.open-mesh.org
Cc: Antonio Quartulli <antonio@meshcoding.com>
Subject: [B.A.T.M.A.N.] [PATCHv4 next 07/11] batman-adv: fix multicast kerneldoc
Date: Wed, 19 Mar 2014 18:57:31 +0100 [thread overview]
Message-ID: <1395251855-30765-3-git-send-email-antonio@meshcoding.com> (raw)
In-Reply-To: <1395251855-30765-1-git-send-email-antonio@meshcoding.com>
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.
Introduced by f2ed1502191a37abb39e3e2c80cca07f0f3bb411
("batman-adv: Send multicast packets to nodes with a WANT_ALL flag")
Cc: Linus Lüssing <linus.luessing@web.de>
Signed-off-by: Antonio Quartulli <antonio@meshcoding.com>
---
multicast.c | 20 ++++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/multicast.c b/multicast.c
index 25b2632..53d82e2 100644
--- a/multicast.c
+++ b/multicast.c
@@ -363,9 +363,9 @@ static int batadv_mcast_forw_mode_check(struct batadv_priv *bat_priv,
* @bat_priv: the bat priv with all the soft interface information
* @ethhdr: ethernet header of a packet
*
- * Return the number of nodes which want all IPv4 multicast traffic if
- * the given ethhdr is from an IPv4 packet or the number of nodes which want
- * all IPv6 traffic if it matches an IPv6 packet.
+ * Returns the number of nodes which want all IPv4 multicast traffic if the
+ * given ethhdr is from an IPv4 packet or the number of nodes which want all
+ * IPv6 traffic if it matches an IPv6 packet.
*/
static int batadv_mcast_forw_want_all_ip_count(struct batadv_priv *bat_priv,
struct ethhdr *ethhdr)
@@ -401,8 +401,8 @@ batadv_mcast_forw_tt_node_get(struct batadv_priv *bat_priv,
* batadv_mcast_want_forw_ipv4_node_get - get a node with an ipv4 flag
* @bat_priv: the bat priv with all the soft interface information
*
- * Return an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 flag set
- * and increase its refcount.
+ * Returns an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 flag set and
+ * increases its refcount.
*/
static struct batadv_orig_node *
batadv_mcast_forw_ipv4_node_get(struct batadv_priv *bat_priv)
@@ -428,8 +428,8 @@ unlock:
* batadv_mcast_want_forw_ipv6_node_get - get a node with an ipv6 flag
* @bat_priv: the bat priv with all the soft interface information
*
- * Return an orig_node which has the BATADV_MCAST_WANT_ALL_IPV6 flag set
- * and increase its refcount.
+ * Returns an orig_node which has the BATADV_MCAST_WANT_ALL_IPV6 flag set
+ * and increases its refcount.
*/
static struct batadv_orig_node *
batadv_mcast_forw_ipv6_node_get(struct batadv_priv *bat_priv)
@@ -456,9 +456,9 @@ unlock:
* @bat_priv: the bat priv with all the soft interface information
* @ethhdr: an ethernet header to determine the protocol family from
*
- * Return an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 or
- * BATADV_MCAST_WANT_ALL_IPV6 flag, depending on the provided ethhdr, set
- * and increase its refcount.
+ * Returns an orig_node which has the BATADV_MCAST_WANT_ALL_IPV4 or
+ * BATADV_MCAST_WANT_ALL_IPV6 flag, depending on the provided ethhdr, set and
+ * increases its refcount.
*/
static struct batadv_orig_node *
batadv_mcast_forw_ip_node_get(struct batadv_priv *bat_priv,
--
1.8.3.2
next prev parent reply other threads:[~2014-03-19 17:57 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-03-19 17:55 [B.A.T.M.A.N.] [PATCHv4 next 01/11] batman-adv: remove useless goto Antonio Quartulli
2014-03-19 17:55 ` [B.A.T.M.A.N.] [PATCHv4 next 02/11] batman-adv: don't mess up with the netdev refcounting if not needed Antonio Quartulli
2014-03-21 8:29 ` Marek Lindner
2014-03-19 17:55 ` [B.A.T.M.A.N.] [PATCHv4 next 03/11] batman-adv: fix multicast kerneldoc Antonio Quartulli
2014-03-21 8:30 ` Marek Lindner
2014-03-19 17:55 ` [B.A.T.M.A.N.] [PATCHv4 next 04/11] " Antonio Quartulli
2014-03-21 8:31 ` Marek Lindner
2014-03-19 17:57 ` [B.A.T.M.A.N.] [PATCHv4 next 05/11] " Antonio Quartulli
2014-03-19 17:57 ` [B.A.T.M.A.N.] [PATCHv4 next 06/11] " Antonio Quartulli
2014-03-21 8:33 ` Marek Lindner
2014-03-19 17:57 ` Antonio Quartulli [this message]
2014-03-21 8:34 ` [B.A.T.M.A.N.] [PATCHv4 next 07/11] " Marek Lindner
2014-03-19 17:57 ` [B.A.T.M.A.N.] [PATCHv4 next 08/11] batman-adv: adjust copyright disclaimer in multicast files Antonio Quartulli
2014-03-21 8:35 ` Marek Lindner
2014-03-19 17:57 ` [B.A.T.M.A.N.] [PATCHv4 next 09/11] batman-adv: fix code style Antonio Quartulli
2014-03-21 8:37 ` Marek Lindner
2014-03-19 17:57 ` [B.A.T.M.A.N.] [PATCHv4 next 10/11] batman-adv: fix more " Antonio Quartulli
2014-03-21 8:39 ` Marek Lindner
2014-03-19 17:57 ` [B.A.T.M.A.N.] [PATCHv4 next 11/11] " Antonio Quartulli
2014-03-21 8:40 ` Marek Lindner
2014-03-21 8:32 ` [B.A.T.M.A.N.] [PATCHv4 next 05/11] batman-adv: fix multicast kerneldoc Marek Lindner
2014-03-21 8:27 ` [B.A.T.M.A.N.] [PATCHv4 next 01/11] batman-adv: remove useless goto Marek Lindner
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=1395251855-30765-3-git-send-email-antonio@meshcoding.com \
--to=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;
as well as URLs for NNTP newsgroup(s).