Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 426fc6c8 authored by Sven Eckelmann's avatar Sven Eckelmann Committed by Antonio Quartulli
Browse files

batman-adv: Fix kernel-doc parsing of main structs 



kernel-doc is not able to skip an #ifdef between the kernel documentation
block and the start of the struct. Moving the #ifdef before the kernel doc
block avoids this problem

Signed-off-by: default avatarSven Eckelmann <sven@narfation.org>
Signed-off-by: default avatarMarek Lindner <mareklindner@neomailbox.ch>
Signed-off-by: default avatarAntonio Quartulli <a@unstable.cc>
parent cc69d3db

net/batman-adv/types.h

+10 −5
Original line number Diff line number Diff line
@@ -423,13 +423,14 @@ 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

 * @crc: crc32 checksum of broadcast payload

 * @entrytime: time when the broadcast packet was received

 */

#ifdef CONFIG_BATMAN_ADV_BLA

struct batadv_bcast_duplist_entry {

	u8 orig[ETH_ALEN];

	__be32 crc;
@@ -571,6 +572,8 @@ 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
@@ -583,7 +586,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;
@@ -597,6 +599,8 @@ 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)
@@ -605,7 +609,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;
@@ -647,13 +650,14 @@ 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;
@@ -893,6 +897,8 @@ struct batadv_socket_packet { 
	u8 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)
@@ -910,7 +916,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 {

	u8 orig[ETH_ALEN];

	unsigned short vid;