Linux-mediatek Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH 3/4] pwm: mediatek: Provide missing kerneldoc description for 'soc' arg
       [not found] <20200629124752.1018358-1-lee.jones@linaro.org>
@ 2020-06-29 12:47 ` Lee Jones
  2020-06-29 19:47   ` Uwe Kleine-König
  0 siblings, 1 reply; 2+ messages in thread
From: Lee Jones @ 2020-06-29 12:47 UTC (permalink / raw)
  To: thierry.reding, u.kleine-koenig, linux-pwm
  Cc: linux-kernel, linux-mediatek, Zhi Mao, Matthias Brugger,
	Lee Jones, linux-arm-kernel, John Crispin

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@gmail.com>
Cc: John Crispin <blogic@openwrt.org>
Cc: Zhi Mao <zhi.mao@mediatek.com>
Cc: linux-pwm@vger.kernel.org
Cc: linux-mediatek@lists.infradead.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 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;
-- 
2.25.1


_______________________________________________
Linux-mediatek mailing list
Linux-mediatek@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-mediatek

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH 3/4] pwm: mediatek: Provide missing kerneldoc description for 'soc' arg
  2020-06-29 12:47 ` [PATCH 3/4] pwm: mediatek: Provide missing kerneldoc description for 'soc' arg Lee Jones
@ 2020-06-29 19:47   ` Uwe Kleine-König
  0 siblings, 0 replies; 2+ messages in thread
From: Uwe Kleine-König @ 2020-06-29 19:47 UTC (permalink / raw)
  To: Lee Jones
  Cc: linux-pwm, linux-kernel, thierry.reding, linux-mediatek, Zhi Mao,
	Matthias Brugger, linux-arm-kernel, John Crispin

[-- Attachment #1.1: Type: text/plain, Size: 1442 bytes --]

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@gmail.com>
> Cc: John Crispin <blogic@openwrt.org>
> Cc: Zhi Mao <zhi.mao@mediatek.com>
> Cc: linux-pwm@vger.kernel.org
> Cc: linux-mediatek@lists.infradead.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  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@pengutronix.de>

Best regards
Uwe

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

[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[-- Attachment #2: Type: text/plain, Size: 170 bytes --]

_______________________________________________
Linux-mediatek mailing list
Linux-mediatek@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-mediatek

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, back to index

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <20200629124752.1018358-1-lee.jones@linaro.org>
2020-06-29 12:47 ` [PATCH 3/4] pwm: mediatek: Provide missing kerneldoc description for 'soc' arg Lee Jones
2020-06-29 19:47   ` Uwe Kleine-König

Linux-mediatek Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-mediatek/0 linux-mediatek/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-mediatek linux-mediatek/ https://lore.kernel.org/linux-mediatek \
		linux-mediatek@lists.infradead.org
	public-inbox-index linux-mediatek

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.infradead.lists.linux-mediatek


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git