staging: rtl8723bs: core: block comment style changes
v3 cover staging: rtl8723bs: core: block comment style changes
Style changes to block comments.
Changes since v2:
- add subsystem/driver prefix into 0/X email subject line
Changes since v1:
- all commit messages more accurately describe changes
Deborah Brouwer (3):
staging: rtl8723bs: core: add comma within a comment
staging: rtl8723bs: core: add * to block comments
staging: rtl8723bs: core: remove empty comment
drivers/staging/rtl8723bs/core/rtw_xmit.c | 61 +++++++++++------------ 1 file changed, 28 insertions(+), 33 deletions(-)
--
2.17.1
PATCH v3 1/3 staging: rtl8723bs: core: add comma within a comment
Add a comma to separate repeated words in a comment. The comma preserves the meaning of the comment while also stopping the checkpatch warning:
WARNING: Possible repeated word: 'very'.
--- drivers/staging/rtl8723bs/core/rtw_xmit.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/rtl8723bs/core/rtw_xmit.c +1 -1
@@ -1700,7 +1700,7 @@ Calling context:If we turn on USE_RXTHREAD, then, no need for critical section. Otherwise, we must use _enter/_exit critical to protect free_xmit_queue... -Must be very very cautious... +Must be very, very cautious... */ struct xmit_frame *rtw_alloc_xmitframe (struct xmit_priv *pxmitpriv)/* _queue *pfree_xmit_queue) */
Signature · 1 line
2.17.1
PATCH v3 2/3 staging: rtl8723bs: core: add * to block comments
In reply to Deborah BrouwerAdd * at the beginning of each line in block comments to conform to the Linux kernel coding style. Issue detected using checkpatch.
--- drivers/staging/rtl8723bs/core/rtw_xmit.c | 59 +++++++++++------------ 1 file changed, 28 insertions(+), 31 deletions(-)
drivers/staging/rtl8723bs/core/rtw_xmit.c +28 -31
@@ -46,8 +46,8 @@ s32 _rtw_init_xmit_priv(struct xmit_priv *pxmitpriv, struct adapter *padapter)init_completion (&pxmitpriv->terminate_xmitthread_comp);/* -Please insert all the queue initializaiton using _rtw_init_queue below -*/ +* Please insert all the queue initializaiton using _rtw_init_queue below +*/ pxmitpriv->adapter = padapter;
@@ -60,10 +60,10 @@ s32 _rtw_init_xmit_priv(struct xmit_priv *pxmitpriv, struct adapter *padapter)_rtw_init_queue (&pxmitpriv->free_xmit_queue);/* -Please allocate memory with the sz = (struct xmit_frame) * NR_XMITFRAME, -and initialize free_xmit_frame below. -Please also apply free_txobj to link_up all the xmit_frames... -*/ +* Please allocate memory with the sz = (struct xmit_frame) * NR_XMITFRAME, +* and initialize free_xmit_frame below. +* Please also apply free_txobj to link_up all the xmit_frames... +*/ pxmitpriv->pallocated_frame_buf =vzalloc (NR_XMITFRAME *sizeof (struct xmit_frame ) +4 );
@@ -1069,17 +1069,15 @@ u32 rtw_calculate_wlan_pkt_size_by_attribue(struct pkt_attrib *pattrib) }/* - -This sub-routine will perform all the following: - -1. remove 802.3 header. -2. create wlan_header, based on the info in pxmitframe -3. append sta's iv/ext-iv -4. append LLC -5. move frag chunk from pframe to pxmitframe->mem -6. apply sw-encrypt, if necessary. - -*/ +* This sub-routine will perform all the following: +* +* 1. remove 802.3 header. +* 2. create wlan_header, based on the info in pxmitframe +* 3. append sta's iv/ext-iv +* 4. append LLC +* 5. move frag chunk from pframe to pxmitframe->mem +* 6. apply sw-encrypt, if necessary. +*/ s32 rtw_xmitframe_coalesce (struct adapter *padapter,struct sk_buff *pkt,struct xmit_frame *pxmitframe) {struct pkt_file pktfile;
@@ -1693,23 +1691,22 @@ static void rtw_init_xmitframe(struct xmit_frame *pxframe) }/* -Calling context: -1. OS_TXENTRY -2. RXENTRY (rx_thread or RX_ISR/RX_CallBack) - -If we turn on USE_RXTHREAD, then, no need for critical section. -Otherwise, we must use _enter/_exit critical to protect free_xmit_queue... - -Must be very, very cautious... - -*/ +* Calling context: +* 1. OS_TXENTRY +* 2. RXENTRY (rx_thread or RX_ISR/RX_CallBack) +* +* If we turn on USE_RXTHREAD, then, no need for critical section. +* Otherwise, we must use _enter/_exit critical to protect free_xmit_queue... +* +* Must be very, very cautious... +*/ struct xmit_frame *rtw_alloc_xmitframe (struct xmit_priv *pxmitpriv)/* _queue *pfree_xmit_queue) */ {/* -Please remember to use all the osdep_service api, -and lock/unlock or _enter/_exit critical to protect -pfree_xmit_queue -*/ +* Please remember to use all the osdep_service api, +* and lock/unlock or _enter/_exit critical to protect +* pfree_xmit_queue +*/ struct xmit_frame *pxframe =NULL ;struct list_head *plist, *phead;
Signature · 1 line
2.17.1
PATCH v3 3/3 staging: rtl8723bs: core: remove empty comment
In reply to Deborah BrouwerRemove empty comment because it provides no information.
--- drivers/staging/rtl8723bs/core/rtw_xmit.c | 2 -- 1 file changed, 2 deletions(-)
drivers/staging/rtl8723bs/core/rtw_xmit.c +0 -2
@@ -876,8 +876,6 @@ static s32 xmitframe_addmic(struct adapter *padapter, struct xmit_frame *pxmitfr *(payload+curfragnum), *(payload+curfragnum+1 ), *(payload+curfragnum+2 ), *(payload+curfragnum+3 ), *(payload+curfragnum+4), *(payload+curfragnum+5), *(payload+curfragnum+6), *(payload+curfragnum+7))); } -/* -*/ }return _SUCCESS; }
Signature · 1 line
2.17.1