linux-iio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Sukrut Heroorkar <hsukrut3@gmail.com>
To: Nuno Sa <nuno.sa@analog.com>,
	Olivier Moysan <olivier.moysan@foss.st.com>,
	Jonathan Cameron <jic23@kernel.org>,
	David Lechner <dlechner@baylibre.com>,
	Andy Shevchenko <andy@kernel.org>,
	Pop Ioan Daniel <pop.ioan-daniel@analog.com>,
	linux-iio@vger.kernel.org (open list:IIO BACKEND FRAMEWORK),
	linux-kernel@vger.kernel.org (open list)
Cc: shuah@kernel.org, david.hunter.linux@gmail.com,
	Sukrut Heroorkar <hsukrut3@gmail.com>
Subject: [PATCH] iio: backend: document @chan in iio_backend_oversampling_ratio_set kernel-doc comment
Date: Wed, 29 Oct 2025 13:21:16 +0530	[thread overview]
Message-ID: <20251029075117.104758-1-hsukrut3@gmail.com> (raw)

Buidling with W=1 reports:
Warning: drivers/iio/industrialio-backend.c:727 function parameter 'chan'
not described in 'iio_backend_oversampling_ratio_set'

The @chan parameter was added when iio_backend_oversampling_ratio_set() was
updated so the contexts could specify the channel, but the parameter was
never documented. Document @chan to silence this warning.

Fixes: 97e6882ed1a1 ("iio: backend: update iio_backend_oversampling_ratio_set")
Signed-off-by: Sukrut Heroorkar <hsukrut3@gmail.com>
---
 drivers/iio/industrialio-backend.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/iio/industrialio-backend.c b/drivers/iio/industrialio-backend.c
index 23760652a046..937f4ef38e1e 100644
--- a/drivers/iio/industrialio-backend.c
+++ b/drivers/iio/industrialio-backend.c
@@ -717,6 +717,7 @@ EXPORT_SYMBOL_NS_GPL(iio_backend_data_size_set, "IIO_BACKEND");
 /**
  * iio_backend_oversampling_ratio_set - set the oversampling ratio
  * @back: Backend device
+ * @chan: Channel number
  * @ratio: The oversampling ratio - value 1 corresponds to no oversampling.
  *
  * Return:
-- 
2.43.0


             reply	other threads:[~2025-10-29  7:51 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-29  7:51 Sukrut Heroorkar [this message]
2025-10-29  8:13 ` [PATCH] iio: backend: document @chan in iio_backend_oversampling_ratio_set kernel-doc comment Andy Shevchenko
2025-10-29 11:22   ` sukrut heroorkar

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=20251029075117.104758-1-hsukrut3@gmail.com \
    --to=hsukrut3@gmail.com \
    --cc=andy@kernel.org \
    --cc=david.hunter.linux@gmail.com \
    --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 \
    --cc=olivier.moysan@foss.st.com \
    --cc=pop.ioan-daniel@analog.com \
    --cc=shuah@kernel.org \
    /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;
as well as URLs for NNTP newsgroup(s).