From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
James Clark <james.clark@arm.com>,
Tao Zhang <quic_taozha@quicinc.com>,
Suzuki K Poulose <suzuki.poulose@arm.com>,
coresight@lists.linaro.org, Danilo Krummrich <dakr@kernel.org>,
Mike Leach <mike.leach@arm.com>, Leo Yan <leo.yan@arm.com>,
linux-arm-kernel@lists.infradead.org
Subject: [PATCH v3] coresight: coresight.h: add '*' to kernel-doc lines
Date: Sun, 19 Jul 2026 15:24:56 -0700 [thread overview]
Message-ID: <20260719222456.2831456-1-rdunlap@infradead.org> (raw)
kernel-doc reports 2 (kernel-doc) lines in coresight.h that don't have
a beginning '*' in them, so fix these lines.
Also convert struct coresight_trace_id_map to kernel-doc format to
remove another warning.
Warning: include/linux/coresight.h:173 bad line:
connected to @src_port. NULL until the device is created
Warning: include/linux/coresight.h:177 bad line:
needs to be filtered.
Warning: include/linux/coresight.h:236 This comment starts with '/**',
but isn't a kernel-doc comment.
Fixes: ec9903d6cc34 ("coresight: Add support for trace filtering by source")
Fixes: d49c9cf15f89 ("coresight: Rename connection members to make the direction explicit")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
v2: rebase & resend
v3: rebase & resend
Cc: James Clark <james.clark@arm.com>
Cc: Tao Zhang <quic_taozha@quicinc.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: coresight@lists.linaro.org
Cc: Danilo Krummrich <dakr@kernel.org>
Cc: Mike Leach <mike.leach@arm.com>
Cc: Leo Yan <leo.yan@arm.com>
Cc: linux-arm-kernel@lists.infradead.org
---
include/linux/coresight.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
--- linux-next-20260717.orig/include/linux/coresight.h
+++ linux-next-20260717/include/linux/coresight.h
@@ -177,11 +177,11 @@ struct coresight_desc {
* @dest_port: destination's input port number @src_port is connected to.
* @dest_fwnode: destination component's fwnode handle.
* @dest_dev: a @coresight_device representation of the component
- connected to @src_port. NULL until the device is created
+ * connected to @src_port. NULL until the device is created
* @link: Representation of the connection as a sysfs link.
* @filter_src_fwnode: filter source component's fwnode handle.
* @filter_src_dev: a @coresight_device representation of the component that
- needs to be filtered.
+ * needs to be filtered.
*
* The full connection structure looks like this, where in_conns store
* references to same connection as the source device's out_conns.
@@ -234,7 +234,7 @@ struct coresight_sysfs_link {
#define CORESIGHT_TRACE_IDS_MAX 128
/**
- * Trace ID map.
+ * struct coresight_trace_id_map - Trace ID map.
*
* @used_ids: Bitmap to register available (bit = 0) and in use (bit = 1) IDs.
* Initialised so that the reserved IDs are permanently marked as
next reply other threads:[~2026-07-19 22:25 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-19 22:24 Randy Dunlap [this message]
2026-07-28 0:28 ` [PATCH v3] coresight: coresight.h: add '*' to kernel-doc lines Randy Dunlap
2026-07-28 5:31 ` Anshuman Khandual
2026-07-28 17:04 ` Randy Dunlap
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=20260719222456.2831456-1-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=coresight@lists.linaro.org \
--cc=dakr@kernel.org \
--cc=james.clark@arm.com \
--cc=leo.yan@arm.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mike.leach@arm.com \
--cc=quic_taozha@quicinc.com \
--cc=suzuki.poulose@arm.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