2017-12-13 19:43:56

by Corentin Labbe

Subject: [PATCH] watchdog: document watchdog_init_timeout() wdd parameter

All parameters of watchdog_init_timeout() are documented with exception
of wdd, thus generating a build warning.

This patch document it and so remove the following build warning:
drivers/watchdog/watchdog_core.c:113: warning: No description found for parameter 'wdd'

Signed-off-by: Corentin Labbe <[email protected]>
---
drivers/watchdog/watchdog_core.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/watchdog/watchdog_core.c b/drivers/watchdog/watchdog_core.c
index 8a8d952f8df9..eb8fa25f8eb2 100644
--- a/drivers/watchdog/watchdog_core.c
+++ b/drivers/watchdog/watchdog_core.c
@@ -97,6 +97,7 @@ static void watchdog_check_min_max_timeout(struct watchdog_device *wdd)

/**
* watchdog_init_timeout() - initialize the timeout field
+ * @wdd: watchdog device
* @timeout_parm: timeout module parameter
* @dev: Device that stores the timeout-sec property
*
--
2.13.6

2017-12-14 14:30:31

by Guenter Roeck

Subject: Re: [PATCH] watchdog: document watchdog_init_timeout() wdd parameter

On 12/13/2017 11:41 AM, Corentin Labbe wrote:
> All parameters of watchdog_init_timeout() are documented with exception
> of wdd, thus generating a build warning.
>
> This patch document it and so remove the following build warning:
> drivers/watchdog/watchdog_core.c:113: warning: No description found for parameter 'wdd'
>
> Signed-off-by: Corentin Labbe <[email protected]>

Reviewed-by: Guenter Roeck <[email protected]>

> ---
> drivers/watchdog/watchdog_core.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/watchdog/watchdog_core.c b/drivers/watchdog/watchdog_core.c
> index 8a8d952f8df9..eb8fa25f8eb2 100644
> --- a/drivers/watchdog/watchdog_core.c
> +++ b/drivers/watchdog/watchdog_core.c
> @@ -97,6 +97,7 @@ static void watchdog_check_min_max_timeout(struct watchdog_device *wdd)
>
> /**
> * watchdog_init_timeout() - initialize the timeout field
> + * @wdd: watchdog device
> * @timeout_parm: timeout module parameter
> * @dev: Device that stores the timeout-sec property
> *
>