[v6,10/17] net/i40e/base: fix headers to match functions

Message ID 20211009013956.70937-11-robinx.zhang@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Qi Zhang
Headers
Series i40e base code update |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Robin Zhang Oct. 9, 2021, 1:39 a.m. UTC
  Fix several kernel-doc warnings when building with W=1. These changes
are only to comments.

Fixes: 8db9e2a1b232 ("i40e: base driver")
Fixes: 842ea1996335 ("i40e/base: save link module type")
Fixes: fd72a2284a89 ("i40e/base: support LED blinking with new PHY")
Fixes: 788fc17b2dec ("i40e/base: support proxy config for X722")
Cc: stable@dpdk.org

Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
Signed-off-by: Robin Zhang <robinx.zhang@intel.com>
---
 drivers/net/i40e/base/i40e_common.c  | 10 +++++-----
 drivers/net/i40e/base/i40e_dcb.c     |  2 +-
 drivers/net/i40e/base/i40e_lan_hmc.c |  2 +-
 drivers/net/i40e/base/i40e_nvm.c     |  2 +-
 4 files changed, 8 insertions(+), 8 deletions(-)
  

Comments

Qi Zhang Oct. 9, 2021, 5:36 a.m. UTC | #1
> -----Original Message-----
> From: Zhang, RobinX <robinx.zhang@intel.com>
> Sent: Saturday, October 9, 2021 9:40 AM
> To: dev@dpdk.org
> Cc: Xing, Beilei <beilei.xing@intel.com>; Zhang, Qi Z <qi.z.zhang@intel.com>;
> Zhang, Helin <helin.zhang@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>;
> remy.horton@intel.com; jijiang.liu@intel.com; jing.d.chen@intel.com; Liang,
> Cunming <cunming.liang@intel.com>; Lu, Wenzhuo <wenzhuo.lu@intel.com>;
> Guo, Junfeng <junfeng.guo@intel.com>; Yang, SteveX
> <stevex.yang@intel.com>; Zhang, RobinX <robinx.zhang@intel.com>;
> stable@dpdk.org; Brandeburg, Jesse <jesse.brandeburg@intel.com>
> Subject: [PATCH v6 10/17] net/i40e/base: fix headers to match functions
> 

fix headers to match functions

> Fix several kernel-doc warnings when building with W=1. These changes are
> only to comments.

"Fix mismatched function name in comments"

This is an obvious fix, no need to involve unrelated background.

