[PATCH] staging: zsmalloc: comment zs_create_pool function

[PATCH] staging: zsmalloc: comment zs_create_pool function

[Davidlohr Bueso]

Just as with zs_malloc() and zs_map_object(), it is worth
formally commenting the zs_create_pool() function.

Signed-off-by: Davidlohr Bueso <davidlohr.bueso@hp.com>
---
 drivers/staging/zsmalloc/zsmalloc-main.c | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/drivers/staging/zsmalloc/zsmalloc-main.c b/drivers/staging/zsmalloc/zsmalloc-main.c
index 09a9d35..eb00772 100644
--- a/drivers/staging/zsmalloc/zsmalloc-main.c
+++ b/drivers/staging/zsmalloc/zsmalloc-main.c
@@ -798,6 +798,17 @@ fail:
 	return notifier_to_errno(ret);
 }
 
+/**
+ * zs_create_pool - Creates an allocation pool to work from.
+ * @name: name of the pool to be created
+ * @flags: allocation flags used when growing pool
+ *
+ * This function must be called before anything when using
+ * the zsmalloc allocator.
+ *
+ * On success, a pointer to the newly created pool is returned,
+ * otherwise NULL.
+ */
 struct zs_pool *zs_create_pool(const char *name, gfp_t flags)
 {
 	int i, ovhd_size;
-- 
1.7.11.7

Re: [PATCH] staging: zsmalloc: comment zs_create_pool function

[Davidlohr Bueso]

ping?

On Fri, 2013-01-04 at 12:14 -0800, Davidlohr Bueso wrote:
> Just as with zs_malloc() and zs_map_object(), it is worth
> formally commenting the zs_create_pool() function.
> 
> Signed-off-by: Davidlohr Bueso <davidlohr.bueso@hp.com>
> ---
>  drivers/staging/zsmalloc/zsmalloc-main.c | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/drivers/staging/zsmalloc/zsmalloc-main.c b/drivers/staging/zsmalloc/zsmalloc-main.c
> index 09a9d35..eb00772 100644
> --- a/drivers/staging/zsmalloc/zsmalloc-main.c
> +++ b/drivers/staging/zsmalloc/zsmalloc-main.c
> @@ -798,6 +798,17 @@ fail:
>  	return notifier_to_errno(ret);
>  }
>  
> +/**
> + * zs_create_pool - Creates an allocation pool to work from.
> + * @name: name of the pool to be created
> + * @flags: allocation flags used when growing pool
> + *
> + * This function must be called before anything when using
> + * the zsmalloc allocator.
> + *
> + * On success, a pointer to the newly created pool is returned,
> + * otherwise NULL.
> + */
>  struct zs_pool *zs_create_pool(const char *name, gfp_t flags)
>  {
>  	int i, ovhd_size;

Re: [PATCH] staging: zsmalloc: comment zs_create_pool function

[Greg Kroah-Hartman]

On Wed, Jan 09, 2013 at 09:57:34AM -0800, Davidlohr Bueso wrote:
> ping?
> 
> On Fri, 2013-01-04 at 12:14 -0800, Davidlohr Bueso wrote:
> > Just as with zs_malloc() and zs_map_object(), it is worth
> > formally commenting the zs_create_pool() function.
> > 
> > Signed-off-by: Davidlohr Bueso <davidlohr.bueso@hp.com>
> > ---
> >  drivers/staging/zsmalloc/zsmalloc-main.c | 11 +++++++++++

I am currently digging out of a 3 week backlog of email due to vacation.
Staging patches, especially ones for zsmalloc and friends, are way on
the bottom of the priority list.  It's not lost, and will be gotten to
eventually, thanks for your patience.

greg k-h