[dpdk-dev] [PATCH] doc: announce ABI change for ring structure

[Olivier Matz]

As discussed on the mailing list, the alignment constraint of
the ring structure can be relaxed.

Link: http://dpdk.org/dev/patchwork/patch/25039
Link: http://dpdk.org/dev/patchwork/patch/26103

Signed-off-by: Olivier Matz <olivier.matz at 6wind.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 3362f3350..5a63c0277 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -120,3 +120,9 @@ Deprecation Notices
   The non-"do-sig" versions of the hash tables will be removed
   (including the ``signature_offset`` parameter)
   and the "do-sig" versions renamed accordingly.
+
+* ring: The alignment constraints on the ring structure will be relaxed
+  to one cache line instead of two, and an empty cache line padding will
+  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.
-- 
2.11.0