[dpdk-dev] doc: add VxLAN GRO to release notes

Message ID 1518154117-81882-1-git-send-email-jiayu.hu@intel.com
State Accepted, archived
Headers show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Jiayu Hu Feb. 9, 2018, 5:28 a.m.
Signed-off-by: Jiayu Hu <jiayu.hu@intel.com>
---
 doc/guides/rel_notes/release_18_02.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

Comments

Mcnamara, John Feb. 9, 2018, 9:56 a.m. | #1
> -----Original Message-----
> From: Hu, Jiayu
> Sent: Friday, February 9, 2018 5:29 AM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; thomas@monjalon.net; Hu,
> Jiayu <jiayu.hu@intel.com>
> Subject: [PATCH] doc: add VxLAN GRO to release notes
> 
> Signed-off-by: Jiayu Hu <jiayu.hu@intel.com>
> ---
>  doc/guides/rel_notes/release_18_02.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/release_18_02.rst
> b/doc/guides/rel_notes/release_18_02.rst
> index c42a1d6..c2078b5 100644
> --- a/doc/guides/rel_notes/release_18_02.rst
> +++ b/doc/guides/rel_notes/release_18_02.rst
> @@ -230,6 +230,15 @@ New Features
>    current build system using ``make``. For instructions on how to do a
> DPDK build
>    using the new system, see the instructions in ``doc/build-sdk-
> meson.txt``.
> 
> +* **Add GRO support for VxLAN-tunneled packets.**
> +
> +  Add GRO support for VxLAN-tunneled packets. Supported VxLAN packets
> + must contain an outer IPv4 header and inner TCP/IPv4 headers. VxLAN
> + GRO doesn't check if input packets have correct checksums and doesn't
> + update checksums for output packets. Additionally, it assumes the
> + packets are complete (i.e., MF==0 && frag_off==0), when IP
> + fragmentation is possible (i.e., DF==0).
> +
>  .. note::
> 
>      This new build system support is incomplete at this point and is
> added

The text has been added between the previous section and a note belonging
to the previous section.

However, we can fix this in the final revision of the release notes, so:

Acked-by: John McNamara <john.mcnamara@intel.com>
Thomas Monjalon Feb. 9, 2018, 10:02 a.m. | #2
09/02/2018 10:56, Mcnamara, John:
> The text has been added between the previous section and a note belonging
> to the previous section.
> 
> However, we can fix this in the final revision of the release notes, so:

I can fix it.
I also take care of keeping a logical order in release notes features.
For example, drivers are grouped together by class, and libraries are after.

General comment about release notes:
Please try to update release notes while updating the code.
It is better for 3 reasons:
	- less chance of forgetting
	- release notes is up-to-date in RC1
	- it is better linked in the git history
Thomas Monjalon Feb. 13, 2018, 11:09 p.m. | #3
09/02/2018 11:02, Thomas Monjalon:
> 09/02/2018 10:56, Mcnamara, John:
> > The text has been added between the previous section and a note belonging
> > to the previous section.
> > 
> > However, we can fix this in the final revision of the release notes, so:
> 
> I can fix it.
> I also take care of keeping a logical order in release notes features.
> For example, drivers are grouped together by class, and libraries are after.

Applied, thanks

Patch

diff --git a/doc/guides/rel_notes/release_18_02.rst b/doc/guides/rel_notes/release_18_02.rst
index c42a1d6..c2078b5 100644
--- a/doc/guides/rel_notes/release_18_02.rst
+++ b/doc/guides/rel_notes/release_18_02.rst
@@ -230,6 +230,15 @@  New Features
   current build system using ``make``. For instructions on how to do a DPDK build
   using the new system, see the instructions in ``doc/build-sdk-meson.txt``.
 
+* **Add GRO support for VxLAN-tunneled packets.**
+
+  Add GRO support for VxLAN-tunneled packets. Supported VxLAN packets
+  must contain an outer IPv4 header and inner TCP/IPv4 headers. VxLAN
+  GRO doesn't check if input packets have correct checksums and doesn't
+  update checksums for output packets. Additionally, it assumes the
+  packets are complete (i.e., MF==0 && frag_off==0), when IP
+  fragmentation is possible (i.e., DF==0).
+
 .. note::
 
     This new build system support is incomplete at this point and is added