[PATCH] Syntactic and factual errors in the API document

[PATCH] Syntactic and factual errors in the API document

[Andy Champ]

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

---
 Documentation/thermal/sysfs-api.txt | 44 ++++++++++++++++++-------------------
 1 file changed, 22 insertions(+), 22 deletions(-)

diff --git a/Documentation/thermal/sysfs-api.txt b/Documentation/thermal/sysfs-api.txt
index 8c745c8..5bc73ef 100644
--- a/Documentation/thermal/sysfs-api.txt
+++ b/Documentation/thermal/sysfs-api.txt
@@ -69,8 +69,8 @@ temperature) and throttle appropriate devices.
 1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
 
     This interface function removes the thermal zone device.
-    It deletes the corresponding entry form /sys/class/thermal folder and
-    unbind all the thermal cooling devices it uses.
+    It deletes the corresponding entry from /sys/class/thermal folder and
+    unbinds all the thermal cooling devices it uses.
 
 1.2 thermal cooling device interface
 1.2.1 struct thermal_cooling_device *thermal_cooling_device_register(char *name,
@@ -78,32 +78,32 @@ temperature) and throttle appropriate devices.
 
     This interface function adds a new thermal cooling device (fan/processor/...)
     to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
-    to all the thermal zone devices register at the same time.
+    to all the thermal zone devices registered at the same time.
     name: the cooling device name.
     devdata: device private data.
     ops: thermal cooling devices call-backs.
 	.get_max_state: get the Maximum throttle state of the cooling device.
-	.get_cur_state: get the Current throttle state of the cooling device.
+	.get_cur_state: get the Currently requested throttle state of the cooling device.
 	.set_cur_state: set the Current throttle state of the cooling device.
 
 1.2.2 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
 
-    This interface function remove the thermal cooling device.
-    It deletes the corresponding entry form /sys/class/thermal folder and
-    unbind itself from all the thermal zone devices using it.
+    This interface function removes the thermal cooling device.
+    It deletes the corresponding entry from /sys/class/thermal folder and
+    unbinds itself from all the thermal zone devices using it.
 
 1.3 interface for binding a thermal zone device with a thermal cooling device
 1.3.1 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
 	int trip, struct thermal_cooling_device *cdev,
 	unsigned long upper, unsigned long lower, unsigned int weight);
 
-    This interface function bind a thermal cooling device to the certain trip
+    This interface function binds a thermal cooling device to a particular trip
     point of a thermal zone device.
     This function is usually called in the thermal zone device .bind callback.
     tz: the thermal zone device
     cdev: thermal cooling device
-    trip: indicates which trip point the cooling devices is associated with
-	  in this thermal zone.
+    trip: indicates which trip point in this thermal zone the cooling device
+          is associated with.
     upper:the Maximum cooling state for this trip point.
           THERMAL_NO_LIMIT means no upper limit,
 	  and the cooling device can be in max_state.
@@ -116,13 +116,13 @@ temperature) and throttle appropriate devices.
 1.3.2 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
 		int trip, struct thermal_cooling_device *cdev);
 
-    This interface function unbind a thermal cooling device from the certain
+    This interface function unbinds a thermal cooling device from a particular
     trip point of a thermal zone device. This function is usually called in
     the thermal zone device .unbind callback.
     tz: the thermal zone device
     cdev: thermal cooling device
-    trip: indicates which trip point the cooling devices is associated with
-	  in this thermal zone.
+    trip: indicates which trip point in this thermal zone the cooling device
+          is associated with.
 
 1.4 Thermal Zone Parameters
 1.4.1 struct thermal_bind_params
@@ -142,13 +142,13 @@ temperature) and throttle appropriate devices.
                this thermal zone and cdev, for a particular trip point.
                If nth bit is set, then the cdev and thermal zone are bound
                for trip point n.
