summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNeil Williams <codehelp@debian.org>2015-11-05 10:29:41 +0000
committerNeil Williams <codehelp@debian.org>2015-11-05 10:29:41 +0000
commit534935d2d9a5b702c30ccf44ff5e1cbc4a902e65 (patch)
tree9727c26fbaa5913ede5a98739dfebc5290832500 /doc
parenta6d13b30750b769a366fc976f45a85d921565deb (diff)
downloadvmdebootstrap-534935d2d9a5b702c30ccf44ff5e1cbc4a902e65.tar.gz
Update UEFI docs and fix missing remove_daemon_block section.
Diffstat (limited to 'doc')
-rw-r--r--doc/devel.rst10
-rw-r--r--doc/overview.rst47
2 files changed, 46 insertions, 11 deletions
diff --git a/doc/devel.rst b/doc/devel.rst
index 9f9c340..e5190bb 100644
--- a/doc/devel.rst
+++ b/doc/devel.rst
@@ -71,6 +71,16 @@ is a faster mirror available during the build. This function moves the
specified mirror file aside and uses the nearby mirror. Always use with
:ref:`replace_apt_source`.
+.. _remove_daemon_block:
+
+remove_daemon_block
+-------------------
+
+After using :ref:`disable_daemons`, a policy script remains which needs
+to be removed to allow daemons to start normally when the image itself
+is booted. Use ``remove_daemon_block`` as the next step once package
+installation is complete.
+
.. _replace_apt_source:
replace_apt_source
diff --git a/doc/overview.rst b/doc/overview.rst
index 8a5cb33..f8bee0a 100644
--- a/doc/overview.rst
+++ b/doc/overview.rst
@@ -69,7 +69,7 @@ in the vmdebootstrap log file, if enabled with the ``--log`` option.
.. note:: **grub-legacy** is not supported.
-:file:`vmdebootstrap` also supports **EFI**.
+:file:`vmdebootstrap` also supports **EFI**. See :ref:`uefi`.
Use ``--use-uefi`` to use ``grub-efi`` instead of ``grub-pc``. If the
default 5Mb is not enough space, use the ``--esp-size`` option to
@@ -78,6 +78,41 @@ not supported as it would need to be done after boot. If the system you
are creating is for more than just a VM or live image, you will likely
need a larger ESP, up to 500Mb.
+.. index: uefi
+
+.. _uefi:
+
+UEFI
+====
+
+UEFI support requires Grub and ``vmdebootstrap`` contains a configuration
+table of the UEFI components required for supported architectures.
+
+There are issues with running UEFI with QEMU on some architectures and
+a customisation script is available for amd64::
+
+ # vmdebootstrap --verbose --image jessie-uefi.img --grub --use-uefi \
+ --customize ./examples/qemu-efi-bochs-drm.sh
+
+``vmdebootstrap`` supports UEFI for images and for squashfs but the necessary
+behaviour is different. With an image, an ESP vfat partition is created.
+With squashfs, the EFI files will be copied into an ``efi/`` directory
+in the squashfs output directory instead.
+
+There is EFI firmware available to use with QEMU when testing images built
+using the UEFI support, but this software is in Debian non-free due to patent
+concerns. If you choose to install ``ovmf`` to test UEFI builds, a
+secondary change is also needed to symlink the provided ``OVMF.fd`` to
+the file required by QEMU: ``bios-256k.bin`` and then tell QEMU about
+the location of this file with the -L option::
+
+ $ qemu-system-x86_64 -L /usr/share/ovmf/ -machine accel=kvm \\
+ -m 4096 -smp 2 -drive format=raw,file=test.img
+
+To test the image, also consider using the ``qemu-wrapper.sh``::
+
+ $ /usr/share/vmdebootstrap/qemu-wrapper.sh jessie-uefi.img amd64 /usr/share/ovmf/
+
.. index: uboot
.. _uboot:
@@ -167,16 +202,6 @@ calls where the ``--owner`` option is used, e.g.::
$ /usr/share/vmdebootstrap/qemu-wrapper.sh jessie.img amd64
-There is EFI firmware available to use with QEMU when testing images built
-using the UEFI support, but this software is in Debian non-free due to patent
-concerns. If you choose to install ``ovmf`` to test UEFI builds, a
-secondary change is also needed to symlink the provided ``OVMF.fd`` to
-the file required by QEMU: ``bios-256k.bin`` and then tell QEMU about
-the location of this file with the -L option::
-
- $ qemu-system-x86_64 -L /usr/share/ovmf/ -machine accel=kvm \\
- -m 4096 -smp 2 -drive format=raw,file=test.img
-
For further examples, including u-boot support for beaglebone-black,
see ``/usr/share/vmdebootstrap/examples``