From: Guenter Roeck <linux@roeck-us.net>
To: Yang Li <yang.lee@linux.alibaba.com>, wim@linux-watchdog.org
Cc: linux-watchdog@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH -next] watchdog: Add kernel-doc for wdt_set_timeout()
Date: Tue, 6 Feb 2024 07:06:12 -0800 [thread overview]
Message-ID: <993b31e8-feef-4ad7-a3ab-9ee4f8c6d847@roeck-us.net> (raw)
In-Reply-To: <20240206093857.62444-1-yang.lee@linux.alibaba.com>
On 2/6/24 01:38, Yang Li wrote:
> The wdt_set_timeout function lacked a complete kernel-doc
> description. This patch adds missing parameter and return
> value descriptions in accordance with kernel-doc standards.
>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Reviewed-by: Guenter Roeck <linux@roeckus.net>
> ---
> drivers/watchdog/it87_wdt.c | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/drivers/watchdog/it87_wdt.c b/drivers/watchdog/it87_wdt.c
> index 9297a5891912..3e8c15138edd 100644
> --- a/drivers/watchdog/it87_wdt.c
> +++ b/drivers/watchdog/it87_wdt.c
> @@ -213,12 +213,16 @@ static int wdt_stop(struct watchdog_device *wdd)
>
> /**
> * wdt_set_timeout - set a new timeout value with watchdog ioctl
> + * @wdd: pointer to the watchdog_device structure
> * @t: timeout value in seconds
> *
> * The hardware device has a 8 or 16 bit watchdog timer (depends on
> * chip version) that can be configured to count seconds or minutes.
> *
> * Used within WDIOC_SETTIMEOUT watchdog device ioctl.
> + *
> + * Return: 0 if the timeout was set successfully, or a negative error code on
> + * failure.
> */
>
> static int wdt_set_timeout(struct watchdog_device *wdd, unsigned int t)
prev parent reply other threads:[~2024-02-06 15:06 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-06 9:38 [PATCH -next] watchdog: Add kernel-doc for wdt_set_timeout() Yang Li
2024-02-06 15:06 ` 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=993b31e8-feef-4ad7-a3ab-9ee4f8c6d847@roeck-us.net \
--to=linux@roeck-us.net \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-watchdog@vger.kernel.org \
--cc=wim@linux-watchdog.org \
--cc=yang.lee@linux.alibaba.com \
/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 read-only IMAP folder(s) and NNTP newsgroup(s).