[PATCH v3 1/2] doc: updated incorrect value for IP frag max fragments

[PATCH v3 1/2] doc: updated incorrect value for IP frag max fragments

[Euan Bourke]

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

[PATCH v4 1/2] doc: updated incorrect value for IP frag max fragments

[Euan Bourke]

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