]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
firmware: stratix-svc: fix make htmldocs warning
authorDinh Nguyen <dinguyen@kernel.org>
Fri, 14 Nov 2025 18:58:14 +0000 (12:58 -0600)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Mon, 24 Nov 2025 16:49:12 +0000 (17:49 +0100)
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@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251114153347.16001109@canb.auug.org.au/
Signed-off-by: Dinh Nguyen <dinguyen@kernel.org>
Link: https://patch.msgid.link/20251114185815.358423-2-dinguyen@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
drivers/firmware/stratix10-svc.c

index 3acfa067c5dda5a1a2d8848a18e0627860395902..08ed1b40bcfc94717a846bb47a22a9ca7ce8d19b 100644 (file)
@@ -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.
  */
@@ -297,7 +297,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
  */