ethdev: fix description of tx descriptor status

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: b1b700ce7d6f ("ethdev: add descriptor status API")
Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
Signed-off-by: Didier Pallard <didier.pallard@6wind.com>

diff --git a/lib/librte_ethdev/rte_ethdev.h b/lib/librte_ethdev/rte_ethdev.h
index 36e3984eaca39c88511ca82ea8bd6a72a100a3b0..71d6ab6b46d392c59df709ed7de6b7e3ca0f45ba 100644 (file)
--- a/lib/librte_ethdev/rte_ethdev.h
+++ b/lib/librte_ethdev/rte_ethdev.h
@@ -3992,8 +3992,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.