eef01f159953b44314bce0cebc96c61b7cff2475
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
1 Deprecation
2 ===========
3
4 See the :doc:`guidelines document for details of the ABI policy </guidelines/versioning>`.
5 API and ABI deprecation notices are to be posted here.
6
7 Help to update from a previous release is provided in
8 :doc:`another section </rel_notes/updating_apps>`.
9
10
11 Deprecation Notices
12 -------------------
13
14 * Significant ABI changes are planned for struct rte_eth_dev to support up to
15   1024 queues per port. This change will be in release 2.2.
16   There is no backward compatibility planned from release 2.2.
17   All binaries will need to be rebuilt from release 2.2.
18
19 * The Macros RTE_HASH_BUCKET_ENTRIES_MAX and RTE_HASH_KEY_LENGTH_MAX are
20   deprecated and will be removed with version 2.2.
21
22 * Significant ABI changes are planned for struct rte_mbuf, struct rte_kni_mbuf,
23   and several ``PKT_RX_`` flags will be removed, to support unified packet type
24   from release 2.1. Those changes may be enabled in the upcoming release 2.1
25   with CONFIG_RTE_NEXT_ABI.
26
27 * librte_malloc library has been integrated into librte_eal. The 2.1 release
28   creates a dummy/empty malloc library to fulfill binaries with dynamic linking
29   dependencies on librte_malloc.so. Such dummy library will not be created from
30   release 2.2 so binaries will need to be rebuilt.
31
32 * The following fields have been deprecated in rte_eth_stats:
33   imissed, ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
34   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff