| Message ID | 5924.1565217560@turing-police (mailing list archive) |
|---|---|
| State | Changes Requested |
| Delegated to: | Kalle Valo |
| Headers | show |
| Series | Fix non-kerneldoc comment in realtek/rtlwifi/usb.c | expand |
On 8/7/19 5:39 PM, Valdis Klētnieks wrote:
When this driver was originally entered, a line with "/*" was flagged by
checkpatch.pl. In fact, when I make your change, I get
WARNING: networking block comments don't use an empty /* line, use /* Comment...
#243: FILE: drivers/net/wireless/realtek/rtlwifi/usb.c:243:
+/*
+ *
To avoid a loop of "fixing" compiler/checkpatch warnings, you need to put the
first real line of the comment on the line of the "/*". For the first of your
patches, that results in
diff --git a/drivers/net/wireless/realtek/rtlwifi/usb.c
b/drivers/net/wireless/realtek/rtlwifi/usb.c
index 34d68dbf4b4c..f89ceac25eff 100644
--- a/drivers/net/wireless/realtek/rtlwifi/usb.c
+++ b/drivers/net/wireless/realtek/rtlwifi/usb.c
@@ -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)
Because you merely shift the warning to a different tool,
NACK.
Larry
On 8/7/19 3:39 PM, Valdis Klētnieks wrote: > 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 > > Change the comment so gcc doesn't think it's a kerneldoc comment block s:gcc:scripts/kernel-doc/ and as Larry pointed out, networking comment style is "different" from the rest of the kernel. :( > > Signed-off-by: Valdis Kletnieks <valdis.kletnieks@vt.edu> > > diff --git a/drivers/net/wireless/realtek/rtlwifi/usb.c b/drivers/net/wireless/realtek/rtlwifi/usb.c > index e24fda5e9087..9478cc0d4f8b 100644 > --- a/drivers/net/wireless/realtek/rtlwifi/usb.c > +++ b/drivers/net/wireless/realtek/rtlwifi/usb.c > @@ -239,7 +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. > */ > @@ -756,7 +756,7 @@ static int rtl_usb_start(struct ieee80211_hw *hw) > return err; > } > > -/** > +/* > * > * > */ > @@ -786,7 +786,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. > * >
diff --git a/drivers/net/wireless/realtek/rtlwifi/usb.c b/drivers/net/wireless/realtek/rtlwifi/usb.c index e24fda5e9087..9478cc0d4f8b 100644 --- a/drivers/net/wireless/realtek/rtlwifi/usb.c +++ b/drivers/net/wireless/realtek/rtlwifi/usb.c @@ -239,7 +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. */ @@ -756,7 +756,7 @@ static int rtl_usb_start(struct ieee80211_hw *hw) return err; } -/** +/* * * */ @@ -786,7 +786,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. *
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 Change the comment so gcc doesn't think it's a kerneldoc comment block Signed-off-by: Valdis Kletnieks <valdis.kletnieks@vt.edu>