[B.A.T.M.A.N.] [PATCH 01/13] batman-adv: kernel doc fixes for bat_iv_ogm.c

[B.A.T.M.A.N.] [PATCH 01/13] batman-adv: kernel doc fixes for bat_iv_ogm.c

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 bat_iv_ogm.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/bat_iv_ogm.c b/bat_iv_ogm.c
index 1e80539..73209f3 100644
--- a/bat_iv_ogm.c
+++ b/bat_iv_ogm.c
@@ -28,7 +28,7 @@
 
 
 /**
- * batadv_dup_status - duplicate status
+ * enum batadv_dup_status - duplicate status
  * @BATADV_NO_DUP: the packet is a duplicate
  * @BATADV_ORIG_DUP: OGM is a duplicate in the originator (but not for the
  *  neighbor)
@@ -517,7 +517,7 @@ out:
  * @bat_priv: the bat priv with all the soft interface information
  * @packet_len: (total) length of the OGM
  * @send_time: timestamp (jiffies) when the packet is to be sent
- * @direktlink: true if this is a direct link packet
+ * @directlink: true if this is a direct link packet
  * @if_incoming: interface where the packet was received
  * @if_outgoing: interface for which the retransmission should be considered
  * @forw_packet: the forwarded packet which should be checked
@@ -1366,6 +1366,7 @@ out:
 /**
  * batadv_iv_ogm_process_per_outif - process a batman iv OGM for an outgoing if
  * @skb: the skb containing the OGM
+ * @ogm_offset: offset from skb->data to start of ogm header
  * @orig_node: the (cached) orig node for the originator of this OGM
  * @if_incoming: the interface where this packet was received
  * @if_outgoing: the interface for which the packet should be considered
@@ -1902,10 +1903,10 @@ out:
  * batadv_iv_ogm_neigh_is_eob - check if neigh1 is equally good or better than
  *  neigh2 from the metric prospective
  * @neigh1: the first neighbor object of the comparison
- * @if_outgoing: outgoing interface for the first neighbor
+ * @if_outgoing1: outgoing interface for the first neighbor
  * @neigh2: the second neighbor object of the comparison
  * @if_outgoing2: outgoing interface for the second neighbor
-
+ *
  * Returns true if the metric via neigh1 is equally good or better than
  * the metric via neigh2, false otherwise.
  */
-- 
2.0.1

[B.A.T.M.A.N.] [PATCH 02/13] batman-adv: kernel doc fixes for bridge_loop_avoidance.c

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 bridge_loop_avoidance.c | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/bridge_loop_avoidance.c b/bridge_loop_avoidance.c
index a957c81..9946006 100644
--- a/bridge_loop_avoidance.c
+++ b/bridge_loop_avoidance.c
@@ -252,7 +252,7 @@ batadv_bla_del_backbone_claims(struct batadv_bla_backbone_gw *backbone_gw)
 /**
  * batadv_bla_send_claim - sends a claim frame according to the provided info
  * @bat_priv: the bat priv with all the soft interface information
- * @orig: the mac address to be announced within the claim
+ * @mac: the mac address to be announced within the claim
  * @vid: the VLAN ID
  * @claimtype: the type of the claim (CLAIM, UNCLAIM, ANNOUNCE, ...)
  */
@@ -364,6 +364,7 @@ out:
  * @bat_priv: the bat priv with all the soft interface information
  * @orig: the mac address of the originator
  * @vid: the VLAN ID
+ * @own_backbone: set if the requested backbone  is local
  *
  * searches for the backbone gw or creates a new one if it could not
  * be found.
