linux-kernel - Re: [PATCH] android: binder: fix a kernel-doc enum warning

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] [day] [month] [year] [list]

Message-ID: <ZW-vJGvhQY6oftiJ@google.com>
Date:   Tue, 5 Dec 2023 23:15:48 +0000
From:   Carlos Llamas <cmllamas@...gle.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     linux-kernel@...r.kernel.org,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Arve Hjønnevåg <arve@...roid.com>,
        Todd Kjos <tkjos@...roid.com>,
        Martijn Coenen <maco@...roid.com>,
        Joel Fernandes <joel@...lfernandes.org>,
        Christian Brauner <christian@...uner.io>,
        Suren Baghdasaryan <surenb@...gle.com>
Subject: Re: [PATCH] android: binder: fix a kernel-doc enum warning

On Tue, Dec 05, 2023 at 02:53:18PM -0800, Randy Dunlap wrote:
> Add kernel-doc notation for @LOOP_END to prevent a kernel-doc
> warning.
> 
> binder_alloc_selftest.c:76: warning: Enum value 'LOOP_END' not described in enum 'buf_end_align_type'
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
> Cc: Arve Hjønnevåg <arve@...roid.com>
> Cc: Todd Kjos <tkjos@...roid.com>
> Cc: Martijn Coenen <maco@...roid.com>
> Cc: Joel Fernandes <joel@...lfernandes.org>
> Cc: Christian Brauner <christian@...uner.io>
> Cc: Carlos Llamas <cmllamas@...gle.com>
> Cc: Suren Baghdasaryan <surenb@...gle.com>
> ---
>  drivers/android/binder_alloc_selftest.c |    4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff -- a/drivers/android/binder_alloc_selftest.c b/drivers/android/binder_alloc_selftest.c
> --- a/drivers/android/binder_alloc_selftest.c
> +++ b/drivers/android/binder_alloc_selftest.c
> @@ -72,6 +72,10 @@ enum buf_end_align_type {
>  	 * buf1 ]|[ buf2 | buf2 | buf2 ][ ...
>  	 */
>  	NEXT_NEXT_UNALIGNED,
> +	/**
> +	 * @LOOP_END: The number of enum values in &buf_end_align_type.
> +	 * It is used for controlling loop termination.
> +	 */
>  	LOOP_END,
>  };
>  

'LOOP_END' seems self explanatory to me but if this helps to clear the
warning then why not. Thanks Randy!

Acked-by: Carlos Llamas <cmllamas@...gle.com>