> 
> Fixes: 8db9e2a1b232 ("i40e: base driver")
> Fixes: 842ea1996335 ("i40e/base: save link module type")
> Fixes: fd72a2284a89 ("i40e/base: support LED blinking with new PHY")
> Fixes: 788fc17b2dec ("i40e/base: support proxy config for X722")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Jesse Brandeburg <jesse.brandeburg@intel.com>
> Signed-off-by: Robin Zhang <robinx.zhang@intel.com>
> ---
>  drivers/net/i40e/base/i40e_common.c  | 10 +++++-----
>  drivers/net/i40e/base/i40e_dcb.c     |  2 +-
>  drivers/net/i40e/base/i40e_lan_hmc.c |  2 +-
>  drivers/net/i40e/base/i40e_nvm.c     |  2 +-
>  4 files changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/drivers/net/i40e/base/i40e_common.c
> b/drivers/net/i40e/base/i40e_common.c
> index 2ca6a13e79..baa51e1396 100644
> --- a/drivers/net/i40e/base/i40e_common.c
> +++ b/drivers/net/i40e/base/i40e_common.c
> @@ -2677,7 +2677,7 @@ enum i40e_status_code
> i40e_aq_set_vsi_vlan_promisc(struct i40e_hw *hw,  }
> 
>  /**
> - * i40e_get_vsi_params - get VSI configuration info
> + * i40e_aq_get_vsi_params - get VSI configuration info
>   * @hw: pointer to the hw struct
>   * @vsi_ctx: pointer to a vsi context struct
>   * @cmd_details: pointer to command details structure or NULL @@ -2938,7
> +2938,7 @@ enum i40e_status_code i40e_get_link_status(struct i40e_hw
> *hw, bool *link_up)  }
> 
>  /**
> - * i40e_updatelink_status - update status of the HW network link
> + * i40e_update_link_info - update status of the HW network link
>   * @hw: pointer to the hw struct
>   **/
>  enum i40e_status_code i40e_update_link_info(struct i40e_hw *hw) @@
> -4830,7 +4830,7 @@ enum i40e_status_code i40e_aq_del_udp_tunnel(struct
> i40e_hw *hw, u8 index,  }
> 
>  /**
> - * i40e_aq_get_switch_resource_alloc (0x0204)
> + * i40e_aq_get_switch_resource_alloc - command (0x0204) to get
> + allocations
>   * @hw: pointer to the hw struct
>   * @num_entries: pointer to u8 to store the number of resource entries
> returned
>   * @buf: pointer to a user supplied buffer.  This buffer must be large enough
> @@ -6977,7 +6977,7 @@ u8 i40e_get_phy_address(struct i40e_hw *hw, u8
> dev_num)  }
> 
>  /**
> - * i40e_blink_phy_led
> + * i40e_blink_phy_link_led
>   * @hw: pointer to the HW structure
>   * @time: time how long led will blinks in secs
>   * @interval: gap between LED on and off in msecs @@ -7824,7 +7824,7
> @@ enum i40e_status_code i40e_aq_set_arp_proxy_config(struct i40e_hw
> *hw,  }
> 
>  /**
> - * i40e_aq_opc_set_ns_proxy_table_entry
> + * i40e_aq_set_ns_proxy_table_entry
>   * @hw: pointer to the HW structure
>   * @ns_proxy_table_entry: pointer to NS table entry command struct
>   * @cmd_details: pointer to command details diff --git
> a/drivers/net/i40e/base/i40e_dcb.c b/drivers/net/i40e/base/i40e_dcb.c
> index 27b52bc365..8f9b7e823f 100644
> --- a/drivers/net/i40e/base/i40e_dcb.c
> +++ b/drivers/net/i40e/base/i40e_dcb.c
> @@ -235,7 +235,7 @@ static void i40e_parse_ieee_app_tlv(struct
> i40e_lldp_org_tlv *tlv,  }
> 
>  /**
> - * i40e_parse_ieee_etsrec_tlv
> + * i40e_parse_ieee_tlv
>   * @tlv: IEEE 802.1Qaz TLV
>   * @dcbcfg: Local store to update ETS REC data
>   *
> diff --git a/drivers/net/i40e/base/i40e_lan_hmc.c
> b/drivers/net/i40e/base/i40e_lan_hmc.c
> index d3969396f0..d3bd683ff3 100644
> --- a/drivers/net/i40e/base/i40e_lan_hmc.c
> +++ b/drivers/net/i40e/base/i40e_lan_hmc.c
> @@ -516,7 +516,7 @@ enum i40e_status_code
> i40e_configure_lan_hmc(struct i40e_hw *hw,  }
> 
>  /**
> - * i40e_delete_hmc_object - remove hmc objects
> + * i40e_delete_lan_hmc_object - remove hmc objects
>   * @hw: pointer to the HW structure
>   * @info: pointer to i40e_hmc_delete_obj_info struct
>   *
> diff --git a/drivers/net/i40e/base/i40e_nvm.c
> b/drivers/net/i40e/base/i40e_nvm.c
> index 561ed21136..67e58cc195 100644
> --- a/drivers/net/i40e/base/i40e_nvm.c
> +++ b/drivers/net/i40e/base/i40e_nvm.c
> @@ -7,7 +7,7 @@
>  #include "i40e_prototype.h"
> 
>  /**
> - * i40e_init_nvm_ops - Initialize NVM function pointers
> + * i40e_init_nvm - Initialize NVM function pointers
>   * @hw: pointer to the HW structure
>   *
>   * Setup the function pointers and the NVM info structure. Should be called
> --
> 2.25.1
  

Patch

diff --git a/drivers/net/i40e/base/i40e_common.c b/drivers/net/i40e/base/i40e_common.c
index 2ca6a13e79..baa51e1396 100644
--- a/drivers/net/i40e/base/i40e_common.c
+++ b/drivers/net/i40e/base/i40e_common.c
@@ -2677,7 +2677,7 @@  enum i40e_status_code i40e_aq_set_vsi_vlan_promisc(struct i40e_hw *hw,
 }
 
 /**
- * i40e_get_vsi_params - get VSI configuration info
+ * i40e_aq_get_vsi_params - get VSI configuration info
  * @hw: pointer to the hw struct
  * @vsi_ctx: pointer to a vsi context struct
  * @cmd_details: pointer to command details structure or NULL
@@ -2938,7 +2938,7 @@  enum i40e_status_code i40e_get_link_status(struct i40e_hw *hw, bool *link_up)
 }
 
 /**
- * i40e_updatelink_status - update status of the HW network link
+ * i40e_update_link_info - update status of the HW network link
  * @hw: pointer to the hw struct
  **/
 enum i40e_status_code i40e_update_link_info(struct i40e_hw *hw)
