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

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: <967fa124-5ebc-6b0d-fa1a-27619eb01b8c@infradead.org>
Date:   Sat, 11 Jun 2022 18:31:40 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Bagas Sanjaya <bagasdotme@...il.com>, linux-doc@...r.kernel.org
Cc:     kernel test robot <lkp@...el.com>,
        Ang Tien Sung <tien.sung.ang@...el.com>,
        Richard Gong <richard.gong@...el.com>,
        Dinh Nguyen <dinguyen@...nel.org>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] firmware: stratix10-svc: remove extraneous asterisk from
 #define comments

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@intel.com/
> Fixes: 88f42ac48b8968 ("firmware: stratix10-svc: Add support for FCS")
> Reported-by: kernel test robot <lkp@...el.com>
> Cc: Ang Tien Sung <tien.sung.ang@...el.com>
> Cc: Richard Gong <richard.gong@...el.com>
> Cc: Dinh Nguyen <dinguyen@...nel.org>
> Cc: linux-kernel@...r.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>

Acked-by: Randy Dunlap <rdunlap@...raded.org>

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