Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Merge branch 'net-fix-kernel-doc-problems-in-include-net'

Randy Dunlap says:

====================
net: fix kernel-doc problems in include/net/

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

[PATCH v2 net 1/9] net: bonding: remove kernel-doc comment marker
[PATCH v2 net 2/9] net: cfg802154: fix kernel-doc notation warnings
[PATCH v2 net 3/9] codel: fix kernel-doc notation warnings
[PATCH v2 net 4/9] devlink: fix kernel-doc notation warnings
[PATCH v2 net 5/9] inet: frags: remove kernel-doc comment marker
[PATCH v2 net 6/9] net: llc: fix kernel-doc notation warnings
[PATCH v2 net 7/9] net: NSH: fix kernel-doc notation warning
[PATCH v2 net 8/9] pie: fix kernel-doc notation warning
[PATCH v2 net 9/9] rsi: remove kernel-doc comment marker
====================

Link: https://lore.kernel.org/r/20230714045127.18752-1-rdunlap@infradead.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>

+29 -22
+1 -1
include/net/bonding.h
··· 277 277 unsigned short vlan_id; 278 278 }; 279 279 280 - /** 280 + /* 281 281 * Returns NULL if the net_device does not belong to any of the bond's slaves 282 282 * 283 283 * Caller must hold bond lock for read
+2 -1
include/net/cfg802154.h
··· 170 170 } 171 171 172 172 /** 173 - * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support 173 + * enum wpan_phy_flags - WPAN PHY state flags 174 + * @WPAN_PHY_FLAG_TXPOWER: Indicates that transceiver will support 174 175 * transmit power setting. 175 176 * @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed 176 177 * level setting.
+2 -2
include/net/codel.h
··· 145 145 * @maxpacket: largest packet we've seen so far 146 146 * @drop_count: temp count of dropped packets in dequeue() 147 147 * @drop_len: bytes of dropped packets in dequeue() 148 - * ecn_mark: number of packets we ECN marked instead of dropping 149 - * ce_mark: number of packets CE marked because sojourn time was above ce_threshold 148 + * @ecn_mark: number of packets we ECN marked instead of dropping 149 + * @ce_mark: number of packets CE marked because sojourn time was above ce_threshold 150 150 */ 151 151 struct codel_stats { 152 152 u32 maxpacket;
+16 -12
include/net/devlink.h
··· 221 221 /** 222 222 * struct devlink_dpipe_header - dpipe header object 223 223 * @name: header name 224 - * @id: index, global/local detrmined by global bit 224 + * @id: index, global/local determined by global bit 225 225 * @fields: fields 226 226 * @fields_count: number of fields 227 227 * @global: indicates if header is shared like most protocol header ··· 241 241 * @header_index: header index (packets can have several headers of same 242 242 * type like in case of tunnels) 243 243 * @header: header 244 - * @fieled_id: field index 244 + * @field_id: field index 245 245 */ 246 246 struct devlink_dpipe_match { 247 247 enum devlink_dpipe_match_type type; ··· 256 256 * @header_index: header index (packets can have several headers of same 257 257 * type like in case of tunnels) 258 258 * @header: header 259 - * @fieled_id: field index 259 + * @field_id: field index 260 260 */ 261 261 struct devlink_dpipe_action { 262 262 enum devlink_dpipe_action_type type; ··· 292 292 * struct devlink_dpipe_entry - table entry object 293 293 * @index: index of the entry in the table 294 294 * @match_values: match values 295 - * @matche_values_count: count of matches tuples 295 + * @match_values_count: count of matches tuples 296 296 * @action_values: actions values 297 297 * @action_values_count: count of actions values 298 298 * @counter: value of counter ··· 342 342 */ 343 343 struct devlink_dpipe_table { 344 344 void *priv; 345 + /* private: */ 345 346 struct list_head list; 347 + /* public: */ 346 348 const char *name; 347 349 bool counters_enabled; 348 350 bool counter_control_extern; ··· 357 355 358 356 /** 359 357 * struct devlink_dpipe_table_ops - dpipe_table ops 360 - * @actions_dump - dumps all tables actions 361 - * @matches_dump - dumps all tables matches 362 - * @entries_dump - dumps all active entries in the table 363 - * @counters_set_update - when changing the counter status hardware sync 358 + * @actions_dump: dumps all tables actions 359 + * @matches_dump: dumps all tables matches 360 + * @entries_dump: dumps all active entries in the table 361 + * @counters_set_update: when changing the counter status hardware sync 364 362 * maybe needed to allocate/free counter related 365 363 * resources 366 - * @size_get - get size 364 + * @size_get: get size 367 365 */ 368 366 struct devlink_dpipe_table_ops { 369 367 int (*actions_dump)(void *priv, struct sk_buff *skb); ··· 376 374 377 375 /** 378 376 * struct devlink_dpipe_headers - dpipe headers 379 - * @headers - header array can be shared (global bit) or driver specific 380 - * @headers_count - count of headers 377 + * @headers: header array can be shared (global bit) or driver specific 378 + * @headers_count: count of headers 381 379 */ 382 380 struct devlink_dpipe_headers { 383 381 struct devlink_dpipe_header **headers; ··· 389 387 * @size_min: minimum size which can be set 390 388 * @size_max: maximum size which can be set 391 389 * @size_granularity: size granularity 392 - * @size_unit: resource's basic unit 390 + * @unit: resource's basic unit 393 391 */ 394 392 struct devlink_resource_size_params { 395 393 u64 size_min; ··· 459 457 460 458 /** 461 459 * struct devlink_param - devlink configuration parameter data 460 + * @id: devlink parameter id number 462 461 * @name: name of the parameter 463 462 * @generic: indicates if the parameter is generic or driver specific 464 463 * @type: parameter type ··· 635 632 * struct devlink_flash_update_params - Flash Update parameters 636 633 * @fw: pointer to the firmware data to update from 637 634 * @component: the flash component to update 635 + * @overwrite_mask: which types of flash update are supported (may be %0) 638 636 * 639 637 * With the exception of fw, drivers must opt-in to parameters by 640 638 * setting the appropriate bit in the supported_flash_update_params field in
+1 -1
include/net/inet_frag.h
··· 29 29 }; 30 30 31 31 /** 32 - * fragment queue flags 32 + * enum: fragment queue flags 33 33 * 34 34 * @INET_FRAG_FIRST_IN: first fragment has arrived 35 35 * @INET_FRAG_LAST_IN: final fragment has arrived
+4 -2
include/net/llc_pdu.h
··· 269 269 /** 270 270 * llc_pdu_decode_da - extracts dest address of input frame 271 271 * @skb: input skb that destination address must be extracted from it 272 - * @sa: pointer to destination address (6 byte array). 272 + * @da: pointer to destination address (6 byte array). 273 273 * 274 274 * This function extracts destination address(MAC) of input frame. 275 275 */ ··· 321 321 322 322 /** 323 323 * llc_pdu_init_as_test_cmd - sets PDU as TEST 324 - * @skb - Address of the skb to build 324 + * @skb: Address of the skb to build 325 325 * 326 326 * Sets a PDU as TEST 327 327 */ ··· 369 369 /** 370 370 * llc_pdu_init_as_xid_cmd - sets bytes 3, 4 & 5 of LLC header as XID 371 371 * @skb: input skb that header must be set into it. 372 + * @svcs_supported: The class of the LLC (I or II) 373 + * @rx_window: The size of the receive window of the LLC 372 374 * 373 375 * This function sets third,fourth,fifth and sixth bytes of LLC header as 374 376 * a XID PDU.
+1 -1
include/net/nsh.h
··· 192 192 193 193 /** 194 194 * struct nsh_md1_ctx - Keeps track of NSH context data 195 - * @nshc<1-4>: NSH Contexts. 195 + * @context: NSH Contexts. 196 196 */ 197 197 struct nsh_md1_ctx { 198 198 __be32 context[4];
+1 -1
include/net/pie.h
··· 17 17 /** 18 18 * struct pie_params - contains pie parameters 19 19 * @target: target delay in pschedtime 20 - * @tudpate: interval at which drop probability is calculated 20 + * @tupdate: interval at which drop probability is calculated 21 21 * @limit: total number of packets that can be in the queue 22 22 * @alpha: parameter to control drop probability 23 23 * @beta: parameter to control drop probability
+1 -1
include/net/rsi_91x.h
··· 1 - /** 1 + /* 2 2 * Copyright (c) 2017 Redpine Signals Inc. 3 3 * 4 4 * Permission to use, copy, modify, and/or distribute this software for any