[PATCH] kernel/printk/printk.c: Fix W=1 kernel-doc warning

Anuradha Weeraman posted 1 patch 2 years, 8 months ago
kernel/printk/printk.c | 1 +
1 file changed, 1 insertion(+)
[PATCH] kernel/printk/printk.c: Fix W=1 kernel-doc warning
Posted by Anuradha Weeraman 2 years, 8 months ago
Fix W=1 kernel-doc warning:

kernel/printk/printk.c:
 - Include function parameter in console_lock_spinning_disable_and_check()

Signed-off-by: Anuradha Weeraman <anuradha@debian.org>
---
 kernel/printk/printk.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/kernel/printk/printk.c b/kernel/printk/printk.c
index 7decf1e9c486..557eba131210 100644
--- a/kernel/printk/printk.c
+++ b/kernel/printk/printk.c
@@ -1891,6 +1891,7 @@ static void console_lock_spinning_enable(void)
 /**
  * console_lock_spinning_disable_and_check - mark end of code where another
  *	thread was able to busy wait and check if there is a waiter
+ * @cookie: cookie returned from console_srcu_read_lock()
  *
  * This is called at the end of the section where spinning is allowed.
  * It has two functions. First, it is a signal that it is no longer
-- 
2.39.0
Re: [PATCH] kernel/printk/printk.c: Fix W=1 kernel-doc warning
Posted by Petr Mladek 2 years, 8 months ago
On Mon 2023-01-16 18:26:34, Anuradha Weeraman wrote:
> Fix W=1 kernel-doc warning:
> 
> kernel/printk/printk.c:
>  - Include function parameter in console_lock_spinning_disable_and_check()
> 
> Signed-off-by: Anuradha Weeraman <anuradha@debian.org>

Great catch!

Reviewed-by: Petr Mladek <pmladek@suse.com>

JFYI, the patch has been comitted into printk/linux.git,
branch rework//console-list-lock.

I am going to add it into a pull request for 6.2-rc5 together
with another related fix.

Best Regards,
Petr