MIRRORS/linux-yocto
1
0
Fork 0
mirror of git://git.yoctoproject.org/linux-yocto.git synced 2025-07-05 21:35:46 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

watchdog: Add kernel-doc for wdt_set_timeout()

Browse Source 
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>
Link: https://lore.kernel.org/r/20240206093857.62444-1-yang.lee@linux.alibaba.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Signed-off-by: Wim Van Sebroeck <wim@linux-watchdog.org>
This commit is contained in:
Yang Li 2024-02-06 17:38:57 +08:00 committed by Wim Van Sebroeck
parent b568b1504d
commit d2f656dc49
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
drivers/watchdog/it87_wdt.c
View File

@ -213,12 +213,16 @@ static int wdt_stop(struct watchdog_device *wdd)
/** /**
* wdt_set_timeout - set a new timeout value with watchdog ioctl * wdt_set_timeout - set a new timeout value with watchdog ioctl
* @wdd: pointer to the watchdog_device structure
* @t: timeout value in seconds * @t: timeout value in seconds
* *
* The hardware device has a 8 or 16 bit watchdog timer (depends on * The hardware device has a 8 or 16 bit watchdog timer (depends on
* chip version) that can be configured to count seconds or minutes. * chip version) that can be configured to count seconds or minutes.
* *
* Used within WDIOC_SETTIMEOUT watchdog device ioctl. * 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) static int wdt_set_timeout(struct watchdog_device *wdd, unsigned int t)