Skip to contentSkip to conversation

Unnecessary code cleanup patches

PATCH Superseded Abraham Samuel Adekunle 5 participants 12 messages Apr 4, 2025 – Apr 5, 2025 Staging

v3 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

v3 cover Unnecessary code cleanup patches

The patchset modifies unnecessary duplicate NULL test on a value in an expression, when the value has been NULL tested in a previous expression.

Changes in v2:
- Suggested by Andy Shevchenko.

* Dropped patch files for media drivers from patchset as it is not meant for outreachy applicants.
* Added full-stop sign to text in commit message.
* Added space around binary operators.
* Made code more breadable by adding a line break.
* Replace bitwise AND (&) with modulo (%) in expression.

Changes in v1:
- Suggested by Andy Shevchenko

* Patch for drivers/staging/media/av7110/sp8870.c and drivers/staging/media/atomisp/pci/atomisp_gmin_platform.c is split into two different patches in the patchset for use by the different driver maintainers.
* Added subject title for each of the separated patch.
* Patch 1: Removed unnecessary curl braces {} initially inserted.
* Patch 2: Unnecessary {} was also removed for v1.

Abraham Samuel Adekunle (1):
staging: rtl8723bs: Prevent duplicate NULL tests on a value

 drivers/staging/rtl8723bs/core/rtw_mlme_ext.c |  2 +-
 drivers/staging/rtl8723bs/core/rtw_xmit.c     | 58 +++++++++----------
 2 files changed, 30 insertions(+), 30 deletions(-)
Signature · 1 line
2.34.1
#1 lore raw

PATCH v3 1/1 staging: rtl8723bs: Prevent duplicate NULL tests on a value

When a value has been tested for NULL in an expression, a second NULL test on the same value in another expression is unnecessary when the value has not been assigned NULL.

Remove unnecessary duplicate NULL tests on the same value that has previously been NULL tested.

Found by Coccinelle.

---
 drivers/staging/rtl8723bs/core/rtw_mlme_ext.c |  2 +-
 drivers/staging/rtl8723bs/core/rtw_xmit.c     | 58 +++++++++----------
 2 files changed, 30 insertions(+), 30 deletions(-)
drivers/staging/rtl8723bs/core/rtw_mlme_ext.c +1 -1
index 90966b7034ab..675226535cd1 100644
@@ -1323,7 +1323,7 @@ unsigned int OnAssocReq(struct adapter *padapter, union recv_frame *precv_frame)
 	spin_unlock_bh(&pstapriv->asoc_list_lock);
 
 	/*  now the station is qualified to join our BSS... */
