From: Eduardo Valentin <eduardo.valentin@ti.com>
To: rui.zhang@intel.com
Cc: linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
Eduardo Valentin <eduardo.valentin@ti.com>
Subject: [PATCH RESEND 11/11] thermal: update kernel-doc for thermal_zone_device_register
Date: Mon, 8 Apr 2013 12:07:38 -0400 [thread overview]
Message-ID: <1365437258-31412-12-git-send-email-eduardo.valentin@ti.com> (raw)
In-Reply-To: <1365437258-31412-1-git-send-email-eduardo.valentin@ti.com>
This patch updates the documentation for thermal_zone_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 4cff199..5bd95d4 100644
--- a/drivers/thermal/thermal_sys.c
+++ b/drivers/thermal/thermal_sys.c
@@ -1568,7 +1568,7 @@ static void remove_trip_attrs(struct thermal_zone_device *tz)
}
/**
- * thermal_zone_device_register - register a new thermal zone device
+ * thermal_zone_device_register() - register a new thermal zone device
* @type: the thermal zone device type
* @trips: the number of trip points the thermal zone support
* @mask: a bit string indicating the writeablility of trip points
@@ -1581,8 +1581,15 @@ static void remove_trip_attrs(struct thermal_zone_device *tz)
* whether trip points have been crossed (0 for interrupt
* driven systems)
*
+ * This interface function adds a new thermal zone device (sensor) to
+ * /sys/class/thermal folder as thermal_zone[0-*]. It tries to bind all the
+ * thermal cooling devices registered at the same time.
* thermal_zone_device_unregister() must be called when the device is no
* longer needed. The passive cooling depends on the .get_trend() return value.
+ *
+ * Return: a pointer to the created struct thermal_zone_device or an
+ * in case of error, an ERR_PTR. Caller must check return value with
+ * IS_ERR*() helpers.
*/
struct thermal_zone_device *thermal_zone_device_register(const char *type,
int trips, int mask, void *devdata,
--
1.7.7.1.488.ge8e1c
next prev parent reply other threads:[~2013-04-08 16:07 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-04-08 16:07 From: Eduardo Valentin <eduardo.valentin@ti.com> Eduardo Valentin
2013-04-08 16:07 ` [PATCH RESEND 01/11] thermal: use strlcpy instead of strcpy Eduardo Valentin
2013-04-17 15:36 ` Zhang Rui
2013-04-08 16:07 ` [PATCH RESEND 02/11] thermal: update driver license Eduardo Valentin
2013-04-08 16:07 ` [PATCH RESEND 03/11] thermal: rename notify_thermal_framework to thermal_notify_framework Eduardo Valentin
2013-04-17 15:37 ` Zhang Rui
2013-04-08 16:07 ` [PATCH RESEND 04/11] thermal: rename get_thermal_instance to thermal_instance_get Eduardo Valentin
2013-04-17 15:09 ` Zhang Rui
2013-04-17 19:18 ` Eduardo Valentin
2013-04-08 16:07 ` [PATCH RESEND 05/11] thermal: rename get_tz_trend to thermal_zone_trend_get Eduardo Valentin
2013-04-17 15:10 ` Zhang Rui
2013-04-17 19:20 ` Eduardo Valentin
2013-04-08 16:07 ` [PATCH RESEND 06/11] thermal: use EXPORT_SYMBOL_GPL Eduardo Valentin
2013-04-17 15:20 ` Zhang Rui
2013-04-17 19:22 ` Eduardo Valentin
2013-04-08 16:07 ` [PATCH RESEND 07/11] thermal: update kernel-doc for thermal_zone_bind_cooling_device Eduardo Valentin
2013-04-17 15:26 ` Zhang Rui
2013-04-17 15:28 ` Zhang Rui
2013-04-17 19:24 ` Eduardo Valentin
2013-04-08 16:07 ` [PATCH RESEND 08/11] thermal: update kernel-doc for thermal_zone_unbind_cooling_device Eduardo Valentin
2013-04-17 15:29 ` Zhang Rui
2013-04-08 16:07 ` [PATCH RESEND 09/11] thermal: update kernel-doc for thermal_cooling_device_register Eduardo Valentin
2013-04-17 15:31 ` Zhang Rui
2013-04-17 19:25 ` Eduardo Valentin
2013-04-08 16:07 ` [PATCH RESEND 10/11] thermal: update kernel-doc for create_trip_attrs Eduardo Valentin
2013-04-17 15:31 ` Zhang Rui
2013-04-08 16:07 ` Eduardo Valentin [this message]
2013-04-17 15:24 ` [PATCH RESEND 11/11] thermal: update kernel-doc for thermal_zone_device_register Zhang Rui
2013-04-17 19:30 ` Eduardo Valentin
2013-04-24 16:50 ` Zhang, Rui
2013-04-17 17:15 ` From: Eduardo Valentin <eduardo.valentin@ti.com> Eduardo Valentin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1365437258-31412-12-git-send-email-eduardo.valentin@ti.com \
--to=eduardo.valentin@ti.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=rui.zhang@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).