diff mbox

[v4,next,07/11] batman-adv: fix multicast kerneldoc

Message ID 1395251855-30765-3-git-send-email-antonio@meshcoding.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

Antonio Quartulli March 19, 2014, 5:57 p.m. UTC 
  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(-)

Comments

Marek Lindner March 21, 2014, 8:34 a.m. UTC | #1 
On Wednesday 19 March 2014 18:57:31 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.
> 
> 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(-)

Applied in revision 5690930.

Thanks,
Marek
diff mbox

Patch

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,