Skip to contentSkip to conversation

staging: rtl8188eu: core: fixed a comment format issue.

PATCH In review Daniel West 4 participants 4 messages Dec 19, 2020 – Dec 28, 2020 Staging

lore
Share & tools
lore
#0 lore raw

PATCH 8455/8455 staging: rtl8188eu: core: fixed a comment format issue.

Fixed a checkpatch warning:

WARNING: Block comments use * on subsequent lines
#4595: FILE: drivers/staging/rtl8188eu/core/rtw_mlme_ext.c:4595:
+/**************************************************************************** +

The code is full of comments like this. Should the coding style be inforced here, even when there is a logic to the way the code was broken up?

---
 drivers/staging/rtl8188eu/core/rtw_mlme_ext.c | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)
drivers/staging/rtl8188eu/core/rtw_mlme_ext.c +4 -5
index 8794907a39f4..adf2788a416f 100644
@@ -4591,11 +4591,10 @@ void mlmeext_sta_del_event_callback(struct adapter *padapter)
 	}
 }
 
-/****************************************************************************
-
-Following are the functions for the timer handlers
-
-*****************************************************************************/
+/*
+ *
+ *Following are the functions for the timer handlers
+ */
 
 static u8 chk_ap_is_alive(struct adapter *padapter, struct sta_info *psta)
 {
Signature · 1 line
2.25.1
#1 lore raw
Quoted 10 lines · Daniel West

Fixed a checkpatch warning:

WARNING: Block comments use * on subsequent lines
#4595: FILE: drivers/staging/rtl8188eu/core/rtw_mlme_ext.c:4595:

(quoted diff) +2 -0
+/****************************************************************************
+

The code is full of comments like this. Should the coding style be inforced here, even when there is a logic to the way the code was broken up?

You should make one patch which atleast fix one file at ones. It would be even better if it fixes whole stuff (example one driver) right a way. Also note that you should not but this kind messages to your patch message. If you want to note this kind of thing you can use --- and after that it will not included in patch itself. You can read it online more.

Also where does this [PATCH 8455/8455] even come from? Good thing is that you really didn't send so many patches or atleast I won't see them.

And it seems that you are new so welcome a board :)

--
Kari Argillander

maintainer
#2 lore raw
In reply to Daniel West
Quoted 23 lines · Daniel West

Fixed a checkpatch warning:

WARNING: Block comments use * on subsequent lines
#4595: FILE: drivers/staging/rtl8188eu/core/rtw_mlme_ext.c:4595:

(quoted diff) +2 -0
+/****************************************************************************
+

The code is full of comments like this. Should the coding style be inforced here, even when there is a logic to the way the code was broken up?

---
 drivers/staging/rtl8188eu/core/rtw_mlme_ext.c | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)
drivers/staging/rtl8188eu/core/rtw_mlme_ext.c +0 -0
index 8794907a39f4..adf2788a416f 100644
@@ -4591,11 +4591,10 @@ void mlmeext_sta_del_event_callback(struct adapter *padapter)
 	}
 }

drivers/staging/rtl8188eu/core/rtw_mlme_ext.c void mlmeext_sta_del_event_callback(struct adapter *padapter) · line 4597

Quoted 10 lines
drivers/staging/rtl8188eu/core/rtw_mlme_ext.c +4 -5
 
-/****************************************************************************
-
-Following are the functions for the timer handlers
-
-*****************************************************************************/
+/*
+ *
+ *Following are the functions for the timer handlers
+ */

Does that look correct? Make it all one line please.

thanks,

greg k-h

#3 lore raw
Quoted 11 lines · Greg KH
Quoted 10 lines · Daniel West

Fixed a checkpatch warning:

WARNING: Block comments use * on subsequent lines #4595: FILE: drivers/staging/rtl8188eu/core/rtw_mlme_ext.c:4595:

(quoted diff) +2 -0
+/****************************************************************************
+

The code is full of comments like this. Should the coding style be inforced here, even when there is a logic to the way the code was broken up?

[]

Quoted 1 line

drivers/staging/rtl8188eu/core/rtw_mlme_ext.c

Quoted 1 line
drivers/staging/rtl8188eu/core/rtw_mlme_ext.c +0 -0

[]

Quoted 5 lines
Quoted 5 lines
drivers/staging/rtl8188eu/core/rtw_mlme_ext.c +0 -0
@@ -4591,11 +4591,10 @@ void mlmeext_sta_del_event_callback(struct adapter *padapter)
  	}
  }

Quoted 11 lines

drivers/staging/rtl8188eu/core/rtw_mlme_ext.c void mlmeext_sta_del_event_callback(struct adapter *padapter) · line 4597

Quoted 9 lines
drivers/staging/rtl8188eu/core/rtw_mlme_ext.c +4 -5
-/****************************************************************************
-
-Following are the functions for the timer handlers
-
-*****************************************************************************/
+/*
+ *
+ *Following are the functions for the timer handlers
+ */

Does that look correct? Make it all one line please.

Just:

/* timer handler functions */

would be simpler.

And the code is mostly a horror to read.