[PATCH net-next] ixgbe: fix typos and docstring inconsistencies

[PATCH net-next] ixgbe: fix typos and docstring inconsistencies

[Alok Tiwari]

Corrected function and variable name typos in comments and docstrings:
 ixgbe_write_ee_hostif_X550 -> ixgbe_write_ee_hostif_data_X550
 ixgbe_get_lcd_x550em -> ixgbe_get_lcd_t_x550em
 "Determime" -> "Determine"
 "point to hardware structure" -> "pointer to hardware structure"
 "To turn on the LED" -> "To turn off the LED"

These changes improve readability, consistency.

Signed-off-by: Alok Tiwari <alok.a.tiwari@oracle.com>
---
 drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c b/drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c
index 650c3e522c3e..76d2fa3ef518 100644
--- a/drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c
+++ b/drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c
@@ -1163,7 +1163,7 @@ static int ixgbe_validate_eeprom_checksum_X550(struct ixgbe_hw *hw,
 	return status;
 }
 
-/** ixgbe_write_ee_hostif_X550 - Write EEPROM word using hostif
+/** ixgbe_write_ee_hostif_data_X550 - Write EEPROM word using hostif
  *  @hw: pointer to hardware structure
  *  @offset: offset of  word in the EEPROM to write
  *  @data: word write to the EEPROM
@@ -2318,7 +2318,7 @@ static int ixgbe_get_link_capabilities_X550em(struct ixgbe_hw *hw,
 }
 
 /**
- * ixgbe_get_lasi_ext_t_x550em - Determime external Base T PHY interrupt cause
+ * ixgbe_get_lasi_ext_t_x550em - Determine external Base T PHY interrupt cause
  * @hw: pointer to hardware structure
  * @lsc: pointer to boolean flag which indicates whether external Base T
  *	 PHY interrupt is lsc
@@ -2628,7 +2628,7 @@ static int ixgbe_ext_phy_t_x550em_get_link(struct ixgbe_hw *hw, bool *link_up)
 }
 
 /** ixgbe_setup_internal_phy_t_x550em - Configure KR PHY to X557 link
- *  @hw: point to hardware structure
+ *  @hw: pointer to hardware structure
  *
  *  Configures the link between the integrated KR PHY and the external X557 PHY
  *  The driver will call this function when it gets a link status change
@@ -2745,7 +2745,7 @@ static int ixgbe_led_off_t_x550em(struct ixgbe_hw *hw, u32 led_idx)
 	if (led_idx >= IXGBE_X557_MAX_LED_INDEX)
 		return -EINVAL;
 
-	/* To turn on the LED, set mode to ON. */
+	/* To turn off the LED, set mode to OFF. */
 	hw->phy.ops.read_reg(hw, IXGBE_X557_LED_PROVISIONING + led_idx,
 			     MDIO_MMD_VEND1, &phy_data);
 	phy_data &= ~IXGBE_X557_LED_MANUAL_SET_MASK;
@@ -2812,7 +2812,7 @@ int ixgbe_set_fw_drv_ver_x550(struct ixgbe_hw *hw, u8 maj, u8 min,
 	return ret_val;
 }
 
