doc: announce ethdev API change for preferred burst size
authorShreyansh Jain <shreyansh.jain@nxp.com>
Mon, 5 Feb 2018 06:22:22 +0000 (11:52 +0530)
committerThomas Monjalon <thomas@monjalon.net>
Wed, 14 Feb 2018 17:27:41 +0000 (18:27 +0100)
commit0ab44211c73c2d189bf45fdf8c4aad105873fc27
treee9c267e601ae383ed3223361b3732ff2af054516
parent676b605182a5dd3a4882d99701ea6bf798bf8844
doc: announce ethdev API change for preferred burst size

rte_eth_rx_burst(..,nb_pkts) function has semantic that if return value
is smaller than requested, application can consider it end of packet
stream. Some hardware can only support smaller burst sizes which need
to be advertised. Similar is the case for Tx burst.

This patch adds deprecation notice for rte_eth_dev_info structure as
new members, for preferred Rx and Tx burst and ring size would be
added - impacting the size of the structure.

Signed-off-by: Shreyansh Jain <shreyansh.jain@nxp.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Zhiyong Yang <zhiyong.yang@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
doc/guides/rel_notes/deprecation.rst