[PATCH 2/8] regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value

Andy Shevchenko andriy.shevchenko at linux.intel.com
Tue Aug 27 07:35:50 PDT 2024


On Tue, Aug 27, 2024 at 05:55:42PM +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.

I don't know what error number means. Is it positive? Negative?

s/error number/negative error code/g
(Here and everywhere else)


> Fix the description by expanding it to cover the true, false and error

true and false are not what is returned, right?

> conditions. The description is also converted to a proper "Return"
> section.

...

> - * Returns a boolean.
> + * Return: 1 if voltage range is support, 0 if not, or error number if

supported

> + *	   voltage can't be changed and voltage readback failed.

-- 
With Best Regards,
Andy Shevchenko





More information about the linux-arm-kernel mailing list