Following the discussion on dpdk-users [1], enhance the API documentation of rte_eth_tx_burst() to specify that the mbufs have to be allocated from a pool.
[1] http://dpdk.org/ml/archives/users/2016-June/000618.html Reported-by: Wu Xiaoban <Xiaoban_Wu at student.uml.edu> Signed-off-by: Olivier Matz <olivier.matz at 6wind.com> --- lib/librte_ether/rte_ethdev.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index 2757510..e5e91e4 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -2683,7 +2683,8 @@ rte_eth_rx_descriptor_done(uint8_t port_id, uint16_t queue_id, uint16_t offset) * on the output queue *queue_id* of the Ethernet device designated by its * *port_id*. * The *nb_pkts* parameter is the number of packets to send which are - * supplied in the *tx_pkts* array of *rte_mbuf* structures. + * supplied in the *tx_pkts* array of *rte_mbuf* structures, each of them + * allocated from a pool created with rte_pktmbuf_pool_create(). * The rte_eth_tx_burst() function loops, sending *nb_pkts* packets, * up to the number of transmit descriptors available in the TX ring of the * transmit queue. -- 2.8.0.rc3
