Hi,
since a month the daily build_test is reporting the problems [1] with the
kerneldoc which I reported and started to fix two months ago [2].
Unfortunately, no new patches were send until now. I have prepared now two
patches for the main functions and the network coding part of batman-adv. The
TODOs (and also partially fixed TODOs) of the remaining three parts (BLA, DAT,
TT) can be found in the attachments of this mail.
Kind regards,
Sven
[1] https://lists.open-mesh.org/pipermail/linux-merge/2015-October/002635.html
[2] https://lists.open-mesh.org/pipermail/b.a.t.m.a.n/2015-September/013653.html
From: Simon Wunderlich <sw@simonwunderlich.de>
Date: Sat, 31 Oct 2015 10:30:44 +0100
Subject: [PATCH] batman-adv: kerneldoc TODO Simon Wunderlich <sw@simonwunderlich.de>
---
net/batman-adv/bridge_loop_avoidance.c | 55 +++++++++++++++++++++++++---------
1 file changed, 41 insertions(+), 14 deletions(-)
@@ -59,7 +59,9 @@ batadv_bla_send_announce(struct batadv_priv *bat_priv,
struct batadv_bla_backbone_gw *backbone_gw);
/**
- * batadv_choose_claim
+ * batadv_choose_claim - TODO
+ * @data: data to hash
+ * @size: size of the hash table
*
* Return: the index of the claim
*/
@@ -75,7 +77,9 @@ static inline u32 batadv_choose_claim(const void *data, u32 size)
}
/**
- * batadv_choose_backbone_gw
+ * batadv_choose_backbone_gw - TODO
+ * @data: data to hash
+ * @size: size of the hash table
*
* Return: the index of the backbone gateway
*/
@@ -153,7 +157,7 @@ static void batadv_claim_free_ref(struct batadv_bla_claim *claim)
}
/**
- * batadv_claim_hash_find
+ * batadv_claim_hash_find - TODO
* @bat_priv: the bat priv with all the soft interface information
* @data: search data (may be local/static data)
*
@@ -385,7 +389,7 @@ out:
}
/**
- * batadv_bla_get_backbone_gw
+ * batadv_bla_get_backbone_gw - TODO
* @bat_priv: the bat priv with all the soft interface information
* @orig: the mac address of the originator
* @vid: the VLAN ID
@@ -393,6 +397,8 @@ out:
*
* searches for the backbone gw or creates a new one if it could not
* be found.
+ *
+ * Return: TODO
*/
static struct batadv_bla_backbone_gw *
batadv_bla_get_backbone_gw(struct batadv_priv *bat_priv, u8 *orig,
@@ -555,7 +561,7 @@ static void batadv_bla_send_request(struct batadv_bla_backbone_gw *backbone_gw)
}
/**
- * batadv_bla_send_announce
+ * batadv_bla_send_announce - TODO
* @bat_priv: the bat priv with all the soft interface information
* @backbone_gw: our backbone gateway which should be announced
*
@@ -681,6 +687,10 @@ static void batadv_bla_del_claim(struct batadv_priv *bat_priv,
/**
* batadv_handle_announce - check for ANNOUNCE frame
+ * @bat_priv: the bat priv with all the soft interface information
+ * @an_addr: TODO
+ * @backbone_addr: TODO
+ * @vid: the VLAN ID of the frame
*
* Return: 1 if handled
*/
@@ -735,6 +745,11 @@ static int batadv_handle_announce(struct batadv_priv *bat_priv, u8 *an_addr,
/**
* batadv_handle_request - check for REQUEST frame
+ * @bat_priv: the bat priv with all the soft interface information
+ * @primary_if: the primary hard interface of this batman soft interface
+ * @backbone_addr: TODO
+ * @ethhdr: ethernet header of a packet
+ * @vid: the VLAN ID of the frame
*
* Return: 1 if handled
*/
@@ -763,6 +778,11 @@ static int batadv_handle_request(struct batadv_priv *bat_priv,
/**
* batadv_handle_unclaim - check for UNCLAIM frame
+ * @bat_priv: the bat priv with all the soft interface information
+ * @primary_if: the primary hard interface of this batman soft interface
+ * @backbone_addr: TODO
+ * @claim_addr: TODO
+ * @vid: the VLAN ID of the frame
*
* Return: 1 if handled
*/
@@ -796,6 +816,11 @@ static int batadv_handle_unclaim(struct batadv_priv *bat_priv,
/**
* batadv_handle_claim - check for CLAIM frame
+ * @bat_priv: the bat priv with all the soft interface information
+ * @primary_if: the primary hard interface of this batman soft interface
+ * @backbone_addr: TODO
+ * @claim_addr: TODO
+ * @vid: the VLAN ID of the frame
*
* Return: 1 if handled
*/
@@ -827,7 +852,7 @@ static int batadv_handle_claim(struct batadv_priv *bat_priv,
}
/**
- * batadv_check_claim_group
+ * batadv_check_claim_group - TODO
* @bat_priv: the bat priv with all the soft interface information
* @primary_if: the primary interface of this batman interface
* @hw_src: the Hardware source in the ARP Header
@@ -902,7 +927,7 @@ static int batadv_check_claim_group(struct batadv_priv *bat_priv,
}
/**
- * batadv_bla_process_claim
+ * batadv_bla_process_claim - TODO
* @bat_priv: the bat priv with all the soft interface information
* @primary_if: the primary hard interface of this batman soft interface
* @skb: the frame to be checked
@@ -1088,7 +1113,7 @@ purge_now:
}
/**
- * batadv_bla_purge_claims
+ * batadv_bla_purge_claims - TODO
* @bat_priv: the bat priv with all the soft interface information
* @primary_if: the selected primary interface, may be NULL if now is set
* @now: whether the whole hash shall be wiped now
@@ -1137,7 +1162,7 @@ purge_now:
}
/**
- * batadv_bla_update_orig_address
+ * batadv_bla_update_orig_address - TODO
* @bat_priv: the bat priv with all the soft interface information
* @primary_if: the new selected primary_if
* @oldif: the old primary interface, may be NULL
@@ -1329,7 +1354,7 @@ int batadv_bla_init(struct batadv_priv *bat_priv)
}
/**
- * batadv_bla_check_bcast_duplist
+ * batadv_bla_check_bcast_duplist - TODO
* @bat_priv: the bat priv with all the soft interface information
* @skb: contains the bcast_packet to be checked
*
@@ -1341,6 +1366,8 @@ int batadv_bla_init(struct batadv_priv *bat_priv)
* with a good chance that it is the same packet. If it is furthermore
* sent by another host, drop it. We allow equal packets from
* the same host however as this might be intended.
+ *
+ * Return: TODO
*/
int batadv_bla_check_bcast_duplist(struct batadv_priv *bat_priv,
struct sk_buff *skb)
@@ -1399,7 +1426,7 @@ out:
}
/**
- * batadv_bla_is_backbone_gw_orig
+ * batadv_bla_is_backbone_gw_orig - TODO
* @bat_priv: the bat priv with all the soft interface information
* @orig: originator mac address
* @vid: VLAN identifier
@@ -1440,7 +1467,7 @@ bool batadv_bla_is_backbone_gw_orig(struct batadv_priv *bat_priv, u8 *orig,
}
/**
- * batadv_bla_is_backbone_gw
+ * batadv_bla_is_backbone_gw - TODO
* @skb: the frame to be checked
* @orig_node: the orig_node of the frame
* @hdr_size: maximum length of the frame
@@ -1498,7 +1525,7 @@ void batadv_bla_free(struct batadv_priv *bat_priv)
}
/**
- * batadv_bla_rx
+ * batadv_bla_rx - TODO
* @bat_priv: the bat priv with all the soft interface information
* @skb: the frame to be checked
* @vid: the VLAN ID of the frame
@@ -1594,7 +1621,7 @@ out:
}
/**
- * batadv_bla_tx
+ * batadv_bla_tx - TODO
* @bat_priv: the bat priv with all the soft interface information
* @skb: the frame to be checked
* @vid: the VLAN ID of the frame