patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Morten Brørup <mb@smartsharesystems.com>
To: "Ferruh Yigit" <ferruh.yigit@intel.com>,
	"Lance Richardson" <lance.richardson@broadcom.com>
Cc: <dev@dpdk.org>, <stable@dpdk.org>,
	"Olivier Matz" <olivier.matz@6wind.com>,
	"Konstantin Ananyev" <konstantin.ananyev@intel.com>,
	"Andrew Rybchenko" <andrew.rybchenko@oktetlabs.ru>
Subject: Re: [dpdk-stable] [dpdk-dev] [PATCH] net: fix checksum API documentation
Date: Tue, 21 Sep 2021 12:11:24 +0200
Message-ID: <98CBD80474FA8B44BF855DF32C47DC35C61A9B@smartserver.smartshare.dk> (raw)
In-Reply-To: <38a087e1-67dc-f313-6dd6-4ce63a51be50@intel.com>

> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Ferruh Yigit
> Sent: Tuesday, 21 September 2021 11.28
> 
> On 9/17/2021 11:57 AM, Morten Brørup wrote:
> >> From: Lance Richardson [mailto:lance.richardson@broadcom.com]
> >> Sent: Thursday, 16 September 2021 18.11
> >>
> >> Minor corrections and improvements to documentation
> >> for checksum APIs.
> >>
> >> Fixes: 6006818cfb26 ("net: new checksum functions")
> >> Fixes: 45a08ef55e44 ("net: introduce functions to verify L4
> checksums")
> >> Cc: stable@dpdk.org
> >> Signed-off-by: Lance Richardson <lance.richardson@broadcom.com>
> >> ---
> >>  lib/net/rte_ip.h | 8 ++++----
> >>  1 file changed, 4 insertions(+), 4 deletions(-)
> >>
> >> diff --git a/lib/net/rte_ip.h b/lib/net/rte_ip.h
> >> index 05948b69b7..fd08ea31b2 100644
> >> --- a/lib/net/rte_ip.h
> >> +++ b/lib/net/rte_ip.h
> >> @@ -488,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)
> >> @@ -509,15 +509,15 @@ __rte_ipv6_udptcp_cksum(const struct
> rte_ipv6_hdr
> >> *ipv6_hdr, const void *l4_hdr)
> >>  /**
> >>   * 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.
> 
> Isn't this wrong for 'rte_ipv4_udptcp_cksum()' too? Since you are
> touching this,
> can you fix that one too?
> 

Ferruh, the description of the return value is technically correct; it mentions the IP packet, not the IP header.
So this change is a clarification only.

However, I agree that the same clarification would also benefit 'rte_ipv4_udptcp_cksum()'.

> >>   */
> >>  static inline uint16_t
> >>  rte_ipv6_udptcp_cksum(const struct rte_ipv6_hdr *ipv6_hdr, const
> void
> >> *l4_hdr)
> >> --
> >> 2.25.1
> >
> > Reviewed-by: Morten Brørup <mb@smartsharesystems.com>
> >
> 


  reply	other threads:[~2021-09-21 10:11 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-16 16:10 [dpdk-stable] " Lance Richardson
2021-09-17 10:57 ` Morten Brørup
2021-09-21  9:28   ` Ferruh Yigit
2021-09-21 10:11     ` Morten Brørup [this message]
2021-09-21 14:50       ` [dpdk-stable] [dpdk-dev] " Lance Richardson
2021-09-21 14:59 ` [dpdk-stable] [PATCH v2] " Lance Richardson
2021-09-22  9:16   ` Ferruh Yigit
2021-09-27 16:14     ` Olivier Matz
2021-10-07 12:43       ` Ferruh Yigit

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=98CBD80474FA8B44BF855DF32C47DC35C61A9B@smartserver.smartshare.dk \
    --to=mb@smartsharesystems.com \
    --cc=andrew.rybchenko@oktetlabs.ru \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=konstantin.ananyev@intel.com \
    --cc=lance.richardson@broadcom.com \
    --cc=olivier.matz@6wind.com \
    --cc=stable@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

patches for DPDK stable branches

This inbox may be cloned and mirrored by anyone:

	git clone --mirror http://inbox.dpdk.org/stable/0 stable/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 stable stable/ http://inbox.dpdk.org/stable \
		stable@dpdk.org
	public-inbox-index stable

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.stable


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git