ref-manual: Edits to the "Image Features" section layout

I updated the section to have two lists of features.  One list
is for features that work only when you inherit the core-image
class.  The other list is for features that are available for
all images regargless of inheriting this class.

(From yocto-docs rev: 9d1bcab2a9264e64db2dec66247aaf55493ae362)

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
2014-09-30 11:33:27 -07:00
committed by Richard Purdie
parent 380ec32a4d
commit 6d843e6336

View File

@@ -220,33 +220,11 @@
</para>
<para>
The bulk of image features are available only when you inherit the
Some image features are available only when you inherit the
<link linkend='ref-classes-core-image'><filename>core-image</filename></link>
class.
However, some features, as noted in the following list, are
available to all images.
The current list of valid <filename>IMAGE_FEATURES</filename>
is as follows:
The current list of these valid variables is as follows:
<itemizedlist>
<listitem><para><emphasis>dbg-pkgs:</emphasis>
Installs debug symbol packages for all packages installed
in a given image.
</para></listitem>
<listitem><para><emphasis>debug-tweaks:</emphasis>
Makes an image suitable for development (e.g.
allows root logins without passwords).
The <filename>debug-tweaks</filename> feature is
available for all images regardless of whether or not
the <filename>core-image</filename> class is inherited.
</para></listitem>
<listitem><para><emphasis>dev-pkgs:</emphasis>
Installs development packages (headers and extra library
links) for all packages installed in a given image.
</para></listitem>
<listitem><para><emphasis>doc-pkgs:</emphasis> Installs
documentation packages for all packages installed in a
given image.
</para></listitem>
<listitem><para><emphasis>eclipse-debug:</emphasis> Provides
Eclipse remote debugging support.
</para></listitem>
@@ -256,42 +234,9 @@
<listitem><para><emphasis>nfs-server:</emphasis>
Installs an NFS server.
</para></listitem>
<listitem><para><emphasis>package-management:</emphasis>
Installs package management tools and preserves the package
manager database.
The <filename>package-management</filename> feature is
available for all images regardless of whether or not
the <filename>core-image</filename> class is inherited.
</para></listitem>
<listitem><para><emphasis>ptest-pkgs:</emphasis>
Installs ptest packages for all ptest-enabled recipes.
</para></listitem>
<listitem><para><emphasis>qt4-pkgs:</emphasis>
Supports Qt4/X11 and demo applications.
</para></listitem>
<listitem><para><emphasis>read-only-rootfs:</emphasis>
Creates an image whose root filesystem is read-only.
See the
"<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>"
section in the Yocto Project Development Manual for more
information.
The <filename>read-only-rootfs</filename> feature is
available for all images regardless of whether or not
the <filename>core-image</filename> class is inherited.
</para></listitem>
<listitem><para><emphasis>splash:</emphasis>
Enables showing a splash screen during boot.
By default, this screen is provided by
<filename>psplash</filename>, which does allow
customization.
If you prefer to use an alternative splash screen package,
you can do so by setting the <filename>SPLASH</filename>
variable to a different package name (or names) within the
image recipe or at the distro configuration level.
The <filename>splash</filename> feature is
available for all images regardless of whether or not
the <filename>core-image</filename> class is inherited.
</para></listitem>
<listitem><para><emphasis>ssh-server-dropbear:</emphasis>
Installs the Dropbear minimal SSH server.
</para></listitem>
@@ -303,11 +248,6 @@
<filename>IMAGE_FEATURES</filename>, then OpenSSH will take
precedence and Dropbear will not be installed.
</para></listitem>
<listitem><para><emphasis>staticdev-pkgs:</emphasis>
Installs static development packages (i.e. static
libraries containing <filename>*.a</filename> files) for
all packages installed in a given image.
</para></listitem>
<listitem><para><emphasis>tools-debug:</emphasis>
Installs debugging tools such as
<filename>strace</filename> and <filename>gdb</filename>.
@@ -343,6 +283,60 @@
</para></listitem>
</itemizedlist>
</para>
<para>
Other image features are available for all images regardless of
whether or not you inherit the <filename>core-image</filename>
class.
The list of these valid variables is as follows:
<itemizedlist>
<listitem><para><emphasis>dbg-pkgs:</emphasis>
Installs debug symbol packages for all packages installed
in a given image.
</para></listitem>
<listitem><para><emphasis>debug-tweaks:</emphasis>
Makes an image suitable for development (e.g.
allows root logins without passwords).
</para></listitem>
<listitem><para><emphasis>dev-pkgs:</emphasis>
Installs development packages (headers and extra library
links) for all packages installed in a given image.
</para></listitem>
<listitem><para><emphasis>doc-pkgs:</emphasis> Installs
documentation packages for all packages installed in a
given image.
</para></listitem>
<listitem><para><emphasis>package-management:</emphasis>
Installs package management tools and preserves the package
manager database.
</para></listitem>
<listitem><para><emphasis>ptest-pkgs:</emphasis>
Installs ptest packages for all ptest-enabled recipes.
</para></listitem>
<listitem><para><emphasis>read-only-rootfs:</emphasis>
Creates an image whose root filesystem is read-only.
See the
"<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>"
section in the Yocto Project Development Manual for more
information.
</para></listitem>
<listitem><para><emphasis>splash:</emphasis>
Enables showing a splash screen during boot.
By default, this screen is provided by
<filename>psplash</filename>, which does allow
customization.
If you prefer to use an alternative splash screen package,
you can do so by setting the <filename>SPLASH</filename>
variable to a different package name (or names) within the
image recipe or at the distro configuration level.
</para></listitem>
<listitem><para><emphasis>staticdev-pkgs:</emphasis>
Installs static development packages (i.e. static
libraries containing <filename>*.a</filename> files) for
all packages installed in a given image.
</para></listitem>
</itemizedlist>
</para>
</section>
<section id='ref-features-backfill'>