[2/3] batman-adv: add kerneldoc for batadv_iv_ogm_aggr_packet

Message ID 1448305042-5806-3-git-send-email-sw@simonwunderlich.de (mailing list archive)
State Accepted, archived
Commit 879ffa28b33ec0c86bb0ced55a2471381360b68d
Headers

Commit Message

Simon Wunderlich Nov. 23, 2015, 6:57 p.m. UTC
  From: Simon Wunderlich <simon@open-mesh.com>

Signed-off-by: Simon Wunderlich <simon@open-mesh.com>
---
 net/batman-adv/bat_iv_ogm.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)
  

Comments

Marek Lindner Nov. 27, 2015, 1:56 a.m. UTC | #1
On Monday, November 23, 2015 19:57:21 Simon Wunderlich wrote:
> From: Simon Wunderlich <simon@open-mesh.com>
> 
> Signed-off-by: Simon Wunderlich <simon@open-mesh.com>
> ---
>  net/batman-adv/bat_iv_ogm.c | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)

Applied in revision 879ffa2.

Thanks,
Marek
  

Patch

diff --git a/net/batman-adv/bat_iv_ogm.c b/net/batman-adv/bat_iv_ogm.c
index ad678f0..a594496 100644
--- a/net/batman-adv/bat_iv_ogm.c
+++ b/net/batman-adv/bat_iv_ogm.c
@@ -394,7 +394,14 @@  static u8 batadv_hop_penalty(u8 tq, const struct batadv_priv *bat_priv)
 	return new_tq;
 }
 
-/* is there another aggregated packet here? */
+/**
+ * batadv_iv_ogm_aggr_packet - checks if there is another OGM attached
+ * @buff_pos: current position in the skb
+ * @packet_len: total length of the skb
+ * @tvlv_len: tvlv length of the previously considered OGM
+ *
+ * Return: true if there is enough space for another OGM, false otherwise.
+ */
 static bool batadv_iv_ogm_aggr_packet(int buff_pos, int packet_len,
 				      __be16 tvlv_len)
 {