printk: htmldocs: add missing description

jogness · pmladek · commit 5074ffbec67a · 2022-12-02T11:25:02.000+01:00
Variable and return descriptions were missing from the SRCU read lock functions. Add them. Signed-off-by: John Ogness <john.ogness@linutronix.de> Signed-off-by: Petr Mladek <pmladek@suse.com> Link: https://lore.kernel.org/r/87zgcjpdvo.fsf@jogness.linutronix.de
diff --git 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()
  */

Original file line number	Diff line number	Diff line change
`@@ -282,6 +282,7 @@ EXPORT_SYMBOL(console_list_unlock);`
`282`	`282`	`* Use for_each_console_srcu() to iterate the console list`
`283`	`283`	`*`
`284`	`284`	`* Context: Any context.`
	`285`	`+ * Return: A cookie to pass to console_srcu_read_unlock().`
`285`	`286`	`*/`
`286`	`287`	`int console_srcu_read_lock(void)`
`287`	`288`	`{`
`@@ -292,6 +293,7 @@ EXPORT_SYMBOL(console_srcu_read_lock);`
`292`	`293`	`/**`
`293`	`294`	`* console_srcu_read_unlock - Unregister an old reader from`
`294`	`295`	`* the SRCU-protected console list`
	`296`	`+ * @cookie: cookie returned from console_srcu_read_lock()`
`295`	`297`	`*`
`296`	`298`	`* Counterpart to console_srcu_read_lock()`
`297`	`299`	`*/`