From: Arnav Kapoor <kapoorarnav43@gmail.com>
To: Jean-Baptiste Maneyrol <jean-baptiste.maneyrol@tdk.com>,
Jonathan Cameron <jic23@kernel.org>
Cc: "David Lechner" <dlechner@baylibre.com>,
"Nuno Sá" <nuno.sa@analog.com>,
"Andy Shevchenko" <andy@kernel.org>,
"Andy Shevchenko" <andriy.shevchenko@intel.com>,
"Sean Nyekjaer" <sean@geanix.com>,
linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org,
"Arnav Kapoor" <kapoorarnav43@gmail.com>
Subject: [PATCH v2 2/2] iio: imu: inv_icm42600: fix kernel-doc Return: sections
Date: Tue, 6 Oct 2026 10:24:04 +0530 [thread overview]
Message-ID: <20261006045413.14320-3-kapoorarnav43@gmail.com> (raw)
In-Reply-To: <20261006045413.14320-1-kapoorarnav43@gmail.com>
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
next prev parent reply other threads:[~2026-10-06 4:54 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-06 4:54 [PATCH v2 0/2] iio: imu: inv_icm42600: fix kernel-doc warnings Arnav Kapoor
2026-10-06 4:54 ` [PATCH v2 1/2] iio: imu: inv_icm42600: drop stale vdd_supply kernel-doc Arnav Kapoor
2026-10-06 4:54 ` Arnav Kapoor [this message]
2026-10-06 6:46 ` [PATCH v2 2/2] iio: imu: inv_icm42600: fix kernel-doc Return: sections Joshua Crofts
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=20261006045413.14320-3-kapoorarnav43@gmail.com \
--to=kapoorarnav43@gmail.com \
--cc=andriy.shevchenko@intel.com \
--cc=andy@kernel.org \
--cc=dlechner@baylibre.com \
--cc=jean-baptiste.maneyrol@tdk.com \
--cc=jic23@kernel.org \
--cc=linux-iio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=nuno.sa@analog.com \
--cc=sean@geanix.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
all inboxes | Powered by JetHome®