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

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-prev] [day] [month] [year] [list]

Message-ID: <CAL4kbROq0ko9RT0VENAUsk5j621U8LNkQKz7CxQNk7=C23p7aQ@mail.gmail.com>
Date: Tue, 28 Oct 2025 15:06:44 +0530
From: Kriish Sharma <kriish.sharma2006@...il.com>
To: Andy Shevchenko <andriy.shevchenko@...el.com>
Cc: David Lechner <dlechner@...libre.com>, nuno.sa@...log.com, olivier.moysan@...s.st.com, 
	jic23@...nel.org, andy@...nel.org, linux-iio@...r.kernel.org, 
	linux-kernel@...r.kernel.org, kernel test robot <lkp@...el.com>
Subject: Re: [PATCH v2] iio: fix kernel-doc warnings in industrialio-backend.c

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