[PATCH] Update the kmem_cache_create documentation regarding the name parameter

[PATCH] Update the kmem_cache_create documentation regarding the name parameter

[Catalin Marinas]

kmem_cache implementations like slub are allowed to merge multiple
caches but only the initial name is preserved. Therefore,
kmem_cache_name() is not guaranteed to return the same pointer passed to
the former function. This patch updates the documentation to make this
clearer.

Signed-off-by: Catalin Marinas <catalin.marinas@arm.com>
Cc: Pekka Enberg <penberg@cs.helsinki.fi>
---
 mm/slab.c |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)

diff --git a/mm/slab.c b/mm/slab.c
index 4887f1b..8924a03 100644
--- a/mm/slab.c
+++ b/mm/slab.c
@@ -2124,6 +2124,8 @@ static int __init_refok setup_cpu_cache(struct kmem_cache *cachep)
  *
  * @name must be valid until the cache is destroyed. This implies that
  * the module calling this has to destroy the cache before getting unloaded.
+ * Note that kmem_cache_name() is not guaranteed to return the same pointer,
+ * therefore applications must manage it themselves.
  *
  * The flags are
  *

Re: [PATCH] Update the kmem_cache_create documentation regarding the name parameter

[Pekka Enberg]

Hi Catalin,

On Fri, 2008-11-21 at 12:56 +0000, Catalin Marinas wrote:
> kmem_cache implementations like slub are allowed to merge multiple
> caches but only the initial name is preserved. Therefore,
> kmem_cache_name() is not guaranteed to return the same pointer passed to
> the former function. This patch updates the documentation to make this
> clearer.
> 
> Signed-off-by: Catalin Marinas <catalin.marinas@arm.com>
> Cc: Pekka Enberg <penberg@cs.helsinki.fi>

Applied, thanks!

> ---
>  mm/slab.c |    2 ++
>  1 files changed, 2 insertions(+), 0 deletions(-)
> 
> diff --git a/mm/slab.c b/mm/slab.c
> index 4887f1b..8924a03 100644
> --- a/mm/slab.c
> +++ b/mm/slab.c
> @@ -2124,6 +2124,8 @@ static int __init_refok setup_cpu_cache(struct kmem_cache *cachep)
>   *
>   * @name must be valid until the cache is destroyed. This implies that
>   * the module calling this has to destroy the cache before getting unloaded.
> + * Note that kmem_cache_name() is not guaranteed to return the same pointer,
> + * therefore applications must manage it themselves.
>   *
>   * The flags are
>   *
>