linux-kernel - Re: [PATCH] cpuidle: fix kernel doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <ab9ae316-e01e-117c-36d5-0f733c407217@infradead.org>
Date:   Mon, 20 Jan 2020 08:28:04 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Benjamin Gaignard <benjamin.gaignard@...com>, rjw@...ysocki.net,
        daniel.lezcano@...aro.org
Cc:     linux-pm@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] cpuidle: fix kernel doc warnings

On 1/20/20 5:07 AM, Benjamin Gaignard wrote:
> Fix cpuidle_find_deepest_state() kernel documentation to avoid warnings when compiling with W=1.
> 
> Signed-off-by: Benjamin Gaignard <benjamin.gaignard@...com>
> ---
>  drivers/cpuidle/cpuidle.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/cpuidle/cpuidle.c b/drivers/cpuidle/cpuidle.c
> index 33d19c8eb027..19c6dee88921 100644
> --- a/drivers/cpuidle/cpuidle.c
> +++ b/drivers/cpuidle/cpuidle.c
> @@ -121,6 +121,9 @@ void cpuidle_use_deepest_state(u64 latency_limit_ns)
>   * cpuidle_find_deepest_state - Find the deepest available idle state.
>   * @drv: cpuidle driver for the given CPU.
>   * @dev: cpuidle device for the given CPU.
> + * @latency_limit_ns: Idle state exit latency limit
> + *
> + * Returns the index of the deepest available idle state.

Preferably:

  * Return: the index of the deepest available idle state.

>   */
>  int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
>  			       struct cpuidle_device *dev,
> 

thanks.
-- 
~Randy
Reported-by: Randy Dunlap <rdunlap@...radead.org>