diff mbox

[RESEND,10/11] thermal: update kernel-doc for create_trip_attrs

Message ID 1365437258-31412-11-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 create_trip_attrs
and removes the warnings generated by scripts/kernel-doc -v.

Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
---
 drivers/thermal/thermal_sys.c |    7 ++++++-
 1 files changed, 6 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 create_trip_attrs
> and removes the warnings generated by scripts/kernel-doc -v.
> 
> Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>

this one looks okay to me.

thanks,
rui
> ---
>  drivers/thermal/thermal_sys.c |    7 ++++++-
>  1 files changed, 6 insertions(+), 1 deletions(-)
> 
> diff --git a/drivers/thermal/thermal_sys.c b/drivers/thermal/thermal_sys.c
> index f3a4e17..4cff199 100644
> --- a/drivers/thermal/thermal_sys.c
> +++ b/drivers/thermal/thermal_sys.c
> @@ -1460,9 +1460,14 @@ void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
>  EXPORT_SYMBOL_GPL(thermal_notify_framework);
>  
>  /**
> - * create_trip_attrs - create attributes for trip points
> + * create_trip_attrs() - create attributes for trip points
>   * @tz:		the thermal zone device
>   * @mask:	Writeable trip point bitmap.
> + *
> + * helper function to instantiate sysfs entries for every trip
> + * point and its properties of a struct thermal_zone_device.
> + *
> + * Return: 0 on success, the proper error value otherwise.
>   */
>  static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
>  {


--
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 f3a4e17..4cff199 100644
--- a/drivers/thermal/thermal_sys.c
+++ b/drivers/thermal/thermal_sys.c
@@ -1460,9 +1460,14 @@  void thermal_notify_framework(struct thermal_zone_device *tz, int trip)
 EXPORT_SYMBOL_GPL(thermal_notify_framework);
 
 /**
- * create_trip_attrs - create attributes for trip points
+ * create_trip_attrs() - create attributes for trip points
  * @tz:		the thermal zone device
  * @mask:	Writeable trip point bitmap.
+ *
+ * helper function to instantiate sysfs entries for every trip
+ * point and its properties of a struct thermal_zone_device.
+ *
+ * Return: 0 on success, the proper error value otherwise.
  */
 static int create_trip_attrs(struct thermal_zone_device *tz, int mask)
 {