From: Kriish Sharma <kriish.sharma2006@gmail.com>

Add missing kernel-doc entry for the @chan parameter in
iio_backend_oversampling_ratio_set(), which removes the warning reported by
the kernel test robot.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202506292344.HLJbrrgR-lkp@intel.com
Signed-off-by: Kriish Sharma <kriish.sharma2006@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.34.1

On Sat, Oct 25, 2025 at 1:20 PM <kriish.sharma2006@gmail.com> wrote:
>
> Add missing kernel-doc entry for the @chan parameter in
> iio_backend_oversampling_ratio_set(), which removes the warning reported by
> the kernel test robot.

Is this the only issue with the kernel-doc? Can you run manually
scripts/kernel-doc against this file (with -Wall) and check, please?
The change itself is okay, FWIW,
Reviewed-by: Andy Shevchenko <andy@kernel.org>

-- 
With Best Regards,
Andy Shevchenko

On Sat, Oct 25, 2025 at 7:05 PM Andy Shevchenko
<andy.shevchenko@gmail.com> wrote:
> Is this the only issue with the kernel-doc? Can you run manually
> scripts/kernel-doc against this file (with -Wall) and check, please?
> The change itself is okay, FWIW,
> Reviewed-by: Andy Shevchenko <andy@kernel.org>

Hi Andy,

Thanks for the review!
Looks like I missed another warning in the latest linux-next:
Warning: drivers/iio/industrialio-backend.c:1069 No description found
for return value of 'iio_backend_get_priv'
I can send another patch to address this if you’d like.

Best regards,
Kriish

On Sat, Oct 25, 2025 at 5:12 PM Kriish Sharma
<kriish.sharma2006@gmail.com> wrote:
> On Sat, Oct 25, 2025 at 7:05 PM Andy Shevchenko
> <andy.shevchenko@gmail.com> wrote:
> > Is this the only issue with the kernel-doc? Can you run manually
> > scripts/kernel-doc against this file (with -Wall) and check, please?
> > The change itself is okay, FWIW,
> > Reviewed-by: Andy Shevchenko <andy@kernel.org>
>
> Thanks for the review!
> Looks like I missed another warning in the latest linux-next:
> Warning: drivers/iio/industrialio-backend.c:1069 No description found
> for return value of 'iio_backend_get_priv'
> I can send another patch to address this if you’d like.

You can combine in one patch, there are no strict objections for
fixing all (small) kernel-doc issues in one file at once.

-- 
With Best Regards,
Andy Shevchenko

Thanks, Andy
I've sent a v2 that combines both kernel-doc fixes into a single patch.

https://lore.kernel.org/all/20251027092159.918445-1-kriish.sharma2006@gmail.com/



On Mon, Oct 27, 2025 at 2:24 PM Andy Shevchenko
<andy.shevchenko@gmail.com> wrote:
>
> On Sat, Oct 25, 2025 at 5:12 PM Kriish Sharma
> <kriish.sharma2006@gmail.com> wrote:
> > On Sat, Oct 25, 2025 at 7:05 PM Andy Shevchenko
> > <andy.shevchenko@gmail.com> wrote:
> > > Is this the only issue with the kernel-doc? Can you run manually
> > > scripts/kernel-doc against this file (with -Wall) and check, please?
> > > The change itself is okay, FWIW,
> > > Reviewed-by: Andy Shevchenko <andy@kernel.org>
> >
> > Thanks for the review!
> > Looks like I missed another warning in the latest linux-next:
> > Warning: drivers/iio/industrialio-backend.c:1069 No description found
> > for return value of 'iio_backend_get_priv'
> > I can send another patch to address this if you’d like.
>
> You can combine in one patch, there are no strict objections for
> fixing all (small) kernel-doc issues in one file at once.
>
> --
> With Best Regards,
> Andy Shevchenko