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>
This commit is contained in:
Scott Rifenbark
2013-12-04 13:26:10 -06:00
committed by Richard Purdie
parent 944ee7f14b
commit c35962acfa
2 changed files with 146 additions and 0 deletions

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>