Re: [PATCH 06/11] thermal: mediatek: Appease the kernel-doc deity

From: Viresh Kumar <viresh.kumar@linaro•org>
To: Amit Kucheria <amit.kucheria@linaro•org>
Cc: Amit Kucheria <amit.kucheria@verdurent•com>,
	Heiko Stuebner <heiko@sntech•de>,
	Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung•com>,
	Amit Daniel Kachhap <amit.kachhap@gmail•com>,
	Daniel Lezcano <daniel.lezcano@linaro•org>,
	linux-mediatek@lists•infradead.org, linux-kernel@vger•kernel.org,
	Krzysztof Kozlowski <krzk@kernel•org>,
	Jonathan Hunter <jonathanh@nvidia•com>,
	edubezval@gmail•com, Kukjin Kim <kgene@kernel•org>,
	Guillaume La Roque <glaroque@baylibre•com>,
	linux-pm@vger•kernel.org,
	Matthias Brugger <matthias.bgg@gmail•com>,
	Thierry Reding <thierry.reding@gmail•com>,
	Jun Nie <jun.nie@linaro•org>,
	Javi Merino <javi.merino@kernel•org>,
	Shawn Guo <shawnguo@kernel•org>, Zhang Rui <rui.zhang@intel•com>,
	linux-arm-kernel@lists•infradead.org
Subject: Re: [PATCH 06/11] thermal: mediatek: Appease the kernel-doc deity
Date: Thu, 7 Nov 2019 07:50:12 +0530	[thread overview]
Message-ID: <20191107022012.o7wfyoerhomc3ztu@vireshk-i7> (raw)
In-Reply-To: <20191107021929.hsuyzswcl27n7wqt@vireshk-i7>

On 07-11-19, 07:49, Viresh Kumar wrote:
> On 06-11-19, 18:58, Amit Kucheria wrote:
> > Replace a comment starting with /** by simply /* to avoid having it
> > interpreted as a kernel-doc comment. Describe missing function
> > parameters where needed.
> > 
> > Fixes up the following warnings when compiled with make W=1:
> > 
> > linux.git/drivers/thermal/mtk_thermal.c:374: warning: cannot understand
> > function prototype: 'const struct mtk_thermal_data mt8173_thermal_data =
> > '
> > linux.git/drivers/thermal/mtk_thermal.c:413: warning: cannot understand
> > function prototype: 'const struct mtk_thermal_data mt2701_thermal_data =
> > '
> > linux.git/drivers/thermal/mtk_thermal.c:443: warning: cannot understand
> > function prototype: 'const struct mtk_thermal_data mt2712_thermal_data =
> > '
> > linux.git/drivers/thermal/mtk_thermal.c:499: warning: cannot understand
> > function prototype: 'const struct mtk_thermal_data mt8183_thermal_data =
> > '
> > linux.git/drivers/thermal/mtk_thermal.c:529: warning: Function parameter
> > or member 'sensno' not described in 'raw_to_mcelsius'
> > 
> > Signed-off-by: Amit Kucheria <amit.kucheria@linaro•org>
> > ---
> >  drivers/thermal/mtk_thermal.c | 12 ++++++------
> >  1 file changed, 6 insertions(+), 6 deletions(-)
> > 
> > diff --git a/drivers/thermal/mtk_thermal.c b/drivers/thermal/mtk_thermal.c
> > index acf4854cbb8b8..76e30603d4d58 100644
> > --- a/drivers/thermal/mtk_thermal.c
> > +++ b/drivers/thermal/mtk_thermal.c
> > @@ -358,7 +358,7 @@ static const int mt7622_mux_values[MT7622_NUM_SENSORS] = { 0, };
> >  static const int mt7622_vts_index[MT7622_NUM_SENSORS] = { VTS1 };
> >  static const int mt7622_tc_offset[MT7622_NUM_CONTROLLER] = { 0x0, };
> >  
> > -/**
> > +/*
> >   * The MT8173 thermal controller has four banks. Each bank can read up to
> >   * four temperature sensors simultaneously. The MT8173 has a total of 5
> >   * temperature sensors. We use each bank to measure a certain area of the
> > @@ -400,7 +400,7 @@ static const struct mtk_thermal_data mt8173_thermal_data = {
> >  	.sensor_mux_values = mt8173_mux_values,
> >  };
> >  
> > -/**
> > +/*
> >   * The MT2701 thermal controller has one bank, which can read up to
> >   * three temperature sensors simultaneously. The MT2701 has a total of 3
> >   * temperature sensors.
> > @@ -430,7 +430,7 @@ static const struct mtk_thermal_data mt2701_thermal_data = {
> >  	.sensor_mux_values = mt2701_mux_values,
> >  };
> >  
> > -/**
> > +/*
> >   * The MT2712 thermal controller has one bank, which can read up to
> >   * four temperature sensors simultaneously. The MT2712 has a total of 4
> >   * temperature sensors.
> > @@ -484,7 +484,7 @@ static const struct mtk_thermal_data mt7622_thermal_data = {
> >  	.sensor_mux_values = mt7622_mux_values,
> >  };
> >  
> > -/**
> > +/*
> >   * The MT8183 thermal controller has one bank for the current SW framework.
> >   * The MT8183 has a total of 6 temperature sensors.
> >   * There are two thermal controller to control the six sensor.
> > @@ -495,7 +495,6 @@ static const struct mtk_thermal_data mt7622_thermal_data = {
> >   * data, and this indeed needs the temperatures of the individual banks
> >   * for making better decisions.
> >   */
> > -
> >  static const struct mtk_thermal_data mt8183_thermal_data = {
> >  	.auxadc_channel = MT8183_TEMP_AUXADC_CHANNEL,
> >  	.num_banks = MT8183_NUM_SENSORS_PER_ZONE,
> > @@ -519,7 +518,8 @@ static const struct mtk_thermal_data mt8183_thermal_data = {
> >  
> >  /**
> >   * raw_to_mcelsius - convert a raw ADC value to mcelsius
> > - * @mt:		The thermal controller
> > + * @mt:	The thermal controller
> > + * @sensno:	sensor number
> >   * @raw:	raw ADC value
> 
> This doesn't look related to $subject

I take this statement back :)

Reviewed-by: Viresh Kumar <viresh.kumar@linaro•org>

-- 
viresh

_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists•infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel