doc: announce ABI changes for external mempool manager
authorDavid Hunt <david.hunt@intel.com>
Thu, 10 Mar 2016 11:55:40 +0000 (11:55 +0000)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Mon, 4 Apr 2016 14:50:43 +0000 (16:50 +0200)
Announce the ABI breakage due to addition of external mempool
manager functionality which requires changes to rte_mempool
structure.

Signed-off-by: David Hunt <david.hunt@intel.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Keith Wiles <keith.wiles@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
doc/guides/rel_notes/deprecation.rst

index 8bd0340..ad31355 100644 (file)
@@ -31,3 +31,12 @@ Deprecation Notices
   code affected is app/test/test_mempool.c and librte_mempool/rte_mempool.[ch].
   The rte_mempool.local_cache will be converted from an array to a pointer to
   allow for dynamic allocation of the per lcore cache memory.
+
+* The rte_mempool struct will be changed in 16.07 to facilitate the new
+  external mempool manager functionality.
+  The ring element will be replaced with a more generic 'pool' opaque pointer
+  to allow new mempool handlers to use their own user-defined mempool
+  layout. Also newly added to rte_mempool is a handler index.
+  The existing API will be backward compatible, but there will be new API
+  functions added to facilitate the creation of mempools using an external
+  handler. The 16.07 release will contain these changes.