Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

thermal: Syntactic and factual errors in the API document

There are several places where the English in the document is syntactically
invalid, or unclear. There are also one or two factual errors.

Reviewed-by: Durgadoss R <durgadoss.r@intel.com>
Signed-off-by: Andy Champ <andycham@amazon.com>
Signed-off-by: Eduardo Valentin <edubezval@gmail.com>

authored by

Andy Champ and committed by
Eduardo Valentin
c212ed91 04974df8

+22 -22
+22 -22
Documentation/thermal/sysfs-api.txt
··· 69 69 1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device *tz) 70 70 71 71 This interface function removes the thermal zone device. 72 - It deletes the corresponding entry form /sys/class/thermal folder and 73 - unbind all the thermal cooling devices it uses. 72 + It deletes the corresponding entry from /sys/class/thermal folder and 73 + unbinds all the thermal cooling devices it uses. 74 74 75 75 1.1.3 struct thermal_zone_device *thermal_zone_of_sensor_register( 76 76 struct device *dev, int sensor_id, void *data, ··· 146 146 147 147 This interface function adds a new thermal cooling device (fan/processor/...) 148 148 to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself 149 - to all the thermal zone devices register at the same time. 149 + to all the thermal zone devices registered at the same time. 150 150 name: the cooling device name. 151 151 devdata: device private data. 152 152 ops: thermal cooling devices call-backs. 153 153 .get_max_state: get the Maximum throttle state of the cooling device. 154 - .get_cur_state: get the Current throttle state of the cooling device. 154 + .get_cur_state: get the Currently requested throttle state of the cooling device. 155 155 .set_cur_state: set the Current throttle state of the cooling device. 156 156 157 157 1.2.2 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev) 158 158 159 - This interface function remove the thermal cooling device. 160 - It deletes the corresponding entry form /sys/class/thermal folder and 161 - unbind itself from all the thermal zone devices using it. 159 + This interface function removes the thermal cooling device. 160 + It deletes the corresponding entry from /sys/class/thermal folder and 161 + unbinds itself from all the thermal zone devices using it. 162 162 163 163 1.3 interface for binding a thermal zone device with a thermal cooling device 164 164 1.3.1 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz, 165 165 int trip, struct thermal_cooling_device *cdev, 166 166 unsigned long upper, unsigned long lower, unsigned int weight); 167 167 168 - This interface function bind a thermal cooling device to the certain trip 168 + This interface function binds a thermal cooling device to a particular trip 169 169 point of a thermal zone device. 170 170 This function is usually called in the thermal zone device .bind callback. 171 171 tz: the thermal zone device 172 172 cdev: thermal cooling device 173 - trip: indicates which trip point the cooling devices is associated with 174 - in this thermal zone. 173 + trip: indicates which trip point in this thermal zone the cooling device 174 + is associated with. 175 175 upper:the Maximum cooling state for this trip point. 176 176 THERMAL_NO_LIMIT means no upper limit, 177 177 and the cooling device can be in max_state. ··· 184 184 1.3.2 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz, 185 185 int trip, struct thermal_cooling_device *cdev); 186 186 187 - This interface function unbind a thermal cooling device from the certain 187 + This interface function unbinds a thermal cooling device from a particular 188 188 trip point of a thermal zone device. This function is usually called in 189 189 the thermal zone device .unbind callback. 190 190 tz: the thermal zone device 191 191 cdev: thermal cooling device 192 - trip: indicates which trip point the cooling devices is associated with 193 - in this thermal zone. 192 + trip: indicates which trip point in this thermal zone the cooling device 193 + is associated with. 194 194 195 195 1.4 Thermal Zone Parameters 196 196 1.4.1 struct thermal_bind_params ··· 210 210 this thermal zone and cdev, for a particular trip point. 211 211 If nth bit is set, then the cdev and thermal zone are bound 212 212 for trip point n. 213 - .limits: This is an array of cooling state limits. Must have exactly 214 - 2 * thermal_zone.number_of_trip_points. It is an array consisting 215 - of tuples <lower-state upper-state> of state limits. Each trip 216 - will be associated with one state limit tuple when binding. 217 - A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> 218 - on all trips. These limits are used when binding a cdev to a 219 - trip point. 213 + .binding_limits: This is an array of cooling state limits. Must have 214 + exactly 2 * thermal_zone.number_of_trip_points. It is an 215 + array consisting of tuples <lower-state upper-state> of 216 + state limits. Each trip will be associated with one state 217 + limit tuple when binding. A NULL pointer means 218 + <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> on all trips. 219 + These limits are used when binding a cdev to a trip point. 220 220 .match: This call back returns success(0) if the 'tz and cdev' need to 221 221 be bound, as per platform data. 222 222 1.4.2 struct thermal_zone_params ··· 351 351 RO, Optional 352 352 353 353 cdev[0-*]_trip_point 354 - The trip point with which cdev[0-*] is associated in this thermal 355 - zone; -1 means the cooling device is not associated with any trip 354 + The trip point in this thermal zone which cdev[0-*] is associated 355 + with; -1 means the cooling device is not associated with any trip 356 356 point. 357 357 RO, Optional 358 358