| Message ID | 20200120130701.29948-1-benjamin.gaignard@st.com (mailing list archive) |
|---|---|
| State | Superseded, archived |
| Headers | show |
| Series | cpuidle: fix kernel doc warnings | expand |
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.
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,
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(+)