diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-12-02 07:18:46 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-03 12:53:32 +0000 |
commit | 28a6b529c0a326f79bd5cbf1234c26820da870d6 (patch) | |
tree | 68e78ab03fe41143d45368ed3865a35d43bd2f8a /documentation | |
parent | 04d8460277233046f6db5cd3553ba8e63e62c714 (diff) | |
download | ast2050-yocto-poky-28a6b529c0a326f79bd5cbf1234c26820da870d6.zip ast2050-yocto-poky-28a6b529c0a326f79bd5cbf1234c26820da870d6.tar.gz |
ref-manual: Added grub-efi class and supporting variables.
Created glossary entries for the GRUB_GFXSERIAL, LABELS,
APPEND, GRUB_OPTS, and GRUB_TIMEOUT variables.
(From yocto-docs rev: 31bcc25866525ef998bc01e11ab9ddb0601b8ded)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 47 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 82 |
2 files changed, 128 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 548ffd0..37d0b15 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -658,6 +658,53 @@ </para> </section> +<section id='ref-classes-grub-efi'> + <title><filename>grub-efi.bbclass</filename></title> + + <para> + The GRUB Extensible Firmware Interface (<filename>grub-efi</filename>) + class provides <filename>grub-efi</filename>-specific functions for + building bootable images. + </para> + + <para> + This class supports several variables: + <itemizedlist> + <listitem><para> + <link linkend='var-INITRD'><filename>INITRD</filename></link>: + Indicates a filesystem image to use as an initrd (optional). + </para></listitem> + <listitem><para> + <link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>: + Indicates a filesystem image to include as the root filesystem + (optional).</para></listitem> + <listitem><para> + <link linkend='var-GRUB_GFXSERIAL'><filename>GRUB_GFXSERIAL</filename></link>: + Set this to "1" to have graphics and serial in the boot menu. + </para></listitem> + <listitem><para> + <link linkend='var-LABELS'><filename>LABELS</filename></link>: + A list of targets for the automatic configuration. + </para></listitem> + <listitem><para> + <link linkend='var-APPEND'><filename>APPEND</filename></link>: + An override list of append strings for each + <filename>LABEL</filename>. + </para></listitem> + <listitem><para> + <link linkend='var-GRUB_OPTS'><filename>GRUB_OPTS</filename></link>: + Additional options to add to the configuration (optional). + Options are delimited using semi-colon characters + (<filename>;</filename>).</para></listitem> + <listitem><para> + <link linkend='var-GRUB_TIMEOUT'><filename>GRUB_TIMEOUT</filename></link>: + Timeout before executing the default <filename>LABEL</filename> + (optional). + </para></listitem> + </itemizedlist> + </para> +</section> + <section id='ref-classes-gtk-icon-cache'> <title><filename>gtk-icon-cache.bbclass</filename></title> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 048d440..f2ff494 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -27,7 +27,7 @@ <link linkend='var-IMAGE_BASENAME'>I</link> <!-- <link linkend='var-glossary-j'>J</link> --> <link linkend='var-KARCH'>K</link> - <link linkend='var-LAYERDEPENDS'>L</link> + <link linkend='var-LABELS'>L</link> <link linkend='var-MACHINE'>M</link> <!-- <link linkend='var-glossary-n'>N</link> --> <link linkend='var-OE_BINCONFIG_EXTRA_MANGLE'>O</link> @@ -203,6 +203,21 @@ </glossdef> </glossentry> + <glossentry id='var-APPEND'><glossterm>APPEND</glossterm> + <glossdef> + <para> + An override list of append strings for each + <link linkend='var-LABELS'><filename>LABEL</filename></link>. + </para> + + <para> + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> <glossdef> <para>The email address used to contact the original author @@ -2139,6 +2154,57 @@ </glossdef> </glossentry> + <glossentry id='var-GRUB_GFXSERIAL'><glossterm>GRUB_GFXSERIAL</glossterm> + <glossdef> + <para> + Configures the GNU GRand Unified Bootloader (GRUB) to have + graphics and serial in the boot menu. + Set this variable to "1" to enable both in the menu. + </para> + + <para> + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GRUB_OPTS'><glossterm>GRUB_OPTS</glossterm> + <glossdef> + <para> + Additional options to add to the GNU GRand Unified + Bootloader (GRUB) configuration. + Use a semi-colon character (<filename>;</filename>) to + separate multiple options. + </para> + + <para> + The <filename>GRUB_OPTS</filename> variable is optional. + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GRUB_TIMEOUT'><glossterm>GRUB_TIMEOUT</glossterm> + <glossdef> + <para> + Specifies the timeout before executing the default + <filename>LABEL</filename> in the GNU GRand Unified + Bootloader (GRUB). + </para> + + <para> + The <filename>GRUB_TIMEOUT</filename> variable is optional. + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + </glossdiv> <glossdiv id='var-glossary-h'><title>H</title> @@ -3129,6 +3195,20 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <glossdiv id='var-glossary-l'><title>L</title> + <glossentry id='var-LABELS'><glossterm>LABELS</glossterm> + <glossdef> + <para> + Provides a list of targets for automatic configuration. + </para> + + <para> + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> <glossdef> <para>Lists the layers that this recipe depends upon, separated by spaces. |