linux-kernel - Re: [PATCH -next] watchdog: Add kernel-doc for wdt_set

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] [day] [month] [year] [list]

Message-ID: <993b31e8-feef-4ad7-a3ab-9ee4f8c6d847@roeck-us.net>
Date: Tue, 6 Feb 2024 07:06:12 -0800
From: Guenter Roeck <linux@...ck-us.net>
To: Yang Li <yang.lee@...ux.alibaba.com>, wim@...ux-watchdog.org
Cc: linux-watchdog@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH -next] watchdog: Add kernel-doc for wdt_set_timeout()

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@...ux.alibaba.com>

Reviewed-by: Guenter Roeck <linux@...ckus.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)