Re: [PATCH v3] Staging: rtl8723bs: Remove unnecessary comments.

From: "Tobin C. Harding" <me@tobin.cc>
To: Shreeya Patel <shreeya.patel23498@gmail.com>
Cc: gregkh@linuxfoundation.org, devel@driverdev.osuosl.org,
	linux-kernel@vger.kernel.org, outreachy-kernel@googlegroups.com
Subject: Re: [PATCH v3] Staging: rtl8723bs: Remove unnecessary comments.
Date: Sun, 1 Oct 2017 09:42:05 +1100	[thread overview]
Message-ID: <20170930224205.GA29392@eros> (raw)
In-Reply-To: <1506780671-2209-1-git-send-email-shreeya.patel23498@gmail.com>

On Sat, Sep 30, 2017 at 07:41:11PM +0530, Shreeya Patel wrote:
> Remove unnecessary comments which are there
> to explain why call to memset is in comments. Both of the
> comments are not needed as they are not very useful.
> 
> 
> Signed-off-by: Shreeya Patel <shreeya.patel23498@gmail.com>
> ---
> Changes in v2:
>   -Remove some more unnecessary comments and make the
>    commit message more appropriate.
> 
> Changes in v3:
>   -Make the commit message in imperative form.

Well done. You forgot the period on the commit subject. Here is a blog post you might like (it is
not kernel specific but useful still IMO).

Good luck,
Tobin.

>  drivers/staging/rtl8723bs/core/rtw_mlme.c     | 3 ---
>  drivers/staging/rtl8723bs/core/rtw_mlme_ext.c | 3 ---
>  drivers/staging/rtl8723bs/core/rtw_pwrctrl.c  | 2 --
>  drivers/staging/rtl8723bs/core/rtw_recv.c     | 4 ----
>  drivers/staging/rtl8723bs/core/rtw_xmit.c     | 3 ---
>  5 files changed, 15 deletions(-)
> 
> diff --git a/drivers/staging/rtl8723bs/core/rtw_mlme.c b/drivers/staging/rtl8723bs/core/rtw_mlme.c
> index 6b77820..5b583f7 100644
> --- a/drivers/staging/rtl8723bs/core/rtw_mlme.c
> +++ b/drivers/staging/rtl8723bs/core/rtw_mlme.c
> @@ -28,9 +28,6 @@ sint	_rtw_init_mlme_priv(struct adapter *padapter)
>  	struct mlme_priv 	*pmlmepriv = &padapter->mlmepriv;
>  	sint	res = _SUCCESS;
>  
> -	/*  We don't need to memset padapter->XXX to zero, because adapter is allocated by vzalloc(). */
> -	/* memset((u8 *)pmlmepriv, 0, sizeof(struct mlme_priv)); */
> -
>  	pmlmepriv->nic_hdl = (u8 *)padapter;
>  
>  	pmlmepriv->pscanned = NULL;
> diff --git a/drivers/staging/rtl8723bs/core/rtw_mlme_ext.c b/drivers/staging/rtl8723bs/core/rtw_mlme_ext.c
> index b6d137f..ca35c1c 100644
> --- a/drivers/staging/rtl8723bs/core/rtw_mlme_ext.c
> +++ b/drivers/staging/rtl8723bs/core/rtw_mlme_ext.c
> @@ -474,9 +474,6 @@ int	init_mlme_ext_priv(struct adapter *padapter)
>  	struct mlme_priv *pmlmepriv = &(padapter->mlmepriv);
>  	struct mlme_ext_info *pmlmeinfo = &(pmlmeext->mlmext_info);
>  
> -	/*  We don't need to memset padapter->XXX to zero, because adapter is allocated by vzalloc(). */
> -	/* memset((u8 *)pmlmeext, 0, sizeof(struct mlme_ext_priv)); */
> -
>  	pmlmeext->padapter = padapter;
>  
>  	/* fill_fwpriv(padapter, &(pmlmeext->fwpriv)); */
> diff --git a/drivers/staging/rtl8723bs/core/rtw_pwrctrl.c b/drivers/staging/rtl8723bs/core/rtw_pwrctrl.c
> index aabdaaf..820a061 100644
> --- a/drivers/staging/rtl8723bs/core/rtw_pwrctrl.c
> +++ b/drivers/staging/rtl8723bs/core/rtw_pwrctrl.c
> @@ -1193,8 +1193,6 @@ void rtw_init_pwrctrl_priv(struct adapter *padapter)
>  
>  void rtw_free_pwrctrl_priv(struct adapter *adapter)
>  {
> -	/* memset((unsigned char *)pwrctrlpriv, 0, sizeof(struct pwrctrl_priv)); */
> -
>  #ifdef CONFIG_PNO_SUPPORT
>  	if (pwrctrlpriv->pnlo_info != NULL)
>  		printk("****** pnlo_info memory leak********\n");
> diff --git a/drivers/staging/rtl8723bs/core/rtw_recv.c b/drivers/staging/rtl8723bs/core/rtw_recv.c
> index 68a6303..73e6e41 100644
> --- a/drivers/staging/rtl8723bs/core/rtw_recv.c
> +++ b/drivers/staging/rtl8723bs/core/rtw_recv.c
> @@ -46,9 +46,6 @@ sint _rtw_init_recv_priv(struct recv_priv *precvpriv, struct adapter *padapter)
>  	union recv_frame *precvframe;
>  	sint	res = _SUCCESS;
>  
> -	/*  We don't need to memset padapter->XXX to zero, because adapter is allocated by vzalloc(). */
> -	/* memset((unsigned char *)precvpriv, 0, sizeof (struct  recv_priv)); */
> -
>  	spin_lock_init(&precvpriv->lock);
>  
>  	_rtw_init_queue(&precvpriv->free_recv_queue);
> @@ -65,7 +62,6 @@ sint _rtw_init_recv_priv(struct recv_priv *precvpriv, struct adapter *padapter)
>  		res = _FAIL;
>  		goto exit;
>  	}
> -	/* memset(precvpriv->pallocated_frame_buf, 0, NR_RECVFRAME * sizeof(union recv_frame) + RXFRAME_ALIGN_SZ); */
>  
>  	precvpriv->precv_frame_buf = (u8 *)N_BYTE_ALIGMENT((SIZE_PTR)(precvpriv->pallocated_frame_buf), RXFRAME_ALIGN_SZ);
>  	/* precvpriv->precv_frame_buf = precvpriv->pallocated_frame_buf + RXFRAME_ALIGN_SZ - */
> diff --git a/drivers/staging/rtl8723bs/core/rtw_xmit.c b/drivers/staging/rtl8723bs/core/rtw_xmit.c
> index 022f654..8cd05f8 100644
> --- a/drivers/staging/rtl8723bs/core/rtw_xmit.c
> +++ b/drivers/staging/rtl8723bs/core/rtw_xmit.c
> @@ -51,9 +51,6 @@ s32	_rtw_init_xmit_priv(struct xmit_priv *pxmitpriv, struct adapter *padapter)
>  	struct xmit_frame *pxframe;
>  	sint	res = _SUCCESS;
>  
> -	/*  We don't need to memset padapter->XXX to zero, because adapter is allocated by vzalloc(). */
> -	/* memset((unsigned char *)pxmitpriv, 0, sizeof(struct xmit_priv)); */
> -
>  	spin_lock_init(&pxmitpriv->lock);
>  	spin_lock_init(&pxmitpriv->lock_sctx);
>  	sema_init(&pxmitpriv->xmit_sema, 0);
> -- 
> 2.7.4
> 
> _______________________________________________
> devel mailing list
> devel@linuxdriverproject.org
> http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel