Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1409736

[PATCHv3 08/48] thermal: core: improve power actor documentation

Show all headers | View raw

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>
---
 drivers/thermal/thermal_core.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/thermal/thermal_core.c b/drivers/thermal/thermal_core.c
index 3cbb208..12427cc 100644
--- a/drivers/thermal/thermal_core.c
+++ b/drivers/thermal/thermal_core.c
@@ -1142,12 +1142,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.
-- 
2.1.4

Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[PATCHv3 00/48] thermal: reorganizing thermal core Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:20 +0200
  [PATCHv3 41/48] thermal: core: remove FSF address in the GPL notice Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:20 +0200
  [PATCHv3 48/48] thermal: sysfs: use kcalloc() instead of kzalloc() Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:20 +0200
  [PATCHv3 07/48] thermal: core: move passive attr to tz->device.groups Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:20 +0200
  [PATCHv3 31/48] thermal: core: move bind_cdev() to where it is used Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:20 +0200
  [PATCHv3 40/48] thermal: sysfs: remove symbols of emul_temp when config is disabled Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:20 +0200
  [PATCHv3 19/48] thermal: core: move to_thermal_zone() macro to header file Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 37/48] thermal: core: add a comment describing the main update loop Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 32/48] thermal: core: move bind_tz() to where it is used Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 16/48] thermal: core: split passive_store Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 02/48] thermal: core: group thermal_zone DEVICE_ATTR's declarations Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 06/48] thermal: core: move mode attribute to tz->device.groups Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 27/48] thermal: core: group functions related to governor handling Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 42/48] thermal: core: small style fix when checking for __find_governor() Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 20/48] thermal: core: treat correctly the return value of *scanf calls Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 26/48] thermal: core: introduce thermal_helpers.c Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 23/48] thermal: core: move to_cooling_device macro to header file Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 22/48] thermal: core: move thermal_zone sysfs to thermal_sysfs.c Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 28/48] thermal: core: move idr handling to device management section Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 36/48] thermal: core: move notify to the zone update section Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 25/48] thermal: core: remove a couple of style issues on helpers Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 10/48] thermal: core: remove useless empty line Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 09/48] thermal: core: move power actor code out of sysfs I/F section Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 21/48] thermal: core: match parenthesis on code alignment Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 03/48] thermal: core: group device_create_file() calls that are always created Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 24/48] thermal: core: move cooling device sysfs to thermal_sysfs.c Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 11/48] thermal: core: fix style on remove_trip_attrs() Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 35/48] thermal: core: add inline to print_bind_err_msg() Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 33/48] thermal: core: fix couple of style issues on __bind() helper Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 05/48] thermal: core: move emul_temp creation to tz->device.groups Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 12/48] thermal: core: move the trip attrs to the tz sysfs I/F section Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 14/48] thermal: core: move trips attributes to tz->device.groups Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 08/48] thermal: core: improve power actor documentation Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 30/48] thermal: core: move __unbind() helper to where it is used Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 29/48] thermal: core: small style fix on __unbind() helper Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 38/48] thermal: core: add a comment describing the power actor section Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 18/48] thermal: core: split available_policies_show() Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  [PATCHv3 15/48] thermal: core: remove unnecessary device_remove() calls Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 00:30 +0200
  Re: [PATCHv3 00/48] thermal: reorganizing thermal core Keerthy <a0393675@ti.com> - 2016-05-31 06:30 +0200
    Re: [PATCHv3 00/48] thermal: reorganizing thermal core Eduardo Valentin <edubezval@gmail.com> - 2016-05-31 08:20 +0200

csiph-web