Commit f496990f authored by Mike Rapoport's avatar Mike Rapoport Committed by Jonathan Corbet

slab: make kmem_cache_create{_usercopy} description proper kernel-doc

Add the description for kmem_cache_create, fixup the return value paragraph
and make both kmem_cache_create and add the second '*' to the comment
opening.
Signed-off-by: default avatarMike Rapoport <rppt@linux.ibm.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent f77af637
...@@ -406,8 +406,9 @@ static struct kmem_cache *create_cache(const char *name, ...@@ -406,8 +406,9 @@ static struct kmem_cache *create_cache(const char *name,
goto out; goto out;
} }
/* /**
* kmem_cache_create_usercopy - Create a cache. * kmem_cache_create_usercopy - Create a cache with a region suitable
* for copying to userspace
* @name: A string which is used in /proc/slabinfo to identify this cache. * @name: A string which is used in /proc/slabinfo to identify this cache.
* @size: The size of objects to be created in this cache. * @size: The size of objects to be created in this cache.
* @align: The required alignment for the objects. * @align: The required alignment for the objects.
...@@ -416,7 +417,6 @@ static struct kmem_cache *create_cache(const char *name, ...@@ -416,7 +417,6 @@ static struct kmem_cache *create_cache(const char *name,
* @usersize: Usercopy region size * @usersize: Usercopy region size
* @ctor: A constructor for the objects. * @ctor: A constructor for the objects.
* *
* Returns a ptr to the cache on success, NULL on failure.
* Cannot be called within a interrupt, but can be interrupted. * Cannot be called within a interrupt, but can be interrupted.
* The @ctor is run when new pages are allocated by the cache. * The @ctor is run when new pages are allocated by the cache.
* *
...@@ -425,12 +425,14 @@ static struct kmem_cache *create_cache(const char *name, ...@@ -425,12 +425,14 @@ static struct kmem_cache *create_cache(const char *name,
* %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5) * %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
* to catch references to uninitialised memory. * to catch references to uninitialised memory.
* *
* %SLAB_RED_ZONE - Insert `Red' zones around the allocated memory to check * %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
* for buffer overruns. * for buffer overruns.
* *
* %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware * %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
* cacheline. This can be beneficial if you're counting cycles as closely * cacheline. This can be beneficial if you're counting cycles as closely
* as davem. * as davem.
*
* Return: a pointer to the cache on success, NULL on failure.
*/ */
struct kmem_cache * struct kmem_cache *
kmem_cache_create_usercopy(const char *name, kmem_cache_create_usercopy(const char *name,
...@@ -514,6 +516,31 @@ kmem_cache_create_usercopy(const char *name, ...@@ -514,6 +516,31 @@ kmem_cache_create_usercopy(const char *name,
} }
EXPORT_SYMBOL(kmem_cache_create_usercopy); EXPORT_SYMBOL(kmem_cache_create_usercopy);
/**
* kmem_cache_create - Create a cache.
* @name: A string which is used in /proc/slabinfo to identify this cache.
* @size: The size of objects to be created in this cache.
* @align: The required alignment for the objects.
* @flags: SLAB flags
* @ctor: A constructor for the objects.
*
* Cannot be called within a interrupt, but can be interrupted.
* The @ctor is run when new pages are allocated by the cache.
*
* The flags are
*
* %SLAB_POISON - Poison the slab with a known test pattern (a5a5a5a5)
* to catch references to uninitialised memory.
*
* %SLAB_RED_ZONE - Insert `Red` zones around the allocated memory to check
* for buffer overruns.
*
* %SLAB_HWCACHE_ALIGN - Align the objects in this cache to a hardware
* cacheline. This can be beneficial if you're counting cycles as closely
* as davem.
*
* Return: a pointer to the cache on success, NULL on failure.
*/
struct kmem_cache * struct kmem_cache *
kmem_cache_create(const char *name, unsigned int size, unsigned int align, kmem_cache_create(const char *name, unsigned int size, unsigned int align,
slab_flags_t flags, void (*ctor)(void *)) slab_flags_t flags, void (*ctor)(void *))
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment