linux-kernel - [PATCH] iio: backend: document @chan in iio_backend_oversampling_ratio

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20251029075117.104758-1-hsukrut3@gmail.com>
Date: Wed, 29 Oct 2025 13:21:16 +0530
From: Sukrut Heroorkar <hsukrut3@...il.com>
To: Nuno Sa <nuno.sa@...log.com>,
	Olivier Moysan <olivier.moysan@...s.st.com>,
	Jonathan Cameron <jic23@...nel.org>,
	David Lechner <dlechner@...libre.com>,
	Andy Shevchenko <andy@...nel.org>,
	Pop Ioan Daniel <pop.ioan-daniel@...log.com>,
	linux-iio@...r.kernel.org (open list:IIO BACKEND FRAMEWORK),
	linux-kernel@...r.kernel.org (open list)
Cc: shuah@...nel.org,
	david.hunter.linux@...il.com,
	Sukrut Heroorkar <hsukrut3@...il.com>
Subject: [PATCH] iio: backend: document @chan in iio_backend_oversampling_ratio_set kernel-doc comment

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@...il.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