Re: [PATCH] reset: fix kernel-doc warnings

From: Philipp Zabel
Date: Thu Oct 24 2019 - 04:48:01 EST


Hi Randy,

thank you for the fixes.

On Tue, 2019-10-22 at 20:57 -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>
> Fix kernel-doc warnings discovered in the reset controller API chapter.
> Fixes these warnings:
>
> ./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
> ./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format: * of_reset_control_get_count - Count number of resets available with a device
> ./drivers/reset/core.c:838: warning: Function parameter or member 'node' not described in 'of_reset_control_get_count'
> ./include/linux/reset-controller.h:45: warning: Function parameter or member 'con_id' not described in 'reset_control_lookup'
> ./drivers/reset/core.c:86: warning: Excess function parameter 'flags' description in 'of_reset_simple_xlate'
> ./drivers/reset/core.c:830: warning: Incorrect use of kernel-doc format: * of_reset_control_get_count - Count number of resets available with a device
>
> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> Cc: Philipp Zabel <p.zabel@xxxxxxxxxxxxxx>
> ---
> drivers/reset/core.c | 4 ++--
> include/linux/reset-controller.h | 4 ++--
[...]
> @@ -7,7 +7,7 @@
> struct reset_controller_dev;
>
> /**
> - * struct reset_control_ops
> + * struct reset_control_ops - reset controller driver callbacks
> *
> * @reset: for self-deasserting resets, does all necessary
> * things to reset the device

This is all that remains when I rebase onto reset/fixes. Ok to apply
this and change the commit message to:

reset: fix reset_control_ops kerneldoc comment

Add a missing short description to the reset_control_ops
documentation.

?

regards
Philipp