[PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section
Matti Vaittinen
mazziesaccount at gmail.com
Tue Aug 27 22:55:54 PDT 2024
On 8/27/24 12:55, 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.
>
> Signed-off-by: Chen-Yu Tsai <wenst at chromium.org>
Thank You for improving this! I appreciate it :)
> ---
> drivers/regulator/irq_helpers.c | 4 ++++
> 1 file changed, 4 insertions(+)
>
> diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
> index 5ab1a0befe12..5803ef016b7d 100644
> --- a/drivers/regulator/irq_helpers.c
> +++ b/drivers/regulator/irq_helpers.c
> @@ -414,6 +414,10 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
> * notification helperk. Exactly one rdev and exactly one error (in
I just noticed (an existing) typo "helperk". I wonder if it was Ok to
fix it while anyways changing the doc. It's not strictly speaking
related to the return values though :)
> * "common_errs"-field) can be given at IRQ helper registration for
> * regulator_irq_map_event_simple() to be viable.
> + *
> + * Return: 0
> + *
Anyways, I agree with Andy about not needing the blank line here - but
other than that:
Reviewed-by: Matti Vaittinen <mazziesaccount at gmail.com>
> + * Actual regulator error and notification are passed back through @rid.
> */
> int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid,
> unsigned long *dev_mask)
--
Matti Vaittinen
Linux kernel developer at ROHM Semiconductors
Oulu Finland
~~ When things go utterly wrong vim users can always type :help! ~~
More information about the linux-arm-kernel
mailing list