doc: announce driver name changes
[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 log history is deprecated.
12   It is voided in 16.07 and will be removed in release 16.11.
13
14 * The ethdev hotplug API is going to be moved to EAL with a notification
15   mechanism added to crypto and ethdev libraries so that hotplug is now
16   available to both of them. This API will be stripped of the device arguments
17   so that it only cares about hotplugging.
18
19 * Structures embodying pci and vdev devices are going to be reworked to
20   integrate new common rte_device / rte_driver objects (see
21   http://dpdk.org/ml/archives/dev/2016-January/031390.html).
22   ethdev and crypto libraries will then only handle those objects so that they
23   do not need to care about the kind of devices that are being used, making it
24   easier to add new buses later.
25
26 * The mbuf flags PKT_RX_VLAN_PKT and PKT_RX_QINQ_PKT are deprecated and
27   are respectively replaced by PKT_RX_VLAN_STRIPPED and
28   PKT_RX_QINQ_STRIPPED, that are better described. The old flags and
29   their behavior will be kept in 16.07 and will be removed in 16.11.
30
31 * The APIs rte_mempool_count and rte_mempool_free_count are being deprecated
32   on the basis that they are confusing to use - free_count actually returns
33   the number of allocated entries, not the number of free entries as expected.
34   They are being replaced by rte_mempool_avail_count and
35   rte_mempool_in_use_count respectively.
36
37 * The mempool functions for single/multi producer/consumer are deprecated and
38   will be removed in 16.11.
39   It is replaced by rte_mempool_generic_get/put functions.
40
41 * Driver names are quite inconsistent among each others and they will be
42   renamed to something more consistent (net and crypto prefixes) in 16.11.
43   Some of these driver names are used publicly, to create virtual devices,
44   so a deprecation notice is necessary.