2022-06-28 09:47:32

by Mauro Carvalho Chehab

Subject: [PATCH 02/22] net: mac80211: add a missing comma at kernel-doc markup

The lack of the comma makes it to not parse the function parameter:
include/net/mac80211.h:6250: warning: Function parameter or member 'vif' not described in 'ieee80211_channel_switch_disconnect'

Fix it.

Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---

To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
See [PATCH 00/22] at: https://lore.kernel.org/all/[email protected]/

include/net/mac80211.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/net/mac80211.h b/include/net/mac80211.h
index 27f24ac0426d..c0557142343f 100644
--- a/include/net/mac80211.h
+++ b/include/net/mac80211.h
@@ -6238,7 +6238,7 @@ void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);

/**
* ieee80211_channel_switch_disconnect - disconnect due to channel switch error
- * @vif &struct ieee80211_vif pointer from the add_interface callback.
+ * @vif: &struct ieee80211_vif pointer from the add_interface callback.
* @block_tx: if %true, do not send deauth frame.
*
* Instruct mac80211 to disconnect due to a channel switch error. The channel
--
2.36.1

2022-06-28 17:11:35

by Jeff Johnson

Subject: Re: [PATCH 02/22] net: mac80211: add a missing comma at kernel-doc markup

On 6/28/2022 2:46 AM, Mauro Carvalho Chehab wrote:
> The lack of the comma makes it to not parse the function parameter:

nit: s/comma/colon/

> include/net/mac80211.h:6250: warning: Function parameter or member 'vif' not described in 'ieee80211_channel_switch_disconnect'
>
> Fix it.
>
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>
> ---
>
> To avoid mailbombing on a large number of people, only mailing lists were C/C on the cover.
> See [PATCH 00/22] at: https://lore.kernel.org/all/[email protected]/
>
> include/net/mac80211.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/net/mac80211.h b/include/net/mac80211.h
> index 27f24ac0426d..c0557142343f 100644
> --- a/include/net/mac80211.h
> +++ b/include/net/mac80211.h
> @@ -6238,7 +6238,7 @@ void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
>
> /**
> * ieee80211_channel_switch_disconnect - disconnect due to channel switch error
> - * @vif &struct ieee80211_vif pointer from the add_interface callback.
> + * @vif: &struct ieee80211_vif pointer from the add_interface callback.
> * @block_tx: if %true, do not send deauth frame.
> *
> * Instruct mac80211 to disconnect due to a channel switch error. The channel