summaryrefslogtreecommitdiff
path: root/morphlib
diff options
context:
space:
mode:
authorPete Fotheringham <pete.fotheringham@codethink.co.uk>2014-12-12 11:30:13 +0000
committerPete Fotheringham <pete.fotheringham@codethink.co.uk>2014-12-15 09:16:13 +0000
commite93d7ed826431729ad458df643470b46c0a6865f (patch)
tree48e8eb1acdbe3d4e4b8b5a9f6cb44a253d0701f1 /morphlib
parent902019f72905db694feb97cdb4f027d1576d3933 (diff)
downloadmorph-e93d7ed826431729ad458df643470b46c0a6865f.tar.gz
Document BOOTLOADER_INSTALL and BOOTLOADER_CONFIG_FORMAT write extension parameters
Diffstat (limited to 'morphlib')
-rw-r--r--morphlib/exts/kvm.write.help16
-rw-r--r--morphlib/exts/rawdisk.write.help16
-rw-r--r--morphlib/exts/virtualbox-ssh.write.help16
-rw-r--r--morphlib/writeexts.py5
4 files changed, 50 insertions, 3 deletions
diff --git a/morphlib/exts/kvm.write.help b/morphlib/exts/kvm.write.help
index 6df6c53c..8ddcb89c 100644
--- a/morphlib/exts/kvm.write.help
+++ b/morphlib/exts/kvm.write.help
@@ -47,5 +47,21 @@ help: |
DTB in the built system image . The deployment will fail if `path` does
not exist.
+ * BOOTLOADER_INSTALL=value: the bootloader to be installed
+ **(MANDATORY)** for non-x86 systems
+
+ allowed values =
+ - 'extlinux' (default) - the extlinux bootloader will
+ be installed
+ - 'none' - no bootloader will be installed by `morph deploy`. A
+ bootloader must be installed manually. This value must be used when
+ deploying non-x86 systems such as ARM.
+
+ * BOOTLOADER_CONFIG_FORMAT=value: the bootloader format to be used.
+ If not specified for x86-32 and x86-64 systems, 'extlinux' will be used
+
+ allowed values =
+ - 'extlinux'
+
(See `morph help deploy` for details of how to pass parameters to write
extensions)
diff --git a/morphlib/exts/rawdisk.write.help b/morphlib/exts/rawdisk.write.help
index fe47c890..d6c78573 100644
--- a/morphlib/exts/rawdisk.write.help
+++ b/morphlib/exts/rawdisk.write.help
@@ -39,5 +39,21 @@ help: |
DTB in the built system image . The deployment will fail if `path` does
not exist.
+ * BOOTLOADER_INSTALL=value: the bootloader to be installed
+ **(MANDATORY)** for non-x86 systems
+
+ allowed values =
+ - 'extlinux' (default) - the extlinux bootloader will
+ be installed
+ - 'none' - no bootloader will be installed by `morph deploy`. A
+ bootloader must be installed manually. This value must be used when
+ deploying non-x86 systems such as ARM.
+
+ * BOOTLOADER_CONFIG_FORMAT=value: the bootloader format to be used.
+ If not specified for x86-32 and x86-64 systems, 'extlinux' will be used
+
+ allowed values =
+ - 'extlinux'
+
(See `morph help deploy` for details of how to pass parameters to write
extensions)
diff --git a/morphlib/exts/virtualbox-ssh.write.help b/morphlib/exts/virtualbox-ssh.write.help
index 7131f8b8..4dddd987 100644
--- a/morphlib/exts/virtualbox-ssh.write.help
+++ b/morphlib/exts/virtualbox-ssh.write.help
@@ -46,6 +46,22 @@ help: |
DTB in the built system image . The deployment will fail if `path` does
not exist.
+ * BOOTLOADER_INSTALL=value: the bootloader to be installed
+ **(MANDATORY)** for non-x86 systems
+
+ allowed values =
+ - 'extlinux' (default) - the extlinux bootloader will
+ be installed
+ - 'none' - no bootloader will be installed by `morph deploy`. A
+ bootloader must be installed manually. This value must be used when
+ deploying non-x86 systems such as ARM.
+
+ * BOOTLOADER_CONFIG_FORMAT=value: the bootloader format to be used.
+ If not specified for x86-32 and x86-64 systems, 'extlinux' will be used
+
+ allowed values =
+ - 'extlinux'
+
* AUTOSTART=<VALUE> - boolean. If it is set, the VM will be started when
it has been deployed.
diff --git a/morphlib/writeexts.py b/morphlib/writeexts.py
index 91936f64..068f0741 100644
--- a/morphlib/writeexts.py
+++ b/morphlib/writeexts.py
@@ -545,9 +545,8 @@ class WriteExtension(cliapp.Application):
'''Does the user want to generate a bootloader config?
The user may set $BOOTLOADER_CONFIG_FORMAT to the desired
- format (u-boot or extlinux). If not set, extlinux is the
- default but will be generated on x86-32 and x86-64, but not
- otherwise.
+ format. 'extlinux' is the only allowed value, and is the default
+ value for x86-32 and x86-64.
'''