[v2] reta_query: Doc requirements on reta_conf

Message ID 20190405131337.32589-1-barbette@kth.se (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series [v2] reta_query: Doc requirements on reta_conf |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Performance-Testing success Performance Testing PASS
ci/mellanox-Performance-Testing success Performance Testing PASS

Commit Message

Tom Barbette April 5, 2019, 1:13 p.m. UTC
  Clarify the fact that mask bits should be set in rte_eth_reta_query.

v2:
- Change documentation string as suggested by Ferruh

Signed-off-by: Tom Barbette <barbette@kth.se>
---
 lib/librte_ethdev/rte_ethdev.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
  

Comments

Ferruh Yigit April 5, 2019, 1:44 p.m. UTC | #1
On 4/5/2019 2:13 PM, Tom Barbette wrote:
> Clarify the fact that mask bits should be set in rte_eth_reta_query.
> 
> v2:
> - Change documentation string as suggested by Ferruh
> 
> Signed-off-by: Tom Barbette <barbette@kth.se>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied to dpdk-next-net/master, thanks.
  

Patch

diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index e254da8b1..2a49fd2e2 100644
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -2941,7 +2941,8 @@  int rte_eth_dev_rss_reta_update(uint16_t port_id,
  * @param port_id
  *   The port identifier of the Ethernet device.
  * @param reta_conf
- *   RETA to query.
+ *   RETA to query. For each requested reta entry, corresponding bit
+ *   in mask must be set.
  * @param reta_size
  *   Redirection table size. The table size can be queried by
  *   rte_eth_dev_info_get().