sd-network: rename operstates 'down' -> 'off' and 'up' -> 'no-carrier'

[elogind.git] / src / systemd / sd-network.h

diff --git a/src/systemd/sd-network.h b/src/systemd/sd-network.h
index 49034e84d02150345a13f2c5a4b33afea24f8117..dede7aea3de76a5364002c830040d98a0ef18a4f 100644 (file)
--- a/src/systemd/sd-network.h
+++ b/src/systemd/sd-network.h
@@ -78,7 +78,13 @@ int sd_network_get_ntp(char ***addr);
 int sd_network_link_get_state(int ifindex, char **state);
 
 /* Get operatinal state from ifindex.
- * Possible states: down, up, dormant, carrier, degraded, routable
+ * Possible states:
+ *   off: the device is powered down
+ *   no-carrier: the device is powered up, but it does not yet have a carrier
+ *   dormant: the device has a carrier, but is not yet ready for normal traffic
+ *   carrier: the link has a carrier
+ *   degraded: the link has carrier and addresses valid on the local link configured
+ *   routable: the link has carrier and routable address configured
  * Possible return codes:
  *   -ENODATA: networkd is not aware of the link
  */