From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S935928Ab3DQPYs (ORCPT ); Wed, 17 Apr 2013 11:24:48 -0400 Received: from mga02.intel.com ([134.134.136.20]:22429 "EHLO mga02.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S933146Ab3DQPYq (ORCPT ); Wed, 17 Apr 2013 11:24:46 -0400 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="4.87,494,1363158000"; d="scan'208";a="319730892" Message-ID: <1366212281.2091.59.camel@rzhang1-mobl4> Subject: Re: [PATCH RESEND 11/11] thermal: update kernel-doc for thermal_zone_device_register From: Zhang Rui To: Eduardo Valentin Cc: linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org Date: Wed, 17 Apr 2013 23:24:41 +0800 In-Reply-To: <1365437258-31412-12-git-send-email-eduardo.valentin@ti.com> References: <1365437258-31412-1-git-send-email-eduardo.valentin@ti.com> <1365437258-31412-12-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_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. 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,