sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2013-12-04 13:26:10 -06:00 committed by Richard Purdie
parent 234ea4b9ba
commit 4dcaea2128
2 changed files with 146 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
documentation/ref-manual/ref-classes.xml
View File

@ -1979,6 +1979,54 @@
</para>
</section>
<section id='ref-classes-syslinux'>
<title><filename>syslinux.bbclass</filename></title>
<para>
The <filename>syslinux</filename> class provides syslinux-specific
functions for building bootable images.
</para>
<para>
The class supports the following variables:
<itemizedlist>
<listitem><para><emphasis><link linkend='var-INITRD'><filename>INITRD</filename></link>:</emphasis>
Indicates a filesystem image to use as an initial RAM disk
(initrd).
This variable is optional.</para></listitem>
<listitem><para><emphasis><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>:</emphasis>
Indicates a filesystem image to include as the root filesystem.
This variable is optional.</para></listitem>
<listitem><para><emphasis><link linkend='var-AUTO_SYSLINUXMENU'><filename>AUTO_SYSLINUXMENU</filename></link>:</emphasis>
Enables creating an automatic menu when set to "1".
</para></listitem>
<listitem><para><emphasis><link linkend='var-LABELS'><filename>LABELS</filename></link>:</emphasis>
Lists targets for automatic configuration.
</para></listitem>
<listitem><para><emphasis><link linkend='var-APPEND'><filename>APPEND</filename></link>:</emphasis>
Lists append string overrides for each label.
</para></listitem>
<listitem><para><emphasis><link linkend='var-SYSLINUX_OPTS'><filename>SYSLINUX_OPTS</filename></link>:</emphasis>
Lists additional options to add to the syslinux file.
Semicolon characters separate multiple options.
</para></listitem>
<listitem><para><emphasis><link linkend='var-SYSLINUX_SPLASH'><filename>SYSLINUX_SPLASH</filename></link>:</emphasis>
Lists a background for the VGA boot menu when you are using the
boot menu.</para></listitem>
<listitem><para><emphasis><link linkend='var-SYSLINUX_DEFAULT_CONSOLE'><filename>SYSLINUX_DEFAULT_CONSOLE</filename></link>:</emphasis>
Set to "console=ttyX" to change kernel boot default console.
</para></listitem>
<listitem><para><emphasis><link linkend='var-SYSLINUX_SERIAL'><filename>SYSLINUX_SERIAL</filename></link>:</emphasis>
Sets an alternate serial port.
Or, turns off serial when the variable is set with an
empty string.</para></listitem>
<listitem><para><emphasis><link linkend='var-SYSLINUX_SERIAL_TTY'><filename>SYSLINUX_SERIAL_TTY</filename></link>:</emphasis>
Sets an alternate "console=tty..." kernel boot argument.
</para></listitem>
</itemizedlist>
</para>
</section>
<section id='ref-classes-package_tar'>
<title><filename>package_tar.bbclass</filename></title>

98
documentation/ref-manual/ref-variables.xml
View File

@ -225,6 +225,18 @@
</glossdef>
</glossentry>
<glossentry id='var-AUTO_SYSLINUXMENU'><glossterm>AUTO_SYSLINUXMENU</glossterm>
<glossdef>
<para>
Enables creating an automatic menu.
You must set this in your recipe.
The
<link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
class checks this variable.
</para>
</glossdef>
</glossentry>
<glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm>
<glossdef>
<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"
</glossdef>
</glossentry>
<glossentry id='var-SYSLINUX_DEFAULT_CONSOLE'><glossterm>SYSLINUX_DEFAULT_CONSOLE</glossterm>
<glossdef>
<para>
Specifies the kernel boot default console.
If you want to use a console other than the default,
set this variable in your recipe as follows where "X" is
the console number you want to use:
<literallayout class='monospaced'>
SYSLINUX_DEFAULT_CONSOLE = "console=ttyX"
</literallayout>
</para>
<para>
The
<link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
class initially sets this variable to null but then checks
for a value later.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SYSLINUX_OPTS'><glossterm>SYSLINUX_OPTS</glossterm>
<glossdef>
<para>
Lists additional options to add to the syslinux file.
You need to set this variable in your recipe.
If you want to list multiple options, separate the options
with a semicolon character (<filename>;</filename>).
</para>
<para>
The
<link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
class uses this variable to create a set of options.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SYSLINUX_SERIAL'><glossterm>SYSLINUX_SERIAL</glossterm>
<glossdef>
<para>
Specifies the alternate serial port or turns it off.
To turn off serial, set this variable to an empty string
in your recipe.
The variable's default value is set in the
<link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
as follows:
<literallayout class='monospaced'>
SYSLINUX_SERIAL ?= "0 115200"
</literallayout>
The class checks for and uses the variable as needed. </para>
</glossdef>
</glossentry>
<glossentry id='var-SYSLINUX_SPLASH'><glossterm>SYSLINUX_SPLASH</glossterm>
<glossdef>
<para>
An <filename>.LSS</filename> file used as the background
for the VGA boot menu when you are using the boot menu.
You need to set this variable in your recipe.
</para>
<para>
The
<link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
class checks for this variable and if found, the
OpenEmbedded build system installs the splash screen.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SYSLINUX_SERIAL_TTY'><glossterm>SYSLINUX_SERIAL_TTY</glossterm>
<glossdef>
<para>
Specifies the alternate console=tty... kernel boot argument.
The variable's default value is set in the
<link linkend='ref-classes-syslinux'><filename>syslinux</filename></link>
as follows:
<literallayout class='monospaced'>
SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200"
</literallayout>
The class checks for and uses the variable as needed.
</para>
</glossdef>
</glossentry>
<glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm>
<glossdef>
<para>