summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml26
-rw-r--r--documentation/ref-manual/ref-classes.xml67
-rw-r--r--documentation/ref-manual/ref-variables.xml176
3 files changed, 138 insertions, 131 deletions
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 @@
8777 within a separately started QEMU or any 8777 within a separately started QEMU or any
8778 other virtual machine manager. 8778 other virtual machine manager.
8779 </para></listitem> 8779 </para></listitem>
8780 <listitem><para><emphasis>"GummibootTarget":</emphasis> 8780 <listitem><para><emphasis>"Systemd-bootTarget":</emphasis>
8781 Choose "GummibootTarget" if your hardware is 8781 Choose "Systemd-bootTarget" if your hardware is
8782 an EFI-based machine with 8782 an EFI-based machine with
8783 <filename>gummiboot</filename> as bootloader and 8783 <filename>systemd-boot</filename> as bootloader and
8784 <filename>core-image-testmaster</filename> 8784 <filename>core-image-testmaster</filename>
8785 (or something similar) is installed. 8785 (or something similar) is installed.
8786 Also, your hardware under test must be in a 8786 Also, your hardware under test must be in a
8787 DHCP-enabled network that gives it the same IP 8787 DHCP-enabled network that gives it the same IP
8788 address for each reboot.</para> 8788 address for each reboot.</para>
8789 <para>If you choose "GummibootTarget", there are 8789 <para>If you choose "Systemd-bootTarget", there are
8790 additional requirements and considerations. 8790 additional requirements and considerations.
8791 See the 8791 See the
8792 "<link linkend='selecting-gummiboottarget'>Selecting GummibootTarget</link>" 8792 "<link linkend='selecting-systemd-boottarget'>Selecting Systemd-bootTarget</link>"
8793 section, which follows, for more information. 8793 section, which follows, for more information.
8794 </para></listitem> 8794 </para></listitem>
8795 <listitem><para><emphasis>"BeagleBoneTarget":</emphasis> 8795 <listitem><para><emphasis>"BeagleBoneTarget":</emphasis>
@@ -8835,12 +8835,12 @@
8835 </para> 8835 </para>
8836 </section> 8836 </section>
8837 8837
8838 <section id='selecting-gummiboottarget'> 8838 <section id='selecting-systemd-boottarget'>
8839 <title>Selecting GummibootTarget</title> 8839 <title>Selecting Systemd-bootTarget</title>
8840 8840
8841 <para> 8841 <para>
8842 If you did not set <filename>TEST_TARGET</filename> to 8842 If you did not set <filename>TEST_TARGET</filename> to
8843 "GummibootTarget", then you do not need any information 8843 "Systemd-bootTarget", then you do not need any information
8844 in this section. 8844 in this section.
8845 You can skip down to the 8845 You can skip down to the
8846 "<link linkend='qemu-image-running-tests'>Running Tests</link>" 8846 "<link linkend='qemu-image-running-tests'>Running Tests</link>"
@@ -8849,14 +8849,14 @@
8849 8849
8850 <para> 8850 <para>
8851 If you did set <filename>TEST_TARGET</filename> to 8851 If you did set <filename>TEST_TARGET</filename> to
8852 "GummibootTarget", you also need to perform a one-time 8852 "Systemd-bootTarget", you also need to perform a one-time
8853 setup of your master image by doing the following: 8853 setup of your master image by doing the following:
8854 <orderedlist> 8854 <orderedlist>
8855 <listitem><para><emphasis>Set <filename>EFI_PROVIDER</filename>:</emphasis> 8855 <listitem><para><emphasis>Set <filename>EFI_PROVIDER</filename>:</emphasis>
8856 Be sure that <filename>EFI_PROVIDER</filename> 8856 Be sure that <filename>EFI_PROVIDER</filename>
8857 is as follows: 8857 is as follows:
8858 <literallayout class='monospaced'> 8858 <literallayout class='monospaced'>
8859 EFI_PROVIDER = "gummiboot" 8859 EFI_PROVIDER = "systemd-boot"
8860 </literallayout> 8860 </literallayout>
8861 </para></listitem> 8861 </para></listitem>
8862 <listitem><para><emphasis>Build the master image:</emphasis> 8862 <listitem><para><emphasis>Build the master image:</emphasis>
@@ -8920,7 +8920,7 @@
8920 8920
8921 <para> 8921 <para>
8922 The final thing you need to do when setting 8922 The final thing you need to do when setting
8923 <filename>TEST_TARGET</filename> to "GummibootTarget" is 8923 <filename>TEST_TARGET</filename> to "Systemd-bootTarget" is
8924 to set up the test image: 8924 to set up the test image:
8925 <orderedlist> 8925 <orderedlist>
8926 <listitem><para><emphasis>Set up your <filename>local.conf</filename> file:</emphasis> 8926 <listitem><para><emphasis>Set up your <filename>local.conf</filename> file:</emphasis>
@@ -8929,7 +8929,7 @@
8929 <literallayout class='monospaced'> 8929 <literallayout class='monospaced'>
8930 IMAGE_FSTYPES += "tar.gz" 8930 IMAGE_FSTYPES += "tar.gz"
8931 INHERIT += "testimage" 8931 INHERIT += "testimage"
8932 TEST_TARGET = "GummibootTarget" 8932 TEST_TARGET = "Systemd-bootTarget"
8933 TEST_TARGET_IP = "192.168.2.3" 8933 TEST_TARGET_IP = "192.168.2.3"
8934 </literallayout> 8934 </literallayout>
8935 </para></listitem> 8935 </para></listitem>
@@ -9325,7 +9325,7 @@
9325 The target controller object used to deploy 9325 The target controller object used to deploy
9326 and start an image on a particular target 9326 and start an image on a particular target
9327 (e.g. QemuTarget, SimpleRemote, and 9327 (e.g. QemuTarget, SimpleRemote, and
9328 GummibootTarget). 9328 Systemd-bootTarget).
9329 Tests usually use the following: 9329 Tests usually use the following:
9330 <itemizedlist> 9330 <itemizedlist>
9331 <listitem><para><emphasis><filename>ip</filename>:</emphasis> 9331 <listitem><para><emphasis><filename>ip</filename>:</emphasis>
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 @@
1099 </para> 1099 </para>
1100</section> 1100</section>
1101 1101
1102<section id='ref-classes-gummiboot'>
1103 <title><filename>gummiboot.bbclass</filename></title>
1104
1105 <para>
1106 The <filename>gummiboot</filename> class provides functions specific
1107 to the gummiboot bootloader for building bootable images.
1108 This is an internal class and is not intended to be
1109 used directly.
1110 Set the
1111 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
1112 variable to "gummiboot" to use this class.
1113 </para>
1114
1115 <para>
1116 For information on more variables used and supported in this class,
1117 see the
1118 <link linkend='var-GUMMIBOOT_CFG'><filename>GUMMIBOOT_CFG</filename></link>,
1119 <link linkend='var-GUMMIBOOT_ENTRIES'><filename>GUMMIBOOT_ENTRIES</filename></link>,
1120 and
1121 <link linkend='var-GUMMIBOOT_TIMEOUT'><filename>GUMMIBOOT_TIMEOUT</filename></link>
1122 variables.
1123 </para>
1124
1125 <para>
1126 You can also see the
1127 <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>
1128 for more information.
1129 </para>
1130</section>
1131
1132<section id='ref-classes-gzipnative'> 1102<section id='ref-classes-gzipnative'>
1133 <title><filename>gzipnative.bbclass</filename></title> 1103 <title><filename>gzipnative.bbclass</filename></title>
1134 1104
@@ -3315,6 +3285,43 @@
3315 </para> 3285 </para>
3316</section> 3286</section>
3317 3287
3288<section id='ref-classes-systemd-boot'>
3289 <title><filename>systemd-boot.bbclass</filename></title>
3290
3291 <para>
3292 The <filename>systemd-boot</filename> class provides functions specific
3293 to the systemd-boot bootloader for building bootable images.
3294 This is an internal class and is not intended to be used directly.
3295 <note>
3296 The <filename>systemd-boot</filename> class is a result from
3297 merging the <filename>gummiboot</filename> class used in previous
3298 Yocto Project releases with the <filename>systemd</filename>
3299 project.
3300 </note>
3301 Set the
3302 <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
3303 variable to "systemd-boot" to use this class.
3304 Doing so creates a standalone EFI bootloader that is not dependent
3305 on systemd.
3306 </para>
3307
3308 <para>
3309 For information on more variables used and supported in this class,
3310 see the
3311 <link linkend='var-SYSTEMD_BOOT_CFG'><filename>SYSTEMD_BOOT_CFG</filename></link>,
3312 <link linkend='var-SYSTEMD_BOOT_ENTRIES'><filename>SYSTEMD_BOOT_ENTRIES</filename></link>,
3313 and
3314 <link linkend='var-SYSTEMD_BOOT_TIMEOUT'><filename>SYSTEMD_BOOT_TIMEOUT</filename></link>
3315 variables.
3316 </para>
3317
3318 <para>
3319 You can also see the
3320 <ulink url='https://www.freedesktop.org/wiki/Software/systemd/'>Systemd documentation</ulink>
3321 for more information.
3322 </para>
3323</section>
3324
3318<section id='ref-classes-terminal'> 3325<section id='ref-classes-terminal'>
3319 <title><filename>terminal.bbclass</filename></title> 3326 <title><filename>terminal.bbclass</filename></title>
3320 3327
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."
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2026-02-03 16:44:53 +0000