Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   zhaoxinchao <ChrisXinchao@outlook.com>
To:     vbabka@suse.cz
Cc:     ChrisXinchao@outlook.com, akpm@linux-foundation.org,
        bagasdotme@gmail.com, cl@linux.com, iamjoonsoo.kim@lge.com,
        linux-kernel@vger.kernel.org, linux-mm@kvack.org,
        penberg@kernel.org, rientjes@google.com,
        zhaoxinchao <chrisxinchao@outlook.com>
Subject: [PATCH v3] mm: Fixed incorrect comment for _kmem_cache_create function
Date:   Tue, 18 Apr 2023 10:05:23 +0800
Message-ID: <DM6PR22MB1836E82FB689EE68B8065C47C59D9@DM6PR22MB1836.namprd22.prod.outlook.com>
In-Reply-To: <24a0219d-b0a1-8b81-ff98-2fff107650c3@suse.cz>
References: <24a0219d-b0a1-8b81-ff98-2fff107650c3@suse.cz>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-MessageSentRepresentingType: 1
X-MS-PublicTrafficType: Email
X-MS-TrafficTypeDiagnostic: DM6PR22MB1836:EE_|PH7PR22MB3615:EE_
X-MS-Office365-Filtering-Correlation-Id: 54577834-2f33-4b8e-955f-08db3fb169ac
X-MS-Exchange-SLBlob-MailProps: AZnQBsB9XmofvZvLhntBlNaxIR7rLBomn77l1A8uQl7OdzufGCdp0iZXnQKNvC67c9jovCoYGyD1MQOjb1e9BuBODeRvo8jX1nxzmh3WGIQbZtoR4ERA3uBwFV4I6G7T3Z7DPRBtz+8noyHzR6FWawcizu1kqG2gRAK8nJzdJGCGBmgv5mEpXUmvqm+OhVi29kpIzbbzVonsFCARwy3KQqomZJK6iQRaFYgMYjquhbmKQWuPNNcFE3DCVqeahbhV92baVdcrx9T/FTD4kKL4qnHwRkJaN1aNkbY41NI+c/fRO8fhGncuoh+dS8seKCpGMGnTqGnO0iMmzyReKSKAR2Wy+UhUegG7vIqKDdR3fIy9wYUvmHgToEGtRYXZyUrfD9sXn3LSMK47VQrD+G+IvooG03vxIKC+jXZfG/gZ88sSRqA3IKyd0QnALD+JLMpL/E37VTivBXalbodYw9hLS17RZ1FBF0u6K6DhPxw/vtRsKC9b4e2R6toXUr/CNo+tWoZu9x0iLr2/96dHhUDOElbdCCj61DkwBw1htFjmFh9I+e6e6Tim0BADc6ggtYeWTn2mgKXeBnXQn47Lf2nv+7+bbWvpwSb/GAxgh2jXXDDlpW0jrH8c9vtMHh1mmzVrMW/Rlu7ID9uXXWaXIVCKeT439/iA0u7jCJiwqLTs8R5oWkBvHNR49/tCvFl68OXTX/q134J05EctZdquvjbU1+VGYB2DFUHZg7Qq4Wf/BuDRBVn3A+AiROSd5l29T3+g5g+7qhfK/yg=
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info: RxZKgAayqWK1GwoNFn9ozelxrMYGD0riTBM0UnE9meYYnMhTtvHmXV7ockAiYyKIXaW9BsnbVTHUPOH4phyQwiE9Xv+DIrf+my8tI5+ZuYVPIyvbzFxzfLxKJLFQxIWN9k2VnnCHShSpmiFX2OZBGBmvGDc4uZAjbwzn/auPovcrRrQqsuvnlzAxyow6EztXVIVeyiVx8Hg0TIVCdkYvPSfz9AfygZ67cDATSGbuWsJpMx6ZPM6wm8Mu4BVjnsgo+H6JRSXGdwBKMBuNNhHzE0iIW+RvpnOIZ8maixiNHKFCjk1bVZFZF0qhdW7RF7awMHL1CMgI2wS8rcr5aGjlcTjes0wuGacF1S7MhNm6swFgCjLZh2VEGTBoGcfDT7g2FEsUpO7kw2MOrHHkoUF2of9iXUZOzK7SWjg8QrJROc+3PcTWaigQCjp7EQ3P69hYjdMGnR5mRrHgu5KWBWGSp+aGQRkWRnryafye3/w/h2sbFJumv3Zcq5J011XioJNDN8WVFf6z17WE8MSevECeOgYNlaW6KnqRQuPl+IAOgPPPsxXF34pFKKY2mTQmLh0dHcZv1li8pm6VMp5faak0c7TN//KjKTS5Bh8zwve1DOBaZyooH0SyrvBFBJ0dx1f1
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?lT5kewVICWJzJ411scFhWiLMjPhPuuHANhBj7rcCm/xjQfwM6T2tpdiUgHRr?=
 =?us-ascii?Q?M3VZ5+xrY4bLVga2n6pSZtsQnjCfLdZW+JaaFjqHBJMsx1qMAdm+Bda+2hCc?=
 =?us-ascii?Q?4xpQiHUUmILUqLT7NjcENzICSuFdI/b55ahw1KmX9QJ0pqfpvurJytJ0a4zD?=
 =?us-ascii?Q?AoBxLxv7kUjQ2tHs01mLTzJbaXMQ4p0qk2rCPDW7ZD8VNJVqA5Nm2RXzl/GH?=
 =?us-ascii?Q?/4+dZ/Ga+4ha4ksnZcDRTIAlxDOuRblmLxEgQ3FcfXr4J3z7dVJHQNNtXzMb?=
 =?us-ascii?Q?hGJOOLyKo4Hbht38jQAVcM41e+lVyqfUcGuuOnkrDZoRV6J27TeZTEUqk1rY?=
 =?us-ascii?Q?PHhhI69rcJBbhtJOycyJ+dl/+oZuFXHWkkZzBnORAVm5XkiKbXTJ2PyFySeJ?=
 =?us-ascii?Q?HLRGSjbeyM5eGVt9NafWvf+qCqZCg5MKkg/RBk74xOSYq+jS8JbFKjG85GhT?=
 =?us-ascii?Q?An2RnnZPBaOTLDHFYqdyvFTB4wT7RiJT9bUM35kdnQT9fQ8dzYHx97hkKBEL?=
 =?us-ascii?Q?uAzXlVDKngcwezU4SCsGhBi34+uKm9ck8+U+1uV/6st8ycX4Yg8jW7/E++Pl?=
 =?us-ascii?Q?9lrKruNn0YbnnfjbWVIY7GL9WBK8MQXm7qDt0xW7T0I63zhTux9evGJjaCnm?=
 =?us-ascii?Q?ZkdhaJkagb/PsaY0GQuzvufyHztcGyRDzcQ5KS4xR9BvtMR2qypowwBbXb/x?=
 =?us-ascii?Q?T2sDmrr/4tCvotXx4e0di1kDghNrqiwt7m6Bj0bT2NgAqiIra8ox54F2kBWk?=
 =?us-ascii?Q?ZUHqWvq+js7Z3GmDk1whqi4QhWc385ibK+wG89VTDVvEEf8C5AXBkhqSvFan?=
 =?us-ascii?Q?HA4Ug1FPUajbPo9iU6TsXdWF13X+GE7MLwYZYWn2nn97WidOdexIx8WPKUhP?=
 =?us-ascii?Q?ExcOR6Vog9yUn4zp5GjgvAFQXk6d45Ttyr9a827273awUaYVzUjELbrhIXiJ?=
 =?us-ascii?Q?y+GLp4oEnpYa/GHD6Pmswk+W525L4NQvLxas8EDBI7OUOPOh/BjxJ8QEKVjS?=
 =?us-ascii?Q?mf4vVvPz/ZF9fcSQc6npQ/enj1lboCMl9ka20Vuqkns7GbuHKakSM+wabuat?=
 =?us-ascii?Q?iM3H8qXUol3VMl7qXVcCh9aKdW9RnWdpBo55Ia1QGJJPAipRlw41KMMAubtI?=
 =?us-ascii?Q?kPSRNJuwOSb++uBniRRh7FX5jTZjY26jltmcvm9BXqpakCTXRgvp+cFuF6TT?=
 =?us-ascii?Q?tprDHSu3Xn9PRHCqpxxGc8eFQmMvBvIqGulI+dxlGG7peS7giFVoMPpwvUI?=
 =?us-ascii?Q?=3D?=
X-OriginatorOrg: outlook.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 54577834-2f33-4b8e-955f-08db3fb169ac
X-MS-Exchange-CrossTenant-AuthSource: DM6PR22MB1836.namprd22.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 18 Apr 2023 02:05:41.9340
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa
X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PH7PR22MB3615
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,FREEMAIL_FROM,
        RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,
        T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

From: zhaoxinchao <chrisxinchao@outlook.com>

Actually __kmem_cache_create() returns a status :
0 is success
nonezero are failed.

This function has three return positions. In addition to successfully
return 0, the first failed position will return - E2BIG, and the second
position will return nonzero value for setup_cpu_cache function failure.

Signed-off-by: zhaoxinchao <chrisxinchao@outlook.com>
---
 mm/slab.c | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/mm/slab.c b/mm/slab.c
index edbe722fb..ebd326f07 100644
--- a/mm/slab.c
+++ b/mm/slab.c
@@ -1888,14 +1888,17 @@ 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.
+ * This function has three return positions.
+ * In addition to successfully return 0, the
+ * first failed position will return - E2BIG,
+ * and the second position will return nonzero
+ * value for setup_cpu_cache function failure.
  *
  * The flags are
  *
@@ -1908,8 +1911,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)
 {
-- 
2.39.2