public inbox for b.a.t.m.a.n@lists.open-mesh.org
 help / color / mirror / Atom feed
From: Sven Eckelmann <sven@narfation.org>
To: b.a.t.m.a.n@lists.open-mesh.org
Subject: [B.A.T.M.A.N.] [PATCH 1/9] batman-adv: Fix kernel-doc parsing of main structs
Date: Sun,  6 Sep 2015 21:38:45 +0200	[thread overview]
Message-ID: <1441568333-15947-2-git-send-email-sven@narfation.org> (raw)
In-Reply-To: <1441568333-15947-1-git-send-email-sven@narfation.org>

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: Sven Eckelmann <sven@narfation.org>
---
 net/batman-adv/types.h | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/net/batman-adv/types.h b/net/batman-adv/types.h
index d260efd..6e8515c 100644
--- a/net/batman-adv/types.h
+++ b/net/batman-adv/types.h
@@ -401,13 +401,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;
@@ -549,6 +550,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
@@ -561,7 +564,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;
@@ -575,6 +577,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)
@@ -583,7 +587,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;
@@ -625,13 +628,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;
@@ -871,6 +875,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)
@@ -887,7 +893,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;
-- 
2.5.1


  reply	other threads:[~2015-09-06 19:38 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-09-06 19:38 [B.A.T.M.A.N.] kerneldoc cleanups Sven Eckelmann
2015-09-06 19:38 ` Sven Eckelmann [this message]
2015-09-13 10:24   ` [B.A.T.M.A.N.] [PATCH 1/9] batman-adv: Fix kernel-doc parsing of main structs Marek Lindner
2015-09-06 19:38 ` [B.A.T.M.A.N.] [PATCH 2/9] batman-adv: Fix kerneldoc member names in for " Sven Eckelmann
2015-09-13 12:50   ` Marek Lindner
2015-09-06 19:38 ` [B.A.T.M.A.N.] [PATCH 3/9] batman-adv: Remove kerneldoc for missing struct members Sven Eckelmann
2015-09-13 14:12   ` Marek Lindner
2015-09-06 19:38 ` [B.A.T.M.A.N.] [PATCH 4/9] batman-adv: Add kerneldoc for batadv_gw_node::refcount Sven Eckelmann
2015-09-13 14:22   ` Marek Lindner
2015-09-06 19:38 ` [B.A.T.M.A.N.] [PATCH 5/9] batman-adv: Fix kerneldoc parsing of structs/enums Sven Eckelmann
2015-09-14  8:30   ` Marek Lindner
2015-09-06 19:38 ` [B.A.T.M.A.N.] [PATCH 6/9] batman-adv: Remove kerneldoc for missing parameters Sven Eckelmann
2015-09-14  8:40   ` Marek Lindner
2015-09-06 19:38 ` [B.A.T.M.A.N.] [PATCH 7/9] batman-adv: Fix names in kerneldoc of functions Sven Eckelmann
2015-09-14  8:44   ` Marek Lindner
2015-09-06 19:38 ` [B.A.T.M.A.N.] [PATCH 8/9] batman-adv: Fix kerneldoc parsing of return description Sven Eckelmann
2015-09-06 19:38 ` [B.A.T.M.A.N.] [PATCH 9/9] batman-adv: Drop invalid kerneldoc for variable batadv_vlan_attrs Sven Eckelmann
2015-09-14  8:52   ` Marek Lindner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1441568333-15947-2-git-send-email-sven@narfation.org \
    --to=sven@narfation.org \
    --cc=b.a.t.m.a.n@lists.open-mesh.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox