All of lore.kernel.org
 help / color / mirror / Atom feed
From: Alex Henrie <alexhenrie24@gmail.com>
To: linux-man@vger.kernel.org, kuniyu@amazon.com, alx@kernel.org,
	mtk.manpages@gmail.com, branden@debian.org,
	netdev@vger.kernel.org
Cc: Alex Henrie <alexhenrie24@gmail.com>
Subject: [PATCH man-pages v2] rtnetlink.7: Document struct ifa_cacheinfo
Date: Sun, 10 Nov 2024 23:20:06 -0700	[thread overview]
Message-ID: <20241111062205.207027-1-alexhenrie24@gmail.com> (raw)
In-Reply-To: <20241105041507.1292595-1-alexhenrie24@gmail.com>

struct ifa_cacheinfo contains the address's creation time, update time,
preferred lifetime remaining, and valid lifetime remaining.

Link: <https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/include/uapi/linux/if_addr.h?h=v6.11#n60>
Signed-off-by: Alex Henrie <alexhenrie24@gmail.com>
---
Changes from v1:
- Move link to Link line in commit message
- Add the word "remaining" to clarify that the reported values will
  decrease over time
- Say UINT32_MAX instead of -1
- Add a short paragraph to explain the constraints on the minimum and
  maximum lifetimes

Thanks to Kuniyuki and Alejandro for your feedback.
---
 man/man7/rtnetlink.7 | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

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
+struct ifa_cacheinfo {
+    __u32 ifa_prefered; /* Preferred lifetime remaining, in seconds */
+    __u32 ifa_valid;    /* Valid lifetime remaining, in seconds */
+    __u32 cstamp;       /* Creation timestamp, in hundredths of seconds */
+    __u32 tstamp;       /* Update timestamp, in hundredths of seconds */
+};
+.EE
+.IP
+.I ifa_valid
+cannot be zero, and
+.I ifa_prefered
+cannot be greater than
+.IR ifa_valid .
+A value of
+.B UINT32_MAX
+represents an infinite lifetime.
 .TP
 .B RTM_NEWROUTE
 .TQ
-- 
2.47.0


  parent reply	other threads:[~2024-11-11  6:22 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-05  4:14 [PATCH] rtnetlink.7: Document struct ifa_cacheinfo Alex Henrie
2024-11-05  5:53 ` Kuniyuki Iwashima
2024-11-05 11:33   ` Alejandro Colomar
2024-11-06 17:18     ` Stephen Hemminger
2024-11-06 17:44       ` Alejandro Colomar
2024-11-06 17:48         ` G. Branden Robinson
2024-11-06 17:45       ` G. Branden Robinson
2024-11-06 18:02         ` Alejandro Colomar
2024-11-11  6:17     ` Alex Henrie
2024-11-11  9:34       ` Alejandro Colomar
2024-11-09 16:27 ` Stephen Hemminger
2024-11-11  6:20 ` Alex Henrie [this message]
2024-11-12  1:11   ` [PATCH man-pages v2] " Kuniyuki Iwashima
2024-11-12  7:58     ` Alejandro Colomar
2024-11-12 23:26   ` Alejandro Colomar
2024-11-12 23:33     ` Kuniyuki Iwashima
2024-11-12 23:38       ` Alejandro Colomar
2024-11-12 23:46   ` Alejandro Colomar

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=20241111062205.207027-1-alexhenrie24@gmail.com \
    --to=alexhenrie24@gmail.com \
    --cc=alx@kernel.org \
    --cc=branden@debian.org \
    --cc=kuniyu@amazon.com \
    --cc=linux-man@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    --cc=netdev@vger.kernel.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.