@@ -454,6 +455,7 @@ batadv_bla_update_own_backbone_gw(struct batadv_priv *bat_priv,
 /**
  * batadv_bla_answer_request - answer a bla request by sending own claims
  * @bat_priv: the bat priv with all the soft interface information
+ * @primary_if: interface where the request came on
  * @vid: the vid where the request came on
  *
  * Repeat all of our own claims, and finally send an ANNOUNCE frame
@@ -775,6 +777,7 @@ static int batadv_handle_claim(struct batadv_priv *bat_priv,
 /**
  * batadv_check_claim_group
  * @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
  * @hw_dst: the Hardware destination in the ARP Header
  * @ethhdr: pointer to the Ethernet header of the claim frame
@@ -850,6 +853,7 @@ static int batadv_check_claim_group(struct batadv_priv *bat_priv,
 /**
  * batadv_bla_process_claim
  * @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
  *
  * Check if this is a claim frame, and process it accordingly.
-- 
2.0.1

Re: [B.A.T.M.A.N.] [PATCH 02/13] batman-adv: kernel doc fixes for bridge_loop_avoidance.c

[Antonio Quartulli]

[-- Attachment #1: Type: text/plain, Size: 1195 bytes --]



On 11/07/14 14:26, Martin Hundebøll wrote:
> Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
> ---
>  bridge_loop_avoidance.c | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/bridge_loop_avoidance.c b/bridge_loop_avoidance.c
> index a957c81..9946006 100644
> --- a/bridge_loop_avoidance.c
> +++ b/bridge_loop_avoidance.c
> @@ -252,7 +252,7 @@ batadv_bla_del_backbone_claims(struct batadv_bla_backbone_gw *backbone_gw)
>  /**
>   * batadv_bla_send_claim - sends a claim frame according to the provided info
>   * @bat_priv: the bat priv with all the soft interface information
> - * @orig: the mac address to be announced within the claim
> + * @mac: the mac address to be announced within the claim
>   * @vid: the VLAN ID
>   * @claimtype: the type of the claim (CLAIM, UNCLAIM, ANNOUNCE, ...)
>   */
> @@ -364,6 +364,7 @@ out:
>   * @bat_priv: the bat priv with all the soft interface information
>   * @orig: the mac address of the originator
>   * @vid: the VLAN ID
> + * @own_backbone: set if the requested backbone  is local
                          too many white spaces   ^^


Cheers,


-- 
Antonio Quartulli


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 884 bytes --]

Re: [B.A.T.M.A.N.] [PATCH 02/13] batman-adv: kernel doc fixes for bridge_loop_avoidance.c

[Simon Wunderlich]

> > + * @own_backbone: set if the requested backbone  is local
> 
>                           too many white spaces   ^^

Apart from that, the rest of the patch looks good. :) Feel free to add my 
Acked-by if you want ...

Thanks!
     Simon

[B.A.T.M.A.N.] [PATCH 03/13] batman-adv: kernel doc fix for distributed-arp-table.h

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 distributed-arp-table.h | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/distributed-arp-table.h b/distributed-arp-table.h
index d76e1d0..2fe0764 100644
--- a/distributed-arp-table.h
+++ b/distributed-arp-table.h
@@ -25,9 +25,7 @@
 
 #include <linux/if_arp.h>
 
-/**
- * BATADV_DAT_ADDR_MAX - maximum address value in the DHT space
- */
+/* BATADV_DAT_ADDR_MAX - maximum address value in the DHT space */
 #define BATADV_DAT_ADDR_MAX ((batadv_dat_addr_t)~(batadv_dat_addr_t)0)
 
 void batadv_dat_status_update(struct net_device *net_dev);
-- 
2.0.1

Re: [B.A.T.M.A.N.] [PATCH 03/13] batman-adv: kernel doc fix for distributed-arp-table.h

[Antonio Quartulli]

