From: "Oscar Alejandro Sánchez Lucero" <aleszlucero@gmail.com>
To: "Jonathan Cameron" <jic23@kernel.org>,
"David Lechner" <dlechner@baylibre.com>,
"Nuno Sá" <nuno.sa@analog.com>,
"Andy Shevchenko" <andy@kernel.org>,
"Matti Vaittinen" <mazziesaccount@gmail.com>
Cc: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
"Oscar Alejandro Sánchez Lucero" <aleszlucero@gmail.com>
Subject: [PATCH 1/2] iio: consumers: fix kernel-doc parameter name in fwnode_iio_channel_get_by_name()
Date: Thu, 12 Nov 2026 23:25:32 -0600 [thread overview]
Message-ID: <20261112-iio-kernel-doc-v1-1-e382fc9a47c2@gmail.com> (raw)
In-Reply-To: <20261112-iio-kernel-doc-v1-0-e382fc9a47c2@gmail.com>
Rename @consumer_channel to @name in the kernel-doc comment of
fwnode_iio_channel_get_by_name() to match the function signature.
Verified with ./scripts/kernel-doc, checkpatch.pl --strict, and a W=1
build of drivers/iio/inkern.o.
Signed-off-by: Oscar Alejandro Sánchez Lucero <aleszlucero@gmail.com>
---
include/linux/iio/consumer.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/iio/consumer.h b/include/linux/iio/consumer.h
index 5039558267e4..b9593d24950c 100644
--- a/include/linux/iio/consumer.h
+++ b/include/linux/iio/consumer.h
@@ -101,7 +101,7 @@ struct iio_channel *devm_iio_channel_get_all(struct device *dev);
/**
* fwnode_iio_channel_get_by_name() - get description of all that is needed to access channel.
* @fwnode: Pointer to consumer Firmware node
- * @consumer_channel: Unique name to identify the channel on the consumer
+ * @name: Unique name to identify the channel on the consumer
* side. This typically describes the channels use within
* the consumer. E.g. 'battery_voltage'
*/
--
2.56.0
next prev parent reply other threads:[~2026-11-13 5:25 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-13 5:25 [PATCH 0/2] iio: fix kernel-doc warnings in public headers Oscar Alejandro Sánchez Lucero
2026-11-13 5:25 ` Oscar Alejandro Sánchez Lucero [this message]
2026-11-13 5:25 ` [PATCH 2/2] iio: gts-helper: fix duplicate NOTE section in struct iio_itime_sel_mul Oscar Alejandro Sánchez Lucero
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=20261112-iio-kernel-doc-v1-1-e382fc9a47c2@gmail.com \
--to=aleszlucero@gmail.com \
--cc=andy@kernel.org \
--cc=dlechner@baylibre.com \
--cc=jic23@kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mazziesaccount@gmail.com \
--cc=nuno.sa@analog.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.