From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1758445Ab3DQTaU (ORCPT ); Wed, 17 Apr 2013 15:30:20 -0400 Received: from comal.ext.ti.com ([198.47.26.152]:48337 "EHLO comal.ext.ti.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1756126Ab3DQTaP (ORCPT ); Wed, 17 Apr 2013 15:30:15 -0400 Message-ID: <516EF839.9090500@ti.com> Date: Wed, 17 Apr 2013 15:30:01 -0400 From: Eduardo Valentin User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130308 Thunderbird/17.0.4 MIME-Version: 1.0 To: Zhang Rui CC: Eduardo Valentin , , Subject: Re: [PATCH RESEND 11/11] thermal: update kernel-doc for thermal_zone_device_register References: <1365437258-31412-1-git-send-email-eduardo.valentin@ti.com> <1365437258-31412-12-git-send-email-eduardo.valentin@ti.com> <1366212281.2091.59.camel@rzhang1-mobl4> In-Reply-To: <1366212281.2091.59.camel@rzhang1-mobl4> Content-Type: text/plain; charset="UTF-8"; format=flowed Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 17-04-2013 11:24, Zhang Rui wrote: > On Mon, 2013-04-08 at 12:07 -0400, Eduardo Valentin wrote: >> This patch updates the documentation for thermal_zone_device_register > > it is not enough. > parameters including const struct thermal_zone_params *tzp, > int passive_delay, and int polling_delay are missing in the > documentation. > no Rui, I guess you were already too sleepy as you said. :-) The patch is just an update. There are some entries already in the comment. The parameters you mentioned are already there, thats why you dont see in my patch.. > thanks, > rui >> and removes the warnings generated by scripts/kernel-doc -v. >> >> Signed-off-by: Eduardo Valentin > > >> --- >> 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, > > > >