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

[Matti Vaittinen]

ke 28. elok. 2024 klo 10.53 Chen-Yu Tsai (wenst@xxxxxxxxxxxx) kirjoitti:
>
> On Wed, Aug 28, 2024 at 1:55 PM Matti Vaittinen
> <mazziesaccount@xxxxxxxxx> 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@xxxxxxxxxxxx>
> >
> > 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.

Right. It'd be nice if you fixed the typo as well if you for some
reason re-spin this.

> > >    * "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.

Fair enough. The "errors" or "notifications" indeed don't tell if this
specific function has failed.
So, if you feel the @rid is not documented well enough, maybe add a note in the
respective parameter documentation instead of leaving it alone at the
bottom of the doc?

Well, I don't have a strong opinion on this so you can keep the RB tag
also with the blank line.

Yours,
  -- Matti