diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-12-04 13:26:10 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-11 14:17:52 +0000 |
commit | 4dcaea2128546cbbf5b375f2bfcbb5fad407482a (patch) | |
tree | 948cf37fa3961afea74863b1c86b396a1d89a266 /documentation/ref-manual/ref-variables.xml | |
parent | 234ea4b9ba998061f1adeb68551f011297ee594d (diff) | |
download | poky-4dcaea2128546cbbf5b375f2bfcbb5fad407482a.tar.gz |
ref-manual: Added syslinux class and many variables.
Variables added:
AUTO_SYSLINUXMENU
SYSLINUX_OPTS
SYSLINUX_SPLASH
SYSLINUX_DEFAULT_CONSOLE
SYSLINUX_SERIAL
SYSLINUX_SERIAL_TTY
(From yocto-docs rev: 1c1bfe53f760b56db9a84a1d46dd2cd85168990f)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.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.xml | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index c5030727f9..049c771ea5 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -225,6 +225,18 @@ | |||
225 | </glossdef> | 225 | </glossdef> |
226 | </glossentry> | 226 | </glossentry> |
227 | 227 | ||
228 | <glossentry id='var-AUTO_SYSLINUXMENU'><glossterm>AUTO_SYSLINUXMENU</glossterm> | ||
229 | <glossdef> | ||
230 | <para> | ||
231 | Enables creating an automatic menu. | ||
232 | You must set this in your recipe. | ||
233 | The | ||
234 | <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> | ||
235 | class checks this variable. | ||
236 | </para> | ||
237 | </glossdef> | ||
238 | </glossentry> | ||
239 | |||
228 | <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm> | 240 | <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm> |
229 | <glossdef> | 241 | <glossdef> |
230 | <para>When <filename><link linkend='var-SRCREV'>SRCREV</link></filename> | 242 | <para>When <filename><link linkend='var-SRCREV'>SRCREV</link></filename> |
@@ -6179,6 +6191,92 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
6179 | </glossdef> | 6191 | </glossdef> |
6180 | </glossentry> | 6192 | </glossentry> |
6181 | 6193 | ||
6194 | <glossentry id='var-SYSLINUX_DEFAULT_CONSOLE'><glossterm>SYSLINUX_DEFAULT_CONSOLE</glossterm> | ||
6195 | <glossdef> | ||
6196 | <para> | ||
6197 | Specifies the kernel boot default console. | ||
6198 | If you want to use a console other than the default, | ||
6199 | set this variable in your recipe as follows where "X" is | ||
6200 | the console number you want to use: | ||
6201 | <literallayout class='monospaced'> | ||
6202 | SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" | ||
6203 | </literallayout> | ||
6204 | </para> | ||
6205 | |||
6206 | <para> | ||
6207 | The | ||
6208 | <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> | ||
6209 | class initially sets this variable to null but then checks | ||
6210 | for a value later. | ||
6211 | </para> | ||
6212 | </glossdef> | ||
6213 | </glossentry> | ||
6214 | |||
6215 | <glossentry id='var-SYSLINUX_OPTS'><glossterm>SYSLINUX_OPTS</glossterm> | ||
6216 | <glossdef> | ||
6217 | <para> | ||
6218 | Lists additional options to add to the syslinux file. | ||
6219 | You need to set this variable in your recipe. | ||
6220 | If you want to list multiple options, separate the options | ||
6221 | with a semicolon character (<filename>;</filename>). | ||
6222 | </para> | ||
6223 | |||
6224 | <para> | ||
6225 | The | ||
6226 | <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> | ||
6227 | class uses this variable to create a set of options. | ||
6228 | </para> | ||
6229 | </glossdef> | ||
6230 | </glossentry> | ||
6231 | |||
6232 | <glossentry id='var-SYSLINUX_SERIAL'><glossterm>SYSLINUX_SERIAL</glossterm> | ||
6233 | <glossdef> | ||
6234 | <para> | ||
6235 | Specifies the alternate serial port or turns it off. | ||
6236 | To turn off serial, set this variable to an empty string | ||
6237 | in your recipe. | ||
6238 | The variable's default value is set in the | ||
6239 | <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> | ||
6240 | as follows: | ||
6241 | <literallayout class='monospaced'> | ||
6242 | SYSLINUX_SERIAL ?= "0 115200" | ||
6243 | </literallayout> | ||
6244 | The class checks for and uses the variable as needed. </para> | ||
6245 | </glossdef> | ||
6246 | </glossentry> | ||
6247 | |||
6248 | <glossentry id='var-SYSLINUX_SPLASH'><glossterm>SYSLINUX_SPLASH</glossterm> | ||
6249 | <glossdef> | ||
6250 | <para> | ||
6251 | An <filename>.LSS</filename> file used as the background | ||
6252 | for the VGA boot menu when you are using the boot menu. | ||
6253 | You need to set this variable in your recipe. | ||
6254 | </para> | ||
6255 | |||
6256 | <para> | ||
6257 | The | ||
6258 | <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> | ||
6259 | class checks for this variable and if found, the | ||
6260 | OpenEmbedded build system installs the splash screen. | ||
6261 | </para> | ||
6262 | </glossdef> | ||
6263 | </glossentry> | ||
6264 | |||
6265 | <glossentry id='var-SYSLINUX_SERIAL_TTY'><glossterm>SYSLINUX_SERIAL_TTY</glossterm> | ||
6266 | <glossdef> | ||
6267 | <para> | ||
6268 | Specifies the alternate console=tty... kernel boot argument. | ||
6269 | The variable's default value is set in the | ||
6270 | <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> | ||
6271 | as follows: | ||
6272 | <literallayout class='monospaced'> | ||
6273 | SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" | ||
6274 | </literallayout> | ||
6275 | The class checks for and uses the variable as needed. | ||
6276 | </para> | ||
6277 | </glossdef> | ||
6278 | </glossentry> | ||
6279 | |||
6182 | <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm> | 6280 | <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm> |
6183 | <glossdef> | 6281 | <glossdef> |
6184 | <para> | 6282 | <para> |