On Mon, 2013-04-08 at 12:07 -0400, Eduardo Valentin wrote: > This patch updates the documentation for thermal_zone_bind_cooling_device > and removes the warnings generated by scripts/kernel-doc -v. > > Signed-off-by: Eduardo Valentin <eduardo.valen...@ti.com> > --- > drivers/thermal/thermal_sys.c | 16 +++++++++++++--- > 1 files changed, 13 insertions(+), 3 deletions(-) > > diff --git a/drivers/thermal/thermal_sys.c b/drivers/thermal/thermal_sys.c > index 602596e..8acaab6 100644 > --- a/drivers/thermal/thermal_sys.c > +++ b/drivers/thermal/thermal_sys.c > @@ -1097,13 +1097,23 @@ thermal_remove_hwmon_sysfs(struct thermal_zone_device > *tz) > #endif > > /** > - * thermal_zone_bind_cooling_device - bind a cooling device to a thermal zone > - * @tz: thermal zone device > + * thermal_zone_bind_cooling_device() - bind a cooling device to a thermal > zone > + * @tz: pointer to struct thermal_zone_device > * @trip: indicates which trip point the cooling devices is > * associated with in this thermal zone. > - * @cdev: thermal cooling device > + * @cdev: pointer to struct thermal_cooling_device > + * @upper: the Maximum cooling state for this trip point. > + * THERMAL_NO_LIMIT means no upper limit, > + * and the cooling device can be in max_state. > + * @lower: the Minimum cooling state can be used for this trip point. > + * THERMAL_NO_LIMIT means no lower limit, > + * and the cooling device can be in cooling state 0. > * good catch. But we miss this in the comments in drivers/thermal/thermal_core.c as well.
thanks, rui > + * This interface function bind a thermal cooling device to the certain trip > + * point of a thermal zone device. > * This function is usually called in the thermal zone device .bind callback. > + * > + * Return: 0 on success, the proper error value otherwise. > */ > int thermal_zone_bind_cooling_device(struct thermal_zone_device *tz, > int trip, -- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
