mirror of
https://git.yoctoproject.org/poky
synced 2026-05-09 05:29:32 +00:00
ref-manual: Updated the "Image Features" section.
The list of features in the section was out of sync with the list of features shown in the comments of the core-image class. Additionally, four of the features are available to all images regardless of whether or not the core-image class is inherited. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: e4821fd0a63e906da8b1ff015fb4970e5e62d667) 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
committed by
Richard Purdie
Richard Purdie
parent
4a908714ef
commit
328cb8ced6
@@ -207,51 +207,109 @@
|
||||
<title>Image Features</title>
|
||||
|
||||
<para>
|
||||
The contents of images generated by the OpenEmbedded build system can be controlled by the
|
||||
<filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>
|
||||
and <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename>
|
||||
The contents of images generated by the OpenEmbedded build system
|
||||
can be controlled by the
|
||||
<link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>
|
||||
and
|
||||
<link linkend='var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></link>
|
||||
variables that you typically configure in your image recipes.
|
||||
Through these variables, you can add several different
|
||||
predefined packages such as development utilities or packages with debug
|
||||
information needed to investigate application problems or profile applications.
|
||||
predefined packages such as development utilities or packages with
|
||||
debug information needed to investigate application problems or
|
||||
profile applications.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Current list of
|
||||
<filename>IMAGE_FEATURES</filename> contains the following:
|
||||
The bulk of 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:
|
||||
<itemizedlist>
|
||||
<listitem><para><emphasis>dbg-pkgs:</emphasis> Installs debug symbol packages for all packages
|
||||
installed in a given image.</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>nfs-server:</emphasis> Installs an NFS server.</para></listitem>
|
||||
<listitem><para><emphasis>read-only-rootfs:</emphasis> Creates
|
||||
an image whose root filesystem is read-only.
|
||||
<listitem><para><emphasis>dbg-pkgs:</emphasis>
|
||||
Installs debug symbol packages for all packages installed
|
||||
in a given image.
|
||||
</para></listitem>
|
||||
<listitem><para><emphasis>dbg-tweaks:</emphasis>
|
||||
Makes an image suitable for development (e.g.
|
||||
allows root logins without passwords).
|
||||
The <filename>dbg-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>
|
||||
<listitem><para><emphasis>hwcodecs:</emphasis> Installs
|
||||
hardware acceleration codecs.
|
||||
</para></listitem>
|
||||
<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.</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>ssh-server-dropbear:</emphasis> Installs the Dropbear minimal
|
||||
SSH server.
|
||||
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>ssh-server-openssh:</emphasis> Installs the OpenSSH SSH server,
|
||||
which is more full-featured than Dropbear.
|
||||
Note that if both the OpenSSH SSH server and the Dropbear minimal SSH server
|
||||
are present in <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
|
||||
<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>
|
||||
<listitem><para><emphasis>ssh-server-openssh:</emphasis>
|
||||
Installs the OpenSSH SSH server, which is more
|
||||
full-featured than Dropbear.
|
||||
Note that if both the OpenSSH SSH server and the Dropbear
|
||||
minimal SSH server are present in
|
||||
<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>.
|
||||
For information on GDB, see the
|
||||
"<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>"
|
||||
@@ -259,20 +317,29 @@
|
||||
For information on tracing and profiling, see the
|
||||
<ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>.
|
||||
</para></listitem>
|
||||
<listitem><para><emphasis>tools-profile:</emphasis> Installs profiling tools such as
|
||||
<filename>oprofile</filename>, <filename>exmap</filename>, and
|
||||
<filename>LTTng</filename>.
|
||||
<listitem><para><emphasis>tools-profile:</emphasis>
|
||||
Installs profiling tools such as
|
||||
<filename>oprofile</filename>, <filename>exmap</filename>,
|
||||
and <filename>LTTng</filename>.
|
||||
For general information on user-space tools, see the
|
||||
"<ulink url='&YOCTO_DOCS_ADT_URL;#user-space-tools'>User-Space Tools</ulink>"
|
||||
section in the Yocto Project Application Developer's Guide.</para></listitem>
|
||||
<listitem><para><emphasis>tools-sdk:</emphasis> Installs a full SDK that runs on the device.
|
||||
section in the Yocto Project Application Developer's
|
||||
Guide.
|
||||
</para></listitem>
|
||||
<listitem><para><emphasis>tools-testapps:</emphasis> Installs device testing tools (e.g.
|
||||
touchscreen debugging).</para></listitem>
|
||||
<listitem><para><emphasis>x11:</emphasis> Installs the X server</para></listitem>
|
||||
<listitem><para><emphasis>x11-base:</emphasis> Installs the X server with a
|
||||
minimal environment.</para></listitem>
|
||||
<listitem><para><emphasis>x11-sato:</emphasis> Installs the OpenedHand Sato environment.
|
||||
<listitem><para><emphasis>tools-sdk:</emphasis>
|
||||
Installs a full SDK that runs on the device.
|
||||
</para></listitem>
|
||||
<listitem><para><emphasis>tools-testapps:</emphasis>
|
||||
Installs device testing tools (e.g. touchscreen debugging).
|
||||
</para></listitem>
|
||||
<listitem><para><emphasis>x11:</emphasis>
|
||||
Installs the X server.
|
||||
</para></listitem>
|
||||
<listitem><para><emphasis>x11-base:</emphasis>
|
||||
Installs the X server with a minimal environment.
|
||||
</para></listitem>
|
||||
<listitem><para><emphasis>x11-sato:</emphasis>
|
||||
Installs the OpenedHand Sato environment.
|
||||
</para></listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
|
||||
Reference in New Issue
Block a user