Re: [PATCH 3/4] pwm: mediatek: Provide missing kerneldoc description for 'soc' arg

From: Uwe Kleine-KÃnig
Date: Mon Jun 29 2020 - 15:47:56 EST


Hello Lee,

On Mon, Jun 29, 2020 at 01:47:51PM +0100, Lee Jones wrote:
> Kerneldoc syntax is used, but not complete.
>
> Descriptions are required for all arguments.
>
> Fixes the following W=1 build warning:
>
> drivers/pwm/pwm-mediatek.c:57: warning: Function parameter or member 'soc' not described in 'pwm_mediatek_chip'
>
> Cc: Matthias Brugger <matthias.bgg@xxxxxxxxx>
> Cc: John Crispin <blogic@xxxxxxxxxxx>
> Cc: Zhi Mao <zhi.mao@xxxxxxxxxxxx>
> Cc: linux-pwm@xxxxxxxxxxxxxxx
> Cc: linux-mediatek@xxxxxxxxxxxxxxxxxxx
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>
> ---
> drivers/pwm/pwm-mediatek.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/pwm/pwm-mediatek.c b/drivers/pwm/pwm-mediatek.c
> index b94e0d09c300f..ab001ce55178e 100644
> --- a/drivers/pwm/pwm-mediatek.c
> +++ b/drivers/pwm/pwm-mediatek.c
> @@ -46,6 +46,7 @@ struct pwm_mediatek_of_data {
> * @clk_main: the clock used by PWM core
> * @clk_pwms: the clock used by each PWM channel
> * @clk_freq: the fix clock frequency of legacy MIPS SoC
> + * @soc: pointer to chip's platform data
> */
> struct pwm_mediatek_chip {
> struct pwm_chip chip;

LGTM:

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

Best regards
Uwe

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

Attachment: signature.asc
Description: PGP signature