[v7,3/3] doc: update prog_guide and rel_notes for GRO
diff mbox series

Message ID 20200924085740.270192-4-yang_y_yi@163.com
State Accepted
Delegated to: Thomas Monjalon
Headers show
Series
  • gro: add UDP/IPv4 GRO and VXLAN UDP/IPv4 GRO support
Related show

Checks

Context Check Description
ci/iol-mellanox-Performance success Performance Testing PASS
ci/travis-robot success Travis build: passed
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

yang_y_yi Sept. 24, 2020, 8:57 a.m. UTC
From: Yi Yang <yangyi01@inspur.com>

Release 20.11 added UDP/IPv4 and VXLAN UDP/IPv4 support
for GRO, so update prog_guide and rel_notes to reflect
these changes.

Signed-off-by: Yi Yang <yangyi01@inspur.com>
---
 doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 +++---
 doc/guides/rel_notes/release_20_11.rst                | 6 ++++++
 2 files changed, 9 insertions(+), 3 deletions(-)

Comments

Jiayu Hu Sept. 27, 2020, 4:56 a.m. UTC | #1
Acked-by: Jiayu Hu <jiayu.hu@intel.com>

> -----Original Message-----
> From: yang_y_yi@163.com <yang_y_yi@163.com>
> Sent: Thursday, September 24, 2020 4:58 PM
> To: dev@dpdk.org
> Cc: Hu, Jiayu <jiayu.hu@intel.com>; thomas@monjalon.net;
> yangyi01@inspur.com; yang_y_yi@163.com
> Subject: [PATCH v7 3/3] doc: update prog_guide and rel_notes for GRO
> 
> From: Yi Yang <yangyi01@inspur.com>
> 
> Release 20.11 added UDP/IPv4 and VXLAN UDP/IPv4 support
> for GRO, so update prog_guide and rel_notes to reflect
> these changes.
> 
> Signed-off-by: Yi Yang <yangyi01@inspur.com>
> ---
>  doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 +++---
>  doc/guides/rel_notes/release_20_11.rst                | 6 ++++++
>  2 files changed, 9 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/prog_guide/generic_receive_offload_lib.rst
> b/doc/guides/prog_guide/generic_receive_offload_lib.rst
> index 5b3fb91..98a5d29 100644
> --- a/doc/guides/prog_guide/generic_receive_offload_lib.rst
> +++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst
> @@ -30,9 +30,9 @@ assumes the packets are complete (i.e., MF==0 &&
> frag_off==0), when IP
>  fragmentation is possible (i.e., DF==0). Additionally, it complies RFC
>  6864 to process the IPv4 ID field.
> 
> -Currently, the GRO library provides GRO supports for TCP/IPv4 packets and
> -VxLAN packets which contain an outer IPv4 header and an inner TCP/IPv4
> -packet.
> +Currently, the GRO library provides GRO supports for TCP/IPv4 and
> UDP/IPv4
> +packets as well as VxLAN packets which contain an outer IPv4 header and
> an
> +inner TCP/IPv4 or UDP/IPv4 packet.
> 
>  Two Sets of API
>  ---------------
> diff --git a/doc/guides/rel_notes/release_20_11.rst
> b/doc/guides/rel_notes/release_20_11.rst
> index f377ab8..b7f2b68 100644
> --- a/doc/guides/rel_notes/release_20_11.rst
> +++ b/doc/guides/rel_notes/release_20_11.rst
> @@ -78,6 +78,12 @@ New Features
>      ``--portmask=N``
>      where N represents the hexadecimal bitmask of ports used.
> 
> +* **Add UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
> +
> +  Add UDP/IPv4 GRO support for VxLAN and non-VxLAN packets. For
> +  VxLAN packets, this adds inner UDP/IPv4 support, for non-VxLAN
> +  packets, this adds UDP/IPv4 support.
> +
> 
>  Removed Items
>  -------------
> --
> 1.8.3.1
yang_y_yi Oct. 9, 2020, 6:34 a.m. UTC | #2
Thomas, only this one of this series hasn't yet been merged, maybe you missed it, also please help merge it, thanks a lot.



