[v2,04/11] thermal: devfreq_cooling: Appease the kernel-doc deity

Message ID 7059d82472fe12139fc7a3379c5b9716a23cce5c.1574242756.git.amit.kucheria@linaro.org
State New
Headers show
Series
  • thermal: clean up output of make W=1
Related show

Commit Message

Amit Kucheria Nov. 20, 2019, 3:45 p.m.
Fix up the following warnings with make W=1:

linux.git/drivers/thermal/devfreq_cooling.c:68: warning: Function
parameter or member 'capped_state' not described in
'devfreq_cooling_device'
linux.git/drivers/thermal/devfreq_cooling.c:593: warning: Function
parameter or member 'cdev' not described in 'devfreq_cooling_unregister'
linux.git/drivers/thermal/devfreq_cooling.c:593: warning: Excess
function parameter 'dfc' description in 'devfreq_cooling_unregister'

Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>

---
 drivers/thermal/devfreq_cooling.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

-- 
2.20.1

Comments

Viresh Kumar Nov. 21, 2019, 5:31 a.m. | #1
On 20-11-19, 21:15, Amit Kucheria wrote:
> Fix up the following warnings with make W=1:

> 

> linux.git/drivers/thermal/devfreq_cooling.c:68: warning: Function

> parameter or member 'capped_state' not described in

> 'devfreq_cooling_device'

> linux.git/drivers/thermal/devfreq_cooling.c:593: warning: Function

> parameter or member 'cdev' not described in 'devfreq_cooling_unregister'

> linux.git/drivers/thermal/devfreq_cooling.c:593: warning: Excess

> function parameter 'dfc' description in 'devfreq_cooling_unregister'

> 

> Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>

> ---

>  drivers/thermal/devfreq_cooling.c | 3 ++-

>  1 file changed, 2 insertions(+), 1 deletion(-)


Reviewed-by: Viresh Kumar <viresh.kumar@linaro.org>


-- 
viresh

Patch

diff --git a/drivers/thermal/devfreq_cooling.c b/drivers/thermal/devfreq_cooling.c
index ef59256887ff..a87d4fa031c8 100644
--- a/drivers/thermal/devfreq_cooling.c
+++ b/drivers/thermal/devfreq_cooling.c
@@ -53,6 +53,7 @@  static DEFINE_IDA(devfreq_ida);
  *		'utilization' (which is	'busy_time / 'total_time').
  *		The 'res_util' range is from 100 to (power_table[state] * 100)
  *		for the corresponding 'state'.
+ * @capped_state:	index to cooling state with in dynamic power budget
  */
 struct devfreq_cooling_device {
 	int id;
@@ -587,7 +588,7 @@  EXPORT_SYMBOL_GPL(devfreq_cooling_register);
 
 /**
  * devfreq_cooling_unregister() - Unregister devfreq cooling device.
- * @dfc: Pointer to devfreq cooling device to unregister.
+ * @cdev: Pointer to devfreq cooling device to unregister.
  */
 void devfreq_cooling_unregister(struct thermal_cooling_device *cdev)
 {