diff mbox series

android: binder: fix a kernel-doc enum warning

Message ID 20231205225324.32362-1-rdunlap@infradead.org
State New
Headers
Series android: binder: fix a kernel-doc enum warning |

Commit Message

Randy Dunlap Dec. 5, 2023, 10:53 p.m. UTC 
  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@infradead.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Arve Hjønnevåg <arve@android.com>
Cc: Todd Kjos <tkjos@android.com>
Cc: Martijn Coenen <maco@android.com>
Cc: Joel Fernandes <joel@joelfernandes.org>
Cc: Christian Brauner <christian@brauner.io>
Cc: Carlos Llamas <cmllamas@google.com>
Cc: Suren Baghdasaryan <surenb@google.com>
---
 drivers/android/binder_alloc_selftest.c |    4 ++++
 1 file changed, 4 insertions(+)

Comments

Carlos Llamas Dec. 5, 2023, 11:15 p.m. UTC | #1 
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@infradead.org>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: Arve Hjønnevåg <arve@android.com>
> Cc: Todd Kjos <tkjos@android.com>
> Cc: Martijn Coenen <maco@android.com>
> Cc: Joel Fernandes <joel@joelfernandes.org>
> Cc: Christian Brauner <christian@brauner.io>
> Cc: Carlos Llamas <cmllamas@google.com>
> Cc: Suren Baghdasaryan <surenb@google.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@google.com>
diff mbox series

Patch

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,
 };