linux-kernel - Re: [PATCH v2] gpio: EN7523: fix 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: <CAMRc=MeGmN1xEEGhXV=zY9kKJayBbF4UABZEK4ieQPxzVefHfw@mail.gmail.com>
Date: Mon, 15 Jan 2024 11:15:41 +0100
From: Bartosz Golaszewski <brgl@...ev.pl>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, John Crispin <john@...ozen.org>, 
	Linus Walleij <linus.walleij@...aro.org>, Felix Fietkau <nbd@....name>, linux-gpio@...r.kernel.org
Subject: Re: [PATCH v2] gpio: EN7523: fix kernel-doc warnings

On Mon, Jan 15, 2024 at 6:21 AM Randy Dunlap <rdunlap@...radead.org> wrote:
>
> Add "struct" keyword and explain the @dir array differently to
> prevent kernel-doc warnings:
>
> gpio-en7523.c:22: warning: cannot understand function prototype: 'struct airoha_gpio_ctrl '
> gpio-en7523.c:27: warning: Function parameter or struct member 'dir' not described in 'airoha_gpio_ctrl'
> gpio-en7523.c:27: warning: Excess struct member 'dir0' description in 'airoha_gpio_ctrl'
> gpio-en7523.c:27: warning: Excess struct member 'dir1' description in 'airoha_gpio_ctrl'
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: John Crispin <john@...ozen.org>
> Cc: Linus Walleij <linus.walleij@...aro.org>
> Cc: Bartosz Golaszewski <brgl@...ev.pl>
> Cc: Felix Fietkau <nbd@....name>
> Cc: linux-gpio@...r.kernel.org
> ---
> v2: Add commit text.
>
>  drivers/gpio/gpio-en7523.c |    6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff -- a/drivers/gpio/gpio-en7523.c b/drivers/gpio/gpio-en7523.c
> --- a/drivers/gpio/gpio-en7523.c
> +++ b/drivers/gpio/gpio-en7523.c
> @@ -12,11 +12,11 @@
>  #define AIROHA_GPIO_MAX                32
>
>  /**
> - * airoha_gpio_ctrl - Airoha GPIO driver data
> + * struct airoha_gpio_ctrl - Airoha GPIO driver data
>   * @gc: Associated gpio_chip instance.
>   * @data: The data register.
> - * @dir0: The direction register for the lower 16 pins.
> - * @dir1: The direction register for the higher 16 pins.
> + * @dir: [0] The direction register for the lower 16 pins.
> + * [1]: The direction register for the higher 16 pins.
>   * @output: The output enable register.
>   */
>  struct airoha_gpio_ctrl {

Could you add a Fixes: tag too, please?

Bartosz