summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-08-22 14:55:05 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-08-25 23:09:29 +0100
commit9ba4fc087ef9609a4a4e7546ee00f9801c2dfac8 (patch)
tree1ef0856bfa8abce53db68ca252d395ad872c3a3d /documentation/ref-manual/ref-variables.xml
parentac0fa7a2965e9cd44cdaf0fcdb83cecd361bfdec (diff)
downloadpoky-9ba4fc087ef9609a4a4e7546ee00f9801c2dfac8.tar.gz
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>
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml176
1 files changed, 88 insertions, 88 deletions
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 @@
3532 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>), 3532 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>),
3533 the <filename>EFI_PROVIDER</filename> variable specifies 3533 the <filename>EFI_PROVIDER</filename> variable specifies
3534 the EFI bootloader to use. 3534 the EFI bootloader to use.
3535 The default is "grub-efi", but "gummiboot" can be used 3535 The default is "grub-efi", but "systemd-boot" can be used
3536 instead. 3536 instead.
3537 </para> 3537 </para>
3538 3538
3539 <para> 3539 <para>
3540 See the 3540 See the
3541 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link> 3541 <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
3542 class for more information. 3542 class for more information.
3543 </para> 3543 </para>
3544 </glossdef> 3544 </glossdef>
@@ -4674,92 +4674,6 @@
4674 </glossdef> 4674 </glossdef>
4675 </glossentry> 4675 </glossentry>
4676 4676
4677 <glossentry id='var-GUMMIBOOT_CFG'><glossterm>GUMMIBOOT_CFG</glossterm>
4678 <info>
4679 GUMMIBOOT_CFG[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_CFG variable specifies the configuration file that should be used."
4680 </info>
4681 <glossdef>
4682 <para role="glossdeffirst">
4683<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
4684 When
4685 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
4686 is set to "gummiboot", the
4687 <filename>GUMMIBOOT_CFG</filename> variable specifies the
4688 configuration file that should be used.
4689 By default, the
4690 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
4691 class sets the <filename>GUMMIBOOT_CFG</filename> as
4692 follows:
4693 <literallayout class='monospaced'>
4694 GUMMIBOOT_CFG ?= "${<link linkend='var-S'>S</link>}/loader.conf"
4695 </literallayout>
4696 </para>
4697
4698 <para>
4699 For information on Gummiboot, see the
4700 <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
4701 </para>
4702 </glossdef>
4703 </glossentry>
4704
4705 <glossentry id='var-GUMMIBOOT_ENTRIES'><glossterm>GUMMIBOOT_ENTRIES</glossterm>
4706 <info>
4707 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."
4708 </info>
4709 <glossdef>
4710 <para role="glossdeffirst">
4711<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
4712 When
4713 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
4714 is set to "gummiboot", the
4715 <filename>GUMMIBOOT_ENTRIES</filename> variable specifies
4716 a list of entry files
4717 (<filename>*.conf</filename>) to be installed
4718 containing one boot entry per file.
4719 By default, the
4720 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
4721 class sets the <filename>GUMMIBOOT_ENTRIES</filename> as
4722 follows:
4723 <literallayout class='monospaced'>
4724 GUMMIBOOT_ENTRIES ?= ""
4725 </literallayout>
4726 </para>
4727
4728 <para>
4729 For information on Gummiboot, see the
4730 <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
4731 </para>
4732 </glossdef>
4733 </glossentry>
4734
4735 <glossentry id='var-GUMMIBOOT_TIMEOUT'><glossterm>GUMMIBOOT_TIMEOUT</glossterm>
4736 <info>
4737 GUMMIBOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_TIMEOUT variable specifies the boot menu timeout in seconds."
4738 </info>
4739 <glossdef>
4740 <para role="glossdeffirst">
4741<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
4742 When
4743 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
4744 is set to "gummiboot", the
4745 <filename>GUMMIBOOT_TIMEOUT</filename> variable specifies
4746 the boot menu timeout in seconds.
4747 By default, the
4748 <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
4749 class sets the <filename>GUMMIBOOT_TIMEOUT</filename> as
4750 follows:
4751 <literallayout class='monospaced'>
4752 GUMMIBOOT_TIMEOUT ?= "10"
4753 </literallayout>
4754 </para>
4755
4756 <para>
4757 For information on Gummiboot, see the
4758 <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>.
4759 </para>
4760 </glossdef>
4761 </glossentry>
4762
4763 </glossdiv> 4677 </glossdiv>
4764 4678
4765 <glossdiv id='var-glossary-h'><title>H</title> 4679 <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"
12938 </glossdef> 12852 </glossdef>
12939 </glossentry> 12853 </glossentry>
12940 12854
12855 <glossentry id='var-SYSTEMD_BOOT_CFG'><glossterm>SYSTEMD_BOOT_CFG</glossterm>
12856 <info>
12857 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."
12858 </info>
12859 <glossdef>
12860 <para role="glossdeffirst">
12861<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
12862 When
12863 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
12864 is set to "systemd-boot", the
12865 <filename>SYSTEMD_BOOT_CFG</filename> variable specifies the
12866 configuration file that should be used.
12867 By default, the
12868 <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
12869 class sets the <filename>SYSTEMD_BOOT_CFG</filename> as
12870 follows:
12871 <literallayout class='monospaced'>
12872 SYSTEMD_BOOT_CFG ?= "${<link linkend='var-S'>S</link>}/loader.conf"
12873 </literallayout>
12874 </para>
12875
12876 <para>
12877 For information on Systemd-boot, see the
12878 <ulink url='http://freedesktop.org/wiki/Software/systemd-boot/'>Systemd-boot documentation</ulink>.
12879 </para>
12880 </glossdef>
12881 </glossentry>
12882
12883 <glossentry id='var-SYSTEMD_BOOT_ENTRIES'><glossterm>SYSTEMD_BOOT_ENTRIES</glossterm>
12884 <info>
12885 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."
12886 </info>
12887 <glossdef>
12888 <para role="glossdeffirst">
12889<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
12890 When
12891 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
12892 is set to "systemd-boot", the
12893 <filename>SYSTEMD_BOOT_ENTRIES</filename> variable specifies
12894 a list of entry files
12895 (<filename>*.conf</filename>) to be installed
12896 containing one boot entry per file.
12897 By default, the
12898 <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
12899 class sets the <filename>SYSTEMD_BOOT_ENTRIES</filename> as
12900 follows:
12901 <literallayout class='monospaced'>
12902 SYSTEMD_BOOT_ENTRIES ?= ""
12903 </literallayout>
12904 </para>
12905
12906 <para>
12907 For information on Systemd-boot, see the
12908 <ulink url='http://freedesktop.org/wiki/Software/systemd-boot/'>Systemd-boot documentation</ulink>.
12909 </para>
12910 </glossdef>
12911 </glossentry>
12912
12913 <glossentry id='var-SYSTEMD_BOOT_TIMEOUT'><glossterm>SYSTEMD_BOOT_TIMEOUT</glossterm>
12914 <info>
12915 SYSTEMD_BOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_TIMEOUT variable specifies the boot menu timeout in seconds."
12916 </info>
12917 <glossdef>
12918 <para role="glossdeffirst">
12919<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
12920 When
12921 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
12922 is set to "systemd-boot", the
12923 <filename>SYSTEMD_BOOT_TIMEOUT</filename> variable specifies
12924 the boot menu timeout in seconds.
12925 By default, the
12926 <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link>
12927 class sets the <filename>SYSTEMD_BOOT_TIMEOUT</filename> as
12928 follows:
12929 <literallayout class='monospaced'>
12930 SYSTEMD_BOOT_TIMEOUT ?= "10"
12931 </literallayout>
12932 </para>
12933
12934 <para>
12935 For information on Systemd-boot, see the
12936 <ulink url='http://freedesktop.org/wiki/Software/systemd-boot/'>Systemd-boot documentation</ulink>.
12937 </para>
12938 </glossdef>
12939 </glossentry>
12940
12941 <glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm> 12941 <glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm>
12942 <info> 12942 <info>
12943 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." 12943 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."