-    .limits: This is an array of cooling state limits. Must have exactly
-         2 * thermal_zone.number_of_trip_points. It is an array consisting
-         of tuples <lower-state upper-state> of state limits. Each trip
-         will be associated with one state limit tuple when binding.
-         A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
-         on all trips. These limits are used when binding a cdev to a
-         trip point.
+    .binding_limits: This is an array of cooling state limits. Must have
+                     exactly 2 * thermal_zone.number_of_trip_points. It is an
+                     array consisting of tuples <lower-state upper-state> of
+                     state limits. Each trip will be associated with one state
+                     limit tuple when binding. A NULL pointer means
+                     <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> on all trips.
+                     These limits are used when binding a cdev to a trip point.
     .match: This call back returns success(0) if the 'tz and cdev' need to
 	    be bound, as per platform data.
 1.4.2 struct thermal_zone_params
@@ -283,8 +283,8 @@ cdev[0-*]
 	RO, Optional
 
 cdev[0-*]_trip_point
-	The trip point with which cdev[0-*] is associated in this thermal
-	zone; -1 means the cooling device is not associated with any trip
+	The trip point in this thermal zone which cdev[0-*] is associated
+	with; -1 means the cooling device is not associated with any trip
 	point.
 	RO, Optional
 
-- 
1.9.1

RE: [PATCH] Syntactic and factual errors in the API document

[R, Durgadoss]

>-----Original Message-----
>From: Andy Champ [mailto:andycham@amazon.com]
>Sent: Tuesday, March 22, 2016 6:07 PM
>To: edubezval@gmail.com
>Cc: corbet@lwn.net; javi.merino@arm.com; R, Durgadoss <durgadoss.r@intel.com>;
>leo.yan@linaro.org; kapileshwar.singh@arm.com; wni@nvidia.com; linux-doc@vger.kernel.org; linux-
>kernel@vger.kernel.org; andycham@amazon.com
>Subject: [PATCH] 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.
>

Please add linux-pm list also,

Looks good to me,

Reviewed-by: Durgadoss R <durgadoss.r@intel.com>

Thanks,
Durga

