* [PATCH] cpuidle: fix kernel doc warnings
@ 2020-01-20 13:07 Benjamin Gaignard
2020-01-20 16:28 ` Randy Dunlap
0 siblings, 1 reply; 2+ messages in thread
From: Benjamin Gaignard @ 2020-01-20 13:07 UTC (permalink / raw)
To: rjw, daniel.lezcano; +Cc: linux-pm, linux-kernel, Benjamin Gaignard
Fix cpuidle_find_deepest_state() kernel documentation to avoid warnings when compiling with W=1.
Signed-off-by: Benjamin Gaignard <benjamin.gaignard@st.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.
*/
int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
struct cpuidle_device *dev,
--
2.15.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] cpuidle: fix kernel doc warnings
2020-01-20 13:07 [PATCH] cpuidle: fix kernel doc warnings Benjamin Gaignard
@ 2020-01-20 16:28 ` Randy Dunlap
0 siblings, 0 replies; 2+ messages in thread
From: Randy Dunlap @ 2020-01-20 16:28 UTC (permalink / raw)
To: Benjamin Gaignard, rjw, daniel.lezcano; +Cc: linux-pm, linux-kernel
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@st.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@infradead.org>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-01-20 16:28 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-01-20 13:07 [PATCH] cpuidle: fix kernel doc warnings Benjamin Gaignard
2020-01-20 16:28 ` Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).