iio: fix kernel-doc warnings in industrialio-backend.c

[PATCH v2] iio: fix kernel-doc warnings in industrialio-backend.c

Posted by KRIISHSHARMA 3 months, 1 week ago

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

Fix multiple kernel-doc warnings in drivers/iio/industrialio-backend.c,
including a missing description for the @chan parameter in
iio_backend_oversampling_ratio_set() and a missing return value
description in iio_backend_get_priv().

This addresses the warnings reported by kernel-doc and 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
Suggested-by: Andy Shevchenko <andy@kernel.org>
Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
---

v2:
- Fixed another kernel-doc warning.

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

 drivers/iio/industrialio-backend.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/iio/industrialio-backend.c b/drivers/iio/industrialio-backend.c
index 23760652a046..73704cc1bd03 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:
@@ -1064,6 +1065,9 @@ EXPORT_SYMBOL_NS_GPL(__devm_iio_backend_get_from_fwnode_lookup, "IIO_BACKEND");
 /**
  * iio_backend_get_priv - Get driver private data
  * @back: Backend device
+ *
+ * RETURNS:
+ * Pointer to the driver private data associated with the backend.
  */
 void *iio_backend_get_priv(const struct iio_backend *back)
 {
-- 
2.34.1

Re: [PATCH v2] iio: fix kernel-doc warnings in industrialio-backend.c

Posted by David Lechner 3 months, 1 week ago

On 10/27/25 4:21 AM, KRIISHSHARMA wrote:
> From: Kriish Sharma <kriish.sharma2006@gmail.com>
> 
> Fix multiple kernel-doc warnings in drivers/iio/industrialio-backend.c,
> including a missing description for the @chan parameter in
> iio_backend_oversampling_ratio_set() and a missing return value
> description in iio_backend_get_priv().
> 
> This addresses the warnings reported by kernel-doc and 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
> Suggested-by: Andy Shevchenko <andy@kernel.org>
> Signed-off-by: Kriish Sharma <kriish.sharma2006@gmail.com>
> ---
> 
> v2:
> - Fixed another kernel-doc warning.
> 
> v1: https://lore.kernel.org/all/20251025102008.253566-1-kriish.sharma2006@gmail.com
> 
>  drivers/iio/industrialio-backend.c | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/iio/industrialio-backend.c b/drivers/iio/industrialio-backend.c
> index 23760652a046..73704cc1bd03 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:

I guess it would not hurt to change this to RETURNS: to match the
rest of the file either.

> @@ -1064,6 +1065,9 @@ EXPORT_SYMBOL_NS_GPL(__devm_iio_backend_get_from_fwnode_lookup, "IIO_BACKEND");
>  /**
>   * iio_backend_get_priv - Get driver private data
>   * @back: Backend device
> + *
> + * RETURNS:
> + * Pointer to the driver private data associated with the backend.
>   */
>  void *iio_backend_get_priv(const struct iio_backend *back)
>  {

Re: [PATCH v2] iio: fix kernel-doc warnings in industrialio-backend.c

Posted by Andy Shevchenko 3 months, 1 week ago

On Mon, Oct 27, 2025 at 10:35:02AM -0500, David Lechner wrote:
> On 10/27/25 4:21 AM, KRIISHSHARMA wrote:

...

> >   * 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:
> 
> I guess it would not hurt to change this to RETURNS: to match the
> rest of the file either.

Good catch! KRIISHSHARMA, please check the whole file for this as it's not a
direct mistake from kernel-doc perspective, there is a mistake from consistency
point of view and hence needs to be addressed.

...

> > + * RETURNS:
> > + * Pointer to the driver private data associated with the backend.

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v2] iio: fix kernel-doc warnings in industrialio-backend.c

Posted by Kriish Sharma 3 months, 1 week ago

Hi Andy, David,

Thank you both for the reviews and helpful suggestions!
I've sent v3 now, which includes the consistency fixes (changing
Return: to RETURNS: across the file) and the other points you
mentioned.

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

Appreciate your time and feedback.

Best regards,
Kriish


On Tue, Oct 28, 2025 at 2:39 PM Andy Shevchenko
<andriy.shevchenko@intel.com> wrote:
>
> On Mon, Oct 27, 2025 at 10:35:02AM -0500, David Lechner wrote:
> > On 10/27/25 4:21 AM, KRIISHSHARMA wrote:
>
> ...
>
> > >   * 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:
> >
> > I guess it would not hurt to change this to RETURNS: to match the
> > rest of the file either.
>
> Good catch! KRIISHSHARMA, please check the whole file for this as it's not a
> direct mistake from kernel-doc perspective, there is a mistake from consistency
> point of view and hence needs to be addressed.
>
> ...
>
> > > + * RETURNS:
> > > + * Pointer to the driver private data associated with the backend.
>
> --
> With Best Regards,
> Andy Shevchenko
>
>

Re: [PATCH v2] iio: fix kernel-doc warnings in industrialio-backend.c

Posted by Andy Shevchenko 3 months, 1 week ago

On Mon, Oct 27, 2025 at 09:21:59AM +0000, KRIISHSHARMA wrote:
> 
> Fix multiple kernel-doc warnings in drivers/iio/industrialio-backend.c,
> including a missing description for the @chan parameter in
> iio_backend_oversampling_ratio_set() and a missing return value
> description in iio_backend_get_priv().
> 
> This addresses the warnings reported by kernel-doc and the kernel test
> robot.

Reviewed-by: Andy Shevchenko <andy@kernel.org>

Subject should be rather

iio: backend: fix kernel-doc to avoid warnings

But no need to resend, until Jonathan requests this. I hope he can massage
the commit message whilst applying.

-- 
With Best Regards,
Andy Shevchenko