From: Christian Ehrhardt <christian.ehrhardt@canonical.com>
To: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Cc: Petr Houska <t-pehous@microsoft.com>, dpdk stable <stable@dpdk.org>
Subject: [dpdk-stable] patch 'hash: fix doxygen of return values' has been queued to stable release 18.05.1
Date: Tue, 14 Aug 2018 13:06:44 +0200 [thread overview]
Message-ID: <20180814110651.25277-41-christian.ehrhardt@canonical.com> (raw)
In-Reply-To: <20180814110651.25277-1-christian.ehrhardt@canonical.com>
Hi,
FYI, your patch has been queued to stable release 18.05.1
Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 08/16/18. So please
shout if anyone has objections.
Thanks.
Christian Ehrhardt <christian.ehrhardt@canonical.com>
---
>From 8ade816d20b07670a2e8f3f595b710d0a0f36b96 Mon Sep 17 00:00:00 2001
From: Pablo de Lara <pablo.de.lara.guarch@intel.com>
Date: Tue, 7 Aug 2018 03:00:04 +0100
Subject: [PATCH] hash: fix doxygen of return values
[ upstream commit f9975d333a8d51e4c15961f56a554914288768aa ]
rte_hash_lookup_data() and rte_hash_lookup_with_hash_data()
functions return the index of the table where the key is stored
when this is found, and not 0 as the Doxygen currently states.
Also, these functions, and rte_hash_get_key_with_position()
return negative values when keys are not found (-EINVAL and -ENOENT),
where the minus sign was missing.
Bugzilla ID: 78
Fixes: 473d1bebce43 ("hash: allow to store data in hash table")
Fixes: 6dc34e0afe7a ("hash: retrieve a key given its position")
Reported-by: Petr Houska <t-pehous@microsoft.com>
Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
lib/librte_hash/rte_hash.h | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/lib/librte_hash/rte_hash.h b/lib/librte_hash/rte_hash.h
index f71ca9fbf..ed5c134b1 100644
--- a/lib/librte_hash/rte_hash.h
+++ b/lib/librte_hash/rte_hash.h
@@ -254,8 +254,8 @@ rte_hash_del_key_with_hash(const struct rte_hash *h, const void *key, hash_sig_t
* Output containing a pointer to the key
* @return
* - 0 if retrieved successfully
- * - EINVAL if the parameters are invalid.
- * - ENOENT if no valid key is found in the given position.
+ * - -EINVAL if the parameters are invalid.
+ * - -ENOENT if no valid key is found in the given position.
*/
int
rte_hash_get_key_with_position(const struct rte_hash *h, const int32_t position,
@@ -272,9 +272,11 @@ rte_hash_get_key_with_position(const struct rte_hash *h, const int32_t position,
* @param data
* Output with pointer to data returned from the hash table.
* @return
- * 0 if successful lookup
- * - 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
+ * 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.
+ * - -ENOENT if the key is not found.
*/
int
rte_hash_lookup_data(const struct rte_hash *h, const void *key, void **data);
@@ -293,9 +295,11 @@ 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
- * 0 if successful lookup
- * - 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
+ * 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.
+ * - -ENOENT if the key is not found.
*/
int
rte_hash_lookup_with_hash_data(const struct rte_hash *h, const void *key,
--
2.17.1
next prev parent reply other threads:[~2018-08-14 11:09 UTC|newest]
Thread overview: 49+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-08-14 11:06 [dpdk-stable] patch 'test: fix result printing' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'test: fix code on report' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'test: make autotest runner python 2/3 compliant' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'test: print autotest categories' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'test: improve filtering' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'mk: update targets for classified tests' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'mk: remove unnecessary test rules' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'test: fix uninitialized port configuration' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'app/testpmd: fix DCB config' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'latency: free up the memzone' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/octeontx: fix stop clearing Rx/Tx functions' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/bnxt: fix filter freeing' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/bnxt: fix memory leaks in NVM commands' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/bnxt: fix lock release on NVM write failure' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/bnxt: check access denied for HWRM commands' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/bnxt: fix RETA size' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/qede: fix interrupt handler unregister' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/qede/base: fix to clear HW indication' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/qede/base: fix GRC attention callback' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/qede: fix MAC address removal failure message' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/bnx2x: fix FW command timeout during stop' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/bnx2x: fix poll link status' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/dpaa2: remove loop for unused pool entries' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/mlx4: check RSS queues number limitation' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/mlx4: avoid stripping the glue library' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/mlx5: " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/mlx4: advertise Rx jumbo frame support' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/mlx5: fix secondary process resource leakage' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/i40e: fix device parameter parsing' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/i40e: fix rearm check in AVX2 Rx' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/i40e: revert fix of flow director check' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/avf: fix offload capabilities' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'vhost: flush IOTLB cache on new mem table handling' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/bonding: fix race condition' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/mlx5: preserve promiscuous flag for flow isolation mode' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/mlx5: preserve allmulticast " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'event: fix ring init failure handling' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'app/crypto-perf: fix auth IV offset' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'eal: fix bitmap documentation' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'examples/flow_filtering: add flow director config for i40e' " Christian Ehrhardt
2018-08-14 12:08 ` Xu, Rosen
2018-08-14 11:06 ` Christian Ehrhardt [this message]
2018-08-14 11:06 ` [dpdk-stable] patch 'net/tap: fix zeroed flow mask configurations' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'net/qede: fix ntuple filter configuration' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'kni: fix crash with null name' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'kni: fix build on RHEL 7.5' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'ethdev: fix a doxygen comment for port allocation' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'mk: fix permissions when using make install' " Christian Ehrhardt
2018-08-14 11:06 ` [dpdk-stable] patch 'maintainers: claim maintainership for ARM v7 and v8' " Christian Ehrhardt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180814110651.25277-41-christian.ehrhardt@canonical.com \
--to=christian.ehrhardt@canonical.com \
--cc=pablo.de.lara.guarch@intel.com \
--cc=stable@dpdk.org \
--cc=t-pehous@microsoft.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).