summaryrefslogtreecommitdiffstats
path: root/drivers/thermal/thermal_core.c
diff options
context:
space:
mode:
authorEduardo Valentin <edubezval@gmail.com>2016-11-07 21:08:46 -0800
committerZhang Rui <rui.zhang@intel.com>2016-11-23 10:06:12 +0800
commit059386f43ef96bd61af40715aff757b727c3105b (patch)
treef129ae20e896f1c280773d86cb0e4b3b6ae1a2b2 /drivers/thermal/thermal_core.c
parent3a836bfe9ff6342303bd2a146bcc42eebc3a259a (diff)
downloadlinux-059386f43ef96bd61af40715aff757b727c3105b.tar.gz
linux-059386f43ef96bd61af40715aff757b727c3105b.tar.bz2
linux-059386f43ef96bd61af40715aff757b727c3105b.zip
thermal: core: improve power actor documentation
Simple improvement on clarity and removal of checkpatch warning in the documentation of power actor kernel doc. Cc: Zhang Rui <rui.zhang@intel.com> Cc: linux-pm@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Eduardo Valentin <edubezval@gmail.com> Signed-off-by: Zhang Rui <rui.zhang@intel.com>
Diffstat (limited to 'drivers/thermal/thermal_core.c')
-rw-r--r--drivers/thermal/thermal_core.c5
1 files changed, 3 insertions, 2 deletions
diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c
index f3d9fe9d5c48..3d2adfac9578 100644
--- a/drivers/thermal/thermal_core.c
+++ b/drivers/thermal/thermal_core.c
@@ -1206,12 +1206,13 @@ int power_actor_get_min_power(struct thermal_cooling_device *cdev,
}
/**
- * power_actor_set_power() - limit the maximum power that a cooling device can consume
+ * power_actor_set_power() - limit the maximum power a cooling device consumes
* @cdev: pointer to &thermal_cooling_device
* @instance: thermal instance to update
* @power: the power in milliwatts
*
- * Set the cooling device to consume at most @power milliwatts.
+ * Set the cooling device to consume at most @power milliwatts. The limit is
+ * expected to be a cap at the maximum power consumption.
*
* Return: 0 on success, -EINVAL if the cooling device does not
* implement the power actor API or -E* for other failures.