From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S965067Ab3DQP04 (ORCPT ); Wed, 17 Apr 2013 11:26:56 -0400 Received: from mga03.intel.com ([143.182.124.21]:38320 "EHLO mga03.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933146Ab3DQP0z (ORCPT ); Wed, 17 Apr 2013 11:26:55 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="4.87,494,1363158000"; d="scan'208";a="228357655" Message-ID: <1366212385.2091.60.camel@rzhang1-mobl4> Subject: Re: [PATCH RESEND 07/11] thermal: update kernel-doc for thermal_zone_bind_cooling_device From: Zhang Rui To: Eduardo Valentin Cc: linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org Date: Wed, 17 Apr 2013 23:26:25 +0800 In-Reply-To: <1365437258-31412-8-git-send-email-eduardo.valentin@ti.com> References: <1365437258-31412-1-git-send-email-eduardo.valentin@ti.com> <1365437258-31412-8-git-send-email-eduardo.valentin@ti.com> Content-Type: text/plain; charset="UTF-8" X-Mailer: Evolution 3.2.3-0ubuntu6 Content-Transfer-Encoding: 7bit Mime-Version: 1.0 Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 > --- > 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,