From patchwork Tue Dec 19 15:17:53 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Euan Bourke X-Patchwork-Id: 135335 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 453DA43746; Tue, 19 Dec 2023 16:18:10 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AFA3542DED; Tue, 19 Dec 2023 16:18:09 +0100 (CET) Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.11]) by mails.dpdk.org (Postfix) with ESMTP id 0F5F0402E0 for ; Tue, 19 Dec 2023 16:18:07 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1702999088; x=1734535088; h=from:to:cc:subject:date:message-id:mime-version: content-transfer-encoding; bh=/fy7gKuZOkTmT6+VSSzf0PULpGW84As3zObIr/ENhCE=; b=lCvHv+ZGMArqJoLBqh+3auGyyHNtvPUgbzrTHkX+glrTYaekFApWs9wh 2VtlCJs57O7+INNNLdJkA5D0PGZMa9mjjlCvpDHaPW/Ot4xZ68tq+bXR2 9Dy7sJOm7RnYzr0+3TzjPzqKunTJD5yZVbYggivLUir9JfpFoxqsRVxSS 99W79k5mn8bWCQiUFibHG5Kpg0s6yVkT65icFyb1fxgX65B8KupXHdjrF /Aotz2PK/Y5cPz/v/ADzeSGDxnct/SkY4fNMbuhshfMKhWeGhrueFhSDf +ZQOBeRdw80YwdBui/DwSWx/CNzwnE8eG43VbTrh+c1GzlI0AEiPakb7a Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10929"; a="2497041" X-IronPort-AV: E=Sophos;i="6.04,288,1695711600"; d="scan'208";a="2497041" Received: from fmviesa001.fm.intel.com ([10.60.135.141]) by fmvoesa105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Dec 2023 07:18:07 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.04,288,1695711600"; d="scan'208";a="17907749" Received: from unknown (HELO silpixa00400630.ir.intel.com) ([10.237.213.151]) by fmviesa001.fm.intel.com with ESMTP; 19 Dec 2023 07:18:06 -0800 From: Euan Bourke To: dev@dpdk.org Cc: Euan Bourke , Thomas Monjalon , Konstantin Ananyev Subject: [PATCH 1/2] doc: updated incorrect value for IP frag max fragments Date: Tue, 19 Dec 2023 15:17:53 +0000 Message-Id: <20231219151754.3285058-1-euan.bourke@intel.com> X-Mailer: git-send-email 2.34.1 MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org 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 --- .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 Erik Gabriel Carrillo Erik Ziegenbalg Erlu Chen +Euan Bourke Eugenio Pérez Eugeny Parshutin Evan Swanson 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: