diff mbox series

PM: runtime: Fix pm_runtime_active() kerneldoc comment

Message ID 2633024.mvXUDI8C0e@kreacher
State New
Headers show
Series PM: runtime: Fix pm_runtime_active() kerneldoc comment | expand

Commit Message

Rafael J. Wysocki Dec. 3, 2021, 4:19 p.m. UTC
From: Rafael J. Wysocki <rafael.j.wysocki@intel.com>

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 <rafael.j.wysocki@intel.com>
---
 include/linux/pm_runtime.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Ulf Hansson Dec. 6, 2021, 11:26 a.m. UTC | #1
On Fri, 3 Dec 2021 at 17:19, Rafael J. Wysocki <rjw@rjwysocki.net> wrote:
>
> From: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
>
> 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 <rafael.j.wysocki@intel.com>

Reviewed-by: Ulf Hansson <ulf.hansson@linaro.org>

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
>
>
>
diff mbox series

Patch

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