diff options
Diffstat (limited to 'documentation/ref-manual')
| -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 548ffd077b..37d0b15586 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
| @@ -658,6 +658,53 @@ | |||
| 658 | </para> | 658 | </para> |
| 659 | </section> | 659 | </section> |
| 660 | 660 | ||
| 661 | <section id='ref-classes-grub-efi'> | ||
| 662 | <title><filename>grub-efi.bbclass</filename></title> | ||
| 663 | |||
| 664 | <para> | ||
| 665 | The GRUB Extensible Firmware Interface (<filename>grub-efi</filename>) | ||
| 666 | class provides <filename>grub-efi</filename>-specific functions for | ||
| 667 | building bootable images. | ||
| 668 | </para> | ||
| 669 | |||
| 670 | <para> | ||
| 671 | This class supports several variables: | ||
| 672 | <itemizedlist> | ||
| 673 | <listitem><para> | ||
| 674 | <link linkend='var-INITRD'><filename>INITRD</filename></link>: | ||
| 675 | Indicates a filesystem image to use as an initrd (optional). | ||
| 676 | </para></listitem> | ||
| 677 | <listitem><para> | ||
| 678 | <link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>: | ||
| 679 | Indicates a filesystem image to include as the root filesystem | ||
| 680 | (optional).</para></listitem> | ||
| 681 | <listitem><para> | ||
| 682 | <link linkend='var-GRUB_GFXSERIAL'><filename>GRUB_GFXSERIAL</filename></link>: | ||
| 683 | Set this to "1" to have graphics and serial in the boot menu. | ||
| 684 | </para></listitem> | ||
| 685 | <listitem><para> | ||
| 686 | <link linkend='var-LABELS'><filename>LABELS</filename></link>: | ||
| 687 | A list of targets for the automatic configuration. | ||
| 688 | </para></listitem> | ||
| 689 | <listitem><para> | ||
| 690 | <link linkend='var-APPEND'><filename>APPEND</filename></link>: | ||
| 691 | An override list of append strings for each | ||
| 692 | <filename>LABEL</filename>. | ||
| 693 | </para></listitem> | ||
| 694 | <listitem><para> | ||
| 695 | <link linkend='var-GRUB_OPTS'><filename>GRUB_OPTS</filename></link>: | ||
| 696 | Additional options to add to the configuration (optional). | ||
| 697 | Options are delimited using semi-colon characters | ||
| 698 | (<filename>;</filename>).</para></listitem> | ||
| 699 | <listitem><para> | ||
| 700 | <link linkend='var-GRUB_TIMEOUT'><filename>GRUB_TIMEOUT</filename></link>: | ||
| 701 | Timeout before executing the default <filename>LABEL</filename> | ||
| 702 | (optional). | ||
| 703 | </para></listitem> | ||
| 704 | </itemizedlist> | ||
| 705 | </para> | ||
| 706 | </section> | ||
| 707 | |||
| 661 | <section id='ref-classes-gtk-icon-cache'> | 708 | <section id='ref-classes-gtk-icon-cache'> |
| 662 | <title><filename>gtk-icon-cache.bbclass</filename></title> | 709 | <title><filename>gtk-icon-cache.bbclass</filename></title> |
| 663 | 710 | ||
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 048d44082e..f2ff49483c 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
| @@ -27,7 +27,7 @@ | |||
| 27 | <link linkend='var-IMAGE_BASENAME'>I</link> | 27 | <link linkend='var-IMAGE_BASENAME'>I</link> |
| 28 | <!-- <link linkend='var-glossary-j'>J</link> --> | 28 | <!-- <link linkend='var-glossary-j'>J</link> --> |
| 29 | <link linkend='var-KARCH'>K</link> | 29 | <link linkend='var-KARCH'>K</link> |
| 30 | <link linkend='var-LAYERDEPENDS'>L</link> | 30 | <link linkend='var-LABELS'>L</link> |
| 31 | <link linkend='var-MACHINE'>M</link> | 31 | <link linkend='var-MACHINE'>M</link> |
| 32 | <!-- <link linkend='var-glossary-n'>N</link> --> | 32 | <!-- <link linkend='var-glossary-n'>N</link> --> |
| 33 | <link linkend='var-OE_BINCONFIG_EXTRA_MANGLE'>O</link> | 33 | <link linkend='var-OE_BINCONFIG_EXTRA_MANGLE'>O</link> |
| @@ -203,6 +203,21 @@ | |||
| 203 | </glossdef> | 203 | </glossdef> |
| 204 | </glossentry> | 204 | </glossentry> |
| 205 | 205 | ||
| 206 | <glossentry id='var-APPEND'><glossterm>APPEND</glossterm> | ||
| 207 | <glossdef> | ||
| 208 | <para> | ||
| 209 | An override list of append strings for each | ||
| 210 | <link linkend='var-LABELS'><filename>LABEL</filename></link>. | ||
| 211 | </para> | ||
| 212 | |||
| 213 | <para> | ||
| 214 | See the | ||
| 215 | <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> | ||
| 216 | class for more information on how this variable is used. | ||
| 217 | </para> | ||
| 218 | </glossdef> | ||
| 219 | </glossentry> | ||
| 220 | |||
| 206 | <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> | 221 | <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> |
| 207 | <glossdef> | 222 | <glossdef> |
| 208 | <para>The email address used to contact the original author | 223 | <para>The email address used to contact the original author |
| @@ -2139,6 +2154,57 @@ | |||
| 2139 | </glossdef> | 2154 | </glossdef> |
| 2140 | </glossentry> | 2155 | </glossentry> |
| 2141 | 2156 | ||
| 2157 | <glossentry id='var-GRUB_GFXSERIAL'><glossterm>GRUB_GFXSERIAL</glossterm> | ||
| 2158 | <glossdef> | ||
| 2159 | <para> | ||
| 2160 | Configures the GNU GRand Unified Bootloader (GRUB) to have | ||
| 2161 | graphics and serial in the boot menu. | ||
| 2162 | Set this variable to "1" to enable both in the menu. | ||
| 2163 | </para> | ||
| 2164 | |||
| 2165 | <para> | ||
| 2166 | See the | ||
| 2167 | <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> | ||
| 2168 | class for more information on how this variable is used. | ||
| 2169 | </para> | ||
| 2170 | </glossdef> | ||
| 2171 | </glossentry> | ||
| 2172 | |||
| 2173 | <glossentry id='var-GRUB_OPTS'><glossterm>GRUB_OPTS</glossterm> | ||
| 2174 | <glossdef> | ||
| 2175 | <para> | ||
| 2176 | Additional options to add to the GNU GRand Unified | ||
| 2177 | Bootloader (GRUB) configuration. | ||
| 2178 | Use a semi-colon character (<filename>;</filename>) to | ||
| 2179 | separate multiple options. | ||
| 2180 | </para> | ||
| 2181 | |||
| 2182 | <para> | ||
| 2183 | The <filename>GRUB_OPTS</filename> variable is optional. | ||
| 2184 | See the | ||
| 2185 | <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> | ||
| 2186 | class for more information on how this variable is used. | ||
| 2187 | </para> | ||
| 2188 | </glossdef> | ||
| 2189 | </glossentry> | ||
| 2190 | |||
| 2191 | <glossentry id='var-GRUB_TIMEOUT'><glossterm>GRUB_TIMEOUT</glossterm> | ||
| 2192 | <glossdef> | ||
| 2193 | <para> | ||
| 2194 | Specifies the timeout before executing the default | ||
| 2195 | <filename>LABEL</filename> in the GNU GRand Unified | ||
| 2196 | Bootloader (GRUB). | ||
| 2197 | </para> | ||
| 2198 | |||
| 2199 | <para> | ||
| 2200 | The <filename>GRUB_TIMEOUT</filename> variable is optional. | ||
| 2201 | See the | ||
| 2202 | <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> | ||
| 2203 | class for more information on how this variable is used. | ||
| 2204 | </para> | ||
| 2205 | </glossdef> | ||
| 2206 | </glossentry> | ||
| 2207 | |||
| 2142 | </glossdiv> | 2208 | </glossdiv> |
| 2143 | 2209 | ||
| 2144 | <glossdiv id='var-glossary-h'><title>H</title> | 2210 | <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" | |||
| 3129 | 3195 | ||
| 3130 | <glossdiv id='var-glossary-l'><title>L</title> | 3196 | <glossdiv id='var-glossary-l'><title>L</title> |
| 3131 | 3197 | ||
| 3198 | <glossentry id='var-LABELS'><glossterm>LABELS</glossterm> | ||
| 3199 | <glossdef> | ||
| 3200 | <para> | ||
| 3201 | Provides a list of targets for automatic configuration. | ||
| 3202 | </para> | ||
| 3203 | |||
| 3204 | <para> | ||
| 3205 | See the | ||
| 3206 | <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> | ||
| 3207 | class for more information on how this variable is used. | ||
| 3208 | </para> | ||
| 3209 | </glossdef> | ||
| 3210 | </glossentry> | ||
| 3211 | |||
| 3132 | <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> | 3212 | <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> |
| 3133 | <glossdef> | 3213 | <glossdef> |
| 3134 | <para>Lists the layers that this recipe depends upon, separated by spaces. | 3214 | <para>Lists the layers that this recipe depends upon, separated by spaces. |