>---
> Documentation/thermal/sysfs-api.txt | 44 ++++++++++++++++++-------------------
> 1 file changed, 22 insertions(+), 22 deletions(-)
>
>diff --git a/Documentation/thermal/sysfs-api.txt b/Documentation/thermal/sysfs-api.txt
>index 8c745c8..5bc73ef 100644
>--- a/Documentation/thermal/sysfs-api.txt
>+++ b/Documentation/thermal/sysfs-api.txt
>@@ -69,8 +69,8 @@ temperature) and throttle appropriate devices.
> 1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
>
>     This interface function removes the thermal zone device.
>-    It deletes the corresponding entry form /sys/class/thermal folder and
>-    unbind all the thermal cooling devices it uses.
>+    It deletes the corresponding entry from /sys/class/thermal folder and
>+    unbinds all the thermal cooling devices it uses.
>
> 1.2 thermal cooling device interface
> 1.2.1 struct thermal_cooling_device *thermal_cooling_device_register(char *name,
>@@ -78,32 +78,32 @@ temperature) and throttle appropriate devices.
>
>     This interface function adds a new thermal cooling device (fan/processor/...)
>     to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
>-    to all the thermal zone devices register at the same time.
>+    to all the thermal zone devices registered at the same time.
>     name: the cooling device name.
>     devdata: device private data.
>     ops: thermal cooling devices call-backs.
> 	.get_max_state: get the Maximum throttle state of the cooling device.
>-	.get_cur_state: get the Current throttle state of the cooling device.
>+	.get_cur_state: get the Currently requested throttle state of the cooling device.
> 	.set_cur_state: set the Current throttle state of the cooling device.
>
> 1.2.2 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
>
>-    This interface function remove the thermal cooling device.
>-    It deletes the corresponding entry form /sys/class/thermal folder and
>-    unbind itself from all the thermal zone devices using it.
>+    This interface function removes the thermal cooling device.
>+    It deletes the corresponding entry from /sys/class/thermal folder and
>+    unbinds itself from all the thermal zone devices using it.
>
> 1.3 interface for binding a thermal zone device with a thermal cooling device
> 1.3.1 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
> 	int trip, struct thermal_cooling_device *cdev,
> 	unsigned long upper, unsigned long lower, unsigned int weight);
>
>-    This interface function bind a thermal cooling device to the certain trip
>+    This interface function binds a thermal cooling device to a particular trip
>     point of a thermal zone device.
>     This function is usually called in the thermal zone device .bind callback.
>     tz: the thermal zone device
>     cdev: thermal cooling device
>-    trip: indicates which trip point the cooling devices is associated with
>-	  in this thermal zone.
>+    trip: indicates which trip point in this thermal zone the cooling device
>+          is associated with.
>     upper:the Maximum cooling state for this trip point.
>           THERMAL_NO_LIMIT means no upper limit,
> 	  and the cooling device can be in max_state.
>@@ -116,13 +116,13 @@ temperature) and throttle appropriate devices.
> 1.3.2 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
> 		int trip, struct thermal_cooling_device *cdev);
>
>-    This interface function unbind a thermal cooling device from the certain
>+    This interface function unbinds a thermal cooling device from a particular
>     trip point of a thermal zone device. This function is usually called in
>     the thermal zone device .unbind callback.
>     tz: the thermal zone device
>     cdev: thermal cooling device
>-    trip: indicates which trip point the cooling devices is associated with
>-	  in this thermal zone.
>+    trip: indicates which trip point in this thermal zone the cooling device
>+          is associated with.
>
> 1.4 Thermal Zone Parameters
> 1.4.1 struct thermal_bind_params
>@@ -142,13 +142,13 @@ temperature) and throttle appropriate devices.
>                this thermal zone and cdev, for a particular trip point.
>                If nth bit is set, then the cdev and thermal zone are bound
>                for trip point n.
>-    .limits: This is an array of cooling state limits. Must have exactly
>-         2 * thermal_zone.number_of_trip_points. It is an array consisting
>-         of tuples <lower-state upper-state> of state limits. Each trip
>-         will be associated with one state limit tuple when binding.
>-         A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
>-         on all trips. These limits are used when binding a cdev to a
>-         trip point.
>+    .binding_limits: This is an array of cooling state limits. Must have
>+                     exactly 2 * thermal_zone.number_of_trip_points. It is an
>+                     array consisting of tuples <lower-state upper-state> of
>+                     state limits. Each trip will be associated with one state
>+                     limit tuple when binding. A NULL pointer means
>+                     <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> on all trips.
>+                     These limits are used when binding a cdev to a trip point.
>     .match: This call back returns success(0) if the 'tz and cdev' need to
> 	    be bound, as per platform data.
> 1.4.2 struct thermal_zone_params
>@@ -283,8 +283,8 @@ cdev[0-*]
> 	RO, Optional
>
> cdev[0-*]_trip_point
>-	The trip point with which cdev[0-*] is associated in this thermal
>-	zone; -1 means the cooling device is not associated with any trip
>+	The trip point in this thermal zone which cdev[0-*] is associated
>+	with; -1 means the cooling device is not associated with any trip
> 	point.
> 	RO, Optional
>
>--
>1.9.1

Re: [PATCH] Syntactic and factual errors in the API document

[Javi Merino]

Hi Andy,

Thanks for improving the documentation!  One minor nit below.  Other
than that, you can add my reviewed-by.

