patch 'net: fix checksum API documentation' has been queued to stable release 19.11.11

[christian.ehrhardt at canonical.com]

Hi,

FYI, your patch has been queued to stable release 19.11.11

Note it hasn't been pushed to http://dpdk.org/browse/dpdk-stable yet.
It will be pushed if I get no objections before December 10th 2021. 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.

Queued patches are on a temporary branch at:
https://github.com/cpaelzer/dpdk-stable-queue

This queued commit can be viewed at:
https://github.com/cpaelzer/dpdk-stable-queue/commit/0b9f46c0b78feacbbcfba8a1417f6926d83dd5aa

Thanks.

Christian Ehrhardt <christian.ehrhardt at canonical.com>

---
>From 0b9f46c0b78feacbbcfba8a1417f6926d83dd5aa Mon Sep 17 00:00:00 2001
From: Lance Richardson <lance.richardson at broadcom.com>
Date: Tue, 21 Sep 2021 10:59:24 -0400
Subject: [PATCH] net: fix checksum API documentation

[ upstream commit dc954ae73aab9aaf45b8d5ce42f4490773dd1fab ]

Minor corrections and improvements to documentation
for checksum APIs.

Fixes: 6006818cfb26 ("net: new checksum functions")
Fixes: 45a08ef55e44 ("net: introduce functions to verify L4 checksums")

Signed-off-by: Lance Richardson <lance.richardson at broadcom.com>
Acked-by: Ferruh Yigit <ferruh.yigit at intel.com>
Acked-by: Olivier Matz <olivier.matz at 6wind.com>
---
 lib/librte_net/rte_ip.h | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/lib/librte_net/rte_ip.h b/lib/librte_net/rte_ip.h
index f03db05e18..cedfd27ac1 100644
--- a/lib/librte_net/rte_ip.h
+++ b/lib/librte_net/rte_ip.h
@@ -322,15 +322,14 @@ rte_ipv4_phdr_cksum(const struct rte_ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
 /**
  * Process the IPv4 UDP or TCP checksum.
  *
- * The IPv4 header should not contains options. The IP and layer 4
- * checksum must be set to 0 in the packet by the caller.
+ * The layer 4 checksum must be set to 0 in the L4 header by the caller.
  *
  * @param ipv4_hdr
  *   The pointer to the contiguous IPv4 header.
  * @param l4_hdr
  *   The pointer to the beginning of the L4 header.
  * @return
- *   The complemented checksum to set in the IP packet.
+ *   The complemented checksum to set in the L4 header.
  */
 static inline uint16_t
 rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
@@ -423,15 +422,15 @@ rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
 /**
  * Process the IPv6 UDP or TCP checksum.
  *
- * The IPv4 header should not contains options. The layer 4 checksum
- * must be set to 0 in the packet by the caller.
+ * The IPv6 header must not be followed by extension headers. The layer 4
+ * checksum must be set to 0 in the L4 header by the caller.
  *
  * @param ipv6_hdr
  *   The pointer to the contiguous IPv6 header.
  * @param l4_hdr
  *   The pointer to the beginning of the L4 header.
  * @return
- *   The complemented checksum to set in the IP packet.
+ *   The complemented checksum to set in the L4 header.
  */
 static inline uint16_t
 rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
-- 
2.34.0

---
  Diff of the applied patch vs upstream commit (please double-check if non-empty:
---
--- -	2021-11-30 16:50:09.442171659 +0100
+++ 0059-net-fix-checksum-API-documentation.patch	2021-11-30 16:50:05.726873060 +0100
@@ -1 +1 @@
-From dc954ae73aab9aaf45b8d5ce42f4490773dd1fab Mon Sep 17 00:00:00 2001
+From 0b9f46c0b78feacbbcfba8a1417f6926d83dd5aa Mon Sep 17 00:00:00 2001
@@ -5,0 +6,2 @@
+[ upstream commit dc954ae73aab9aaf45b8d5ce42f4490773dd1fab ]
+
@@ -11 +12,0 @@
-Cc: stable at dpdk.org
@@ -17,2 +18,2 @@
- lib/net/rte_ip.h | 13 ++++++-------
- 1 file changed, 6 insertions(+), 7 deletions(-)
+ lib/librte_net/rte_ip.h | 11 +++++------
+ 1 file changed, 5 insertions(+), 6 deletions(-)
@@ -20,5 +21,5 @@
-diff --git a/lib/net/rte_ip.h b/lib/net/rte_ip.h
-index bbd8650962..b3d45e85db 100644
---- a/lib/net/rte_ip.h
-+++ b/lib/net/rte_ip.h
-@@ -372,15 +372,14 @@ __rte_ipv4_udptcp_cksum(const struct rte_ipv4_hdr *ipv4_hdr, const void *l4_hdr)
+diff --git a/lib/librte_net/rte_ip.h b/lib/librte_net/rte_ip.h
+index f03db05e18..cedfd27ac1 100644
+--- a/lib/librte_net/rte_ip.h
++++ b/lib/librte_net/rte_ip.h
+@@ -322,15 +322,14 @@ rte_ipv4_phdr_cksum(const struct rte_ipv4_hdr *ipv4_hdr, uint64_t ol_flags)
@@ -28,2 +29,2 @@
-- * The IP and layer 4 checksum must be set to 0 in the packet by
-- * the caller.
+- * The IPv4 header should not contains options. The IP and layer 4
+- * checksum must be set to 0 in the packet by the caller.
@@ -42,10 +43 @@
-@@ -489,7 +488,7 @@ rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)
- }
- 
- /**
-- * @internal Calculate the non-complemented IPv4 L4 checksum
-+ * @internal Calculate the non-complemented IPv6 L4 checksum
-  */
- static inline uint16_t
- __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
-@@ -510,15 +509,15 @@ __rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const void *l4_hdr)
+@@ -423,15 +422,15 @@ rte_ipv6_phdr_cksum(const struct rte_ipv6_hdr *ipv6_hdr, uint64_t ol_flags)