From: Simon Wunderlich <sw@simonwunderlich.de>
To: kuba@kernel.org, davem@davemloft.net
Cc: netdev@vger.kernel.org, b.a.t.m.a.n@lists.open-mesh.org,
Sven Eckelmann <sven@narfation.org>,
Simon Wunderlich <sw@simonwunderlich.de>
Subject: [PATCH 4/4] batman-adv: Fix names for kernel-doc blocks
Date: Tue, 2 Feb 2021 18:40:36 +0100 [thread overview]
Message-ID: <20210202174037.7081-5-sw@simonwunderlich.de> (raw)
In-Reply-To: <20210202174037.7081-1-sw@simonwunderlich.de>
From: Sven Eckelmann <sven@narfation.org>
kernel-doc can only correctly identify the documented function or struct
when the name in the first kernel-doc line references it. But some of the
kernel-doc blocks referenced a different function/struct then it actually
documented.
Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
---
net/batman-adv/distributed-arp-table.c | 2 +-
net/batman-adv/multicast.c | 2 +-
net/batman-adv/netlink.c | 4 ++--
net/batman-adv/tp_meter.c | 2 +-
net/batman-adv/types.h | 3 ++-
5 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/net/batman-adv/distributed-arp-table.c b/net/batman-adv/distributed-arp-table.c
index 61a6cfef2742..fcabd6b1e77f 100644
--- a/net/batman-adv/distributed-arp-table.c
+++ b/net/batman-adv/distributed-arp-table.c
@@ -1564,7 +1564,7 @@ static int batadv_dat_get_dhcp_message_type(struct sk_buff *skb)
}
/**
- * batadv_dat_get_dhcp_yiaddr() - get yiaddr from a DHCP packet
+ * batadv_dat_dhcp_get_yiaddr() - get yiaddr from a DHCP packet
* @skb: the DHCP packet to parse
* @buf: a buffer to store the yiaddr in
*
diff --git a/net/batman-adv/multicast.c b/net/batman-adv/multicast.c
index 8db5d285c433..ad216c42406f 100644
--- a/net/batman-adv/multicast.c
+++ b/net/batman-adv/multicast.c
@@ -828,7 +828,7 @@ batadv_mcast_bridge_log(struct batadv_priv *bat_priv,
}
/**
- * batadv_mcast_flags_logs() - output debug information about mcast flag changes
+ * batadv_mcast_flags_log() - output debug information about mcast flag changes
* @bat_priv: the bat priv with all the soft interface information
* @flags: TVLV flags indicating the new multicast state
*
diff --git a/net/batman-adv/netlink.c b/net/batman-adv/netlink.c
index 8eef71a62a5a..c80527b879a7 100644
--- a/net/batman-adv/netlink.c
+++ b/net/batman-adv/netlink.c
@@ -193,7 +193,7 @@ static int batadv_netlink_mesh_fill_ap_isolation(struct sk_buff *msg,
}
/**
- * batadv_option_set_ap_isolation() - Set ap_isolation from genl msg
+ * batadv_netlink_set_mesh_ap_isolation() - Set ap_isolation from genl msg
* @attr: parsed BATADV_ATTR_AP_ISOLATION_ENABLED attribute
* @bat_priv: the bat priv with all the soft interface information
*
@@ -757,7 +757,7 @@ batadv_netlink_tp_meter_start(struct sk_buff *skb, struct genl_info *info)
}
/**
- * batadv_netlink_tp_meter_start() - Cancel a running tp_meter session
+ * batadv_netlink_tp_meter_cancel() - Cancel a running tp_meter session
* @skb: received netlink message
* @info: receiver information
*
diff --git a/net/batman-adv/tp_meter.c b/net/batman-adv/tp_meter.c
index e61925f19f66..72ec4aab4813 100644
--- a/net/batman-adv/tp_meter.c
+++ b/net/batman-adv/tp_meter.c
@@ -131,7 +131,7 @@ static u32 batadv_tp_cwnd(u32 base, u32 increment, u32 min)
}
/**
- * batadv_tp_updated_cwnd() - update the Congestion Windows
+ * batadv_tp_update_cwnd() - update the Congestion Windows
* @tp_vars: the private data of the current TP meter session
* @mss: maximum segment size of transmission
*
diff --git a/net/batman-adv/types.h b/net/batman-adv/types.h
index 65985e262cde..aae7366bb679 100644
--- a/net/batman-adv/types.h
+++ b/net/batman-adv/types.h
@@ -228,7 +228,8 @@ struct batadv_hard_iface {
};
/**
- * struct batadv_orig_ifinfo - B.A.T.M.A.N. IV private orig_ifinfo members
+ * struct batadv_orig_ifinfo_bat_iv - B.A.T.M.A.N. IV private orig_ifinfo
+ * members
*/
struct batadv_orig_ifinfo_bat_iv {
/**
--
2.20.1
next prev parent reply other threads:[~2021-02-02 17:40 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-02 17:40 [PATCH 0/4] pull request for net-next: batman-adv 2021-02-02 Simon Wunderlich
2021-02-02 17:40 ` [PATCH 1/4] batman-adv: Start new development cycle Simon Wunderlich
2021-02-04 0:33 ` Jakub Kicinski
2021-02-04 7:41 ` Sven Eckelmann
2021-02-02 17:40 ` [PATCH 2/4] batman-adv: Update copyright years for 2021 Simon Wunderlich
2021-02-04 0:35 ` Jakub Kicinski
2021-02-04 0:37 ` Randy Dunlap
2021-02-04 7:54 ` Sven Eckelmann
2021-02-04 19:58 ` Jakub Kicinski
2021-02-05 7:47 ` Sven Eckelmann
2021-02-05 19:37 ` Jakub Kicinski
2021-02-02 17:40 ` [PATCH 3/4] batman-adv: Avoid sizeof on flexible structure Simon Wunderlich
2021-02-02 17:40 ` Simon Wunderlich [this message]
-- strict thread matches above, loose matches on Subject: below --
2021-02-08 16:59 [PATCH 0/4] pull request for net-next: batman-adv 2021-02-08 Simon Wunderlich
2021-02-08 16:59 ` [PATCH 4/4] batman-adv: Fix names for kernel-doc blocks Simon Wunderlich
2021-02-08 18:00 ` Randy Dunlap
2021-02-08 19:35 ` Jakub Kicinski
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210202174037.7081-5-sw@simonwunderlich.de \
--to=sw@simonwunderlich.de \
--cc=b.a.t.m.a.n@lists.open-mesh.org \
--cc=davem@davemloft.net \
--cc=kuba@kernel.org \
--cc=netdev@vger.kernel.org \
--cc=sven@narfation.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).