[-- Attachment #1: Type: text/plain, Size: 708 bytes --]



On 11/07/14 14:26, Martin Hundebøll wrote:
> Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
> ---
>  distributed-arp-table.h | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/distributed-arp-table.h b/distributed-arp-table.h
> index d76e1d0..2fe0764 100644
> --- a/distributed-arp-table.h
> +++ b/distributed-arp-table.h
> @@ -25,9 +25,7 @@
>  
>  #include <linux/if_arp.h>
>  
> -/**
> - * BATADV_DAT_ADDR_MAX - maximum address value in the DHT space
> - */
> +/* BATADV_DAT_ADDR_MAX - maximum address value in the DHT space */

How can this be detected as kernel doc if you removed the starting  /** ?


Cheers,


-- 
Antonio Quartulli


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 884 bytes --]

[B.A.T.M.A.N.] [PATCH 04/13] batman-adv: kernel doc fixes for main.{c, h}

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 main.c | 4 ++--
 main.h | 5 ++---
 2 files changed, 4 insertions(+), 5 deletions(-)

diff --git a/main.c b/main.c
index d1183e8..2cdd25a 100644
--- a/main.c
+++ b/main.c
@@ -651,7 +651,7 @@ static struct batadv_tvlv_handler
 /**
  * batadv_tvlv_container_free_ref - decrement the tvlv container refcounter and
  *  possibly free it
- * @tvlv_handler: the tvlv container to free
+ * @tvlv: the tvlv container to free
  */
 static void batadv_tvlv_container_free_ref(struct batadv_tvlv_container *tvlv)
 {
@@ -800,7 +800,7 @@ void batadv_tvlv_container_register(struct batadv_priv *bat_priv,
  *  requested packet size
  * @packet_buff: packet buffer
  * @packet_buff_len: packet buffer size
- * @packet_min_len: requested packet minimum size
+ * @min_packet_len: requested packet minimum size
  * @additional_packet_len: requested additional packet size on top of minimum
  *  size
  *
diff --git a/main.h b/main.h
index 4bb500b..9a8a1d5 100644
--- a/main.h
+++ b/main.h
@@ -92,9 +92,8 @@
 /* numbers of originator to contact for any PUT/GET DHT operation */
 #define BATADV_DAT_CANDIDATES_NUM 3
 
-/**
- * BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ
- *  at most from the primary one in order to be still considered acceptable
+/* BATADV_TQ_SIMILARITY_THRESHOLD - TQ points that a secondary metric can differ
+ * at most from the primary one in order to be still considered acceptable
  */
 #define BATADV_TQ_SIMILARITY_THRESHOLD 50
 
-- 
2.0.1

[B.A.T.M.A.N.] [PATCH 05/13] batman-adv: kernel doc fix for multicast.h

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 multicast.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/multicast.h b/multicast.h
index 73b5d45..d790a71 100644
--- a/multicast.h
+++ b/multicast.h
@@ -19,7 +19,7 @@
 #define _NET_BATMAN_ADV_MULTICAST_H_
 
 /**
- * batadv_forw_mode - the way a packet should be forwarded as
+ * enum batadv_forw_mode - the way a packet should be forwarded as
  * @BATADV_FORW_ALL: forward the packet to all nodes (currently via classic
  *  flooding)
  * @BATADV_FORW_SINGLE: forward the packet to a single node (currently via the
-- 
2.0.1

Re: [B.A.T.M.A.N.] [PATCH 05/13] batman-adv: kernel doc fix for multicast.h

[Linus Lüssing]

On Fri, Jul 11, 2014 at 02:26:27PM +0200, Martin Hundebøll wrote:
> Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
> ---
>  multicast.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/multicast.h b/multicast.h
> index 73b5d45..d790a71 100644
> --- a/multicast.h
> +++ b/multicast.h
> @@ -19,7 +19,7 @@
>  #define _NET_BATMAN_ADV_MULTICAST_H_
>  
>  /**
> - * batadv_forw_mode - the way a packet should be forwarded as
> + * enum batadv_forw_mode - the way a packet should be forwarded as
>   * @BATADV_FORW_ALL: forward the packet to all nodes (currently via classic
>   *  flooding)
>   * @BATADV_FORW_SINGLE: forward the packet to a single node (currently via the
> -- 
> 2.0.1
> 

Acked-by: Linus Lüssing <linus.luessing@web.de>

[B.A.T.M.A.N.] [PATCH 06/13] batman-adv: kernel doc fixes for originator.c

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 originator.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/originator.c b/originator.c
index 6a48451..3c2413e 100644
--- a/originator.c
+++ b/originator.c
@@ -166,7 +166,7 @@ static void batadv_neigh_ifinfo_free_rcu(struct rcu_head *rcu)
 }
 
 /**
- * batadv_neigh_ifinfo_free_now - decrement the refcounter and possibly free
+ * batadv_neigh_ifinfo_free_ref_now - decrement the refcounter and possibly free
  *  the neigh_ifinfo (without rcu callback)
  * @neigh_ifinfo: the neigh_ifinfo object to release
  */
@@ -233,7 +233,7 @@ void batadv_neigh_node_free_ref(struct batadv_neigh_node *neigh_node)
 }
 
 /**
- * batadv_orig_node_get_router - router to the originator depending on iface
+ * batadv_orig_router_get - router to the originator depending on iface
  * @orig_node: the orig node for the router
  * @if_outgoing: the interface where the payload packet has been received or
  *  the OGM should be sent to
@@ -347,7 +347,7 @@ out:
 
 /**
  * batadv_neigh_ifinfo_get - find the ifinfo from an neigh_node
- * @neigh_node: the neigh node to be queried
+ * @neigh: the neigh node to be queried
  * @if_outgoing: the interface for which the ifinfo should be acquired
  *
  * The object is returned with refcounter increased by 1.
@@ -380,7 +380,7 @@ batadv_neigh_ifinfo_get(struct batadv_neigh_node *neigh,
 
 /**
  * batadv_neigh_ifinfo_new - search and possibly create an neigh_ifinfo object
- * @neigh_node: the neigh node to be queried
+ * @neigh: the neigh node to be queried
  * @if_outgoing: the interface for which the ifinfo should be acquired
  *
  * Returns NULL in case of failure or the neigh_ifinfo object for the
@@ -516,7 +516,7 @@ static void batadv_orig_ifinfo_free_rcu(struct rcu_head *rcu)
 }
 
 /**
- * batadv_orig_ifinfo_free_ref - decrement the refcounter and possibly free
+ * batadv_orig_ifinfo_free_ref_now - decrement the refcounter and possibly free
  *  the orig_ifinfo (without rcu callback)
  * @orig_ifinfo: the orig_ifinfo object to release
  */
-- 
2.0.1

[B.A.T.M.A.N.] [PATCH 07/13] batman-adv: kernel doc fixes for packet.h

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 packet.h | 21 +++++++++++++--------
 1 file changed, 13 insertions(+), 8 deletions(-)

diff --git a/packet.h b/packet.h
index 34e096d..cfbaf4d 100644
--- a/packet.h
+++ b/packet.h
@@ -156,7 +156,7 @@ enum batadv_tt_client_flags {
 };
 
 /**
- * batadv_vlan_flags - flags for the four MSB of any vlan ID field
+ * enum batadv_vlan_flags - flags for the four MSB of any vlan ID field
  * @BATADV_VLAN_HAS_TAG: whether the field contains a valid vlan tag or not
  */
 enum batadv_vlan_flags {
@@ -203,9 +203,14 @@ struct batadv_bla_claim_dst {
 /**
  * struct batadv_ogm_packet - ogm (routing protocol) packet
  * @packet_type: batman-adv packet type, part of the general header
- * @version: batman-adv protocol version, part of the genereal header
- * @ttl: time to live for this packet, part of the genereal header
+ * @version: batman-adv protocol version, part of the general header
+ * @ttl: time to live for this packet, part of the general header
  * @flags: contains routing relevant flags - see enum batadv_iv_flags
+ * @seqno: inremental sequence number for this ogm packet
+ * @orig: address of the originator of this ogm packet
+ * @prev_sender: address of the previous sender of this ogm packet
+ * @reserved: reserved byte for alignment
+ * @tq: accumulated TQ value towards the originator of this ogm packet
  * @tvlv_len: length of tvlv data following the ogm header
  */
 struct batadv_ogm_packet {
@@ -227,7 +232,7 @@ struct batadv_ogm_packet {
 #define BATADV_OGM_HLEN sizeof(struct batadv_ogm_packet)
 
 /**
- * batadv_icmp_header - common members among all the ICMP packets
+ * struct batadv_icmp_header - common members among all the ICMP packets
  * @packet_type: batman-adv packet type, part of the general header
  * @version: batman-adv protocol version, part of the genereal header
  * @ttl: time to live for this packet, part of the genereal header
@@ -253,7 +258,7 @@ struct batadv_icmp_header {
 };
 
 /**
- * batadv_icmp_packet - ICMP packet
+ * struct batadv_icmp_packet - ICMP packet
  * @packet_type: batman-adv packet type, part of the general header
  * @version: batman-adv protocol version, part of the genereal header
  * @ttl: time to live for this packet, part of the genereal header
@@ -279,7 +284,7 @@ struct batadv_icmp_packet {
 #define BATADV_RR_LEN 16
 
 /**
- * batadv_icmp_packet_rr - ICMP RouteRecord packet
+ * struct batadv_icmp_packet_rr - ICMP RouteRecord packet
  * @packet_type: batman-adv packet type, part of the general header
  * @version: batman-adv protocol version, part of the genereal header
  * @ttl: time to live for this packet, part of the genereal header
@@ -342,6 +347,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;
@@ -410,7 +416,6 @@ struct batadv_bcast_packet {
  * @packet_type: batman-adv packet type, part of the general header
  * @version: batman-adv protocol version, part of the genereal header
  * @ttl: time to live for this packet, part of the genereal header
- * @reserved: Align following fields to 2-byte boundaries
  * @first_source: original source of first included packet
  * @first_orig_dest: original destinal of first included packet
  * @first_crc: checksum of first included packet
@@ -492,7 +497,7 @@ struct batadv_tvlv_gateway_data {
  * struct batadv_tvlv_tt_data - tt data propagated through the tt tvlv container
  * @flags: translation table flags (see batadv_tt_data_flags)
  * @ttvn: translation table version number
- * @vlan_num: number of announced VLANs. In the TVLV this struct is followed by
+ * @num_vlan: number of announced VLANs. In the TVLV this struct is followed by
  *  one batadv_tvlv_tt_vlan_data object per announced vlan
  */
 struct batadv_tvlv_tt_data {
-- 
2.0.1

[B.A.T.M.A.N.] [PATCH 08/13] batman-adv: kernel doc fix for routing.c

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 routing.c | 1 -
 1 file changed, 1 deletion(-)

diff --git a/routing.c b/routing.c
index 35f76f2..385f319 100644
--- a/routing.c
+++ b/routing.c
@@ -876,7 +876,6 @@ rx_success:
  * batadv_recv_unicast_tvlv - receive and process unicast tvlv packets
  * @skb: unicast tvlv packet to process
  * @recv_if: pointer to interface this packet was received on
- * @dst_addr: the payload destination
  *
  * Returns NET_RX_SUCCESS if the packet has been consumed or NET_RX_DROP
  * otherwise.
-- 
2.0.1

[B.A.T.M.A.N.] [PATCH 09/13] batman-adv: kernel doc fix for send.c

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 send.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/send.c b/send.c
index d27161e..ed77eae 100644
--- a/send.c
+++ b/send.c
@@ -193,7 +193,7 @@ static bool batadv_send_skb_prepare_unicast(struct sk_buff *skb,
  *  unicast 4addr header
  * @bat_priv: the bat priv with all the soft interface information
  * @skb: the skb containing the payload to encapsulate
- * @orig_node: the destination node
+ * @orig: the destination node
  * @packet_subtype: the unicast 4addr packet subtype to use
  *
  * Returns false if the payload could not be encapsulated or true otherwise.
-- 
2.0.1

[B.A.T.M.A.N.] [PATCH 10/13] batman-adv: kernel doc fixes for soft-interface.c

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 soft-interface.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/soft-interface.c b/soft-interface.c
index 9bf382d..bc0e44d 100644
--- a/soft-interface.c
+++ b/soft-interface.c
@@ -563,6 +563,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: must be ETH_P_8021Q
  * @vid: identifier of the new vlan
  *
  * Set up all the internal structures for handling the new vlan on top of the
@@ -620,6 +621,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: must be ETH_P_8021Q
  * @vid: identifier of the deleted vlan
  *
  * Destroy all the internal structures used to handle the vlan identified by vid
-- 
2.0.1

[B.A.T.M.A.N.] [PATCH 11/13] batman-adv: kernel doc fixes for sysfs.{c, h}

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 sysfs.c | 5 ++---
 sysfs.h | 8 ++++----
 2 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/sysfs.c b/sysfs.c
index fc47baa..bf8800e 100644
--- a/sysfs.c
+++ b/sysfs.c
@@ -62,6 +62,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: batman-adv private data
  * @obj: kobject to covert
  *
  * Returns the associated softif_vlan struct if found, NULL otherwise.
@@ -593,9 +594,7 @@ static struct batadv_attribute *batadv_mesh_attrs[] = {
 
 BATADV_ATTR_VLAN_BOOL(ap_isolation, S_IRUGO | S_IWUSR, NULL);
 
-/**
- * batadv_vlan_attrs - array of vlan specific sysfs attributes
- */
+/* struct batadv_vlan_attrs - array of vlan specific sysfs attributes */
 static struct batadv_attribute *batadv_vlan_attrs[] = {
 	&batadv_attr_vlan_ap_isolation,
 	NULL,
diff --git a/sysfs.h b/sysfs.h
index b715b60..68b8c99 100644
--- a/sysfs.h
+++ b/sysfs.h
@@ -20,10 +20,10 @@
 
 #define BATADV_SYSFS_IF_MESH_SUBDIR "mesh"
 #define BATADV_SYSFS_IF_BAT_SUBDIR "batman_adv"
-/**
- * BATADV_SYSFS_VLAN_SUBDIR_PREFIX - prefix of the subfolder that will be
- *  created in the sysfs hierarchy for each VLAN interface. The subfolder will
- *  be named "BATADV_SYSFS_VLAN_SUBDIR_PREFIX%vid".
+
+/* BATADV_SYSFS_VLAN_SUBDIR_PREFIX - prefix of the subfolder that will be
+ * created in the sysfs hierarchy for each VLAN interface. The subfolder will
+ * be named "BATADV_SYSFS_VLAN_SUBDIR_PREFIX%vid".
  */
 #define BATADV_SYSFS_VLAN_SUBDIR_PREFIX "vlan"
 
-- 
2.0.1

Re: [B.A.T.M.A.N.] [PATCH 11/13] batman-adv: kernel doc fixes for sysfs.{c, h}

[Antonio Quartulli]

[-- Attachment #1: Type: text/plain, Size: 695 bytes --]



On 11/07/14 14:26, Martin Hundebøll wrote:
> Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
> ---
>  sysfs.c | 5 ++---
>  sysfs.h | 8 ++++----
>  2 files changed, 6 insertions(+), 7 deletions(-)
> 
> diff --git a/sysfs.c b/sysfs.c
> index fc47baa..bf8800e 100644
> --- a/sysfs.c
> +++ b/sysfs.c
> @@ -62,6 +62,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: batman-adv private data


Martin,

what about re-using the same text we use in all the other kerneldocs for
bat_priv ?

Cheers,


-- 
Antonio Quartulli


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 884 bytes --]

[B.A.T.M.A.N.] [PATCH 12/13] batman-adv: kernel fixes for translation-table.c

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 translation-table.c | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

diff --git a/translation-table.c b/translation-table.c
index 5f59e7f..ffc594e 100644
--- a/translation-table.c
+++ b/translation-table.c
@@ -195,7 +195,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
- * @hash: hash table containing the tt entries
+ * @bat_priv: batman-adv private data
  * @addr: the mac address of the client to count entries for
  * @vid: VLAN identifier
  *
@@ -280,7 +280,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
- * @bat_priv: the bat priv with all the soft interface information
+ * @orig_node: orig_node to change table on
  * @vid: the VLAN identifier
  * @v: the amount to sum to the global table size
  */
@@ -691,7 +691,7 @@ 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.
@@ -2339,7 +2339,6 @@ static void batadv_tt_tvlv_generate(struct batadv_priv *bat_priv,
  * @orig_node: originator for which the CRCs have to be checked
  * @tt_vlan: pointer to the first tvlv VLAN entry
  * @num_vlan: number of tvlv VLAN entries
- * @create: if true, create VLAN objects if not found
  *
  * Return true if all the received CRCs match the locally stored ones, false
  * otherwise
@@ -3284,13 +3283,12 @@ out:
  * batadv_tt_update_orig - update global translation table with new tt
  *  information received via ogms
  * @bat_priv: the bat priv with all the soft interface information
- * @orig: the orig_node of the ogm
- * @tt_vlan: pointer to the first tvlv VLAN entry
+ * @orig_node: the orig_node of the ogm
+ * @tt_buff: pointer to the first tvlv VLAN entry
  * @tt_num_vlan: number of tvlv VLAN entries
  * @tt_change: pointer to the first entry in the TT buffer
  * @tt_num_changes: number of tt changes inside the tt buffer
  * @ttvn: translation table version number of this changeset
- * @tt_crc: crc32 checksum of orig node's translation table
  */
 static void batadv_tt_update_orig(struct batadv_priv *bat_priv,
 				  struct batadv_orig_node *orig_node,
-- 
2.0.1

[B.A.T.M.A.N.] [PATCH 13/13] batman-adv: kernel doc fixes for types.h

[Martin Hundebøll]

Signed-off-by: Martin Hundebøll <martin@hundeboll.net>
---
 types.h | 46 +++++++++++++++++++++-------------------------
 1 file changed, 21 insertions(+), 25 deletions(-)

diff --git a/types.h b/types.h
index 8854c05..4018479 100644
--- a/types.h
+++ b/types.h
@@ -24,9 +24,8 @@
 
 #ifdef CONFIG_BATMAN_ADV_DAT
 
-/**
- * batadv_dat_addr_t - it is the type used for all DHT addresses. If it is
- *  changed, BATADV_DAT_ADDR_MAX is changed as well.
+/* batadv_dat_addr_t - it is the type used for all DHT addresses. If it is
+ * changed, BATADV_DAT_ADDR_MAX is changed as well.
  *
  * *Please be careful: batadv_dat_addr_t must be UNSIGNED*
  */
@@ -46,15 +45,13 @@ enum batadv_dhcp_recipient {
 	BATADV_DHCP_TO_CLIENT,
 };
 
-/**
- * BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
- *  wire only
+/* BATADV_TT_REMOTE_MASK - bitmask selecting the flags that are sent over the
+ * wire only
  */
 #define BATADV_TT_REMOTE_MASK	0x00FF
 
-/**
- * BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
- *  among the nodes. These flags are used to compute the global/local CRC
+/* BATADV_TT_SYNC_MASK - bitmask of the flags that need to be kept in sync
+ * among the nodes. These flags are used to compute the global/local CRC
  */
 #define BATADV_TT_SYNC_MASK	0x00F0
 
@@ -202,11 +199,11 @@ struct batadv_orig_bat_iv {
  * @primary_addr: hosts primary interface address
  * @ifinfo_list: list for routers per outgoing interface
  * @last_bonding_candidate: pointer to last ifinfo of last used router
- * @batadv_dat_addr_t:  address of the orig node in the distributed hash
+ * @dat_addr: address of the orig node in the distributed hash
  * @last_seen: time when last packet from this node was received
  * @bcast_seqno_reset: time when the broadcast seqno window was reset
  * @mcast_flags: multicast flags announced by the orig node
- * @mcast_want_all_unsnoop_node: a list node for the
+ * @mcast_want_all_unsnoopables_node: a list node for the
  *  mcast.want_all_unsnoopables list
  * @mcast_want_all_ipv4_node: a list node for the mcast.want_all_ipv4 list
  * @mcast_want_all_ipv6_node: a list node for the mcast.want_all_ipv6 list
@@ -333,9 +330,8 @@ struct batadv_gw_node {
  * @ifinfo_lock: lock protecting private ifinfo members and list
  * @if_incoming: pointer to incoming hard interface
  * @last_seen: when last packet via this neighbor was received
- * @last_ttl: last received ttl from this neigh node
+ * @refcount: number of contexts the object is used
  * @rcu: struct used for freeing in an RCU-safe manner
- * @bat_iv: B.A.T.M.A.N. IV private structure
  */
 struct batadv_neigh_node {
 	struct hlist_node list;
@@ -385,13 +381,13 @@ struct batadv_neigh_ifinfo {
 	struct rcu_head rcu;
 };
 
+#ifdef CONFIG_BATMAN_ADV_BLA
 /**
  * struct batadv_bcast_duplist_entry - structure for LAN broadcast suppression
- * @orig[ETH_ALEN]: mac address of orig node orginating the broadcast
+ * @orig: mac address of orig node orginating the broadcast
  * @crc: crc32 checksum of broadcast payload
  * @entrytime: time when the broadcast packet was received
  */
-#ifdef CONFIG_BATMAN_ADV_BLA
 struct batadv_bcast_duplist_entry {
 	uint8_t orig[ETH_ALEN];
 	__be32 crc;
@@ -533,9 +529,10 @@ struct batadv_priv_tt {
 	struct delayed_work work;
 };
 
+#ifdef CONFIG_BATMAN_ADV_BLA
 /**
  * struct batadv_priv_bla - per mesh interface bridge loope avoidance data
- * @num_requests; number of bla requests in flight
+ * @num_requests: number of bla requests in flight
  * @claim_hash: hash table containing mesh nodes this host has claimed
  * @backbone_hash: hash table containing all detected backbone gateways
  * @bcast_duplist: recently received broadcast packets array (for broadcast
@@ -545,7 +542,6 @@ struct batadv_priv_tt {
  * @claim_dest: local claim data (e.g. claim group)
  * @work: work queue callback item for cleanups & bla announcements
  */
-#ifdef CONFIG_BATMAN_ADV_BLA
 struct batadv_priv_bla {
 	atomic_t num_requests;
 	struct batadv_hashtable *claim_hash;
@@ -559,6 +555,7 @@ struct batadv_priv_bla {
 };
 #endif
 
+#ifdef CONFIG_BATMAN_ADV_DEBUG
 /**
  * struct batadv_priv_debug_log - debug logging data
  * @log_buff: buffer holding the logs (ring bufer)
@@ -567,7 +564,6 @@ struct batadv_priv_bla {
  * @lock: lock protecting log_buff, log_start & log_end
  * @queue_wait: log reader's wait queue
  */
-#ifdef CONFIG_BATMAN_ADV_DEBUG
 struct batadv_priv_debug_log {
 	char log_buff[BATADV_LOG_BUF_LEN];
 	unsigned long log_start;
@@ -609,13 +605,13 @@ struct batadv_priv_tvlv {
 	spinlock_t handler_list_lock; /* protects handler_list */
 };
 
+#ifdef CONFIG_BATMAN_ADV_DAT
 /**
  * struct batadv_priv_dat - per mesh interface DAT private data
  * @addr: node DAT address
  * @hash: hashtable representing the local ARP cache
  * @work: work queue callback item for cache purging
  */
-#ifdef CONFIG_BATMAN_ADV_DAT
 struct batadv_priv_dat {
 	batadv_dat_addr_t addr;
 	struct batadv_hashtable *hash;
@@ -730,6 +726,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: mark to use in ap isolation when filtering packets
+ * @isolation_mark_mask: mask of bits to check when filtering packets
  * @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
@@ -757,7 +755,7 @@ struct batadv_softif_vlan {
  * @dat: distributed arp table data
  * @mcast: multicast data
  * @network_coding: bool indicating whether network coding is enabled
- * @batadv_priv_nc: network coding data
+ * @nc: network coding data
  */
 struct batadv_priv {
 	atomic_t mesh_state;
@@ -855,6 +853,7 @@ struct batadv_socket_packet {
 	uint8_t icmp_packet[BATADV_ICMP_MAX_PACKET_SIZE];
 };
 
+#ifdef CONFIG_BATMAN_ADV_BLA
 /**
  * struct batadv_bla_backbone_gw - batman-adv gateway bridged into the LAN
  * @orig: originator address of backbone node (mac address of primary iface)
@@ -871,7 +870,6 @@ struct batadv_socket_packet {
  * @refcount: number of contexts the object is used
  * @rcu: struct used for freeing in an RCU-safe manner
  */
-#ifdef CONFIG_BATMAN_ADV_BLA
 struct batadv_bla_backbone_gw {
 	uint8_t orig[ETH_ALEN];
 	unsigned short vid;
@@ -889,7 +887,7 @@ struct batadv_bla_backbone_gw {
  * struct batadv_bla_claim - claimed non-mesh client structure
  * @addr: mac address of claimed non-mesh client
  * @vid: vlan id this client was detected on
- * @batadv_bla_backbone_gw: pointer to backbone gw claiming this client
+ * @backbone_gw: pointer to backbone gw claiming this client
  * @lasttime: last time we heard of claim (locals only)
  * @hash_entry: hlist node for batadv_priv_bla::claim_hash
  * @refcount: number of contexts the object is used
@@ -1204,9 +1202,7 @@ struct batadv_dat_candidate {
  * struct batadv_tvlv_container - container for tvlv appended to OGMs
  * @list: hlist node for batadv_priv_tvlv::container_list
  * @tvlv_hdr: tvlv header information needed to construct the tvlv
- * @value_len: length of the buffer following this struct which contains
- *  the actual tvlv payload
- * @refcount: number of contexts the object is used
+ * @refcount: number of contexts the object is used in
  */
 struct batadv_tvlv_container {
 	struct hlist_node list;
-- 
2.0.1

Re: [B.A.T.M.A.N.] [PATCH 03/13] batman-adv: kernel doc fix for distributed-arp-table.h

[Martin Hundebøll]

On Jul 11, 2014 3:05 PM, Antonio Quartulli <antonio@meshcoding.com> wrote:
>
>
>
> On 11/07/14 14:26, Martin Hundebøll wrote: 
> > Signed-off-by: Martin Hundebøll <martin@hundeboll.net> 
> > --- 
> >  distributed-arp-table.h | 4 +--- 
> >  1 file changed, 1 insertion(+), 3 deletions(-) 
> > 
> > diff --git a/distributed-arp-table.h b/distributed-arp-table.h 
> > index d76e1d0..2fe0764 100644 
> > --- a/distributed-arp-table.h 
> > +++ b/distributed-arp-table.h 
> > @@ -25,9 +25,7 @@ 
> >  
> >  #include <linux/if_arp.h> 
> >  
> > -/** 
> > - * BATADV_DAT_ADDR_MAX - maximum address value in the DHT space 
> > - */ 
> > +/* BATADV_DAT_ADDR_MAX - maximum address value in the DHT space */ 
>
> How can this be detected as kernel doc if you removed the starting  /** ?

It is not kernel doc. I couldn't find any documentation about defines in the nano-kernel-doc-doc, and since the kernel doc script complained, I chose to remove it..

// Martin