* [PATCH 01/22] net: cfg80211: fix kernel-doc warnings all over the file
2022-06-28 9:46 [PATCH 00/22] Fix kernel-doc warnings at linux-next Mauro Carvalho Chehab
@ 2022-06-28 9:46 ` Mauro Carvalho Chehab
2022-06-28 9:46 ` [PATCH 02/22] net: mac80211: add a missing comma at kernel-doc markup Mauro Carvalho Chehab
` (2 subsequent siblings)
3 siblings, 0 replies; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2022-06-28 9:46 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, David S. Miller, Jonathan Corbet,
Mauro Carvalho Chehab, Eric Dumazet, Jakub Kicinski,
Johannes Berg, Paolo Abeni, linux-kernel, linux-wireless, netdev
There are currently 17 kernel-doc warnings on this file:
include/net/cfg80211.h:391: warning: Function parameter or member 'bw' not described in 'ieee80211_eht_mcs_nss_supp'
include/net/cfg80211.h:437: warning: Function parameter or member 'eht_cap' not described in 'ieee80211_sband_iftype_data'
include/net/cfg80211.h:507: warning: Function parameter or member 's1g' not described in 'ieee80211_sta_s1g_cap'
include/net/cfg80211.h:1390: warning: Function parameter or member 'counter_offset_beacon' not described in 'cfg80211_color_change_settings'
include/net/cfg80211.h:1390: warning: Function parameter or member 'counter_offset_presp' not described in 'cfg80211_color_change_settings'
include/net/cfg80211.h:1430: warning: Enum value 'STATION_PARAM_APPLY_STA_TXPOWER' not described in enum 'station_parameters_apply_mask'
include/net/cfg80211.h:2195: warning: Function parameter or member 'dot11MeshConnectedToAuthServer' not described in 'mesh_config'
include/net/cfg80211.h:2341: warning: Function parameter or member 'short_ssid' not described in 'cfg80211_scan_6ghz_params'
include/net/cfg80211.h:3328: warning: Function parameter or member 'kck_len' not described in 'cfg80211_gtk_rekey_data'
include/net/cfg80211.h:3698: warning: Function parameter or member 'ftm' not described in 'cfg80211_pmsr_result'
include/net/cfg80211.h:3828: warning: Function parameter or member 'global_mcast_stypes' not described in 'mgmt_frame_regs'
include/net/cfg80211.h:4977: warning: Function parameter or member 'ftm' not described in 'cfg80211_pmsr_capabilities'
include/net/cfg80211.h:5742: warning: Function parameter or member 'u' not described in 'wireless_dev'
include/net/cfg80211.h:5742: warning: Function parameter or member 'links' not described in 'wireless_dev'
include/net/cfg80211.h:5742: warning: Function parameter or member 'valid_links' not described in 'wireless_dev'
include/net/cfg80211.h:6076: warning: Function parameter or member 'is_amsdu' not described in 'ieee80211_data_to_8023_exthdr'
include/net/cfg80211.h:6949: warning: Function parameter or member 'sig_dbm' not described in 'cfg80211_notify_new_peer_candidate'
Address them, in order to build a better documentation from this
header.
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---
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/cover.1656409369.git.mchehab@kernel.org/
include/net/cfg80211.h | 28 +++++++++++++++++++++-------
1 file changed, 21 insertions(+), 7 deletions(-)
diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h
index 996782c44838..c7e641071eff 100644
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -374,6 +374,7 @@ struct ieee80211_sta_he_cap {
* and NSS Set field"
*
* @only_20mhz: MCS/NSS support for 20 MHz-only STA.
+ * @bw: MCS/NSS support for 80, 160 and 320 MHz
* @bw._80: MCS/NSS support for BW <= 80 MHz
* @bw._160: MCS/NSS support for BW = 160 MHz
* @bw._320: MCS/NSS support for BW = 320 MHz
@@ -420,6 +421,7 @@ struct ieee80211_sta_eht_cap {
* @he_cap: holds the HE capabilities
* @he_6ghz_capa: HE 6 GHz capabilities, must be filled in for a
* 6 GHz band channel (and 0 may be valid value).
+ * @eht_cap: STA's EHT capabilities
* @vendor_elems: vendor element(s) to advertise
* @vendor_elems.data: vendor element(s) data
* @vendor_elems.len: vendor element(s) length
@@ -495,7 +497,7 @@ struct ieee80211_edmg {
* This structure describes most essential parameters needed
* to describe 802.11ah S1G capabilities for a STA.
*
- * @s1g_supported: is STA an S1G STA
+ * @s1g: is STA an S1G STA
* @cap: S1G capabilities information
* @nss_mcs: Supported NSS MCS set
*/
@@ -1373,8 +1375,8 @@ struct cfg80211_csa_settings {
* Used for bss color change
*
* @beacon_color_change: beacon data while performing the color countdown
- * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
- * @counter_offsets_presp: offsets of the counters within the probe response
+ * @counter_offset_beacon: offsets of the counters within the beacon (tail)
+ * @counter_offset_presp: offsets of the counters within the probe response
* @beacon_next: beacon data to be used after the color change
* @count: number of beacons until the color change
* @color: the color used after the change
@@ -1417,6 +1419,7 @@ struct iface_combination_params {
* @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
* @STATION_PARAM_APPLY_CAPABILITY: apply new capability
* @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
+ * @STATION_PARAM_APPLY_STA_TXPOWER: apply tx power for STA
*
* Not all station parameters have in-band "no change" signalling,
* for those that don't these flags will are used.
@@ -2149,6 +2152,9 @@ struct bss_parameters {
* @plink_timeout: If no tx activity is seen from a STA we've established
* peering with for longer than this time (in seconds), then remove it
* from the STA's list of peers. Default is 30 minutes.
+ * @dot11MeshConnectedToAuthServer: if set to true then this mesh STA
+ * will advertise that it is connected to a authentication server
+ * in the mesh formation field.
* @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
* connected to a mesh gate in mesh formation info. If false, the
* value in mesh formation is determined by the presence of root paths
@@ -2321,12 +2327,12 @@ struct cfg80211_scan_info {
/**
* struct cfg80211_scan_6ghz_params - relevant for 6 GHz only
*
- * @short_bssid: short ssid to scan for
+ * @short_ssid: short ssid to scan for
* @bssid: bssid to scan for
* @channel_idx: idx of the channel in the channel array in the scan request
* which the above info relvant to
* @unsolicited_probe: the AP transmits unsolicited probe response every 20 TU
- * @short_ssid_valid: short_ssid is valid and can be used
+ * @short_ssid_valid: @short_ssid is valid and can be used
* @psc_no_listen: when set, and the channel is a PSC channel, no need to wait
* 20 TUs before starting to send probe requests.
*/
@@ -3317,7 +3323,7 @@ struct cfg80211_wowlan_wakeup {
* @kck: key confirmation key (@kck_len bytes)
* @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
* @kek_len: length of kek
- * @kck_len length of kck
+ * @kck_len: length of kck
* @akm: akm (oui, id)
*/
struct cfg80211_gtk_rekey_data {
@@ -3679,6 +3685,7 @@ struct cfg80211_pmsr_ftm_result {
* @type: type of the measurement reported, note that we only support reporting
* one type at a time, but you can report multiple results separately and
* they're all aggregated for userspace.
+ * @ftm: FTM result
*/
struct cfg80211_pmsr_result {
u64 host_time, ap_tsf;
@@ -3817,7 +3824,7 @@ struct cfg80211_update_owe_info {
* for the entire device
* @interface_stypes: bitmap of management frame subtypes registered
* for the given interface
- * @global_mcast_rx: mcast RX is needed globally for these subtypes
+ * @global_mcast_stypes: mcast RX is needed globally for these subtypes
* @interface_mcast_stypes: mcast RX is needed on this interface
* for these subtypes
*/
@@ -4940,6 +4947,7 @@ struct wiphy_iftype_ext_capab {
* @max_peers: maximum number of peers in a single measurement
* @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
* @randomize_mac_addr: can randomize MAC address for measurement
+ * @ftm: FTM measurement data
* @ftm.supported: FTM measurement is supported
* @ftm.asap: ASAP-mode is supported
* @ftm.non_asap: non-ASAP-mode is supported
@@ -5563,6 +5571,7 @@ static inline void wiphy_unlock(struct wiphy *wiphy)
* @netdev: (private) Used to reference back to the netdev, may be %NULL
* @identifier: (private) Identifier used in nl80211 to identify this
* wireless device if it has no netdev
+ * @u: union containing data specific to @iftype
* @connected_addr: (private) BSSID or AP MLD address if connected
* @connected: indicates if connected or not (STA mode)
* @current_bss: (private) Used by the internal configuration code
@@ -5624,6 +5633,9 @@ static inline void wiphy_unlock(struct wiphy *wiphy)
* @pmsr_free_wk: (private) peer measurements cleanup work
* @unprot_beacon_reported: (private) timestamp of last
* unprotected beacon report
+ * @links: array of %IEEE80211_MLD_MAX_NUM_LINKS elements containing @addr
+ * @ap and @client for each link
+ * @valid_links: bitmap describing what elements of @links are valid
*/
struct wireless_dev {
struct wiphy *wiphy;
@@ -6068,6 +6080,7 @@ unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
* @addr: the device MAC address
* @iftype: the virtual interface type
* @data_offset: offset of payload after the 802.11 header
+ * @is_amsdu: true if the 802.11 header is A-MSDU
* Return: 0 on success. Non-zero on error.
*/
int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
@@ -6937,6 +6950,7 @@ void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
* @macaddr: the MAC address of the new candidate
* @ie: information elements advertised by the peer candidate
* @ie_len: length of the information elements buffer
+ * @sig_dbm: signal level in dBm
* @gfp: allocation flags
*
* This function notifies cfg80211 that the mesh peer candidate has been
--
2.36.1
^ permalink raw reply related [flat|nested] 6+ messages in thread* [PATCH 02/22] net: mac80211: add a missing comma at kernel-doc markup
2022-06-28 9:46 [PATCH 00/22] Fix kernel-doc warnings at linux-next Mauro Carvalho Chehab
2022-06-28 9:46 ` [PATCH 01/22] net: cfg80211: fix kernel-doc warnings all over the file Mauro Carvalho Chehab
@ 2022-06-28 9:46 ` Mauro Carvalho Chehab
2022-06-28 17:09 ` Jeff Johnson
2022-06-28 9:46 ` [PATCH 03/22] net: mac80211: sta_info: fix a missing kernel-doc struct element Mauro Carvalho Chehab
2022-06-29 3:23 ` [PATCH 00/22] Fix kernel-doc warnings at linux-next Bagas Sanjaya
3 siblings, 1 reply; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2022-06-28 9:46 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, David S. Miller, Jonathan Corbet,
Mauro Carvalho Chehab, Eric Dumazet, Jakub Kicinski,
Johannes Berg, Paolo Abeni, linux-kernel, linux-wireless, netdev
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 <mchehab@kernel.org>
---
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/cover.1656409369.git.mchehab@kernel.org/
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
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH 02/22] net: mac80211: add a missing comma at kernel-doc markup
2022-06-28 9:46 ` [PATCH 02/22] net: mac80211: add a missing comma at kernel-doc markup Mauro Carvalho Chehab
@ 2022-06-28 17:09 ` Jeff Johnson
0 siblings, 0 replies; 6+ messages in thread
From: Jeff Johnson @ 2022-06-28 17:09 UTC (permalink / raw)
To: Mauro Carvalho Chehab, Linux Doc Mailing List
Cc: David S. Miller, Jonathan Corbet, Mauro Carvalho Chehab,
Eric Dumazet, Jakub Kicinski, Johannes Berg, Paolo Abeni,
linux-kernel, linux-wireless, netdev
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 <mchehab@kernel.org>
> ---
>
> 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/cover.1656409369.git.mchehab@kernel.org/
>
> 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
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH 03/22] net: mac80211: sta_info: fix a missing kernel-doc struct element
2022-06-28 9:46 [PATCH 00/22] Fix kernel-doc warnings at linux-next Mauro Carvalho Chehab
2022-06-28 9:46 ` [PATCH 01/22] net: cfg80211: fix kernel-doc warnings all over the file Mauro Carvalho Chehab
2022-06-28 9:46 ` [PATCH 02/22] net: mac80211: add a missing comma at kernel-doc markup Mauro Carvalho Chehab
@ 2022-06-28 9:46 ` Mauro Carvalho Chehab
2022-06-29 3:23 ` [PATCH 00/22] Fix kernel-doc warnings at linux-next Bagas Sanjaya
3 siblings, 0 replies; 6+ messages in thread
From: Mauro Carvalho Chehab @ 2022-06-28 9:46 UTC (permalink / raw)
To: Linux Doc Mailing List
Cc: Mauro Carvalho Chehab, David S. Miller, Jonathan Corbet,
Mauro Carvalho Chehab, Eric Dumazet, Jakub Kicinski,
Johannes Berg, Paolo Abeni, linux-kernel, linux-wireless, netdev
struct link_sta_info has now a cur_max_bandwidth data:
net/mac80211/sta_info.h:569: warning: Function parameter or member 'cur_max_bandwidth' not described in 'link_sta_info'
Copy the meaning from struct sta_info, documenting it.
Signed-off-by: Mauro Carvalho Chehab <mchehab@kernel.org>
---
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/cover.1656409369.git.mchehab@kernel.org/
net/mac80211/sta_info.h | 2 ++
1 file changed, 2 insertions(+)
diff --git a/net/mac80211/sta_info.h b/net/mac80211/sta_info.h
index 218430790660..4e0b969891de 100644
--- a/net/mac80211/sta_info.h
+++ b/net/mac80211/sta_info.h
@@ -517,6 +517,8 @@ struct ieee80211_fragment_cache {
* @status_stats.last_ack_signal: last ACK signal
* @status_stats.ack_signal_filled: last ACK signal validity
* @status_stats.avg_ack_signal: average ACK signal
+ * @cur_max_bandwidth: maximum bandwidth to use for TX to the station,
+ * taken from HT/VHT capabilities or VHT operating mode notification
* @pub: public (driver visible) link STA data
* TODO Move other link params from sta_info as required for MLD operation
*/
--
2.36.1
^ permalink raw reply related [flat|nested] 6+ messages in thread* Re: [PATCH 00/22] Fix kernel-doc warnings at linux-next
2022-06-28 9:46 [PATCH 00/22] Fix kernel-doc warnings at linux-next Mauro Carvalho Chehab
` (2 preceding siblings ...)
2022-06-28 9:46 ` [PATCH 03/22] net: mac80211: sta_info: fix a missing kernel-doc struct element Mauro Carvalho Chehab
@ 2022-06-29 3:23 ` Bagas Sanjaya
3 siblings, 0 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2022-06-29 3:23 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
Jonathan Corbet, Christian König, David S. Miller,
H. Peter Anvin, Alexander Potapenko, Alexander Viro,
Andrew Morton, Andrey Grodzovsky, Borislav Petkov, Chanwoo Choi,
Daniel Vetter, Dave Hansen, David Airlie, Dmitry Vyukov,
Eric Dumazet, Felipe Balbi, Heikki Krogerus, Ingo Molnar,
Jakub Kicinski, Johannes Berg, Kyungmin Park, Marco Elver,
MyungJoo Ham, Paolo Abeni, Sumit Semwal, Thomas Gleixner, amd-gfx,
dri-devel, kasan-dev, linaro-mm-sig, linux-cachefs, linux-fsdevel,
linux-media, linux-mm, linux-pm, linux-sgx, linux-usb,
linux-wireless, netdev, x86
On Tue, Jun 28, 2022 at 10:46:04AM +0100, Mauro Carvalho Chehab wrote:
> As we're currently discussing about making kernel-doc issues fatal when
> CONFIG_WERROR is enable, let's fix all 60 kernel-doc warnings
> inside linux-next:
>
To be fair, besides triggering error on kernel-doc warnings, Sphinx
warnings should also be errors on CONFIG_WERROR.
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 6+ messages in thread