* [B.A.T.M.A.N.] [PATCH 0/2] Kerneldoc fixes and TODOs
@ 2015-10-31 11:28 Sven Eckelmann
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Sven Eckelmann
0 siblings, 1 reply; 8+ messages in thread
From: Sven Eckelmann @ 2015-10-31 11:28 UTC (permalink / raw)
To: b.a.t.m.a.n; +Cc: Antonio Quartulli
[-- Attachment #1.1: Type: text/plain, Size: 12762 bytes --]
=2D-nextPart13031541.r4eREZIBmO
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="us-ascii"
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
=2D-nextPart13031541.r4eREZIBmO
Content-Disposition: attachment; filename="TODO-Antonio-Quartulli-antonio-.patch"
Content-Transfer-Encoding: 7Bit
Content-Type: text/x-patch; charset="UTF-8"; name="TODO-Antonio-Quartulli-antonio-.patch"
From: Antonio Quartulli <antonio@meshcoding.com>
Date: Sat, 31 Oct 2015 10:30:54 +0100
Subject: [PATCH] batman-adv: kerneldoc TODO Antonio Quartulli <antonio@meshcoding.com>
=2D--
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(-)
diff --git a/net/batman-adv/distributed-arp-table.c b/net/batman-adv/distributed-arp-table.c
index 9daccdc..496ada2 100644
=2D-- a/net/batman-adv/distributed-arp-table.c
+++ b/net/batman-adv/distributed-arp-table.c
@@ -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)
{
diff --git a/net/batman-adv/translation-table.c b/net/batman-adv/translation-table.c
index d98476f..a49e9b4 100644
=2D-- a/net/batman-adv/translation-table.c
+++ b/net/batman-adv/translation-table.c
@@ -69,7 +69,9 @@ static void batadv_tt_global_del(struct batadv_priv *bat_priv,
bool roaming);
/**
=2D * 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
=2D
* 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)
}
/**
=2D * 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,
}
/**
=2D * 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)
}
/**
=2D * 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
diff --git a/net/batman-adv/types.h b/net/batman-adv/types.h
index 7f7a0f1..1a450ac 100644
=2D-- a/net/batman-adv/types.h
+++ b/net/batman-adv/types.h
@@ -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
=2D-nextPart13031541.r4eREZIBmO
Content-Disposition: attachment; filename="TODO-Simon-Wunderlich-sw-simonw.patch"
Content-Transfer-Encoding: 7Bit
Content-Type: text/x-patch; charset="UTF-8"; name="TODO-Simon-Wunderlich-sw-simonw.patch"
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>
=2D--
net/batman-adv/bridge_loop_avoidance.c | 55 +++++++++++++++++++++++++---------
1 file changed, 41 insertions(+), 14 deletions(-)
diff --git a/net/batman-adv/bridge_loop_avoidance.c b/net/batman-adv/bridge_loop_avoidance.c
index 6633c77..2889216 100644
=2D-- a/net/batman-adv/bridge_loop_avoidance.c
+++ b/net/batman-adv/bridge_loop_avoidance.c
@@ -59,7 +59,9 @@ batadv_bla_send_announce(struct batadv_priv *bat_priv,
struct batadv_bla_backbone_gw *backbone_gw);
/**
=2D * 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)
}
/**
=2D * 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)
}
/**
=2D * 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:
}
/**
=2D * 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)
}
/**
=2D * 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,
}
/**
=2D * 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,
}
/**
=2D * 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:
}
/**
=2D * 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:
}
/**
=2D * 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)
}
/**
=2D * 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:
}
/**
=2D * 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,
}
/**
=2D * 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)
}
/**
=2D * 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:
}
/**
=2D * 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
=2D-nextPart13031541.r4eREZIBmO--
This is a multi-part message in MIME format.
[-- Attachment #1.2: Type: text/plain, Size: 614 bytes --]
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
[-- Attachment #1.3: TODO-Antonio-Quartulli-antonio-.patch --]
[-- Type: text/x-patch, Size: 4777 bytes --]
From: Antonio Quartulli <antonio@meshcoding.com>
Date: Sat, 31 Oct 2015 10:30:54 +0100
Subject: [PATCH] batman-adv: kerneldoc TODO Antonio Quartulli <antonio@meshcoding.com>
---
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(-)
diff --git a/net/batman-adv/distributed-arp-table.c b/net/batman-adv/distributed-arp-table.c
index 9daccdc..496ada2 100644
--- a/net/batman-adv/distributed-arp-table.c
+++ b/net/batman-adv/distributed-arp-table.c
@@ -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)
{
diff --git a/net/batman-adv/translation-table.c b/net/batman-adv/translation-table.c
index d98476f..a49e9b4 100644
--- a/net/batman-adv/translation-table.c
+++ b/net/batman-adv/translation-table.c
@@ -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
diff --git a/net/batman-adv/types.h b/net/batman-adv/types.h
index 7f7a0f1..1a450ac 100644
--- a/net/batman-adv/types.h
+++ b/net/batman-adv/types.h
@@ -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
[-- Attachment #1.4: TODO-Simon-Wunderlich-sw-simonw.patch --]
[-- Type: text/x-patch, Size: 6655 bytes --]
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(-)
diff --git a/net/batman-adv/bridge_loop_avoidance.c b/net/batman-adv/bridge_loop_avoidance.c
index 6633c77..2889216 100644
--- a/net/batman-adv/bridge_loop_avoidance.c
+++ b/net/batman-adv/bridge_loop_avoidance.c
@@ -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
[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions
2015-10-31 11:28 [B.A.T.M.A.N.] [PATCH 0/2] Kerneldoc fixes and TODOs Sven Eckelmann
@ 2015-10-31 11:29 ` Sven Eckelmann
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 2/2] batman-adv: Fix kerneldoc of network-coding functions Sven Eckelmann
` (2 more replies)
0 siblings, 3 replies; 8+ messages in thread
From: Sven Eckelmann @ 2015-10-31 11:29 UTC (permalink / raw)
To: b.a.t.m.a.n
Signed-off-by: Sven Eckelmann <sven@narfation.org>
---
net/batman-adv/bitarray.c | 12 +++++++++---
net/batman-adv/bitarray.h | 11 +++++------
net/batman-adv/debugfs.c | 6 ++++++
net/batman-adv/main.c | 2 ++
net/batman-adv/main.h | 4 ++++
net/batman-adv/originator.c | 4 +++-
net/batman-adv/packet.h | 6 ++++++
net/batman-adv/routing.c | 7 ++++++-
net/batman-adv/send.c | 5 ++++-
net/batman-adv/soft-interface.c | 2 ++
net/batman-adv/sysfs.c | 1 +
11 files changed, 48 insertions(+), 12 deletions(-)
diff --git a/net/batman-adv/bitarray.c b/net/batman-adv/bitarray.c
index 06bab51..3404195 100644
--- a/net/batman-adv/bitarray.c
+++ b/net/batman-adv/bitarray.c
@@ -29,10 +29,16 @@ static void batadv_bitmap_shift_left(unsigned long *seq_bits, s32 n)
bitmap_shift_left(seq_bits, seq_bits, n, BATADV_TQ_LOCAL_WINDOW_SIZE);
}
-/* receive and process one packet within the sequence number window.
+/**
+ * batadv_bit_get_packet - receive and process one packet within the sequence
+ * number window
+ * @priv: the bat priv with all the soft interface information
+ * @seq_bits: pointer to the sequence number receive packet
+ * @seq_num_diff: difference between the current/received sequence number and
+ * the last sequence number
+ * @set_mark: whether this packet should be marked in seq_bits
*
- * Return:
- * 1 if the window was moved (either new or very old)
+ * Return: 1 if the window was moved (either new or very old),
* 0 if the window was not moved/shifted.
*/
int batadv_bit_get_packet(void *priv, unsigned long *seq_bits, s32 seq_num_diff,
diff --git a/net/batman-adv/bitarray.h b/net/batman-adv/bitarray.h
index cf2aeb0..2b64d7a 100644
--- a/net/batman-adv/bitarray.h
+++ b/net/batman-adv/bitarray.h
@@ -25,7 +25,11 @@
#include <linux/types.h>
/**
- * batadv_test_bit
+ * batadv_test_bit - check if bit is set in the current window
+ *
+ * @seq_bits: pointer to the sequence number receive packet
+ * @last_seqno: latest sequence number in seq_bits
+ * @curr_seqno: sequence number to test for
*
* Return: 1 if the corresponding bit in the given seq_bits indicates true
* and curr_seqno is within range of last_seqno. Otherwise returns 0.
@@ -51,11 +55,6 @@ static inline void batadv_set_bit(unsigned long *seq_bits, s32 n)
set_bit(n, seq_bits); /* turn the position on */
}
-/**
- * batadv_bit_get_packet - receive and process one packet
- *
- * Return: 1 if received seq_num is considered new, 0 if old
- */
int batadv_bit_get_packet(void *priv, unsigned long *seq_bits, s32 seq_num_diff,
int set_mark);
diff --git a/net/batman-adv/debugfs.c b/net/batman-adv/debugfs.c
index 037ad0a..0fc9df5 100644
--- a/net/batman-adv/debugfs.c
+++ b/net/batman-adv/debugfs.c
@@ -281,6 +281,8 @@ static int batadv_originators_open(struct inode *inode, struct file *file)
* originator table of an hard interface
* @inode: inode pointer to debugfs file
* @file: pointer to the seq_file
+ *
+ * Return: 0 on success or negative error number in case of failure
*/
static int batadv_originators_hardif_open(struct inode *inode,
struct file *file)
@@ -329,6 +331,8 @@ static int batadv_bla_backbone_table_open(struct inode *inode,
* batadv_dat_cache_open - Prepare file handler for reads from dat_chache
* @inode: inode which was opened
* @file: file handle to be initialized
+ *
+ * Return: 0 on success or negative error number in case of failure
*/
static int batadv_dat_cache_open(struct inode *inode, struct file *file)
{
@@ -483,6 +487,8 @@ void batadv_debugfs_destroy(void)
* batadv_debugfs_add_hardif - creates the base directory for a hard interface
* in debugfs.
* @hard_iface: hard interface which should be added.
+ *
+ * Return: 0 on success or negative error number in case of failure
*/
int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
{
diff --git a/net/batman-adv/main.c b/net/batman-adv/main.c
index 2fa168a..062d319 100644
--- a/net/batman-adv/main.c
+++ b/net/batman-adv/main.c
@@ -599,6 +599,8 @@ int batadv_algo_seq_print_text(struct seq_file *seq, void *offset)
*
* payload_ptr must always point to an address in the skb head buffer and not to
* a fragment.
+ *
+ * Return: big endian crc32c of the checksummed data
*/
__be32 batadv_skb_crc32(struct sk_buff *skb, u8 *payload_ptr)
{
diff --git a/net/batman-adv/main.h b/net/batman-adv/main.h
index 79e2052..ff4e44b 100644
--- a/net/batman-adv/main.h
+++ b/net/batman-adv/main.h
@@ -275,6 +275,8 @@ static inline void _batadv_dbg(int type __always_unused,
/**
* batadv_compare_eth - Compare two not u16 aligned Ethernet addresses
+ * @data1: Pointer to a six-byte array containing the Ethernet address
+ * @data2: Pointer other six-byte array containing the Ethernet address
*
* note: can't use ether_addr_equal() as it requires aligned memory
*
@@ -331,6 +333,8 @@ static inline void batadv_add_counter(struct batadv_priv *bat_priv, size_t idx,
/**
* batadv_sum_counter - Sum the cpu-local counters for index 'idx'
+ * @bat_priv: the bat priv with all the soft interface information
+ * @idx: index of counter to sum up
*
* Return: sum of all cpu-local counters
*/
diff --git a/net/batman-adv/originator.c b/net/batman-adv/originator.c
index ddf22f5..00b0437 100644
--- a/net/batman-adv/originator.c
+++ b/net/batman-adv/originator.c
@@ -48,7 +48,9 @@ static struct lock_class_key batadv_orig_hash_lock_class_key;
static void batadv_purge_orig(struct work_struct *work);
/**
- * batadv_compare_orig
+ * batadv_compare_orig - comparing function used in the originator hash table
+ * @node: node in the local table
+ * @data2: second object to compare the node to
*
* Return: 1 if they are the same originator
*/
diff --git a/net/batman-adv/packet.h b/net/batman-adv/packet.h
index 72fd5b0..fdb0163 100644
--- a/net/batman-adv/packet.h
+++ b/net/batman-adv/packet.h
@@ -209,6 +209,11 @@ struct batadv_bla_claim_dst {
* @version: batman-adv protocol version, part of the genereal header
* @ttl: time to live for this packet, part of the genereal header
* @flags: contains routing relevant flags - see enum batadv_iv_flags
+ * @seqno: sequence identification
+ * @orig: address of the source node
+ * @prev_sender: address of the previous sender
+ * @reserved: reserved byte for alignment
+ * @tq: transmission quality
* @tvlv_len: length of tvlv data following the ogm header
*/
struct batadv_ogm_packet {
@@ -345,6 +350,7 @@ struct batadv_unicast_packet {
* @u: common unicast packet header
* @src: address of the source
* @subtype: packet subtype
+ * @reserved: reserved byte for alignment
*/
struct batadv_unicast_4addr_packet {
struct batadv_unicast_packet u;
diff --git a/net/batman-adv/routing.c b/net/batman-adv/routing.c
index bcaa787..1fb1be3 100644
--- a/net/batman-adv/routing.c
+++ b/net/batman-adv/routing.c
@@ -141,8 +141,13 @@ out:
}
/**
- * batadv_window_protected checks whether the host restarted and is in the
+ * batadv_window_protected - checks whether the host restarted and is in the
* protection time.
+ * @bat_priv: the bat priv with all the soft interface information
+ * @seq_num_diff: difference between the current/received sequence number and
+ * the last sequence number
+ * @last_reset: jiffies timestamp of the last reset, will be updated when reset
+ * is detected
*
* Return:
* 0 if the packet is to be accepted.
diff --git a/net/batman-adv/send.c b/net/batman-adv/send.c
index d2efab5..27712c8 100644
--- a/net/batman-adv/send.c
+++ b/net/batman-adv/send.c
@@ -432,7 +432,10 @@ _batadv_add_bcast_packet_to_list(struct batadv_priv *bat_priv,
}
/**
- * batadv_add_bcast_packet_to_list
+ * batadv_add_bcast_packet_to_list - queue broadcast packet for multiple sends
+ * @bat_priv: the bat priv with all the soft interface information
+ * @skb: broadcast packet to add
+ * @delay: number of jiffies to wait before sending
*
* add a broadcast packet to the queue and setup timers. broadcast packets
* are sent multiple times to increase probability for being received.
diff --git a/net/batman-adv/soft-interface.c b/net/batman-adv/soft-interface.c
index 5ee794b..6c65de9 100644
--- a/net/batman-adv/soft-interface.c
+++ b/net/batman-adv/soft-interface.c
@@ -594,6 +594,7 @@ static void batadv_softif_destroy_vlan(struct batadv_priv *bat_priv,
/**
* batadv_interface_add_vid - ndo_add_vid API implementation
* @dev: the netdev of the mesh interface
+ * @proto: protocol of the the vlan id
* @vid: identifier of the new vlan
*
* Set up all the internal structures for handling the new vlan on top of the
@@ -651,6 +652,7 @@ static int batadv_interface_add_vid(struct net_device *dev, __be16 proto,
/**
* batadv_interface_kill_vid - ndo_kill_vid API implementation
* @dev: the netdev of the mesh interface
+ * @proto: protocol of the the vlan id
* @vid: identifier of the deleted vlan
*
* Destroy all the internal structures used to handle the vlan identified by vid
diff --git a/net/batman-adv/sysfs.c b/net/batman-adv/sysfs.c
index 2bcc7f6..c3c9770 100644
--- a/net/batman-adv/sysfs.c
+++ b/net/batman-adv/sysfs.c
@@ -81,6 +81,7 @@ static struct batadv_priv *batadv_vlan_kobj_to_batpriv(struct kobject *obj)
/**
* batadv_kobj_to_vlan - convert a kobj in the associated softif_vlan struct
+ * @bat_priv: the bat priv with all the soft interface information
* @obj: kobject to covert
*
* Return: the associated softif_vlan struct if found, NULL otherwise.
--
2.6.2
^ permalink raw reply related [flat|nested] 8+ messages in thread
* [B.A.T.M.A.N.] [PATCH 2/2] batman-adv: Fix kerneldoc of network-coding functions
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Sven Eckelmann
@ 2015-10-31 11:29 ` Sven Eckelmann
2015-11-17 7:34 ` Marek Lindner
2015-11-01 15:13 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Markus Pargmann
2015-11-17 7:33 ` Marek Lindner
2 siblings, 1 reply; 8+ messages in thread
From: Sven Eckelmann @ 2015-10-31 11:29 UTC (permalink / raw)
To: b.a.t.m.a.n
Signed-off-by: Sven Eckelmann <sven@narfation.org>
---
net/batman-adv/network-coding.c | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/net/batman-adv/network-coding.c b/net/batman-adv/network-coding.c
index 4a95fbe..ae3b055 100644
--- a/net/batman-adv/network-coding.c
+++ b/net/batman-adv/network-coding.c
@@ -64,6 +64,8 @@ static int batadv_nc_recv_coded_packet(struct sk_buff *skb,
/**
* batadv_nc_init - one-time initialization for network coding
+ *
+ * Return: 0 on success or negative error number in case of failure
*/
int __init batadv_nc_init(void)
{
@@ -142,6 +144,8 @@ static void batadv_nc_tvlv_ogm_handler_v1(struct batadv_priv *bat_priv,
/**
* batadv_nc_mesh_init - initialise coding hash table and start house keeping
* @bat_priv: the bat priv with all the soft interface information
+ *
+ * Return: 0 on success or negative error number in case of failure
*/
int batadv_nc_mesh_init(struct batadv_priv *bat_priv)
{
@@ -994,6 +998,8 @@ static struct batadv_nc_path *batadv_nc_get_path(struct batadv_priv *bat_priv,
* batadv_nc_random_weight_tq - scale the receivers TQ-value to avoid unfair
* selection of a receiver with slightly lower TQ than the other
* @tq: to be weighted tq value
+ *
+ * Return: scaled tq value
*/
static u8 batadv_nc_random_weight_tq(u8 tq)
{
@@ -1786,6 +1792,9 @@ batadv_nc_find_decoding_packet(struct batadv_priv *bat_priv,
* resulting unicast packet
* @skb: incoming coded packet
* @recv_if: pointer to interface this packet was received on
+ *
+ * Return: NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP
+ * otherwise.
*/
static int batadv_nc_recv_coded_packet(struct sk_buff *skb,
struct batadv_hard_iface *recv_if)
@@ -1870,6 +1879,8 @@ void batadv_nc_mesh_free(struct batadv_priv *bat_priv)
* batadv_nc_nodes_seq_print_text - print the nc node information
* @seq: seq file to print on
* @offset: not used
+ *
+ * Return: always 0
*/
int batadv_nc_nodes_seq_print_text(struct seq_file *seq, void *offset)
{
@@ -1932,6 +1943,8 @@ out:
/**
* batadv_nc_init_debugfs - create nc folder and related files in debugfs
* @bat_priv: the bat priv with all the soft interface information
+ *
+ * Return: 0 on success or negative error number in case of failure
*/
int batadv_nc_init_debugfs(struct batadv_priv *bat_priv)
{
--
2.6.2
^ permalink raw reply related [flat|nested] 8+ messages in thread
* Re: [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Sven Eckelmann
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 2/2] batman-adv: Fix kerneldoc of network-coding functions Sven Eckelmann
@ 2015-11-01 15:13 ` Markus Pargmann
2015-11-01 15:32 ` Sven Eckelmann
2015-11-17 7:33 ` Marek Lindner
2 siblings, 1 reply; 8+ messages in thread
From: Markus Pargmann @ 2015-11-01 15:13 UTC (permalink / raw)
To: Sven Eckelmann; +Cc: b.a.t.m.a.n
[-- Attachment #1: Type: text/plain, Size: 1696 bytes --]
Hi Sven,
On Sat, Oct 31, 2015 at 12:29:29PM +0100, Sven Eckelmann wrote:
> Signed-off-by: Sven Eckelmann <sven@narfation.org>
> ---
> net/batman-adv/bitarray.c | 12 +++++++++---
> net/batman-adv/bitarray.h | 11 +++++------
> net/batman-adv/debugfs.c | 6 ++++++
> net/batman-adv/main.c | 2 ++
> net/batman-adv/main.h | 4 ++++
> net/batman-adv/originator.c | 4 +++-
> net/batman-adv/packet.h | 6 ++++++
> net/batman-adv/routing.c | 7 ++++++-
> net/batman-adv/send.c | 5 ++++-
> net/batman-adv/soft-interface.c | 2 ++
> net/batman-adv/sysfs.c | 1 +
> 11 files changed, 48 insertions(+), 12 deletions(-)
>
> diff --git a/net/batman-adv/bitarray.c b/net/batman-adv/bitarray.c
> index 06bab51..3404195 100644
> --- a/net/batman-adv/bitarray.c
> +++ b/net/batman-adv/bitarray.c
> @@ -29,10 +29,16 @@ static void batadv_bitmap_shift_left(unsigned long *seq_bits, s32 n)
> bitmap_shift_left(seq_bits, seq_bits, n, BATADV_TQ_LOCAL_WINDOW_SIZE);
> }
>
> -/* receive and process one packet within the sequence number window.
> +/**
> + * batadv_bit_get_packet - receive and process one packet within the sequence
> + * number window
Are you sure this works? IIRC some time ago multi line function
descriptions were not supported.
Best Regards,
Markus
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions
2015-11-01 15:13 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Markus Pargmann
@ 2015-11-01 15:32 ` Sven Eckelmann
2015-11-01 15:35 ` Markus Pargmann
0 siblings, 1 reply; 8+ messages in thread
From: Sven Eckelmann @ 2015-11-01 15:32 UTC (permalink / raw)
To: Markus Pargmann; +Cc: b.a.t.m.a.n
[-- Attachment #1: Type: text/plain, Size: 1348 bytes --]
On Sunday 01 November 2015 16:13:02 Markus Pargmann wrote:
> > diff --git a/net/batman-adv/bitarray.c b/net/batman-adv/bitarray.c
> > index 06bab51..3404195 100644
> > --- a/net/batman-adv/bitarray.c
> > +++ b/net/batman-adv/bitarray.c
> > @@ -29,10 +29,16 @@ static void batadv_bitmap_shift_left(unsigned long
> > *seq_bits, s32 n)>
> > bitmap_shift_left(seq_bits, seq_bits, n, BATADV_TQ_LOCAL_WINDOW_SIZE);
> >
> > }
> >
> > -/* receive and process one packet within the sequence number window.
> > +/**
> > + * batadv_bit_get_packet - receive and process one packet within the
> > sequence + * number window
>
> Are you sure this works? IIRC some time ago multi line function
> descriptions were not supported.
Yes, it works since 2009 [1,2,3].
Here is the kerneldoc (text) output for the function you've quoted:
Name:
batadv_bit_get_packet - receive and process one packet within the sequence number window
Synopsis:
[...]
Kind regards,
Sven
[1] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=6423133bdee0e07d1c2f8411cb3fe676c207ba33
[2] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=4c98ecaf350737cd424eb94140e9e9f1a3408956
[3] https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=47e0c88b37a5c3d6732f4ec896dfa8aa55868b4f
[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions
2015-11-01 15:32 ` Sven Eckelmann
@ 2015-11-01 15:35 ` Markus Pargmann
0 siblings, 0 replies; 8+ messages in thread
From: Markus Pargmann @ 2015-11-01 15:35 UTC (permalink / raw)
To: Sven Eckelmann; +Cc: b.a.t.m.a.n
[-- Attachment #1: Type: text/plain, Size: 1508 bytes --]
Hi,
On Sun, Nov 01, 2015 at 04:32:09PM +0100, Sven Eckelmann wrote:
> On Sunday 01 November 2015 16:13:02 Markus Pargmann wrote:
> > > diff --git a/net/batman-adv/bitarray.c b/net/batman-adv/bitarray.c
> > > index 06bab51..3404195 100644
> > > --- a/net/batman-adv/bitarray.c
> > > +++ b/net/batman-adv/bitarray.c
> > > @@ -29,10 +29,16 @@ static void batadv_bitmap_shift_left(unsigned long
> > > *seq_bits, s32 n)>
> > > bitmap_shift_left(seq_bits, seq_bits, n, BATADV_TQ_LOCAL_WINDOW_SIZE);
> > >
> > > }
> > >
> > > -/* receive and process one packet within the sequence number window.
> > > +/**
> > > + * batadv_bit_get_packet - receive and process one packet within the
> > > sequence + * number window
> >
> > Are you sure this works? IIRC some time ago multi line function
> > descriptions were not supported.
>
> Yes, it works since 2009 [1,2,3].
>
> Here is the kerneldoc (text) output for the function you've quoted:
>
> Name:
>
> batadv_bit_get_packet - receive and process one packet within the sequence number window
Ok, I am probably mixing it up with something else then. Thanks for
clarifying.
Best Regards,
Markus
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 819 bytes --]
^ permalink raw reply [flat|nested] 8+ messages in thread
* Re: [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Sven Eckelmann
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 2/2] batman-adv: Fix kerneldoc of network-coding functions Sven Eckelmann
2015-11-01 15:13 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Markus Pargmann
@ 2015-11-17 7:33 ` Marek Lindner
2 siblings, 0 replies; 8+ messages in thread
From: Marek Lindner @ 2015-11-17 7:33 UTC (permalink / raw)
To: b.a.t.m.a.n
[-- Attachment #1: Type: text/plain, Size: 731 bytes --]
On Saturday, October 31, 2015 12:29:29 Sven Eckelmann wrote:
> Signed-off-by: Sven Eckelmann <sven@narfation.org>
> ---
> net/batman-adv/bitarray.c | 12 +++++++++---
> net/batman-adv/bitarray.h | 11 +++++------
> net/batman-adv/debugfs.c | 6 ++++++
> net/batman-adv/main.c | 2 ++
> net/batman-adv/main.h | 4 ++++
> net/batman-adv/originator.c | 4 +++-
> net/batman-adv/packet.h | 6 ++++++
> net/batman-adv/routing.c | 7 ++++++-
> net/batman-adv/send.c | 5 ++++-
> net/batman-adv/soft-interface.c | 2 ++
> net/batman-adv/sysfs.c | 1 +
> 11 files changed, 48 insertions(+), 12 deletions(-)
Applied in revision d7a21c1.
Thanks,
Marek
[-- Attachment #2: This is a digitally signed message part. --]
[-- Type: application/pgp-signature, Size: 473 bytes --]
^ permalink raw reply [flat|nested] 8+ messages in thread
end of thread, other threads:[~2015-11-17 7:34 UTC | newest]
Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-10-31 11:28 [B.A.T.M.A.N.] [PATCH 0/2] Kerneldoc fixes and TODOs Sven Eckelmann
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Sven Eckelmann
2015-10-31 11:29 ` [B.A.T.M.A.N.] [PATCH 2/2] batman-adv: Fix kerneldoc of network-coding functions Sven Eckelmann
2015-11-17 7:34 ` Marek Lindner
2015-11-01 15:13 ` [B.A.T.M.A.N.] [PATCH 1/2] batman-adv: Fix kerneldoc of main functions Markus Pargmann
2015-11-01 15:32 ` Sven Eckelmann
2015-11-01 15:35 ` Markus Pargmann
2015-11-17 7:33 ` Marek Lindner
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).