diff mbox series

[printk] printk: htmldocs: add missing description

Message ID 87zgcjpdvo.fsf@jogness.linutronix.de
State New
Headers
Series [printk] printk: htmldocs: add missing description |

Commit Message

John Ogness Nov. 22, 2022, 8:55 a.m. UTC 
  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(+)

Comments

Petr Mladek Nov. 22, 2022, 11:06 a.m. UTC | #1 
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
diff mbox series

Patch

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()
  */