[PATCH 0/2] iio: fix kernel-doc warnings in public headers

[PATCH 0/2] iio: fix kernel-doc warnings in public headers

[Oscar Alejandro Sánchez Lucero]

Fix two kernel-doc warnings in public IIO headers:
- Rename @consumer_channel to @name in fwnode_iio_channel_get_by_name().
- Replace repeated 'NOTE:' labels in struct iio_itime_sel_mul to avoid
  a duplicate section name warning.

Tested with ./scripts/kernel-doc, ./scripts/checkpatch.pl --strict, and
W=1 builds of drivers/iio/inkern.o and drivers/iio/industrialio-gts-helper.o.

Signed-off-by: Oscar Alejandro Sánchez Lucero <aleszlucero@gmail.com>
---
Oscar Alejandro Sánchez Lucero (2):
      iio: consumers: fix kernel-doc parameter name in fwnode_iio_channel_get_by_name()
      iio: gts-helper: fix duplicate NOTE section in struct iio_itime_sel_mul

 include/linux/iio/consumer.h       | 2 +-
 include/linux/iio/iio-gts-helper.h | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)
---
base-commit: 9d66f26fefacebfeed15de31c1123451a17ff119
change-id: 20261112-iio-kernel-doc-80cb46e21fb6

Best regards,
-- 
Oscar Alejandro Sánchez Lucero <aleszlucero@gmail.com>

[PATCH 1/2] iio: consumers: fix kernel-doc parameter name in fwnode_iio_channel_get_by_name()

[Oscar Alejandro Sánchez Lucero]

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

[PATCH 2/2] iio: gts-helper: fix duplicate NOTE section in struct iio_itime_sel_mul

[Oscar Alejandro Sánchez Lucero]

Replace the repeated 'NOTE:' prefixes in struct iio_itime_sel_mul
kernel-doc comments with plain sentences to avoid the duplicate section
name warning.

Verified with ./scripts/kernel-doc, checkpatch.pl --strict, and a W=1
build of drivers/iio/industrialio-gts-helper.o.

Signed-off-by: Oscar Alejandro Sánchez Lucero <aleszlucero@gmail.com>
---
 include/linux/iio/iio-gts-helper.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/iio/iio-gts-helper.h b/include/linux/iio/iio-gts-helper.h
index 0c4b2e9fbe1e..3f07a46ddff2 100644
--- a/include/linux/iio/iio-gts-helper.h
+++ b/include/linux/iio/iio-gts-helper.h
@@ -47,9 +47,9 @@ struct iio_gain_sel_pair {
  * @time_us:	Integration time in microseconds. Time values must be positive,
  *		negative values are reserved for error handling.
  * @sel:	Selector (usually register value) used to indicate this time
- *		NOTE: Only selectors >= 0 supported.
+ *		Note that only selectors >= 0 are supported.
  * @mul:	Multiplication to the values caused by this time.
- *		NOTE: Only multipliers > 0 supported.
+ *		Note that only multipliers > 0 are supported.
  */
 struct iio_itime_sel_mul {
 	int time_us;

-- 
2.56.0

Re: [PATCH 0/2] iio: fix kernel-doc warnings in public headers

[Arnav Kapoor]

On Thu, Nov 12, 2026 at 11:25:31PM -0600, Oscar Alejandro Sánchez Lucero wrote:
> Fix two kernel-doc warnings in public IIO headers:
> - Rename @consumer_channel to @name in fwnode_iio_channel_get_by_name().
> - Replace repeated 'NOTE:' labels in struct iio_itime_sel_mul to avoid
>   a duplicate section name warning.

Reviewed-by: Arnav Kapoor <kapoorarnav43@gmail.com>

Re: [PATCH 2/2] iio: gts-helper: fix duplicate NOTE section in struct iio_itime_sel_mul

[Matti Vaittinen]

On 13/11/2026 07:25, Oscar Alejandro Sánchez Lucero wrote:
> Replace the repeated 'NOTE:' prefixes in struct iio_itime_sel_mul
> kernel-doc comments with plain sentences to avoid the duplicate section
> name warning.
> 
> Verified with ./scripts/kernel-doc, checkpatch.pl --strict, and a W=1
> build of drivers/iio/industrialio-gts-helper.o.
> 
> Signed-off-by: Oscar Alejandro Sánchez Lucero <aleszlucero@gmail.com>
> ---
>   include/linux/iio/iio-gts-helper.h | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/iio/iio-gts-helper.h b/include/linux/iio/iio-gts-helper.h
> index 0c4b2e9fbe1e..3f07a46ddff2 100644
> --- a/include/linux/iio/iio-gts-helper.h
> +++ b/include/linux/iio/iio-gts-helper.h
> @@ -47,9 +47,9 @@ struct iio_gain_sel_pair {
>    * @time_us:	Integration time in microseconds. Time values must be positive,
>    *		negative values are reserved for error handling.
>    * @sel:	Selector (usually register value) used to indicate this time
> - *		NOTE: Only selectors >= 0 supported.
> + *		Note that only selectors >= 0 are supported.
>    * @mul:	Multiplication to the values caused by this time.
> - *		NOTE: Only multipliers > 0 supported.
> + *		Note that only multipliers > 0 are supported.
>    */
>   struct iio_itime_sel_mul {
>   	int time_us;
> 

I am unsure the "Note that..." serves any real value. Might as well be 
short and concise:
"NOTE: Only multipliers > 0 supported." => "Only multipliers > 0 supported."

Well, "Note that only multipliers > 0 are supported." isn't much longer 
so it works well enough for me unless you respin this for some other reason.

Thanks for the fix!

Yours,
	-- Matti

-- 
Matti Vaittinen
Linux kernel developer at ROHM Semiconductors
Oulu Finland

~~ When things go utterly wrong vim users can always type :help! ~~