diff mbox series

watchdog: mlx_wdt: fix all kernel-doc warnings

Message ID 20231218062659.26916-1-rdunlap@infradead.org
State New
Headers
Series watchdog: mlx_wdt: fix all kernel-doc warnings |

Commit Message

Randy Dunlap Dec. 18, 2023, 6:26 a.m. UTC 
  Correct kernel-doc warnings as reported by kernel test robot:

mlx_wdt.c:56: warning: Function parameter or member 'wdt_type' not described in 'mlxreg_wdt'
mlx_wdt.c:56: warning: Excess struct member 'device' description in 'mlxreg_wdt'
mlx_wdt.c:56: warning: Excess struct member 'timeout' description in 'mlxreg_wdt'
mlx_wdt.c:56: warning: Excess struct member 'wd_type' description in 'mlxreg_wdt'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202312171701.xNkzdgdi-lkp@intel.com/
Cc: Michael Shych <michaelsh@nvidia.com>
Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: linux-watchdog@vger.kernel.org
---
 drivers/watchdog/mlx_wdt.c |    4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

Comments

Guenter Roeck Dec. 18, 2023, 7:03 p.m. UTC | #1 
On 12/17/23 22:26, Randy Dunlap wrote:
> Correct kernel-doc warnings as reported by kernel test robot:
> 
> mlx_wdt.c:56: warning: Function parameter or member 'wdt_type' not described in 'mlxreg_wdt'
> mlx_wdt.c:56: warning: Excess struct member 'device' description in 'mlxreg_wdt'
> mlx_wdt.c:56: warning: Excess struct member 'timeout' description in 'mlxreg_wdt'
> mlx_wdt.c:56: warning: Excess struct member 'wd_type' description in 'mlxreg_wdt'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202312171701.xNkzdgdi-lkp@intel.com/
> Cc: Michael Shych <michaelsh@nvidia.com>
> Cc: Wim Van Sebroeck <wim@linux-watchdog.org>
> Cc: Guenter Roeck <linux@roeck-us.net>
> Cc: linux-watchdog@vger.kernel.org

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

> ---
>   drivers/watchdog/mlx_wdt.c |    4 +---
>   1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff -- a/drivers/watchdog/mlx_wdt.c b/drivers/watchdog/mlx_wdt.c
> --- a/drivers/watchdog/mlx_wdt.c
> +++ b/drivers/watchdog/mlx_wdt.c
> @@ -30,17 +30,15 @@
>    * struct mlxreg_wdt - wd private data:
>    *
>    * @wdd:	watchdog device;
> - * @device:	basic device;
>    * @pdata:	data received from platform driver;
>    * @regmap:	register map of parent device;
> - * @timeout:	defined timeout in sec.;
>    * @action_idx:	index for direct access to action register;
>    * @timeout_idx:index for direct access to TO register;
>    * @tleft_idx:	index for direct access to time left register;
>    * @ping_idx:	index for direct access to ping register;
>    * @reset_idx:	index for direct access to reset cause register;
>    * @regmap_val_sz: size of value in register map;
> - * @wd_type:	watchdog HW type;
> + * @wdt_type:	watchdog HW type;
>    */
>   struct mlxreg_wdt {
>   	struct watchdog_device wdd;
>
diff mbox series

Patch

diff -- a/drivers/watchdog/mlx_wdt.c b/drivers/watchdog/mlx_wdt.c
--- a/drivers/watchdog/mlx_wdt.c
+++ b/drivers/watchdog/mlx_wdt.c
@@ -30,17 +30,15 @@ 
  * struct mlxreg_wdt - wd private data:
  *
  * @wdd:	watchdog device;
- * @device:	basic device;
  * @pdata:	data received from platform driver;
  * @regmap:	register map of parent device;
- * @timeout:	defined timeout in sec.;
  * @action_idx:	index for direct access to action register;
  * @timeout_idx:index for direct access to TO register;
  * @tleft_idx:	index for direct access to time left register;
  * @ping_idx:	index for direct access to ping register;
  * @reset_idx:	index for direct access to reset cause register;
  * @regmap_val_sz: size of value in register map;
- * @wd_type:	watchdog HW type;
+ * @wdt_type:	watchdog HW type;
  */
 struct mlxreg_wdt {
 	struct watchdog_device wdd;