patch 'hash: fix return code description in Doxygen' has been queued to stable release 22.11.6

[luca.boccassi at gmail.com]

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 <ccm at ccm.ink>
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 <ccm at ccm.ink>
Acked-by: Stephen Hemminger <stephen at networkplumber.org>
Acked-by: Vladimir Medvedkin <vladimir.medvedkin at intel.com>
---
 .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 <liucheng11 at huawei.com>
 Cheng Peng <cheng.peng5 at zte.com.cn>
 Chengwen Feng <fengchengwen at huawei.com>
 Chenmin Sun <chenmin.sun at intel.com>
+Chenming Chang <ccm at ccm.ink>
 Chenxu Di <chenxux.di at intel.com>
 Cheryl Houser <chouser at vmware.com>
 Chinh T Cao <chinh.t.cao at intel.com>
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 at dpdk.org
@@ -20 +21 @@
-index 1aca379558..111dbb0ac3 100644
+index 8aca0a656e..7e7c1a75cb 100644
@@ -23 +24 @@
-@@ -228,6 +228,7 @@ Cheng Liu <liucheng11 at huawei.com>
+@@ -215,6 +215,7 @@ Cheng Liu <liucheng11 at huawei.com>
@@ -29 +29,0 @@
- Chenyu Huang <chenyux.huang at intel.com>
@@ -30,0 +31 @@
+ Chinh T Cao <chinh.t.cao at intel.com>
@@ -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);