Re: [PATCH] firmware: stratix10-svc: remove extraneous asterisk from #define comments

[Randy Dunlap]

Hi,

On 6/11/22 18:22, Bagas Sanjaya wrote:
> kernel test robot reported kernel-doc warning:
> 
>>> include/linux/firmware/intel/stratix10-svc-client.h:19: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> 
> The warning above is because comments above #define statements are prefixed
> with double asterisk, which kernel-doc script mistook these as actual
> kernel-doc comment.
> 
> Remove extraneouse asterisk from these comments.

         extraneous

> 
> Link: https://lore.kernel.org/lkml/202206120445.FeU5wA93-lkp@xxxxxxxxx/
> Fixes: 88f42ac48b8968 ("firmware: stratix10-svc: Add support for FCS")
> Reported-by: kernel test robot <lkp@xxxxxxxxx>
> Cc: Ang Tien Sung <tien.sung.ang@xxxxxxxxx>
> Cc: Richard Gong <richard.gong@xxxxxxxxx>
> Cc: Dinh Nguyen <dinguyen@xxxxxxxxxx>
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>

Thanks.

> ---
>  include/linux/firmware/intel/stratix10-svc-client.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h
> index 5098dbba138d0f..63927aba0b5699 100644
> --- a/include/linux/firmware/intel/stratix10-svc-client.h
> +++ b/include/linux/firmware/intel/stratix10-svc-client.h
> @@ -15,7 +15,7 @@
>  #define SVC_CLIENT_FPGA			"fpga"
>  #define SVC_CLIENT_RSU			"rsu"
>  #define SVC_CLIENT_FCS			"fcs"
> -/**
> +/*
>   * Status of the sent command, in bit number
>   *
>   * SVC_STATUS_OK:
> @@ -50,7 +50,7 @@
>  #define SVC_STATUS_ERROR		5
>  #define SVC_STATUS_NO_SUPPORT		6
>  #define SVC_STATUS_INVALID_PARAM	7
> -/**
> +/*
>   * Flag bit for COMMAND_RECONFIG
>   *
>   * COMMAND_RECONFIG_FLAG_PARTIAL:
> 
> base-commit: 107da326a0a3e7b6e81557c4225548db670a2647

-- 
~Randy