doc: announce removal of old port count function
authorThomas Monjalon <thomas@monjalon.net>
Tue, 6 Aug 2019 13:31:35 +0000 (15:31 +0200)
committerThomas Monjalon <thomas@monjalon.net>
Sat, 10 Aug 2019 20:34:39 +0000 (22:34 +0200)
The function rte_eth_dev_count() was marked as deprecated in DPDK 18.05
in commit d9a42a69febf ("ethdev: deprecate port count function").
It is planned to be removed after the next LTS release.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: David Marchand <david.marchand@redhat.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Acked-by: Jerin Jacob <jerinj@marvell.com>
doc/guides/rel_notes/deprecation.rst

index b777f9e..b08c78e 100644 (file)
@@ -71,6 +71,11 @@ Deprecation Notices
   naturally align the Ethernet header on receive and all known
   encapsulations preserve the alignment of the header.
 
   naturally align the Ethernet header on receive and all known
   encapsulations preserve the alignment of the header.
 
+* ethdev: The function ``rte_eth_dev_count`` will be removed in DPDK 20.02.
+  It is replaced by the function ``rte_eth_dev_count_avail``.
+  If the intent is to iterate over ports, ``RTE_ETH_FOREACH_*`` macros
+  are better port iterators.
+
 * ethdev: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,
 * ethdev: the legacy filter API, including
   ``rte_eth_dev_filter_supported()``, ``rte_eth_dev_filter_ctrl()`` as well
   as filter types MACVLAN, ETHERTYPE, FLEXIBLE, SYN, NTUPLE, TUNNEL, FDIR,