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

rddunlap · rafaeljw · commit 5f70413a8505 · 2023-12-21T12:05:48.000+01:00
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 &lt;rdunlap@infradead.org&gt;
Signed-off-by: Rafael J. Wysocki &lt;rafael.j.wysocki@intel.com&gt;
diff --git a/drivers/thermal/cpuidle_cooling.c b/drivers/thermal/cpuidle_cooling.c
@@ -66,7 +66,7 @@ static unsigned int cpuidle_cooling_runtime(unsigned int idle_duration_us,
  * @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(struct thermal_cooling_device *cdev,
 	return 0;
 }
 
-/**
+/*
  * cpuidle_cooling_ops - thermal cooling device ops
  */
 static struct thermal_cooling_device_ops cpuidle_cooling_ops = {

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ static unsigned int cpuidle_cooling_runtime(unsigned int idle_duration_us,`
`66`	`66`	`* @state : a pointer to the state variable to be filled`
`67`	`67`	`*`
`68`	`68`	`* The function always returns 100 as the injection ratio. It is`
`69`		`- * percentile based for consistency accross different platforms.`
	`69`	`+ * percentile based for consistency across different platforms.`
`70`	`70`	`*`
`71`	`71`	`* Return: The function can not fail, it is always zero`
`72`	`72`	`*/`
`@@ -146,7 +146,7 @@ static int cpuidle_cooling_set_cur_state(struct thermal_cooling_device *cdev,`
`146`	`146`	`return 0;`
`147`	`147`	`}`
`148`	`148`
`149`		`-/**`
	`149`	`+/*`
`150`	`150`	`* cpuidle_cooling_ops - thermal cooling device ops`
`151`	`151`	`*/`
`152`	`152`	`static struct thermal_cooling_device_ops cpuidle_cooling_ops = {`