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 <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2016-08-22 14:55:05 -07:00
committed by Richard Purdie
parent ac0fa7a296
commit 9ba4fc087e
3 changed files with 138 additions and 131 deletions

View File

@@ -3532,13 +3532,13 @@
<link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>),
the <filename>EFI_PROVIDER</filename> 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.
</para>
<para>
See the
<link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
<link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
class for more information.
</para>
</glossdef>
@@ -4674,92 +4674,6 @@
</glossdef>
</glossentry>
<glossentry id='var-GUMMIBOOT_CFG'><glossterm>GUMMIBOOT_CFG</glossterm>
<info>
GUMMIBOOT_CFG[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_CFG variable specifies the configuration file that should be used."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
When
<link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
is set to "gummiboot", the
<filename>GUMMIBOOT_CFG</filename> variable specifies the
configuration file that should be used.
By default, the
<link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
class sets the <filename>GUMMIBOOT_CFG</filename> as
follows:
<literallayout class='monospaced'>
GUMMIBOOT_CFG ?= "${<link linkend='var-S'>S</link>}/loader.conf"
</literallayout>
</para>
<para>
For information on Gummiboot, see the
<ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-GUMMIBOOT_ENTRIES'><glossterm>GUMMIBOOT_ENTRIES</glossterm>
<info>
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."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
When
<link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
is set to "gummiboot", the
<filename>GUMMIBOOT_ENTRIES</filename> variable specifies
a list of entry files
(<filename>*.conf</filename>) to be installed
containing one boot entry per file.
By default, the
<link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
class sets the <filename>GUMMIBOOT_ENTRIES</filename> as
follows:
<literallayout class='monospaced'>
GUMMIBOOT_ENTRIES ?= ""
</literallayout>
</para>
<para>
For information on Gummiboot, see the
<ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-GUMMIBOOT_TIMEOUT'><glossterm>GUMMIBOOT_TIMEOUT</glossterm>
<info>
GUMMIBOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_TIMEOUT variable specifies the boot menu timeout in seconds."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
When
<link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
is set to "gummiboot", the
<filename>GUMMIBOOT_TIMEOUT</filename> variable specifies
the boot menu timeout in seconds.
By default, the
<link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
class sets the <filename>GUMMIBOOT_TIMEOUT</filename> as
follows:
<literallayout class='monospaced'>
GUMMIBOOT_TIMEOUT ?= "10"
</literallayout>
</para>
<para>
For information on Gummiboot, see the
<ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
</para>
</glossdef>
</glossentry>
</glossdiv>
<glossdiv id='var-glossary-h'><title>H</title>
@@ -12938,6 +12852,92 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-SYSTEMD_BOOT_CFG'><glossterm>SYSTEMD_BOOT_CFG</glossterm>
<info>
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."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
When
<link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
is set to "systemd-boot", the
<filename>SYSTEMD_BOOT_CFG</filename> variable specifies the
configuration file that should be used.
By default, the
<link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
class sets the <filename>SYSTEMD_BOOT_CFG</filename> as
follows:
<literallayout class='monospaced'>
SYSTEMD_BOOT_CFG ?= "${<link linkend='var-S'>S</link>}/loader.conf"
</literallayout>
</para>
<para>
For information on Systemd-boot, see the
<ulink url='http://freedesktop.org/wiki/Software/systemd-boot/'>Systemd-boot documentation</ulink>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SYSTEMD_BOOT_ENTRIES'><glossterm>SYSTEMD_BOOT_ENTRIES</glossterm>
<info>
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."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
When
<link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
is set to "systemd-boot", the
<filename>SYSTEMD_BOOT_ENTRIES</filename> variable specifies
a list of entry files
(<filename>*.conf</filename>) to be installed
containing one boot entry per file.
By default, the
<link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
class sets the <filename>SYSTEMD_BOOT_ENTRIES</filename> as
follows:
<literallayout class='monospaced'>
SYSTEMD_BOOT_ENTRIES ?= ""
</literallayout>
</para>
<para>
For information on Systemd-boot, see the
<ulink url='http://freedesktop.org/wiki/Software/systemd-boot/'>Systemd-boot documentation</ulink>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SYSTEMD_BOOT_TIMEOUT'><glossterm>SYSTEMD_BOOT_TIMEOUT</glossterm>
<info>
SYSTEMD_BOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_TIMEOUT variable specifies the boot menu timeout in seconds."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
When
<link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
is set to "systemd-boot", the
<filename>SYSTEMD_BOOT_TIMEOUT</filename> variable specifies
the boot menu timeout in seconds.
By default, the
<link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
class sets the <filename>SYSTEMD_BOOT_TIMEOUT</filename> as
follows:
<literallayout class='monospaced'>
SYSTEMD_BOOT_TIMEOUT ?= "10"
</literallayout>
</para>
<para>
For information on Systemd-boot, see the
<ulink url='http://freedesktop.org/wiki/Software/systemd-boot/'>Systemd-boot documentation</ulink>.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm>
<info>
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."