On Tue, Mar 22, 2016 at 12:37:25PM +0000, Andy Champ wrote:
> There are several places where the English in the document is syntactically
> invalid, or unclear. There are also one or two factual errors.
> 
> ---
>  Documentation/thermal/sysfs-api.txt | 44 ++++++++++++++++++-------------------
>  1 file changed, 22 insertions(+), 22 deletions(-)
> 
> diff --git a/Documentation/thermal/sysfs-api.txt b/Documentation/thermal/sysfs-api.txt
> index 8c745c8..5bc73ef 100644
> --- a/Documentation/thermal/sysfs-api.txt
> +++ b/Documentation/thermal/sysfs-api.txt
> @@ -69,8 +69,8 @@ temperature) and throttle appropriate devices.
>  1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device *tz)
>  
>      This interface function removes the thermal zone device.
> -    It deletes the corresponding entry form /sys/class/thermal folder and
> -    unbind all the thermal cooling devices it uses.
> +    It deletes the corresponding entry from /sys/class/thermal folder and
> +    unbinds all the thermal cooling devices it uses.
>  
>  1.2 thermal cooling device interface
>  1.2.1 struct thermal_cooling_device *thermal_cooling_device_register(char *name,
> @@ -78,32 +78,32 @@ temperature) and throttle appropriate devices.
>  
>      This interface function adds a new thermal cooling device (fan/processor/...)
>      to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
> -    to all the thermal zone devices register at the same time.
> +    to all the thermal zone devices registered at the same time.
>      name: the cooling device name.
>      devdata: device private data.
>      ops: thermal cooling devices call-backs.
>  	.get_max_state: get the Maximum throttle state of the cooling device.
> -	.get_cur_state: get the Current throttle state of the cooling device.
> +	.get_cur_state: get the Currently requested throttle state of the cooling device.

Not sure about this one.  It's good that it uses the same language as
set_cur_state.  What's the problem with "Current throttle state"?

>  	.set_cur_state: set the Current throttle state of the cooling device.
>  
>  1.2.2 void thermal_cooling_device_unregister(struct thermal_cooling_device *cdev)
>  
> -    This interface function remove the thermal cooling device.
> -    It deletes the corresponding entry form /sys/class/thermal folder and
> -    unbind itself from all the thermal zone devices using it.
> +    This interface function removes the thermal cooling device.
> +    It deletes the corresponding entry from /sys/class/thermal folder and
> +    unbinds itself from all the thermal zone devices using it.
>  
>  1.3 interface for binding a thermal zone device with a thermal cooling device
>  1.3.1 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
>  	int trip, struct thermal_cooling_device *cdev,
>  	unsigned long upper, unsigned long lower, unsigned int weight);
>  
> -    This interface function bind a thermal cooling device to the certain trip
> +    This interface function binds a thermal cooling device to a particular trip
>      point of a thermal zone device.
>      This function is usually called in the thermal zone device .bind callback.
>      tz: the thermal zone device
>      cdev: thermal cooling device
> -    trip: indicates which trip point the cooling devices is associated with
> -	  in this thermal zone.
> +    trip: indicates which trip point in this thermal zone the cooling device
> +          is associated with.
>      upper:the Maximum cooling state for this trip point.
>            THERMAL_NO_LIMIT means no upper limit,
>  	  and the cooling device can be in max_state.
> @@ -116,13 +116,13 @@ temperature) and throttle appropriate devices.
>  1.3.2 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
>  		int trip, struct thermal_cooling_device *cdev);
>  
> -    This interface function unbind a thermal cooling device from the certain
> +    This interface function unbinds a thermal cooling device from a particular
>      trip point of a thermal zone device. This function is usually called in
>      the thermal zone device .unbind callback.
>      tz: the thermal zone device
>      cdev: thermal cooling device
> -    trip: indicates which trip point the cooling devices is associated with
> -	  in this thermal zone.
> +    trip: indicates which trip point in this thermal zone the cooling device
> +          is associated with.
>  
>  1.4 Thermal Zone Parameters
>  1.4.1 struct thermal_bind_params
> @@ -142,13 +142,13 @@ temperature) and throttle appropriate devices.
>                 this thermal zone and cdev, for a particular trip point.
>                 If nth bit is set, then the cdev and thermal zone are bound
>                 for trip point n.
> -    .limits: This is an array of cooling state limits. Must have exactly
> -         2 * thermal_zone.number_of_trip_points. It is an array consisting
> -         of tuples <lower-state upper-state> of state limits. Each trip
> -         will be associated with one state limit tuple when binding.
> -         A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
> -         on all trips. These limits are used when binding a cdev to a
> -         trip point.
> +    .binding_limits: This is an array of cooling state limits. Must have
> +                     exactly 2 * thermal_zone.number_of_trip_points. It is an
> +                     array consisting of tuples <lower-state upper-state> of
> +                     state limits. Each trip will be associated with one state
> +                     limit tuple when binding. A NULL pointer means
> +                     <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> on all trips.
> +                     These limits are used when binding a cdev to a trip point.
>      .match: This call back returns success(0) if the 'tz and cdev' need to
>  	    be bound, as per platform data.
>  1.4.2 struct thermal_zone_params
> @@ -283,8 +283,8 @@ cdev[0-*]
>  	RO, Optional
>  
>  cdev[0-*]_trip_point
> -	The trip point with which cdev[0-*] is associated in this thermal
> -	zone; -1 means the cooling device is not associated with any trip
> +	The trip point in this thermal zone which cdev[0-*] is associated
> +	with; -1 means the cooling device is not associated with any trip
>  	point.
>  	RO, Optional
>  