-/** ixgbe_get_lcd_x550em - Determine lowest common denominator
+/** ixgbe_get_lcd_t_x550em - Determine lowest common denominator
  *  @hw: pointer to hardware structure
  *  @lcd_speed: pointer to lowest common link speed
  *
-- 
2.50.1

RE: [Intel-wired-lan] [PATCH net-next] ixgbe: fix typos and docstring inconsistencies

[Loktionov, Aleksandr]

> -----Original Message-----
> From: Intel-wired-lan <intel-wired-lan-bounces@osuosl.org> On Behalf
> Of Alok Tiwari
> Sent: Monday, September 29, 2025 2:44 PM
> To: Nguyen, Anthony L <anthony.l.nguyen@intel.com>; Kitszel,
> Przemyslaw <przemyslaw.kitszel@intel.com>; andrew+netdev@lunn.ch;
> davem@davemloft.net; edumazet@google.com; kuba@kernel.org;
> pabeni@redhat.com; netdev@vger.kernel.org; horms@kernel.org; intel-
> wired-lan@lists.osuosl.org
> Cc: alok.a.tiwari@oracle.com
> Subject: [Intel-wired-lan] [PATCH net-next] ixgbe: fix typos and
> docstring inconsistencies
> 
> Corrected function and variable name typos in comments and docstrings:
>  ixgbe_write_ee_hostif_X550 -> ixgbe_write_ee_hostif_data_X550
> ixgbe_get_lcd_x550em -> ixgbe_get_lcd_t_x550em  "Determime" ->
> "Determine"
>  "point to hardware structure" -> "pointer to hardware structure"
>  "To turn on the LED" -> "To turn off the LED"
> 
> These changes improve readability, consistency.
> 
> Signed-off-by: Alok Tiwari <alok.a.tiwari@oracle.com>
> ---
>  drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c
> b/drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c
> index 650c3e522c3e..76d2fa3ef518 100644
> --- a/drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c
> +++ b/drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c
> @@ -1163,7 +1163,7 @@ static int
> ixgbe_validate_eeprom_checksum_X550(struct ixgbe_hw *hw,
>  	return status;
>  }
> 
> -/** ixgbe_write_ee_hostif_X550 - Write EEPROM word using hostif
> +/** ixgbe_write_ee_hostif_data_X550 - Write EEPROM word using hostif
>   *  @hw: pointer to hardware structure
>   *  @offset: offset of  word in the EEPROM to write
>   *  @data: word write to the EEPROM
> @@ -2318,7 +2318,7 @@ static int
> ixgbe_get_link_capabilities_X550em(struct ixgbe_hw *hw,  }
> 
>  /**
> - * ixgbe_get_lasi_ext_t_x550em - Determime external Base T PHY
> interrupt cause
> + * ixgbe_get_lasi_ext_t_x550em - Determine external Base T PHY
> + interrupt cause
>   * @hw: pointer to hardware structure
>   * @lsc: pointer to boolean flag which indicates whether external
> Base T
>   *	 PHY interrupt is lsc
> @@ -2628,7 +2628,7 @@ static int
> ixgbe_ext_phy_t_x550em_get_link(struct ixgbe_hw *hw, bool *link_up)  }
> 
>  /** ixgbe_setup_internal_phy_t_x550em - Configure KR PHY to X557 link
> - *  @hw: point to hardware structure
> + *  @hw: pointer to hardware structure
>   *
>   *  Configures the link between the integrated KR PHY and the
> external X557 PHY
>   *  The driver will call this function when it gets a link status
> change @@ -2745,7 +2745,7 @@ static int ixgbe_led_off_t_x550em(struct
> ixgbe_hw *hw, u32 led_idx)
>  	if (led_idx >= IXGBE_X557_MAX_LED_INDEX)
>  		return -EINVAL;
> 
> -	/* To turn on the LED, set mode to ON. */
> +	/* To turn off the LED, set mode to OFF. */
>  	hw->phy.ops.read_reg(hw, IXGBE_X557_LED_PROVISIONING + led_idx,
>  			     MDIO_MMD_VEND1, &phy_data);
>  	phy_data &= ~IXGBE_X557_LED_MANUAL_SET_MASK; @@ -2812,7 +2812,7
> @@ int ixgbe_set_fw_drv_ver_x550(struct ixgbe_hw *hw, u8 maj, u8 min,
>  	return ret_val;
>  }
> 
> -/** ixgbe_get_lcd_x550em - Determine lowest common denominator
> +/** ixgbe_get_lcd_t_x550em - Determine lowest common denominator
>   *  @hw: pointer to hardware structure
>   *  @lcd_speed: pointer to lowest common link speed
>   *
> --
> 2.50.1

Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov@intel.com>

Re: [Intel-wired-lan] [PATCH net-next] ixgbe: fix typos and docstring inconsistencies

[Paul Menzel]

Dear Alok,


Thank you for your patch.

Am 29.09.25 um 14:44 schrieb Alok Tiwari:
> Corrected function and variable name typos in comments and docstrings:
>   ixgbe_write_ee_hostif_X550 -> ixgbe_write_ee_hostif_data_X550
>   ixgbe_get_lcd_x550em -> ixgbe_get_lcd_t_x550em
>   "Determime" -> "Determine"
>   "point to hardware structure" -> "pointer to hardware structure"
>   "To turn on the LED" -> "To turn off the LED"
> 
> These changes improve readability, consistency.
> 
> Signed-off-by: Alok Tiwari <alok.a.tiwari@oracle.com>
> ---
>   drivers/net/ethernet/intel/ixgbe/ixgbe_x550.c | 10 +++++-----
>   1 file changed, 5 insertions(+), 5 deletions(-)

[…]

Reviewed-by: Paul Menzel <pmenzel@molgen.mpg.de>


Kind regards,

Paul

Re: [PATCH net-next] ixgbe: fix typos and docstring inconsistencies

[Jakub Kicinski]

On Mon, 29 Sep 2025 05:44:01 -0700 Alok Tiwari wrote:
> Corrected function and variable name typos in comments and docstrings:
>  ixgbe_write_ee_hostif_X550 -> ixgbe_write_ee_hostif_data_X550
>  ixgbe_get_lcd_x550em -> ixgbe_get_lcd_t_x550em
>  "Determime" -> "Determine"
>  "point to hardware structure" -> "pointer to hardware structure"
>  "To turn on the LED" -> "To turn off the LED"

Hi Jake, looks trivial. Ack for us to take it directly to net-next now?

Re: [PATCH net-next] ixgbe: fix typos and docstring inconsistencies

[Jacob Keller]

[-- Attachment #1.1: Type: text/plain, Size: 604 bytes --]



On 9/29/2025 11:59 AM, Jakub Kicinski wrote:
> On Mon, 29 Sep 2025 05:44:01 -0700 Alok Tiwari wrote:
>> Corrected function and variable name typos in comments and docstrings:
>>  ixgbe_write_ee_hostif_X550 -> ixgbe_write_ee_hostif_data_X550
>>  ixgbe_get_lcd_x550em -> ixgbe_get_lcd_t_x550em
>>  "Determime" -> "Determine"
>>  "point to hardware structure" -> "pointer to hardware structure"
>>  "To turn on the LED" -> "To turn off the LED"
> 
> Hi Jake, looks trivial. Ack for us to take it directly to net-next now?

Yep, go ahead.

Acked-by: Jacob Keller <jacob.e.keller@intel.com>

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 236 bytes --]

Re: [PATCH net-next] ixgbe: fix typos and docstring inconsistencies

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Mon, 29 Sep 2025 05:44:01 -0700 you wrote:
> Corrected function and variable name typos in comments and docstrings:
>  ixgbe_write_ee_hostif_X550 -> ixgbe_write_ee_hostif_data_X550
>  ixgbe_get_lcd_x550em -> ixgbe_get_lcd_t_x550em
>  "Determime" -> "Determine"
>  "point to hardware structure" -> "pointer to hardware structure"
>  "To turn on the LED" -> "To turn off the LED"
> 
> [...]

Here is the summary with links:
  - [net-next] ixgbe: fix typos and docstring inconsistencies
    https://git.kernel.org/netdev/net-next/c/96ccc93744f8

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html