Re: [PATCH 2/2] net: macb: Kconfig: Rename Atmel to Cadence

[Nicolas.Ferre]

On 24/06/2019 at 11:57, Palmer Dabbelt wrote:
> External E-Mail
> 
> 
> On Mon, 24 Jun 2019 02:49:16 PDT (-0700), Nicolas.Ferre@xxxxxxxxxxxxx wrote:
>> On 24/06/2019 at 08:16, Palmer Dabbelt wrote:
>>> External E-Mail
>>>
>>>
>>> When touching the Kconfig for this driver I noticed that both the
>>> Kconfig help text and a comment referred to this being an Atmel driver.
>>> As far as I know, this is a Cadence driver.  The fix is just
>>
>> Indeed: was written and then maintained by Atmel (now Microchip) for
>> years... So I would say that more than a "Cadence driver" it's a driver
>> that applies to a Cadence peripheral.
>>
>> I won't hold the patch just for this as the patch makes perfect sense,
>> but would love that it's been highlighted...
> 
> OK, I don't mind changing it.  Does this look OK?  I have to submit a v2 anyway
> for the first patch.

Yep, nice!

Thanks,
   Nicolas

> 
> Author: Palmer Dabbelt <palmer@xxxxxxxxxx>
> Date:   Sun Jun 23 23:04:14 2019 -0700
> 
>      net: macb: Kconfig: Rename Atmel to Cadence
> 
>      The help text makes it look like NET_VENDOR_CADENCE enables support for
>      Atmel devices, when in reality it's a driver written by Atmel that
>      supports Cadence devices.  This may confuse users that have this device
>      on a non-Atmel SoC.
> 
>      The fix is just s/Atmel/Cadence/, but I did go and re-wrap the Kconfig
>      help text as that change caused it to go over 80 characters.
> 
>      Signed-off-by: Palmer Dabbelt <palmer@xxxxxxxxxx>
> 
> diff --git a/drivers/net/ethernet/cadence/Kconfig b/drivers/net/ethernet/cadence/Kconfig
> index 74ee2bfd2369..29b6132b418e 100644
> --- a/drivers/net/ethernet/cadence/Kconfig
> +++ b/drivers/net/ethernet/cadence/Kconfig
> @@ -1,6 +1,6 @@
>   # SPDX-License-Identifier: GPL-2.0-only
>   #
> -# Atmel device configuration
> +# Cadence device configuration
>   #
> 
>   config NET_VENDOR_CADENCE
> @@ -13,8 +13,8 @@ config NET_VENDOR_CADENCE
>            If unsure, say Y.
> 
>            Note that the answer to this question doesn't directly affect the
> -         kernel: saying N will just cause the configurator to skip all
> -         the remaining Atmel network card questions. If you say Y, you will be
> +         kernel: saying N will just cause the configurator to skip all the
> +         remaining Cadence network card questions. If you say Y, you will be
>            asked for your specific card in the following questions.
> 
>   if NET_VENDOR_CADENCE
> 
>>
>>> s/Atmel/Cadence/, but I did go and re-wrap the Kconfig help text as that
>>> change caused it to go over 80 characters.
>>>
>>> Signed-off-by: Palmer Dabbelt <palmer@xxxxxxxxxx>
>>> ---
>>>    drivers/net/ethernet/cadence/Kconfig | 6 +++---
>>>    1 file changed, 3 insertions(+), 3 deletions(-)
>>>
>>> diff --git a/drivers/net/ethernet/cadence/Kconfig b/drivers/net/ethernet/cadence/Kconfig
>>> index 74ee2bfd2369..29b6132b418e 100644
>>> --- a/drivers/net/ethernet/cadence/Kconfig
>>> +++ b/drivers/net/ethernet/cadence/Kconfig
>>> @@ -1,6 +1,6 @@
>>>    # SPDX-License-Identifier: GPL-2.0-only
>>>    #
>>> -# Atmel device configuration
>>> +# Cadence device configuration
>>>    #
>>>    
>>>    config NET_VENDOR_CADENCE
>>> @@ -13,8 +13,8 @@ config NET_VENDOR_CADENCE
>>>    	  If unsure, say Y.
>>>    
>>>    	  Note that the answer to this question doesn't directly affect the
>>> -	  kernel: saying N will just cause the configurator to skip all
>>> -	  the remaining Atmel network card questions. If you say Y, you will be
>>> +	  kernel: saying N will just cause the configurator to skip all the
>>> +	  remaining Cadence network card questions. If you say Y, you will be
>>>    	  asked for your specific card in the following questions.
>>>    
>>>    if NET_VENDOR_CADENCE
>>>
>>
>>
>> -- 
>> Nicolas Ferre


-- 
Nicolas Ferre