[PATCH net 00/12] net: fix kernel-doc problems in include/net/

[PATCH net 00/12] net: fix kernel-doc problems in include/net/

[Randy Dunlap]

Fix many (but not all) kernel-doc warnings in include/net/.

 [PATCH net 01/12] net: bonding: remove kernel-doc comment marker
 [PATCH net 02/12] wifi: cfg80211: remove dead/unused enum value
 [PATCH net 03/12] net: cfg802154: fix kernel-doc notation warnings
 [PATCH net 04/12] codel: fix kernel-doc notation warnings
 [PATCH net 05/12] devlink: fix kernel-doc notation warnings
 [PATCH net 06/12] wifi: radiotap: fix kernel-doc notation warnings
 [PATCH net 07/12] inet: frags: remove kernel-doc comment marker
 [PATCH net 08/12] net: llc: fix kernel-doc notation warnings
 [PATCH net 09/12] wifi: mac80211: fix kernel-doc notation warning
 [PATCH net 10/12] net: NSH: fix kernel-doc notation warning
 [PATCH net 11/12] pie: fix kernel-doc notation warning
 [PATCH net 12/12] rsi: remove kernel-doc comment marker

 include/net/bonding.h            |    2 +-
 include/net/cfg80211.h           |    1 -
 include/net/cfg802154.h          |    3 ++-
 include/net/codel.h              |    4 ++--
 include/net/devlink.h            |   28 ++++++++++++++++------------
 include/net/ieee80211_radiotap.h |    3 ++-
 include/net/inet_frag.h          |    2 +-
 include/net/llc_pdu.h            |    6 ++++--
 include/net/mac80211.h           |    1 +
 include/net/nsh.h                |    2 +-
 include/net/pie.h                |    2 +-
 include/net/rsi_91x.h            |    2 +-
 12 files changed, 32 insertions(+), 24 deletions(-)

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: linux-wireless@vger.kernel.org
Cc: linux-wpan@vger.kernel.org
Cc: Jay Vosburgh <j.vosburgh@gmail.com>
Cc: Andy Gospodarek <andy@greyhouse.net>
Cc: Johannes Berg <johannes@sipsolutions.net>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Alexander Aring <alex.aring@gmail.com>
Cc: Stefan Schmidt <stefan@datenfreihafen.org>
Cc: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: Marcel Holtmann <marcel@holtmann.org>
Cc: Jamal Hadi Salim <jhs@mojatatu.com>
Cc: Cong Wang <xiyou.wangcong@gmail.com>
Cc: Jiri Pirko <jiri@resnulli.us>
Cc: Dave Taht <dave.taht@bufferbloat.net>
Cc: Arkadi Sharshevsky <arkadis@mellanox.com>
Cc: Moshe Shemesh <moshe@mellanox.com>
Cc: Jacob Keller <jacob.e.keller@intel.com>
Cc: Nikolay Aleksandrov <razor@blackwall.org>
Cc: Benjamin Berg <benjamin.berg@intel.com>
Cc: Yi Yang <yi.y.yang@intel.com>
Cc: Jiri Benc <jbenc@redhat.com>
Cc: Leslie Monis <lesliemonis@gmail.com>
Cc: "Mohit P. Tahiliani" <tahiliani@nitk.edu.in>
Cc: Gautam Ramakrishnan <gautamramk@gmail.com>
Cc: Prameela Rani Garnepudi <prameela.j04cs@gmail.com>
Cc: Siva Rebbagondla <siva.rebbagondla@redpinesignals.com>
Cc: Amitkumar Karwar <amit.karwar@redpinesignals.com>
Cc: Kalle Valo <kvalo@kernel.org>

[PATCH net 02/12] wifi: cfg80211: remove dead/unused enum value

[Randy Dunlap]

Drop an unused (extra) enum value to prevent a kernel-doc warning.

cfg80211.h:1492: warning: Excess enum value 'STATION_PARAM_APPLY_STA_TXPOWER' description in 'station_parameters_apply_mask'

Fixes: 2d8b08fef0af ("wifi: cfg80211: fix kernel-doc warnings all over the file")
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: linux-wireless@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
---
 include/net/cfg80211.h |    1 -
 1 file changed, 1 deletion(-)

diff -- a/include/net/cfg80211.h b/include/net/cfg80211.h
--- a/include/net/cfg80211.h
+++ b/include/net/cfg80211.h
@@ -1479,7 +1479,6 @@ 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.

[PATCH net 06/12] wifi: radiotap: fix kernel-doc notation warnings

[Randy Dunlap]

Fix a typo (82011 -> 80211) to prevent a kernel-doc warning.
Add one missing function parameter description to prevent a
kernel-doc warning.

ieee80211_radiotap.h:52: warning: expecting prototype for struct ieee82011_radiotap_header. Prototype was for struct ieee80211_radiotap_header instead
ieee80211_radiotap.h:581: warning: Function parameter or member 'data' not described in 'ieee80211_get_radiotap_len'

Fixes: 42f82e2e62ae ("wireless: radiotap: rewrite the radiotap header file")
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: linux-wireless@vger.kernel.org
---
 include/net/ieee80211_radiotap.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff -- a/include/net/ieee80211_radiotap.h b/include/net/ieee80211_radiotap.h
--- a/include/net/ieee80211_radiotap.h
+++ b/include/net/ieee80211_radiotap.h
@@ -21,7 +21,7 @@
 #include <asm/unaligned.h>
 
 /**
- * struct ieee82011_radiotap_header - base radiotap header
+ * struct ieee80211_radiotap_header - base radiotap header
  */
 struct ieee80211_radiotap_header {
 	/**
@@ -575,6 +575,7 @@ enum ieee80211_radiotap_eht_usig_tb {
 
 /**
  * ieee80211_get_radiotap_len - get radiotap header length
+ * @data: pointer to the header
  */
 static inline u16 ieee80211_get_radiotap_len(const char *data)
 {

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

[Randy Dunlap]

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(+)

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

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

[Jakub Kicinski]

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?

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

[Randy Dunlap]

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.

-- 
~Randy