[dpdk-dev] [PATCH] doc: add a deprecation about the modification of the return type of promiscuous configure ops in i40e eth_dev_ops

[Jeff Guo]

Since an issue has broken out the problem that even the i40e linux kernel driver
do not support the promiscuous mode in i40e VF when use i40e linux kernel driver
as host driver, the testpmd app still show the mode configure status to be enabled.
In order to reflect the real status of the i40e linux kernel driver configure result,
some i40e eth_dev_ops about enable and disable promiscuous and all multicast mode need
to be modified the return type from void to int.
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index f502f86..2f41f67 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -41,3 +41,10 @@ Deprecation Notices
 * The mempool functions for single/multi producer/consumer are deprecated and
   will be removed in 16.11.
   It is replaced by rte_mempool_generic_get/put functions.
+
+* The i40e eth_dev_ops about enable and disable promiscuous and all multicast
+  mode are planned to modify the return type from void to int, in order to reflect
+  the real status of the hardware driver configure result to APIs users. The deprecated ops include,
+  i40evf_dev_promiscuous_enable, i40evf_dev_promiscuous_disable, i40evf_dev_allmulticast_enable,
+  i40evf_dev_allmulticast_disable, i40e_dev_promiscuous_enable, i40e_dev_promiscuous_disable,
+  i40e_dev_allmulticast_enable, i40e_dev_allmulticast_disable.
-- 
1.9.3