Improve comments for the guest-related sample configuration files.

pgj · Apr 27, 2022 · 55c1610 · 55c1610
1 parent 238ddbb
commit 55c1610
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/etc/interfaces.conf.sample b/etc/interfaces.conf.sample
@@ -1,7 +1,11 @@
 # This is an iface stanza for interfaces(5) with relatively sane
 # defaults.  Consult http://manpages.org/etc-network-interfaces/5 for
-# more.  The purpose is to bring up an interface which would be the
-# default gateway.
+# more.
+#
+# The purpose is to bring up an interface on the guest which would be
+# the default gateway for the host.  Here, `eth0` is the networking
+# interface of the virtual Ethernet card.  Change these values only if
+# the 10.0.0.0/24 network is not suitable.
 
 iface eth0 inet static
   address 10.0.0.1

diff --git a/etc/udhcpd.conf.sample b/etc/udhcpd.conf.sample
@@ -1,8 +1,12 @@
 # This is configuration file for udhcpd(8) with relatively sane
 # defaults.  Consult https://udhcp.busybox.net/udhcpd.conf for more.
-# The interface should match with the one defined in the
-# interfaces.conf file: router is the address and subnet is the
-# netmask.
+#
+# The value of `interface` should match with the one defined in the
+# interfaces.conf file: `interface` should be exactly the same,
+# `router` should correspond to `address` and `subnet` is the
+# `netmask`.  According to these settings below, the IP addresses are
+# handed out for the 10.0.0.0/24 network.  Change these only if this
+# is not suitable.
 
 start		10.0.0.2
 end		10.0.0.254