public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Dinh Nguyen <dinguyen@kernel.org>
To: linux-kernel@vger.kernel.org
Cc: dinguyen@kernel.org, gregkh@linuxfoundation.org, arnd@arndb.de,
	Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH 2/3] firmware: stratix-svc: fix make htmldocs warning
Date: Fri, 14 Nov 2025 12:58:14 -0600	[thread overview]
Message-ID: <20251114185815.358423-2-dinguyen@kernel.org> (raw)
In-Reply-To: <20251114185815.358423-1-dinguyen@kernel.org>

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>
---
 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


  reply	other threads:[~2025-11-14 18:58 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-14 18:58 [PATCHv2 1/3] firmware: stratix10-svc: fix make htmldocs warning Dinh Nguyen
2025-11-14 18:58 ` Dinh Nguyen [this message]
2025-11-14 18:58 ` [PATCH 3/3] " Dinh Nguyen
2025-11-24 16:49   ` Greg KH

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=20251114185815.358423-2-dinguyen@kernel.org \
    --to=dinguyen@kernel.org \
    --cc=arnd@arndb.de \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sfr@canb.auug.org.au \
    /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