-	if (pstat && (pstat->state & WIFI_FW_ASSOC_SUCCESS) && (status == WLAN_STATUS_SUCCESS)) {
+	if ((pstat->state & WIFI_FW_ASSOC_SUCCESS) && (status == WLAN_STATUS_SUCCESS)) {
 		/* 1 bss_cap_update & sta_info_update */
 		bss_cap_update_on_sta_join(padapter, pstat);
 		sta_info_update(padapter, pstat);
drivers/staging/rtl8723bs/core/rtw_xmit.c +29 -29

64 lines not on this page · raw message

Signature · 1 line
2.34.1
#2 lore raw

Re: [v3 1/1] staging: rtl8723bs: Prevent duplicate NULL tests on a value

Quoted 9 lines · Abraham Samuel Adekunle

When a value has been tested for NULL in an expression, a second NULL test on the same value in another expression is unnecessary when the value has not been assigned NULL.

Remove unnecessary duplicate NULL tests on the same value that has previously been NULL tested.

Found by Coccinelle.

...

drivers/staging/rtl8723bs/core/rtw_xmit.c s32 rtw_make_wlanhdr(struct adapter *padapter, u8 *hdr, struct pkt_attrib *pattr · line 971

Quoted 7 lines
drivers/staging/rtl8723bs/core/rtw_xmit.c +5 -0
+                       psta->sta_xmitpriv.txseq_tid[pattrib->priority] &= 0xFFF;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (tx_seq + 1) & 0xfff;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (pattrib->seqnum + 1) % 4096;

Logically it's obvious that you need to align all cases to have consistent approach.
Besides that the commit message should mention this change. Something like this "While at it, convert '& 0xfff' cases to use modulo operator and decimal number to make the upper limit visible and clear what the semantic of it is."

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#3 lore raw

Re: [v3 1/1] staging: rtl8723bs: Prevent duplicate NULL tests on a value

Quoted 23 lines · Andy Shevchenko
Quoted 9 lines · Abraham Samuel Adekunle

When a value has been tested for NULL in an expression, a second NULL test on the same value in another expression is unnecessary when the value has not been assigned NULL.

Remove unnecessary duplicate NULL tests on the same value that has previously been NULL tested.

Found by Coccinelle.

...

drivers/staging/rtl8723bs/core/rtw_xmit.c s32 rtw_make_wlanhdr(struct adapter *padapter, u8 *hdr, struct pkt_attrib *pattr · line 971

Quoted 7 lines
drivers/staging/rtl8723bs/core/rtw_xmit.c +5 -0
+                       psta->sta_xmitpriv.txseq_tid[pattrib->priority] &= 0xFFF;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (tx_seq + 1) & 0xfff;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (pattrib->seqnum + 1) % 4096;
Quoted 6 lines

Logically it's obvious that you need to align all cases to have consistent approach.
Besides that the commit message should mention this change. Something like this "While at it, convert '& 0xfff' cases to use modulo operator and decimal number to make the upper limit visible and clear what the semantic of it is."

Okay, I will do that.
Thank you for being so patient

Adekunle.

#4 lore raw

Re: [v3 1/1] staging: rtl8723bs: Prevent duplicate NULL tests on a value

In reply to Andy Shevchenko
Quoted 22 lines · Andy Shevchenko
Quoted 9 lines · Abraham Samuel Adekunle

When a value has been tested for NULL in an expression, a second NULL test on the same value in another expression is unnecessary when the value has not been assigned NULL.

Remove unnecessary duplicate NULL tests on the same value that has previously been NULL tested.

Found by Coccinelle.

...

drivers/staging/rtl8723bs/core/rtw_xmit.c s32 rtw_make_wlanhdr(struct adapter *padapter, u8 *hdr, struct pkt_attrib *pattr · line 971

Quoted 7 lines
drivers/staging/rtl8723bs/core/rtw_xmit.c +5 -0
+                       psta->sta_xmitpriv.txseq_tid[pattrib->priority] &= 0xFFF;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (tx_seq + 1) & 0xfff;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (pattrib->seqnum + 1) % 4096;
Quoted 6 lines

Logically it's obvious that you need to align all cases to have consistent approach.
Besides that the commit message should mention this change. Something like this "While at it, convert '& 0xfff' cases to use modulo operator and decimal number to make the upper limit visible and clear what the semantic of it is."

No, I'm sorry but that's really against the rules in drivers/staging. Don't mix unrelated changes into a patch. It needs to be done as a separate patch if we're going to do that.

To be honest, I don't even want people fixing line length issues or adding spaces. I would have accepted small white space changes but I prefered the v2 version of this patch. Once you start changing "& 0xfff" to "% 4096" that's not white space and it must be done in a separate patch. I use a script to review white space patches because I'm always nervous someone will slip something malicious into 100+ lines of reformated code. It's really fast to review patches with my script but once people start mixing things in then it's a headache for me.

Also if the change accidentally introduces a bug, I want it to be a one liner change and not something hidden inside a giant reformat.

regards,
dan carpenter

#5 lore raw

Re: [v3 1/1] staging: rtl8723bs: Prevent duplicate NULL tests on a value

Quoted 45 lines · Dan Carpenter
Quoted 22 lines · Andy Shevchenko
Quoted 9 lines · Abraham Samuel Adekunle

When a value has been tested for NULL in an expression, a second NULL test on the same value in another expression is unnecessary when the value has not been assigned NULL.

Remove unnecessary duplicate NULL tests on the same value that has previously been NULL tested.

Found by Coccinelle.

...

drivers/staging/rtl8723bs/core/rtw_xmit.c s32 rtw_make_wlanhdr(struct adapter *padapter, u8 *hdr, struct pkt_attrib *pattr · line 971

Quoted 7 lines
drivers/staging/rtl8723bs/core/rtw_xmit.c +5 -0
+                       psta->sta_xmitpriv.txseq_tid[pattrib->priority] &= 0xFFF;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (tx_seq + 1) & 0xfff;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (pattrib->seqnum + 1) % 4096;
Quoted 6 lines

Logically it's obvious that you need to align all cases to have consistent approach.
Besides that the commit message should mention this change. Something like this "While at it, convert '& 0xfff' cases to use modulo operator and decimal number to make the upper limit visible and clear what the semantic of it is."

No, I'm sorry but that's really against the rules in drivers/staging. Don't mix unrelated changes into a patch. It needs to be done as a separate patch if we're going to do that.

To be honest, I don't even want people fixing line length issues or adding spaces. I would have accepted small white space changes but I prefered the v2 version of this patch. Once you start changing "& 0xfff" to "% 4096" that's not white space and it must be done in a separate patch. I use a script to review white space patches because I'm always nervous someone will slip something malicious into 100+ lines of reformated code. It's really fast to review patches with my script but once people start mixing things in then it's a headache for me.

Quoted 5 lines

Also if the change accidentally introduces a bug, I want it to be a one liner change and not something hidden inside a giant reformat.

regards,
dan carpenter

Hello Dan,
Thank you for your review.
Please can you provide some guidance on what the next steps should be for me as regards the patch?
Thank you.

Adekunle

#6 lore raw

Re: [v3 1/1] staging: rtl8723bs: Prevent duplicate NULL tests on a value

In reply to Dan Carpenter
Quoted 3 lines · Dan Carpenter
Quoted 2 lines · Andy Shevchenko

On Fri, Apr 4, 2025 at 3:03 AM Abraham Samuel Adekunle <[email protected]> wrote:

...

Quoted 19 lines
Quoted 8 lines

drivers/staging/rtl8723bs/core/rtw_xmit.c s32 rtw_make_wlanhdr(struct adapter *padapter, u8 *hdr, struct pkt_attrib *pattr · line 971

Quoted 7 lines
drivers/staging/rtl8723bs/core/rtw_xmit.c +5 -0
+                       psta->sta_xmitpriv.txseq_tid[pattrib->priority] &= 0xFFF;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (tx_seq + 1) & 0xfff;
 
+                                       psta->BA_starting_seqctrl[pattrib->priority & 0x0f] =
+                                               (pattrib->seqnum + 1) % 4096;
Quoted 6 lines

Logically it's obvious that you need to align all cases to have consistent approach.
Besides that the commit message should mention this change. Something like this "While at it, convert '& 0xfff' cases to use modulo operator and decimal number to make the upper limit visible and clear what the semantic of it is."

No, I'm sorry but that's really against the rules in drivers/staging. Don't mix unrelated changes into a patch. It needs to be done as a separate patch if we're going to do that.

Quoted 9 lines

To be honest, I don't even want people fixing line length issues or adding spaces. I would have accepted small white space changes but I prefered the v2 version of this patch. Once you start changing "& 0xfff" to "% 4096" that's not white space and it must be done in a separate patch. I use a script to review white space patches because I'm always nervous someone will slip something malicious into 100+ lines of reformated code. It's really fast to review patches with my script but once people start mixing things in then it's a headache for me.

Separate patch is even better, indeed.

Quoted 2 lines

Also if the change accidentally introduces a bug, I want it to be a one liner change and not something hidden inside a giant reformat.

The noisy {] have no point to be left. Now I'm curious, what do you propose here?

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#7 lore raw

Re: [v3 1/1] staging: rtl8723bs: Prevent duplicate NULL tests on a value

Quoted 5 lines · Andy Shevchenko
Quoted 2 lines

Also if the change accidentally introduces a bug, I want it to be a one liner change and not something hidden inside a giant reformat.

The noisy {] have no point to be left. Now I'm curious, what do you propose here?

The patch *must* remove the { and }. We wouldn't have accepted the v1 patch.

regards,
dan carpenter

maintainer
#8 lore raw
In reply to Abraham Samuel Adekunle
Quoted 3 lines · Abraham Samuel Adekunle

The patchset modifies unnecessary duplicate NULL test on a value in an expression, when the value has been NULL tested in a previous expression.

Nit, the subject line does nto have "staging:" in it, so I don't know where this goes.

Also, it really reads as "this is an unnecessary patch" :)

And finally, for a single patch, there's usually not a need for a 0/X email to describe it, everything should be in just the single patch itself.

thanks,

greg k-h

#9 lore raw
Quoted 9 lines · Greg KH
Quoted 3 lines · Abraham Samuel Adekunle

The patchset modifies unnecessary duplicate NULL test on a value in an expression, when the value has been NULL tested in a previous expression.

Nit, the subject line does nto have "staging:" in it, so I don't know where this goes.

Also, it really reads as "this is an unnecessary patch" :)

Technically, in English, if you have a noun that is being used as an adjective and that noun is itself modified in some way, you should use a hyphen:

Unnecessary-code cleanup patches

But something like

Remove unnecessary code

would have had no ambiguity at all. Also everything you are doing is a patch, so "patches" in the subject line doesn't seem very necessary.

julia

Quoted 10 lines

And finally, for a single patch, there's usually not a need for a 0/X email to describe it, everything should be in just the single patch itself.

thanks,

greg k-h

#11 lore raw
In reply to Greg KH
Quoted 10 lines · Greg KH
Quoted 3 lines · Abraham Samuel Adekunle

The patchset modifies unnecessary duplicate NULL test on a value in an expression, when the value has been NULL tested in a previous expression.

Nit, the subject line does nto have "staging:" in it, so I don't know where this goes.

Also, it really reads as "this is an unnecessary patch" :)

Argh, Not what I meant to say at all :)
Thank you.

Quoted 4 lines

And finally, for a single patch, there's usually not a need for a 0/X email to describe it, everything should be in just the single patch itself.

It initially started as a patchset with modification for three different drivers, one patch for each driver, but two were dropped from the patchset for being media drivers.
So I thought I should add the cover letter to the only patch left in the patchset so details about the changes can be made known.

I've made a note of this. Thanks.
Adekunle.

#10 lore raw
In reply to Julia Lawall
Quoted 13 lines · Julia Lawall
Quoted 8 lines · Greg KH
Quoted 3 lines · Abraham Samuel Adekunle

The patchset modifies unnecessary duplicate NULL test on a value in an expression, when the value has been NULL tested in a previous expression.

Nit, the subject line does nto have "staging:" in it, so I don't know where this goes.

Quoted 7 lines
Quoted 1 line

Also, it really reads as "this is an unnecessary patch" :)

Technically, in English, if you have a noun that is being used as an adjective and that noun is itself modified in some way, you should use a hyphen:

Unnecessary-code cleanup patches

Yes this was what I intended to do. ;)
Thank you

Quoted 4 lines

But something like

Remove unnecessary code

Yes perfect.

Quoted 4 lines

would have had no ambiguity at all. Also everything you are doing is a patch, so "patches" in the subject line doesn't seem very necessary.

Thank you, Julia.

I will update it as necessary.

Adekunle.