diff mbox

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

Message ID 1395251855-30765-1-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 f70c60d236cddb28d9e576de774ad97f9b0fd1b7
("batman-adv: Announce new capability via multicast TVLV")

Cc: Linus Lüssing <linus.luessing@web.de>
Signed-off-by: Antonio Quartulli <antonio@meshcoding.com>
---
 multicast.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Comments

Marek Lindner March 21, 2014, 8:32 a.m. UTC | #1 
On Wednesday 19 March 2014 18:57:29 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 f70c60d236cddb28d9e576de774ad97f9b0fd1b7
> ("batman-adv: Announce new capability via multicast TVLV")
> 
> Cc: Linus Lüssing <linus.luessing@web.de>
> Signed-off-by: Antonio Quartulli <antonio@meshcoding.com>
> ---
>  multicast.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)

Applied in revision 3b44ced.

Thanks,
Marek
diff mbox

Patch

diff --git a/multicast.c b/multicast.c
index ae2cb48..5bc0703 100644
--- a/multicast.c
+++ b/multicast.c
@@ -179,11 +179,11 @@  static bool batadv_mcast_has_bridge(struct batadv_priv *bat_priv)
  * batadv_mcast_mla_tvlv_update - update multicast tvlv
  * @bat_priv: the bat priv with all the soft interface information
  *
- * Update the own multicast tvlv with our current multicast related settings,
+ * Updates the own multicast tvlv with our current multicast related settings,
  * capabilities and inabilities.
  *
- * Return true if the tvlv container is registered afterwards. Otherwise return
- * false.
+ * Returns true if the tvlv container is registered afterwards. Otherwise
+ * returns false.
  */
 static bool batadv_mcast_mla_tvlv_update(struct batadv_priv *bat_priv)
 {
@@ -220,7 +220,7 @@  static bool batadv_mcast_mla_tvlv_update(struct batadv_priv *bat_priv)
  * batadv_mcast_mla_update - update the own MLAs
  * @bat_priv: the bat priv with all the soft interface information
  *
- * Update the own multicast listener announcements in the translation
+ * Updates the own multicast listener announcements in the translation
  * table as well as the own, announced multicast tvlv container.
  */
 void batadv_mcast_mla_update(struct batadv_priv *bat_priv)