watchdog: document watchdog_init_timeout() wdd parameter

Message ID 20171213194140.1717-1-clabbe.montjoie@gmail.com
State New
Headers show
Series
  • watchdog: document watchdog_init_timeout() wdd parameter
Related show

Commit Message

Corentin Labbe Dec. 13, 2017, 7:41 p.m.
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 <clabbe.montjoie@gmail.com>

---
 drivers/watchdog/watchdog_core.c | 1 +
 1 file changed, 1 insertion(+)

-- 
2.13.6

--
To unsubscribe from this list: send the line "unsubscribe linux-watchdog" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Comments

Guenter Roeck Dec. 14, 2017, 2:30 p.m. | #1
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 <clabbe.montjoie@gmail.com>


Reviewed-by: Guenter Roeck <linux@roeck-us.net>


> ---

>   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

>    *

> 


--
To unsubscribe from this list: send the line "unsubscribe linux-watchdog" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

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
  *