diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml index 242dfe0737..cc4f3456c1 100644 --- a/documentation/ref-manual/ref-features.xml +++ b/documentation/ref-manual/ref-features.xml @@ -207,51 +207,109 @@ Image Features - The contents of images generated by the OpenEmbedded build system can be controlled by the - IMAGE_FEATURES - and EXTRA_IMAGE_FEATURES + The contents of images generated by the OpenEmbedded build system + can be controlled by the + IMAGE_FEATURES + and + EXTRA_IMAGE_FEATURES 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. - Current list of - IMAGE_FEATURES contains the following: + The bulk of image features are available only when you inherit the + core-image + class. + However, some features, as noted in the following list, are + available to all images. + The current list of valid IMAGE_FEATURES + is as follows: - dbg-pkgs: Installs debug symbol packages for all packages - installed in a given image. - dev-pkgs: Installs development packages (headers and - extra library links) for all packages installed in a given image. - doc-pkgs: Installs documentation packages for all packages - installed in a given image. - nfs-server: Installs an NFS server. - read-only-rootfs: Creates - an image whose root filesystem is read-only. + dbg-pkgs: + Installs debug symbol packages for all packages installed + in a given image. + + dbg-tweaks: + Makes an image suitable for development (e.g. + allows root logins without passwords). + The dbg-tweaks feature is + available for all images regardless of whether or not + the core-image class is inherited. + + dev-pkgs: + Installs development packages (headers and extra library + links) for all packages installed in a given image. + + doc-pkgs: Installs + documentation packages for all packages installed in a + given image. + + eclipse-debug: Provides + Eclipse remote debugging support. + + hwcodecs: Installs + hardware acceleration codecs. + + nfs-server: + Installs an NFS server. + + package-management: + Installs package management tools and preserves the package + manager database. + The package-management feature is + available for all images regardless of whether or not + the core-image class is inherited. + + ptest-pkgs: + Installs ptest packages for all ptest-enabled recipes. + + qt4-pkgs: + Supports Qt4/X11 and demo applications. + + read-only-rootfs: + Creates an image whose root filesystem is read-only. See the "Creating a Read-Only Root Filesystem" section in the Yocto Project Development Manual for more - information. - splash: Enables showing a splash screen during boot. - By default, this screen is provided by psplash, which does - allow customization. - If you prefer to use an alternative splash screen package, you can do so by - setting the SPLASH variable - to a different package name (or names) within the image recipe or at the distro - configuration level. - ssh-server-dropbear: Installs the Dropbear minimal - SSH server. + information. + The read-only-rootfs feature is + available for all images regardless of whether or not + the core-image class is inherited. - ssh-server-openssh: 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 IMAGE_FEATURES, then OpenSSH will take - precedence and Dropbear will not be installed. - staticdev-pkgs: Installs static development - packages (i.e. static libraries containing *.a files) for all - packages installed in a given image. - tools-debug: Installs debugging tools such as + splash: + Enables showing a splash screen during boot. + By default, this screen is provided by + psplash, which does allow + customization. + If you prefer to use an alternative splash screen package, + you can do so by setting the SPLASH + variable to a different package name (or names) within the + image recipe or at the distro configuration level. + The splash feature is + available for all images regardless of whether or not + the core-image class is inherited. + + ssh-server-dropbear: + Installs the Dropbear minimal SSH server. + + ssh-server-openssh: + 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 + IMAGE_FEATURES, then OpenSSH will take + precedence and Dropbear will not be installed. + + staticdev-pkgs: + Installs static development packages (i.e. static + libraries containing *.a files) for + all packages installed in a given image. + + tools-debug: + Installs debugging tools such as strace and gdb. For information on GDB, see the "Debugging With the GNU Project Debugger (GDB) Remotely" @@ -259,20 +317,29 @@ For information on tracing and profiling, see the Yocto Project Profiling and Tracing Manual. - tools-profile: Installs profiling tools such as - oprofile, exmap, and - LTTng. + tools-profile: + Installs profiling tools such as + oprofile, exmap, + and LTTng. For general information on user-space tools, see the "User-Space Tools" - section in the Yocto Project Application Developer's Guide. - tools-sdk: Installs a full SDK that runs on the device. + section in the Yocto Project Application Developer's + Guide. - tools-testapps: Installs device testing tools (e.g. - touchscreen debugging). - x11: Installs the X server - x11-base: Installs the X server with a - minimal environment. - x11-sato: Installs the OpenedHand Sato environment. + tools-sdk: + Installs a full SDK that runs on the device. + + tools-testapps: + Installs device testing tools (e.g. touchscreen debugging). + + x11: + Installs the X server. + + x11-base: + Installs the X server with a minimal environment. + + x11-sato: + Installs the OpenedHand Sato environment.