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

[Eduardo Valentin]

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 <eduardo.valentin@xxxxxx>
>
>
> > ---
> >   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,

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/