linux-kernel - Re: [PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section

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

Message-ID: <CAGXv+5EcHQ7E979fKPEci2qwXBnKPfVHc_aB02amUbdVB3KTxg@mail.gmail.com>
Date: Wed, 28 Aug 2024 15:53:03 +0800
From: Chen-Yu Tsai <wenst@...omium.org>
To: Matti Vaittinen <mazziesaccount@...il.com>
Cc: Mark Brown <broonie@...nel.org>, Liam Girdwood <lgirdwood@...il.com>, 
	linux-kernel@...r.kernel.org, linux-arm-kernel@...ts.infradead.org, 
	Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
Subject: Re: [PATCH 8/8] regulator: irq_helpers: Add missing "Return"
 kerneldoc section

On Wed, Aug 28, 2024 at 1:55 PM Matti Vaittinen
<mazziesaccount@...il.com> wrote:
>
> On 8/27/24 12:55, Chen-Yu Tsai wrote:
> > kernel-doc complains about missing "Return" section for the function
> > regulator_irq_map_event_simple().
> >
> > Add a "Return" section for it based on its behavior.
> >
> > Signed-off-by: Chen-Yu Tsai <wenst@...omium.org>
>
> Thank You for improving this! I appreciate it :)
>
> > ---
> >   drivers/regulator/irq_helpers.c | 4 ++++
> >   1 file changed, 4 insertions(+)
> >
> > diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
> > index 5ab1a0befe12..5803ef016b7d 100644
> > --- a/drivers/regulator/irq_helpers.c
> > +++ b/drivers/regulator/irq_helpers.c
> > @@ -414,6 +414,10 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
> >    * notification helperk. Exactly one rdev and exactly one error (in
>
> I just noticed (an existing) typo "helperk". I wonder if it was Ok to
> fix it while anyways changing the doc. It's not strictly speaking
> related to the return values though :)

Why not? Only the kerneldoc this function is touched. It looks like the
'k' belongs to the "callbac" on the previous line.

> >    * "common_errs"-field) can be given at IRQ helper registration for
> >    * regulator_irq_map_event_simple() to be viable.
> > + *
> > + * Return: 0
> > + *
> Anyways, I agree with Andy about not needing the blank line here - but

I disagree because of the formatting result. See my other reply.

> other than that:
>
> Reviewed-by: Matti Vaittinen <mazziesaccount@...il.com>
>
> > + * Actual regulator error and notification are passed back through @rid.
> >    */
> >   int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid,
> >                           unsigned long *dev_mask)
>
> --
> Matti Vaittinen
> Linux kernel developer at ROHM Semiconductors
> Oulu Finland
>
> ~~ When things go utterly wrong vim users can always type :help! ~~
>