[dpdk-dev] [PATCH v1] doc: announce API and ABI change for librte_ether

[Bernard Iremonger]

In 17.02 five rte_eth_dev_set_vf_*** functions will be removed
from librte_ether, renamed and moved to the ixgbe PMD.

Signed-off-by: Bernard Iremonger <bernard.iremonger at intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1d274d8..20e11ac 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -53,3 +53,39 @@ Deprecation Notices
 * librte_ether: an API change is planned for 17.02 for the function
   ``_rte_eth_dev_callback_process``. In 17.02 the function will return an ``int``
   instead of ``void`` and a fourth parameter ``void *ret_param`` will be added.
+
+* librte_ether: for 17.02 it is planned to deprecate the following five functions:
+
+  ``rte_eth_dev_set_vf_rxmode``
+
+  ``rte_eth_dev_set_vf_rx``
+
+  ``rte_eth_dev_set_vf_tx``
+
+  ``rte_eth_dev_set_vf_vlan_filter``
+
+  ``rte_eth_set_vf_rate_limit``
+
+  The following fields will be removed from ``struct eth_dev_ops``:
+
+  ``eth_set_vf_rx_mode_t``
+
+  ``eth_set_vf_rx_t``
+
+  ``eth_set_vf_tx_t``
+
+  ``eth_set_vf_vlan_filter_t``
+
+  ``eth_set_vf_rate_limit_t``
+
+  The functions will be renamed to the following, and moved to the ``ixgbe`` PMD.
+
+  ``rte_pmd_ixgbe_set_vf_rxmode``
+
+  ``rte_pmd_ixgbe_set_vf_rx``
+
+  ``rte_pmd_ixgbe_set_vf_tx``
+
+  ``rte_pmd_ixgbe_set_vf_vlan_filter``
+
+  ``rte_pmd_ixgbe_set_vf_rate_limit``
-- 
2.10.1