diff mbox series

[printk,v2,10/26] printk: nbcon: Fix kerneldoc for enums

Message ID	20240218185726.1994771-11-john.ogness@linutronix.de
State	New
Headers	Received-SPF: pass (google.com: domain of linux-kernel+bounces-70505-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3; From: John Ogness <john.ogness@linutronix.de> To: Petr Mladek <pmladek@suse.com> Cc: Sergey Senozhatsky <senozhatsky@chromium.org>, Steven Rostedt <rostedt@goodmis.org>, Thomas Gleixner <tglx@linutronix.de>, linux-kernel@vger.kernel.org, Greg Kroah-Hartman <gregkh@linuxfoundation.org> Subject: [PATCH printk v2 10/26] printk: nbcon: Fix kerneldoc for enums Date: Sun, 18 Feb 2024 20:03:10 +0106 Message-Id: <20240218185726.1994771-11-john.ogness@linutronix.de> In-Reply-To: <20240218185726.1994771-1-john.ogness@linutronix.de> References: <20240218185726.1994771-1-john.ogness@linutronix.de> Precedence: bulk MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-getmail-retrieved-from-mailbox: INBOX
Series	wire up write_atomic() printing \| [printk,v2,00/26] wire up write_atomic() printing [printk,v2,01/26] serial: core: Provide port lock wrappers [printk,v2,02/26] serial: core: Use lock wrappers [printk,v2,03/26] serial: core: fix kernel-doc for uart_port_unlock_irqrestore() [printk,v2,04/26] printk: Consider nbcon boot consoles on seq init [printk,v2,05/26] printk: Add notation to console_srcu locking [printk,v2,06/26] printk: nbcon: Ensure ownership release on failed emit [printk,v2,07/26] printk: Check printk_deferred_enter()/_exit() usage [printk,v2,08/26] printk: nbcon: Implement processing in port->lock wrapper [printk,v2,09/26] printk: nbcon: Add detailed doc for write_atomic() [printk,v2,10/26] printk: nbcon: Fix kerneldoc for enums [printk,v2,11/26] printk: Make console_is_usable() available to nbcon [printk,v2,12/26] printk: Let console_is_usable() handle nbcon [printk,v2,13/26] printk: Add @flags argument for console_is_usable() [printk,v2,14/26] printk: nbcon: Provide function to flush using write_atomic() [printk,v2,15/26] printk: Track registered boot consoles [printk,v2,16/26] printk: nbcon: Use nbcon consoles in console_flush_all() [printk,v2,17/26] printk: nbcon: Assign priority based on CPU state [printk,v2,18/26] printk: nbcon: Add unsafe flushing on panic [printk,v2,19/26] printk: Avoid console_lock dance if no legacy or boot consoles [printk,v2,20/26] printk: Track nbcon consoles [printk,v2,21/26] printk: Coordinate direct printing in panic [printk,v2,22/26] printk: nbcon: Implement emergency sections [printk,v2,23/26] panic: Mark emergency section in warn [printk,v2,24/26] panic: Mark emergency section in oops [printk,v2,25/26] rcu: Mark emergency section in rcu stalls [printk,v2,26/26] lockdep: Mark emergency section in lockdep splats

Commit Message

John Ogness Feb. 18, 2024, 6:57 p.m. UTC

  Kerneldoc requires enums to be specified as such. Otherwise it is
interpreted as function documentation.

Signed-off-by: John Ogness <john.ogness@linutronix.de>
---
 include/linux/console.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Randy Dunlap Feb. 18, 2024, 7:10 p.m. UTC | #1

On 2/18/24 10:57, John Ogness wrote:
> Kerneldoc requires enums to be specified as such. Otherwise it is
> interpreted as function documentation.
> 
> Signed-off-by: John Ogness <john.ogness@linutronix.de>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  include/linux/console.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/console.h b/include/linux/console.h
> index 5c55faa013e8..d8922282efa1 100644
> --- a/include/linux/console.h
> +++ b/include/linux/console.h
> @@ -130,7 +130,7 @@ static inline int con_debug_leave(void)
>   */
>  
>  /**
> - * cons_flags - General console flags
> + * enum cons_flags - General console flags
>   * @CON_PRINTBUFFER:	Used by newly registered consoles to avoid duplicate
>   *			output of messages that were already shown by boot
>   *			consoles or read by userspace via syslog() syscall.
> @@ -211,7 +211,7 @@ struct nbcon_state {
>  static_assert(sizeof(struct nbcon_state) <= sizeof(int));
>  
>  /**
> - * nbcon_prio - console owner priority for nbcon consoles
> + * enum nbcon_prio - console owner priority for nbcon consoles
>   * @NBCON_PRIO_NONE:		Unused
>   * @NBCON_PRIO_NORMAL:		Normal (non-emergency) usage
>   * @NBCON_PRIO_EMERGENCY:	Emergency output (WARN/OOPS...)

Petr Mladek Feb. 23, 2024, 1:13 p.m. UTC | #2

On Sun 2024-02-18 20:03:10, John Ogness wrote:
> Kerneldoc requires enums to be specified as such. Otherwise it is
> interpreted as function documentation.
> 
> Signed-off-by: John Ogness <john.ogness@linutronix.de>

Good to know. I havn't been aware of it.

Reviewed-by: Petr Mladek <pmladek@suse.com>

Best Regards,
Petr

diff mbox series

Patch

diff --git a/include/linux/console.h b/include/linux/console.h
index 5c55faa013e8..d8922282efa1 100644
--- a/include/linux/console.h
+++ b/include/linux/console.h
@@ -130,7 +130,7 @@  static inline int con_debug_leave(void)
  */
 
 /**
- * cons_flags - General console flags
+ * enum cons_flags - General console flags
  * @CON_PRINTBUFFER:	Used by newly registered consoles to avoid duplicate
  *			output of messages that were already shown by boot
  *			consoles or read by userspace via syslog() syscall.
@@ -211,7 +211,7 @@  struct nbcon_state {
 static_assert(sizeof(struct nbcon_state) <= sizeof(int));
 
 /**
- * nbcon_prio - console owner priority for nbcon consoles
+ * enum nbcon_prio - console owner priority for nbcon consoles
  * @NBCON_PRIO_NONE:		Unused
  * @NBCON_PRIO_NORMAL:		Normal (non-emergency) usage
  * @NBCON_PRIO_EMERGENCY:	Emergency output (WARN/OOPS...)