[dpdk-dev] lib/librte_hash: fix incorrect comment for lookup

Message ID 20180412123358.30939-1-shreyansh.jain@nxp.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Shreyansh Jain April 12, 2018, 12:33 p.m. UTC
  rte_hash_lookup_with_hash() has wrong comment for its 'sig' param.

Fixes: 1a9f648be291 ("hash: fix for multi-process apps")

Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
---
 lib/librte_hash/rte_hash.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

De Lara Guarch, Pablo April 12, 2018, 2:27 p.m. UTC | #1
> -----Original Message-----
> From: Shreyansh Jain [mailto:shreyansh.jain@nxp.com]
> Sent: Thursday, April 12, 2018 1:34 PM
> To: Richardson, Bruce <bruce.richardson@intel.com>; De Lara Guarch, Pablo
> <pablo.de.lara.guarch@intel.com>
> Cc: dev@dpdk.org; Shreyansh Jain <shreyansh.jain@nxp.com>
> Subject: [PATCH] lib/librte_hash: fix incorrect comment for lookup
> 
> rte_hash_lookup_with_hash() has wrong comment for its 'sig' param.
> 
> Fixes: 1a9f648be291 ("hash: fix for multi-process apps")
> 
> Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Also, this should be backported to the stable branch, so I CC stable@dpdk.org.
  
Thomas Monjalon April 15, 2018, 1:08 p.m. UTC | #2
> > rte_hash_lookup_with_hash() has wrong comment for its 'sig' param.
> > 
> > Fixes: 1a9f648be291 ("hash: fix for multi-process apps")
> > 
> > Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
> 
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> 
> Also, this should be backported to the stable branch, so I CC stable@dpdk.org.

Applied, thanks
  

Patch

diff --git a/lib/librte_hash/rte_hash.h b/lib/librte_hash/rte_hash.h
index 3beaca71c..f71ca9fbf 100644
--- a/lib/librte_hash/rte_hash.h
+++ b/lib/librte_hash/rte_hash.h
@@ -328,7 +328,7 @@  rte_hash_lookup(const struct rte_hash *h, const void *key);
  * @param key
  *   Key to find.
  * @param sig
- *   Hash value to remove from the hash table.
+ *   Precomputed hash value for 'key'.
  * @return
  *   - -EINVAL if the parameters are invalid.
  *   - -ENOENT if the key is not found.