From 9ba4fc087ef9609a4a4e7546ee00f9801c2dfac8 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 22 Aug 2016 14:55:05 -0700 Subject: dev-manual, ref-manual: Systemd-boot: Update documents for new EFI bootloader Fixes [YOCTO #9707] * Replaced gummiboot with systemd-boot in the dev-manual * Replaced the gummiboot class with a new systemd-boot class * Replaced the appropriate gummiboot variables in the glossary with new variables SYSTEMD_BOOT_CFG, SYSTEMD_BOOT_ENTRIES, and SYSTEMD_BOOT_TIMEOUT. (From yocto-docs rev: 778b620e65cc68531b3c41aeb8f27f2a07eb0d00) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 26 +-- documentation/ref-manual/ref-classes.xml | 67 ++++---- documentation/ref-manual/ref-variables.xml | 176 ++++++++++----------- 3 files changed, 138 insertions(+), 131 deletions(-) (limited to 'documentation') diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 48d3ecb632..bd11062c41 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -8777,19 +8777,19 @@ within a separately started QEMU or any other virtual machine manager. - "GummibootTarget": - Choose "GummibootTarget" if your hardware is + "Systemd-bootTarget": + Choose "Systemd-bootTarget" if your hardware is an EFI-based machine with - gummiboot as bootloader and + systemd-boot as bootloader and core-image-testmaster (or something similar) is installed. Also, your hardware under test must be in a DHCP-enabled network that gives it the same IP address for each reboot. - If you choose "GummibootTarget", there are + If you choose "Systemd-bootTarget", there are additional requirements and considerations. See the - "Selecting GummibootTarget" + "Selecting Systemd-bootTarget" section, which follows, for more information. "BeagleBoneTarget": @@ -8835,12 +8835,12 @@ -
- Selecting GummibootTarget +
+ Selecting Systemd-bootTarget If you did not set TEST_TARGET to - "GummibootTarget", then you do not need any information + "Systemd-bootTarget", then you do not need any information in this section. You can skip down to the "Running Tests" @@ -8849,14 +8849,14 @@ If you did set TEST_TARGET to - "GummibootTarget", you also need to perform a one-time + "Systemd-bootTarget", you also need to perform a one-time setup of your master image by doing the following: Set EFI_PROVIDER: Be sure that EFI_PROVIDER is as follows: - EFI_PROVIDER = "gummiboot" + EFI_PROVIDER = "systemd-boot" Build the master image: @@ -8920,7 +8920,7 @@ The final thing you need to do when setting - TEST_TARGET to "GummibootTarget" is + TEST_TARGET to "Systemd-bootTarget" is to set up the test image: Set up your local.conf file: @@ -8929,7 +8929,7 @@ IMAGE_FSTYPES += "tar.gz" INHERIT += "testimage" - TEST_TARGET = "GummibootTarget" + TEST_TARGET = "Systemd-bootTarget" TEST_TARGET_IP = "192.168.2.3" @@ -9325,7 +9325,7 @@ The target controller object used to deploy and start an image on a particular target (e.g. QemuTarget, SimpleRemote, and - GummibootTarget). + Systemd-bootTarget). Tests usually use the following: ip: diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 1bbd075b87..97b2995358 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -1099,36 +1099,6 @@
-
- <filename>gummiboot.bbclass</filename> - - - The gummiboot class provides functions specific - to the gummiboot bootloader for building bootable images. - This is an internal class and is not intended to be - used directly. - Set the - EFI_PROVIDER - variable to "gummiboot" to use this class. - - - - For information on more variables used and supported in this class, - see the - GUMMIBOOT_CFG, - GUMMIBOOT_ENTRIES, - and - GUMMIBOOT_TIMEOUT - variables. - - - - You can also see the - Gummiboot documentation - for more information. - -
-
<filename>gzipnative.bbclass</filename> @@ -3315,6 +3285,43 @@
+
+ <filename>systemd-boot.bbclass</filename> + + + The systemd-boot class provides functions specific + to the systemd-boot bootloader for building bootable images. + This is an internal class and is not intended to be used directly. + + The systemd-boot class is a result from + merging the gummiboot class used in previous + Yocto Project releases with the systemd + project. + + Set the + EFI_PROVIDER + variable to "systemd-boot" to use this class. + Doing so creates a standalone EFI bootloader that is not dependent + on systemd. + + + + For information on more variables used and supported in this class, + see the + SYSTEMD_BOOT_CFG, + SYSTEMD_BOOT_ENTRIES, + and + SYSTEMD_BOOT_TIMEOUT + variables. + + + + You can also see the + Systemd documentation + for more information. + +
+
<filename>terminal.bbclass</filename> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index d0c02d392b..927e8f0f30 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -3532,13 +3532,13 @@ IMAGE_FSTYPES), the EFI_PROVIDER variable specifies the EFI bootloader to use. - The default is "grub-efi", but "gummiboot" can be used + The default is "grub-efi", but "systemd-boot" can be used instead. See the - gummiboot + systemd-boot class for more information. @@ -4674,92 +4674,6 @@ - GUMMIBOOT_CFG - - GUMMIBOOT_CFG[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_CFG variable specifies the configuration file that should be used." - - - - - When - EFI_PROVIDER - is set to "gummiboot", the - GUMMIBOOT_CFG variable specifies the - configuration file that should be used. - By default, the - gummiboot - class sets the GUMMIBOOT_CFG as - follows: - - GUMMIBOOT_CFG ?= "${S}/loader.conf" - - - - - For information on Gummiboot, see the - Gummiboot documentation. - - - - - GUMMIBOOT_ENTRIES - - GUMMIBOOT_ENTRIES[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_ENTRIES variable specifies a list of entry files (*.conf) to be installed containing one boot entry per file." - - - - - When - EFI_PROVIDER - is set to "gummiboot", the - GUMMIBOOT_ENTRIES variable specifies - a list of entry files - (*.conf) to be installed - containing one boot entry per file. - By default, the - gummiboot - class sets the GUMMIBOOT_ENTRIES as - follows: - - GUMMIBOOT_ENTRIES ?= "" - - - - - For information on Gummiboot, see the - Gummiboot documentation. - - - - - GUMMIBOOT_TIMEOUT - - GUMMIBOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_TIMEOUT variable specifies the boot menu timeout in seconds." - - - - - When - EFI_PROVIDER - is set to "gummiboot", the - GUMMIBOOT_TIMEOUT variable specifies - the boot menu timeout in seconds. - By default, the - gummiboot - class sets the GUMMIBOOT_TIMEOUT as - follows: - - GUMMIBOOT_TIMEOUT ?= "10" - - - - - For information on Gummiboot, see the - Gummiboot documentation. - - - - H @@ -12938,6 +12852,92 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + SYSTEMD_BOOT_CFG + + SYSTEMD_BOOT_CFG[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_CFG variable specifies the configuration file that should be used." + + + + + When + EFI_PROVIDER + is set to "systemd-boot", the + SYSTEMD_BOOT_CFG variable specifies the + configuration file that should be used. + By default, the + systemd-boot + class sets the SYSTEMD_BOOT_CFG as + follows: + + SYSTEMD_BOOT_CFG ?= "${S}/loader.conf" + + + + + For information on Systemd-boot, see the + Systemd-boot documentation. + + + + + SYSTEMD_BOOT_ENTRIES + + SYSTEMD_BOOT_ENTRIES[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_ENTRIES variable specifies a list of entry files (*.conf) to be installed containing one boot entry per file." + + + + + When + EFI_PROVIDER + is set to "systemd-boot", the + SYSTEMD_BOOT_ENTRIES variable specifies + a list of entry files + (*.conf) to be installed + containing one boot entry per file. + By default, the + systemd-boot + class sets the SYSTEMD_BOOT_ENTRIES as + follows: + + SYSTEMD_BOOT_ENTRIES ?= "" + + + + + For information on Systemd-boot, see the + Systemd-boot documentation. + + + + + SYSTEMD_BOOT_TIMEOUT + + SYSTEMD_BOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_TIMEOUT variable specifies the boot menu timeout in seconds." + + + + + When + EFI_PROVIDER + is set to "systemd-boot", the + SYSTEMD_BOOT_TIMEOUT variable specifies + the boot menu timeout in seconds. + By default, the + systemd-boot + class sets the SYSTEMD_BOOT_TIMEOUT as + follows: + + SYSTEMD_BOOT_TIMEOUT ?= "10" + + + + + For information on Systemd-boot, see the + Systemd-boot documentation. + + + + SYSTEMD_PACKAGES SYSTEMD_PACKAGES[doc] = "For recipes that inherit the systemd class, this variable locates the systemd unit files when they are not found in the main recipe's package." -- cgit v1.2.3-54-g00ecf