DPDK patches and discussions
 help / color / mirror / Atom feed
From: Euan Bourke <euan.bourke@intel.com>
To: dev@dpdk.org
Cc: Euan Bourke <euan.bourke@intel.com>,
	stable@dpdk.org, Thomas Monjalon <thomas@monjalon.net>,
	Konstantin Ananyev <konstantin.v.ananyev@yandex.ru>
Subject: [PATCH v4 1/2] doc: updated incorrect value for IP frag max fragments
Date: Mon,  8 Jan 2024 11:36:13 +0000	[thread overview]
Message-ID: <20240108113614.3860138-1-euan.bourke@intel.com> (raw)
In-Reply-To: <20231221174140.3369894-1-euan.bourke@intel.com>

Docs for IP Fragment said RTE_LIBRTE_IP_FRAG_MAX_FRAG was 4 by default,
however this was changed to 8.

Documentation has been updated to account for this, including a
snippet of code where RTE_LIBRTE_IP_FRAG_MAX_FRAG is defined to
ensure documentation stays up to date.

Fixes: f8e0f8ce9030 ("ip_frag: increase default maximum of fragments")
Cc: stable@dpdk.org

Signed-off-by: Euan Bourke <euan.bourke@intel.com>
---
 .mailmap                                             | 1 +
 doc/guides/prog_guide/ip_fragment_reassembly_lib.rst | 8 +++++++-
 2 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/.mailmap b/.mailmap
index ab0742a382..528bc68a30 100644
--- a/.mailmap
+++ b/.mailmap
@@ -379,6 +379,7 @@ Eric Zhang <eric.zhang@windriver.com>
 Erik Gabriel Carrillo <erik.g.carrillo@intel.com>
 Erik Ziegenbalg <eziegenb@brocade.com>
 Erlu Chen <erlu.chen@intel.com>
+Euan Bourke <euan.bourke@intel.com>
 Eugenio Pérez <eperezma@redhat.com>
 Eugeny Parshutin <eugeny.parshutin@linux.intel.com>
 Evan Swanson <evan.swanson@intel.com>
diff --git a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst
index 314d4adbb8..f3ed90d700 100644
--- a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst
+++ b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst
@@ -43,7 +43,13 @@ Note that all update/lookup operations on Fragment Table are not thread safe.
 So if different execution contexts (threads/processes) will access the same table simultaneously,
 then some external syncing mechanism have to be provided.
 
-Each table entry can hold information about packets consisting of up to RTE_LIBRTE_IP_FRAG_MAX (by default: 4) fragments.
+Each table entry can hold information about packets of up to ``RTE_LIBRTE_IP_FRAG_MAX_FRAG`` fragments,
+where ``RTE_LIBRTE_IP_FRAG_MAX_FRAG`` defaults to:
+
+.. literalinclude:: ../../../config/rte_config.h
+    :language: c
+    :start-at: #define RTE_LIBRTE_IP_FRAG_MAX_FRAG
+    :lines: 1
 
 Code example, that demonstrates creation of a new Fragment table:
 
-- 
2.34.1


  parent reply	other threads:[~2024-01-08 11:36 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <https://inbox.dpdk.org/dev/20231219151754.3285058-1-euan.bourke@intel.com/>
2023-12-21 11:32 ` [PATCH v2 " Euan Bourke
2023-12-21 11:32   ` [PATCH v2 2/2] ip_frag: updated name for IP frag define Euan Bourke
2023-12-21 11:39   ` [PATCH v2 1/2] doc: updated incorrect value for IP frag max fragments David Marchand
2023-12-21 11:41   ` Thomas Monjalon
2023-12-21 13:46     ` Bourke, Euan
2023-12-21 17:41   ` [PATCH v3 " Euan Bourke
2023-12-21 17:41     ` [PATCH v3 2/2] ip_frag: updated name for IP frag max frag define Euan Bourke
2023-12-22  9:08       ` Bruce Richardson
2024-01-08 11:36     ` Euan Bourke [this message]
2024-01-08 11:36       ` [PATCH v4 2/2] ip_frag: updated name for IP " Euan Bourke

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=20240108113614.3860138-1-euan.bourke@intel.com \
    --to=euan.bourke@intel.com \
    --cc=dev@dpdk.org \
    --cc=konstantin.v.ananyev@yandex.ru \
    --cc=stable@dpdk.org \
    --cc=thomas@monjalon.net \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).