From patchwork Fri Oct 20 14:46:46 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Ferruh Yigit X-Patchwork-Id: 133077 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 18126431BB; Fri, 20 Oct 2023 16:47:12 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id BE4C3402D7; Fri, 20 Oct 2023 16:47:11 +0200 (CEST) Received: from NAM10-MW2-obe.outbound.protection.outlook.com (mail-mw2nam10on2064.outbound.protection.outlook.com [40.107.94.64]) by mails.dpdk.org (Postfix) with ESMTP id 129B940276; Fri, 20 Oct 2023 16:47:10 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=YQzsbcXTG9J74UBDX7s+D6C/lE4gfL8moUBdFv93U6F2fmabOXYe8uERCNOVBR5KMQeGQ981vaVRMvu1eh+OUjq6mM3s3xYsNUPfYm9Dz9vSz0cTMSdXGUZs2xRCua2WFjCXYTbta4sugeBZzio3aQ8F0vuQS4qLAU+5uQkL2w+RGHxt7PuFt80YEq0Zp5TGQRXF83z+vtBqR9gtwtA1+NrrE5Nh+8mRwo3hA8W7tNmA3kRmpg8KNN1+hPw2HTNgVc9AO263MVuZFDDtMeGvZCrb8iU3fVH5QxeKK3mwj/SIa1yUdJGeDJn/w0O5NbJxU2WANXPXMPQFZqNVIfQLBA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=mswjkgf+cqb3g8UcCOLjotFux0QaSJPv+FG70KE69Fs=; b=ncFxD4jEvTUMQbpPEQXk7+z8YAVTLt0ar8gNu6XciKBrHT5MQ/1r+liJZImO5QHLjLm5paGIinxU9ctVQjT/o648OGLLarCw0/kkSBY56LQtw8QLfTjl8o1Myu27Otd550+SERVZLbpuAdzHlvBj1cSIXt91+78EDt9Ao6ghsb5FyB0QXQef9NcCoIqI/LRf5M91sF2RKDhl8Zj++zs+DhdZhv1xw6OieVbRfKOKrrKIEXeWfw/CU3fzryQi9nSsAGY8P6XAz0e930AK/lJ8+eD7f74bCnq9OV7LCsC5b+Sofxs3W6rjOOElADpZzPtuMAjEIPog3lkPBO2/QnnWRA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=monjalon.net smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=mswjkgf+cqb3g8UcCOLjotFux0QaSJPv+FG70KE69Fs=; b=hVtuEOuTq3ryh2YiS7/swFEit0XxZ0b8j3tIxdjE/VIy1oq92nx5xuRk5MOFTU7sdHXw9kJ4Em8wqk6jN+BP688rjknp768z5tcOZpbDacszNbv6OdIfUpZslnVUrDNhrgNg+uIL/oZT7PMm8uAuvoELz7FQfrMQqbT7DOmT+Os= Received: from CY5PR22CA0101.namprd22.prod.outlook.com (2603:10b6:930:65::15) by LV3PR12MB9144.namprd12.prod.outlook.com (2603:10b6:408:19d::10) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6907.26; Fri, 20 Oct 2023 14:47:07 +0000 Received: from CY4PEPF0000FCBF.namprd03.prod.outlook.com (2603:10b6:930:65:cafe::a3) by CY5PR22CA0101.outlook.office365.com (2603:10b6:930:65::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6907.26 via Frontend Transport; Fri, 20 Oct 2023 14:47:07 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17) smtp.mailfrom=amd.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=amd.com; Received-SPF: Pass (protection.outlook.com: domain of amd.com designates 165.204.84.17 as permitted sender) receiver=protection.outlook.com; client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C Received: from SATLEXMB04.amd.com (165.204.84.17) by CY4PEPF0000FCBF.mail.protection.outlook.com (10.167.242.101) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.6907.23 via Frontend Transport; Fri, 20 Oct 2023 14:47:06 +0000 Received: from telcodpdk.amd.com (10.180.168.240) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.27; Fri, 20 Oct 2023 09:47:04 -0500 From: Ferruh Yigit To: Thomas Monjalon , Andrew Rybchenko CC: , , Mahesh Adulla Subject: [PATCH] mempool: fix internal function documentation Date: Fri, 20 Oct 2023 15:46:46 +0100 Message-ID: <20231020144647.1682698-1-ferruh.yigit@amd.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-Originating-IP: [10.180.168.240] X-ClientProxiedBy: SATLEXMB03.amd.com (10.181.40.144) To SATLEXMB04.amd.com (10.181.40.145) X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CY4PEPF0000FCBF:EE_|LV3PR12MB9144:EE_ X-MS-Office365-Filtering-Correlation-Id: 7fcae5cd-4240-41b9-7774-08dbd17b6e97 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: 8wUssLLZoE9H2iekG637w3Igx3N59tPaCizCpkSuhIhGPl19wEnEhxtLli5pYKYfNC2erzVkyLs3IrevZKi3KH6R8G5OE6T80jAPfaF5vXlTa6tnjTEIaauqmAJ+JOednQrjFLhrimvsp/U3lZIcVR9b4nNzJK10cvB2b7JN/ld56LKh3PGb8T+88fbkubnplA0y/9Nfms6JKg4CSHucI4d9OyKE0zYSulJrPUi8O5cSMmyB9gc2gi52ZGhm2VCtYvwtNcAreg8YubNwDoYH8Np038mgkPgYbklYt46EbOP9FG67J8h0ciY5YhMJbYLtISwpdKAE1i+OiRcPEJbEYwh6YrIZkxOQVlgkuQZE1OwVZfxyDhACakl2w7HVWDkOQgV48XkIeekh6PvV56LvL8tZyqHoPi+dbdN5jt1xu0S482sBTs9wgYFJ5hPUdZpZPoJD48ahd5k7ABHDXnLUCh78jFVTpdkaOQmGQpwtE7xjn5gGpqhAkx9pMqzAj+UEXDWee2GiDw7aMXz+bsZpuR1YFVFUqROOdPvZNUwD7BGWha/knDeDzWYaaQwSQ2nuHcvzJWH0QE72NBliTMr+l5GmoaxM/ugXRbRMxR305lbYrZ60Srxsfzex96Q1nrBjlbFXfhly0UxK0HuilYpLDWnsFAM6a2rJzJRjCUWS1vqNwvno3XMGZPEezxxL1gGXMQLCEkVrf//wiuwbQSEl9qDSjQQ2ymMTBfbNeiBwW9v4JEX1uJu5PZfnqW7TLX1CVtk14A0Msok2S3wZ9TxLTQ== X-Forefront-Antispam-Report: CIP:165.204.84.17; CTRY:US; LANG:en; SCL:1; SRV:; IPV:CAL; SFV:NSPM; H:SATLEXMB04.amd.com; PTR:InfoDomainNonexistent; CAT:NONE; SFS:(13230031)(4636009)(39860400002)(346002)(396003)(376002)(136003)(230922051799003)(64100799003)(82310400011)(451199024)(186009)(1800799009)(40470700004)(46966006)(36840700001)(2906002)(40480700001)(40460700003)(478600001)(5660300002)(4326008)(41300700001)(8936002)(8676002)(44832011)(110136005)(316002)(70586007)(70206006)(54906003)(36860700001)(83380400001)(47076005)(36756003)(86362001)(2616005)(356005)(81166007)(82740400003)(336012)(426003)(1076003)(26005)(16526019)(6666004)(7696005)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Oct 2023 14:47:06.7159 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 7fcae5cd-4240-41b9-7774-08dbd17b6e97 X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d; Ip=[165.204.84.17]; Helo=[SATLEXMB04.amd.com] X-MS-Exchange-CrossTenant-AuthSource: CY4PEPF0000FCBF.namprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: LV3PR12MB9144 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org static function `rte_mempool_do_generic_get()` returns zero on success, not >=0 as its function comment documents. Since this function called by public API, the comment causes confusion on the public API return value. Fixing the internal function documentation for return value. Fixes: af75078fece3 ("first public release") Cc: stable@dpdk.org Reported-by: Mahesh Adulla Signed-off-by: Ferruh Yigit Reviewed-by: Morten Brørup Acked-by: Huisong Li --- .mailmap | 1 + lib/mempool/rte_mempool.h | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.mailmap b/.mailmap index 3f5bab26a81f..bfe451980f1c 100644 --- a/.mailmap +++ b/.mailmap @@ -836,6 +836,7 @@ Maciej Rabeda Maciej Szwed Madhu Chittim Madhuker Mythri +Mahesh Adulla Mahipal Challa Mah Yock Gen Mairtin o Loingsigh diff --git a/lib/mempool/rte_mempool.h b/lib/mempool/rte_mempool.h index f70bf36080fb..86598bc639e6 100644 --- a/lib/mempool/rte_mempool.h +++ b/lib/mempool/rte_mempool.h @@ -1484,7 +1484,7 @@ rte_mempool_put(struct rte_mempool *mp, void *obj) * @param cache * A pointer to a mempool cache structure. May be NULL if not needed. * @return - * - >=0: Success; number of objects supplied. + * - 0: Success; number of objects supplied. * - <0: Error; code of driver dequeue function. */ static __rte_always_inline int