diff mbox series

[net,09/12] wifi: mac80211: fix kernel-doc notation warning

Message ID 20230710230312.31197-10-rdunlap@infradead.org (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series net: fix kernel-doc problems in include/net/ | expand

Checks

Context Check Description
netdev/series_format success Posting correctly formatted
netdev/tree_selection success Clearly marked for net
netdev/fixes_present success Fixes tag present in non-next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 1440 this patch: 1440
netdev/cc_maintainers success CCed 8 of 8 maintainers
netdev/build_clang success Errors and warnings before: 1400 this patch: 1400
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 1464 this patch: 1464
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 7 lines checked
netdev/kdoc success Errors and warnings before: 1 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Randy Dunlap July 10, 2023, 11:03 p.m. UTC
Add description for struct member 'agg' to prevent a kernel-doc
warning.

mac80211.h:2289: warning: Function parameter or member 'agg' not described in 'ieee80211_link_sta'

Fixes: 4c51541ddb78 ("wifi: mac80211: keep A-MSDU data in sta and per-link")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Eric Dumazet <edumazet@google.com>
Cc: Jakub Kicinski <kuba@kernel.org>
Cc: Paolo Abeni <pabeni@redhat.com>
Cc: Johannes Berg <johannes@sipsolutions.net>
Cc: Benjamin Berg <benjamin.berg@intel.com>
Cc: linux-wireless@vger.kernel.org
---
 include/net/mac80211.h |    1 +
 1 file changed, 1 insertion(+)

Comments

Jakub Kicinski July 12, 2023, 3:37 a.m. UTC | #1
On Mon, 10 Jul 2023 16:03:09 -0700 Randy Dunlap wrote:
> + * @agg: station's active links data

That does not sound right. It'd be better to wait for the WiFi
maintainers to return to get the WiFi bits merged. Can we defer
WiFi patches for now?
Randy Dunlap July 12, 2023, 3:46 a.m. UTC | #2
On 7/11/23 20:37, Jakub Kicinski wrote:
> On Mon, 10 Jul 2023 16:03:09 -0700 Randy Dunlap wrote:
>> + * @agg: station's active links data
> 
> That does not sound right. It'd be better to wait for the WiFi
> maintainers to return to get the WiFi bits merged. Can we defer
> WiFi patches for now?

Sure, no problem.
diff mbox series

Patch

diff -- a/include/net/mac80211.h b/include/net/mac80211.h
--- a/include/net/mac80211.h
+++ b/include/net/mac80211.h
@@ -2259,6 +2259,7 @@  struct ieee80211_sta_aggregates {
  * @he_cap: HE capabilities of this STA
  * @he_6ghz_capa: on 6 GHz, holds the HE 6 GHz band capabilities
  * @eht_cap: EHT capabilities of this STA
+ * @agg: station's active links data
  * @bandwidth: current bandwidth the station can receive with
  * @rx_nss: in HT/VHT, the maximum number of spatial streams the
  *	station can receive at the moment, changed by operating mode