[PATCH v4] staging: rtl8192e: renamed (3) variables

[PATCH v4] staging: rtl8192e: renamed (3) variables

[Gary Rookard]

This patch renames the vaiable in staging/rtl8192e
HTUpdateDefaultSetting -> ht_update_default_setting
in (3) files of rtl8192e:
1) rtl819x_HTProc.c
2) rtllib.h
3) rtllib_module.c

Linux Kernel Coding Style "cleanup", no change in runtime,
staging/rtl8192e builds before and after.

Signed-off-by: Gary Rookard <garyrookard@fastmail.org>
---
 drivers/staging/rtl8192e/rtl819x_HTProc.c | 2 +-
 drivers/staging/rtl8192e/rtllib.h         | 2 +-
 drivers/staging/rtl8192e/rtllib_module.c  | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/staging/rtl8192e/rtl819x_HTProc.c b/drivers/staging/rtl8192e/rtl819x_HTProc.c
index a7e356e90d0e..832f595d36c2 100644
--- a/drivers/staging/rtl8192e/rtl819x_HTProc.c
+++ b/drivers/staging/rtl8192e/rtl819x_HTProc.c
@@ -67,7 +67,7 @@ static u8 CISCO_BROADCOM[3] = {0x00, 0x17, 0x94};
 
 static u8 LINKSYS_MARVELL_4400N[3] = {0x00, 0x14, 0xa4};
 
-void HTUpdateDefaultSetting(struct rtllib_device *ieee)
+void ht_update_default_setting(struct rtllib_device *ieee)
 {
 	struct rt_hi_throughput *ht_info = ieee->ht_info;
 
diff --git a/drivers/staging/rtl8192e/rtllib.h b/drivers/staging/rtl8192e/rtllib.h
index bdbd27e382b9..ec1eef7486a2 100644
--- a/drivers/staging/rtl8192e/rtllib.h
+++ b/drivers/staging/rtl8192e/rtllib.h
@@ -1785,7 +1785,7 @@ int rtllib_wx_get_rts(struct rtllib_device *ieee, struct iw_request_info *info,
 void HTSetConnectBwMode(struct rtllib_device *ieee,
 			enum ht_channel_width bandwidth,
 			enum ht_extchnl_offset Offset);
-void HTUpdateDefaultSetting(struct rtllib_device *ieee);
+void ht_update_default_setting(struct rtllib_device *ieee);
 void HTConstructCapabilityElement(struct rtllib_device *ieee,
 				  u8 *posHTCap, u8 *len,
 				  u8 isEncrypt, bool bAssoc);
diff --git a/drivers/staging/rtl8192e/rtllib_module.c b/drivers/staging/rtl8192e/rtllib_module.c
index abd6bfd4dfa3..859241af617c 100644
--- a/drivers/staging/rtl8192e/rtllib_module.c
+++ b/drivers/staging/rtl8192e/rtllib_module.c
@@ -126,7 +126,7 @@ struct net_device *alloc_rtllib(int sizeof_priv)
 	if (!ieee->ht_info)
 		goto free_softmac;
 
-	HTUpdateDefaultSetting(ieee);
+	ht_update_default_setting(ieee);
 	HTInitializeHTInfo(ieee);
 	rtllib_ts_init(ieee);
 	for (i = 0; i < IEEE_IBSS_MAC_HASH_SIZE; i++)
-- 
2.41.0

Re: [PATCH v4] staging: rtl8192e: renamed (3) variables

[Philipp Hortmann]

On 9/28/23 02:02, Gary Rookard wrote:
> This patch renames the vaiable in staging/rtl8192e
> HTUpdateDefaultSetting -> ht_update_default_setting
> in (3) files of rtl8192e:
> 1) rtl819x_HTProc.c
> 2) rtllib.h
> 3) rtllib_module.c >
> Linux Kernel Coding Style "cleanup", no change in runtime,
> staging/rtl8192e builds before and after.
> 
> Signed-off-by: Gary Rookard <garyrookard@fastmail.org>

Hi Gary,

your subject is to general and also wrong as you change just one 
variable. Please find good examples in the in the kernel log.
Or here:
https://lore.kernel.org/linux-staging/20230921032515.96152-2-tdavies@darkphysics.net/T/#u

