sd-networkd: rename link_get_state to link_get_setup_state

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

diff --git a/src/systemd/sd-network.h b/src/systemd/sd-network.h
index 49034e84d02150345a13f2c5a4b33afea24f8117..47731c2620cf4a75bf011b8964543c040deaa8d6 100644 (file)
--- a/src/systemd/sd-network.h
+++ b/src/systemd/sd-network.h
@@ -64,7 +64,7 @@ int sd_network_get_dns(char ***addr);
  * reperesentations of IP addresses */
 int sd_network_get_ntp(char ***addr);
 
-/* Get state from ifindex.
+/* Get setup state from ifindex.
  * Possible states:
  *   pending: udev is still processing the link, we don't yet know if we will manage it
  *   failed: networkd failed to manage the link
@@ -75,10 +75,16 @@ int sd_network_get_ntp(char ***addr);
  * Possible return codes:
  *   -ENODATA: networkd is not aware of the link
  */
-int sd_network_link_get_state(int ifindex, char **state);
+int sd_network_link_get_setup_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
  */