Re: [PATCH 04/11] thermal: devfreq_cooling: Appease the kernel-doc deity

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

On 06-11-19, 18:58, Amit Kucheria wrote:
> Fix up the following warnings with make W=1:
> 
> linux.git/drivers/thermal/devfreq_cooling.c:593: warning: Function
> parameter or member 'cdev' not described in 'devfreq_cooling_unregister'
> linux.git/drivers/thermal/devfreq_cooling.c:593: warning: Excess
> function parameter 'dfc' description in 'devfreq_cooling_unregister'
> 
> Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
> ---
>  drivers/thermal/devfreq_cooling.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/thermal/devfreq_cooling.c b/drivers/thermal/devfreq_cooling.c
> index ef59256887ff6..a87d4fa031c87 100644
> --- a/drivers/thermal/devfreq_cooling.c
> +++ b/drivers/thermal/devfreq_cooling.c
> @@ -53,6 +53,7 @@ static DEFINE_IDA(devfreq_ida);
>   *		'utilization' (which is	'busy_time / 'total_time').
>   *		The 'res_util' range is from 100 to (power_table[state] * 100)
>   *		for the corresponding 'state'.
> + * @capped_state:	index to cooling state with in dynamic power budget

Should there be space instead of tab after : ?

And warning in $subject doesn't talk about this change.

>   */
>  struct devfreq_cooling_device {
>  	int id;
> @@ -587,7 +588,7 @@ EXPORT_SYMBOL_GPL(devfreq_cooling_register);
>  
>  /**
>   * devfreq_cooling_unregister() - Unregister devfreq cooling device.
> - * @dfc: Pointer to devfreq cooling device to unregister.
> + * @cdev: Pointer to devfreq cooling device to unregister.
>   */
>  void devfreq_cooling_unregister(struct thermal_cooling_device *cdev)
>  {
> -- 
> 2.17.1

-- 
viresh