diff mbox series

[05/41] rtl8192cu: trx: Demote clear abuse of kernel-doc format

Message ID 20201102112410.1049272-6-lee.jones@linaro.org
State New
Headers show
Series [01/41] wil6210: wmi: Correct misnamed function parameter 'ptr_' | expand

Commit Message

Lee Jones Nov. 2, 2020, 11:23 a.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c:455: warning: Function parameter or member 'txdesc' not described in '_rtl_tx_desc_checksum'

Cc: Ping-Ke Shih <pkshih@realtek.com>
Cc: Kalle Valo <kvalo@codeaurora.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Larry Finger <Larry.Finger@lwfinger.net>
Cc: linux-wireless@vger.kernel.org
Cc: netdev@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Larry Finger Nov. 2, 2020, 4:50 p.m. UTC | #1
On 11/2/20 5:23 AM, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):

> 

>   drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c:455: warning: Function parameter or member 'txdesc' not described in '_rtl_tx_desc_checksum'

> 

> Cc: Ping-Ke Shih <pkshih@realtek.com>

> Cc: Kalle Valo <kvalo@codeaurora.org>

> Cc: "David S. Miller" <davem@davemloft.net>

> Cc: Jakub Kicinski <kuba@kernel.org>

> Cc: Larry Finger <Larry.Finger@lwfinger.net>

> Cc: linux-wireless@vger.kernel.org

> Cc: netdev@vger.kernel.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>   drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c | 2 +-

>   1 file changed, 1 insertion(+), 1 deletion(-)

> 

> diff --git a/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c b/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c

> index 1ad0cf37f60bb..87f959d5d861d 100644

> --- a/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c

> +++ b/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c

> @@ -448,7 +448,7 @@ static void _rtl_fill_usb_tx_desc(__le32 *txdesc)

>   	set_tx_desc_first_seg(txdesc, 1);

>   }

>   

> -/**

> +/*

>    *	For HW recovery information

>    */

>   static void _rtl_tx_desc_checksum(__le32 *txdesc)

> 


Did you check this patch with checkpatch.pl? I think you substituted one warning 
for another. The wireless-testing trees previously did not accept a bare "/*", 
which is why "/**" was present.

This particular instance should have
/* For HW recovery information */
as the comment.

Larry
Lee Jones Nov. 3, 2020, 8:51 a.m. UTC | #2
On Mon, 02 Nov 2020, Larry Finger wrote:

> On 11/2/20 5:23 AM, Lee Jones wrote:

> > Fixes the following W=1 kernel build warning(s):

> > 

> >   drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c:455: warning: Function parameter or member 'txdesc' not described in '_rtl_tx_desc_checksum'

> > 

> > Cc: Ping-Ke Shih <pkshih@realtek.com>

> > Cc: Kalle Valo <kvalo@codeaurora.org>

> > Cc: "David S. Miller" <davem@davemloft.net>

> > Cc: Jakub Kicinski <kuba@kernel.org>

> > Cc: Larry Finger <Larry.Finger@lwfinger.net>

> > Cc: linux-wireless@vger.kernel.org

> > Cc: netdev@vger.kernel.org

> > Signed-off-by: Lee Jones <lee.jones@linaro.org>

> > ---

> >   drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c | 2 +-

> >   1 file changed, 1 insertion(+), 1 deletion(-)

> > 

> > diff --git a/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c b/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c

> > index 1ad0cf37f60bb..87f959d5d861d 100644

> > --- a/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c

> > +++ b/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c

> > @@ -448,7 +448,7 @@ static void _rtl_fill_usb_tx_desc(__le32 *txdesc)

> >   	set_tx_desc_first_seg(txdesc, 1);

> >   }

> > -/**

> > +/*

> >    *	For HW recovery information

> >    */

> >   static void _rtl_tx_desc_checksum(__le32 *txdesc)

> > 

> 

> Did you check this patch with checkpatch.pl?


Yes.

> I think you substituted one

> warning for another. The wireless-testing trees previously did not accept a

> bare "/*", which is why "/**" was present.


I don't see a problem.

$ git format-patch -n1 --stdout 8cd8b929e0458 | ./scripts/checkpatch.pl 
total: 0 errors, 0 warnings, 0 checks, 8 lines checked

"[PATCH 1/1] rtl8192cu: trx: Demote clear abuse of kernel-doc format"
  has no obvious style problems and is ready for submission.

> This particular instance should have

> /* For HW recovery information */

> as the comment.


-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
diff mbox series

Patch

diff --git a/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c b/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c
index 1ad0cf37f60bb..87f959d5d861d 100644
--- a/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c
+++ b/drivers/net/wireless/realtek/rtlwifi/rtl8192cu/trx.c
@@ -448,7 +448,7 @@  static void _rtl_fill_usb_tx_desc(__le32 *txdesc)
 	set_tx_desc_first_seg(txdesc, 1);
 }
 
-/**
+/*
  *	For HW recovery information
  */
 static void _rtl_tx_desc_checksum(__le32 *txdesc)