Skip to contentSkip to conversation

Fix non-kerneldoc comment in realtek/rtlwifi/usb.c

PATCH In review Valdis Klētnieks 3 participants 5 messages Aug 8, 2019 – Sep 3, 2019

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 Fix non-kerneldoc comment in realtek/rtlwifi/usb.c

Fix spurious warning message when building with W=1:

CC [M] drivers/net/wireless/realtek/rtlwifi/usb.o

drivers/net/wireless/realtek/rtlwifi/usb.c:243: warning: Cannot understand  * on line 243 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:760: warning: Cannot understand  * on line 760 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:790: warning: Cannot understand  * on line 790 - I thought it was a doc line

Clean up the comment format.

---
Changes since v1: Larry Finger pointed out the patch wasn't checkpatch-clean.

drivers/net/wireless/realtek/rtlwifi/usb.c +2 -14
index 34d68dbf4b4c..4b59f3b46b28 100644
@@ -239,10 +239,7 @@ static void _rtl_usb_io_handler_release(struct ieee80211_hw *hw)
 	mutex_destroy(&rtlpriv->io.bb_mutex);
 }
 
-/**
- *
- *	Default aggregation handler. Do nothing and just return the oldest skb.
- */
+/*	Default aggregation handler. Do nothing and just return the oldest skb.  */
 static struct sk_buff *_none_usb_tx_aggregate_hdl(struct ieee80211_hw *hw,
 						  struct sk_buff_head *list)
 {
@@ -756,11 +753,6 @@ static int rtl_usb_start(struct ieee80211_hw *hw)
 	return err;
 }
 
-/**
- *
- *
- */
-
 /*=======================  tx =========================================*/
 static void rtl_usb_cleanup(struct ieee80211_hw *hw)
 {
@@ -786,11 +778,7 @@ static void rtl_usb_cleanup(struct ieee80211_hw *hw)
 	usb_kill_anchored_urbs(&rtlusb->tx_submitted);
 }
 
-/**
- *
- * We may add some struct into struct rtl_usb later. Do deinit here.
- *
- */
+/* We may add some struct into struct rtl_usb later. Do deinit here.  */
 static void rtl_usb_deinit(struct ieee80211_hw *hw)
 {
 	rtl_usb_cleanup(hw);
#1 lore raw
Quoted 45 lines · Valdis Klētnieks

Fix spurious warning message when building with W=1:

CC [M] drivers/net/wireless/realtek/rtlwifi/usb.o

drivers/net/wireless/realtek/rtlwifi/usb.c:243: warning: Cannot understand  * on line 243 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:760: warning: Cannot understand  * on line 760 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:790: warning: Cannot understand  * on line 790 - I thought it was a doc line

Clean up the comment format.

---
Changes since v1: Larry Finger pointed out the patch wasn't checkpatch-clean.

drivers/net/wireless/realtek/rtlwifi/usb.c +1 -9
index 34d68dbf4b4c..4b59f3b46b28 100644
@@ -239,10 +239,7 @@ static void _rtl_usb_io_handler_release(struct ieee80211_hw *hw)
  	mutex_destroy(&rtlpriv->io.bb_mutex);
  }
 
-/**
- *
- *	Default aggregation handler. Do nothing and just return the oldest skb.
- */
+/*	Default aggregation handler. Do nothing and just return the oldest skb.  */
  static struct sk_buff *_none_usb_tx_aggregate_hdl(struct ieee80211_hw *hw,
  						  struct sk_buff_head *list)
  {
@@ -756,11 +753,6 @@ static int rtl_usb_start(struct ieee80211_hw *hw)
  	return err;
  }
 
-/**
- *
- *
- */
-
  /*=======================  tx =========================================*/
  static void rtl_usb_cleanup(struct ieee80211_hw *hw)
  {
@@ -786,11 +778,7 @@ static void rtl_usb_cleanup(struct ieee80211_hw *hw)
  	usb_kill_anchored_urbs(&rtlusb->tx_submitted);
  }

drivers/net/wireless/realtek/rtlwifi/usb.c static void rtl_usb_cleanup(struct ieee80211_hw *hw) · line 784

Quoted 10 lines
drivers/net/wireless/realtek/rtlwifi/usb.c +1 -5
 
