From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D8BD8A0579; Thu, 8 Apr 2021 14:33:06 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 9C7B540698; Thu, 8 Apr 2021 14:33:06 +0200 (CEST) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by mails.dpdk.org (Postfix) with ESMTP id A403B40138 for ; Thu, 8 Apr 2021 14:33:04 +0200 (CEST) Received: from Internal Mail-Server by MTLPINE1 (envelope-from akozyrev@nvidia.com) with SMTP; 8 Apr 2021 15:33:01 +0300 Received: from nvidia.com (pegasus02.mtr.labs.mlnx [10.210.16.122]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id 138CX1hc005000; Thu, 8 Apr 2021 15:33:01 +0300 From: Alexander Kozyrev To: dev@dpdk.org Cc: stable@dpdk.org, ferruh.yigit@intel.com, rasland@nvidia.com, viacheslavo@nvidia.com Date: Thu, 8 Apr 2021 12:32:58 +0000 Message-Id: <20210408123258.10452-1-akozyrev@nvidia.com> X-Mailer: git-send-email 2.24.1 In-Reply-To: <20210331160028.21811-1-akozyrev@nvidia.com> References: <20210331160028.21811-1-akozyrev@nvidia.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2] doc: refer to the supported Field IDs for modify field API 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 Sender: "dev" Fix the documentation about the MODIFY_FIELD RTE Flow action. 1. Include the rte_flow_field_id enumeration reference to point to the full list of all supported Field IDs available. 2. Correct the formatting of the MODIFY_FIELD action and the destination/source field definition tables. Fixes: 73b68f4c54 ("ethdev: introduce generic modify flow action") Cc: stable@dpdk.org Signed-off-by: Alexander Kozyrev Acked-by: Viacheslav Ovsiienko --- v2: added commit message about the tables formatting doc/guides/prog_guide/rte_flow.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst index aec2ba1ec0..e1b93ecedf 100644 --- a/doc/guides/prog_guide/rte_flow.rst +++ b/doc/guides/prog_guide/rte_flow.rst @@ -2779,6 +2779,7 @@ can be used as both source and destination fields as set by ``field``. The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it ``RTE_FLOW_FIELD_POINTER``) is allowed as a source only. ``RTE_FLOW_FIELD_START`` is used to point to the beginning of a packet. +See ``enum rte_flow_field_id`` for the list of supported fields. ``op`` selects the operation to perform on a destination field. - ``set`` copies the data from ``src`` field to ``dst`` field. @@ -2812,12 +2813,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively. .. table:: MODIFY_FIELD - +-----------------------------------------+ + +---------------+-------------------------+ | Field | Value | +===============+=========================+ | ``op`` | operation to perform | + +---------------+-------------------------+ | ``dst`` | destination field | + +---------------+-------------------------+ | ``src`` | source field | + +---------------+-------------------------+ | ``width`` | number of bits to use | +---------------+-------------------------+ @@ -2825,12 +2829,15 @@ for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively. .. table:: destination/source field definition - +--------------------------------------------------------------------------+ + +---------------+----------------------------------------------------------+ | Field | Value | +===============+==========================================================+ | ``field`` | ID: packet field, mark, meta, tag, immediate, pointer | + +---------------+----------------------------------------------------------+ | ``level`` | encapsulation level of a packet field or tag array index | + +---------------+----------------------------------------------------------+ | ``offset`` | number of bits to skip at the beginning | + +---------------+----------------------------------------------------------+ | ``value`` | immediate value or a pointer to this value | +---------------+----------------------------------------------------------+ -- 2.24.1