summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-12-04 13:26:10 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-11 14:18:55 +0000
commitc35962acfa4d999359c8bab5b39aea72d41f5754 (patch)
tree5d496c27678c4e72521fe092b3e2eac0933fcfad /documentation/ref-manual
parent944ee7f14b6779f7dfd8e1e5d008d6788b3ba22d (diff)
downloadpoky-c35962acfa4d999359c8bab5b39aea72d41f5754.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: cb47fab2ba00617c8205b36a83b7e97f5504c5d9) 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')
-rw-r--r--documentation/ref-manual/ref-classes.xml48
-rw-r--r--documentation/ref-manual/ref-variables.xml98
2 files changed, 146 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 756acee71c..bd1ec36ae3 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1979,6 +1979,54 @@
1979 </para> 1979 </para>
1980</section> 1980</section>
1981 1981
1982<section id='ref-classes-syslinux'>
1983 <title><filename>syslinux.bbclass</filename></title>
1984
1985 <para>
1986 The <filename>syslinux</filename> class provides syslinux-specific
1987 functions for building bootable images.
1988 </para>
1989
1990 <para>
1991 The class supports the following variables:
1992 <itemizedlist>
1993 <listitem><para><emphasis><link linkend='var-INITRD'><filename>INITRD</filename></link>:</emphasis>
1994 Indicates a filesystem image to use as an initial RAM disk
1995 (initrd).
1996 This variable is optional.</para></listitem>
1997 <listitem><para><emphasis><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>:</emphasis>
1998 Indicates a filesystem image to include as the root filesystem.
1999 This variable is optional.</para></listitem>
2000 <listitem><para><emphasis><link linkend='var-AUTO_SYSLINUXMENU'><filename>AUTO_SYSLINUXMENU</filename></link>:</emphasis>
2001 Enables creating an automatic menu when set to "1".
2002 </para></listitem>
2003 <listitem><para><emphasis><link linkend='var-LABELS'><filename>LABELS</filename></link>:</emphasis>
2004 Lists targets for automatic configuration.
2005 </para></listitem>
2006 <listitem><para><emphasis><link linkend='var-APPEND'><filename>APPEND</filename></link>:</emphasis>
2007 Lists append string overrides for each label.
2008 </para></listitem>
2009 <listitem><para><emphasis><link linkend='var-SYSLINUX_OPTS'><filename>SYSLINUX_OPTS</filename></link>:</emphasis>
2010 Lists additional options to add to the syslinux file.
2011 Semicolon characters separate multiple options.
2012 </para></listitem>
2013 <listitem><para><emphasis><link linkend='var-SYSLINUX_SPLASH'><filename>SYSLINUX_SPLASH</filename></link>:</emphasis>
2014 Lists a background for the VGA boot menu when you are using the
2015 boot menu.</para></listitem>
2016 <listitem><para><emphasis><link linkend='var-SYSLINUX_DEFAULT_CONSOLE'><filename>SYSLINUX_DEFAULT_CONSOLE</filename></link>:</emphasis>
2017 Set to "console=ttyX" to change kernel boot default console.
2018 </para></listitem>
2019 <listitem><para><emphasis><link linkend='var-SYSLINUX_SERIAL'><filename>SYSLINUX_SERIAL</filename></link>:</emphasis>
2020 Sets an alternate serial port.
2021 Or, turns off serial when the variable is set with an
2022 empty string.</para></listitem>
2023 <listitem><para><emphasis><link linkend='var-SYSLINUX_SERIAL_TTY'><filename>SYSLINUX_SERIAL_TTY</filename></link>:</emphasis>
2024 Sets an alternate "console=tty..." kernel boot argument.
2025 </para></listitem>
2026 </itemizedlist>
2027 </para>
2028</section>
2029
1982<section id='ref-classes-package_tar'> 2030<section id='ref-classes-package_tar'>
1983 <title><filename>package_tar.bbclass</filename></title> 2031 <title><filename>package_tar.bbclass</filename></title>
1984 2032
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>