doc: announce API change for ethdev callback
authorBernard Iremonger <bernard.iremonger@intel.com>
Tue, 18 Oct 2016 13:38:08 +0000 (14:38 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Sun, 13 Nov 2016 13:55:53 +0000 (14:55 +0100)
The _rte_eth_dev_call_process function will change to return "int"
and a fourth parameter "void* ret_param" will be added. This change
targets release 17.02.

Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
doc/guides/rel_notes/deprecation.rst

index f7b8896..c4b1de7 100644 (file)
@@ -30,6 +30,10 @@ Deprecation Notices
   ``nb_seg_max`` and ``nb_mtu_seg_max`` providing information about number of
   segments limit to be transmitted by device for TSO/non-TSO packets.
 
+* ethdev: 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.
+
 * ABI changes are planned for 17.02 in the ``rte_mbuf`` structure: some fields
   may be reordered to facilitate the writing of ``data_off``, ``refcnt``, and
   ``nb_segs`` in one operation, because some platforms have an overhead if the