Several of the tap_push_*() functions have doc comments claiming they take
the context pointer, but don't. Some (tap_push_uh[46]) were broken fairly
recently, but others (tap_push_ip[46]h) have been broken for a long time.
Regardless, fix all the doc comments.
Reported-by: Stefano Brivio
Fixes: 82a839be9 ("tap: break out building of udp header from tap_udp4_send function")
Fixes: 87e6a4644 ("tap: break out building of udp header from tap_udp6_send function")
Fixes: 2dbc622f5 ("tap: Split tap_ip4_send() into UDP and ICMP variants")
Fixes: 9d8dd8b6f ("tap: Split tap_ip6_send() into UDP and ICMP variants")
Signed-off-by: David Gibson
---
tap.c | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
v2:
* Added missing "Fixes" tags from v1's commit message.
diff --git a/tap.c b/tap.c
index 95d309bd..f3d1f660 100644
--- a/tap.c
+++ b/tap.c
@@ -188,7 +188,7 @@ void *tap_push_l2h(const struct ctx *c, void *buf, uint16_t proto)
/**
* tap_push_ip4h() - Build IPv4 header for inbound packet, with checksum
- * @c: Execution context
+ * @ip4h: Buffer in which to build the IPv4 header
* @src: IPv4 source address
* @dst: IPv4 destination address
* @l4len: IPv4 payload length
@@ -217,7 +217,7 @@ void *tap_push_ip4h(struct iphdr *ip4h, struct in_addr src,
/**
* tap_push_uh4() - Build UDPv4 header with checksum
- * @c: Execution context
+ * @uh: Buffer in which to build the UDP header
* @src: IPv4 source address
* @sport: UDP source port
* @dst: IPv4 destination address
@@ -293,7 +293,7 @@ void tap_icmp4_send(const struct ctx *c, struct in_addr src, struct in_addr dst,
/**
* tap_push_ip6h() - Build IPv6 header for inbound packet
- * @c: Execution context
+ * @ip6h: Buffer in which to build the IPv6 header
* @src: IPv6 source address
* @dst: IPv6 destination address
* @l4len: L4 payload length
@@ -319,7 +319,7 @@ void *tap_push_ip6h(struct ipv6hdr *ip6h,
/**
* tap_push_uh6() - Build UDPv6 header with checksum
- * @c: Execution context
+ * @uh: Buffer in which to build the UDP header
* @src: IPv6 source address
* @sport: UDP source port
* @dst: IPv6 destination address
--
2.51.0