[PATCH] PM: Fix kernel-doc notation

[PATCH] PM: Fix kernel-doc notation

[Jaswinder Singh Rajput]

Fix the following htmldocs warnings:

  Warning(drivers/base/power/main.c:249): No description found for parameter 'master'
  Warning(drivers/base/power/main.c:249): Excess function parameter 'slave' description in 'device_pm_wait_for_slaves'
  Warning(drivers/base/power/main.c:292): No description found for parameter 'master'
  Warning(drivers/base/power/main.c:292): Excess function parameter 'slave' description in 'device_pm_check_slaves'

Signed-off-by: Jaswinder Singh Rajput <jaswinderrajput@gmail.com>
Cc: Rafael J. Wysocki <rjw@sisk.pl>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Randy Dunlap <randy.dunlap@oracle.com>
---
 drivers/base/power/main.c |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/base/power/main.c b/drivers/base/power/main.c
index e8d1ea6..5f13084 100644
--- a/drivers/base/power/main.c
+++ b/drivers/base/power/main.c
@@ -243,7 +243,7 @@ static void device_pm_wait_for_masters(struct device *slave)
 
 /**
  * device_pm_wait_for_slaves - Wait for all slaves of given device.
- * @slave: Device to wait for the slaves of.
+ * @master: Device to wait for the slaves of.
  */
 static void device_pm_wait_for_slaves(struct device *master)
 {
@@ -286,7 +286,7 @@ static int device_pm_check_masters(struct device *slave)
 
 /**
  * device_pm_check_slaves - Check power.op_complete for slaves of a device.
- * @slave: Device to check the slaves of.
+ * @master: Device to check the slaves of.
  */
 static int device_pm_check_slaves(struct device *master)
 {
-- 
1.6.5.3

Re: [PATCH] PM: Fix kernel-doc notation

[Pavel Machek]

On Sun 2009-11-22 13:43:57, Jaswinder Singh Rajput wrote:
> 
> Fix the following htmldocs warnings:
> 
>   Warning(drivers/base/power/main.c:249): No description found for parameter 'master'
>   Warning(drivers/base/power/main.c:249): Excess function parameter 'slave' description in 'device_pm_wait_for_slaves'
>   Warning(drivers/base/power/main.c:292): No description found for parameter 'master'
>   Warning(drivers/base/power/main.c:292): Excess function parameter 'slave' description in 'device_pm_check_slaves'
> 
> Signed-off-by: Jaswinder Singh Rajput <jaswinderrajput@gmail.com>
> Cc: Rafael J. Wysocki <rjw@sisk.pl>

Acked-by: Pavel Machek <pavel@ucw.cz>

-- 
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html

Re: [PATCH] PM: Fix kernel-doc notation

[Rafael J. Wysocki]

On Sunday 22 November 2009, Jaswinder Singh Rajput wrote:
> 
> Fix the following htmldocs warnings:
> 
>   Warning(drivers/base/power/main.c:249): No description found for parameter 'master'
>   Warning(drivers/base/power/main.c:249): Excess function parameter 'slave' description in 'device_pm_wait_for_slaves'
>   Warning(drivers/base/power/main.c:292): No description found for parameter 'master'
>   Warning(drivers/base/power/main.c:292): Excess function parameter 'slave' description in 'device_pm_check_slaves'
> 
> Signed-off-by: Jaswinder Singh Rajput <jaswinderrajput@gmail.com>
> Cc: Rafael J. Wysocki <rjw@sisk.pl>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Randy Dunlap <randy.dunlap@oracle.com>

Applied to suspend-2.6/linux-next.

Thanks,
Rafael

Re: [PATCH] PM: Fix kernel-doc notation

[Randy Dunlap]

On Sun, 22 Nov 2009 13:43:57 +0530 Jaswinder Singh Rajput wrote:

> 
> Fix the following htmldocs warnings:
> 
>   Warning(drivers/base/power/main.c:249): No description found for parameter 'master'
>   Warning(drivers/base/power/main.c:249): Excess function parameter 'slave' description in 'device_pm_wait_for_slaves'
>   Warning(drivers/base/power/main.c:292): No description found for parameter 'master'
>   Warning(drivers/base/power/main.c:292): Excess function parameter 'slave' description in 'device_pm_check_slaves'
> 
> Signed-off-by: Jaswinder Singh Rajput <jaswinderrajput@gmail.com>
> Cc: Rafael J. Wysocki <rjw@sisk.pl>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Randy Dunlap <randy.dunlap@oracle.com>

What tree was this for?
I guess it's not needed now, I can't find these functions..

Thanks.

> ---
>  drivers/base/power/main.c |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/base/power/main.c b/drivers/base/power/main.c
> index e8d1ea6..5f13084 100644
> --- a/drivers/base/power/main.c
> +++ b/drivers/base/power/main.c
> @@ -243,7 +243,7 @@ static void device_pm_wait_for_masters(struct device *slave)
>  
>  /**
>   * device_pm_wait_for_slaves - Wait for all slaves of given device.
> - * @slave: Device to wait for the slaves of.
> + * @master: Device to wait for the slaves of.
>   */
>  static void device_pm_wait_for_slaves(struct device *master)
>  {
> @@ -286,7 +286,7 @@ static int device_pm_check_masters(struct device *slave)
>  
>  /**
>   * device_pm_check_slaves - Check power.op_complete for slaves of a device.
> - * @slave: Device to check the slaves of.
> + * @master: Device to check the slaves of.
>   */
>  static int device_pm_check_slaves(struct device *master)
>  {
> -- 

---
~Randy

Re: [PATCH] PM: Fix kernel-doc notation

[Rafael J. Wysocki]

On Friday 11 December 2009, Randy Dunlap wrote:
> On Sun, 22 Nov 2009 13:43:57 +0530 Jaswinder Singh Rajput wrote:
> 
> > 
> > Fix the following htmldocs warnings:
> > 
> >   Warning(drivers/base/power/main.c:249): No description found for parameter 'master'
> >   Warning(drivers/base/power/main.c:249): Excess function parameter 'slave' description in 'device_pm_wait_for_slaves'
> >   Warning(drivers/base/power/main.c:292): No description found for parameter 'master'
> >   Warning(drivers/base/power/main.c:292): Excess function parameter 'slave' description in 'device_pm_check_slaves'
> > 
> > Signed-off-by: Jaswinder Singh Rajput <jaswinderrajput@gmail.com>
> > Cc: Rafael J. Wysocki <rjw@sisk.pl>
> > Cc: Pavel Machek <pavel@ucw.cz>
> > Cc: Randy Dunlap <randy.dunlap@oracle.com>
> 
> What tree was this for?
> I guess it's not needed now, I can't find these functions..

It was on top of the async suspend/resume patches that Linus has rejected.

Rafael