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 A5C5FA034F; Wed, 31 Mar 2021 17:53:11 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 5D286140E7D; Wed, 31 Mar 2021 17:53:11 +0200 (CEST) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by mails.dpdk.org (Postfix) with ESMTP id 789D9140E7C for ; Wed, 31 Mar 2021 17:53:10 +0200 (CEST) IronPort-SDR: Y9KOLcmYYtymsYi9CiRqPumQ2H5y+v6MHmnDG1Y0Q8nQLpwh/vA99xjed0AsgWn3hGHaBLlPkg 58betyVKQn9w== X-IronPort-AV: E=McAfee;i="6000,8403,9940"; a="256019262" X-IronPort-AV: E=Sophos;i="5.81,293,1610438400"; d="scan'208";a="256019262" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga105.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 31 Mar 2021 08:53:07 -0700 IronPort-SDR: cyYagJ/EqrLgsQSlikyBj7t+nrtL8xvW1WcIUBqJOjOdotGFl4wV5iHnkfWo0K1XeX1tdw8s+r 7VlkeRiCAIGg== X-IronPort-AV: E=Sophos;i="5.81,293,1610438400"; d="scan'208";a="445765986" Received: from fyigit-mobl1.ger.corp.intel.com (HELO [10.213.249.9]) ([10.213.249.9]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 31 Mar 2021 08:53:05 -0700 To: Alexander Kozyrev , dev@dpdk.org Cc: rasland@nvidia.com, viacheslavo@nvidia.com, matan@nvidia.com, orika@nvidia.com References: <20210324150439.9247-1-akozyrev@nvidia.com> <20210324150439.9247-6-akozyrev@nvidia.com> From: Ferruh Yigit X-User: ferruhy Message-ID: <6367c8e6-2ecd-c395-0888-c42403334503@intel.com> Date: Wed, 31 Mar 2021 16:53:00 +0100 MIME-Version: 1.0 In-Reply-To: <20210324150439.9247-6-akozyrev@nvidia.com> Content-Type: text/plain; charset=utf-8; format=flowed Content-Language: en-US Content-Transfer-Encoding: 8bit Subject: Re: [dpdk-dev] [PATCH v2 5/6] doc: add list of supported Field IDs to modify 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" On 3/24/2021 3:04 PM, Alexander Kozyrev wrote: > Include the rte_flow_field_id enumeration into the > documentation to provide the full list of all supported > Field IDs available for the MODIFY_FIELD RTE action. > > Signed-off-by: Alexander Kozyrev > --- > doc/guides/prog_guide/rte_flow.rst | 45 ++++++++++++++++++++++++++++-- > 1 file changed, 43 insertions(+), 2 deletions(-) > > diff --git a/doc/guides/prog_guide/rte_flow.rst b/doc/guides/prog_guide/rte_flow.rst > index 62a57919eb..4265b7bfb8 100644 > --- a/doc/guides/prog_guide/rte_flow.rst > +++ b/doc/guides/prog_guide/rte_flow.rst > @@ -2784,6 +2784,41 @@ 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: > + > +.. code-block:: c > + > + enum rte_flow_field_id { > + RTE_FLOW_FIELD_START = 0, /**< Start of a packet. */ > + RTE_FLOW_FIELD_MAC_DST, /**< Destination MAC Address. */ > + RTE_FLOW_FIELD_MAC_SRC, /**< Source MAC Address. */ > + RTE_FLOW_FIELD_VLAN_TYPE, /**< 802.1Q Tag Identifier. */ > + RTE_FLOW_FIELD_VLAN_ID, /**< 802.1Q VLAN Identifier. */ > + RTE_FLOW_FIELD_MAC_TYPE, /**< EtherType. */ > + RTE_FLOW_FIELD_IPV4_DSCP, /**< IPv4 DSCP. */ > + RTE_FLOW_FIELD_IPV4_TTL, /**< IPv4 Time To Live. */ > + RTE_FLOW_FIELD_IPV4_SRC, /**< IPv4 Source Address. */ > + RTE_FLOW_FIELD_IPV4_DST, /**< IPv4 Destination Address. */ > + RTE_FLOW_FIELD_IPV6_DSCP, /**< IPv6 DSCP. */ > + RTE_FLOW_FIELD_IPV6_HOPLIMIT, /**< IPv6 Hop Limit. */ > + RTE_FLOW_FIELD_IPV6_SRC, /**< IPv6 Source Address. */ > + RTE_FLOW_FIELD_IPV6_DST, /**< IPv6 Destination Address. */ > + RTE_FLOW_FIELD_TCP_PORT_SRC, /**< TCP Source Port Number. */ > + RTE_FLOW_FIELD_TCP_PORT_DST, /**< TCP Destination Port Number. */ > + RTE_FLOW_FIELD_TCP_SEQ_NUM, /**< TCP Sequence Number. */ > + RTE_FLOW_FIELD_TCP_ACK_NUM, /**< TCP Acknowledgment Number. */ > + RTE_FLOW_FIELD_TCP_FLAGS, /**< TCP Flags. */ > + RTE_FLOW_FIELD_UDP_PORT_SRC, /**< UDP Source Port Number. */ > + RTE_FLOW_FIELD_UDP_PORT_DST, /**< UDP Destination Port Number. */ > + RTE_FLOW_FIELD_VXLAN_VNI, /**< VXLAN Network Identifier. */ > + RTE_FLOW_FIELD_GENEVE_VNI, /**< GENEVE Network Identifier. */ > + RTE_FLOW_FIELD_GTP_TEID, /**< GTP Tunnel Endpoint Identifier. */ > + RTE_FLOW_FIELD_TAG, /**< Tag value. */ > + RTE_FLOW_FIELD_MARK, /**< Mark value. */ > + RTE_FLOW_FIELD_META, /**< Metadata value. */ > + RTE_FLOW_FIELD_POINTER, /**< Memory pointer. */ > + RTE_FLOW_FIELD_VALUE, /**< Immediate value. */ > + }; The code in the documentation proved to be problem in long term, they get out of date most of the times. So what do you think to just keep the reference to ``enum rte_flow_field_id`` but drop the code block? Dropping the patch in next-net, it can be sent later separately.