linux-kernel - [PATCH 2/3] firmware: stratix-svc: fix make htmldocs warning

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: <20251114185815.358423-2-dinguyen@kernel.org>
Date: Fri, 14 Nov 2025 12:58:14 -0600
From: Dinh Nguyen <dinguyen@...nel.org>
To: linux-kernel@...r.kernel.org
Cc: dinguyen@...nel.org,
	gregkh@...uxfoundation.org,
	arnd@...db.de,
	Stephen Rothwell <sfr@...b.auug.org.au>
Subject: [PATCH 2/3] firmware: stratix-svc: fix make htmldocs warning

Stephen Rothwell reports htmldocs warnings when merging char-misc tree:

WARNING: drivers/firmware/stratix10-svc.c:58 This comment starts with '/**',
but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * Total number of transaction IDs, which is a combination of

WARNING: drivers/firmware/stratix10-svc.c:302 This comment starts with '/**',
but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * svc_mem_lock protects access to the svc_data_mem list for

Fixes: bcb9f4f07061 ("firmware: stratix10-svc: Add support for async communication")
Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251114153347.16001109@canb.auug.org.au/
Signed-off-by: Dinh Nguyen <dinguyen@...nel.org>
---
 drivers/firmware/stratix10-svc.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/firmware/stratix10-svc.c b/drivers/firmware/stratix10-svc.c
index ebf3a591efc6..515b948ff320 100644
--- a/drivers/firmware/stratix10-svc.c
+++ b/drivers/firmware/stratix10-svc.c
@@ -55,7 +55,7 @@
 #define MAX_SDM_JOB_IDS				16
 /* Number of bits used for asynchronous transaction hashing. */
 #define ASYNC_TRX_HASH_BITS			3
-/**
+/*
  * Total number of transaction IDs, which is a combination of
  * client ID and job ID.
  */
@@ -300,7 +300,7 @@ struct stratix10_svc_chan {
 static LIST_HEAD(svc_ctrl);
 static LIST_HEAD(svc_data_mem);
 
-/**
+/*
  * svc_mem_lock protects access to the svc_data_mem list for
  * concurrent multi-client operations
  */
-- 
2.42.0.411.g813d9a9188