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

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

On Thursday, October 25, 2012 06:10:13 PM Nishanth Menon wrote:
> Commit 34b53237e9ceb141e13e846baed2a282461f4a01
> (PM / devfreq: Add suspend and resume apis)
> 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/1545791/
>
> Warning(drivers/devfreq/devfreq.c:436): No description found for parameter 'devfreq'
> Warning(drivers/devfreq/devfreq.c:450): No description found for parameter 'devfreq'
>
> Yet again, a missing ':' causes the kernel-doc to cry
>
> Since it is not merged to upstream, I suggest squashing it
>
> 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 | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/devfreq/devfreq.c b/drivers/devfreq/devfreq.c
> index 32e9b48..cdc3e2d 100644
> --- a/drivers/devfreq/devfreq.c
> +++ b/drivers/devfreq/devfreq.c
> @@ -430,7 +430,7 @@ EXPORT_SYMBOL(devfreq_remove_device);
>
> /**
> * devfreq_suspend_device() - Suspend devfreq of a device.
> - * @devfreq the devfreq instance to be suspended
> + * @devfreq: the devfreq instance to be suspended
> */
> int devfreq_suspend_device(struct devfreq *devfreq)
> {
> @@ -444,7 +444,7 @@ EXPORT_SYMBOL(devfreq_suspend_device);
>
> /**
> * devfreq_resume_device() - Resume devfreq of a device.
> - * @devfreq the devfreq instance to be resumed
> + * @devfreq: the devfreq instance to be resumed
> */
> int devfreq_resume_device(struct devfreq *devfreq)
> {
>
--
I speak only for myself.
Rafael J. Wysocki, Intel Open Source Technology Center.