[dpdk-dev] doc: update ethdev APIs to return named opaque type

Message ID 20180209101119.69860-1-ferruh.yigit@intel.com (mailing list archive)
State Superseded, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Ferruh Yigit Feb. 9, 2018, 10:11 a.m. UTC
  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>
---
Cc: Konstantin Ananyev <konstantin.ananyev@intel.com>
Cc: Stephen Hemminger <stephen@networkplumber.org>
Cc: Bruce Richardson <bruce.richardson@intel.com>
Cc: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index bbd9456a7..b6479cd5a 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -49,6 +49,13 @@  Deprecation Notices
   rte_eth_dev_get_sec_ctx() is using uint8_t for port_id, which should be
   uint16_t.
 
+* ethdev: add rx/tx callback functions return named opaque type
+  rte_eth_add_rx_callback(), rte_eth_add_first_rx_callback() and
+  rte_eth_add_tx_callback() functions currently return "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