At 2020-09-27 12:56:54, "Hu, Jiayu" <jiayu.hu@intel.com> wrote:
>Acked-by: Jiayu Hu <jiayu.hu@intel.com>
>
>> -----Original Message-----
>> From: yang_y_yi@163.com <yang_y_yi@163.com>
>> Sent: Thursday, September 24, 2020 4:58 PM
>> To: dev@dpdk.org
>> Cc: Hu, Jiayu <jiayu.hu@intel.com>; thomas@monjalon.net;
>> yangyi01@inspur.com; yang_y_yi@163.com
>> Subject: [PATCH v7 3/3] doc: update prog_guide and rel_notes for GRO
>> 
>> From: Yi Yang <yangyi01@inspur.com>
>> 
>> Release 20.11 added UDP/IPv4 and VXLAN UDP/IPv4 support
>> for GRO, so update prog_guide and rel_notes to reflect
>> these changes.
>> 
>> Signed-off-by: Yi Yang <yangyi01@inspur.com>
>> ---
>>  doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 +++---
>>  doc/guides/rel_notes/release_20_11.rst                | 6 ++++++
>>  2 files changed, 9 insertions(+), 3 deletions(-)
>> 
>> diff --git a/doc/guides/prog_guide/generic_receive_offload_lib.rst
>> b/doc/guides/prog_guide/generic_receive_offload_lib.rst
>> index 5b3fb91..98a5d29 100644
>> --- a/doc/guides/prog_guide/generic_receive_offload_lib.rst
>> +++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst
>> @@ -30,9 +30,9 @@ assumes the packets are complete (i.e., MF==0 &&
>> frag_off==0), when IP
>>  fragmentation is possible (i.e., DF==0). Additionally, it complies RFC
>>  6864 to process the IPv4 ID field.
>> 
>> -Currently, the GRO library provides GRO supports for TCP/IPv4 packets and
>> -VxLAN packets which contain an outer IPv4 header and an inner TCP/IPv4
>> -packet.
>> +Currently, the GRO library provides GRO supports for TCP/IPv4 and
>> UDP/IPv4
>> +packets as well as VxLAN packets which contain an outer IPv4 header and
>> an
>> +inner TCP/IPv4 or UDP/IPv4 packet.
>> 
>>  Two Sets of API
>>  ---------------
>> diff --git a/doc/guides/rel_notes/release_20_11.rst
>> b/doc/guides/rel_notes/release_20_11.rst
>> index f377ab8..b7f2b68 100644
>> --- a/doc/guides/rel_notes/release_20_11.rst
>> +++ b/doc/guides/rel_notes/release_20_11.rst
>> @@ -78,6 +78,12 @@ New Features
>>      ``--portmask=N``
>>      where N represents the hexadecimal bitmask of ports used.
>> 
>> +* **Add UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
>> +
>> +  Add UDP/IPv4 GRO support for VxLAN and non-VxLAN packets. For
>> +  VxLAN packets, this adds inner UDP/IPv4 support, for non-VxLAN
>> +  packets, this adds UDP/IPv4 support.
>> +
>> 
>>  Removed Items
>>  -------------
>> --
>> 1.8.3.1
Thomas Monjalon Oct. 9, 2020, 6:48 a.m. UTC | #3
09/10/2020 08:34, yang_y_yi:
> Thomas, only this one of this series hasn't yet been merged, maybe you missed it, also please help merge it, thanks a lot.

No I did not miss it.
It has been squashed with the related code change as it should be.
Please double check.

[...]
> >>  doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 +++---
> >>  doc/guides/rel_notes/release_20_11.rst                | 6 ++++++
> >>  2 files changed, 9 insertions(+), 3 deletions(-)
yang_y_yi Oct. 9, 2020, 7:47 a.m. UTC | #4
Thomas, sorry for confusion, previous two merges did include changes against doc/guides/prog_guide/generic_receive_offload_lib.rst, but
doc/guides/rel_notes/release_20_11.rst isn't updated yet, so I posted https://patches.dpdk.org/patch/80105/ to update it, please help merge  
https://patches.dpdk.org/patch/80105/, thanks a lot.
At 2020-10-09 14:48:19, "Thomas Monjalon" <thomas@monjalon.net> wrote:
>09/10/2020 08:34, yang_y_yi:
>> Thomas, only this one of this series hasn't yet been merged, maybe you missed it, also please help merge it, thanks a lot.
>
>No I did not miss it.
>It has been squashed with the related code change as it should be.
>Please double check.
>
>[...]
>> >>  doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 +++---
>> >>  doc/guides/rel_notes/release_20_11.rst                | 6 ++++++
>> >>  2 files changed, 9 insertions(+), 3 deletions(-)
>
>
Thomas Monjalon Oct. 9, 2020, 8 a.m. UTC | #5
Please triple check, release notes were squashed and merged already.

