diff mbox series

thermal: cpuidle_cooling: fix kernel-doc warning and a spello

Message ID 20231221055144.24862-1-rdunlap@infradead.org
State New
Headers
Series thermal: cpuidle_cooling: fix kernel-doc warning and a spello |

Commit Message

Randy Dunlap Dec. 21, 2023, 5:51 a.m. UTC 
  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 <rdunlap@infradead.org>
Cc: Amit Daniel Kachhap <amit.kachhap@gmail.com>
Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
Cc: Viresh Kumar <viresh.kumar@linaro.org>
Cc: Lukasz Luba <lukasz.luba@arm.com>
Cc: Rafael J. Wysocki <rafael@kernel.org>
Cc: Zhang Rui <rui.zhang@intel.com>
Cc: linux-pm@vger.kernel.org
---
 drivers/thermal/cpuidle_cooling.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Rafael J. Wysocki Dec. 21, 2023, 11:06 a.m. UTC | #1 
On Thu, Dec 21, 2023 at 6:51 AM Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org>
> Cc: Amit Daniel Kachhap <amit.kachhap@gmail.com>
> Cc: Daniel Lezcano <daniel.lezcano@linaro.org>
> Cc: Viresh Kumar <viresh.kumar@linaro.org>
> Cc: Lukasz Luba <lukasz.luba@arm.com>
> Cc: Rafael J. Wysocki <rafael@kernel.org>
> Cc: Zhang Rui <rui.zhang@intel.com>
> Cc: linux-pm@vger.kernel.org
> ---
>  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!
diff mbox series

Patch

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 = {