diff mbox

[RESEND,09/11] thermal: update kernel-doc for thermal_cooling_device_register

Message ID 1365437258-31412-10-git-send-email-eduardo.valentin@ti.com (mailing list archive)
State Superseded, archived
Delegated to: Zhang Rui
Headers show

Commit Message

Eduardo Valentin April 8, 2013, 4:07 p.m. UTC
This patch updates the documentation for thermal_cooling_device_register
and removes the warnings generated by scripts/kernel-doc -v.

Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
---
 drivers/thermal/thermal_sys.c |    9 ++++++++-
 1 files changed, 8 insertions(+), 1 deletions(-)

Comments

Zhang, Rui April 17, 2013, 3:31 p.m. UTC | #1
On Mon, 2013-04-08 at 12:07 -0400, Eduardo Valentin wrote:
> This patch updates the documentation for thermal_cooling_device_register
> and removes the warnings generated by scripts/kernel-doc -v.
> 
> Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
> ---
>  drivers/thermal/thermal_sys.c |    9 ++++++++-
>  1 files changed, 8 insertions(+), 1 deletions(-)
> 
> diff --git a/drivers/thermal/thermal_sys.c b/drivers/thermal/thermal_sys.c
> index 98d7d53..f3a4e17 100644
> --- a/drivers/thermal/thermal_sys.c
> +++ b/drivers/thermal/thermal_sys.c
> @@ -1275,10 +1275,17 @@ static struct class thermal_class = {
>  };
>  
>  /**
> - * thermal_cooling_device_register - register a new thermal cooling device
> + * thermal_cooling_device_register() - register a new thermal cooling device
>   * @type:	the thermal cooling device type.
>   * @devdata:	device private data.
>   * @ops:		standard thermal cooling devices callbacks.
> + *
> + * 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.

s/register/registered ?

thanks,
rui
> + *
> + * Return: a pointer to the created struct thermal_cooling_device or an
> + * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
>   */
>  struct thermal_cooling_device *
>  thermal_cooling_device_register(char *type, void *devdata,


--
To unsubscribe from this list: send the line "unsubscribe linux-pm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Eduardo Valentin April 17, 2013, 7:25 p.m. UTC | #2
On 17-04-2013 11:31, Zhang Rui wrote:
> On Mon, 2013-04-08 at 12:07 -0400, Eduardo Valentin wrote:
>> This patch updates the documentation for thermal_cooling_device_register
>> and removes the warnings generated by scripts/kernel-doc -v.
>>
>> Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
>> ---
>>   drivers/thermal/thermal_sys.c |    9 ++++++++-
>>   1 files changed, 8 insertions(+), 1 deletions(-)
>>
>> diff --git a/drivers/thermal/thermal_sys.c b/drivers/thermal/thermal_sys.c
>> index 98d7d53..f3a4e17 100644
>> --- a/drivers/thermal/thermal_sys.c
>> +++ b/drivers/thermal/thermal_sys.c
>> @@ -1275,10 +1275,17 @@ static struct class thermal_class = {
>>   };
>>
>>   /**
>> - * thermal_cooling_device_register - register a new thermal cooling device
>> + * thermal_cooling_device_register() - register a new thermal cooling device
>>    * @type:	the thermal cooling device type.
>>    * @devdata:	device private data.
>>    * @ops:		standard thermal cooling devices callbacks.
>> + *
>> + * 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.
>
> s/register/registered ?

Indeed, will add this and resend.

>
> thanks,
> rui
>> + *
>> + * Return: a pointer to the created struct thermal_cooling_device or an
>> + * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
>>    */
>>   struct thermal_cooling_device *
>>   thermal_cooling_device_register(char *type, void *devdata,
>
>
> --
> To unsubscribe from this list: send the line "unsubscribe linux-pm" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
>
>

--
To unsubscribe from this list: send the line "unsubscribe linux-pm" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/drivers/thermal/thermal_sys.c b/drivers/thermal/thermal_sys.c
index 98d7d53..f3a4e17 100644
--- a/drivers/thermal/thermal_sys.c
+++ b/drivers/thermal/thermal_sys.c
@@ -1275,10 +1275,17 @@  static struct class thermal_class = {
 };
 
 /**
- * thermal_cooling_device_register - register a new thermal cooling device
+ * thermal_cooling_device_register() - register a new thermal cooling device
  * @type:	the thermal cooling device type.
  * @devdata:	device private data.
  * @ops:		standard thermal cooling devices callbacks.
+ *
+ * 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.
+ *
+ * Return: a pointer to the created struct thermal_cooling_device or an
+ * ERR_PTR. Caller must check return value with IS_ERR*() helpers.
  */
 struct thermal_cooling_device *
 thermal_cooling_device_register(char *type, void *devdata,