net/ethernet: fix typo in annotation comment

[PATCH] net/ethernet: fix typo in annotation comment

Posted by Jun Miao 1 year ago

It`s "auto-negotiation", not "auto-negotitation". Let's fix that.

Signed-off-by: Jun Miao <jun.miao@intel.com>
---
 drivers/net/ethernet/amd/xgbe/xgbe-mdio.c  | 2 +-
 drivers/net/ethernet/intel/igb/e1000_mac.c | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c b/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
index 07f4f3418d01..5597e7df0aba 100644
--- a/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
+++ b/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
@@ -1264,7 +1264,7 @@ static int __xgbe_phy_config_aneg(struct xgbe_prv_data *pdata, bool set_mode)
 	/* Disable and stop any in progress auto-negotiation */
 	xgbe_an_disable_all(pdata);
 
-	/* Clear any auto-negotitation interrupts */
+	/* Clear any auto-negotiation interrupts */
 	xgbe_an_clear_interrupts_all(pdata);
 
 	pdata->an_result = XGBE_AN_READY;
diff --git a/drivers/net/ethernet/intel/igb/e1000_mac.c b/drivers/net/ethernet/intel/igb/e1000_mac.c
index fa3dfafd2bb1..2bcce6eef0c7 100644
--- a/drivers/net/ethernet/intel/igb/e1000_mac.c
+++ b/drivers/net/ethernet/intel/igb/e1000_mac.c
@@ -1581,7 +1581,7 @@ s32 igb_disable_pcie_master(struct e1000_hw *hw)
  *  igb_validate_mdi_setting - Verify MDI/MDIx settings
  *  @hw: pointer to the HW structure
  *
- *  Verify that when not using auto-negotitation that MDI/MDIx is correctly
+ *  Verify that when not using auto-negotiation that MDI/MDIx is correctly
  *  set, which is forced to MDI mode only.
  **/
 s32 igb_validate_mdi_setting(struct e1000_hw *hw)
-- 
2.32.0

Re: [PATCH] net/ethernet: fix typo in annotation comment

Posted by Shyam Sundar S K 1 year ago


On 12/5/2024 12:22, Jun Miao wrote:
> It`s "auto-negotiation", not "auto-negotitation". Let's fix that.
> 

Thanks!

Acked-by: Shyam Sundar S K <Shyam-sundar.S-k@amd.com> #for xgbe-mdio.c

> Signed-off-by: Jun Miao <jun.miao@intel.com>
> ---
>  drivers/net/ethernet/amd/xgbe/xgbe-mdio.c  | 2 +-
>  drivers/net/ethernet/intel/igb/e1000_mac.c | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c b/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
> index 07f4f3418d01..5597e7df0aba 100644
> --- a/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
> +++ b/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
> @@ -1264,7 +1264,7 @@ static int __xgbe_phy_config_aneg(struct xgbe_prv_data *pdata, bool set_mode)
>  	/* Disable and stop any in progress auto-negotiation */
>  	xgbe_an_disable_all(pdata);
>  
> -	/* Clear any auto-negotitation interrupts */
> +	/* Clear any auto-negotiation interrupts */
>  	xgbe_an_clear_interrupts_all(pdata);
>  
>  	pdata->an_result = XGBE_AN_READY;
> diff --git a/drivers/net/ethernet/intel/igb/e1000_mac.c b/drivers/net/ethernet/intel/igb/e1000_mac.c
> index fa3dfafd2bb1..2bcce6eef0c7 100644
> --- a/drivers/net/ethernet/intel/igb/e1000_mac.c
> +++ b/drivers/net/ethernet/intel/igb/e1000_mac.c
> @@ -1581,7 +1581,7 @@ s32 igb_disable_pcie_master(struct e1000_hw *hw)
>   *  igb_validate_mdi_setting - Verify MDI/MDIx settings
>   *  @hw: pointer to the HW structure
>   *
> - *  Verify that when not using auto-negotitation that MDI/MDIx is correctly
> + *  Verify that when not using auto-negotiation that MDI/MDIx is correctly
>   *  set, which is forced to MDI mode only.
>   **/
>  s32 igb_validate_mdi_setting(struct e1000_hw *hw)

Re: [PATCH] net/ethernet: fix typo in annotation comment

Posted by Przemek Kitszel 1 year ago

