doc: announce deprecation of rte_mbuf_extbuf_free_callback_t
diff mbox series

Message ID 20200730125555.43908-1-yang_y_yi@163.com
State New
Delegated to: Thomas Monjalon
Headers show
Series
  • doc: announce deprecation of rte_mbuf_extbuf_free_callback_t
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

yang_y_yi July 30, 2020, 12:55 p.m. UTC
From: Yi Yang <yangyi01@inspur.com>

typedef rte_mbuf_extbuf_free_callback_t will be deprecated
in 20.08 release.

Signed-off-by: Yi Yang <yangyi01@inspur.com>
---
 doc/guides/rel_notes/deprecation.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 99c9806..df60e06 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -135,6 +135,14 @@  Deprecation Notices
   will be removed in 20.11. It will be replaced with ``refcnt`` of type
   ``uint16_t``.
 
+* rte_mbuf_ext_shared_info: typedef of ``free_cb`` member in structure
+  ``rte_mbuf_ext_shared_info`` ``rte_mbuf_extbuf_free_callback_t`` will be
+  changed to adapt to GSO case, new typedef will be
+  ``void (*rte_mbuf_extbuf_free_callback_t)(struct rte_mbuf *, void *)``,
+  it is impossible to free original owner mbuf of shinfo by ``free_cb`` and
+  keep compatible with non-GSO case at the same time without this change.
+  It will be deprecated in 20.08.
+
 * metrics: The function ``rte_metrics_init`` will have a non-void return
   in order to notify errors instead of calling ``rte_exit``.