[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <87zgcjpdvo.fsf@jogness.linutronix.de>
Date: Tue, 22 Nov 2022 10:01:23 +0106
From: John Ogness <john.ogness@...utronix.de>
To: Petr Mladek <pmladek@...e.com>
Cc: Sergey Senozhatsky <senozhatsky@...omium.org>,
Steven Rostedt <rostedt@...dmis.org>,
linux-kernel@...r.kernel.org,
Stephen Rothwell <sfr@...b.auug.org.au>
Subject: [PATCH printk] printk: htmldocs: add missing description
Variable and return descriptions were missing from the SRCU read
lock functions. Add them.
Signed-off-by: John Ogness <john.ogness@...utronix.de>
---
Fix htmldocs build warning as reported by Stephen [0]. Thanks Stephen!
[0] https://lore.kernel.org/lkml/20221122181052.75618842@canb.auug.org.au
kernel/printk/printk.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/kernel/printk/printk.c b/kernel/printk/printk.c
index 503d55ccc835..9ec101766471 100644
--- a/kernel/printk/printk.c
+++ b/kernel/printk/printk.c
@@ -282,6 +282,7 @@ EXPORT_SYMBOL(console_list_unlock);
* Use for_each_console_srcu() to iterate the console list
*
* Context: Any context.
+ * Return: A cookie to pass to console_srcu_read_unlock().
*/
int console_srcu_read_lock(void)
{
@@ -292,6 +293,7 @@ EXPORT_SYMBOL(console_srcu_read_lock);
/**
* console_srcu_read_unlock - Unregister an old reader from
* the SRCU-protected console list
+ * @cookie: cookie returned from console_srcu_read_lock()
*
* Counterpart to console_srcu_read_lock()
*/
--
2.30.2
Powered by blists - more mailing lists