summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-10-20 12:43:43 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-21 15:09:16 +0100
commit1ea92a27f60d51c320157155d21c41272124649c (patch)
tree9ef7eb8a007eb7a3f3dbd61304e36ca964fd5a2e
parent82638ca39f2f71317f996f1bfc725597d18ac03d (diff)
downloadpoky-1ea92a27f60d51c320157155d21c41272124649c.tar.gz
poky-1ea92a27f60d51c320157155d21c41272124649c.tar.bz2
poky-1ea92a27f60d51c320157155d21c41272124649c.zip
ref-manual: Added gummiboot class and four supporting variables.
The variables added were: * EFI_PROVIDER * GUMMIBOOT_CFG * GUMMIBOOT_ENTRIES * GUMMIBOOT_TIMEOUT (From yocto-docs rev: 42d548a9c4e6eb8eb67ada258fefb32ba8ba175c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-classes.xml32
-rw-r--r--documentation/ref-manual/ref-variables.xml86
2 files changed, 115 insertions, 3 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index ae01bcec97..2bb9e2d890 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -494,7 +494,7 @@
<para>
A class used by the archiver and the
<link linkend='ref-classes-copyleft_compliance'><filename>copyleft_compliance</filename></link>
- classe for filtering licenses.
+ class for filtering licenses.
This is an internal class and is not intended to be used directly.
</para>
</section>
@@ -1034,6 +1034,36 @@
</para>
</section>
+<section id='ref-classes-gummiboot'>
+ <title><filename>gummiboot.bbclass</filename></title>
+
+ <para>
+ The <filename>gummiboot</filename> 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
+ <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link>
+ variable to "gummiboot" to use this class.
+ </para>
+
+ <para>
+ For information on more variables used and supported in this class,
+ see the
+ <link linkend='var-GUMMIBOOT_CFG'><filename>GUMMIBOOT_CFG</filename></link>,
+ <link linkend='var-GUMMIBOOT_ENTRIES'><filename>GUMMIBOOT_ENTRIES</filename></link>,
+ and
+ <link linkend='var-GUMMIBOOT_TIMEOUT'><filename>GUMMIBOOT_TIMEOUT</filename></link>
+ variables.
+ </para>
+
+ <para>
+ You can also see the
+ <ulink url='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink>
+ for more information.
+ </para>
+</section>
+
<section id='ref-classes-gzipnative'>
<title><filename>gzipnative.bbclass</filename></title>
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index bc17ee409b..cc5382f334 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -20,7 +20,7 @@
<link linkend='var-B'>B</link>
<link linkend='var-CFLAGS'>C</link>
<link linkend='var-D'>D</link>
- <link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link>
+ <link linkend='var-EFI_PROVIDER'>E</link>
<link linkend='var-FEATURE_PACKAGES'>F</link>
<link linkend='var-GLIBC_GENERATE_LOCALES'>G</link>
<link linkend='var-HOMEPAGE'>H</link>
@@ -2233,9 +2233,29 @@
<glossdiv id='var-glossary-e'><title>E</title>
- <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm>
+ <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm>
<glossdef>
<para></para>
+ <para>
+ Setting this variable to "gummiboot" causes the
+ OpenEmbedded build system to use the Gummiboot bootloader.
+ </para>
+
+ <para>
+ See the
+ <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link>
+ class for more information.
+ </para>
+
+ <para>
+ For information on Gummiboot, see the
+ <ulink url='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink>.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm>
+ <glossdef>
<para>Variable that controls which locales for
<filename>eglibc</filename> are generated during the
build (useful if the target device has 64Mbytes
@@ -3046,6 +3066,68 @@
</glossdef>
</glossentry>
+ <glossentry id='var-GUMMIBOOT_CFG'><glossterm>GUMMIBOOT_CFG</glossterm>
+ <glossdef>
+ <para>
+ 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='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink>.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id='var-GUMMIBOOT_ENTRIES'><glossterm>GUMMIBOOT_ENTRIES</glossterm>
+ <glossdef>
+ <para>
+ 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='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink>.
+ </para>
+ </glossdef>
+ </glossentry>
+
+ <glossentry id='var-GUMMIBOOT_TIMEOUT'><glossterm>GUMMIBOOT_TIMEOUT</glossterm>
+ <glossdef>
+ <para>
+ 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='https://wiki.archlinux.org/index.php/Gummiboot'>Gummiboot documentation</ulink>.
+ </para>
+ </glossdef>
+ </glossentry>
+
</glossdiv>
<glossdiv id='var-glossary-h'><title>H</title>