RE: [PATCH] Syntactic and factual errors in the API document

[Champ, Andy]

>> Not sure about this one.  It's good that it uses the same language as set_cur_state.  What's the problem with "Current throttle state"?

It's a cooling device, typically a fan. If I set it to 5000RPM, but it's stuck and not going round at all, the API only allows me to ask what I set it to not what it has currently achieved. That's not obvious from the description as it was. Some fans have tachometer feedback, but this API won't give you that data.

The alteration is intended to make it clear that what you get back only tells you what you asked for, not what you actually got. 

Regards
Andy

-----Original Message-----
From: Javi Merino [mailto:javi.merino@arm.com] 
Sent: 22 March 2016 14:36
To: Champ, Andy <andycham@amazon.co.uk>
Cc: edubezval@gmail.com; corbet@lwn.net; durgadoss.r@intel.com; leo.yan@linaro.org; kapileshwar.singh@arm.com; wni@nvidia.com; linux-doc@vger.kernel.org; linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Syntactic and factual errors in the API document

Hi Andy,

Thanks for improving the documentation!  One minor nit below.  Other than that, you can add my reviewed-by.

On Tue, Mar 22, 2016 at 12:37:25PM +0000, Andy Champ wrote:
> There are several places where the English in the document is 
> syntactically invalid, or unclear. There are also one or two factual errors.
> 
> ---
>  Documentation/thermal/sysfs-api.txt | 44 
> ++++++++++++++++++-------------------
>  1 file changed, 22 insertions(+), 22 deletions(-)
> 
> diff --git a/Documentation/thermal/sysfs-api.txt 
> b/Documentation/thermal/sysfs-api.txt
> index 8c745c8..5bc73ef 100644
> --- a/Documentation/thermal/sysfs-api.txt
> +++ b/Documentation/thermal/sysfs-api.txt
> @@ -69,8 +69,8 @@ temperature) and throttle appropriate devices.
>  1.1.2 void thermal_zone_device_unregister(struct thermal_zone_device 
> *tz)
>  
>      This interface function removes the thermal zone device.
> -    It deletes the corresponding entry form /sys/class/thermal folder and
> -    unbind all the thermal cooling devices it uses.
> +    It deletes the corresponding entry from /sys/class/thermal folder and
> +    unbinds all the thermal cooling devices it uses.
>  
>  1.2 thermal cooling device interface
>  1.2.1 struct thermal_cooling_device 
> *thermal_cooling_device_register(char *name, @@ -78,32 +78,32 @@ temperature) and throttle appropriate devices.
>  
>      This interface function adds a new thermal cooling device (fan/processor/...)
>      to /sys/class/thermal/ folder as cooling_device[0-*]. It tries to bind itself
> -    to all the thermal zone devices register at the same time.
> +    to all the thermal zone devices registered at the same time.
>      name: the cooling device name.
>      devdata: device private data.
>      ops: thermal cooling devices call-backs.
>  	.get_max_state: get the Maximum throttle state of the cooling device.
> -	.get_cur_state: get the Current throttle state of the cooling device.
> +	.get_cur_state: get the Currently requested throttle state of the cooling device.

