2019-08-08 02:08:36

by Larry Finger

[permalink] [raw]
Subject: Re: [PATCH v2] Fix non-kerneldoc comment in realtek/rtlwifi/usb.c

On 8/7/19 8:51 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
>
> Clean up the comment format.
>
> Signed-off-by: Valdis Kletnieks <[email protected]>
>
> ---
> Changes since v1: Larry Finger pointed out the patch wasn't checkpatch-clean.
>
> diff --git a/drivers/net/wireless/realtek/rtlwifi/usb.c b/drivers/net/wireless/realtek/rtlwifi/usb.c
> index 34d68dbf4b4c..4b59f3b46b28 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)
> {
> @@ -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);

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

Larry



2019-08-08 07:11:45

by Kalle Valo

[permalink] [raw]
Subject: Re: [PATCH v2] Fix non-kerneldoc comment in realtek/rtlwifi/usb.c

Larry Finger <[email protected]> writes:

> On 8/7/19 8:51 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
>>
>> Clean up the comment format.
>>
>> Signed-off-by: Valdis Kletnieks <[email protected]>
>>
>> ---
>> Changes since v1: Larry Finger pointed out the patch wasn't checkpatch-clean.
>>
>> diff --git a/drivers/net/wireless/realtek/rtlwifi/usb.c b/drivers/net/wireless/realtek/rtlwifi/usb.c
>> index 34d68dbf4b4c..4b59f3b46b28 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)
>> {
>> @@ -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);
>
> I missed that the subject line should be "rtwifi: Fix ....". Otherwise it is OK.

I can fix the subject during commit.

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