Просмотр исходного кода

ncd: modules: net.ipv4.dhcp: update description

ambrop7 15 лет назад
Родитель
Сommit
1fd4481f32
1 измененных файлов с 6 добавлено и 1 удалено
  1. 6 1
      ncd/modules/net_ipv4_dhcp.c

+ 6 - 1
ncd/modules/net_ipv4_dhcp.c

@@ -21,9 +21,14 @@
  * 
  * @section DESCRIPTION
  * 
- * Physical network interface module.
+ * DHCP client module.
  * 
  * Synopsis: net.ipv4.dhcp(string ifname)
+ * Description:
+ *   Runs a DHCP client on a network interface. When an address is obtained,
+ *   transitions up (but does not assign anything). If the lease times out,
+ *   transitions down.
+ *   The interface must already be up.
  * Variables:
  *   string addr - assigned IP address ("A.B.C.D")
  *   string prefix - address prefix length ("N")