Re: [for-next PATCH 2/2] PM / devfreq: more documentation warning fixes next set

Rafael J. Wysocki
2012-10-26T00:01:21Z

On Thursday, October 25, 2012 06:10:14 PM Nishanth Menon wrote:
> commit cfd5194aecd08cd8fbfbf1534a0209b95bc6fcdf
> (PM / devfreq: Core updates to support devices which can idle)
> in Rafael's pm-devfreq-next branch on
> git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm.git
>
> Patchworks: https://patchwork.kernel.org/patch/1545751/
>
> introduced a kernel documentation warning:
> Warning(drivers/devfreq/devfreq.c:289): bad line: release its resources.
>
> This is due to lack of '*' at documentation start messing
> up poor scripts/kernel-doc 's mind. I suggest squashing
> this to original commit given not-yet-upstream status :).
>
> Cc: Rajagopal Venkat <rajagopal.venkat@linaro.org>
> Cc: MyungJoo Ham <myungjoo.ham@samsung.com>
> Cc: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
> Cc: Kyungmin Park <kyungmin.park@samsung.com>
>
> Signed-off-by: Nishanth Menon <nm@ti.com>

I fixed up the original patch in a slightly different way.

Thanks,
Rafael

> ---
> drivers/devfreq/devfreq.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
> index cdc3e2d..2f6ad6b 100644
> --- a/drivers/devfreq/devfreq.c
> +++ b/drivers/devfreq/devfreq.c
> @@ -286,7 +286,7 @@ static int devfreq_notifier_call(struct notifier_block *nb, unsigned long type,
>
> /**
> * _remove_devfreq() - Remove devfreq from the devfreq list and
> - release its resources.
> + * release its resources.
> * @devfreq: the devfreq struct
> * @skip: skip calling device_unregister().
> */
>
--
I speak only for myself.
Rafael J. Wysocki, Intel Open Source Technology Center.