[v1] local_lock: fix all kernel-doc warnings

[PATCH] local_lock: fix all kernel-doc warnings

Posted by Randy Dunlap 3 days, 13 hours ago

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>
---
Cc: Andrew Morton <akpm@linux-foundation.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Will Deacon <will@kernel.org>
Cc: Waiman Long <longman@redhat.com>
---
 include/linux/local_lock.h |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

--- linux-next-20251127.orig/include/linux/local_lock.h
+++ linux-next-20251127/include/linux/local_lock.h
@@ -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)

Re: [PATCH] local_lock: fix all kernel-doc warnings

Posted by Peter Zijlstra 3 days, 10 hours ago

On Thu, Nov 27, 2025 at 10:59:25PM -0800, Randy Dunlap wrote:
> 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>

Thanks!

[tip: locking/core] locking/local_lock: Fix all kernel-doc warnings

Posted by tip-bot2 for Randy Dunlap 14 hours ago

The following commit has been merged into the locking/core branch of tip:

Commit-ID:     43decb6b628eb033a1b6188e5018773c0d38be1d
Gitweb:        https://git.kernel.org/tip/43decb6b628eb033a1b6188e5018773c0d38be1d
Author:        Randy Dunlap <rdunlap@infradead.org>
AuthorDate:    Thu, 27 Nov 2025 22:59:25 -08:00
Committer:     Ingo Molnar <mingo@kernel.org>
CommitterDate: Mon, 01 Dec 2025 06:56:16 +01:00

locking/local_lock: Fix all kernel-doc warnings

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 | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/include/linux/local_lock.h b/include/linux/local_lock.h
index 0d91d06..b0e6ab3 100644
--- a/include/linux/local_lock.h
+++ b/include/linux/local_lock.h
@@ -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)

[tip: locking/core] local_lock: fix all kernel-doc warnings

Posted by tip-bot2 for Randy Dunlap 2 days, 9 hours ago

The following commit has been merged into the locking/core branch of tip:

Commit-ID:     e7194ffe9a0411122980b031c0bbb455a5106266
Gitweb:        https://git.kernel.org/tip/e7194ffe9a0411122980b031c0bbb455a5106266
Author:        Randy Dunlap <rdunlap@infradead.org>
AuthorDate:    Thu, 27 Nov 2025 22:59:25 -08:00
Committer:     Peter Zijlstra <peterz@infradead.org>
CommitterDate: Fri, 28 Nov 2025 11:09:02 +01:00

local_lock: fix all kernel-doc warnings

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>
Link: https://patch.msgid.link/20251128065925.917917-1-rdunlap@infradead.org
---
 include/linux/local_lock.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/include/linux/local_lock.h b/include/linux/local_lock.h
index 0d91d06..b0e6ab3 100644
--- a/include/linux/local_lock.h
+++ b/include/linux/local_lock.h
@@ -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)