* [PATCH] iio: backend: document @chan in iio_backend_oversampling_ratio_set kernel-doc comment
@ 2025-10-29 7:51 Sukrut Heroorkar
2025-10-29 8:13 ` Andy Shevchenko
0 siblings, 1 reply; 3+ messages in thread
From: Sukrut Heroorkar @ 2025-10-29 7:51 UTC (permalink / raw)
To: Nuno Sa, Olivier Moysan, Jonathan Cameron, David Lechner,
Andy Shevchenko, Pop Ioan Daniel, open list:IIO BACKEND FRAMEWORK,
open list
Cc: shuah, david.hunter.linux, Sukrut Heroorkar
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] iio: backend: document @chan in iio_backend_oversampling_ratio_set kernel-doc comment
2025-10-29 7:51 [PATCH] iio: backend: document @chan in iio_backend_oversampling_ratio_set kernel-doc comment Sukrut Heroorkar
@ 2025-10-29 8:13 ` Andy Shevchenko
2025-10-29 11:22 ` sukrut heroorkar
0 siblings, 1 reply; 3+ messages in thread
From: Andy Shevchenko @ 2025-10-29 8:13 UTC (permalink / raw)
To: Sukrut Heroorkar
Cc: Nuno Sa, Olivier Moysan, Jonathan Cameron, David Lechner,
Andy Shevchenko, Pop Ioan Daniel, open list:IIO BACKEND FRAMEWORK,
open list, shuah, david.hunter.linux
On Wed, Oct 29, 2025 at 01:21:16PM +0530, Sukrut Heroorkar wrote:
> 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.
There is already more comprehensive patch available:
https://lore.kernel.org/linux-iio/20251028093326.1087660-1-kriish.sharma2006@gmail.com/
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] iio: backend: document @chan in iio_backend_oversampling_ratio_set kernel-doc comment
2025-10-29 8:13 ` Andy Shevchenko
@ 2025-10-29 11:22 ` sukrut heroorkar
0 siblings, 0 replies; 3+ messages in thread
From: sukrut heroorkar @ 2025-10-29 11:22 UTC (permalink / raw)
To: Andy Shevchenko
Cc: Nuno Sa, Olivier Moysan, Jonathan Cameron, David Lechner,
Andy Shevchenko, Pop Ioan Daniel, open list:IIO BACKEND FRAMEWORK,
open list, shuah, david.hunter.linux
On Wed, Oct 29, 2025 at 1:43 PM Andy Shevchenko
<andriy.shevchenko@intel.com> wrote:
>
> On Wed, Oct 29, 2025 at 01:21:16PM +0530, Sukrut Heroorkar wrote:
> > 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.
>
> There is already more comprehensive patch available:
> https://lore.kernel.org/linux-iio/20251028093326.1087660-1-kriish.sharma2006@gmail.com/
Thanks for the update, Andy.
Regards,
Sukurt Heroorkar
>
> --
> With Best Regards,
> Andy Shevchenko
>
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2025-10-29 11:22 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-10-29 7:51 [PATCH] iio: backend: document @chan in iio_backend_oversampling_ratio_set kernel-doc comment Sukrut Heroorkar
2025-10-29 8:13 ` Andy Shevchenko
2025-10-29 11:22 ` sukrut heroorkar
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).