@@ -4830,7 +4830,7 @@  enum i40e_status_code i40e_aq_del_udp_tunnel(struct i40e_hw *hw, u8 index,
 }
 
 /**
- * i40e_aq_get_switch_resource_alloc (0x0204)
+ * i40e_aq_get_switch_resource_alloc - command (0x0204) to get allocations
  * @hw: pointer to the hw struct
  * @num_entries: pointer to u8 to store the number of resource entries returned
  * @buf: pointer to a user supplied buffer.  This buffer must be large enough
@@ -6977,7 +6977,7 @@  u8 i40e_get_phy_address(struct i40e_hw *hw, u8 dev_num)
 }
 
 /**
- * i40e_blink_phy_led
+ * i40e_blink_phy_link_led
  * @hw: pointer to the HW structure
  * @time: time how long led will blinks in secs
  * @interval: gap between LED on and off in msecs
@@ -7824,7 +7824,7 @@  enum i40e_status_code i40e_aq_set_arp_proxy_config(struct i40e_hw *hw,
 }
 
 /**
- * i40e_aq_opc_set_ns_proxy_table_entry
+ * i40e_aq_set_ns_proxy_table_entry
  * @hw: pointer to the HW structure
  * @ns_proxy_table_entry: pointer to NS table entry command struct
  * @cmd_details: pointer to command details
diff --git a/drivers/net/i40e/base/i40e_dcb.c b/drivers/net/i40e/base/i40e_dcb.c
index 27b52bc365..8f9b7e823f 100644
--- a/drivers/net/i40e/base/i40e_dcb.c
+++ b/drivers/net/i40e/base/i40e_dcb.c
@@ -235,7 +235,7 @@  static void i40e_parse_ieee_app_tlv(struct i40e_lldp_org_tlv *tlv,
 }
 
 /**
- * i40e_parse_ieee_etsrec_tlv
+ * i40e_parse_ieee_tlv
  * @tlv: IEEE 802.1Qaz TLV
  * @dcbcfg: Local store to update ETS REC data
  *
diff --git a/drivers/net/i40e/base/i40e_lan_hmc.c b/drivers/net/i40e/base/i40e_lan_hmc.c
index d3969396f0..d3bd683ff3 100644
--- a/drivers/net/i40e/base/i40e_lan_hmc.c
+++ b/drivers/net/i40e/base/i40e_lan_hmc.c
@@ -516,7 +516,7 @@  enum i40e_status_code i40e_configure_lan_hmc(struct i40e_hw *hw,
 }
 
 /**
- * i40e_delete_hmc_object - remove hmc objects
+ * i40e_delete_lan_hmc_object - remove hmc objects
  * @hw: pointer to the HW structure
  * @info: pointer to i40e_hmc_delete_obj_info struct
  *
diff --git a/drivers/net/i40e/base/i40e_nvm.c b/drivers/net/i40e/base/i40e_nvm.c
index 561ed21136..67e58cc195 100644
--- a/drivers/net/i40e/base/i40e_nvm.c
+++ b/drivers/net/i40e/base/i40e_nvm.c
@@ -7,7 +7,7 @@ 
 #include "i40e_prototype.h"
 
 /**
- * i40e_init_nvm_ops - Initialize NVM function pointers
+ * i40e_init_nvm - Initialize NVM function pointers
  * @hw: pointer to the HW structure
  *
  * Setup the function pointers and the NVM info structure. Should be called