2023-12-05 22:54:24

by Randy Dunlap

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

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 <[email protected]>
Cc: Greg Kroah-Hartman <[email protected]>
Cc: Arve Hjønnevåg <[email protected]>
Cc: Todd Kjos <[email protected]>
Cc: Martijn Coenen <[email protected]>
Cc: Joel Fernandes <[email protected]>
Cc: Christian Brauner <[email protected]>
Cc: Carlos Llamas <[email protected]>
Cc: Suren Baghdasaryan <[email protected]>
---
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,
};

2023-12-05 23:16:36

by Carlos Llamas

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 <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: Arve Hj?nnev?g <[email protected]>
> Cc: Todd Kjos <[email protected]>
> Cc: Martijn Coenen <[email protected]>
> Cc: Joel Fernandes <[email protected]>
> Cc: Christian Brauner <[email protected]>
> Cc: Carlos Llamas <[email protected]>
> Cc: Suren Baghdasaryan <[email protected]>
> ---
> 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 <[email protected]>