[for-next PATCH 0/2] PM / devfreq: more documentation fixes

[for-next PATCH 0/2] PM / devfreq: more documentation fixes

[Nishanth Menon]

The following patches apply on top of
Rafael's pm-devfreq-next branch on
git://git.kernel.org/pub/scm/linux/kernel/git/rafael/linux-pm.git

and introduced due to warnings of accepted patches.
I dont seem to have the original emails in my mailbox anymore
So apologies of not replying inline to the original patches.
I have tried to provide link to the relevant patchworks link
of the original patch if I could find them.

I hope we will keep the documentation clean ahead :)

Nishanth Menon (2):
  PM / devfreq: more documentation warning fixes
  PM / devfreq: more documentation warning fixes next set

 drivers/devfreq/devfreq.c |    6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

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>

Regards,
Nishanth Menon
-- 
1.7.9.5

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

[Nishanth Menon]

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>
---
 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)
 {
-- 
1.7.9.5

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

[Nishanth Menon]

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>
---
 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().
  */
-- 
1.7.9.5

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

[Rafael J. Wysocki]

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.

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

[Rafael J. Wysocki]

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.