Not sure about this one.  It's good that it uses the same language as set_cur_state.  What's the problem with "Current throttle state"?

>  	.set_cur_state: set the Current throttle state of the cooling device.
>  
>  1.2.2 void thermal_cooling_device_unregister(struct 
> thermal_cooling_device *cdev)
>  
> -    This interface function remove the thermal cooling device.
> -    It deletes the corresponding entry form /sys/class/thermal folder and
> -    unbind itself from all the thermal zone devices using it.
> +    This interface function removes the thermal cooling device.
> +    It deletes the corresponding entry from /sys/class/thermal folder and
> +    unbinds itself from all the thermal zone devices using it.
>  
>  1.3 interface for binding a thermal zone device with a thermal 
> cooling device
>  1.3.1 int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz,
>  	int trip, struct thermal_cooling_device *cdev,
>  	unsigned long upper, unsigned long lower, unsigned int weight);
>  
> -    This interface function bind a thermal cooling device to the certain trip
> +    This interface function binds a thermal cooling device to a 
> + particular trip
>      point of a thermal zone device.
>      This function is usually called in the thermal zone device .bind callback.
>      tz: the thermal zone device
>      cdev: thermal cooling device
> -    trip: indicates which trip point the cooling devices is associated with
> -	  in this thermal zone.
> +    trip: indicates which trip point in this thermal zone the cooling device
> +          is associated with.
>      upper:the Maximum cooling state for this trip point.
>            THERMAL_NO_LIMIT means no upper limit,
>  	  and the cooling device can be in max_state.
> @@ -116,13 +116,13 @@ temperature) and throttle appropriate devices.
>  1.3.2 int thermal_zone_unbind_cooling_device(struct thermal_zone_device *tz,
>  		int trip, struct thermal_cooling_device *cdev);
>  
> -    This interface function unbind a thermal cooling device from the certain
> +    This interface function unbinds a thermal cooling device from a 
> + particular
>      trip point of a thermal zone device. This function is usually called in
>      the thermal zone device .unbind callback.
>      tz: the thermal zone device
>      cdev: thermal cooling device
> -    trip: indicates which trip point the cooling devices is associated with
> -	  in this thermal zone.
> +    trip: indicates which trip point in this thermal zone the cooling device
> +          is associated with.
>  
>  1.4 Thermal Zone Parameters
>  1.4.1 struct thermal_bind_params
> @@ -142,13 +142,13 @@ temperature) and throttle appropriate devices.
>                 this thermal zone and cdev, for a particular trip point.
>                 If nth bit is set, then the cdev and thermal zone are bound
>                 for trip point n.
> -    .limits: This is an array of cooling state limits. Must have exactly
> -         2 * thermal_zone.number_of_trip_points. It is an array consisting
> -         of tuples <lower-state upper-state> of state limits. Each trip
> -         will be associated with one state limit tuple when binding.
> -         A NULL pointer means <THERMAL_NO_LIMITS THERMAL_NO_LIMITS>
> -         on all trips. These limits are used when binding a cdev to a
> -         trip point.
> +    .binding_limits: This is an array of cooling state limits. Must have
> +                     exactly 2 * thermal_zone.number_of_trip_points. It is an
> +                     array consisting of tuples <lower-state upper-state> of
> +                     state limits. Each trip will be associated with one state
> +                     limit tuple when binding. A NULL pointer means
> +                     <THERMAL_NO_LIMITS THERMAL_NO_LIMITS> on all trips.
> +                     These limits are used when binding a cdev to a trip point.
>      .match: This call back returns success(0) if the 'tz and cdev' need to
>  	    be bound, as per platform data.
>  1.4.2 struct thermal_zone_params
> @@ -283,8 +283,8 @@ cdev[0-*]
>  	RO, Optional
>  
>  cdev[0-*]_trip_point
> -	The trip point with which cdev[0-*] is associated in this thermal
> -	zone; -1 means the cooling device is not associated with any trip
> +	The trip point in this thermal zone which cdev[0-*] is associated
> +	with; -1 means the cooling device is not associated with any trip
>  	point.
>  	RO, Optional
>  

