LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
From: Eduardo Valentin <edubezval@gmail.com>
To: Rui Zhang <rui.zhang@intel.com>,
	ezequiel.garcia@free-electrons.com, amit.kachhap@linaro.org,
	viresh.kumar@linaro.org, amit.daniel@samsung.com,
	hongbo.zhang@linaro.com, andrew@lunn.ch, durgadoss.r@intel.com,
	peter@piie.net, shawn.guo@linaro.org, aaron.lu@intel.com,
	caesar.wang@rock-chips.com, b.zolnierkie@samsung.com,
	l.majewski@samsung.com, vincenzo.frascino@st.com,
	mperttunen@nvidia.com, mikko.perttunen@kapsi.fi,
	srinivas.pandruvada@linux.intel.com,
	jacob.jun.pan@linux.intel.com, bcousson@baylibre.com
Cc: LKML <linux-kernel@vger.kernel.org>,
	Linux PM <linux-pm@vger.kernel.org>,
	Eduardo Valentin <edubezval@gmail.com>
Subject: [PATCH RFC 10/12] thermal: bang bang: fix kernel doc entry
Date: Mon,  9 Feb 2015 17:34:11 -0400	[thread overview]
Message-ID: <1423517653-11359-11-git-send-email-edubezval@gmail.com> (raw)
In-Reply-To: <1423517653-11359-1-git-send-email-edubezval@gmail.com>

Update kernel doc entry and correct the format. Now
kernel doc does not complain about it.

Signed-off-by: Eduardo Valentin <edubezval@gmail.com>
---
 drivers/thermal/gov_bang_bang.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/thermal/gov_bang_bang.c b/drivers/thermal/gov_bang_bang.c
index c5dd76b..5154929 100644
--- a/drivers/thermal/gov_bang_bang.c
+++ b/drivers/thermal/gov_bang_bang.c
@@ -74,8 +74,8 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip)
 
 /**
  * bang_bang_control - controls devices associated with the given zone
- * @tz - thermal_zone_device
- * @trip - the trip point
+ * @tz: thermal_zone_device
+ * @trip: the trip point
  *
  * Regulation Logic: a two point regulation, deliver cooling state depending
  * on the previous state shown in this diagram:
@@ -98,6 +98,7 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip)
  *   * In case the fan is running, temperature must fall below
  *     (trip_temp - hyst) so that the fan gets turned off again.
  *
+ * Return: 0.
  */
 static int bang_bang_control(struct thermal_zone_device *tz, int trip)
 {
-- 
2.1.3


  parent reply	other threads:[~2015-02-10  0:38 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-02-09 21:34 [PATCH RFC 00/12] The Linux Kernel Thermal Framework Docbook Eduardo Valentin
2015-02-09 21:34 ` [PATCH RFC 01/12] Documentation: Introduce Linux Kernel Thermal Framework DocBook Eduardo Valentin
2015-02-10 22:50   ` Randy Dunlap
2015-02-16 15:17     ` Eduardo Valentin
2015-02-18 11:13   ` Javi Merino
2015-02-09 21:34 ` [PATCH RFC 02/12] Documentation: thermal docbook: add glossary Eduardo Valentin
2015-02-10 22:50   ` Randy Dunlap
2015-02-16 15:19     ` Eduardo Valentin
2015-02-16 13:01   ` Mikko Perttunen
2015-02-17  3:22     ` Eduardo Valentin
2015-02-18 11:52   ` Javi Merino
2015-02-18 16:58     ` Srinivas Pandruvada
2015-02-17  3:27       ` Eduardo Valentin
2015-02-09 21:34 ` [PATCH RFC 03/12] thermal: cpu_cooling: remove duplicate documentation entries Eduardo Valentin
2015-02-09 21:34 ` [PATCH RFC 04/12] thermal: of-thermal: remove kernel doc warn Eduardo Valentin
2015-02-09 21:34 ` [PATCH RFC 05/12] thermal: thermal.h: minor kernel doc fix Eduardo Valentin
2015-02-09 21:34 ` [PATCH RFC 06/12] thermal: thermal_core: correct kernel doc wording on thermal_zone_get_temp Eduardo Valentin
2015-02-09 21:34 ` [PATCH RFC 07/12] Documentation: thermal docbook: introduce API reference chapter Eduardo Valentin
2015-02-09 21:34 ` [PATCH RFC 08/12] thermal: fair share: fix kernel doc entry Eduardo Valentin
2015-02-09 21:34 ` [PATCH RFC 09/12] thermal: user space: " Eduardo Valentin
2015-02-09 21:34 ` Eduardo Valentin [this message]
2015-02-09 21:34 ` [PATCH RFC 11/12] thermal: step wise: " Eduardo Valentin
2015-02-09 21:34 ` [PATCH RFC 12/12] Documentation: thermal docbook: introduce governor chapter Eduardo Valentin
2015-02-18 16:21   ` Javi Merino

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1423517653-11359-11-git-send-email-edubezval@gmail.com \
    --to=edubezval@gmail.com \
    --cc=aaron.lu@intel.com \
    --cc=amit.daniel@samsung.com \
    --cc=amit.kachhap@linaro.org \
    --cc=andrew@lunn.ch \
    --cc=b.zolnierkie@samsung.com \
    --cc=bcousson@baylibre.com \
    --cc=caesar.wang@rock-chips.com \
    --cc=durgadoss.r@intel.com \
    --cc=ezequiel.garcia@free-electrons.com \
    --cc=hongbo.zhang@linaro.com \
    --cc=jacob.jun.pan@linux.intel.com \
    --cc=l.majewski@samsung.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=mikko.perttunen@kapsi.fi \
    --cc=mperttunen@nvidia.com \
    --cc=peter@piie.net \
    --cc=rui.zhang@intel.com \
    --cc=shawn.guo@linaro.org \
    --cc=srinivas.pandruvada@linux.intel.com \
    --cc=vincenzo.frascino@st.com \
    --cc=viresh.kumar@linaro.org \
    --subject='Re: [PATCH RFC 10/12] thermal: bang bang: fix kernel doc entry' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).