From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 434DD43752;
Thu, 21 Dec 2023 18:42:38 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 10F5F402BD;
Thu, 21 Dec 2023 18:42:38 +0100 (CET)
Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.8])
by mails.dpdk.org (Postfix) with ESMTP id 28FB04028B;
Thu, 21 Dec 2023 18:42:36 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
t=1703180556; x=1734716556;
h=from:to:cc:subject:date:message-id:in-reply-to:
references:mime-version:content-transfer-encoding;
bh=C9nEhIlAD0g5x19h0Ufl+BA1ogfAVGvNn+5gmC3quko=;
b=eicEs9FnFvl7PPrCTdIbHQX9CxW0tq8j6irLH9niri1nEJVcKKnERotM
GiyLK9SwSF7Hn8cvDBpL9lSasQEayDWokLe+UUDqHGgcGj0Ha8jo+9gnH
UHO6yLPj4tOLzhg4GNpdNxJCTorcavfcTtAsDTdN5P+1vJGcZIRRL/Dv+
LhQrqjP7EjoHtGPYW6piOrDR0Wr4CdN3ZyRM+gFkCTo72CKApVgy6eL2k
oiHz4JMnzT0PTKTJ2U7BOVdQNMy3DyZa8N2PkFX4QLuCJSgyY6U7T1TbZ
popSTVl2zEHtBXNjslipfDXlpCRhYLNWf3tYl8U0nbKP+GF6DaDrWQRwQ Q==;
X-IronPort-AV: E=McAfee;i="6600,9927,10931"; a="9490090"
X-IronPort-AV: E=Sophos;i="6.04,294,1695711600";
d="scan'208";a="9490090"
Received: from orsmga002.jf.intel.com ([10.7.209.21])
by fmvoesa102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
21 Dec 2023 09:42:35 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=McAfee;i="6600,9927,10931"; a="776784430"
X-IronPort-AV: E=Sophos;i="6.04,294,1695711600"; d="scan'208";a="776784430"
Received: from unknown (HELO silpixa00400630.ir.intel.com) ([10.237.213.151])
by orsmga002.jf.intel.com with ESMTP; 21 Dec 2023 09:42:33 -0800
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 v3 1/2] doc: updated incorrect value for IP frag max fragments
Date: Thu, 21 Dec 2023 17:41:39 +0000
Message-Id: <20231221174140.3369894-1-euan.bourke@intel.com>
X-Mailer: git-send-email 2.34.1
In-Reply-To: <20231221113242.3351356-1-euan.bourke@intel.com>
References: <20231221113242.3351356-1-euan.bourke@intel.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
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