staging: r8188eu: Block comments use * on subsequent lines

[PATCH] staging: r8188eu: Block comments use * on subsequent lines

Posted by Rommel Rodriguez Perez 3 years, 9 months ago

This patch modifies a comment in order for it to comply with Linux
Kernel style guidelines on comments belonging to  net/ or drivers/net/ by
fixing the missing * at the beginning of each comment line and removing
the initial almost-blank initial line from the comment block.

checkpatch output:
WARNING: Block comments use * on subsequent lines

Signed-off-by: Rommel Rodriguez Perez <alrodperez@gmail.com>
---
 drivers/staging/r8188eu/core/rtw_ap.c | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

diff --git a/drivers/staging/r8188eu/core/rtw_ap.c b/drivers/staging/r8188eu/core/rtw_ap.c
index ac6effbecf6d..5bd9dfa57cc5 100644
--- a/drivers/staging/r8188eu/core/rtw_ap.c
+++ b/drivers/staging/r8188eu/core/rtw_ap.c
@@ -654,18 +654,17 @@ void update_beacon(struct adapter *padapter, u8 ie_id, u8 *oui, u8 tx)
 		set_tx_beacon_cmd(padapter);
 }
 
-/*
-op_mode
-Set to 0 (HT pure) under the following conditions
-	- all STAs in the BSS are 20/40 MHz HT in 20/40 MHz BSS or
-	- all STAs in the BSS are 20 MHz HT in 20 MHz BSS
-Set to 1 (HT non-member protection) if there may be non-HT STAs
-	in both the primary and the secondary channel
-Set to 2 if only HT STAs are associated in BSS,
-	however and at least one 20 MHz HT STA is associated
-Set to 3 (HT mixed mode) when one or more non-HT STAs are associated
-	(currently non-GF HT station is considered as non-HT STA also)
-*/
+/* op_mode
+ * Set to 0 (HT pure) under the following conditions
+ *	- all STAs in the BSS are 20/40 MHz HT in 20/40 MHz BSS or
+ *	- all STAs in the BSS are 20 MHz HT in 20 MHz BSS
+ * Set to 1 (HT non-member protection) if there may be non-HT STAs
+ *	in both the primary and the secondary channel
+ * Set to 2 if only HT STAs are associated in BSS,
+ *	however and at least one 20 MHz HT STA is associated
+ * Set to 3 (HT mixed mode) when one or more non-HT STAs are associated
+ *	(currently non-GF HT station is considered as non-HT STA also)
+ */
 static int rtw_ht_operation_update(struct adapter *padapter)
 {
 	u16 cur_op_mode, new_op_mode;
-- 
2.30.2

Re: [PATCH] staging: r8188eu: Block comments use * on subsequent lines

Posted by Philipp Hortmann 3 years, 9 months ago

On 7/5/22 01:55, Rommel Rodriguez Perez wrote:
> This patch modifies a comment in order for it to comply with Linux
> Kernel style guidelines on comments belonging to  net/ or drivers/net/ by
> fixing the missing * at the beginning of each comment line and removing
> the initial almost-blank initial line from the comment block.
> 
> checkpatch output:
> WARNING: Block comments use * on subsequent lines
> 
> Signed-off-by: Rommel Rodriguez Perez <alrodperez@gmail.com>
> ---
>   drivers/staging/r8188eu/core/rtw_ap.c | 23 +++++++++++------------
>   1 file changed, 11 insertions(+), 12 deletions(-)
> 
> diff --git a/drivers/staging/r8188eu/core/rtw_ap.c b/drivers/staging/r8188eu/core/rtw_ap.c
> index ac6effbecf6d..5bd9dfa57cc5 100644
> --- a/drivers/staging/r8188eu/core/rtw_ap.c
> +++ b/drivers/staging/r8188eu/core/rtw_ap.c
> @@ -654,18 +654,17 @@ void update_beacon(struct adapter *padapter, u8 ie_id, u8 *oui, u8 tx)
>   		set_tx_beacon_cmd(padapter);
>   }
>   
> -/*
> -op_mode
> -Set to 0 (HT pure) under the following conditions
> -	- all STAs in the BSS are 20/40 MHz HT in 20/40 MHz BSS or
> -	- all STAs in the BSS are 20 MHz HT in 20 MHz BSS
> -Set to 1 (HT non-member protection) if there may be non-HT STAs
> -	in both the primary and the secondary channel
> -Set to 2 if only HT STAs are associated in BSS,
> -	however and at least one 20 MHz HT STA is associated
> -Set to 3 (HT mixed mode) when one or more non-HT STAs are associated
> -	(currently non-GF HT station is considered as non-HT STA also)
> -*/
> +/* op_mode
> + * Set to 0 (HT pure) under the following conditions
> + *	- all STAs in the BSS are 20/40 MHz HT in 20/40 MHz BSS or
> + *	- all STAs in the BSS are 20 MHz HT in 20 MHz BSS
> + * Set to 1 (HT non-member protection) if there may be non-HT STAs
> + *	in both the primary and the secondary channel
> + * Set to 2 if only HT STAs are associated in BSS,
> + *	however and at least one 20 MHz HT STA is associated
> + * Set to 3 (HT mixed mode) when one or more non-HT STAs are associated
> + *	(currently non-GF HT station is considered as non-HT STA also)
> + */
>   static int rtw_ht_operation_update(struct adapter *padapter)
>   {
>   	u16 cur_op_mode, new_op_mode;

Reviewed-by: Philipp Hortmann <philipp.g.hortmann@gmail.com>