From: Randy Dunlap <rdunlap@infradead.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>, linux-doc@vger.kernel.org
Cc: kernel test robot <lkp@intel.com>,
Ang Tien Sung <tien.sung.ang@intel.com>,
Richard Gong <richard.gong@intel.com>,
Dinh Nguyen <dinguyen@kernel.org>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH] firmware: stratix10-svc: remove extraneous asterisk from #define comments
Date: Sat, 11 Jun 2022 18:31:40 -0700 [thread overview]
Message-ID: <967fa124-5ebc-6b0d-fa1a-27619eb01b8c@infradead.org> (raw)
In-Reply-To: <20220612012253.16583-1-bagasdotme@gmail.com>
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@intel.com>
> Cc: Ang Tien Sung <tien.sung.ang@intel.com>
> Cc: Richard Gong <richard.gong@intel.com>
> Cc: Dinh Nguyen <dinguyen@kernel.org>
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infraded.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
next prev parent reply other threads:[~2022-06-12 1:32 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-11 20:30 [dinguyen:svc_driver_updates_for_v4.20 1/6] htmldocs: 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 kernel test robot
2022-06-12 1:22 ` [PATCH] firmware: stratix10-svc: remove extraneous asterisk from #define comments Bagas Sanjaya
2022-06-12 1:31 ` Randy Dunlap [this message]
2022-06-13 14:24 ` Dinh Nguyen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=967fa124-5ebc-6b0d-fa1a-27619eb01b8c@infradead.org \
--to=rdunlap@infradead.org \
--cc=bagasdotme@gmail.com \
--cc=dinguyen@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lkp@intel.com \
--cc=richard.gong@intel.com \
--cc=tien.sung.ang@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).