lkml.org 
[lkml]   [2022]   [Nov]   [22]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[PATCH printk] printk: htmldocs: add missing description
Date
Variable and return descriptions were missing from the SRCU read
lock functions. Add them.

Signed-off-by: John Ogness <john.ogness@linutronix.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
\
 
 \ /
  Last update: 2022-11-22 09:56    [W:1.290 / U:0.176 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site