batman-adv: bla: update stale kernel-doc

The bridge-loop-avoidance code was changed recently to avoid inconsistent
state and race condition problems. The kernel-doc addded in these commits
(and related code) has various minor deficits which are now resolved.

Signed-off-by: Sven Eckelmann <sven@narfation.org>

diff --git a/net/batman-adv/bridge_loop_avoidance.c b/net/batman-adv/bridge_loop_avoidance.c
index 0bd24a19ff20225130508f3b8545303c829788ba..5c73f6ba16cff368b661b3fd9dff27f964af73ac 100644 (file)
--- a/net/batman-adv/bridge_loop_avoidance.c
+++ b/net/batman-adv/bridge_loop_avoidance.c
@@ -123,7 +123,7 @@ static bool batadv_compare_backbone_gw(const struct hlist_node *node,
  * @node: list node of the first entry to compare
  * @data2: pointer to the second claims
  *
- * Return: true if the claim have the same data, 0 otherwise
+ * Return: true if the claims have the same data, false otherwise
  */
 static bool batadv_compare_claim(const struct hlist_node *node,
                                 const void *data2)

diff --git a/net/batman-adv/bridge_loop_avoidance.h b/net/batman-adv/bridge_loop_avoidance.h
index 8673a265995ff42b283071222c401a68b23c4a33..06c7dfb8c677f5ab1847e75e33359b28ca35f9da 100644 (file)
--- a/net/batman-adv/bridge_loop_avoidance.h
+++ b/net/batman-adv/bridge_loop_avoidance.h
@@ -21,7 +21,7 @@
  *  detect frame sent by bridge loop avoidance
  * @mac: mac address to check
  *
- * Return: true if the it looks like a loop detect frame
+ * Return: true if it looks like a loop detect frame
  * (mac starts with BA:BE), false otherwise
  */
 static inline bool batadv_bla_is_loopdetect_mac(const uint8_t *mac)

diff --git a/net/batman-adv/types.h b/net/batman-adv/types.h
index a7fa0d9e092887508c002015391771545dcfd322..5fd5bd358a249af63b83e864efc17784037e9fbb 100644 (file)
--- a/net/batman-adv/types.h
+++ b/net/batman-adv/types.h
@@ -1723,22 +1723,26 @@ struct batadv_priv {
 
 #ifdef CONFIG_BATMAN_ADV_BLA
 
+/**
+ * enum batadv_bla_backbone_gw_state - state of a bridge loop avoidance
+ *  backbone gateway
+ */
 enum batadv_bla_backbone_gw_state {
        /**
         * @BATADV_BLA_BACKBONE_GW_STOPPED: backbone gw is being removed
-        * and it must not longer work on requests
+        * and it must no longer work on requests
         */
        BATADV_BLA_BACKBONE_GW_STOPPED,
 
        /**
         * @BATADV_BLA_BACKBONE_GW_UNSYNCED: backbone was detected out
-        * of sync and a request was send. No traffic is forwarded until the
+        * of sync and a request was sent. No traffic is forwarded until the
         * situation is resolved
         */
        BATADV_BLA_BACKBONE_GW_UNSYNCED,
 
        /**
-        * @BATADV_BLA_BACKBONE_GW_SYNCED: backbone is consider to be in
+        * @BATADV_BLA_BACKBONE_GW_SYNCED: backbone is considered to be in
         * sync. traffic can be forwarded
         */
        BATADV_BLA_BACKBONE_GW_SYNCED,