DPDK patches and discussions
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Alexander Kozyrev <akozyrev@nvidia.com>, dev@dpdk.org
Cc: rasland@nvidia.com, viacheslavo@nvidia.com, matan@nvidia.com,
	orika@nvidia.com
Subject: Re: [dpdk-dev] [PATCH v2 5/6] doc: add list of supported Field IDs to modify
Date: Wed, 31 Mar 2021 16:53:00 +0100
Message-ID: <6367c8e6-2ecd-c395-0888-c42403334503@intel.com> (raw)
In-Reply-To: <20210324150439.9247-6-akozyrev@nvidia.com>

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 <akozyrev@nvidia.com>
> ---
>   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.

  parent reply	other threads:[~2021-03-31 15:53 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-24 15:04 [dpdk-dev] [PATCH v2 0/6] modify field action enhancements Alexander Kozyrev
2021-03-24 15:04 ` [dpdk-dev] [PATCH v2 1/6] net/mlx5: check for a field size in modify field action Alexander Kozyrev
2021-03-30  7:09   ` Slava Ovsiienko
2021-03-24 15:04 ` [dpdk-dev] [PATCH v2 2/6] net/mlx5: adjust modify field action endianess Alexander Kozyrev
2021-03-30  7:09   ` Slava Ovsiienko
2021-03-24 15:04 ` [dpdk-dev] [PATCH v2 3/6] net/mlx5: check extended metadata for mark modififcation Alexander Kozyrev
2021-03-30  7:09   ` Slava Ovsiienko
2021-03-24 15:04 ` [dpdk-dev] [PATCH v2 4/6] net/mlx5: allow group 0 modify field action Alexander Kozyrev
2021-03-30  7:10   ` Slava Ovsiienko
2021-03-24 15:04 ` [dpdk-dev] [PATCH v2 5/6] doc: add list of supported Field IDs to modify Alexander Kozyrev
2021-03-30  7:10   ` Slava Ovsiienko
2021-03-31 15:53   ` Ferruh Yigit [this message]
2021-04-08  3:20     ` Alexander Kozyrev
2021-03-24 15:04 ` [dpdk-dev] [PATCH v2 6/6] net/mlx5: reject VXLAN ID's modifications Alexander Kozyrev
2021-03-30  7:10   ` Slava Ovsiienko
2021-03-31 13:03 ` [dpdk-dev] [PATCH v2 0/6] modify field action enhancements Raslan Darawsheh

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6367c8e6-2ecd-c395-0888-c42403334503@intel.com \
    --to=ferruh.yigit@intel.com \
    --cc=akozyrev@nvidia.com \
    --cc=dev@dpdk.org \
    --cc=matan@nvidia.com \
    --cc=orika@nvidia.com \
    --cc=rasland@nvidia.com \
    --cc=viacheslavo@nvidia.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

DPDK patches and discussions

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://inbox.dpdk.org/dev/0 dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dev dev/ https://inbox.dpdk.org/dev \
		dev@dpdk.org
	public-inbox-index dev

Example config snippet for mirrors.
Newsgroup available over NNTP:
	nntp://inbox.dpdk.org/inbox.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git