Re: [PATCH v2 2/8] PM: runtime: More kerneldoc formatting
From: Rafael J. Wysocki (Intel)
Date: Tue Sep 29 2026 - 15:47:03 EST
On Wed, Sep 23, 2026 at 7:47 PM Brian Norris <briannorris@xxxxxxxxxxxx> wrote:
>
> In taking another pass at these docs, I found some more inconsistencies.
>
> Signed-off-by: Brian Norris <briannorris@xxxxxxxxxxxx>
> ---
>
> Changes in v2:
> * New in v2
>
> drivers/base/power/runtime.c | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/base/power/runtime.c b/drivers/base/power/runtime.c
> index 7e75f6d5df07..dce7b6ff7e9d 100644
> --- a/drivers/base/power/runtime.c
> +++ b/drivers/base/power/runtime.c
> @@ -1255,7 +1255,7 @@ static int pm_runtime_get_conditional(struct device *dev, bool ign_usage_count)
>
> /**
> * pm_runtime_get_if_active - Bump up runtime PM usage counter if the device is
> - * in active state
> + * in active state.
I wouldn't do this.
Instead, I'd change the one-line description to "Conditionally bump up
runtime PM usage counter" and I'd explain what "conditionally" means
in the body of the comment.
> * @dev: Target device.
> *
> * Increment the runtime PM usage counter of @dev if its runtime PM status is
> @@ -1635,10 +1635,10 @@ static void pm_runtime_disable_action(void *data)
> /**
> * devm_pm_runtime_enable - devres-enabled version of pm_runtime_enable.
> *
I'd remove the empty line above.
> + * @dev: Device to handle.
> + *
> * NOTE: this will also handle calling pm_runtime_dont_use_autosuspend() for
> * you at driver exit time if needed.
> - *
> - * @dev: Device to handle.
> */
> int devm_pm_runtime_enable(struct device *dev)
> {
> --
> 2.56.0.rc1.310.g51773c2048-goog
>