Skip to content

Commit d2c4b44

Browse files
mkubecekdavem330
authored andcommitted
ethtool: fix kernel-doc descriptions
Fix missing or incorrect function argument and struct member descriptions. Signed-off-by: Michal Kubecek <[email protected]> Signed-off-by: David S. Miller <[email protected]>
1 parent 82bc2e4 commit d2c4b44

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

net/ethtool/netlink.c

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,12 @@ int ethnl_fill_reply_header(struct sk_buff *skb, struct net_device *dev,
134134

135135
/**
136136
* ethnl_reply_init() - Create skb for a reply and fill device identification
137-
* @payload: payload length (without netlink and genetlink header)
138-
* @dev: device the reply is about (may be null)
139-
* @cmd: ETHTOOL_MSG_* message type for reply
140-
* @info: genetlink info of the received packet we respond to
141-
* @ehdrp: place to store payload pointer returned by genlmsg_new()
137+
* @payload: payload length (without netlink and genetlink header)
138+
* @dev: device the reply is about (may be null)
139+
* @cmd: ETHTOOL_MSG_* message type for reply
140+
* @hdr_attrtype: attribute type for common header
141+
* @info: genetlink info of the received packet we respond to
142+
* @ehdrp: place to store payload pointer returned by genlmsg_new()
142143
*
143144
* Return: pointer to allocated skb on success, NULL on error
144145
*/
@@ -188,10 +189,11 @@ static int ethnl_multicast(struct sk_buff *skb, struct net_device *dev)
188189

189190
/**
190191
* struct ethnl_dump_ctx - context structure for generic dumpit() callback
191-
* @ops: request ops of currently processed message type
192-
* @req_info: parsed request header of processed request
193-
* @pos_hash: saved iteration position - hashbucket
194-
* @pos_idx: saved iteration position - index
192+
* @ops: request ops of currently processed message type
193+
* @req_info: parsed request header of processed request
194+
* @reply_data: data needed to compose the reply
195+
* @pos_hash: saved iteration position - hashbucket
196+
* @pos_idx: saved iteration position - index
195197
*
196198
* These parameters are kept in struct netlink_callback as context preserved
197199
* between iterations. They are initialized by ethnl_default_start() and used
@@ -268,9 +270,9 @@ static int ethnl_default_parse(struct ethnl_req_info *req_info,
268270

269271
/**
270272
* ethnl_init_reply_data() - Initialize reply data for GET request
271-
* @req_info: pointer to embedded struct ethnl_req_info
272-
* @ops: instance of struct ethnl_request_ops describing the layout
273-
* @dev: network device to initialize the reply for
273+
* @reply_data: pointer to embedded struct ethnl_reply_data
274+
* @ops: instance of struct ethnl_request_ops describing the layout
275+
* @dev: network device to initialize the reply for
274276
*
275277
* Fills the reply data part with zeros and sets the dev member. Must be called
276278
* before calling the ->fill_reply() callback (for each iteration when handling

net/ethtool/strset.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ get_stringset_policy[ETHTOOL_A_STRINGSET_MAX + 1] = {
8585

8686
/**
8787
* strset_include() - test if a string set should be included in reply
88+
* @info: parsed client request
8889
* @data: pointer to request data structure
8990
* @id: id of string set to check (ETH_SS_* constants)
9091
*/

0 commit comments

Comments
 (0)