Message ID | 87plz1g2sc.fsf@meer.lwn.net |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel+bounces-6124-ouuuleilei=gmail.com@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:24d3:b0:fb:cd0c:d3e with SMTP id r19csp2313549dyi; Tue, 19 Dec 2023 16:02:08 -0800 (PST) X-Google-Smtp-Source: AGHT+IEqVF+l+NbDlFhtd5hcDcRRIZZlFKe2NO+M9vGHhEGmxR4zO4O0+0uzUsKPOfbk4BV2BuFN X-Received: by 2002:a05:600c:cc9:b0:40d:2fe4:5908 with SMTP id fk9-20020a05600c0cc900b0040d2fe45908mr200718wmb.169.1703030528443; Tue, 19 Dec 2023 16:02:08 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1703030528; cv=none; d=google.com; s=arc-20160816; b=E+bPzoLX10t3op1s2JaycYWv/6y97ziJ0cAuSXQjXctC6e1wPnNsj7fHEqMb36bVpg sqHOgKD0ivlYp8bB80rnq9AlG/rKoNSV/mvuCFbclkdARURYvvMU/7HBG0ieHSnmG0sl 0ZZBXNvzMk/m+ptyTEEbA/nkFMgLiWTbsZgGx7FzI3tk9CrAqAgWlENUxRP8FBiBPYjJ XJCFOo8uOAiX0fin03owUGb+X7t64tIibYPSjIyPryIqUeHw4d7iJib9kRlaNs/1v16C qD0HD2x5uUVUnirBUyzzyGdSqwHe12ON7RGQjxmweLMoDEZFlNrJBKF61jmaTH8Qz/Vp fFnQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=mime-version:list-unsubscribe:list-subscribe:list-id:precedence :message-id:date:subject:cc:to:from:dkim-signature:dkim-filter; bh=jTG5dpMX6psNetWgHqT85RaanezwkMuMisj0ITm0ioU=; fh=QM/O3X4NEfpji6ycdyxXi6cCU6hmRZvr+IIWOkw4+LQ=; b=uvIVGaviDoMP1w3sfGGYdfOUcdfsCKbwoAaOAy9buzG7ESiDV0k43Hu284/SCmmU8W 465MtTEsCVjpwTAmEriw1Q5p0K4yKh3lTHVSK0P5szapp7AaGUasaRahbpXn4hAIGSOC e7ai4MoGapI9RQdE/9VI+4aov8eT2A2b7AINcv1vB0wHo0UNfUVJwqowt0c12gAQX4fU oKEGYJDMqyy+C2+CnxFxoseGHAxR3PtB8WePFP7ElnFaedSc/GCGBlg9CFkltEjTvWLI 3i64rSMspzpeo7rewcEYCl1J+f9STRVgWHJdewWpSrVkWLK1ln4fVcFGOeSUiyO2q/af LcNA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@lwn.net header.s=20201203 header.b=PKTFgcrd; spf=pass (google.com: domain of linux-kernel+bounces-6124-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-6124-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=lwn.net Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id m8-20020a1709066d0800b00a23581d4972si2234853ejr.911.2023.12.19.16.02.08 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 19 Dec 2023 16:02:08 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-6124-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; dkim=pass header.i=@lwn.net header.s=20201203 header.b=PKTFgcrd; spf=pass (google.com: domain of linux-kernel+bounces-6124-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-6124-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=lwn.net Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by am.mirrors.kernel.org (Postfix) with ESMTPS id 1199F1F25181 for <ouuuleilei@gmail.com>; Wed, 20 Dec 2023 00:02:08 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 3D87723B5; Wed, 20 Dec 2023 00:01:45 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=lwn.net header.i=@lwn.net header.b="PKTFgcrd" X-Original-To: linux-kernel@vger.kernel.org Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 26623BE4C; Wed, 20 Dec 2023 00:01:40 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=lwn.net Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=lwn.net Received: from localhost (unknown [IPv6:2601:280:5e00:7e19::646]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 61D837DA; Wed, 20 Dec 2023 00:01:40 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 61D837DA DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1703030500; bh=jTG5dpMX6psNetWgHqT85RaanezwkMuMisj0ITm0ioU=; h=From:To:Cc:Subject:Date:From; b=PKTFgcrdEopAi67xnqTUoADR0ekAwSZca5EQZXRiu0s0VCrnJUSZH2jw0hKdL2XJr IvqONFHTjtT16Oaw8iLyEqeT37Lis2UYUH7FFM2s6SMD3+ymsLSXCuBjnppnSXtkGw VK/VxIGgopdoBXQfhTxuBd2AYIIK6lRbEok5KLAnsNqskfkHMU5qdGXzwCBaWkAapx /mBsniOra91aEquQtW9L73957O6dP6pvnDDujjlYcQVRkhGRurPpYUOJWOLGp0BJW3 tSxIISBkmZvZfG0XN5vjgRM05ri1mabw8vJKzY1R39TVUbFucNYm8gheFr14Hz3itV 1J3896O74KWdg== From: Jonathan Corbet <corbet@lwn.net> To: Johannes Berg <johannes@sipsolutions.net> Cc: linux-wireless@vger.kernel.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org Subject: [PATCH] wifi: cfg80211: address several kerneldoc warnings Date: Tue, 19 Dec 2023 17:01:39 -0700 Message-ID: <87plz1g2sc.fsf@meer.lwn.net> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: <linux-kernel.vger.kernel.org> List-Subscribe: <mailto:linux-kernel+subscribe@vger.kernel.org> List-Unsubscribe: <mailto:linux-kernel+unsubscribe@vger.kernel.org> MIME-Version: 1.0 Content-Type: text/plain X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785756938995600632 X-GMAIL-MSGID: 1785756938995600632 |
Series |
wifi: cfg80211: address several kerneldoc warnings
|
|
Commit Message
Jonathan Corbet
Dec. 20, 2023, 12:01 a.m. UTC
include/net/cfg80211.h includes a number of kerneldoc entries for struct
members that do not exist, leading to these warnings:
./include/net/cfg80211.h:3192: warning: Excess struct member 'band_pref' description in 'cfg80211_bss_selection'
./include/net/cfg80211.h:3192: warning: Excess struct member 'adjust' description in 'cfg80211_bss_selection'
./include/net/cfg80211.h:6181: warning: Excess struct member 'bssid' description in 'wireless_dev'
./include/net/cfg80211.h:6181: warning: Excess struct member 'beacon_interval' description in 'wireless_dev'
./include/net/cfg80211.h:7299: warning: Excess struct member 'bss' description in 'cfg80211_rx_assoc_resp_data'
Remove and/or repair each entry to address the warnings and ensure a proper
docs build for the affected structures.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
include/net/cfg80211.h | 11 ++++-------
1 file changed, 4 insertions(+), 7 deletions(-)
Comments
On 12/19/2023 4:01 PM, Jonathan Corbet wrote: > include/net/cfg80211.h includes a number of kerneldoc entries for struct > members that do not exist, leading to these warnings: > > ./include/net/cfg80211.h:3192: warning: Excess struct member 'band_pref' description in 'cfg80211_bss_selection' > ./include/net/cfg80211.h:3192: warning: Excess struct member 'adjust' description in 'cfg80211_bss_selection' > ./include/net/cfg80211.h:6181: warning: Excess struct member 'bssid' description in 'wireless_dev' > ./include/net/cfg80211.h:6181: warning: Excess struct member 'beacon_interval' description in 'wireless_dev' > ./include/net/cfg80211.h:7299: warning: Excess struct member 'bss' description in 'cfg80211_rx_assoc_resp_data' > > Remove and/or repair each entry to address the warnings and ensure a proper > docs build for the affected structures. > > Signed-off-by: Jonathan Corbet <corbet@lwn.net> > --- > include/net/cfg80211.h | 11 ++++------- > 1 file changed, 4 insertions(+), 7 deletions(-) > > diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h > index b137a33a1b68..81c46c8e2a68 100644 > --- a/include/net/cfg80211.h > +++ b/include/net/cfg80211.h > @@ -3180,8 +3180,8 @@ struct cfg80211_ibss_params { > * > * @behaviour: requested BSS selection behaviour. > * @param: parameters for requestion behaviour. > - * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF. > - * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST. > + * @param.band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF. > + * @param.adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST. > */ > struct cfg80211_bss_selection { > enum nl80211_bss_select_attr behaviour; > @@ -6013,7 +6013,6 @@ void wiphy_delayed_work_flush(struct wiphy *wiphy, > * wireless device if it has no netdev > * @u: union containing data specific to @iftype > * @connected: indicates if connected or not (STA mode) > - * @bssid: (private) Used by the internal configuration code > * @wext: (private) Used by the internal wireless extensions compat code > * @wext.ibss: (private) IBSS data part of wext handling > * @wext.connect: (private) connection handling data > @@ -6033,8 +6032,6 @@ void wiphy_delayed_work_flush(struct wiphy *wiphy, > * @mgmt_registrations: list of registrations for management frames > * @mgmt_registrations_need_update: mgmt registrations were updated, > * need to propagate the update to the driver > - * @beacon_interval: beacon interval used on this device for transmitting > - * beacons, 0 when not valid > * @address: The address for this device, valid only if @netdev is %NULL > * @is_running: true if this is a non-netdev device that has been started, e.g. > * the P2P Device. > @@ -7270,8 +7267,6 @@ void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr); > > /** > * struct cfg80211_rx_assoc_resp_data - association response data > - * @bss: the BSS that association was requested with, ownership of the pointer > - * moves to cfg80211 in the call to cfg80211_rx_assoc_resp() > * @buf: (Re)Association Response frame (header + body) > * @len: length of the frame data > * @uapsd_queues: bitmap of queues configured for uapsd. Same format > @@ -7281,6 +7276,8 @@ void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr); > * @ap_mld_addr: AP MLD address (in case of MLO) > * @links: per-link information indexed by link ID, use links[0] for > * non-MLO connections also missing the following? * @links.addr: MLO per-link MAC address > + * @links.bss: the BSS that association was requested with, ownership of the > + * pointer moves to cfg80211 in the call to cfg80211_rx_assoc_resp() > * @links.status: Set this (along with a BSS pointer) for links that > * were rejected by the AP. > */
On 12/19/23 16:01, Jonathan Corbet wrote: > include/net/cfg80211.h includes a number of kerneldoc entries for struct > members that do not exist, leading to these warnings: > > ./include/net/cfg80211.h:3192: warning: Excess struct member 'band_pref' description in 'cfg80211_bss_selection' > ./include/net/cfg80211.h:3192: warning: Excess struct member 'adjust' description in 'cfg80211_bss_selection' > ./include/net/cfg80211.h:6181: warning: Excess struct member 'bssid' description in 'wireless_dev' > ./include/net/cfg80211.h:6181: warning: Excess struct member 'beacon_interval' description in 'wireless_dev' > ./include/net/cfg80211.h:7299: warning: Excess struct member 'bss' description in 'cfg80211_rx_assoc_resp_data' > > Remove and/or repair each entry to address the warnings and ensure a proper > docs build for the affected structures. > > Signed-off-by: Jonathan Corbet <corbet@lwn.net> Reviewed-by: Randy Dunlap <rdunlap@infradead.org> > --- > include/net/cfg80211.h | 11 ++++------- > 1 file changed, 4 insertions(+), 7 deletions(-) > > diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h > index b137a33a1b68..81c46c8e2a68 100644 > --- a/include/net/cfg80211.h > +++ b/include/net/cfg80211.h > @@ -3180,8 +3180,8 @@ struct cfg80211_ibss_params { > * > * @behaviour: requested BSS selection behaviour. > * @param: parameters for requestion behaviour. > - * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF. > - * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST. > + * @param.band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF. > + * @param.adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST. > */ > struct cfg80211_bss_selection { > enum nl80211_bss_select_attr behaviour; > @@ -6013,7 +6013,6 @@ void wiphy_delayed_work_flush(struct wiphy *wiphy, > * wireless device if it has no netdev > * @u: union containing data specific to @iftype > * @connected: indicates if connected or not (STA mode) > - * @bssid: (private) Used by the internal configuration code > * @wext: (private) Used by the internal wireless extensions compat code > * @wext.ibss: (private) IBSS data part of wext handling > * @wext.connect: (private) connection handling data > @@ -6033,8 +6032,6 @@ void wiphy_delayed_work_flush(struct wiphy *wiphy, > * @mgmt_registrations: list of registrations for management frames > * @mgmt_registrations_need_update: mgmt registrations were updated, > * need to propagate the update to the driver > - * @beacon_interval: beacon interval used on this device for transmitting > - * beacons, 0 when not valid > * @address: The address for this device, valid only if @netdev is %NULL > * @is_running: true if this is a non-netdev device that has been started, e.g. > * the P2P Device. > @@ -7270,8 +7267,6 @@ void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr); > > /** > * struct cfg80211_rx_assoc_resp_data - association response data > - * @bss: the BSS that association was requested with, ownership of the pointer > - * moves to cfg80211 in the call to cfg80211_rx_assoc_resp() > * @buf: (Re)Association Response frame (header + body) > * @len: length of the frame data > * @uapsd_queues: bitmap of queues configured for uapsd. Same format > @@ -7281,6 +7276,8 @@ void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr); > * @ap_mld_addr: AP MLD address (in case of MLO) > * @links: per-link information indexed by link ID, use links[0] for > * non-MLO connections > + * @links.bss: the BSS that association was requested with, ownership of the > + * pointer moves to cfg80211 in the call to cfg80211_rx_assoc_resp() > * @links.status: Set this (along with a BSS pointer) for links that > * were rejected by the AP. > */
On 12/19/23 17:00, Jeff Johnson wrote: > On 12/19/2023 4:01 PM, Jonathan Corbet wrote: >> include/net/cfg80211.h includes a number of kerneldoc entries for struct >> members that do not exist, leading to these warnings: >> >> ./include/net/cfg80211.h:3192: warning: Excess struct member 'band_pref' description in 'cfg80211_bss_selection' >> ./include/net/cfg80211.h:3192: warning: Excess struct member 'adjust' description in 'cfg80211_bss_selection' >> ./include/net/cfg80211.h:6181: warning: Excess struct member 'bssid' description in 'wireless_dev' >> ./include/net/cfg80211.h:6181: warning: Excess struct member 'beacon_interval' description in 'wireless_dev' >> ./include/net/cfg80211.h:7299: warning: Excess struct member 'bss' description in 'cfg80211_rx_assoc_resp_data' >> >> Remove and/or repair each entry to address the warnings and ensure a proper >> docs build for the affected structures. >> >> Signed-off-by: Jonathan Corbet <corbet@lwn.net> >> --- >> include/net/cfg80211.h | 11 ++++------- >> 1 file changed, 4 insertions(+), 7 deletions(-) >> >> diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h >> index b137a33a1b68..81c46c8e2a68 100644 >> --- a/include/net/cfg80211.h >> +++ b/include/net/cfg80211.h >> @@ -3180,8 +3180,8 @@ struct cfg80211_ibss_params { >> * >> * @behaviour: requested BSS selection behaviour. >> * @param: parameters for requestion behaviour. >> - * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF. >> - * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST. >> + * @param.band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF. >> + * @param.adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST. >> */ >> struct cfg80211_bss_selection { >> enum nl80211_bss_select_attr behaviour; >> @@ -6013,7 +6013,6 @@ void wiphy_delayed_work_flush(struct wiphy *wiphy, >> * wireless device if it has no netdev >> * @u: union containing data specific to @iftype >> * @connected: indicates if connected or not (STA mode) >> - * @bssid: (private) Used by the internal configuration code >> * @wext: (private) Used by the internal wireless extensions compat code >> * @wext.ibss: (private) IBSS data part of wext handling >> * @wext.connect: (private) connection handling data >> @@ -6033,8 +6032,6 @@ void wiphy_delayed_work_flush(struct wiphy *wiphy, >> * @mgmt_registrations: list of registrations for management frames >> * @mgmt_registrations_need_update: mgmt registrations were updated, >> * need to propagate the update to the driver >> - * @beacon_interval: beacon interval used on this device for transmitting >> - * beacons, 0 when not valid >> * @address: The address for this device, valid only if @netdev is %NULL >> * @is_running: true if this is a non-netdev device that has been started, e.g. >> * the P2P Device. >> @@ -7270,8 +7267,6 @@ void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr); >> >> /** >> * struct cfg80211_rx_assoc_resp_data - association response data >> - * @bss: the BSS that association was requested with, ownership of the pointer >> - * moves to cfg80211 in the call to cfg80211_rx_assoc_resp() >> * @buf: (Re)Association Response frame (header + body) >> * @len: length of the frame data >> * @uapsd_queues: bitmap of queues configured for uapsd. Same format >> @@ -7281,6 +7276,8 @@ void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr); >> * @ap_mld_addr: AP MLD address (in case of MLO) >> * @links: per-link information indexed by link ID, use links[0] for >> * non-MLO connections > > also missing the following? > * @links.addr: MLO per-link MAC address Yes, that should also be fixed at some point. What Jon is trying to do here is address a boatload of new kernel-doc warnings of the "Excess struct member" variety. > >> + * @links.bss: the BSS that association was requested with, ownership of the >> + * pointer moves to cfg80211 in the call to cfg80211_rx_assoc_resp() >> * @links.status: Set this (along with a BSS pointer) for links that >> * were rejected by the AP. >> */ > > Thanks.
Jonathan Corbet <corbet@lwn.net> writes: > include/net/cfg80211.h includes a number of kerneldoc entries for struct > members that do not exist, leading to these warnings: > > ./include/net/cfg80211.h:3192: warning: Excess struct member 'band_pref' description in 'cfg80211_bss_selection' > ./include/net/cfg80211.h:3192: warning: Excess struct member 'adjust' description in 'cfg80211_bss_selection' > ./include/net/cfg80211.h:6181: warning: Excess struct member 'bssid' description in 'wireless_dev' > ./include/net/cfg80211.h:6181: warning: Excess struct member 'beacon_interval' description in 'wireless_dev' > ./include/net/cfg80211.h:7299: warning: Excess struct member 'bss' description in 'cfg80211_rx_assoc_resp_data' > > Remove and/or repair each entry to address the warnings and ensure a proper > docs build for the affected structures. > > Signed-off-by: Jonathan Corbet <corbet@lwn.net> I try to periodically check for kerneldoc warnings in wireless trees but I have never seen these. Am I missing something or did you do something special (enable new warnings etc.)?
On 12/19/23 22:35, Kalle Valo wrote: > Jonathan Corbet <corbet@lwn.net> writes: > >> include/net/cfg80211.h includes a number of kerneldoc entries for struct >> members that do not exist, leading to these warnings: >> >> ./include/net/cfg80211.h:3192: warning: Excess struct member 'band_pref' description in 'cfg80211_bss_selection' >> ./include/net/cfg80211.h:3192: warning: Excess struct member 'adjust' description in 'cfg80211_bss_selection' >> ./include/net/cfg80211.h:6181: warning: Excess struct member 'bssid' description in 'wireless_dev' >> ./include/net/cfg80211.h:6181: warning: Excess struct member 'beacon_interval' description in 'wireless_dev' >> ./include/net/cfg80211.h:7299: warning: Excess struct member 'bss' description in 'cfg80211_rx_assoc_resp_data' >> >> Remove and/or repair each entry to address the warnings and ensure a proper >> docs build for the affected structures. >> >> Signed-off-by: Jonathan Corbet <corbet@lwn.net> > > I try to periodically check for kerneldoc warnings in wireless trees but > I have never seen these. Am I missing something or did you do something > special (enable new warnings etc.)? There are new patches from both Kees Cook and me to report Excess kernel-doc descriptions, so now there are a bunch of kernel-doc warnings that we are working to fix quickly. :(
Randy Dunlap <rdunlap@infradead.org> writes: > On 12/19/23 22:35, Kalle Valo wrote: >> Jonathan Corbet <corbet@lwn.net> writes: >> >>> include/net/cfg80211.h includes a number of kerneldoc entries for struct >>> members that do not exist, leading to these warnings: >>> >>> ./include/net/cfg80211.h:3192: warning: Excess struct member >>> 'band_pref' description in 'cfg80211_bss_selection' >>> ./include/net/cfg80211.h:3192: warning: Excess struct member >>> 'adjust' description in 'cfg80211_bss_selection' >>> ./include/net/cfg80211.h:6181: warning: Excess struct member >>> 'bssid' description in 'wireless_dev' >>> ./include/net/cfg80211.h:6181: warning: Excess struct member >>> 'beacon_interval' description in 'wireless_dev' >>> ./include/net/cfg80211.h:7299: warning: Excess struct member >>> 'bss' description in 'cfg80211_rx_assoc_resp_data' >>> >>> Remove and/or repair each entry to address the warnings and ensure a proper >>> docs build for the affected structures. >>> >>> Signed-off-by: Jonathan Corbet <corbet@lwn.net> >> >> I try to periodically check for kerneldoc warnings in wireless trees but >> I have never seen these. Am I missing something or did you do something >> special (enable new warnings etc.)? > > There are new patches from both Kees Cook and me to report Excess kernel-doc > descriptions, so now there are a bunch of kernel-doc warnings that we are working > to fix quickly. :( Got it, thanks. Good to know that I wasn't missing anything.
diff --git a/include/net/cfg80211.h b/include/net/cfg80211.h index b137a33a1b68..81c46c8e2a68 100644 --- a/include/net/cfg80211.h +++ b/include/net/cfg80211.h @@ -3180,8 +3180,8 @@ struct cfg80211_ibss_params { * * @behaviour: requested BSS selection behaviour. * @param: parameters for requestion behaviour. - * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF. - * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST. + * @param.band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF. + * @param.adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST. */ struct cfg80211_bss_selection { enum nl80211_bss_select_attr behaviour; @@ -6013,7 +6013,6 @@ void wiphy_delayed_work_flush(struct wiphy *wiphy, * wireless device if it has no netdev * @u: union containing data specific to @iftype * @connected: indicates if connected or not (STA mode) - * @bssid: (private) Used by the internal configuration code * @wext: (private) Used by the internal wireless extensions compat code * @wext.ibss: (private) IBSS data part of wext handling * @wext.connect: (private) connection handling data @@ -6033,8 +6032,6 @@ void wiphy_delayed_work_flush(struct wiphy *wiphy, * @mgmt_registrations: list of registrations for management frames * @mgmt_registrations_need_update: mgmt registrations were updated, * need to propagate the update to the driver - * @beacon_interval: beacon interval used on this device for transmitting - * beacons, 0 when not valid * @address: The address for this device, valid only if @netdev is %NULL * @is_running: true if this is a non-netdev device that has been started, e.g. * the P2P Device. @@ -7270,8 +7267,6 @@ void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr); /** * struct cfg80211_rx_assoc_resp_data - association response data - * @bss: the BSS that association was requested with, ownership of the pointer - * moves to cfg80211 in the call to cfg80211_rx_assoc_resp() * @buf: (Re)Association Response frame (header + body) * @len: length of the frame data * @uapsd_queues: bitmap of queues configured for uapsd. Same format @@ -7281,6 +7276,8 @@ void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr); * @ap_mld_addr: AP MLD address (in case of MLO) * @links: per-link information indexed by link ID, use links[0] for * non-MLO connections + * @links.bss: the BSS that association was requested with, ownership of the + * pointer moves to cfg80211 in the call to cfg80211_rx_assoc_resp() * @links.status: Set this (along with a BSS pointer) for links that * were rejected by the AP. */