Omit the file names in the description as this is redundant.

You need a version history for all four versions of your patch.
See example:
https://lore.kernel.org/linux-staging/ZQGiqA2GoDp%2FWiPK@ubuntu.myguest.virtualbox.org/T/#u

Bye Philipp


> ---
>   drivers/staging/rtl8192e/rtl819x_HTProc.c | 2 +-
>   drivers/staging/rtl8192e/rtllib.h         | 2 +-
>   drivers/staging/rtl8192e/rtllib_module.c  | 2 +-
>   3 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/staging/rtl8192e/rtl819x_HTProc.c b/drivers/staging/rtl8192e/rtl819x_HTProc.c
> index a7e356e90d0e..832f595d36c2 100644
> --- a/drivers/staging/rtl8192e/rtl819x_HTProc.c
> +++ b/drivers/staging/rtl8192e/rtl819x_HTProc.c
> @@ -67,7 +67,7 @@ static u8 CISCO_BROADCOM[3] = {0x00, 0x17, 0x94};
>   
>   static u8 LINKSYS_MARVELL_4400N[3] = {0x00, 0x14, 0xa4};
>   
> -void HTUpdateDefaultSetting(struct rtllib_device *ieee)
> +void ht_update_default_setting(struct rtllib_device *ieee)
>   {
>   	struct rt_hi_throughput *ht_info = ieee->ht_info;
>   
> diff --git a/drivers/staging/rtl8192e/rtllib.h b/drivers/staging/rtl8192e/rtllib.h
> index bdbd27e382b9..ec1eef7486a2 100644
> --- a/drivers/staging/rtl8192e/rtllib.h
> +++ b/drivers/staging/rtl8192e/rtllib.h
> @@ -1785,7 +1785,7 @@ int rtllib_wx_get_rts(struct rtllib_device *ieee, struct iw_request_info *info,
>   void HTSetConnectBwMode(struct rtllib_device *ieee,
>   			enum ht_channel_width bandwidth,
>   			enum ht_extchnl_offset Offset);
> -void HTUpdateDefaultSetting(struct rtllib_device *ieee);
> +void ht_update_default_setting(struct rtllib_device *ieee);
>   void HTConstructCapabilityElement(struct rtllib_device *ieee,
>   				  u8 *posHTCap, u8 *len,
>   				  u8 isEncrypt, bool bAssoc);
> diff --git a/drivers/staging/rtl8192e/rtllib_module.c b/drivers/staging/rtl8192e/rtllib_module.c
> index abd6bfd4dfa3..859241af617c 100644
> --- a/drivers/staging/rtl8192e/rtllib_module.c
> +++ b/drivers/staging/rtl8192e/rtllib_module.c
> @@ -126,7 +126,7 @@ struct net_device *alloc_rtllib(int sizeof_priv)
>   	if (!ieee->ht_info)
>   		goto free_softmac;
>   
> -	HTUpdateDefaultSetting(ieee);
> +	ht_update_default_setting(ieee);
>   	HTInitializeHTInfo(ieee);
>   	rtllib_ts_init(ieee);
>   	for (i = 0; i < IEEE_IBSS_MAC_HASH_SIZE; i++)

Re: [PATCH v4] staging: rtl8192e: renamed (3) variables

[Philipp Hortmann]

On 9/28/23 06:40, Philipp Hortmann wrote:
> On 9/28/23 02:02, Gary Rookard wrote:
>> This patch renames the vaiable in staging/rtl8192e
>> HTUpdateDefaultSetting -> ht_update_default_setting
>> in (3) files of rtl8192e:
>> 1) rtl819x_HTProc.c
>> 2) rtllib.h
>> 3) rtllib_module.c >
>> Linux Kernel Coding Style "cleanup", no change in runtime,
>> staging/rtl8192e builds before and after.
>>
>> Signed-off-by: Gary Rookard <garyrookard@fastmail.org>
> 
> Hi Gary,
> 
> your subject is to general and also wrong as you change just one 
> variable. Please find good examples in the in the kernel log.
> Or here:
> https://lore.kernel.org/linux-staging/20230921032515.96152-2-tdavies@darkphysics.net/T/#u
> 
> Omit the file names in the description as this is redundant.
> 
> You need a version history for all four versions of your patch.
> See example:
> https://lore.kernel.org/linux-staging/ZQGiqA2GoDp%2FWiPK@ubuntu.myguest.virtualbox.org/T/#u
> 
> Bye Philipp
> 

