From d8b0020ddecfcf0d993bcfd45314ba8785d09fb1 Mon Sep 17 00:00:00 2001
From: Jerome Forissier <jerome.forissier@linaro.org>
Date: Tue, 3 Dec 2024 14:50:51 +0100
Subject: [PATCH] doc: environment: NET_LWIP dhcp sets ipaddrN, netmaskN and
gatewayipN
Document environment variables set by the dhcp command when the network
stack is lwIP.
Signed-off-by: Jerome Forissier <jerome.forissier@linaro.org>
---
doc/usage/environment.rst | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/doc/usage/environment.rst b/doc/usage/environment.rst
index 7bd9ffce8d..30fc16794f 100644
--- a/doc/usage/environment.rst
+++ b/doc/usage/environment.rst
@@ -499,12 +499,12 @@ Automatically updated variables
-------------------------------
The following environment variables may be used and automatically
-updated by the network boot commands ("bootp" and "rarpboot"),
+updated by the network boot commands ("bootp", "dhcp" and "rarpboot"),
depending the information provided by your boot server:
-========= ===================================================
+========== ===================================================================
Variable Notes
-========= ===================================================
+========== ===================================================================
bootfile see above
dnsip IP address of your Domain Name Server
dnsip2 IP address of your secondary Domain Name Server
@@ -514,7 +514,10 @@ ipaddr See above
netmask Subnet Mask
rootpath Pathname of the root filesystem on the NFS server
serverip see above
-========= ===================================================
+ipaddrN IP address for interface N (>0) (NET_LWIP dhcp only)
+netmaskN Subnet mask for interface N (>0) (NET_LWIP dhcp only)
+gatewayipN IP address of the Gateway for interface N (>0) (NET_LWIP dhcp only)
+========== ===================================================================
Special environment variables
--
2.39.5