From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 1BD5B43699 for ; Thu, 7 Dec 2023 12:21:52 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 161D042F07; Thu, 7 Dec 2023 12:21:52 +0100 (CET) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mails.dpdk.org (Postfix) with ESMTP id 2340342EF4 for ; Thu, 7 Dec 2023 12:21:50 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1701948109; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=SzXD/KmYK16rGgiCM5NhAs+0MY+zV68BBkARlSqPuKc=; b=R7+7T63323FN91YNRptcWRQTAWGWOYcarwPHP0BxuSO140c1wB88OEo25yfeZbi9MaDFRF HDev5naTZnoBWVXtwLLnMuKGtvNwKdZFhK6azFJqpSyHLyxVHbFRXiVtYv4LINkS8b2hh1 nw2IzTh+Dq6uSb3K4Z2UbRRHUmVoN0k= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-434-Mp7I7IGrNFK36nzYC5lQcg-1; Thu, 07 Dec 2023 06:21:44 -0500 X-MC-Unique: Mp7I7IGrNFK36nzYC5lQcg-1 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 3D652863063; Thu, 7 Dec 2023 11:21:44 +0000 (UTC) Received: from rh.Home (unknown [10.39.192.7]) by smtp.corp.redhat.com (Postfix) with ESMTP id 57E94C15880; Thu, 7 Dec 2023 11:21:43 +0000 (UTC) From: Kevin Traynor To: Ferruh Yigit Cc: Mahesh Adulla , =?UTF-8?q?Morten=20Br=C3=B8rup?= , Huisong Li , dpdk stable Subject: patch 'mempool: fix get function documentation' has been queued to stable release 21.11.6 Date: Thu, 7 Dec 2023 11:21:08 +0000 Message-ID: <20231207112116.769502-16-ktraynor@redhat.com> In-Reply-To: <20231207112116.769502-1-ktraynor@redhat.com> References: <20231207112116.769502-1-ktraynor@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-bounces@dpdk.org Hi, FYI, your patch has been queued to stable release 21.11.6 Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet. It will be pushed if I get no objections before 12/12/23. So please shout if anyone has objections. Also note that after the patch there's a diff of the upstream commit vs the patch applied to the branch. This will indicate if there was any rebasing needed to apply to the stable branch. If there were code changes for rebasing (ie: not only metadata diffs), please double check that the rebase was correctly done. Queued patches are on a temporary branch at: https://github.com/kevintraynor/dpdk-stable This queued commit can be viewed at: https://github.com/kevintraynor/dpdk-stable/commit/1699794ad5d64e9fecce4b6d022f2446209b58da Thanks. Kevin --- >From 1699794ad5d64e9fecce4b6d022f2446209b58da Mon Sep 17 00:00:00 2001 From: Ferruh Yigit Date: Mon, 23 Oct 2023 10:38:42 +0100 Subject: [PATCH] mempool: fix get function documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit [ upstream commit 9b3233ab09ea331dcf5fb38d215d91818bef3b47 ] 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") 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 3b6d7a0069..fe94cbe1ff 100644 --- a/.mailmap +++ b/.mailmap @@ -808,4 +808,5 @@ Maciej Rabeda Maciej Szwed Madhuker Mythri +Mahesh Adulla Mahipal Challa Mah Yock Gen diff --git a/lib/mempool/rte_mempool.h b/lib/mempool/rte_mempool.h index 2b2a9dc20d..771a3a1e7f 100644 --- a/lib/mempool/rte_mempool.h +++ b/lib/mempool/rte_mempool.h @@ -1452,5 +1452,5 @@ rte_mempool_put(struct rte_mempool *mp, void *obj) * A pointer to a mempool cache structure. May be NULL if not needed. * @return - * - >=0: Success; number of objects supplied. + * - 0: Success. * - <0: Error; code of ring dequeue function. */ -- 2.43.0 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2023-12-07 11:18:59.987625216 +0000 +++ 0016-mempool-fix-get-function-documentation.patch 2023-12-07 11:18:59.636873958 +0000 @@ -1 +1 @@ -From 9b3233ab09ea331dcf5fb38d215d91818bef3b47 Mon Sep 17 00:00:00 2001 +From 1699794ad5d64e9fecce4b6d022f2446209b58da Mon Sep 17 00:00:00 2001 @@ -8,0 +9,2 @@ +[ upstream commit 9b3233ab09ea331dcf5fb38d215d91818bef3b47 ] + @@ -18 +19,0 @@ -Cc: stable@dpdk.org @@ -30 +31 @@ -index 49d3616c4c..3630e72f41 100644 +index 3b6d7a0069..fe94cbe1ff 100644 @@ -33,2 +34,2 @@ -@@ -840,4 +840,5 @@ Maciej Szwed - Madhu Chittim +@@ -808,4 +808,5 @@ Maciej Rabeda + Maciej Szwed @@ -40 +41 @@ -index df87cd231e..1303eef494 100644 +index 2b2a9dc20d..771a3a1e7f 100644 @@ -43 +44 @@ -@@ -1485,5 +1485,5 @@ rte_mempool_put(struct rte_mempool *mp, void *obj) +@@ -1452,5 +1452,5 @@ rte_mempool_put(struct rte_mempool *mp, void *obj) @@ -48 +49 @@ - * - <0: Error; code of driver dequeue function. + * - <0: Error; code of ring dequeue function.