Re: [PATCH 4/4] pwm: omap-dmtimer: Repair pwm_omap_dmtimer_chip's broken kerneldoc header

From: Uwe Kleine-KÃnig
Date: Mon Jun 29 2020 - 16:02:16 EST


Hello,

[dropped Joachim Eastwood <manabian@xxxxxxxxx> from recipents as his
address bounces]

On Mon, Jun 29, 2020 at 01:47:52PM +0100, Lee Jones wrote:
> Argument descriptions must be prepended with a '@' to be understood
> by the kerneldoc tooling/parsers/validators.
>
> Fixes the following W=1 warning:
>
> drivers/pwm/pwm-omap-dmtimer.c:70: warning: Function parameter or member 'dm_timer_pdev' not described in 'pwm_omap_dmtimer_chip'
>
> Cc: Tony Lindgren <tony@xxxxxxxxxxx>
> Cc: Joachim Eastwood <manabian@xxxxxxxxx>
> Cc: NeilBrown <neilb@xxxxxxx>
> Cc: Grant Erickson <marathon96@xxxxxxxxx>
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> ---
> drivers/pwm/pwm-omap-dmtimer.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/pwm/pwm-omap-dmtimer.c b/drivers/pwm/pwm-omap-dmtimer.c
> index 0d31833db2e2c..75cea7f2aff5e 100644
> --- a/drivers/pwm/pwm-omap-dmtimer.c
> +++ b/drivers/pwm/pwm-omap-dmtimer.c
> @@ -58,7 +58,7 @@
> * @mutex: Mutex to protect pwm apply state
> * @dm_timer: Pointer to omap dm timer.
> * @pdata: Pointer to omap dm timer ops.
> - * dm_timer_pdev: Pointer to omap dm timer platform device
> + * @dm_timer_pdev: Pointer to omap dm timer platform device
> */
> struct pwm_omap_dmtimer_chip {
> struct pwm_chip chip;

LGTM,

Acked-by: Uwe Kleine-König <u.kleine-koenig@xxxxxxxxxxxxxx>

Thanks
Uwe

--
Pengutronix e.K. | Uwe Kleine-König |
Industrial Linux Solutions | https://www.pengutronix.de/ |

Attachment: signature.asc
Description: PGP signature