[PATCH] firmware: stratix10-svc: fix kernel-doc warning

Dinh Nguyen posted 1 patch 3 years, 9 months ago
include/linux/firmware/intel/stratix10-svc-client.h | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
[PATCH] firmware: stratix10-svc: fix kernel-doc warning
Posted by Dinh Nguyen 3 years, 9 months ago
include/linux/firmware/intel/stratix10-svc-client.h:55: warning: This comment
starts with '/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst
 * Flag bit for COMMAND_RECONFIG

Fixes: 4a4709d470e6 ("firmware: stratix10-svc: add new FCS commands")
Signed-off-by: Dinh Nguyen <dinguyen@kernel.org>
---
 include/linux/firmware/intel/stratix10-svc-client.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/include/linux/firmware/intel/stratix10-svc-client.h b/include/linux/firmware/intel/stratix10-svc-client.h
index a776a787ac75..0c16037fd08d 100644
--- a/include/linux/firmware/intel/stratix10-svc-client.h
+++ b/include/linux/firmware/intel/stratix10-svc-client.h
@@ -51,7 +51,8 @@
 #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:
-- 
2.25.1
Re: [PATCH] firmware: stratix10-svc: fix kernel-doc warning
Posted by Greg KH 3 years, 9 months ago
On Fri, Jul 15, 2022 at 10:03:49AM -0500, Dinh Nguyen wrote:
> include/linux/firmware/intel/stratix10-svc-client.h:55: warning: This comment
> starts with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
>  * Flag bit for COMMAND_RECONFIG
> 
> Fixes: 4a4709d470e6 ("firmware: stratix10-svc: add new FCS commands")
> Signed-off-by: Dinh Nguyen <dinguyen@kernel.org>
> ---
>  include/linux/firmware/intel/stratix10-svc-client.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)

You forgot the reported-by link :(

I'll go add it...