[PATCH v2 1/2] doc: updated incorrect value for IP frag max fragments
Euan Bourke
euan.bourke at intel.com
Thu Dec 21 12:32:41 CET 2023
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 at intel.com>
---
.mailmap | 1 +
config/rte_config.h | 4 +++-
doc/guides/prog_guide/ip_fragment_reassembly_lib.rst | 7 ++++++-
3 files changed, 10 insertions(+), 2 deletions(-)
diff --git a/.mailmap b/.mailmap
index ab0742a382..528bc68a30 100644
--- a/.mailmap
+++ b/.mailmap
@@ -379,6 +379,7 @@ Eric Zhang <eric.zhang at windriver.com>
Erik Gabriel Carrillo <erik.g.carrillo at intel.com>
Erik Ziegenbalg <eziegenb at brocade.com>
Erlu Chen <erlu.chen at intel.com>
+Euan Bourke <euan.bourke at intel.com>
Eugenio Pérez <eperezma at redhat.com>
Eugeny Parshutin <eugeny.parshutin at linux.intel.com>
Evan Swanson <evan.swanson at intel.com>
diff --git a/config/rte_config.h b/config/rte_config.h
index da265d7dd2..a3f92354f8 100644
--- a/config/rte_config.h
+++ b/config/rte_config.h
@@ -84,8 +84,10 @@
/* rawdev defines */
#define RTE_RAWDEV_MAX_DEVS 64
-/* ip_fragmentation defines */
+/* ip_fragmentation defines 8< */
#define RTE_LIBRTE_IP_FRAG_MAX_FRAG 8
+/* >8 End of ip_fragmentation defines */
+
// RTE_LIBRTE_IP_FRAG_TBL_STAT is not set
/* rte_power defines */
diff --git a/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst b/doc/guides/prog_guide/ip_fragment_reassembly_lib.rst
index 314d4adbb8..5010472246 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 8<
+ :end-before: >8 End of ip_fragmentation defines
Code example, that demonstrates creation of a new Fragment table:
--
2.34.1
More information about the dev
mailing list