Hi all,
After merging the printk tree, today's linux-next build (htmldocs)
produced this warning:
kernel/printk/printk.c:298: warning: Function parameter or member 'cookie' not described in 'console_srcu_read_unlock'
Introduced by commit
8bdbdd7f43cd ("printk: Prepare for SRCU console list protection")
--
Cheers,
Stephen Rothwell
Variable and return descriptions were missing from the SRCU read
lock functions. Add them.
Signed-off-by: John Ogness <[email protected]>
---
Fix htmldocs build warning as reported by Stephen [0]. Thanks Stephen!
[0] https://lore.kernel.org/lkml/[email protected]
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
On Tue 2022-11-22 10:01:23, John Ogness wrote:
> Variable and return descriptions were missing from the SRCU read
> lock functions. Add them.
>
> Signed-off-by: John Ogness <[email protected]>
JFYI, the patch is comitted in printk/linux.git,
branch rework/console-list-lock.
Best Regards,
Petr