09/10/2020 09:47, yang_y_yi:
> Thomas, sorry for confusion, previous two merges did include changes against doc/guides/prog_guide/generic_receive_offload_lib.rst, but
> doc/guides/rel_notes/release_20_11.rst isn't updated yet, so I posted https://patches.dpdk.org/patch/80105/ to update it, please help merge  
> https://patches.dpdk.org/patch/80105/, thanks a lot.
> At 2020-10-09 14:48:19, "Thomas Monjalon" <thomas@monjalon.net> wrote:
> >09/10/2020 08:34, yang_y_yi:
> >> Thomas, only this one of this series hasn't yet been merged, maybe you missed it, also please help merge it, thanks a lot.
> >
> >No I did not miss it.
> >It has been squashed with the related code change as it should be.
> >Please double check.
> >
> >[...]
> >> >>  doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 +++---
> >> >>  doc/guides/rel_notes/release_20_11.rst                | 6 ++++++
> >> >>  2 files changed, 9 insertions(+), 3 deletions(-)
yang_y_yi Oct. 9, 2020, 8:11 a.m. UTC | #6
Thomas, sorry for quick reply, update for doc/guides/rel_notes/release_20_11.rst also has been there, so please ignore this one merge request.

I'm totally confused. The version Jiayu acked is v7, here are diffstat of v7 I sent, I'm not sure why these documents are updated by previous two merges. I also interdiff two merged patches and local these two patches, diff only has document changes, this is really very weird, what happened?



diffstat 0001-gro-add-UDP-IPv4-GRO-support.patch
 gro_udp4.c  |  433 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 gro_udp4.h  |  281 ++++++++++++++++++++++++++++++++++++++
 meson.build |    2
 rte_gro.c   |   94 ++++++++++---
 rte_gro.h   |    5
 5 files changed, 798 insertions(+), 17 deletions(-)








diffstat 0002-gro-add-VXLAN-UDP-IPv4-GRO-support.patch
 gro_udp4.h       |    1
 gro_vxlan_udp4.c |  545 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 gro_vxlan_udp4.h |  153 +++++++++++++++
 meson.build      |    2
 rte_gro.c        |  115 ++++++++---
 rte_gro.h        |    3
 6 files changed, 792 insertions(+), 27 deletions(-)





$ grep "\.rst" 0001-gro-add-UDP-IPv4-GRO-support.patch

$ grep "\.rst" 0002-gro-add-VXLAN-UDP-IPv4-GRO-support.patch


At 2020-10-09 15:47:49, "yang_y_yi" <yang_y_yi@163.com> wrote:
>Thomas, sorry for confusion, previous two merges did include changes against doc/guides/prog_guide/generic_receive_offload_lib.rst, but
>doc/guides/rel_notes/release_20_11.rst isn't updated yet, so I posted https://patches.dpdk.org/patch/80105/ to update it, please help merge  
>https://patches.dpdk.org/patch/80105/, thanks a lot.
>At 2020-10-09 14:48:19, "Thomas Monjalon" <thomas@monjalon.net> wrote:
>>09/10/2020 08:34, yang_y_yi:
>>> Thomas, only this one of this series hasn't yet been merged, maybe you missed it, also please help merge it, thanks a lot.
>>
>>No I did not miss it.
>>It has been squashed with the related code change as it should be.
>>Please double check.
>>
>>[...]
>>> >>  doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 +++---
>>> >>  doc/guides/rel_notes/release_20_11.rst                | 6 ++++++
>>> >>  2 files changed, 9 insertions(+), 3 deletions(-)
>>
>>
Thomas Monjalon Oct. 9, 2020, 8:45 a.m. UTC | #7
09/10/2020 10:11, yang_y_yi:
> Thomas, sorry for quick reply, update for doc/guides/rel_notes/release_20_11.rst also has been there, so please ignore this one merge request.
> 
> I'm totally confused. The version Jiayu acked is v7, here are diffstat of v7 I sent, I'm not sure why these documents are updated by previous two merges. I also interdiff two merged patches and local these two patches, diff only has document changes, this is really very weird, what happened?

Listen, after several emails about this, I am a bit bored that you
don't double check before asking the same question again.
Look at the mail I sent to you originally:
	http://mails.dpdk.org/archives/dev/2020-October/184701.html*
"Applied with release notes changes integrated in the right commits"
Then I explained again:
"It has been squashed with the related code change as it should be."

It means I did what you were supposed to do:
merging the documentation updates in the commits which are doing
the code changes. So the changes are atomic with the doc,
which helps when digging in the git history.

