korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-24 12:44:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

ethtool: fix kernel-doc descriptions

Browse Source 
Fix missing or incorrect function argument and struct member descriptions.

Signed-off-by: Michal Kubecek <mkubecek@suse.cz>
Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
Michal Kubecek 2020-01-26 23:11:01 +01:00 committed by David S. Miller
parent 82bc2e4a26
commit d2c4b444fd
2 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
net/ethtool/netlink.c
View File

@ -134,11 +134,12 @@ nla_put_failure:
/** /**
* ethnl_reply_init() - Create skb for a reply and fill device identification * ethnl_reply_init() - Create skb for a reply and fill device identification
* @payload: payload length (without netlink and genetlink header) * @payload: payload length (without netlink and genetlink header)
* @dev: device the reply is about (may be null) * @dev: device the reply is about (may be null)
* @cmd: ETHTOOL_MSG_* message type for reply * @cmd: ETHTOOL_MSG_* message type for reply
* @info: genetlink info of the received packet we respond to * @hdr_attrtype: attribute type for common header
* @ehdrp: place to store payload pointer returned by genlmsg_new() * @info: genetlink info of the received packet we respond to
* @ehdrp: place to store payload pointer returned by genlmsg_new()
* *
* Return: pointer to allocated skb on success, NULL on error * Return: pointer to allocated skb on success, NULL on error
*/ */
@ -188,10 +189,11 @@ static int ethnl_multicast(struct sk_buff *skb, struct net_device *dev)
/** /**
* struct ethnl_dump_ctx - context structure for generic dumpit() callback * struct ethnl_dump_ctx - context structure for generic dumpit() callback
* @ops: request ops of currently processed message type * @ops: request ops of currently processed message type
* @req_info: parsed request header of processed request * @req_info: parsed request header of processed request
* @pos_hash: saved iteration position - hashbucket * @reply_data: data needed to compose the reply
* @pos_idx: saved iteration position - index * @pos_hash: saved iteration position - hashbucket
* @pos_idx: saved iteration position - index
* *
* These parameters are kept in struct netlink_callback as context preserved * These parameters are kept in struct netlink_callback as context preserved
* between iterations. They are initialized by ethnl_default_start() and used * between iterations. They are initialized by ethnl_default_start() and used
@ -268,9 +270,9 @@ out:
/** /**
* ethnl_init_reply_data() - Initialize reply data for GET request * ethnl_init_reply_data() - Initialize reply data for GET request
* @req_info: pointer to embedded struct ethnl_req_info * @reply_data: pointer to embedded struct ethnl_reply_data
* @ops: instance of struct ethnl_request_ops describing the layout * @ops: instance of struct ethnl_request_ops describing the layout
* @dev: network device to initialize the reply for * @dev: network device to initialize the reply for
* *
* Fills the reply data part with zeros and sets the dev member. Must be called * Fills the reply data part with zeros and sets the dev member. Must be called
* before calling the ->fill_reply() callback (for each iteration when handling * before calling the ->fill_reply() callback (for each iteration when handling

1
net/ethtool/strset.c
View File

@ -85,6 +85,7 @@ get_stringset_policy[ETHTOOL_A_STRINGSET_MAX + 1] = {
/** /**
* strset_include() - test if a string set should be included in reply * strset_include() - test if a string set should be included in reply
* @info: parsed client request
* @data: pointer to request data structure * @data: pointer to request data structure
* @id: id of string set to check (ETH_SS_* constants) * @id: id of string set to check (ETH_SS_* constants)
*/ */