linux-watchdog.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Guenter Roeck <linux@roeck-us.net>
To: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Cc: linux-watchdog@vger.kernel.org, linux-kernel@vger.kernel.org,
	Wim Van Sebroeck <wim@linux-watchdog.org>,
	Srinath Mannam <srinath.mannam@broadcom.com>
Subject: Re: [PATCH v1 1/1] watchdog: sp805: Fix kernel doc description
Date: Mon, 17 May 2021 14:48:30 -0700	[thread overview]
Message-ID: <20210517214830.GB3623005@roeck-us.net> (raw)
In-Reply-To: <20210517174912.26419-1-andriy.shevchenko@linux.intel.com>

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
> 

      reply	other threads:[~2021-05-17 21:48 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210517214830.GB3623005@roeck-us.net \
    --to=linux@roeck-us.net \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-watchdog@vger.kernel.org \
    --cc=srinath.mannam@broadcom.com \
    --cc=wim@linux-watchdog.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).