[PATCH v2 0/2] iio: imu: inv_icm42600: fix kernel-doc warnings

[PATCH v2 0/2] iio: imu: inv_icm42600: fix kernel-doc warnings

[Arnav Kapoor]

Fix the kernel-doc warnings in the inv_icm42600 driver. With this series,
scripts/kernel-doc -Wall reports no warnings for
drivers/iio/imu/inv_icm42600/. Comment-only changes.

Changes in v2:
- Add patch 2 for the remaining kernel-doc -Wall warnings in the
  driver (Andy)
- Collect Andy's Reviewed-by on patch 1
- Use the Assisted-by format from coding-assistants.rst (Andy)

v1: https://lore.kernel.org/all/20261003055339.143977-1-kapoorarnav43@gmail.com/

Arnav Kapoor (2):
  iio: imu: inv_icm42600: drop stale vdd_supply kernel-doc
  iio: imu: inv_icm42600: fix kernel-doc Return: sections

 drivers/iio/imu/inv_icm42600/inv_icm42600.h        | 1 -
 drivers/iio/imu/inv_icm42600/inv_icm42600_buffer.c | 4 ++--
 drivers/iio/imu/inv_icm42600/inv_icm42600_core.c   | 4 ++--
 3 files changed, 4 insertions(+), 5 deletions(-)

-- 
2.53.0

[PATCH v2 1/2] iio: imu: inv_icm42600: drop stale vdd_supply kernel-doc

[Arnav Kapoor]

The vdd_supply member was removed from struct inv_icm42600_state when
the driver switched to devm_regulator_get_enable() for the VDD
regulator, but its kernel-doc entry was left behind. This triggers a
W=1 warning:

  Warning: drivers/iio/imu/inv_icm42600/inv_icm42600.h:186 Excess struct
  member 'vdd_supply' description in 'inv_icm42600_state'

Drop the stale line.

Fixes: 9fd569aa3d70 ("iio: imu: inv_icm42600: Use devm_regulator_get_enable() for vdd regulator")
Reviewed-by: Andy Shevchenko <andriy.shevchenko@intel.com>
Assisted-by: LLM
Signed-off-by: Arnav Kapoor <kapoorarnav43@gmail.com>
---
 drivers/iio/imu/inv_icm42600/inv_icm42600.h | 1 -
 1 file changed, 1 deletion(-)

