2020-01-21 08:29:22

by Benjamin GAIGNARD

Subject: [PATCH v2] cpuidle: fix kernel doc warnings

Fix cpuidle_find_deepest_state() kernel documentation to avoid warnings when compiling with W=1.

Signed-off-by: Benjamin Gaignard <[email protected]>
---
CC: [email protected]
version 2:
- fix the comment done by Randy
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
+ *
+ * Return: the index of the deepest available idle state.
*/
int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
struct cpuidle_device *dev,
--
2.15.0

2020-01-21 15:38:06

by Randy Dunlap

Subject: Re: [PATCH v2] cpuidle: fix kernel doc warnings

On 1/21/20 12:27 AM, Benjamin Gaignard wrote:
> Fix cpuidle_find_deepest_state() kernel documentation to avoid warnings when compiling with W=1.
>
> Signed-off-by: Benjamin Gaignard <[email protected]>

Acked-by: Randy Dunlap <[email protected]>

Thanks.

> ---
> CC: [email protected]
> version 2:
> - fix the comment done by Randy
> 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
> + *
> + * Return: the index of the deepest available idle state.
> */
> int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
> struct cpuidle_device *dev,
>


--
~Randy
Reported-by: Randy Dunlap <[email protected]>

2020-01-22 23:47:39

by Rafael J. Wysocki

Subject: Re: [PATCH v2] cpuidle: fix kernel doc warnings

On Tue, Jan 21, 2020 at 4:36 PM Randy Dunlap <[email protected]> wrote:
>
> On 1/21/20 12:27 AM, Benjamin Gaignard wrote:
> > Fix cpuidle_find_deepest_state() kernel documentation to avoid warnings when compiling with W=1.
> >
> > Signed-off-by: Benjamin Gaignard <[email protected]>
>
> Acked-by: Randy Dunlap <[email protected]>

The patch has been queued up as 5.6 material under modified subject
("cpuidle: fix cpuidle_find_deepest_state() kerneldoc warnings"),
thanks!

> > ---
> > CC: [email protected]
> > version 2:
> > - fix the comment done by Randy
> > 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
> > + *
> > + * Return: the index of the deepest available idle state.
> > */
> > int cpuidle_find_deepest_state(struct cpuidle_driver *drv,
> > struct cpuidle_device *dev,
> >
>
>
> --
> ~Randy
> Reported-by: Randy Dunlap <[email protected]>