From: Matti Vaittinen <mazziesaccount@gmail.com>
To: "Oscar Alejandro Sánchez Lucero" <aleszlucero@gmail.com>,
"Jonathan Cameron" <jic23@kernel.org>,
"David Lechner" <dlechner@baylibre.com>,
"Nuno Sá" <nuno.sa@analog.com>,
"Andy Shevchenko" <andy@kernel.org>
Cc: linux-iio@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 2/2] iio: gts-helper: fix duplicate NOTE section in struct iio_itime_sel_mul
Date: Fri, 13 Nov 2026 10:37:00 +0200 [thread overview]
Message-ID: <d12ee272-8dc3-46f2-997a-5de019ed6baa@gmail.com> (raw)
In-Reply-To: <20261112-iio-kernel-doc-v1-2-e382fc9a47c2@gmail.com>
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! ~~
next prev parent reply other threads:[~2026-11-13 8:37 UTC|newest]
Thread overview: 5+ 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 ` [PATCH 1/2] iio: consumers: fix kernel-doc parameter name in fwnode_iio_channel_get_by_name() Oscar Alejandro Sánchez Lucero
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
2026-11-13 8:37 ` Matti Vaittinen [this message]
2026-11-13 8:17 ` [PATCH 0/2] iio: fix kernel-doc warnings in public headers Arnav Kapoor
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=d12ee272-8dc3-46f2-997a-5de019ed6baa@gmail.com \
--to=mazziesaccount@gmail.com \
--cc=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=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.