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

Oded Gabbay oded.gabbay at gmail.com
Mon Jun 29 11:01:37 EDT 2020


On Mon, Jun 29, 2020 at 5:04 PM Lee Jones <lee.jones at linaro.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 at gmail.com>
> Cc: Tomer Tayar <ttayar at habana.ai>
> Signed-off-by: Lee Jones <lee.jones at linaro.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 at gmail.com>



More information about the linux-arm-kernel mailing list