summaryrefslogtreecommitdiffstats
path: root/Documentation/user
diff options
context:
space:
mode:
authorRoland Hieber <rhi@pengutronix.de>2023-02-06 14:45:51 +0100
committerSascha Hauer <s.hauer@pengutronix.de>2023-02-08 09:23:15 +0100
commit05ab8dd0064b626b65d6e45f106c56417e3b46f0 (patch)
tree4e6887583de46b3e7922628f493cbd4231370639 /Documentation/user
parentb0ad40ee6e5eceeb27e8f29ad54f80c75699e067 (diff)
downloadbarebox-05ab8dd0064b626b65d6e45f106c56417e3b46f0.tar.gz
barebox-05ab8dd0064b626b65d6e45f106c56417e3b46f0.tar.xz
Documentation: networking: improve net.* variable description
Signed-off-by: Roland Hieber <rhi@pengutronix.de> Link: https://lore.barebox.org/20230206134551.3227602-1-rhi@pengutronix.de Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'Documentation/user')
-rw-r--r--Documentation/user/booting-linux.rst2
-rw-r--r--Documentation/user/networking.rst10
2 files changed, 8 insertions, 4 deletions
diff --git a/Documentation/user/booting-linux.rst b/Documentation/user/booting-linux.rst
index 60babb513c..1a95f87e77 100644
--- a/Documentation/user/booting-linux.rst
+++ b/Documentation/user/booting-linux.rst
@@ -232,6 +232,8 @@ device where the entry is found on. This makes it possible to use the same rootf
image on different devices without having to specify a different root= option each
time.
+.. _booting_linux_net:
+
Network boot
------------
diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
index 9231ebde56..2306cb6a60 100644
--- a/Documentation/user/networking.rst
+++ b/Documentation/user/networking.rst
@@ -45,15 +45,17 @@ device:
| | | any directly visible subnet. May be set |
| | | automatically by DHCP. |
+------------------------------+--------------+------------------------------------------------+
-| global.net.server | hostname or | The default server. If unspecified, may be set |
-| | ipv4 address | by DHCP |
+| global.net.server | hostname or | The default server used by the defaultenv boot |
+| | ipv4 address | scripts for NFS and TFTP; see |
+| | | :ref:`booting_linux_net`. |
+| | | If unspecified, may be set by DHCP. |
+------------------------------+--------------+------------------------------------------------+
| global.net.nameserver | ipv4 address | The DNS server used for resolving host names. |
-| | | May be set by DHCP |
+| | | May be set by DHCP. |
+------------------------------+--------------+------------------------------------------------+
| global.net.ifup_force_detect | boolean | Set to true if your network device is not |
| | | detected automatically during start (i.e. for |
-| | | USB network adapters) |
+| | | USB network adapters). |
+------------------------------+--------------+------------------------------------------------+
The first step for networking is configuring the network device. The network