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

Message-ID: <ZtBtqPB2MgwUCsM3@smile.fi.intel.com>
Date: Thu, 29 Aug 2024 15:46:32 +0300
From: Andy Shevchenko <andriy.shevchenko@...ux.intel.com>
To: Chen-Yu Tsai <wenst@...omium.org>
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 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.

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.

(Also similar applies to the other patch(es))

-- 
With Best Regards,
Andy Shevchenko