diff mbox series

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

Message ID 20231219151754.3285058-1-euan.bourke@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series [1/2] doc: updated incorrect value for IP frag max fragments |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Euan Bourke Dec. 19, 2023, 3:17 p.m. UTC 
  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(-)

Comments

Thomas Monjalon Dec. 20, 2023, 9:42 a.m. UTC | #1 
19/12/2023 16:17, Euan Bourke:
> +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:

Instead of repeating the name, you can use "it".

> +
> +.. literalinclude:: ../../../config/rte_config.h
> +    :start-after: /* ip_fragmentation defines */
> +    :lines: 1

Relying on the comment before is a bit fragile here.
Please use "start-at".
Bruce Richardson Dec. 20, 2023, 10:03 a.m. UTC | #2 
On Wed, Dec 20, 2023 at 10:42:28AM +0100, Thomas Monjalon wrote:
> 19/12/2023 16:17, Euan Bourke:
> > +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:
> 
> Instead of repeating the name, you can use "it".
> 
In this instance, I actually think it's better to repeat the name - as "it"
would read strangely, and could refer to "table entry" or "information"
either.

/Bruce
diff mbox series

Patch

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: