From: zhaoxinchao <chrisxinchao@outlook.com>
Date: Tue, 18 Apr 2023 02:05:23 +0000 (+0800)
Subject: mm/slab: correct return values in comment for _kmem_cache_create()
X-Git-Tag: v6.5-rc1~137^2~10
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=444f20c29e8b41a5aef5c34e3eab84e8d1cc4511;p=thirdparty%2Fkernel%2Flinux.git

mm/slab: correct return values in comment for _kmem_cache_create()

__kmem_cache_create() returns 0 on success and non-zero on failure.
The comment is wrong in two instances, so fix the first one and remove
the second one. Also make the comment non-doc, because it doesn't
describe an API function, but SLAB-specific implementation.

Signed-off-by: zhaoxinchao <chrisxinchao@outlook.com>
Signed-off-by: Vlastimil Babka <vbabka@suse.cz>
---

diff --git a/mm/slab.c b/mm/slab.c
index bb57f7fdbae14..30d2419087396 100644
--- a/mm/slab.c
+++ b/mm/slab.c
@@ -1887,14 +1887,12 @@ static bool set_on_slab_cache(struct kmem_cache *cachep,
 	return true;
 }
 
-/**
+/*
  * __kmem_cache_create - Create a cache.
  * @cachep: cache management descriptor
  * @flags: SLAB flags
  *
- * Returns a ptr to the cache on success, NULL on failure.
- * Cannot be called within an int, but can be interrupted.
- * The @ctor is run when new pages are allocated by the cache.
+ * Returns zero on success, nonzero on failure.
  *
  * The flags are
  *
@@ -1907,8 +1905,6 @@ static bool set_on_slab_cache(struct kmem_cache *cachep,
  * %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 created cache or %NULL in case of error
  */
 int __kmem_cache_create(struct kmem_cache *cachep, slab_flags_t flags)
 {