You can see the result by yourself:
	http://git.dpdk.org/dpdk/commit/?id=1ca5e674
	http://git.dpdk.org/dpdk/commit/?id=e2d81106

While we are at it, please reply kindly to Olivier who is trying
to understand your issue with mbuf. You keep saying it is his fault
without giving the evidence he is asking for.
In short: please pay more attention to what the maintainers are saying.

Thank you


PS: please do not top-post


> diffstat 0001-gro-add-UDP-IPv4-GRO-support.patch
>  gro_udp4.c  |  433 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  gro_udp4.h  |  281 ++++++++++++++++++++++++++++++++++++++
>  meson.build |    2
>  rte_gro.c   |   94 ++++++++++---
>  rte_gro.h   |    5
>  5 files changed, 798 insertions(+), 17 deletions(-)
> 
> diffstat 0002-gro-add-VXLAN-UDP-IPv4-GRO-support.patch
>  gro_udp4.h       |    1
>  gro_vxlan_udp4.c |  545 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  gro_vxlan_udp4.h |  153 +++++++++++++++
>  meson.build      |    2
>  rte_gro.c        |  115 ++++++++---
>  rte_gro.h        |    3
>  6 files changed, 792 insertions(+), 27 deletions(-)
> 
> $ grep "\.rst" 0001-gro-add-UDP-IPv4-GRO-support.patch
> 
> $ grep "\.rst" 0002-gro-add-VXLAN-UDP-IPv4-GRO-support.patch
> 
> 
> At 2020-10-09 15:47:49, "yang_y_yi" <yang_y_yi@163.com> wrote:
> >Thomas, sorry for confusion, previous two merges did include changes against doc/guides/prog_guide/generic_receive_offload_lib.rst, but
> >doc/guides/rel_notes/release_20_11.rst isn't updated yet, so I posted https://patches.dpdk.org/patch/80105/ to update it, please help merge  
> >https://patches.dpdk.org/patch/80105/, thanks a lot.
> >At 2020-10-09 14:48:19, "Thomas Monjalon" <thomas@monjalon.net> wrote:
> >>09/10/2020 08:34, yang_y_yi:
> >>> Thomas, only this one of this series hasn't yet been merged, maybe you missed it, also please help merge it, thanks a lot.
> >>
> >>No I did not miss it.
> >>It has been squashed with the related code change as it should be.
> >>Please double check.
> >>
> >>[...]
> >>> >>  doc/guides/prog_guide/generic_receive_offload_lib.rst | 6 +++---
> >>> >>  doc/guides/rel_notes/release_20_11.rst                | 6 ++++++
> >>> >>  2 files changed, 9 insertions(+), 3 deletions(-)

Patch
diff mbox series

diff --git a/doc/guides/prog_guide/generic_receive_offload_lib.rst b/doc/guides/prog_guide/generic_receive_offload_lib.rst
index 5b3fb91..98a5d29 100644
--- a/doc/guides/prog_guide/generic_receive_offload_lib.rst
+++ b/doc/guides/prog_guide/generic_receive_offload_lib.rst
@@ -30,9 +30,9 @@  assumes the packets are complete (i.e., MF==0 && frag_off==0), when IP
 fragmentation is possible (i.e., DF==0). Additionally, it complies RFC
 6864 to process the IPv4 ID field.
 
-Currently, the GRO library provides GRO supports for TCP/IPv4 packets and
-VxLAN packets which contain an outer IPv4 header and an inner TCP/IPv4
-packet.
+Currently, the GRO library provides GRO supports for TCP/IPv4 and UDP/IPv4
+packets as well as VxLAN packets which contain an outer IPv4 header and an
+inner TCP/IPv4 or UDP/IPv4 packet.
 
 Two Sets of API
 ---------------
diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst
index f377ab8..b7f2b68 100644
--- a/doc/guides/rel_notes/release_20_11.rst
+++ b/doc/guides/rel_notes/release_20_11.rst
@@ -78,6 +78,12 @@  New Features
     ``--portmask=N``
     where N represents the hexadecimal bitmask of ports used.
 
+* **Add UDP/IPv4 GRO support for VxLAN and non-VxLAN packets.**
+
+  Add UDP/IPv4 GRO support for VxLAN and non-VxLAN packets. For
+  VxLAN packets, this adds inner UDP/IPv4 support, for non-VxLAN
+  packets, this adds UDP/IPv4 support.
+
 
 Removed Items
 -------------