linux-watchdog.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v1 1/1] watchdog: sp805: Fix kernel doc description
@ 2021-05-17 17:49 Andy Shevchenko
  2021-05-17 21:48 ` Guenter Roeck
  0 siblings, 1 reply; 2+ messages in thread
From: Andy Shevchenko @ 2021-05-17 17:49 UTC (permalink / raw)
  To: Guenter Roeck, Andy Shevchenko, linux-watchdog, linux-kernel
  Cc: Wim Van Sebroeck, Srinath Mannam

Kernel doc validation script is not happy

  CHECK   .../sp805_wdt.c
  .../sp805_wdt.c:73: warning: Function parameter or member 'rate' not described in 'sp805_wdt'

Fix this by describing rate parameter.

While at it, mark clk one optional.

Fixes: dc0e4a3bb7dc ("watchdog: sp805: Add clock-frequency property")
Cc: Srinath Mannam <srinath.mannam@broadcom.com>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 drivers/watchdog/sp805_wdt.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/watchdog/sp805_wdt.c b/drivers/watchdog/sp805_wdt.c
index 531551216c8c..dbeb2146c968 100644
--- a/drivers/watchdog/sp805_wdt.c
+++ b/drivers/watchdog/sp805_wdt.c
@@ -57,7 +57,8 @@
  * @wdd: instance of struct watchdog_device
  * @lock: spin lock protecting dev structure and io access
  * @base: base address of wdt
- * @clk: clock structure of wdt
+ * @clk: (optional) clock structure of wdt
+ * @rate: (optional) clock rate when provided via properties
  * @adev: amba device structure of wdt
  * @status: current status of wdt
  * @load_val: load value to be set for current timeout
-- 
2.30.2


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

* Re: [PATCH v1 1/1] watchdog: sp805: Fix kernel doc description
  2021-05-17 17:49 [PATCH v1 1/1] watchdog: sp805: Fix kernel doc description Andy Shevchenko
@ 2021-05-17 21:48 ` Guenter Roeck
  0 siblings, 0 replies; 2+ messages in thread
From: Guenter Roeck @ 2021-05-17 21:48 UTC (permalink / raw)
  To: Andy Shevchenko
  Cc: linux-watchdog, linux-kernel, Wim Van Sebroeck, Srinath Mannam

On Mon, May 17, 2021 at 08:49:12PM +0300, Andy Shevchenko wrote:
> Kernel doc validation script is not happy
> 
>   CHECK   .../sp805_wdt.c
>   .../sp805_wdt.c:73: warning: Function parameter or member 'rate' not described in 'sp805_wdt'
> 
> Fix this by describing rate parameter.
> 
> While at it, mark clk one optional.
> 
> Fixes: dc0e4a3bb7dc ("watchdog: sp805: Add clock-frequency property")
> Cc: Srinath Mannam <srinath.mannam@broadcom.com>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Reviewed-by: Guenter Roeck <linux@roeck-us.net>

> ---
>  drivers/watchdog/sp805_wdt.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/watchdog/sp805_wdt.c b/drivers/watchdog/sp805_wdt.c
> index 531551216c8c..dbeb2146c968 100644
> --- a/drivers/watchdog/sp805_wdt.c
> +++ b/drivers/watchdog/sp805_wdt.c
> @@ -57,7 +57,8 @@
>   * @wdd: instance of struct watchdog_device
>   * @lock: spin lock protecting dev structure and io access
>   * @base: base address of wdt
> - * @clk: clock structure of wdt
> + * @clk: (optional) clock structure of wdt
> + * @rate: (optional) clock rate when provided via properties
>   * @adev: amba device structure of wdt
>   * @status: current status of wdt
>   * @load_val: load value to be set for current timeout
> -- 
> 2.30.2
> 

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

end of thread, other threads:[~2021-05-17 21:48 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-17 17:49 [PATCH v1 1/1] watchdog: sp805: Fix kernel doc description Andy Shevchenko
2021-05-17 21:48 ` Guenter Roeck

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).