tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

watchdog: Add kernel-doc for wdt_set_timeout()

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>

authored by

Yang Li and committed by
Wim Van Sebroeck d2f656dc b568b150

+4
+4
drivers/watchdog/it87_wdt.c
··· 213 213 214 214 /** 215 215 * wdt_set_timeout - set a new timeout value with watchdog ioctl 216 + * @wdd: pointer to the watchdog_device structure 216 217 * @t: timeout value in seconds 217 218 * 218 219 * The hardware device has a 8 or 16 bit watchdog timer (depends on 219 220 * chip version) that can be configured to count seconds or minutes. 220 221 * 221 222 * Used within WDIOC_SETTIMEOUT watchdog device ioctl. 223 + * 224 + * Return: 0 if the timeout was set successfully, or a negative error code on 225 + * failure. 222 226 */ 223 227 224 228 static int wdt_set_timeout(struct watchdog_device *wdd, unsigned int t)