docs: add code comment to explain the meaning of the fields in rtnl_addr_cacheinfo

Signed-off-by: Thomas Haller <thaller@redhat.com>

diff --git a/include/netlink-private/types.h b/include/netlink-private/types.h
index 6f213115935310ed5141aff71f00c992e1f070d4..3ff4fe1aadf385e2e5753c5581142e2757f27af6 100644 (file)
--- a/include/netlink-private/types.h
+++ b/include/netlink-private/types.h
@@ -225,16 +225,16 @@ struct rtnl_neigh
 
 struct rtnl_addr_cacheinfo
 {
-       /* Preferred lifetime in seconds */
+       /* Preferred lifetime in seconds, ticking from when the message gets constructed */
        uint32_t aci_prefered;
 
-       /* Valid lifetime in seconds */
+       /* Valid lifetime in seconds, ticking from when the message gets constructed */
        uint32_t aci_valid;
 
-       /* Timestamp of creation in 1/100s since boottime */
+       /* Timestamp of creation in 1/100s since boottime, clock_gettime(CLOCK_MONOTONIC) */
        uint32_t aci_cstamp;
 
-       /* Timestamp of last update in 1/100s since boottime */
+       /* Timestamp of last update in 1/100s since boottime, clock_gettime(CLOCK_MONOTONIC) */
        uint32_t aci_tstamp;
 };