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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-Id: <20200629124752.1018358-4-lee.jones@linaro.org>
Date:   Mon, 29 Jun 2020 13:47:51 +0100
From:   Lee Jones <lee.jones@...aro.org>
To:     thierry.reding@...il.com, u.kleine-koenig@...gutronix.de,
        linux-pwm@...r.kernel.org
Cc:     linux-arm-kernel@...ts.infradead.org, linux-kernel@...r.kernel.org,
        Lee Jones <lee.jones@...aro.org>,
        Matthias Brugger <matthias.bgg@...il.com>,
        John Crispin <blogic@...nwrt.org>,
        Zhi Mao <zhi.mao@...iatek.com>,
        linux-mediatek@...ts.infradead.org
Subject: [PATCH 3/4] pwm: mediatek: Provide missing kerneldoc description for 'soc' arg

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@...il.com>
Cc: John Crispin <blogic@...nwrt.org>
Cc: Zhi Mao <zhi.mao@...iatek.com>
Cc: linux-pwm@...r.kernel.org
Cc: linux-mediatek@...ts.infradead.org
Signed-off-by: Lee Jones <lee.jones@...aro.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