linux-kernel - Re: [PATCH] thermal: cpuidle_cooling: fix kernel-doc warning and a spello

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CAJZ5v0j5mcxRMQR3T+tmuL89Y+GjrWYwK_hj+fYikczp=Ey3Fw@mail.gmail.com>
Date: Thu, 21 Dec 2023 12:06:48 +0100
From: "Rafael J. Wysocki" <rafael@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org, Amit Daniel Kachhap <amit.kachhap@...il.com>, 
	Daniel Lezcano <daniel.lezcano@...aro.org>, Viresh Kumar <viresh.kumar@...aro.org>, 
	Lukasz Luba <lukasz.luba@....com>, "Rafael J . Wysocki" <rafael@...nel.org>, Zhang Rui <rui.zhang@...el.com>, 
	linux-pm@...r.kernel.org
Subject: Re: [PATCH] thermal: cpuidle_cooling: fix kernel-doc warning and a spello

On Thu, Dec 21, 2023 at 6:51 AM Randy Dunlap <rdunlap@...radead.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@...radead.org>
> Cc: Amit Daniel Kachhap <amit.kachhap@...il.com>
> Cc: Daniel Lezcano <daniel.lezcano@...aro.org>
> Cc: Viresh Kumar <viresh.kumar@...aro.org>
> Cc: Lukasz Luba <lukasz.luba@....com>
> Cc: Rafael J. Wysocki <rafael@...nel.org>
> Cc: Zhang Rui <rui.zhang@...el.com>
> Cc: linux-pm@...r.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!