From d2c4b444fd13f4699ab8c4c49062cd2c7516c241 Mon Sep 17 00:00:00 2001 From: Michal Kubecek Date: Sun, 26 Jan 2020 23:11:01 +0100 Subject: [PATCH] ethtool: fix kernel-doc descriptions Fix missing or incorrect function argument and struct member descriptions. Signed-off-by: Michal Kubecek Signed-off-by: David S. Miller --- net/ethtool/netlink.c | 26 ++++++++++++++------------ net/ethtool/strset.c | 1 + 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/net/ethtool/netlink.c b/net/ethtool/netlink.c index 86b79f9bc08d..0af43bbdb9b2 100644 --- a/net/ethtool/netlink.c +++ b/net/ethtool/netlink.c @@ -134,11 +134,12 @@ nla_put_failure: /** * ethnl_reply_init() - Create skb for a reply and fill device identification - * @payload: payload length (without netlink and genetlink header) - * @dev: device the reply is about (may be null) - * @cmd: ETHTOOL_MSG_* message type for reply - * @info: genetlink info of the received packet we respond to - * @ehdrp: place to store payload pointer returned by genlmsg_new() + * @payload: payload length (without netlink and genetlink header) + * @dev: device the reply is about (may be null) + * @cmd: ETHTOOL_MSG_* message type for reply + * @hdr_attrtype: attribute type for common header + * @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 */ @@ -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 - * @ops: request ops of currently processed message type - * @req_info: parsed request header of processed request - * @pos_hash: saved iteration position - hashbucket - * @pos_idx: saved iteration position - index + * @ops: request ops of currently processed message type + * @req_info: parsed request header of processed request + * @reply_data: data needed to compose the reply + * @pos_hash: saved iteration position - hashbucket + * @pos_idx: saved iteration position - index * * These parameters are kept in struct netlink_callback as context preserved * 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 - * @req_info: pointer to embedded struct ethnl_req_info - * @ops: instance of struct ethnl_request_ops describing the layout - * @dev: network device to initialize the reply for + * @reply_data: pointer to embedded struct ethnl_reply_data + * @ops: instance of struct ethnl_request_ops describing the layout + * @dev: network device to initialize the reply for * * 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 diff --git a/net/ethtool/strset.c b/net/ethtool/strset.c index 82a059c13c1c..948d967f1eca 100644 --- a/net/ethtool/strset.c +++ b/net/ethtool/strset.c @@ -85,6 +85,7 @@ get_stringset_policy[ETHTOOL_A_STRINGSET_MAX + 1] = { /** * strset_include() - test if a string set should be included in reply + * @info: parsed client request * @data: pointer to request data structure * @id: id of string set to check (ETH_SS_* constants) */