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

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

[Stephen Rothwell]

[-- Attachment #1: Type: text/plain, Size: 354 bytes --]

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

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[PATCH printk] printk: htmldocs: add missing description

[John Ogness]

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

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

[Petr Mladek]

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 <john.ogness@linutronix.de>

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

Best Regards,
Petr