Commit 0dd1805f authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

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: default avatarJakub Kicinski <kuba@kernel.org>
parents 98400367 04be3c95

include/net/bonding.h

+1 −1
Original line number Diff line number Diff line
@@ -277,7 +277,7 @@ struct bond_vlan_tag { 
	unsigned short	vlan_id;

};



/**

/*

 * Returns NULL if the net_device does not belong to any of the bond's slaves

 *

 * Caller must hold bond lock for read

include/net/cfg802154.h

+2 −1
Original line number Diff line number Diff line
@@ -170,7 +170,8 @@ wpan_phy_cca_cmp(const struct wpan_phy_cca *a, const struct wpan_phy_cca *b) 
}



/**

 * @WPAN_PHY_FLAG_TRANSMIT_POWER: Indicates that transceiver will support

 * enum wpan_phy_flags - WPAN PHY state flags

 * @WPAN_PHY_FLAG_TXPOWER: Indicates that transceiver will support

 *	transmit power setting.

 * @WPAN_PHY_FLAG_CCA_ED_LEVEL: Indicates that transceiver will support cca ed

 *	level setting.

include/net/codel.h

+2 −2
Original line number Diff line number Diff line
@@ -145,8 +145,8 @@ struct codel_vars { 
 * @maxpacket:	largest packet we've seen so far

 * @drop_count:	temp count of dropped packets in dequeue()

 * @drop_len:	bytes of dropped packets in dequeue()

 * ecn_mark:	number of packets we ECN marked instead of dropping

 * ce_mark:	number of packets CE marked because sojourn time was above ce_threshold

 * @ecn_mark:	number of packets we ECN marked instead of dropping

 * @ce_mark:	number of packets CE marked because sojourn time was above ce_threshold

 */

struct codel_stats {

	u32		maxpacket;

include/net/devlink.h

+16 −12
Original line number Diff line number Diff line
@@ -221,7 +221,7 @@ struct devlink_dpipe_field { 
/**

 * struct devlink_dpipe_header - dpipe header object

 * @name: header name

 * @id: index, global/local detrmined by global bit

 * @id: index, global/local determined by global bit

 * @fields: fields

 * @fields_count: number of fields

 * @global: indicates if header is shared like most protocol header
@@ -241,7 +241,7 @@ struct devlink_dpipe_header { 
 * @header_index: header index (packets can have several headers of same

 *		  type like in case of tunnels)

 * @header: header

 * @fieled_id: field index

 * @field_id: field index

 */

struct devlink_dpipe_match {

	enum devlink_dpipe_match_type type;
@@ -256,7 +256,7 @@ struct devlink_dpipe_match { 
 * @header_index: header index (packets can have several headers of same

 *		  type like in case of tunnels)

 * @header: header

 * @fieled_id: field index

 * @field_id: field index

 */

struct devlink_dpipe_action {

	enum devlink_dpipe_action_type type;
@@ -292,7 +292,7 @@ struct devlink_dpipe_value { 
 * struct devlink_dpipe_entry - table entry object

 * @index: index of the entry in the table

 * @match_values: match values

 * @matche_values_count: count of matches tuples

 * @match_values_count: count of matches tuples

 * @action_values: actions values

 * @action_values_count: count of actions values

 * @counter: value of counter
@@ -342,7 +342,9 @@ struct devlink_dpipe_table_ops; 
 */

struct devlink_dpipe_table {

	void *priv;

	/* private: */

	struct list_head list;

	/* public: */

	const char *name;

	bool counters_enabled;

	bool counter_control_extern;
@@ -355,13 +357,13 @@ struct devlink_dpipe_table { 


/**

 * struct devlink_dpipe_table_ops - dpipe_table ops

 * @actions_dump - dumps all tables actions

 * @matches_dump - dumps all tables matches

 * @entries_dump - dumps all active entries in the table

 * @counters_set_update - when changing the counter status hardware sync

 * @actions_dump: dumps all tables actions

 * @matches_dump: dumps all tables matches

 * @entries_dump: dumps all active entries in the table

 * @counters_set_update:  when changing the counter status hardware sync

 *			  maybe needed to allocate/free counter related

 *			  resources

 * @size_get - get size

 * @size_get: get size

 */

struct devlink_dpipe_table_ops {

	int (*actions_dump)(void *priv, struct sk_buff *skb);
@@ -374,8 +376,8 @@ struct devlink_dpipe_table_ops { 


/**

 * struct devlink_dpipe_headers - dpipe headers

 * @headers - header array can be shared (global bit) or driver specific

 * @headers_count - count of headers

 * @headers: header array can be shared (global bit) or driver specific

 * @headers_count: count of headers

 */

struct devlink_dpipe_headers {

	struct devlink_dpipe_header **headers;
@@ -387,7 +389,7 @@ struct devlink_dpipe_headers { 
 * @size_min: minimum size which can be set

 * @size_max: maximum size which can be set

 * @size_granularity: size granularity

 * @size_unit: resource's basic unit

 * @unit: resource's basic unit

 */

struct devlink_resource_size_params {

	u64 size_min;
@@ -457,6 +459,7 @@ struct devlink_flash_notify { 


/**

 * struct devlink_param - devlink configuration parameter data

 * @id: devlink parameter id number

 * @name: name of the parameter

 * @generic: indicates if the parameter is generic or driver specific

 * @type: parameter type
@@ -632,6 +635,7 @@ enum devlink_param_generic_id { 
 * struct devlink_flash_update_params - Flash Update parameters

 * @fw: pointer to the firmware data to update from

 * @component: the flash component to update

 * @overwrite_mask: which types of flash update are supported (may be %0)

 *

 * With the exception of fw, drivers must opt-in to parameters by

 * setting the appropriate bit in the supported_flash_update_params field in

include/net/inet_frag.h

+1 −1
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ struct fqdir { 
};



/**

 * fragment queue flags

 * enum: fragment queue flags

 *

 * @INET_FRAG_FIRST_IN: first fragment has arrived

 * @INET_FRAG_LAST_IN: final fragment has arrived