diff mbox series

[maint] batman-adv: Fix order of kernel doc in batadv_priv

Message ID 20210323203007.11014-1-linus.luessing@c0d3.blue
State Accepted, archived
Delegated to: Simon Wunderlich
Headers show
Series [maint] batman-adv: Fix order of kernel doc in batadv_priv | expand

Commit Message

Linus Lüssing March 23, 2021, 8:30 p.m. UTC
During the inlining process of kerneldoc some comments were placed at
the wrong struct members. Fixing this by reordering the comments.

Fixes: 6369b8e999af ("batman-adv: Use inline kernel-doc for enum/struct")
Signed-off-by: Linus Lüssing <linus.luessing@c0d3.blue>

Note: checkpatch shows me a warning:

~/dev-priv/linux/linux/scripts/checkpatch.pl --strict ./0001-batman-adv-Fix-order-of-kernel-doc-in-batadv_priv.patch
CHECK: spinlock_t definition without comment
#35: FILE: net/batman-adv/types.h:1665:
+       spinlock_t forw_bat_list_lock;

CHECK: spinlock_t definition without comment
#39: FILE: net/batman-adv/types.h:1668:
+       spinlock_t forw_bcast_list_lock;

total: 0 errors, 0 warnings, 2 checks, 25 lines checked

NOTE: For some of the reported defects, checkpatch may be able to
      mechanically convert to the typical style using --fix or --fix-inplace.

./0001-batman-adv-Fix-order-of-kernel-doc-in-batadv_priv.patch has style problems, please review.

However it seems to be a false positive:

~/dev-priv/linux/linux/scripts/checkpatch.pl -f ./net/batman-adv/types.h
Traceback (most recent call last):
  File "scripts/spdxcheck.py", line 10, in <module>
    import git
ImportError: No module named git
total: 0 errors, 0 warnings, 2410 lines checked

NOTE: If any of the errors are false positives, please report
      them to the maintainer, see CHECKPATCH in MAINTAINERS.

./net/batman-adv/types.h has no obvious style problems and is ready for submission.

Checkpatch version is: e0c755a45f6f from net-master

 net/batman-adv/types.h | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
diff mbox series


diff --git a/net/batman-adv/types.h b/net/batman-adv/types.h
index 2f96e96a..30c78e6e 100644
--- a/net/batman-adv/types.h
+++ b/net/batman-adv/types.h
@@ -1658,19 +1658,19 @@  struct batadv_priv {
 	/** @tp_list: list of tp sessions */
 	struct hlist_head tp_list;
-	/** @tp_num: number of currently active tp sessions */
-	struct batadv_hashtable *orig_hash;
 	/** @orig_hash: hash table containing mesh participants (orig nodes) */
-	spinlock_t forw_bat_list_lock;
+	struct batadv_hashtable *orig_hash;
 	/** @forw_bat_list_lock: lock protecting forw_bat_list */
-	spinlock_t forw_bcast_list_lock;
+	spinlock_t forw_bat_list_lock;
 	/** @forw_bcast_list_lock: lock protecting forw_bcast_list */
-	spinlock_t tp_list_lock;
+	spinlock_t forw_bcast_list_lock;
 	/** @tp_list_lock: spinlock protecting @tp_list */
+	spinlock_t tp_list_lock;
+	/** @tp_num: number of currently active tp sessions */
 	atomic_t tp_num;
 	/** @orig_work: work queue callback item for orig node purging */