2019-03-12 11:07:18

by Valdis Klētnieks

Subject: [PATCH] drivers/net/wireless/realtek/rtlwifi/usb.c - fix some non-kerneldoc comments

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

Fix comment blocks so they don't look like kerneldoc lines

Signed-off-by: Valdis Kletnieks <[email protected]>

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

2019-03-12 12:58:13

by Larry Finger

Subject: Re: [PATCH] drivers/net/wireless/realtek/rtlwifi/usb.c - fix some non-kerneldoc comments

On 3/12/19 6:05 AM, Valdis Klētnieks wrote:
> 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
>
> Fix comment blocks so they don't look like kerneldoc lines
>
> Signed-off-by: Valdis Kletnieks <[email protected]>
>
> 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.
> *

As these comments are 1 line at most, I would have changed the first and third
instance to /* <contents of line> */, and deleted the second empty comment, but
the content of this patch is OK. The subject line needs to be changed. It should
start with "rtlwifi: rtl_usb: Fix some ...".

Once this change is made in v2, then

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

Larry