Re: [PATCH] Syntactic and factual errors in the API document

[Eduardo Valentin]

Hello Andy,

On Tue, Mar 22, 2016 at 12:37:25PM +0000, Andy Champ wrote:
> There are several places where the English in the document is syntactically
> invalid, or unclear. There are also one or two factual errors.
> 
> ---
>  Documentation/thermal/sysfs-api.txt | 44 ++++++++++++++++++-------------------
>  1 file changed, 22 insertions(+), 22 deletions(-)

Thanks for your patch improving the documentation. I have no comments in
the text correction. The only minor is that the patch title should have
'thermal:' prefix (have a look in the git log
Documentation/thermal/sysfs-api.txt). 

Also, I will get this patch only after the merge window is finished and
my current pending patches queue has been sent and merged.

BR,

Eduardo Valentin

Re: [PATCH] Syntactic and factual errors in the API document

[Eduardo Valentin]

On Tue, Mar 22, 2016 at 09:00:32AM -0700, Eduardo Valentin wrote:
> Hello Andy,
> 
> On Tue, Mar 22, 2016 at 12:37:25PM +0000, Andy Champ wrote:
> > There are several places where the English in the document is syntactically
> > invalid, or unclear. There are also one or two factual errors.

BTW, you are supposed to sign your patches too. I am adding your
signed-off-by here, but next time, remember to sign your patches (have a
look at the Documentation/SubmittingPatches file.

> > 
> > ---
> >  Documentation/thermal/sysfs-api.txt | 44 ++++++++++++++++++-------------------
> >  1 file changed, 22 insertions(+), 22 deletions(-)
> 
> Thanks for your patch improving the documentation. I have no comments in
> the text correction. The only minor is that the patch title should have
> 'thermal:' prefix (have a look in the git log
> Documentation/thermal/sysfs-api.txt). 
> 
> Also, I will get this patch only after the merge window is finished and
> my current pending patches queue has been sent and merged.
> 
> BR,
> 
> Eduardo Valentin

Re: [PATCH] Syntactic and factual errors in the API document

[Jonathan Corbet]

On Tue, 22 Mar 2016 12:37:25 +0000
Andy Champ <andycham@amazon.com> wrote:

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

I went to apply this one to the docs tree, but it no longer applies to
current kernels.  Any chance of getting a respin?

Thanks,

jon

Re: [PATCH] Syntactic and factual errors in the API document

[Champ, Andy]

I thought that _was_ the current kernel (not the obsolete one our chip vendor supports).

Which one do you mean by current? (URL & commit ID would be great!)

Andy
________________________________________
From: Jonathan Corbet <corbet@lwn.net>
Sent: 31 March 2016 07:43
To: Champ, Andy
Cc: edubezval@gmail.com; javi.merino@arm.com; durgadoss.r@intel.com; leo.yan@linaro.org; kapileshwar.singh@arm.com; wni@nvidia.com; linux-doc@vger.kernel.org; linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Syntactic and factual errors in the API document

On Tue, 22 Mar 2016 12:37:25 +0000
Andy Champ <andycham@amazon.com> wrote:

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

I went to apply this one to the docs tree, but it no longer applies to
current kernels.  Any chance of getting a respin?

Thanks,

jon

Re: [PATCH] Syntactic and factual errors in the API document

[Javi Merino]

On Thu, Mar 31, 2016 at 08:32:26AM +0000, Champ, Andy wrote:
> I thought that _was_ the current kernel (not the obsolete one our chip vendor supports).
> 
> Which one do you mean by current? (URL & commit ID would be great!)

You can find it in the MAINTAINERS file.  I think Jon refers to 

git://git.lwn.net/linux.git docs-next

Cheers,
Javi

> ________________________________________
> From: Jonathan Corbet <corbet@lwn.net>
> Sent: 31 March 2016 07:43
> To: Champ, Andy
> Cc: edubezval@gmail.com; javi.merino@arm.com; durgadoss.r@intel.com; leo.yan@linaro.org; kapileshwar.singh@arm.com; wni@nvidia.com; linux-doc@vger.kernel.org; linux-kernel@vger.kernel.org
> Subject: Re: [PATCH] Syntactic and factual errors in the API document
> 
> On Tue, 22 Mar 2016 12:37:25 +0000
> Andy Champ <andycham@amazon.com> wrote:
> 
> > There are several places where the English in the document is syntactically
> > invalid, or unclear. There are also one or two factual errors.
> 
> I went to apply this one to the docs tree, but it no longer applies to
> current kernels.  Any chance of getting a respin?
> 
> Thanks,
> 
> jon
> 
> 
> 

Re: [PATCH] Syntactic and factual errors in the API document

[Champ, Andy]

Hi All,

I've added remote git://git.lwn.net/linux.git to my tree. docs-next looks to point to commit 4817ebb144ffa5a1a2bc84b89ed9655dbe6c4502, and my patch applies cleanly to that commit.

Jonathan, what problem did you have?

Regards

Andy
________________________________________
From: Javi Merino <javi.merino@arm.com>
Sent: 31 March 2016 09:58
To: Champ, Andy
Cc: Jonathan Corbet; edubezval@gmail.com; durgadoss.r@intel.com; leo.yan@linaro.org; kapileshwar.singh@arm.com; wni@nvidia.com; linux-doc@vger.kernel.org; linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Syntactic and factual errors in the API document

On Thu, Mar 31, 2016 at 08:32:26AM +0000, Champ, Andy wrote:
> I thought that _was_ the current kernel (not the obsolete one our chip vendor supports).
>
> Which one do you mean by current? (URL & commit ID would be great!)

You can find it in the MAINTAINERS file.  I think Jon refers to

git://git.lwn.net/linux.git docs-next

Cheers,
Javi

> ________________________________________
> From: Jonathan Corbet <corbet@lwn.net>
> Sent: 31 March 2016 07:43
> To: Champ, Andy
> Cc: edubezval@gmail.com; javi.merino@arm.com; durgadoss.r@intel.com; leo.yan@linaro.org; kapileshwar.singh@arm.com; wni@nvidia.com; linux-doc@vger.kernel.org; linux-kernel@vger.kernel.org
> Subject: Re: [PATCH] Syntactic and factual errors in the API document
>
> On Tue, 22 Mar 2016 12:37:25 +0000
> Andy Champ <andycham@amazon.com> wrote:
>
> > There are several places where the English in the document is syntactically
> > invalid, or unclear. There are also one or two factual errors.
>
> I went to apply this one to the docs tree, but it no longer applies to
> current kernels.  Any chance of getting a respin?
>
> Thanks,
>
> jon
>
>
>

Re: [PATCH] Syntactic and factual errors in the API document

[Eduardo Valentin]

On Thu, Mar 31, 2016 at 12:43:22AM -0600, Jonathan Corbet wrote:
> On Tue, 22 Mar 2016 12:37:25 +0000
> Andy Champ <andycham@amazon.com> wrote:
> 
> > There are several places where the English in the document is syntactically
> > invalid, or unclear. There are also one or two factual errors.
> 
> I went to apply this one to the docs tree, but it no longer applies to
> current kernels.  Any chance of getting a respin?

Jonanthan,

I applied this one into the thermal-soc tree. But if you are willing to
add it via the documentation tree, let me know, I can drop it from my
-fixes branch.

> 
> Thanks,
> 
> jon

Re: [PATCH] Syntactic and factual errors in the API document

[Jonathan Corbet]

On Thu, 31 Mar 2016 19:35:32 -0700
Eduardo Valentin <edubezval@gmail.com> wrote:

> I applied this one into the thermal-soc tree. But if you are willing to
> add it via the documentation tree, let me know, I can drop it from my
> -fixes branch.

Up to you, but, if it's already captured in a tree and on its way
Linusward, I don't see a whole lot of point in messing with it.

Thanks,

jon