2023-12-18 06:28:02

by Randy Dunlap

Subject: [PATCH] watchdog: mlx_wdt: fix all kernel-doc warnings

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 <[email protected]>
Reported-by: kernel test robot <[email protected]>
Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
Cc: Michael Shych <[email protected]>
Cc: Wim Van Sebroeck <[email protected]>
Cc: Guenter Roeck <[email protected]>
Cc: [email protected]
---
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;

2023-12-18 19:04:07

by Guenter Roeck

Subject: Re: [PATCH] watchdog: mlx_wdt: fix all kernel-doc warnings

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 <[email protected]>
> Reported-by: kernel test robot <[email protected]>
> Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
> Cc: Michael Shych <[email protected]>
> Cc: Wim Van Sebroeck <[email protected]>
> Cc: Guenter Roeck <[email protected]>
> Cc: [email protected]

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

> ---
> 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;
>