Hi Gary,

this is not a variable. It is a function name. To keep the namespace 
clean it is required to add a rtllib_ in front of the function name.

Bye Philipp

> 
>> ---
>>   drivers/staging/rtl8192e/rtl819x_HTProc.c | 2 +-
>>   drivers/staging/rtl8192e/rtllib.h         | 2 +-
>>   drivers/staging/rtl8192e/rtllib_module.c  | 2 +-
>>   3 files changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/drivers/staging/rtl8192e/rtl819x_HTProc.c 
>> b/drivers/staging/rtl8192e/rtl819x_HTProc.c
>> index a7e356e90d0e..832f595d36c2 100644
>> --- a/drivers/staging/rtl8192e/rtl819x_HTProc.c
>> +++ b/drivers/staging/rtl8192e/rtl819x_HTProc.c
>> @@ -67,7 +67,7 @@ static u8 CISCO_BROADCOM[3] = {0x00, 0x17, 0x94};
>>   static u8 LINKSYS_MARVELL_4400N[3] = {0x00, 0x14, 0xa4};
>> -void HTUpdateDefaultSetting(struct rtllib_device *ieee)
>> +void ht_update_default_setting(struct rtllib_device *ieee)
>>   {
>>       struct rt_hi_throughput *ht_info = ieee->ht_info;
>> diff --git a/drivers/staging/rtl8192e/rtllib.h 
>> b/drivers/staging/rtl8192e/rtllib.h
>> index bdbd27e382b9..ec1eef7486a2 100644
>> --- a/drivers/staging/rtl8192e/rtllib.h
>> +++ b/drivers/staging/rtl8192e/rtllib.h
>> @@ -1785,7 +1785,7 @@ int rtllib_wx_get_rts(struct rtllib_device 
>> *ieee, struct iw_request_info *info,
>>   void HTSetConnectBwMode(struct rtllib_device *ieee,
>>               enum ht_channel_width bandwidth,
>>               enum ht_extchnl_offset Offset);
>> -void HTUpdateDefaultSetting(struct rtllib_device *ieee);
>> +void ht_update_default_setting(struct rtllib_device *ieee);
>>   void HTConstructCapabilityElement(struct rtllib_device *ieee,
>>                     u8 *posHTCap, u8 *len,
>>                     u8 isEncrypt, bool bAssoc);
>> diff --git a/drivers/staging/rtl8192e/rtllib_module.c 
>> b/drivers/staging/rtl8192e/rtllib_module.c
>> index abd6bfd4dfa3..859241af617c 100644
>> --- a/drivers/staging/rtl8192e/rtllib_module.c
>> +++ b/drivers/staging/rtl8192e/rtllib_module.c
>> @@ -126,7 +126,7 @@ struct net_device *alloc_rtllib(int sizeof_priv)
>>       if (!ieee->ht_info)
>>           goto free_softmac;
>> -    HTUpdateDefaultSetting(ieee);
>> +    ht_update_default_setting(ieee);
>>       HTInitializeHTInfo(ieee);
>>       rtllib_ts_init(ieee);
>>       for (i = 0; i < IEEE_IBSS_MAC_HASH_SIZE; i++)
> 

Re: [PATCH v4] staging: rtl8192e: renamed (3) variables

[Greg KH]

On Wed, Sep 27, 2023 at 08:02:25PM -0400, Gary Rookard wrote:
> This patch renames the vaiable in staging/rtl8192e

You did not rename a variable.

> HTUpdateDefaultSetting -> ht_update_default_setting

That is only one rename, not 3.

> in (3) files of rtl8192e:
> 1) rtl819x_HTProc.c
> 2) rtllib.h
> 3) rtllib_module.c
> 
> Linux Kernel Coding Style "cleanup", no change in runtime,
> staging/rtl8192e builds before and after.

I can not parse these lines :(

Please read the documentation for how to write a good changelog subject
and text, that's one of the most important parts of getting a kernel
change accepted.

thanks,

greg k-h