Mailing List Archive: Linux: Kernel

[PATCH] PM: Fix kernel-doc notation

Index | Next | Previous | View Threaded

jaswinder at kernel

Nov 22, 2009, 12:13 AM

Post #1 of 5 (293 views)
Permalink

[PATCH] PM: Fix kernel-doc notation

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 [at] gmail>
Cc: Rafael J. Wysocki <rjw [at] sisk>
Cc: Pavel Machek <pavel [at] ucw>
Cc: Randy Dunlap <randy.dunlap [at] oracle>
---
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

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo [at] vger
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

pavel at ucw

Nov 22, 2009, 9:52 AM

Post #2 of 5 (266 views)
Permalink

Re: [PATCH] PM: Fix kernel-doc notation [In reply to]

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 [at] gmail>
> Cc: Rafael J. Wysocki <rjw [at] sisk>

Acked-by: Pavel Machek <pavel [at] ucw>

--
(english) http://www.livejournal.com/~pavelmachek
(cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo [at] vger
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

rjw at sisk

Nov 24, 2009, 4:18 PM

Post #3 of 5 (253 views)
Permalink

Re: [PATCH] PM: Fix kernel-doc notation [In reply to]

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 [at] gmail>
> Cc: Rafael J. Wysocki <rjw [at] sisk>
> Cc: Pavel Machek <pavel [at] ucw>
> Cc: Randy Dunlap <randy.dunlap [at] oracle>

Applied to suspend-2.6/linux-next.

Thanks,
Rafael
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo [at] vger
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

randy.dunlap at oracle

Dec 11, 2009, 12:02 PM

Post #4 of 5 (244 views)
Permalink

Re: [PATCH] PM: Fix kernel-doc notation [In reply to]

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 [at] gmail>
> Cc: Rafael J. Wysocki <rjw [at] sisk>
> Cc: Pavel Machek <pavel [at] ucw>
> Cc: Randy Dunlap <randy.dunlap [at] oracle>

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
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo [at] vger
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

rjw at sisk

Dec 11, 2009, 1:08 PM

Post #5 of 5 (245 views)
Permalink

Re: [PATCH] PM: Fix kernel-doc notation [In reply to]

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 [at] gmail>
> > Cc: Rafael J. Wysocki <rjw [at] sisk>
> > Cc: Pavel Machek <pavel [at] ucw>
> > Cc: Randy Dunlap <randy.dunlap [at] oracle>
>
> 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
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo [at] vger
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads