linux-kernel - Re: [PATCH v2 02/10] regulator: core: Fix regulator_is_supported

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: <CAGXv+5GBgWqz2_WaSLdQzd6dzK-vSHyMYPpQRWzCj7vt3u8EoQ@mail.gmail.com>
Date: Fri, 30 Aug 2024 07:59:15 +0900
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 v2 02/10] regulator: core: Fix regulator_is_supported_voltage()
 kerneldoc return value

On Thu, Aug 29, 2024 at 9:46 PM Andy Shevchenko
<andriy.shevchenko@...ux.intel.com> wrote:
>
> On Thu, Aug 29, 2024 at 04:51:22PM +0800, Chen-Yu Tsai wrote:
> > The kerneldoc for regulator_is_supported_voltage() states that the
> > return value is a boolean. That is not correct, as it could return an
> > error number if the check failed.
> >
> > Fix the description by expanding it to cover the valid return values and
> > error conditions. The description is also converted to a proper "Return"
> > section.
>
> ...
>
> > - * Returns a boolean.
> > + * Return: 1 if the voltage range is supported, 0 if not, or a negative error
> > + *      number if @regulator's voltage can't be changed and voltage readback
> > + *      failed.
>
> Not sure why you have TABs in the following lines, but I think you have checked
> the rendered files (html, man, pdf) and all look good.

It seems that the kernel-doc tool isn't properly trimming the leading
whitespace for RST output. However it is doing it correctly for manpage
output. And for html, pdf and all the other outputs that go through
Sphinx, the latter reformats stuff and seems to drop the extra whitespace.

I looked at the kernel-doc a bit, but wasn't able to immediately spot where
the problem was.

> Alternatively it might be written as
>
>  * Return:
>  * 1 if the voltage range is supported, 0 if not, or a negative error number
>  * if @regulator's voltage can't be changed and voltage readback failed.
>
> which should be the same in the render.

The RST output then has extra empty lines. *shrugs*


ChenYu

>
> (Also similar applies to the other patch(es))
>
> --
> With Best Regards,
> Andy Shevchenko
>
>