[PATCH] power: trivial comment fixes

[PATCH] power: trivial comment fixes

[Wu Fengguang]

CC: Rafael J. Wysocki <rjw@sisk.pl>
Signed-off-by: Wu Fengguang <fengguang.wu@intel.com>
---
 kernel/power/snapshot.c |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux.orig/kernel/power/snapshot.c
+++ linux/kernel/power/snapshot.c
@@ -233,7 +233,7 @@ static void *chain_alloc(struct chain_al
 
 #define BM_END_OF_MAP	(~0UL)
 
-#define BM_BITS_PER_BLOCK	(PAGE_SIZE << 3)
+#define BM_BITS_PER_BLOCK	(PAGE_SIZE * BITS_PER_BYTE)
 
 struct bm_block {
 	struct list_head hook;	/* hook into a list of bitmap blocks */
@@ -275,7 +275,7 @@ static void memory_bm_free(struct memory
 
 /**
  *	create_bm_block_list - create a list of block bitmap objects
- *	@nr_blocks - number of blocks to allocate
+ *	@pages - number of pages to track
  *	@list - list to put the allocated blocks into
  *	@ca - chain allocator to be used for allocating memory
  */

Re: [PATCH] power: trivial comment fixes

[Rafael J. Wysocki]

On Thursday 16 July 2009, Wu Fengguang wrote:
> CC: Rafael J. Wysocki <rjw@sisk.pl>
> Signed-off-by: Wu Fengguang <fengguang.wu@intel.com>

Thanks for the patch, I'll add it to the suspend tree when I'm back home
(probably on Monday).

Best,
Rafael


> ---
>  kernel/power/snapshot.c |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> --- linux.orig/kernel/power/snapshot.c
> +++ linux/kernel/power/snapshot.c
> @@ -233,7 +233,7 @@ static void *chain_alloc(struct chain_al
>  
>  #define BM_END_OF_MAP	(~0UL)
>  
> -#define BM_BITS_PER_BLOCK	(PAGE_SIZE << 3)
> +#define BM_BITS_PER_BLOCK	(PAGE_SIZE * BITS_PER_BYTE)
>  
>  struct bm_block {
>  	struct list_head hook;	/* hook into a list of bitmap blocks */
> @@ -275,7 +275,7 @@ static void memory_bm_free(struct memory
>  
>  /**
>   *	create_bm_block_list - create a list of block bitmap objects
> - *	@nr_blocks - number of blocks to allocate
> + *	@pages - number of pages to track
>   *	@list - list to put the allocated blocks into
>   *	@ca - chain allocator to be used for allocating memory
>   */

Re: [PATCH] power: trivial comment fixes

[Randy Dunlap]

On Fri, 17 Jul 2009 03:19:02 +0200 Rafael J. Wysocki wrote:

> On Thursday 16 July 2009, Wu Fengguang wrote:
> > CC: Rafael J. Wysocki <rjw@sisk.pl>
> > Signed-off-by: Wu Fengguang <fengguang.wu@intel.com>
> 
> Thanks for the patch, I'll add it to the suspend tree when I'm back home
> (probably on Monday).
> 
> Best,
> Rafael
> 
> 
> > ---
> >  kernel/power/snapshot.c |    4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > --- linux.orig/kernel/power/snapshot.c
> > +++ linux/kernel/power/snapshot.c
> > @@ -233,7 +233,7 @@ static void *chain_alloc(struct chain_al
> >  
> >  #define BM_END_OF_MAP	(~0UL)
> >  
> > -#define BM_BITS_PER_BLOCK	(PAGE_SIZE << 3)
> > +#define BM_BITS_PER_BLOCK	(PAGE_SIZE * BITS_PER_BYTE)
> >  
> >  struct bm_block {
> >  	struct list_head hook;	/* hook into a list of bitmap blocks */
> > @@ -275,7 +275,7 @@ static void memory_bm_free(struct memory
> >  
> >  /**
> >   *	create_bm_block_list - create a list of block bitmap objects
> > - *	@nr_blocks - number of blocks to allocate
> > + *	@pages - number of pages to track
> >   *	@list - list to put the allocated blocks into
> >   *	@ca - chain allocator to be used for allocating memory
> >   */

BTW:
kernel-doc uses @parameter:
and not         @parameter -

---
~Randy
LPC 2009, Sept. 23-25, Portland, Oregon
http://linuxplumbersconf.org/2009/

Re: [PATCH] power: trivial comment fixes

[Rafael J. Wysocki]

On Wednesday 22 July 2009, Randy Dunlap wrote:
> On Fri, 17 Jul 2009 03:19:02 +0200 Rafael J. Wysocki wrote:
> 
> > On Thursday 16 July 2009, Wu Fengguang wrote:
> > > CC: Rafael J. Wysocki <rjw@sisk.pl>
> > > Signed-off-by: Wu Fengguang <fengguang.wu@intel.com>
> > 
> > Thanks for the patch, I'll add it to the suspend tree when I'm back home
> > (probably on Monday).
> > 
> > Best,
> > Rafael
> > 
> > 
> > > ---
> > >  kernel/power/snapshot.c |    4 ++--
> > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > > 
> > > --- linux.orig/kernel/power/snapshot.c
> > > +++ linux/kernel/power/snapshot.c
> > > @@ -233,7 +233,7 @@ static void *chain_alloc(struct chain_al
> > >  
> > >  #define BM_END_OF_MAP	(~0UL)
> > >  
> > > -#define BM_BITS_PER_BLOCK	(PAGE_SIZE << 3)
> > > +#define BM_BITS_PER_BLOCK	(PAGE_SIZE * BITS_PER_BYTE)
> > >  
> > >  struct bm_block {
> > >  	struct list_head hook;	/* hook into a list of bitmap blocks */
> > > @@ -275,7 +275,7 @@ static void memory_bm_free(struct memory
> > >  
> > >  /**
> > >   *	create_bm_block_list - create a list of block bitmap objects
> > > - *	@nr_blocks - number of blocks to allocate
> > > + *	@pages - number of pages to track
> > >   *	@list - list to put the allocated blocks into
> > >   *	@ca - chain allocator to be used for allocating memory
> > >   */
> 
> BTW:
> kernel-doc uses @parameter:
> and not         @parameter -

Yes, kerneldocs in this file generally require fixes.  They're somewhere in my
todo list.

Best,
Rafael