diff mbox

[OSSTEST,30/35] netboot: mg-netgrub-loader-update: Add some more docs

Message ID 1484914764-20861-31-git-send-email-ian.jackson@eu.citrix.com (mailing list archive)
State New, archived
Headers show

Commit Message

Ian Jackson Jan. 20, 2017, 12:19 p.m. UTC 
Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
---
 mg-netgrub-loader-update | 12 ++++++++++++
 1 file changed, 12 insertions(+)
diff mbox

Patch

diff --git a/mg-netgrub-loader-update b/mg-netgrub-loader-update
index 73deb19..22ef67c 100755
--- a/mg-netgrub-loader-update
+++ b/mg-netgrub-loader-update
@@ -10,6 +10,18 @@ 
 # (where EE:EE:EE:EE:EE:EE is the MAC address)
 # (or whatever else is specified in TftpNetGrubTemplates).
 
+# Running this script is optional.  Any approach will do which
+# arranges for the dhcp server to provide `filename' referring to a
+# copy of grub which will eventually load the config file specified by
+# TftpNetGrubPattern.  An example would be an appropriate
+# debian-installer netboot grub image, which will load 
+#   $c{TftpPath}/debian-installer/arm64/grub/grub.cfg
+# which could for example be made to contain
+#   configfile Netgrub.cfg/${net_default_mac}
+
+# This script does not currently support non-default Tftp scopes.
+# (See README.)
+
 # This is part of "osstest", an automated testing framework for Xen.
 # Copyright (C) 2015 Citrix Inc.
 #