RE: [PATCH RESEND 11/11] thermal: update kernel-doc for thermal_zone_device_register

From: "Zhang, Rui" <rui.zhang@intel.com>
To: Eduardo Valentin <eduardo.valentin@ti.com>
Cc: "linux-pm@vger.kernel.org" <linux-pm@vger.kernel.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>
Subject: RE: [PATCH RESEND 11/11] thermal: update kernel-doc for thermal_zone_device_register
Date: Wed, 24 Apr 2013 16:50:17 +0000	[thread overview]
Message-ID: <744357E9AAD1214791ACBA4B0B9092632CA0FC@SHSMSX101.ccr.corp.intel.com> (raw)
In-Reply-To: <516EF839.9090500@ti.com>

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset="utf-8", Size: 3176 bytes --]

> -----Original Message-----
> From: Eduardo Valentin [mailto:eduardo.valentin@ti.com]
> Sent: Thursday, April 18, 2013 3:30 AM
> To: Zhang, Rui
> Cc: Eduardo Valentin; linux-pm@vger.kernel.org; linux-
> kernel@vger.kernel.org
> Subject: Re: [PATCH RESEND 11/11] thermal: update kernel-doc for
> thermal_zone_device_register
> Importance: High
> 
> 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..
> 

Sorry, I was not clear enough.
I mean we need to update Documentation/thermal/sysfs-api.txt as well,
for thermal_zone_device_register.
Patch will be sent out soon.

Thanks,
rui
> 
> > thanks,
> > rui
> >> 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,
> >
> >
> >
> >

ÿôèº{.nÇ+‰·Ÿ®‰†+%ŠËÿ±éÝ¶\x17¥Šwÿº{.nÇ+‰·¥Š{±þG«éÿŠ{ayº\x1dÊ‡Ú™ë,j\a¢f£¢·hšïêÿ‘êçz_è®\x03(éšŽŠÝ¢j"ú\x1a¶^[m§ÿÿ¾\a«þG«éÿ¢¸?™¨èÚ&£ø§~á¶iO•æ¬z·švØ^\x14\x04\x1a¶^[m§ÿÿÃ\fÿ¶ìÿ¢¸?–I¥