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+5FSt=8yRBa0ZqVQs_27wTGDedJiLdhMfGzzSySQYXbctw@mail.gmail.com>
Date: Wed, 28 Aug 2024 15:50:55 +0800
From: Chen-Yu Tsai <wenst@...omium.org>
To: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
Cc: Mark Brown <broonie@...nel.org>, Liam Girdwood <lgirdwood@...il.com>, 
	linux-kernel@...r.kernel.org, linux-arm-kernel@...ts.infradead.org
Subject: Re: [PATCH 8/8] regulator: irq_helpers: Add missing "Return"
 kerneldoc section

On Tue, Aug 27, 2024 at 10:44 PM Andy Shevchenko
<andriy.shevchenko@...ux.intel.com> wrote:
>
> On Tue, Aug 27, 2024 at 05:55:48PM +0800, 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.
>
> ...
>
> > + * Return: 0
>
> "0."

Ack.

> > + *
>
> I don't think we need this blank line.

This actually changes the output. Without the blank line, they are treated
as the same paragraph. With the blank line, the next line is treated as
a separate paragraph, and put in the "Description" section.

Strictly speaking, the only return value is the 0 integer. The other
"return" values are output parameters that have been modified by the
function. I believe those should not be in the "Return" section.


ChenYu


> > + * Actual regulator error and notification are passed back through @rid.
>
> --
> With Best Regards,
> Andy Shevchenko
>
>