-/**
- *
- * We may add some struct into struct rtl_usb later. Do deinit here.
- *
- */
+/* We may add some struct into struct rtl_usb later. Do deinit here.  */
  static void rtl_usb_deinit(struct ieee80211_hw *hw)
  {
  	rtl_usb_cleanup(hw);

I missed that the subject line should be "rtwifi: Fix ....". Otherwise it is OK.

Larry

#2 lore raw
Quoted 47 lines · Larry Finger
Quoted 46 lines · Valdis Klētnieks

Fix spurious warning message when building with W=1:

CC [M] drivers/net/wireless/realtek/rtlwifi/usb.o

drivers/net/wireless/realtek/rtlwifi/usb.c:243: warning: Cannot understand  * on line 243 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:760: warning: Cannot understand  * on line 760 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:790: warning: Cannot understand  * on line 790 - I thought it was a doc line

Clean up the comment format.

---
Changes since v1: Larry Finger pointed out the patch wasn't checkpatch-clean.

drivers/net/wireless/realtek/rtlwifi/usb.c +1 -9
index 34d68dbf4b4c..4b59f3b46b28 100644
@@ -239,10 +239,7 @@ static void _rtl_usb_io_handler_release(struct ieee80211_hw *hw)
  	mutex_destroy(&rtlpriv->io.bb_mutex);
  }
  -/**
- *
- *	Default aggregation handler. Do nothing and just return the oldest skb.
- */
+/*	Default aggregation handler. Do nothing and just return the oldest skb.  */
  static struct sk_buff *_none_usb_tx_aggregate_hdl(struct ieee80211_hw *hw,
  						  struct sk_buff_head *list)
  {
@@ -756,11 +753,6 @@ static int rtl_usb_start(struct ieee80211_hw *hw)
  	return err;
  }
  -/**
- *
- *
- */
-
  /*=======================  tx =========================================*/
  static void rtl_usb_cleanup(struct ieee80211_hw *hw)
  {
@@ -786,11 +778,7 @@ static void rtl_usb_cleanup(struct ieee80211_hw *hw)
  	usb_kill_anchored_urbs(&rtlusb->tx_submitted);
  }
  -/**
- *
- * We may add some struct into struct rtl_usb later. Do deinit here.
Quoted 8 lines

drivers/net/wireless/realtek/rtlwifi/usb.c static void rtl_usb_cleanup(struct ieee80211_hw *hw) · line 784

Quoted 6 lines
drivers/net/wireless/realtek/rtlwifi/usb.c +1 -2
- *
- */
+/* We may add some struct into struct rtl_usb later. Do deinit here.  */
  static void rtl_usb_deinit(struct ieee80211_hw *hw)
  {
  	rtl_usb_cleanup(hw);

I missed that the subject line should be "rtwifi: Fix ....". Otherwise it is OK.

I can fix the subject during commit.

Signature · 1 line
https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#3 lore raw
Quoted 58 lines · Kalle Valo
Quoted 47 lines · Larry Finger
Quoted 46 lines · Valdis Klētnieks

Fix spurious warning message when building with W=1:

CC [M] drivers/net/wireless/realtek/rtlwifi/usb.o

drivers/net/wireless/realtek/rtlwifi/usb.c:243: warning: Cannot understand  * on line 243 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:760: warning: Cannot understand  * on line 760 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:790: warning: Cannot understand  * on line 790 - I thought it was a doc line

Clean up the comment format.

---
Changes since v1: Larry Finger pointed out the patch wasn't checkpatch-clean.

drivers/net/wireless/realtek/rtlwifi/usb.c +1 -9
index 34d68dbf4b4c..4b59f3b46b28 100644
@@ -239,10 +239,7 @@ static void _rtl_usb_io_handler_release(struct ieee80211_hw *hw)
   	mutex_destroy(&rtlpriv->io.bb_mutex);
   }
   -/**
- *
- *	Default aggregation handler. Do nothing and just return the oldest skb.
- */
+/*	Default aggregation handler. Do nothing and just return the oldest skb.  */
   static struct sk_buff *_none_usb_tx_aggregate_hdl(struct ieee80211_hw *hw,
   						  struct sk_buff_head *list)
   {
@@ -756,11 +753,6 @@ static int rtl_usb_start(struct ieee80211_hw *hw)
   	return err;
   }
   -/**
- *
- *
- */
-
   /*=======================  tx =========================================*/
   static void rtl_usb_cleanup(struct ieee80211_hw *hw)
   {
@@ -786,11 +778,7 @@ static void rtl_usb_cleanup(struct ieee80211_hw *hw)
   	usb_kill_anchored_urbs(&rtlusb->tx_submitted);
   }
   -/**
- *
- * We may add some struct into struct rtl_usb later. Do deinit here.
Quoted 8 lines

drivers/net/wireless/realtek/rtlwifi/usb.c static void rtl_usb_cleanup(struct ieee80211_hw *hw) · line 784

Quoted 6 lines
drivers/net/wireless/realtek/rtlwifi/usb.c +1 -2
- *
- */
+/* We may add some struct into struct rtl_usb later. Do deinit here.  */
   static void rtl_usb_deinit(struct ieee80211_hw *hw)
   {
   	rtl_usb_cleanup(hw);

I missed that the subject line should be "rtwifi: Fix ....". Otherwise it is OK.

Quoted 1 line

I can fix the subject during commit.

OK. Acked-by: Larry Finger<[email protected]>

Thanks,

Larry

#4 lore raw

Re: [PATCH v2] rtlwifi: fix non-kerneldoc comment in usb.c

In reply to Valdis Klētnieks
Quoted 10 lines · Valdis

Fix spurious warning message when building with W=1:

CC [M] drivers/net/wireless/realtek/rtlwifi/usb.o

drivers/net/wireless/realtek/rtlwifi/usb.c:243: warning: Cannot understand  * on line 243 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:760: warning: Cannot understand  * on line 760 - I thought it was a doc line
drivers/net/wireless/realtek/rtlwifi/usb.c:790: warning: Cannot understand  * on line 790 - I thought it was a doc line

Clean up the comment format.

Patch applied to wireless-drivers-next.git, thanks.

b6326fc025aa rtlwifi: fix non-kerneldoc comment in usb.c

Signature · 3 lines
https://patchwork.kernel.org/patch/11083073/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches