Thread (23 messages) 23 messages, 4 authors, 2024-08-28

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

From: Chen-Yu Tsai <wenst@chromium.org>
Date: 2024-08-28 07:59:44
Also in: lkml

On Tue, Aug 27, 2024 at 10:35 PM Andy Shevchenko
[off-list ref] wrote:
On Tue, Aug 27, 2024 at 05:55:42PM +0800, Chen-Yu Tsai wrote:
quoted
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)
Ack. I intended to unify them throughout the series. Looks like I missed
a couple spots.
quoted
Fix the description by expanding it to cover the true, false and error
true and false are not what is returned, right?
What I meant to describe was true or false with regards to the function
name. I'll try to make it clear.
quoted
conditions. The description is also converted to a proper "Return"
section.
...
quoted
- * Returns a boolean.
+ * Return: 1 if voltage range is support, 0 if not, or error number if
supported
Ack.


Thanks
ChenYu
quoted
+ *      voltage can't be changed and voltage readback failed.
--
With Best Regards,
Andy Shevchenko
  
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help