doc: announce ethdev API changes for callbacks
authorFerruh Yigit <ferruh.yigit@intel.com>
Fri, 9 Feb 2018 10:18:18 +0000 (10:18 +0000)
committerThomas Monjalon <thomas@monjalon.net>
Wed, 14 Feb 2018 17:29:04 +0000 (18:29 +0100)
Ethdev APIs to add callback return the callback object as "void *",
update return type to actual object type
"struct rte_eth_rxtx_callback *"

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
doc/guides/rel_notes/deprecation.rst

index 7f90ef7..796b139 100644 (file)
@@ -142,6 +142,13 @@ Deprecation Notices
   successful. This modification will only impact the PMDs, not the
   applications.
 
+* ethdev: functions add rx/tx callback will return named opaque type
+  ``rte_eth_add_rx_callback()``, ``rte_eth_add_first_rx_callback()`` and
+  ``rte_eth_add_tx_callback()`` functions currently return callback object as
+  ``void \*`` but APIs to delete callbacks get ``struct rte_eth_rxtx_callback \*``
+  as parameter. For consistency functions adding callback will return
+  ``struct rte_eth_rxtx_callback \*`` instead of ``void \*``.
+
 * i40e: The default flexible payload configuration which extracts the first 16
   bytes of the payload for RSS will be deprecated starting from 18.02. If
   required the previous behavior can be configured using existing flow