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 06/11] batman-adv: fix multicast kerneldoc
Date: Wed, 19 Mar 2014 18:57:30 +0100 [thread overview]
Message-ID: <1395251855-30765-2-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 90ad6a40c80323805be1e86504385de2bd861f0a
("batman-adv: Modified forwarding behaviour for multicast packets")
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 5bc0703..25b2632 100644
--- a/multicast.c
+++ b/multicast.c
@@ -288,11 +288,11 @@ static int batadv_mcast_forw_mode_check_ipv4(struct batadv_priv *bat_priv,
* @skb: the IPv6 packet to check
* @is_unsnoopable: stores whether the destination is snoopable
*
- * Check whether the given IPv6 packet has the potential to
- * be forwarded with a mode more optimal than classic flooding.
+ * Checks whether the given IPv6 packet has the potential to be forwarded with a
+ * mode more optimal than classic flooding.
*
- * If so then return 0. Otherwise -EINVAL is returned or -ENOMEM if we are
- * out of memory.
+ * If so then returns 0. Otherwise -EINVAL is returned or -ENOMEM if we are out
+ * of memory.
*/
static int batadv_mcast_forw_mode_check_ipv6(struct batadv_priv *bat_priv,
struct sk_buff *skb,
@@ -328,11 +328,11 @@ static int batadv_mcast_forw_mode_check_ipv6(struct batadv_priv *bat_priv,
* @skb: the multicast frame to check
* @is_unsnoopable: stores whether the destination is snoopable
*
- * Check whether the given multicast ethernet frame has the potential to
- * be forwarded with a mode more optimal than classic flooding.
+ * Checks whether the given multicast ethernet frame has the potential to be
+ * forwarded with a mode more optimal than classic flooding.
*
- * If so then return 0. Otherwise -EINVAL is returned or -ENOMEM if we are
- * out of memory.
+ * If so then returns 0. Otherwise -EINVAL is returned or -ENOMEM if we are out
+ * of memory.
*/
static int batadv_mcast_forw_mode_check(struct batadv_priv *bat_priv,
struct sk_buff *skb,
@@ -386,7 +386,7 @@ static int batadv_mcast_forw_want_all_ip_count(struct batadv_priv *bat_priv,
* @bat_priv: the bat priv with all the soft interface information
* @ethhdr: the ether header containing the multicast destination
*
- * Return an orig_node matching the multicast address provided by ethhdr
+ * Returns an orig_node matching the multicast address provided by ethhdr
* via a translation table lookup. This increases the returned nodes refcount.
*/
static struct batadv_orig_node *
@@ -508,7 +508,7 @@ unlock:
* @skb: The multicast packet to check
* @orig: an originator to be set to forward the skb to
*
- * Return the forwarding mode as enum batadv_forw_mode and in case of
+ * Returns the forwarding mode as enum batadv_forw_mode and in case of
* BATADV_FORW_SINGLE set the orig to the single originator the skb
* should be forwarded to.
*/
--
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 ` Antonio Quartulli [this message]
2014-03-21 8:33 ` [B.A.T.M.A.N.] [PATCHv4 next 06/11] " Marek Lindner
2014-03-19 17:57 ` [B.A.T.M.A.N.] [PATCHv4 next 07/11] " Antonio Quartulli
2014-03-21 8:34 ` 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-2-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).