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 10AC0454E9 for ; Tue, 25 Jun 2024 02:01:30 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 0A6414113C; Tue, 25 Jun 2024 02:01:30 +0200 (CEST) Received: from mail-wm1-f49.google.com (mail-wm1-f49.google.com [209.85.128.49]) by mails.dpdk.org (Postfix) with ESMTP id 07E5140EDD for ; Tue, 25 Jun 2024 02:01:29 +0200 (CEST) Received: by mail-wm1-f49.google.com with SMTP id 5b1f17b1804b1-421b9068274so43548675e9.1 for ; Mon, 24 Jun 2024 17:01:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1719273688; x=1719878488; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=FtKK1/bcCAyu8WKxarkyVYyOnAiRI9z+leNE76dyLyQ=; b=KhV68niV111yrn8M409T8isE0VIy09WAEStwHpi4dhaOpss8hcHUDZYt7SuZVaLWDK BJi7lovMLtmT0w1XY2UDH0NpCWsPMONnmzb0wIVBoi+fClY4KOU97Evlk/7DgdeSTuSG DGO3W5LgdvouO/M4p+GDlp1WOpQyL0SIddz3d02pm12+sJ7CAhqXNpeexRG87KILRmMQ QiIYh3u9qimjG9YsoY/3URQkeiqreqBCO2OLHwLeSF2fNX8/S5GW9t1PozMPBLcxvNUJ 5Htw/6AwpilESO0WKl7fTF2NjC9LD0H+QKHQTXZPIlU/ZesgKO97siJQvnwNCSSvFNMJ diSg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1719273688; x=1719878488; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=FtKK1/bcCAyu8WKxarkyVYyOnAiRI9z+leNE76dyLyQ=; b=wxZGcctttx/pvLMDM/DUXaBQfafjINCBv/sLB8PHDchLo+b1f0p6N6moCW52Q4nF2q O0CDWHIbYLYeWNXvLa7pO+x/eaDoozLKbhdIhVBtHnYs/P7SovVst6D7sEPC/UuwglLs zQRMFhl3R25qKQCIyGME0JqoBejSX39O68y3Lzcbkh/ynwZhz+Gn5YPch9u7hIkNiVrB btEa4LrnM9ZdyMI5WHjjXpWqwYi1Z3DCrwtwNYoI/CBtEeESOp3s3l64wmeJSiT7yR46 ExaAs81oL734JR8VAvGA/aGYyAQqs/YnD4zXSz9+AJBG4VDNFgyf9MKcPYxts4KFJHGd gXJw== X-Forwarded-Encrypted: i=1; AJvYcCX1/9COCwW+g5scQQfNNDxyCUFGTWQ2qLEOekndapTxSrBn5kJ5poSQBSZpRpaRJBU+Zmv82QmF3TLdFllWC6k= X-Gm-Message-State: AOJu0Yx2lTtITyL4n5iC5CsCSXFD82YvbKBXXGJTAy3ZpwfqBd6PDfU8 5MAqjawhnB9ooQYkFjSFotFVEQ7Z5CcZdGEtmOxgZWat06beTBbP X-Google-Smtp-Source: AGHT+IEfhlKScuaLer6+k1Bx7yDPBwlSPRVhEUGshNHtQBizbat8tS+IULuZ0dkp+miiYaxn07HgEg== X-Received: by 2002:a05:600c:2e06:b0:421:7b3d:1fdb with SMTP id 5b1f17b1804b1-4248b97a240mr42008335e9.21.1719273688445; Mon, 24 Jun 2024 17:01:28 -0700 (PDT) Received: from localhost ([137.220.120.171]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-366dc9c855fsm10496285f8f.84.2024.06.24.17.01.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 24 Jun 2024 17:01:28 -0700 (PDT) From: luca.boccassi@gmail.com To: Chenming Chang Cc: Stephen Hemminger , Vladimir Medvedkin , dpdk stable Subject: patch 'hash: fix return code description in Doxygen' has been queued to stable release 22.11.6 Date: Tue, 25 Jun 2024 00:58:27 +0100 Message-Id: <20240624235907.885628-41-luca.boccassi@gmail.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20240624235907.885628-1-luca.boccassi@gmail.com> References: <20240624235907.885628-1-luca.boccassi@gmail.com> MIME-Version: 1.0 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 22.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 06/27/24. 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/bluca/dpdk-stable This queued commit can be viewed at: https://github.com/bluca/dpdk-stable/commit/07f2ecf7b3283f3637198795ff78d34ebf70c594 Thanks. Luca Boccassi --- >From 07f2ecf7b3283f3637198795ff78d34ebf70c594 Mon Sep 17 00:00:00 2001 From: Chenming Chang Date: Mon, 27 Jun 2022 21:11:21 +0800 Subject: [PATCH] hash: fix return code description in Doxygen [ upstream commit 78a632e6b52c29c5f297001181e870750eee02a7 ] The rte_hash lookup can return ZERO which is not a positive value. Fixes: af75078fece3 ("first public release") Signed-off-by: Chenming Chang Acked-by: Stephen Hemminger Acked-by: Vladimir Medvedkin --- .mailmap | 1 + lib/hash/rte_hash.h | 16 ++++++++-------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/.mailmap b/.mailmap index 8aca0a656e..7e7c1a75cb 100644 --- a/.mailmap +++ b/.mailmap @@ -215,6 +215,7 @@ Cheng Liu Cheng Peng Chengwen Feng Chenmin Sun +Chenming Chang Chenxu Di Cheryl Houser Chinh T Cao diff --git a/lib/hash/rte_hash.h b/lib/hash/rte_hash.h index a399346d02..51611e392b 100644 --- a/lib/hash/rte_hash.h +++ b/lib/hash/rte_hash.h @@ -287,7 +287,7 @@ rte_hash_add_key_with_hash_data(const struct rte_hash *h, const void *key, * @return * - -EINVAL if the parameters are invalid. * - -ENOSPC if there is no space in the hash for this key. - * - A positive value that can be used by the caller as an offset into an + * - A non-negative value that can be used by the caller as an offset into an * array of user data. This value is unique for this key. This * unique key id may be larger than the user specified entry count * when RTE_HASH_EXTRA_FLAGS_MULTI_WRITER_ADD flag is set. @@ -311,7 +311,7 @@ rte_hash_add_key(const struct rte_hash *h, const void *key); * @return * - -EINVAL if the parameters are invalid. * - -ENOSPC if there is no space in the hash for this key. - * - A positive value that can be used by the caller as an offset into an + * - A non-negative value that can be used by the caller as an offset into an * array of user data. This value is unique for this key. This * unique key ID may be larger than the user specified entry count * when RTE_HASH_EXTRA_FLAGS_MULTI_WRITER_ADD flag is set. @@ -342,7 +342,7 @@ rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t * @return * - -EINVAL if the parameters are invalid. * - -ENOENT if the key is not found. - * - A positive value that can be used by the caller as an offset into an + * - A non-negative value that can be used by the caller as an offset into an * array of user data. This value is unique for this key, and is the same * value that was returned when the key was added. */ @@ -374,7 +374,7 @@ rte_hash_del_key(const struct rte_hash *h, const void *key); * @return * - -EINVAL if the parameters are invalid. * - -ENOENT if the key is not found. - * - A positive value that can be used by the caller as an offset into an + * - A non-negative value that can be used by the caller as an offset into an * array of user data. This value is unique for this key, and is the same * value that was returned when the key was added. */ @@ -441,7 +441,7 @@ rte_hash_free_key_with_position(const struct rte_hash *h, * @param data * Output with pointer to data returned from the hash table. * @return - * - A positive value that can be used by the caller as an offset into an + * - A non-negative value that can be used by the caller as an offset into an * array of user data. This value is unique for this key, and is the same * value that was returned when the key was added. * - -EINVAL if the parameters are invalid. @@ -466,7 +466,7 @@ rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data); * @param data * Output with pointer to data returned from the hash table. * @return - * - A positive value that can be used by the caller as an offset into an + * - A non-negative value that can be used by the caller as an offset into an * array of user data. This value is unique for this key, and is the same * value that was returned when the key was added. * - -EINVAL if the parameters are invalid. @@ -489,7 +489,7 @@ rte_hash_lookup_with_hash_data(const struct rte_hash *h, const void *key, * @return * - -EINVAL if the parameters are invalid. * - -ENOENT if the key is not found. - * - A positive value that can be used by the caller as an offset into an + * - A non-negative value that can be used by the caller as an offset into an * array of user data. This value is unique for this key, and is the same * value that was returned when the key was added. */ @@ -511,7 +511,7 @@ rte_hash_lookup(const struct rte_hash *h, const void *key); * @return * - -EINVAL if the parameters are invalid. * - -ENOENT if the key is not found. - * - A positive value that can be used by the caller as an offset into an + * - A non-negative value that can be used by the caller as an offset into an * array of user data. This value is unique for this key, and is the same * value that was returned when the key was added. */ -- 2.39.2 --- Diff of the applied patch vs upstream commit (please double-check if non-empty: --- --- - 2024-06-25 00:22:16.066778136 +0100 +++ 0041-hash-fix-return-code-description-in-Doxygen.patch 2024-06-25 00:22:13.165185241 +0100 @@ -1 +1 @@ -From 78a632e6b52c29c5f297001181e870750eee02a7 Mon Sep 17 00:00:00 2001 +From 07f2ecf7b3283f3637198795ff78d34ebf70c594 Mon Sep 17 00:00:00 2001 @@ -5,0 +6,2 @@ +[ upstream commit 78a632e6b52c29c5f297001181e870750eee02a7 ] + @@ -9 +10,0 @@ -Cc: stable@dpdk.org @@ -20 +21 @@ -index 1aca379558..111dbb0ac3 100644 +index 8aca0a656e..7e7c1a75cb 100644 @@ -23 +24 @@ -@@ -228,6 +228,7 @@ Cheng Liu +@@ -215,6 +215,7 @@ Cheng Liu @@ -29 +29,0 @@ - Chenyu Huang @@ -30,0 +31 @@ + Chinh T Cao @@ -32 +33 @@ -index 7ecc021111..ba96521529 100644 +index a399346d02..51611e392b 100644 @@ -35 +36 @@ -@@ -286,7 +286,7 @@ rte_hash_add_key_with_hash_data(const struct rte_hash *h, const void *key, +@@ -287,7 +287,7 @@ rte_hash_add_key_with_hash_data(const struct rte_hash *h, const void *key, @@ -44 +45 @@ -@@ -310,7 +310,7 @@ rte_hash_add_key(const struct rte_hash *h, const void *key); +@@ -311,7 +311,7 @@ rte_hash_add_key(const struct rte_hash *h, const void *key); @@ -53 +54 @@ -@@ -341,7 +341,7 @@ rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t +@@ -342,7 +342,7 @@ rte_hash_add_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t @@ -62 +63 @@ -@@ -373,7 +373,7 @@ rte_hash_del_key(const struct rte_hash *h, const void *key); +@@ -374,7 +374,7 @@ rte_hash_del_key(const struct rte_hash *h, const void *key); @@ -71 +72 @@ -@@ -440,7 +440,7 @@ rte_hash_free_key_with_position(const struct rte_hash *h, +@@ -441,7 +441,7 @@ rte_hash_free_key_with_position(const struct rte_hash *h, @@ -80 +81 @@ -@@ -465,7 +465,7 @@ rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data); +@@ -466,7 +466,7 @@ rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data); @@ -89 +90 @@ -@@ -488,7 +488,7 @@ rte_hash_lookup_with_hash_data(const struct rte_hash *h, const void *key, +@@ -489,7 +489,7 @@ rte_hash_lookup_with_hash_data(const struct rte_hash *h, const void *key, @@ -98 +99 @@ -@@ -510,7 +510,7 @@ rte_hash_lookup(const struct rte_hash *h, const void *key); +@@ -511,7 +511,7 @@ rte_hash_lookup(const struct rte_hash *h, const void *key);