From patchwork Mon Oct 23 09:38:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Ferruh Yigit X-Patchwork-Id: 133168 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 13BD3431E0; Mon, 23 Oct 2023 11:39:01 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 02CA0410FB; Mon, 23 Oct 2023 11:39:01 +0200 (CEST) Received: from NAM04-DM6-obe.outbound.protection.outlook.com (mail-dm6nam04on2072.outbound.protection.outlook.com [40.107.102.72]) by mails.dpdk.org (Postfix) with ESMTP id AC66C40270; Mon, 23 Oct 2023 11:38:59 +0200 (CEST) ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=R6pPZeU4TSbr3w/koQUWNBiIPADcnhiAcx9ZX6lIoMas7z9m1lTMuulvZ5kt8UeiCBRynvjh9z0/100BHVgg+wV4ejSy9hK1ljv6hpWyB7jQNmPtrRq8cGTHt5xUiqINWKeSNPYAkM4MukZi+QHZCu+0eUylTRb4iAoaRQ7f4vlJnxRWvZwkKOnbKBgnej84D6MoYAMh+TD5TIyyPXpf3xwqEytY6vJNoo/5gKPSCCycM3QkNRj6Tn824ax7fvO5K6pbEr3cWm+wRbDRQMSy9qkMsVNBr5Uo2AokTAiIdDXB27CXpGMZvkcf9SfCakRs9k6swG1njjXIS2hw4ukRGg== 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=m4Ibqym4M6unAqn3QyxxkSadlJzpF1v4n3eL1NkCp8o=; b=AF38nXJWlDuiI5B3K4EKcCvt1pWSASSvmj/LFTqE6Zd+Z9UierIMM35CTVXKB4JYpkS7uMnooz7UHOux06zL8mxoT/exSA8ub6Is8b2PZBfYahqTU3xQmKy2/M0xquM2h75PWr9AdoMhFdxlituf7/Fb+Z6MDVKrPme6lGIheY/v/fH+imPU/RmFKqX85aXGV5Tb5vHErHoZLooXC8iYyrNTOVsxkVRFlvcIkvV2r23hfQ0TndBBFGp+emCsXY9/ruB093JbD/mKflRJxZ6wqMVFrM5c0pkt9XTwpnkujEov19fqv5fXiqdn1zPDl/FCyKVT1suV4mtl3cj+lG586w== 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=m4Ibqym4M6unAqn3QyxxkSadlJzpF1v4n3eL1NkCp8o=; b=b62MMd/bAy8RIhWZZQhbVFUEEirmCtf41yERt/Ti+bB86Iups9f+3v1jxzkR7U1kubi7RlkEb04cJFy5KHavL2JJtLb5ar01bOCEyzHHV2JHKX+bpTTnsrARWfNsxqvF3EKEq8m2HirYqHnKlBySDNTAiPfr5jpKroevj9SjgPc= Received: from DM6PR07CA0097.namprd07.prod.outlook.com (2603:10b6:5:337::30) by SN7PR12MB7417.namprd12.prod.outlook.com (2603:10b6:806:2a4::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6907.29; Mon, 23 Oct 2023 09:38:56 +0000 Received: from CY4PEPF0000EE37.namprd05.prod.outlook.com (2603:10b6:5:337:cafe::fe) by DM6PR07CA0097.outlook.office365.com (2603:10b6:5:337::30) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6907.33 via Frontend Transport; Mon, 23 Oct 2023 09:38:56 +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 CY4PEPF0000EE37.mail.protection.outlook.com (10.167.242.43) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.6933.15 via Frontend Transport; Mon, 23 Oct 2023 09:38:55 +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; Mon, 23 Oct 2023 04:38:54 -0500 From: Ferruh Yigit To: Thomas Monjalon , Andrew Rybchenko CC: , , Mahesh Adulla , =?utf-8?q?Morten_Br=C3=B8rup?= , Huisong Li Subject: [PATCH v2 1/2] mempool: fix internal function documentation Date: Mon, 23 Oct 2023 10:38:42 +0100 Message-ID: <20231023093844.4150572-1-ferruh.yigit@amd.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231020144647.1682698-1-ferruh.yigit@amd.com> References: <20231020144647.1682698-1-ferruh.yigit@amd.com> 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: CY4PEPF0000EE37:EE_|SN7PR12MB7417:EE_ X-MS-Office365-Filtering-Correlation-Id: 6dda0b61-b34a-4f68-6b55-08dbd3abe053 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: VDZzxpTlbC+SCvW/BonmdIihYwwwKtrdISkOSMhr4uhfRbbNrJuvYY2zAFeQB9MTNEnroSFPwBWcz280vRut/8g/TrO16UVLWrus0kX+N3q6tu+Wb0ZfdxvrP7zs9CUKYRh26ZQ4S6nJfL7GgzrxcQzcPRxPJsy9u1opYsg39oBD/O8gGnCzTNZ2m5mFy80nDHGKWzhU+cRP+qsOn9LQFcfe/5ec1y43Cs+mZLMOZ5PBJp14j/NRDABFSKZfw3mC33jwzH4tQnZ19mWw+KFjExK08mb1LGagV5ptnFLvCLU4NRs6U0p4TRrCMv1vuw26jFQQPIxPJgkTUp0su5cbvvOYAAvEflBMLEZ6kpVbAUvaMW1FKKxsrQn7fdD3TmIIDO/gWYKcbfAbQiIYz3hGlrw5uHi1tgQKsUwTtGwKxEi3F30aQx4USyVuwI1V9z3Ycju9l/8kAxWMu6RG0eYzuD+MGTLucJutdUuHe3IdjRMej5VLOQ9q8kyELP7YhoZsUPbLj6OoddIgzx6NVy38XDeTctlPEMbjS1DQdHva42DGmyPEKWbbsHOBqlHrl2kuvHxFlgaS7cQj2oFgoeqiynYNo6GX5Fcy7aVIZAxxaZ/tfMqa9x9Ss8dKuSiEDaE3b/qUmo3MZdjkO5LWvUumBXDm8qeCw0hPsBvK1ALG+GKnrNWpIv5nvKAYkeU3Wts6T2NjKLUvemqX6OxFHAo8iIeuX3UbPl3TjBVwDIrXvhoKg111lhgjXQDflDWQGPtDl/t63uCp1DgPmTdUTtD3lw== 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)(346002)(396003)(39860400002)(136003)(376002)(230922051799003)(186009)(451199024)(64100799003)(1800799009)(82310400011)(36840700001)(40470700004)(46966006)(2906002)(36860700001)(316002)(70586007)(70206006)(6666004)(54906003)(81166007)(82740400003)(2616005)(356005)(16526019)(1076003)(110136005)(478600001)(7696005)(40480700001)(47076005)(336012)(426003)(66574015)(83380400001)(36756003)(44832011)(41300700001)(40460700003)(86362001)(5660300002)(4326008)(8936002)(8676002)(26005)(36900700001); DIR:OUT; SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Oct 2023 09:38:55.8551 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 6dda0b61-b34a-4f68-6b55-08dbd3abe053 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: CY4PEPF0000EE37.namprd05.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN7PR12MB7417 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