From 4bbc0bc06b8b0cced31ee17beb753ad51a2e47e7 Mon Sep 17 00:00:00 2001 From: Davidlohr Bueso Date: Fri, 4 Jan 2013 12:14:00 -0800 Subject: [PATCH] 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 Signed-off-by: Greg Kroah-Hartman --- 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 09a9d35d436f..eb0077261ac6 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; -- 2.34.1