Description of several functions is not accurate.
This patch updates the description, parameter names etc.
Signed-off-by: Dekel Peled <dek...@mellanox.com>
Acked-by: Ori Kam <or...@mellanox.com>
---
drivers/net/mlx5/mlx5_flow_dv.c | 28 ++++++++++++----------------
1 file changed, 12 insertions(+), 16 deletions(-)
diff --git a/drivers/net/mlx5/mlx5_flow_dv.c b/drivers/net/mlx5/mlx5_flow_dv.c
index 4b6a92c..059d03f 100644
--- a/drivers/net/mlx5/mlx5_flow_dv.c
+++ b/drivers/net/mlx5/mlx5_flow_dv.c
@@ -1662,14 +1662,10 @@ struct field_modify_info modify_tcp[] = {
/**
* Get VLAN default info from vlan match info.
*
- * @param[in] dev
- * Pointer to the rte_eth_dev structure.
- * @param[in] item
+ * @param[in] items
* the list of item specifications.
* @param[out] vlan
* pointer VLAN info to fill to.
- * @param[out] error
- * Pointer to error structure.
*
* @return
* 0 on success, a negative errno value otherwise and rte_errno is set.
@@ -1721,8 +1717,10 @@ struct field_modify_info modify_tcp[] = {
*
* @param[in] action_flags
* Holds the actions detected until now.
+ * @param[in] item_flags
+ * The items found in this flow rule.
* @param[in] action
- * Pointer to the encap action.
+ * Pointer to the action structure.
* @param[in] attr
* Pointer to flow attributes
* @param[out] error
@@ -1772,8 +1770,6 @@ struct field_modify_info modify_tcp[] = {
* Holds the actions detected until now.
* @param[in] actions
* Pointer to the list of actions remaining in the flow rule.
- * @param[in] attr
- * Pointer to flow attributes
* @param[out] error
* Pointer to error structure.
*
@@ -1988,7 +1984,7 @@ struct field_modify_info modify_tcp[] = {
* @param[in] dev
* Pointer to the rte_eth_dev structure.
* @param[in] action
- * Pointer to the encap action.
+ * Pointer to the action structure.
* @param[in] action_flags
* Holds the actions detected until now.
* @param[in] attr
@@ -2049,7 +2045,7 @@ struct field_modify_info modify_tcp[] = {
* @param[in] dev
* Pointer to the rte_eth_dev structure.
* @param[in] action
- * Pointer to the encap action.
+ * Pointer to the action structure.
* @param[in] action_flags
* Holds the actions detected until now.
* @param[in] attr
@@ -2103,7 +2099,7 @@ struct field_modify_info modify_tcp[] = {
* Validate count action.
*
* @param[in] dev
- * device otr.
+ * Pointer to rte_eth_dev structure.
* @param[out] error
* Pointer to error structure.
*
@@ -2135,7 +2131,7 @@ struct field_modify_info modify_tcp[] = {
* @param[in] action_flags
* Holds the actions detected until now.
* @param[in] action
- * Pointer to the encap action.
+ * Pointer to the action structure.
* @param[in] attr
* Pointer to flow attributes
* @param[out] error
@@ -2995,12 +2991,12 @@ struct field_modify_info modify_tcp[] = {
*
* @param[in] dev
* Pointer to rte_eth_dev structure.
- * @param[in] vlan_tag
- * the vlan tag to push to the Ethernet header.
- * @param[in, out] dev_flow
- * Pointer to the mlx5_flow.
* @param[in] attr
* Pointer to the flow attributes.
+ * @param[in] vlan
+ * Pointer to the vlan to push to the Ethernet header.
+ * @param[in, out] dev_flow
+ * Pointer to the mlx5_flow.
* @param[out] error
* Pointer to the error structure.
*
--
1.8.3.1
