linux-kernel - [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-next>] [day] [month] [year] [list]

Message-ID: <20231221055144.24862-1-rdunlap@infradead.org>
Date: Wed, 20 Dec 2023 21:51:44 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.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: [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 <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 = {