lkml.org 
[lkml]   [2018]   [Dec]   [6]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    From
    Subject[PATCH 1/2] slab: make kmem_cache_create{_usercopy} description proper kernel-doc
    Date
    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: Mike Rapoport <rppt@linux.ibm.com>
    ---
    mm/slab_common.c | 35 +++++++++++++++++++++++++++++++----
    1 file changed, 31 insertions(+), 4 deletions(-)

    diff --git a/mm/slab_common.c b/mm/slab_common.c
    index 7eb8dc1..dbf63d6 100644
    --- a/mm/slab_common.c
    +++ b/mm/slab_common.c
    @@ -406,8 +406,9 @@ static struct kmem_cache *create_cache(const char *name,
    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.
    * @size: The size of objects to be created in this cache.
    * @align: The required alignment for the objects.
    @@ -416,7 +417,6 @@ static struct kmem_cache *create_cache(const char *name,
    * @usersize: Usercopy region size
    * @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.
    * 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,
    * %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
    + * %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 *
    kmem_cache_create_usercopy(const char *name,
    @@ -514,6 +516,31 @@ kmem_cache_create_usercopy(const char *name,
    }
    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 *
    kmem_cache_create(const char *name, unsigned int size, unsigned int align,
    slab_flags_t flags, void (*ctor)(void *))
    --
    2.7.4
    \
     
     \ /
      Last update: 2018-12-06 22:14    [W:4.782 / U:0.192 seconds]
    ©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site