linux-kernel - Re: [PATCH 09/20] misc: habanalabs: gaudi: Remove ill placed asterisk from kerneldoc header

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <CAFCwf11Tmw4cGr2UMY=dnJFPj6d+PLG2F1ThExvA8bM7wVNb=g@mail.gmail.com>
Date:   Mon, 29 Jun 2020 18:01:37 +0300
From:   Oded Gabbay <oded.gabbay@...il.com>
To:     Lee Jones <lee.jones@...aro.org>
Cc:     Arnd Bergmann <arnd@...db.de>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        linux-arm-kernel@...ts.infradead.org,
        "Linux-Kernel@...r. Kernel. Org" <linux-kernel@...r.kernel.org>,
        Tomer Tayar <ttayar@...ana.ai>
Subject: Re: [PATCH 09/20] misc: habanalabs: gaudi: Remove ill placed asterisk
 from kerneldoc header

On Mon, Jun 29, 2020 at 5:04 PM Lee Jones <lee.jones@...aro.org> wrote:
>
> W=1 kernel builds report a lack of description of gaudi_set_asic_funcs()'s
> 'hdev' argument.  In reality it is documented, but the formatting
> was not as expected '@.*:'.  Instead, there was a misplaced asterisk
> which was confusing the kerneldoc validator.
>
> Squashes the following W=1 warning:
>
>  drivers/misc/habanalabs/gaudi/gaudi.c:6746: warning: Function parameter or member 'hdev' not described in 'gaudi_set_asic_funcs'
>
> Cc: Oded Gabbay <oded.gabbay@...il.com>
> Cc: Tomer Tayar <ttayar@...ana.ai>
> Signed-off-by: Lee Jones <lee.jones@...aro.org>
> ---
>  drivers/misc/habanalabs/gaudi/gaudi.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/misc/habanalabs/gaudi/gaudi.c b/drivers/misc/habanalabs/gaudi/gaudi.c
> index 61f88e9884ce9..bdb9c0080c464 100644
> --- a/drivers/misc/habanalabs/gaudi/gaudi.c
> +++ b/drivers/misc/habanalabs/gaudi/gaudi.c
> @@ -6739,7 +6739,7 @@ static const struct hl_asic_funcs gaudi_funcs = {
>  /**
>   * gaudi_set_asic_funcs - set GAUDI function pointers
>   *
> - * @*hdev: pointer to hl_device structure
> + * @hdev: pointer to hl_device structure
>   *
>   */
>  void gaudi_set_asic_funcs(struct hl_device *hdev)
> --
> 2.25.1
>

This patch is:
Reviewed-by: Oded Gabbay <oded.gabbay@...il.com>