Thread (18 messages) 18 messages, 5 authors, 2024-11-12

Re: [PATCH man-pages v2] rtnetlink.7: Document struct ifa_cacheinfo

From: Kuniyuki Iwashima <hidden>
Date: 2024-11-12 23:33:37
Also in: netdev

From: Alejandro Colomar <alx@kernel.org>
Date: Wed, 13 Nov 2024 00:26:15 +0100
quoted
diff --git a/man/man7/rtnetlink.7 b/man/man7/rtnetlink.7
index 86ed459bb..ed08834b0 100644
--- a/man/man7/rtnetlink.7
+++ b/man/man7/rtnetlink.7
@@ -176,7 +176,24 @@ IFA_BROADCAST:raw protocol address:broadcast address
 IFA_ANYCAST:raw protocol address:anycast address
 IFA_CACHEINFO:struct ifa_cacheinfo:Address information
 .TE
-.\" FIXME Document struct ifa_cacheinfo
+.IP
+.EX
I expect users that need to use this struct to also need to include the
header that defines it, right?
rtnetlink.7 tells #include <linux/rtnetlink.h> is needed in SYNOPSIS
and the header internally includes <linux/if_addr.h>, so users need
not include it explicitly for struct ifa_cacheinfo.

We should probably specify it by using
an #include.  What do you think?
So I think we need not mention linux/if_addr.h here.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help