[dpdk-dev] [PATCH 2/2] doc: announce new mbuf field for LRO

[Matan Azrad <matan@mellanox.com>]

The API breakage is because the ``tso_segsz`` field was documented for
LRO.

The ``tso_segsz`` field in mbuf indicates the size of each segment in
the LRO packet in Rx path and should be provided by the LRO packet
port.

While the generic LRO packet may aggregate different segments sizes in
one packet, it is impossible to expose this information for each segment
by one field and it doesn't make sense to expose all the segments sizes
in the mbuf.

A new field may be added as union with the above field to expose the
number of segments aggregated in the LRO packet.

Signed-off-by: Matan Azrad <matan@mellanox.com>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index c0cd9bc..e826b69 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -45,6 +45,10 @@ Deprecation Notices
   - ``eal_parse_pci_DomBDF`` replaced by ``rte_pci_addr_parse``
   - ``rte_eal_compare_pci_addr`` replaced by ``rte_pci_addr_cmp``
 
+* mbuf: Remove ``tso_segsz`` mbuf field providing for LRO support. Use union
+  block for the field memory to be shared with a new field ``lro_segs_n``
+  indicates the number of segments aggregated in the LRO packet.
+
 * dpaa2: removal of ``rte_dpaa2_memsegs`` structure which has been replaced
   by a pa-va search library. This structure was earlier being used for holding
   memory segments used by dpaa2 driver for faster pa->va translation. This
-- 
1.8.3.1