linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v2] cpuidle: fix kernel doc warnings
@ 2020-01-21  8:27 Benjamin Gaignard
  2020-01-21 15:36 ` Randy Dunlap
  0 siblings, 1 reply; 3+ messages in thread
From: Benjamin Gaignard @ 2020-01-21  8:27 UTC (permalink / raw)
  To: rjw, daniel.lezcano; +Cc: linux-pm, linux-kernel, Benjamin Gaignard, rdunlap

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

Signed-off-by: Benjamin Gaignard <benjamin.gaignard@st.com>
---
CC: rdunlap@infradead.org
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


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [PATCH v2] cpuidle: fix kernel doc warnings
  2020-01-21  8:27 [PATCH v2] cpuidle: fix kernel doc warnings Benjamin Gaignard
@ 2020-01-21 15:36 ` Randy Dunlap
  2020-01-22 23:44   ` Rafael J. Wysocki
  0 siblings, 1 reply; 3+ messages in thread
From: Randy Dunlap @ 2020-01-21 15:36 UTC (permalink / raw)
  To: Benjamin Gaignard, rjw, daniel.lezcano; +Cc: linux-pm, linux-kernel

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 <benjamin.gaignard@st.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> CC: rdunlap@infradead.org
> 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 <rdunlap@infradead.org>

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH v2] cpuidle: fix kernel doc warnings
  2020-01-21 15:36 ` Randy Dunlap
@ 2020-01-22 23:44   ` Rafael J. Wysocki
  0 siblings, 0 replies; 3+ messages in thread
From: Rafael J. Wysocki @ 2020-01-22 23:44 UTC (permalink / raw)
  To: Randy Dunlap, Benjamin Gaignard
  Cc: Rafael J. Wysocki, Daniel Lezcano, Linux PM, Linux Kernel Mailing List

On Tue, Jan 21, 2020 at 4:36 PM Randy Dunlap <rdunlap@infradead.org> 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 <benjamin.gaignard@st.com>
>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>

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

> > ---
> > CC: rdunlap@infradead.org
> > 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 <rdunlap@infradead.org>

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-01-22 23:44 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-01-21  8:27 [PATCH v2] cpuidle: fix kernel doc warnings Benjamin Gaignard
2020-01-21 15:36 ` Randy Dunlap
2020-01-22 23:44   ` Rafael J. Wysocki

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).