Skip to contentSkip to conversation

linux-next: build warning after merge of the printk tree

PATCH In review Stephen Rothwell 3 participants 3 messages Nov 22, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

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")

Signature · 2 lines
Cheers,
Stephen Rothwell
maintainer
#1 lore raw

PATCH 1/1 printk: htmldocs: add missing description

Variable and return descriptions were missing from the SRCU read lock functions. Add them.

---
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(+)
kernel/printk/printk.c +2 -0
index 503d55ccc835..9ec101766471 100644
@@ -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()
  */
Signature · 1 line
2.30.2
maintainer
#2 lore raw

Re: [PATCH printk] printk: htmldocs: add missing description

Quoted 4 lines · John Ogness

Variable and return descriptions were missing from the SRCU read lock functions. Add them.

JFYI, the patch is comitted in printk/linux.git,
branch rework/console-list-lock.

Best Regards,
Petr