Re: [PATCH] PM / core: Fix kerneldoc comments of three functions

From: Ulf Hansson
Date: Fri Oct 13 2017 - 02:48:37 EST


On 13 October 2017 at 02:33, Rafael J. Wysocki <rjw@xxxxxxxxxxxxx> wrote:
> From: Rafael J. Wysocki <rafael.j.wysocki@xxxxxxxxx>
>
> Fix kerneldoc comments of __device_suspend_noirq(),
> __device_suspend_late() and __device_suspend() where the function
> names in kerneldoc don't match the actual names of the functions.
>
> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@xxxxxxxxx>
> ---
> drivers/base/power/main.c | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> Index: linux-pm/drivers/base/power/main.c
> ===================================================================
> --- linux-pm.orig/drivers/base/power/main.c
> +++ linux-pm/drivers/base/power/main.c
> @@ -1077,7 +1077,7 @@ static pm_message_t resume_event(pm_mess
> }
>
> /**
> - * device_suspend_noirq - Execute a "late suspend" callback for given device.
> + * __device_suspend_noirq - Execute a "late suspend" callback for given device.

While at it, I suggest to also change "late suspend" to "noirq suspend".

As a matter of fact I found the similar text to be wrong also for
device_resume_noirq(), perhaps that should be fixed as well.

[...]

Kind regards
Uffe