doc: Add notes about the dhcp and autoip configuration modes

greezybacon · greezybacon · commit ea3b79dae6e0 · 2022-11-07T18:24:06.000-06:00
diff --git a/docs/library/network.rst b/docs/library/network.rst
@@ -122,6 +122,24 @@ parameter should be `id`.
 
         nic.ifconfig(('192.168.0.4', '255.255.255.0', '192.168.0.1', '8.8.8.8'))
 
+.. method:: AbstractNIC.ifconfig('dhcp')
+
+       Request network IP address configuration from a DHCP server on the network.
+
+       As implemented, this method will block until an address is successfully
+       leased from the DHCP server and will raise OSError if a timeout occurs.
+
+.. method:: AbstractNIC.ifconfig('autoip')
+
+       Request stateless network IP address autoconfiguration. For IPv4, the
+       adapter will choose a random address in the 169.254.0.0/16 subnet and
+       verify it does not conflict with an existing address on the network.
+
+       This is currently implemented only for the LWIP software IP stack.
+
+       As implemented, autoconfiguration will run in the background. Use a wait
+       loop before running code requring the autoconfigured address.
+
 .. method:: AbstractNIC.config('param')
             AbstractNIC.config(param=value, ...)
 
