linux-kernel - Re: [PATCH printk v2 10/26] printk: nbcon: Fix kerneldoc for enums

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <ae677f7e-0694-4af0-8f43-df839444aca8@infradead.org>
Date: Sun, 18 Feb 2024 11:10:28 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: John Ogness <john.ogness@...utronix.de>, Petr Mladek <pmladek@...e.com>
Cc: Sergey Senozhatsky <senozhatsky@...omium.org>,
 Steven Rostedt <rostedt@...dmis.org>, Thomas Gleixner <tglx@...utronix.de>,
 linux-kernel@...r.kernel.org, Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Subject: Re: [PATCH printk v2 10/26] printk: nbcon: Fix kerneldoc for enums



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@...utronix.de>

Reviewed-by: Randy Dunlap <rdunlap@...radead.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...)

-- 
#Randy