doc: announce ABI change for RETA configuration
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
1 ABI and API Deprecation
2 =======================
3
4 See the :doc:`guidelines document for details of the ABI policy </contributing/versioning>`.
5 API and ABI deprecation notices are to be posted here.
6
7
8 Deprecation Notices
9 -------------------
10
11 * The following fields have been deprecated in rte_eth_stats:
12   ibadcrc, ibadlen, imcasts, fdirmatch, fdirmiss,
13   tx_pause_xon, rx_pause_xon, tx_pause_xoff, rx_pause_xoff
14
15 * ABI changes is planned for the reta field in struct rte_eth_rss_reta_entry64
16   which handles at most 256 entries (8 bits) while newer NICs support larger
17   tables (512 entries).
18   It should be integrated in release 2.3.
19
20 * The scheduler statistics structure will change to allow keeping track of
21   RED actions.
22
23 * librte_pipeline: The prototype for the pipeline input port, output port
24   and table action handlers will be updated:
25   the pipeline parameter will be added, the packets mask parameter will be
26   either removed (for input port action handler) or made input-only.
27
28 * ABI changes are planned in cmdline buffer size to allow the use of long
29   commands (such as RETA update in testpmd).  This should impact
30   CMDLINE_PARSE_RESULT_BUFSIZE, STR_TOKEN_SIZE and RDLINE_BUF_SIZE.
31   It should be integrated in release 2.3.