staging: rtl8723bs: fix block comment style to match kernel coding guidline
Ankit Bhalani [email protected]
PATCH 1/1 staging: rtl8723bs: fix block comment style to match kernel coding guidline
From: Ankit Bhalani <[email protected]>
Update block comments to follow the Linux kernel coding style recommendations. This include:
- Ensuring proper formatting and alignment for multi-line comments.
--- .../staging/rtl8723bs/core/rtw_ieee80211.c | 26 +++-- drivers/staging/rtl8723bs/core/rtw_io.c | 48 ++++----- drivers/staging/rtl8723bs/core/rtw_mlme.c | 75 ++++++------- drivers/staging/rtl8723bs/core/rtw_mlme_ext.c | 102 ++++++++++-------- drivers/staging/rtl8723bs/core/rtw_pwrctrl.c | 10 +- drivers/staging/rtl8723bs/core/rtw_security.c | 87 +++++++-------- .../staging/rtl8723bs/core/rtw_wlan_util.c | 6 +- 7 files changed, 186 insertions(+), 168 deletions(-)
drivers/staging/rtl8723bs/core/rtw_ieee80211.c +17 -9
@@ -132,9 +132,11 @@ u8 *rtw_set_ie(u8 *pbuf,return pbuf + len +2 ; } -/*---------------------------------------------------------------------------- -index: the information element id index, limit is the limit for search ------------------------------------------------------------------------------*/ +/* +* ---------------------------------------------------------------------------- +* index: the information element id index, limit is the limit for search +* ---------------------------------------------------------------------------- +*/ u8 *rtw_get_ie (u8 *pbuf,signed int index,signed int *len,signed int limit) {signed int tmp, i;
@@ -769,21 +771,27 @@ static int rtw_ieee802_11_parse_vendor_specific(u8 *pos, uint elen, {unsigned int oui; -/* first 3 bytes in vendor specific information element are the IEEE +/* +* first 3 bytes in vendor specific information element are the IEEE * OUI of the vendor. The following byte is used a vendor specific -* sub-type. */ +* sub-type. +*/ if (elen <4 )return -1 ; oui =get_unaligned_be24 (pos);switch (oui) {case OUI_MICROSOFT : -/* Microsoft/Wi-Fi information elements are further typed and -* subtyped */ +/* +* Microsoft/Wi-Fi information elements are further typed and +* subtyped +*/ switch (pos[3 ]) {case 1 : -/* Microsoft OUI (00:50:F2) with OUI Type 1: -* real WPA information element */ +/* +* Microsoft OUI (00:50:F2) with OUI Type 1: +* real WPA information element +*/ elems->wpa_ie = pos; elems->wpa_ie_len = elen;break ;
drivers/staging/rtl8723bs/core/rtw_io.c +23 -25
66 lines not on this page · raw message
drivers/staging/rtl8723bs/core/rtw_mlme.c +38 -37
153 lines not on this page · raw message
drivers/staging/rtl8723bs/core/rtw_mlme_ext.c +56 -46
168 lines not on this page · raw message
drivers/staging/rtl8723bs/core/rtw_pwrctrl.c +5 -5
@@ -1005,11 +1005,11 @@ inline void rtw_set_ips_deny(struct adapter *padapter, u32 ms) }/* -* rtw_pwr_wakeup - Wake the NIC up from: 1)IPS. 2)USB autosuspend -* @adapter: pointer to struct adapter structure -* @ips_deffer_ms: the ms will prevent from falling into IPS after wakeup -* Return _SUCCESS or _FAIL -*/ +* rtw_pwr_wakeup - Wake the NIC up from: 1)IPS. 2)USB autosuspend +* @adapter: pointer to struct adapter structure +* @ips_deffer_ms: the ms will prevent from falling into IPS after wakeup +* Return _SUCCESS or _FAIL +*/ int _rtw_pwr_wakeup (struct adapter *padapter,u32 ips_deffer_ms,const char *caller) {
drivers/staging/rtl8723bs/core/rtw_security.c +44 -43
117 lines not on this page · raw message
drivers/staging/rtl8723bs/core/rtw_wlan_util.c +3 -3
@@ -1021,9 +1021,9 @@ void HTOnAssocRsp(struct adapter *padapter)/* handle A-MPDU parameter field */ /* -AMPDU_para [1:0]:Max AMPDU Len => 0:8k , 1:16k, 2:32k, 3:64k -AMPDU_para [4:2]:Min MPDU Start Spacing -*/ +* AMPDU_para [1:0]:Max AMPDU Len => 0:8k , 1:16k, 2:32k, 3:64k +* AMPDU_para [4:2]:Min MPDU Start Spacing +*/ max_AMPDU_len = pmlmeinfo->HT_caps.u.HT_cap_element.AMPDU_para &0x03 ; min_MPDU_spacing = (pmlmeinfo->HT_caps.u.HT_cap_element.AMPDU_para &0x1c ) >>2 ;
Signature · 1 line
2.43.0
Greg KH
maintainerQuoted 26 lines · On Wed, Oct 01, 2025 at 07:14:33PM +0530, [email protected] wrote:
From: Ankit Bhalani <[email protected]>
Update block comments to follow the Linux kernel coding style recommendations. This include:
- Ensuring proper formatting and alignment for multi-line comments.
Signed-off-by Ankit Bhalani <[email protected]>--- .../staging/rtl8723bs/core/rtw_ieee80211.c | 26 +++-- drivers/staging/rtl8723bs/core/rtw_io.c | 48 ++++----- drivers/staging/rtl8723bs/core/rtw_mlme.c | 75 ++++++------- drivers/staging/rtl8723bs/core/rtw_mlme_ext.c | 102 ++++++++++-------- drivers/staging/rtl8723bs/core/rtw_pwrctrl.c | 10 +- drivers/staging/rtl8723bs/core/rtw_security.c | 87 +++++++-------- .../staging/rtl8723bs/core/rtw_wlan_util.c | 6 +- 7 files changed, 186 insertions(+), 168 deletions(-)drivers/staging/rtl8723bs/core/rtw_ieee80211.c +0
-0@@ -132,9 +132,11 @@ u8 *rtw_set_ie(u8 *pbuf,return pbuf + len +2 ; }
drivers/staging/rtl8723bs/core/rtw_ieee80211.c u8 *rtw_set_ie(u8 *pbuf, · line 140
Quoted 10 lines
drivers/staging/rtl8723bs/core/rtw_ieee80211.c +5
-3-/*---------------------------------------------------------------------------- -index: the information element id index, limit is the limit for search ------------------------------------------------------------------------------*/ +/* +* ---------------------------------------------------------------------------- +* index: the information element id index, limit is the limit for search +* ---------------------------------------------------------------------------- +*/ u8 *rtw_get_ie (u8 *pbuf,signed int index,signed int *len,signed int limit)
This is an odd format for a function comment. Can you make this look more "correct"? All you are describing here is 2 of the variables and not what the function does at all.
drivers/staging/rtl8723bs/core/rtw_ieee80211.c u8 *rtw_set_ie(u8 *pbuf,
Quoted 8 lines
drivers/staging/rtl8723bs/core/rtw_ieee80211.c +3
-4/* -* Increase and check if the continual_io_error of this @param dvobjprive is larger than MAX_CONTINUAL_IO_ERR -* @return true: -* @return false: -*/ +* Increase and check if the continual_io_error of this @param dvobjprive is larger than MAX_CONTINUAL_IO_ERR +* @return true: +* @return false:
What does these last 2 lines mean?
Again, if you are going to comment a function, let's use the documented way to do so.
Same with other changes in this patch.
thanks,
greg k-h