[dpdk-dev] [PATCH] doc: announce API/ABI changes for mempool

[Andrew Rybchenko]

An API/ABI changes are planned for 18.05 [1]:

 * Allow to customize how mempool objects are stored in memory.
 * Deprecate mempool XMEM API.
 * Add mempool driver ops to get information from mempool driver and
   dequeue contiguous blocks of objects if driver supports it.

[1] http://dpdk.org/ml/archives/dev/2018-January/088698.html

Signed-off-by: Andrew Rybchenko <arybchenko at solarflare.com>
---
 doc/guides/rel_notes/deprecation.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index d59ad59..9db80da 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -59,3 +59,20 @@ Deprecation Notices
   be added between the producer and consumer structures. The size of the
   structure and the offset of the fields will remain the same on
   platforms with 64B cache line, but will change on other platforms.
+
+* mempool: several API and ABI changes are planned in v18.05.
+  The following functions, introduced for Xen, which is not supported
+  anymore since v17.11, are hard to use, not used anywhere else in DPDK.
+  Therefore they will be deprecated in v18.05 and removed in v18.08:
+
+  - ``rte_mempool_xmem_create``
+  - ``rte_mempool_xmem_size``
+  - ``rte_mempool_xmem_usage``
+
+  The following changes are planned:
+
+  - removal of ``get_capabilities`` mempool ops and related flags.
+  - substitute ``register_memory_area`` with ``populate`` ops.
+  - addition of new ops to customize required memory chunk calculation,
+    customize objects population and allocate contiguous
+    block of objects if underlying driver supports it.
-- 
2.7.4