DPDK patches and discussions
 help / color / mirror / Atom feed
* [PATCH 1/2] doc: updated incorrect value for IP frag max fragments
@ 2023-12-19 15:17 Euan Bourke
  2023-12-19 15:17 ` [PATCH 2/2] ip_frag: updated name for IP frag define Euan Bourke
  2023-12-20  9:42 ` [PATCH 1/2] doc: updated incorrect value for IP frag max fragments Thomas Monjalon
  0 siblings, 2 replies; 4+ messages in thread
From: Euan Bourke @ 2023-12-19 15:17 UTC (permalink / raw)
  To: dev; +Cc: Euan Bourke, Thomas Monjalon, Konstantin Ananyev

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

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

Signed-off-by: Euan Bourke <euan.bourke@intel.com>
---
 .mailmap                                             | 1 +
 doc/guides/prog_guide/ip_fragment_reassembly_lib.rst | 7 ++++++-
 2 files changed, 7 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..458d7c6776 100644
--- a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst
+++ b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst
@@ -43,7 +43,12 @@ 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_FRAGS`` fragments,
+where ``RTE_LIBRTE_IP_FRAG_MAX_FRAGS`` defaults to:
+
+.. literalinclude:: ../../../config/rte_config.h
+    :start-after: /* ip_fragmentation defines */
+    :lines: 1
 
 Code example, that demonstrates creation of a new Fragment table:
 
-- 
2.34.1


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2023-12-20 10:03 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-12-19 15:17 [PATCH 1/2] doc: updated incorrect value for IP frag max fragments Euan Bourke
2023-12-19 15:17 ` [PATCH 2/2] ip_frag: updated name for IP frag define Euan Bourke
2023-12-20  9:42 ` [PATCH 1/2] doc: updated incorrect value for IP frag max fragments Thomas Monjalon
2023-12-20 10:03   ` Bruce Richardson

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).