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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <1c14424f-0e7f-4300-a010-3d95fbb72716@roeck-us.net>
Date: Mon, 18 Dec 2023 11:03:50 -0800
From: Guenter Roeck <linux@...ck-us.net>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: kernel test robot <lkp@...el.com>, Michael Shych <michaelsh@...dia.com>,
 Wim Van Sebroeck <wim@...ux-watchdog.org>, linux-watchdog@...r.kernel.org
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 <rdunlap@...radead.org>
> Reported-by: kernel test robot <lkp@...el.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202312171701.xNkzdgdi-lkp@intel.com/
> Cc: Michael Shych <michaelsh@...dia.com>
> Cc: Wim Van Sebroeck <wim@...ux-watchdog.org>
> Cc: Guenter Roeck <linux@...ck-us.net>
> Cc: linux-watchdog@...r.kernel.org

Reviewed-by: Guenter Roeck <linux@...ck-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;
>