Skip to contentSkip to conversation

Correct long line comments and remove whitespace in code

PATCH Superseded R Veera Kumar 3 participants 8 messages Mar 20, 2020 – Mar 21, 2020 Staging

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover Correct long line comments and remove whitespace in code

Correct long line comments to match coding style of respecting 80 character per line limit.

Remove five leading whitespace characters in code line.

---
R Veera Kumar (2):
staging: rtl8723bs: os_dep: Correct long line comments
staging: rtl8723bs: os_dep: Remove whitespace characters in code line

 drivers/staging/rtl8723bs/os_dep/recv_linux.c | 38 +++++++++++++------
 1 file changed, 26 insertions(+), 12 deletions(-)
Signature · 1 line
2.20.1
#1 lore raw

PATCH 1/2 staging: rtl8723bs: os_dep: Correct long line comments

Correct long line comments to respect 80 character per line limit.

---
Changes in v3:
- Remove extra ' ' character before comment
Changes in v2:
- Remove an extra blank line added by error

---
 drivers/staging/rtl8723bs/os_dep/recv_linux.c | 26 ++++++++++++++-----
 1 file changed, 20 insertions(+), 6 deletions(-)
drivers/staging/rtl8723bs/os_dep/recv_linux.c +20 -6
index a6491f163272..87090af7d776 100644
@@ -35,7 +35,8 @@ void rtw_os_recv_resource_free(struct recv_priv *precvpriv)
 
 	for (i = 0; i < NR_RECVFRAME; i++) {
 		if (precvframe->u.hdr.pkt) {
-			dev_kfree_skb_any(precvframe->u.hdr.pkt);/* free skb by driver */
+			/* free skb by driver */
+			dev_kfree_skb_any(precvframe->u.hdr.pkt);
 			precvframe->u.hdr.pkt = NULL;
 		}
 		precvframe++;
@@ -80,7 +81,10 @@ _pkt *rtw_os_alloc_msdu_pkt(union recv_frame *prframe, u16 nSubframe_Length, u8
 		((!memcmp(sub_skb->data, rtw_rfc1042_header, SNAP_SIZE) &&
 		  eth_type != ETH_P_AARP && eth_type != ETH_P_IPX) ||
 		 !memcmp(sub_skb->data, rtw_bridge_tunnel_header, SNAP_SIZE))) {
-		/* remove RFC1042 or Bridge-Tunnel encapsulation and replace EtherType */
+		/*
+		 * remove RFC1042 or Bridge-Tunnel encapsulation and replace
+		 * EtherType
+		 */
 		skb_pull(sub_skb, SNAP_SIZE);
 		memcpy(skb_push(sub_skb, ETH_ALEN), pattrib->src, ETH_ALEN);
 		memcpy(skb_push(sub_skb, ETH_ALEN), pattrib->dst, ETH_ALEN);
@@ -112,7 +116,10 @@ void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt
 			/* DBG_871X("bmcast =%d\n", bmcast); */
 
 			if (memcmp(pattrib->dst, myid(&padapter->eeprompriv), ETH_ALEN)) {
-				/* DBG_871X("not ap psta =%p, addr =%pM\n", psta, pattrib->dst); */
+				/*
+				 * DBG_871X("not ap psta =%p, addr =%pM\n",
+				 * psta, pattrib->dst);
+				 */
 
 				if (bmcast) {
 					psta = rtw_get_bcmc_stainfo(padapter);
@@ -124,7 +131,10 @@ void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt
 				if (psta) {
 					struct net_device *pnetdev = (struct net_device*)padapter->pnetdev;
 
-					/* DBG_871X("directly forwarding to the rtw_xmit_entry\n"); */
+					/*
+					 * DBG_871X("directly forwarding to the
+					 * rtw_xmit_entry\n");
+					 */
 
 					/* skb->ip_summed = CHECKSUM_NONE; */
 					pkt->dev = pnetdev;
@@ -236,7 +246,10 @@ static void rtw_os_ksocket_send(struct adapter *padapter, union recv_frame *prec
 			u16 len = *(u16*)(skb->data+ETH_HLEN+2);
 			/* u16 ctrl_type = *(u16*)(skb->data+ETH_HLEN+4); */
 
-			/* DBG_871X("eth, RC: len = 0x%x, ctrl_type = 0x%x\n", len, ctrl_type); */
+			/*
+			 * DBG_871X("eth, RC: len = 0x%x, ctrl_type = 0x%x\n",
+			 * len, ctrl_type);
+			 */
 			DBG_871X("eth, RC: len = 0x%x\n", len);
 
 			for (i = 0; i < len; i++)
@@ -291,7 +304,8 @@ int rtw_recv_indicatepkt(struct adapter *padapter, union recv_frame *precv_frame
 
 	rtw_os_recv_indicate_pkt(padapter, skb, pattrib);
 
-	precv_frame->u.hdr.pkt = NULL; /*  pointers to NULL before rtw_free_recvframe() */
+	/* pointers to NULL before rtw_free_recvframe() */
+	precv_frame->u.hdr.pkt = NULL;
 
 	rtw_free_recvframe(precv_frame, pfree_recv_queue);
 
Signature · 1 line
2.20.1
#2 lore raw

Re: [PATCH 1/2] staging: rtl8723bs: os_dep: Correct long line comments

Quoted 40 lines · R Veera Kumar

Correct long line comments to respect 80 character per line limit.

---
Changes in v3:
- Remove extra ' ' character before comment
Changes in v2:
- Remove an extra blank line added by error

---
 drivers/staging/rtl8723bs/os_dep/recv_linux.c | 26 ++++++++++++++-----
 1 file changed, 20 insertions(+), 6 deletions(-)
drivers/staging/rtl8723bs/os_dep/recv_linux.c +6 -2
index a6491f163272..87090af7d776 100644
@@ -35,7 +35,8 @@ void rtw_os_recv_resource_free(struct recv_priv *precvpriv)
 
 	for (i = 0; i < NR_RECVFRAME; i++) {
 		if (precvframe->u.hdr.pkt) {
-			dev_kfree_skb_any(precvframe->u.hdr.pkt);/* free skb by driver */
+			/* free skb by driver */
+			dev_kfree_skb_any(precvframe->u.hdr.pkt);
 			precvframe->u.hdr.pkt = NULL;
 		}
 		precvframe++;
@@ -80,7 +81,10 @@ _pkt *rtw_os_alloc_msdu_pkt(union recv_frame *prframe, u16 nSubframe_Length, u8
 		((!memcmp(sub_skb->data, rtw_rfc1042_header, SNAP_SIZE) &&
 		  eth_type != ETH_P_AARP && eth_type != ETH_P_IPX) ||
 		 !memcmp(sub_skb->data, rtw_bridge_tunnel_header, SNAP_SIZE))) {
-		/* remove RFC1042 or Bridge-Tunnel encapsulation and replace EtherType */
+		/*
+		 * remove RFC1042 or Bridge-Tunnel encapsulation and replace
+		 * EtherType
+		 */
 		skb_pull(sub_skb, SNAP_SIZE);
 		memcpy(skb_push(sub_skb, ETH_ALEN), pattrib->src, ETH_ALEN);
 		memcpy(skb_push(sub_skb, ETH_ALEN), pattrib->dst, ETH_ALEN);

drivers/staging/rtl8723bs/os_dep/recv_linux.c void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt · line 121

Quoted 7 lines
drivers/staging/rtl8723bs/os_dep/recv_linux.c +3 -1
@@ -112,7 +116,10 @@ void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt
 			/* DBG_871X("bmcast =%d\n", bmcast); */
 
 			if (memcmp(pattrib->dst, myid(&padapter->eeprompriv), ETH_ALEN)) {
-				/* DBG_871X("not ap psta =%p, addr =%pM\n", psta, pattrib->dst); */
+				/*
+				 * DBG_871X("not ap psta =%p, addr =%pM\n",
+				 * psta, pattrib->dst);

Again, this is not a long-line comment, it is a code line that is commented out. Remove it in a patch previous to this one please.

drivers/staging/rtl8723bs/os_dep/recv_linux.c void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt · line 136

Quoted 12 lines
drivers/staging/rtl8723bs/os_dep/recv_linux.c +4 -1
+				 */
 
 				if (bmcast) {
 					psta = rtw_get_bcmc_stainfo(padapter);
@@ -124,7 +131,10 @@ void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt
 				if (psta) {
 					struct net_device *pnetdev = (struct net_device*)padapter->pnetdev;
 
-					/* DBG_871X("directly forwarding to the rtw_xmit_entry\n"); */
+					/*
+					 * DBG_871X("directly forwarding to the
+					 * rtw_xmit_entry\n");

Same here.

thanks,

greg k-h

#3 lore raw

Re: [PATCH 1/2] staging: rtl8723bs: os_dep: Correct long line comments

Quoted 10 lines · Greg Kroah-Hartman
Quoted 9 lines · R Veera Kumar

Correct long line comments to respect 80 character per line limit.

drivers/staging/rtl8723bs/os_dep/recv_linux.c +0 -0
index a6491f163272..87090af7d776 100644
@@ -35,7 +35,8 @@ void rtw_os_recv_resource_free(struct recv_priv *precvpriv)
 
Quoted 9 lines

drivers/staging/rtl8723bs/os_dep/recv_linux.c void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt · line 121

Quoted 5 lines
drivers/staging/rtl8723bs/os_dep/recv_linux.c +3 -1
 			if (memcmp(pattrib->dst, myid(&padapter->eeprompriv), ETH_ALEN)) {
-				/* DBG_871X("not ap psta =%p, addr =%pM\n", psta, pattrib->dst); */
+				/*
+				 * DBG_871X("not ap psta =%p, addr =%pM\n",
+				 * psta, pattrib->dst);

Again, this is not a long-line comment, it is a code line that is commented out. Remove it in a patch previous to this one please.

Okay I understand now that it is not a valid comment describing how it functions.

But is not that the developers intention was to keep this to remind him of doing something.

Or should he should have kept in his codebase and not here.

Also should I create a patch to remove this commented out code lines in the same patch series or a new one.

Veera

Quoted 18 lines

drivers/staging/rtl8723bs/os_dep/recv_linux.c void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt · line 136

Quoted 12 lines
drivers/staging/rtl8723bs/os_dep/recv_linux.c +4 -1
+				 */
 
 				if (bmcast) {
 					psta = rtw_get_bcmc_stainfo(padapter);
@@ -124,7 +131,10 @@ void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt
 				if (psta) {
 					struct net_device *pnetdev = (struct net_device*)padapter->pnetdev;
 
-					/* DBG_871X("directly forwarding to the rtw_xmit_entry\n"); */
+					/*
+					 * DBG_871X("directly forwarding to the
+					 * rtw_xmit_entry\n");

Same here.

thanks,

greg k-h

#4 lore raw

Re: [Outreachy kernel] Re: [PATCH 1/2] staging: rtl8723bs: os_dep: Correct long line comments

Quoted 21 lines · R Veera Kumar
Quoted 10 lines · Greg Kroah-Hartman
Quoted 9 lines · R Veera Kumar

Correct long line comments to respect 80 character per line limit.

drivers/staging/rtl8723bs/os_dep/recv_linux.c +0 -0
index a6491f163272..87090af7d776 100644
@@ -35,7 +35,8 @@ void rtw_os_recv_resource_free(struct recv_priv *precvpriv)
 
Quoted 9 lines

drivers/staging/rtl8723bs/os_dep/recv_linux.c void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt · line 121

Quoted 5 lines
drivers/staging/rtl8723bs/os_dep/recv_linux.c +3 -1
 			if (memcmp(pattrib->dst, myid(&padapter->eeprompriv), ETH_ALEN)) {
-				/* DBG_871X("not ap psta =%p, addr =%pM\n", psta, pattrib->dst); */
+				/*
+				 * DBG_871X("not ap psta =%p, addr =%pM\n",
+				 * psta, pattrib->dst);

Again, this is not a long-line comment, it is a code line that is commented out. Remove it in a patch previous to this one please.

Quoted 5 lines

Okay I understand now that it is not a valid comment describing how it functions.

But is not that the developers intention was to keep this to remind him of doing something.

In general, commented out code is not wanted. It could be found in the git history if needed. You can also use git blame to see how long the code has been there. If it has been there a long time, it seems less likely to be needed. Finally, this is debugging code. If someone needs that in the future, they can easily re-add it, with precisely the information that they are trying to debug for.

julia

Quoted 32 lines

Or should he should have kept in his codebase and not here.

Also should I create a patch to remove this commented out code lines in the same patch series or a new one.

Veera

Quoted 15 lines

drivers/staging/rtl8723bs/os_dep/recv_linux.c void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt · line 136

Quoted 12 lines
drivers/staging/rtl8723bs/os_dep/recv_linux.c +4 -1
+				 */
 
 				if (bmcast) {
 					psta = rtw_get_bcmc_stainfo(padapter);
@@ -124,7 +131,10 @@ void rtw_os_recv_indicate_pkt(struct adapter *padapter, _pkt *pkt, struct rx_pkt
 				if (psta) {
 					struct net_device *pnetdev = (struct net_device*)padapter->pnetdev;
 
-					/* DBG_871X("directly forwarding to the rtw_xmit_entry\n"); */
+					/*
+					 * DBG_871X("directly forwarding to the
+					 * rtw_xmit_entry\n");

Same here.

Quoted 3 lines

thanks,

greg k-h

--
You received this message because you are subscribed to the Google Groups "outreachy-kernel" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/outreachy-kernel/20200321021416.GA569%40tulip.local.

#5 lore raw

PATCH 2/2 staging: rtl8723bs: os_dep: Remove whitespace characters in code line

In reply to R Veera Kumar

Remove five leading whitespace characters in code line.

---
 drivers/staging/rtl8723bs/os_dep/recv_linux.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
drivers/staging/rtl8723bs/os_dep/recv_linux.c +6 -6
index 87090af7d776..1502477e48bb 100644
@@ -79,8 +79,8 @@ _pkt *rtw_os_alloc_msdu_pkt(union recv_frame *prframe, u16 nSubframe_Length, u8
 
 	if (sub_skb->len >= 8 &&
 		((!memcmp(sub_skb->data, rtw_rfc1042_header, SNAP_SIZE) &&
-		  eth_type != ETH_P_AARP && eth_type != ETH_P_IPX) ||
-		 !memcmp(sub_skb->data, rtw_bridge_tunnel_header, SNAP_SIZE))) {
+		eth_type != ETH_P_AARP && eth_type != ETH_P_IPX) ||
+		!memcmp(sub_skb->data, rtw_bridge_tunnel_header, SNAP_SIZE))) {
 		/*
 		 * remove RFC1042 or Bridge-Tunnel encapsulation and replace
 		 * EtherType
@@ -315,11 +315,11 @@ int rtw_recv_indicatepkt(struct adapter *padapter, union recv_frame *precv_frame
 
 _recv_indicatepkt_drop:
 
-	 /* enqueue back to free_recv_queue */
-	 rtw_free_recvframe(precv_frame, pfree_recv_queue);
+	/* enqueue back to free_recv_queue */
+	rtw_free_recvframe(precv_frame, pfree_recv_queue);
 
-	 DBG_COUNTER(padapter->rx_logs.os_indicate_err);
-	 return _FAIL;
+	DBG_COUNTER(padapter->rx_logs.os_indicate_err);
+	return _FAIL;
 }
 
 void rtw_init_recv_timer(struct recv_reorder_ctrl *preorder_ctrl)
Signature · 1 line
2.20.1
#6 lore raw

Re: [PATCH 2/2] staging: rtl8723bs: os_dep: Remove whitespace characters in code line

Quoted 12 lines · R Veera Kumar

Remove five leading whitespace characters in code line.

---
 drivers/staging/rtl8723bs/os_dep/recv_linux.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
drivers/staging/rtl8723bs/os_dep/recv_linux.c +0 -0
index 87090af7d776..1502477e48bb 100644

drivers/staging/rtl8723bs/os_dep/recv_linux.c _pkt *rtw_os_alloc_msdu_pkt(union recv_frame *prframe, u16 nSubframe_Length, u8 · line 83

Quoted 7 lines
drivers/staging/rtl8723bs/os_dep/recv_linux.c +2 -2
@@ -79,8 +79,8 @@ _pkt *rtw_os_alloc_msdu_pkt(union recv_frame *prframe, u16 nSubframe_Length, u8
 
 	if (sub_skb->len >= 8 &&
 		((!memcmp(sub_skb->data, rtw_rfc1042_header, SNAP_SIZE) &&
-		  eth_type != ETH_P_AARP && eth_type != ETH_P_IPX) ||
-		 !memcmp(sub_skb->data, rtw_bridge_tunnel_header, SNAP_SIZE))) {
+		eth_type != ETH_P_AARP && eth_type != ETH_P_IPX) ||
+		!memcmp(sub_skb->data, rtw_bridge_tunnel_header, SNAP_SIZE))) {

No, the original was correct here, checkpatch should not have complained about this.

thanks,

greg k-h

#7 lore raw

Re: [PATCH 2/2] staging: rtl8723bs: os_dep: Remove whitespace characters in code line

Quoted 14 lines · Greg Kroah-Hartman
Quoted 13 lines · R Veera Kumar

Remove five leading whitespace characters in code line.

---
 drivers/staging/rtl8723bs/os_dep/recv_linux.c | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)
drivers/staging/rtl8723bs/os_dep/recv_linux.c +0 -0
index 87090af7d776..1502477e48bb 100644
@@ -79,8 +79,8 @@ _pkt *rtw_os_alloc_msdu_pkt(union recv_frame *prframe, u16 nSubframe_Length, u8
 
Quoted 10 lines

drivers/staging/rtl8723bs/os_dep/recv_linux.c _pkt *rtw_os_alloc_msdu_pkt(union recv_frame *prframe, u16 nSubframe_Length, u8 · line 83

Quoted 6 lines
drivers/staging/rtl8723bs/os_dep/recv_linux.c +2 -2
 	if (sub_skb->len >= 8 &&
 		((!memcmp(sub_skb->data, rtw_rfc1042_header, SNAP_SIZE) &&
-		  eth_type != ETH_P_AARP && eth_type != ETH_P_IPX) ||
-		 !memcmp(sub_skb->data, rtw_bridge_tunnel_header, SNAP_SIZE))) {
+		eth_type != ETH_P_AARP && eth_type != ETH_P_IPX) ||
+		!memcmp(sub_skb->data, rtw_bridge_tunnel_header, SNAP_SIZE))) {

No, the original was correct here, checkpatch should not have complained about this.

This is V1 patch. I removed a single white space before "eth_type !=" as definitely it is compound argument code.

Please see V2 patch. In which Greg says this is fine.

Should final comment by him is to be accepted?

Veera

Quoted 3 lines

thanks,

greg k-h