2023-12-21 05:52:03

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] thermal: cpuidle_cooling: fix kernel-doc warning and a spello

Correct one misuse of kernel-doc notation and one spelling error as
reported by codespell.

cpuidle_cooling.c:152: warning: cannot understand function prototype: 'struct thermal_cooling_device_ops cpuidle_cooling_ops = '

For the kernel-doc warning, don't use "/**" for a comment on data.
kernel-doc can be used for structure declarations but not definitions.

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Amit Daniel Kachhap <[email protected]>
Cc: Daniel Lezcano <[email protected]>
Cc: Viresh Kumar <[email protected]>
Cc: Lukasz Luba <[email protected]>
Cc: Rafael J. Wysocki <[email protected]>
Cc: Zhang Rui <[email protected]>
Cc: [email protected]
---
drivers/thermal/cpuidle_cooling.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff -- a/drivers/thermal/cpuidle_cooling.c b/drivers/thermal/cpuidle_cooling.c
--- a/drivers/thermal/cpuidle_cooling.c
+++ b/drivers/thermal/cpuidle_cooling.c
@@ -66,7 +66,7 @@ static unsigned int cpuidle_cooling_runt
* @state : a pointer to the state variable to be filled
*
* The function always returns 100 as the injection ratio. It is
- * percentile based for consistency accross different platforms.
+ * percentile based for consistency across different platforms.
*
* Return: The function can not fail, it is always zero
*/
@@ -146,7 +146,7 @@ static int cpuidle_cooling_set_cur_state
return 0;
}

-/**
+/*
* cpuidle_cooling_ops - thermal cooling device ops
*/
static struct thermal_cooling_device_ops cpuidle_cooling_ops = {


2023-12-21 11:07:12

by Rafael J. Wysocki

[permalink] [raw]
Subject: Re: [PATCH] thermal: cpuidle_cooling: fix kernel-doc warning and a spello

On Thu, Dec 21, 2023 at 6:51 AM Randy Dunlap <[email protected]> wrote:
>
> Correct one misuse of kernel-doc notation and one spelling error as
> reported by codespell.
>
> cpuidle_cooling.c:152: warning: cannot understand function prototype: 'struct thermal_cooling_device_ops cpuidle_cooling_ops = '
>
> For the kernel-doc warning, don't use "/**" for a comment on data.
> kernel-doc can be used for structure declarations but not definitions.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Amit Daniel Kachhap <[email protected]>
> Cc: Daniel Lezcano <[email protected]>
> Cc: Viresh Kumar <[email protected]>
> Cc: Lukasz Luba <[email protected]>
> Cc: Rafael J. Wysocki <[email protected]>
> Cc: Zhang Rui <[email protected]>
> Cc: [email protected]
> ---
> drivers/thermal/cpuidle_cooling.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff -- a/drivers/thermal/cpuidle_cooling.c b/drivers/thermal/cpuidle_cooling.c
> --- a/drivers/thermal/cpuidle_cooling.c
> +++ b/drivers/thermal/cpuidle_cooling.c
> @@ -66,7 +66,7 @@ static unsigned int cpuidle_cooling_runt
> * @state : a pointer to the state variable to be filled
> *
> * The function always returns 100 as the injection ratio. It is
> - * percentile based for consistency accross different platforms.
> + * percentile based for consistency across different platforms.
> *
> * Return: The function can not fail, it is always zero
> */
> @@ -146,7 +146,7 @@ static int cpuidle_cooling_set_cur_state
> return 0;
> }
>
> -/**
> +/*
> * cpuidle_cooling_ops - thermal cooling device ops
> */
> static struct thermal_cooling_device_ops cpuidle_cooling_ops = {

Applied as 6.8 material, thanks!