diff --git a/drivers/iio/imu/inv_icm42600/inv_icm42600.h b/drivers/iio/imu/inv_icm42600/inv_icm42600.h
index e56943931b6a..3737e79dbcc1 100644
--- a/drivers/iio/imu/inv_icm42600/inv_icm42600.h
+++ b/drivers/iio/imu/inv_icm42600/inv_icm42600.h
@@ -151,7 +151,6 @@ struct inv_icm42600_apex {
  *  @chip:		chip identifier.
  *  @name:		chip name.
  *  @map:		regmap pointer.
- *  @vdd_supply:	VDD voltage regulator for the chip.
  *  @vddio_supply:	I/O voltage regulator for the chip.
  *  @irq:		chip irq, required to enable/disable and set wakeup
  *  @orientation:	sensor chip orientation relative to main hardware.
-- 
2.53.0

[PATCH v2 2/2] iio: imu: inv_icm42600: fix kernel-doc Return: sections

[Arnav Kapoor]

kernel-doc expects the return value to be described in a "Return:"
section. inv_icm42600_buffer_update_watermark(), inv_icm42600_setup()
and inv_icm42600_irq_init() use "Returns ..." in the body instead,
so scripts/kernel-doc -Wall warns for each of them, e.g.:

  Warning: .../inv_icm42600_core.c:511 No description found for
  return value of 'inv_icm42600_setup'

Convert them to "Return:" sections. In the watermark comment, move it
after the description, so the description is not parsed as part of the
return value section.

Assisted-by: LLM
Signed-off-by: Arnav Kapoor <kapoorarnav43@gmail.com>
---
 drivers/iio/imu/inv_icm42600/inv_icm42600_buffer.c | 4 ++--
 drivers/iio/imu/inv_icm42600/inv_icm42600_core.c   | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/iio/imu/inv_icm42600/inv_icm42600_buffer.c b/drivers/iio/imu/inv_icm42600/inv_icm42600_buffer.c
index 2bf9fc29d7d2..7ecd7257921c 100644
--- a/drivers/iio/imu/inv_icm42600/inv_icm42600_buffer.c
+++ b/drivers/iio/imu/inv_icm42600/inv_icm42600_buffer.c
@@ -172,8 +172,6 @@ static unsigned int inv_icm42600_wm_truncate(unsigned int watermark,
  * inv_icm42600_buffer_update_watermark - update watermark FIFO threshold
  * @st:	driver internal state
  *
- * Returns 0 on success, a negative error code otherwise.
- *
  * FIFO watermark threshold is computed based on the required watermark values
  * set for gyro and accel sensors. Since watermark is all about acceptable data
  * latency, we should need to use the smallest latency value. But it is not as
@@ -188,6 +186,8 @@ static unsigned int inv_icm42600_wm_truncate(unsigned int watermark,
  *    dividing this computed latency by the smallest period, which corresponds
  *    to the FIFO frequency. Beware that this is only true because we are not
  *    using 500Hz frequency which is not a multiple of the others.
+ *
+ * Return: 0 on success, a negative error code otherwise.
  */
 int inv_icm42600_buffer_update_watermark(struct inv_icm42600_state *st)
 {
diff --git a/drivers/iio/imu/inv_icm42600/inv_icm42600_core.c b/drivers/iio/imu/inv_icm42600/inv_icm42600_core.c
index cd2e53416f5b..ccaf8ec468f9 100644
--- a/drivers/iio/imu/inv_icm42600/inv_icm42600_core.c
+++ b/drivers/iio/imu/inv_icm42600/inv_icm42600_core.c
@@ -505,7 +505,7 @@ static int inv_icm42600_set_conf(struct inv_icm42600_state *st,
  *  @st:	driver internal state
  *  @bus_setup:	callback for setting up bus specific registers
  *
- *  Returns 0 on success, a negative error code otherwise.
+ *  Return: 0 on success, a negative error code otherwise.
  */
 static int inv_icm42600_setup(struct inv_icm42600_state *st,
 			      inv_icm42600_bus_setup bus_setup)
@@ -639,7 +639,7 @@ static irqreturn_t inv_icm42600_irq_handler(int irq, void *_data)
  * @irq_type:	irq trigger type
  * @open_drain:	true if irq is open drain, false for push-pull
  *
- * Returns 0 on success, a negative error code otherwise.
+ * Return: 0 on success, a negative error code otherwise.
  */
 static int inv_icm42600_irq_init(struct inv_icm42600_state *st, int irq,
 				 int irq_type, bool open_drain)
-- 
2.53.0

Re: [PATCH v2 2/2] iio: imu: inv_icm42600: fix kernel-doc Return: sections

[Joshua Crofts]

On Tue,  6 Oct 2026 10:24:04 +0530
Arnav Kapoor <kapoorarnav43@gmail.com> wrote:

> kernel-doc expects the return value to be described in a "Return:"
> section. inv_icm42600_buffer_update_watermark(), inv_icm42600_setup()
> and inv_icm42600_irq_init() use "Returns ..." in the body instead,
> so scripts/kernel-doc -Wall warns for each of them, e.g.:
> 
>   Warning: .../inv_icm42600_core.c:511 No description found for
>   return value of 'inv_icm42600_setup'
> 
> Convert them to "Return:" sections. In the watermark comment, move it
> after the description, so the description is not parsed as part of the
> return value section.
> 
> Assisted-by: LLM
> Signed-off-by: Arnav Kapoor <kapoorarnav43@gmail.com>
> ---

Reviewed-by: Joshua Crofts <joshua.crofts1@gmail.com>

-- 
Kind regards,
Joshua Crofts