linux-kernel - Re: [PATCH] staging: rtl8723bs: fix block comment style to match kernel coding guidline

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] [day] [month] [year] [list]

Message-ID: <2025100823-outshine-evaluate-3be1@gregkh>
Date: Wed, 8 Oct 2025 12:38:02 +0200
From: Greg KH <gregkh@...uxfoundation.org>
To: Ankit@....codeaurora.org, Bhalani@....codeaurora.org,
	er.ankitbhalani@...il.com
Cc: linux-staging@...ts.linux.dev, linux-kernel@...r.kernel.org,
	abrahamadekunle50@...il.com, julia.lawall@...ia.fr,
	viro@...iv.linux.org.uk, dan.carpenter@...aro.org,
	zhaochenguang@...inos.cn, straube.linux@...il.com, mingo@...nel.org,
	tglx@...utronix.de, philipp.g.hortmann@...il.com,
	vivek.balachandhar@...il.com, rodrigo.gobbi.7@...il.com,
	hansg@...nel.org, nathan@...nel.org
Subject: Re: [PATCH] staging: rtl8723bs: fix block comment style to match
 kernel coding guidline

On Wed, Oct 01, 2025 at 07:14:33PM +0530, Ankit@....codeaurora.org wrote:
> From: Ankit Bhalani <er.ankitbhalani@...il.com>
> 
> 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 <er.ankitbhalani@...il.com>
> ---
>  .../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(-)
> 
> diff --git a/drivers/staging/rtl8723bs/core/rtw_ieee80211.c b/drivers/staging/rtl8723bs/core/rtw_ieee80211.c
> index 53d4c113b19c..c31e64600c0a 100644
> --- a/drivers/staging/rtl8723bs/core/rtw_ieee80211.c
> +++ b/drivers/staging/rtl8723bs/core/rtw_ieee80211.c
> @@ -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)

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.

>  /*
> -* 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