On 12/5/24 07:52, Jun Miao wrote:
> It`s "auto-negotiation", not "auto-negotitation". Let's fix that.
> 
> Signed-off-by: Jun Miao <jun.miao@intel.com>
> ---
>   drivers/net/ethernet/amd/xgbe/xgbe-mdio.c  | 2 +-
>   drivers/net/ethernet/intel/igb/e1000_mac.c | 2 +-

for the igb:
Acked-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>

>   2 files changed, 2 insertions(+), 2 deletions(-)

you could fix also (perhaps as another commit):
arch/arm64/boot/dts/marvell/cn9131-cf-solidwan.dts:273:	 * SGMII 
Auto-Negotation is enabled by bootloader for

nit:
I would also put "about auto-negotiation" at the end of commit message,
to make it unique

> 
> diff --git a/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c b/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
> index 07f4f3418d01..5597e7df0aba 100644
> --- a/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
> +++ b/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
> @@ -1264,7 +1264,7 @@ static int __xgbe_phy_config_aneg(struct xgbe_prv_data *pdata, bool set_mode)
>   	/* Disable and stop any in progress auto-negotiation */
>   	xgbe_an_disable_all(pdata);
>   
> -	/* Clear any auto-negotitation interrupts */
> +	/* Clear any auto-negotiation interrupts */
>   	xgbe_an_clear_interrupts_all(pdata);
>   
>   	pdata->an_result = XGBE_AN_READY;
> diff --git a/drivers/net/ethernet/intel/igb/e1000_mac.c b/drivers/net/ethernet/intel/igb/e1000_mac.c
> index fa3dfafd2bb1..2bcce6eef0c7 100644
> --- a/drivers/net/ethernet/intel/igb/e1000_mac.c
> +++ b/drivers/net/ethernet/intel/igb/e1000_mac.c
> @@ -1581,7 +1581,7 @@ s32 igb_disable_pcie_master(struct e1000_hw *hw)
>    *  igb_validate_mdi_setting - Verify MDI/MDIx settings
>    *  @hw: pointer to the HW structure
>    *
> - *  Verify that when not using auto-negotitation that MDI/MDIx is correctly
> + *  Verify that when not using auto-negotiation that MDI/MDIx is correctly
>    *  set, which is forced to MDI mode only.
>    **/
>   s32 igb_validate_mdi_setting(struct e1000_hw *hw)

Re: [PATCH] net/ethernet: fix typo in annotation comment

Posted by Jun Miao 1 year ago

On 2024/12/5 18:21, Przemek Kitszel wrote:
> On 12/5/24 07:52, Jun Miao wrote:
>> It`s "auto-negotiation", not "auto-negotitation". Let's fix that.
>>
>> Signed-off-by: Jun Miao <jun.miao@intel.com>
>> ---
>>   drivers/net/ethernet/amd/xgbe/xgbe-mdio.c  | 2 +-
>>   drivers/net/ethernet/intel/igb/e1000_mac.c | 2 +-
>
> for the igb:
> Acked-by: Przemek Kitszel <przemyslaw.kitszel@intel.com>
>
>>   2 files changed, 2 insertions(+), 2 deletions(-)
>
> you could fix also (perhaps as another commit):
> arch/arm64/boot/dts/marvell/cn9131-cf-solidwan.dts:273:     * SGMII 
> Auto-Negotation is enabled by bootloader for
>
> nit:
> I would also put "about auto-negotiation" at the end of commit message,
> to make it unique

Nice, thank you. That is perfect to add "about auto-negotiation" in commit.

---Jun.miao

>
>>
>> diff --git a/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c 
>> b/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
>> index 07f4f3418d01..5597e7df0aba 100644
>> --- a/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
>> +++ b/drivers/net/ethernet/amd/xgbe/xgbe-mdio.c
>> @@ -1264,7 +1264,7 @@ static int __xgbe_phy_config_aneg(struct 
>> xgbe_prv_data *pdata, bool set_mode)
>>       /* Disable and stop any in progress auto-negotiation */
>>       xgbe_an_disable_all(pdata);
>>   -    /* Clear any auto-negotitation interrupts */
>> +    /* Clear any auto-negotiation interrupts */
>>       xgbe_an_clear_interrupts_all(pdata);
>>         pdata->an_result = XGBE_AN_READY;
>> diff --git a/drivers/net/ethernet/intel/igb/e1000_mac.c 
>> b/drivers/net/ethernet/intel/igb/e1000_mac.c
>> index fa3dfafd2bb1..2bcce6eef0c7 100644
>> --- a/drivers/net/ethernet/intel/igb/e1000_mac.c
>> +++ b/drivers/net/ethernet/intel/igb/e1000_mac.c
>> @@ -1581,7 +1581,7 @@ s32 igb_disable_pcie_master(struct e1000_hw *hw)
>>    *  igb_validate_mdi_setting - Verify MDI/MDIx settings
>>    *  @hw: pointer to the HW structure
>>    *
>> - *  Verify that when not using auto-negotitation that MDI/MDIx is 
>> correctly
>> + *  Verify that when not using auto-negotiation that MDI/MDIx is 
>> correctly
>>    *  set, which is forced to MDI mode only.
>>    **/
>>   s32 igb_validate_mdi_setting(struct e1000_hw *hw)
>