diff mbox series

ethdev: add Field ID doxygen description

Message ID 20210303221904.25841-1-akozyrev@nvidia.com (mailing list archive)
State Accepted
Delegated to: Ferruh Yigit
Headers show
Series ethdev: add Field ID doxygen description | expand

Checks

Context Check Description
ci/iol-testing success Testing PASS
ci/iol-mellanox-Functional success Functional Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot success github build: passed
ci/travis-robot success travis build: passed
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Alexander Kozyrev March 3, 2021, 10:19 p.m. UTC
Field IDs for the MODIFY_FIELD action lack doxygen comments
and not visible in online DPDK documentation because of that.
Provide a meaningful description for every Field ID for the
rte_flow_field_id enumeration.

Fixes: 73b68f4c54 ("ethdev: introduce generic modify flow action")
Cc: stable@dpdk.org

Signed-off-by: Alexander Kozyrev <akozyrev@nvidia.com>
---
 lib/librte_ethdev/rte_flow.h | 58 ++++++++++++++++++------------------
 1 file changed, 29 insertions(+), 29 deletions(-)

Comments

Ferruh Yigit March 9, 2021, 1:31 p.m. UTC | #1
On 3/3/2021 10:19 PM, Alexander Kozyrev wrote:
> Field IDs for the MODIFY_FIELD action lack doxygen comments
> and not visible in online DPDK documentation because of that.
> Provide a meaningful description for every Field ID for the
> rte_flow_field_id enumeration.
> 
> Fixes: 73b68f4c54 ("ethdev: introduce generic modify flow action")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Alexander Kozyrev <akozyrev@nvidia.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>

Applied to dpdk-next-net/main, thanks.
diff mbox series

Patch

diff --git a/lib/librte_ethdev/rte_flow.h b/lib/librte_ethdev/rte_flow.h
index 68c68cdd6c..669e677e91 100644
--- a/lib/librte_ethdev/rte_flow.h
+++ b/lib/librte_ethdev/rte_flow.h
@@ -2832,35 +2832,35 @@  struct rte_flow_shared_action;
  * Field IDs for MODIFY_FIELD action.
  */
 enum rte_flow_field_id {
-	RTE_FLOW_FIELD_START = 0, /**< Start of a packet. */
-	RTE_FLOW_FIELD_MAC_DST,
-	RTE_FLOW_FIELD_MAC_SRC,
-	RTE_FLOW_FIELD_VLAN_TYPE,
-	RTE_FLOW_FIELD_VLAN_ID,
-	RTE_FLOW_FIELD_MAC_TYPE,
-	RTE_FLOW_FIELD_IPV4_DSCP,
-	RTE_FLOW_FIELD_IPV4_TTL,
-	RTE_FLOW_FIELD_IPV4_SRC,
-	RTE_FLOW_FIELD_IPV4_DST,
-	RTE_FLOW_FIELD_IPV6_DSCP,
-	RTE_FLOW_FIELD_IPV6_HOPLIMIT,
-	RTE_FLOW_FIELD_IPV6_SRC,
-	RTE_FLOW_FIELD_IPV6_DST,
-	RTE_FLOW_FIELD_TCP_PORT_SRC,
-	RTE_FLOW_FIELD_TCP_PORT_DST,
-	RTE_FLOW_FIELD_TCP_SEQ_NUM,
-	RTE_FLOW_FIELD_TCP_ACK_NUM,
-	RTE_FLOW_FIELD_TCP_FLAGS,
-	RTE_FLOW_FIELD_UDP_PORT_SRC,
-	RTE_FLOW_FIELD_UDP_PORT_DST,
-	RTE_FLOW_FIELD_VXLAN_VNI,
-	RTE_FLOW_FIELD_GENEVE_VNI,
-	RTE_FLOW_FIELD_GTP_TEID,
-	RTE_FLOW_FIELD_TAG,
-	RTE_FLOW_FIELD_MARK,
-	RTE_FLOW_FIELD_META,
-	RTE_FLOW_FIELD_POINTER, /**< Memory pointer. */
-	RTE_FLOW_FIELD_VALUE,   /**< Immediate value. */
+	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. */
 };
 
 /**