staging: zsmalloc: comment zs_create_pool function

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>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Davidlohr Bueso 2013-01-04 12:14:00 -08:00 committed by Greg Kroah-Hartman
parent 1867fa64ff
commit 4bbc0bc06b

View file

@ -798,6 +798,17 @@ static int zs_init(void)
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;