Kerneldoc fixes and TODOs
Status from this message: Applied in revision d7a21c1.
Get series with b4
b4 am 1787438.NkeQ2a2MeO@sven-edgeVersions newest first
Patches in v1 Applied
| # | Subject and files | Size | Replies | Applied |
|---|---|---|---|---|
| 1/2 | batman-adv: Fix kerneldoc of main functionsnet/ net/ net/ +8 more | +48 | 4 replies | |
| 2/2 | batman-adv: Fix kerneldoc of network-coding functionsnet/ | +13 | 1 reply |
Reviews trailers per patch
No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.
Cover letter [B.A.T.M.A.N.] [PATCH 0/2] Kerneldoc fixes and TODOs
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: Antonio Quartulli <[email protected]>
Date: Sat, 31 Oct 2015 10:30:54 +0100
Subject: [PATCH] batman-adv: kerneldoc TODO Antonio Quartulli <[email protected]>
--- net/batman-adv/distributed-arp-table.c | 4 ++++ net/batman-adv/translation-table.c | 21 ++++++++++++++++----- net/batman-adv/types.h | 2 ++ 3 files changed, 22 insertions(+), 5 deletions(-)
net/batman-adv/distributed-arp-table.c +4 -0
@@ -738,6 +738,8 @@ static void batadv_dat_hash_free(struct batadv_priv *bat_priv)/** * batadv_dat_init - initialise the DAT internals * @bat_priv: the bat priv with all the soft interface information +* +* Return: TODO */ int batadv_dat_init (struct batadv_priv *bat_priv) {
@@ -776,6 +778,8 @@ void batadv_dat_free(struct batadv_priv *bat_priv)* batadv_dat_cache_seq_print_text - print the local DAT hash table * @seq: seq file to print on * @offset: not used +* +* Return: TODO */ int batadv_dat_cache_seq_print_text (struct seq_file *seq,void *offset) {
net/batman-adv/translation-table.c +16 -5
@@ -69,7 +69,9 @@ static void batadv_tt_global_del(struct batadv_priv *bat_priv, bool roaming);/** -* batadv_compare_tt +* batadv_compare_tt - TODO +* @node: TODO +* @data2: TODO * * Return: 1 if they are the same mac addr */
@@ -219,6 +221,7 @@ batadv_tt_global_entry_free_ref(struct batadv_tt_global_entry *tt_global_entry)/** * batadv_tt_global_hash_count - count the number of orig entries +* @bat_priv: the bat priv with all the soft interface information * @addr: the mac address of the client to count entries for * @vid: VLAN identifier *
@@ -303,6 +306,7 @@ static void batadv_tt_local_size_dec(struct batadv_priv *bat_priv,/** * batadv_tt_global_size_mod - change the size by v of the local table * identified by vid +* @orig_node: TODO * @vid: the VLAN identifier * @v: the amount to sum to the global table size */
@@ -721,7 +725,6 @@ out:* function reserves the amount of space needed to send the entire global TT * table. In case of success the value is updated with the real amount of * reserved bytes -* Allocate the needed amount of memory for the entire TT TVLV and write its * header made up by one tvlv_tt_data object and a series of tvlv_tt_vlan_data * objects, one per active VLAN served by the originator node.
@@ -1243,7 +1246,9 @@ static void batadv_tt_changes_list_free(struct batadv_priv *bat_priv) }/** -* batadv_tt_global_orig_entry_find +* batadv_tt_global_orig_entry_find - TODO +* @entry: TODO +* @orig_node: TODO * * retrieves the orig_tt_list_entry belonging to orig_node from the * batadv_tt_global_entry list
@@ -1274,7 +1279,9 @@ batadv_tt_global_orig_entry_find(const struct batadv_tt_global_entry *entry, }/** -* batadv_tt_global_entry_has_orig +* batadv_tt_global_entry_has_orig - TODO +* @entry: TODO +* @orig_node: TODO * * find out if an orig_node is already in the list of a tt_global_entry. *
@@ -2519,6 +2526,8 @@ static void batadv_tt_global_update_crc(struct batadv_priv *bat_priv,* @num_vlan: number of tvlv VLAN entries * @full_table: ask for the entire translation table if true, while only for the * last TT diff otherwise +* +* Return: TODO */ static int batadv_send_tt_request(struct batadv_priv *bat_priv, struct batadv_orig_node *dst_orig_node,
@@ -3062,7 +3071,9 @@ static void batadv_tt_roam_purge(struct batadv_priv *bat_priv) }/** -* batadv_tt_check_roam_count +* batadv_tt_check_roam_count - TODO +* @bat_priv: the bat priv with all the soft interface information +* @client: mac address of the roaming client * * This function checks whether the client already reached the * maximum number of possible roaming phases. In this case the ROAMING_ADV
net/batman-adv/types.h +2 -0
@@ -772,6 +772,8 @@ struct batadv_softif_vlan {* @orig_interval: OGM broadcast interval in milliseconds * @hop_penalty: penalty which will be applied to an OGM's tq-field on every hop * @log_level: configured log level (see batadv_dbg_level) +* @isolation_mark: TODO +* @isolation_mark_mask: TODO * @bcast_seqno: last sent broadcast packet sequence number * @bcast_queue_left: number of remaining buffered broadcast packet slots * @batman_queue_left: number of remaining OGM packet slots
From: Simon Wunderlich <[email protected]>
Date: Sat, 31 Oct 2015 10:30:44 +0100
Subject: [PATCH] batman-adv: kerneldoc TODO Simon Wunderlich <[email protected]>
--- net/batman-adv/bridge_loop_avoidance.c | 55 +++++++++++++++++++++++++--------- 1 file changed, 41 insertions(+), 14 deletions(-)
net/batman-adv/bridge_loop_avoidance.c +41 -14
175 lines not on this page · raw message