]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
locking/local_lock: Fix all kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Fri, 28 Nov 2025 06:59:25 +0000 (22:59 -0800)
committerIngo Molnar <mingo@kernel.org>
Mon, 1 Dec 2025 05:56:16 +0000 (06:56 +0100)
Modify kernel-doc comments in local_lock.h to prevent warnings:

  Warning: include/linux/local_lock.h:9 function parameter 'lock' not described in 'local_lock_init'
  Warning: include/linux/local_lock.h:56 function parameter 'lock' not described in 'local_trylock_init'
  Warning: include/linux/local_lock.h:56 expecting prototype for local_lock_init(). Prototype was for local_trylock_init() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Link: https://patch.msgid.link/20251128065925.917917-1-rdunlap@infradead.org
include/linux/local_lock.h

index 0d91d060e3e90c075f63d0149ec118485771e035..b0e6ab329b0083070457a74c472bb1e899691e63 100644 (file)
@@ -6,6 +6,7 @@
 
 /**
  * local_lock_init - Runtime initialize a lock instance
+ * @lock:      The lock variable
  */
 #define local_lock_init(lock)          __local_lock_init(lock)
 
@@ -52,7 +53,8 @@
        __local_unlock_irqrestore(this_cpu_ptr(lock), flags)
 
 /**
- * local_lock_init - Runtime initialize a lock instance
+ * local_trylock_init - Runtime initialize a lock instance
+ * @lock:      The lock variable
  */
 #define local_trylock_init(lock)       __local_trylock_init(lock)