[19.11,V2,02/12] ethdev: fix description of tx descriptor status
Checks
Commit Message
From: Olivier Matz <olivier.matz@6wind.com>
The API comment of rte_eth_tx_descriptor_status() was incorrect. The
reference descriptor (when offset = 0) is not where the next packet
will be sent, but where the latest packet has been enqueued.
Fixes: 52f5cdd2e897 ("ethdev: add descriptor status API")
Cc: stable@dpdk.org
Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
---
lib/librte_ethdev/rte_ethdev.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
@@ -4245,8 +4245,8 @@ rte_eth_rx_descriptor_status(uint16_t port_id, uint16_t queue_id,
* @param queue_id
* A valid Tx queue identifier on this port.
* @param offset
- * The offset of the descriptor starting from tail (0 is the place where
- * the next packet will be send).
+ * The offset of the descriptor starting from tail (0 is the last written
+ * descriptor).
*
* @return
* - (RTE_ETH_TX_DESC_FULL) Descriptor is being processed by the hw, i.e.