[dpdk-stable] patch 'doc: add GRO limitations in programmers guide' has been queued to LTS release 18.11.1

[Kevin Traynor <ktraynor@redhat.com>]

Hi,

FYI, your patch has been queued to LTS release 18.11.1

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before 02/14/19. So please
shout if anyone has objections.

Also note that after the patch there's a diff of the upstream commit vs the
patch applied to the branch. This will indicate if there was any rebasing
needed to apply to the stable branch. If there were code changes for rebasing
(ie: not only metadata diffs), please double check that the rebase was
correctly done.

Thanks.

Kevin Traynor

---
>From f31db6a62d113c999a2b1db6e234cffb65350077 Mon Sep 17 00:00:00 2001
From: Jiayu Hu <jiayu.hu@intel.com>
Date: Wed, 16 Jan 2019 10:13:42 +0800
Subject: [PATCH] doc: add GRO limitations in programmers guide

[ upstream commit 5bd5f7b3aee8d0d9cef658c47c7f7544e657ae96 ]

This patch adds GRO limitations in the programmer guide.

Fixes: 2c900d09055e ("doc: add GRO guide")

Signed-off-by: Jiayu Hu <jiayu.hu@intel.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
---
 .../generic_receive_offload_lib.rst           | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/doc/guides/prog_guide/generic_receive_offload_lib.rst b/doc/guides/prog_guide/generic_receive_offload_lib.rst
index 9c6a4d08c..5b3fb91c8 100644
--- a/doc/guides/prog_guide/generic_receive_offload_lib.rst
+++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst
@@ -192,2 +192,21 @@ Header fields deciding if packets are neighbors include:
         Additionally, packets which have different value of DF bit can't
         be merged.
+
+GRO Library Limitations
+-----------------------
+
+- GRO library uses MBUF->l2_len/l3_len/l4_len/outer_l2_len/
+  outer_l3_len/packet_type to get protocol headers for the
+  input packet, rather than parsing the packet header. Therefore,
+  before call GRO APIs to merge packets, user applications
+  must set MBUF->l2_len/l3_len/l4_len/outer_l2_len/outer_l3_len/
+  packet_type to the same values as the protocol headers of the
+  packet.
+
+- GRO library doesn't support to process the packets with IPv4
+  Options or VLAN tagged.
+
+- GRO library just supports to process the packet organized
+  in a single MBUF. If the input packet consists of multiple
+  MBUFs (i.e. chained MBUFs), GRO reassembly behaviors are
+  unknown.
-- 
2.19.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2019-02-07 13:19:56.016060600 +0000
+++ 0021-doc-add-GRO-limitations-in-programmers-guide.patch	2019-02-07 13:19:55.000000000 +0000
@@ -1,12 +1,13 @@
-From 5bd5f7b3aee8d0d9cef658c47c7f7544e657ae96 Mon Sep 17 00:00:00 2001
+From f31db6a62d113c999a2b1db6e234cffb65350077 Mon Sep 17 00:00:00 2001
 From: Jiayu Hu <jiayu.hu@intel.com>
 Date: Wed, 16 Jan 2019 10:13:42 +0800
 Subject: [PATCH] doc: add GRO limitations in programmers guide
 
+[ upstream commit 5bd5f7b3aee8d0d9cef658c47c7f7544e657ae96 ]
+
 This patch adds GRO limitations in the programmer guide.
 
 Fixes: 2c900d09055e ("doc: add GRO guide")
-Cc: stable@dpdk.org
 
 Signed-off-by: Jiayu Hu <jiayu.hu@intel.com>
 Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>