linux-kernel - Re: [PATCH 4/6] staging: r8188eu: format block comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <563ddd2d-b8b2-dde6-a0de-c7bbebcc834e@lwfinger.net>
Date:   Sat, 2 Apr 2022 11:37:27 -0500
From:   Larry Finger <Larry.Finger@...inger.net>
To:     Rebecca Mckeever <remckee0@...il.com>, outreachy@...ts.linux.dev
Cc:     Phillip Potter <phil@...lpotter.co.uk>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        linux-staging@...ts.linux.dev, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 4/6] staging: r8188eu: format block comments

On 4/2/22 03:50, Rebecca Mckeever wrote:
> Add ' * ' or ' ' to beginning of block comment lines
> to conform to Linux kernel coding style.
> 
> Reported by checkpatch:
> 
> WARNING: Block comments use * on subsequent lines
> 
> Signed-off-by: Rebecca Mckeever <remckee0@...il.com>
> ---
>   drivers/staging/r8188eu/core/rtw_cmd.c | 29 +++++++++++++-------------
>   1 file changed, 14 insertions(+), 15 deletions(-)
> 
> diff --git a/drivers/staging/r8188eu/core/rtw_cmd.c b/drivers/staging/r8188eu/core/rtw_cmd.c
> index 2e135bbd836a..0c659b40aa1c 100644
> --- a/drivers/staging/r8188eu/core/rtw_cmd.c
> +++ b/drivers/staging/r8188eu/core/rtw_cmd.c
> @@ -12,9 +12,9 @@
>   #include "../include/rtl8188e_dm.h"
>   
>   /*
> -Caller and the rtw_cmd_thread can protect cmd_q by spin_lock.
> -No irqsave is necessary.
> -*/
> + * Caller and the rtw_cmd_thread can protect cmd_q by spin_lock.
> + * No irqsave is necessary.
> + */
>   
>   static int _rtw_init_cmd_priv(struct cmd_priv *pcmdpriv)
>   {
> @@ -97,14 +97,13 @@ static void _rtw_free_cmd_priv(struct cmd_priv *pcmdpriv)
>   }
>   
>   /*
> -Calling Context:
> -
> -rtw_enqueue_cmd can only be called between kernel thread,
> -since only spin_lock is used.
> -
> -ISR/Call-Back functions can't call this sub-function.
> -
> -*/
> + * Calling Context:
> + *
> + * rtw_enqueue_cmd can only be called between kernel thread,
> + * since only spin_lock is used.
> + *
> + * ISR/Call-Back functions can't call this sub-function.
> + */
>   
>   static int _rtw_enqueue_cmd(struct __queue *queue, struct cmd_obj *obj)
>   {
> @@ -319,10 +318,10 @@ int rtw_cmd_thread(void *context)
>   }
>   
>   /*
> -rtw_sitesurvey_cmd(~)
> -	### NOTE:#### (!!!!)
> -	MUST TAKE CARE THAT BEFORE CALLING THIS FUNC, YOU SHOULD HAVE LOCKED pmlmepriv->lock
> -*/
> + * rtw_sitesurvey_cmd(~)
> + *	### NOTE:#### (!!!!)
> + *	MUST TAKE CARE THAT BEFORE CALLING THIS FUNC, YOU SHOULD HAVE LOCKED pmlmepriv->lock
> + */
>   u8 rtw_sitesurvey_cmd(struct adapter  *padapter, struct ndis_802_11_ssid *ssid, int ssid_num,
>   	struct rtw_ieee80211_channel *ch, int ch_num)
>   {

These changes are OK, but the rules in drivers/net/wireless specify using

/* abcd

rather than

/*
  * abcd

Thus, if and when this driver is accepted into the drivers/net/wireless tree, 
another change will be needed. I suggest doing that now.

Larry