2021-12-03 16:19:52

by Rafael J. Wysocki

[permalink] [raw]
Subject: [PATCH] PM: runtime: Fix pm_runtime_active() kerneldoc comment

From: Rafael J. Wysocki <[email protected]>

The kerneldoc comment of pm_runtime_active() does not reflect the
behavior of the function, so update it accordingly.

Signed-off-by: Rafael J. Wysocki <[email protected]>
---
include/linux/pm_runtime.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

Index: linux-pm/include/linux/pm_runtime.h
===================================================================
--- linux-pm.orig/include/linux/pm_runtime.h
+++ linux-pm/include/linux/pm_runtime.h
@@ -129,7 +129,7 @@ static inline bool pm_runtime_suspended(
* pm_runtime_active - Check whether or not a device is runtime-active.
* @dev: Target device.
*
- * Return %true if runtime PM is enabled for @dev and its runtime PM status is
+ * Return %true if runtime PM is disabled for @dev or its runtime PM status is
* %RPM_ACTIVE, or %false otherwise.
*
* Note that the return value of this function can only be trusted if it is





2021-12-06 11:27:33

by Ulf Hansson

[permalink] [raw]
Subject: Re: [PATCH] PM: runtime: Fix pm_runtime_active() kerneldoc comment

On Fri, 3 Dec 2021 at 17:19, Rafael J. Wysocki <[email protected]> wrote:
>
> From: Rafael J. Wysocki <[email protected]>
>
> The kerneldoc comment of pm_runtime_active() does not reflect the
> behavior of the function, so update it accordingly.
>
> Signed-off-by: Rafael J. Wysocki <[email protected]>

Reviewed-by: Ulf Hansson <[email protected]>

Kind regards
Uffe

> ---
> include/linux/pm_runtime.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> Index: linux-pm/include/linux/pm_runtime.h
> ===================================================================
> --- linux-pm.orig/include/linux/pm_runtime.h
> +++ linux-pm/include/linux/pm_runtime.h
> @@ -129,7 +129,7 @@ static inline bool pm_runtime_suspended(
> * pm_runtime_active - Check whether or not a device is runtime-active.
> * @dev: Target device.
> *
> - * Return %true if runtime PM is enabled for @dev and its runtime PM status is
> + * Return %true if runtime PM is disabled for @dev or its runtime PM status is
> * %RPM_ACTIVE, or %false otherwise.
> *
> * Note that the return value of this function can only be trusted if it is
>
>
>