documentation/poky-ref-manual/ref-variables.xml - YOCTO #1104 EXTRA_IMAGE_FEATURES

YOCTO #1104 - Added a glossary entry for the EXTRA_IMAGE_FEATURES
variable.

(From yocto-docs rev: f81a85322d944d33484da73020593891811a045a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 43 insertions, 0 deletions

diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 8b1470b533..1aa00f3d84 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -297,6 +297,49 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-EXTRA_IMAGE_FEATURES'><glossterm>EXTRA_IMAGE_FEATURES</glossterm>
+            <glossdef>
+                <para>Allows extra packages to be added to the generated images.
+                    You set this variable in the <filename>local.conf</filename>
+                    configuration file.
+                    Note that some image features are also added using the 
+                    <link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link>
+                    variable generally configured in image recipes.
+                    You can use the EXTRA_IMAGE_FEATURES variable to add more features
+                    in addition to those.
+                    Here are some exmaples of features you can add:</para>
+                    <literallayout class='monospaced'>
+"dbg-pkgs" - Adds -dbg packages for all installed packages
+             including symbol information for debugging and 
+             profiling.
+
+"dev-pkgs" - Adds -dev packages for all installed packages.  
+             This is useful if you want to develop against 
+             the libraries in the image.
+
+"tools-sdk" - Adds development tools such as gcc, make, 
+              pkgconfig and so forth.
+
+"tools-debug" - Adds debugging tools such as gdb and 
+                strace.
+
+"tools-profile" - Adds profiling tools such as oprofile, 
+                  exmap, lttng and valgrind (x86 only).
+
+"tools-testapps" - Adds useful testing tools such as ts_print, 
+                   aplay, arecord and so forth.
+
+"debug-tweaks" - Makes an image suitable for development.  
+                 For example, ssh root access has a blank 
+                 password.  There are other application 
+                 targets too, see meta/classes/poky-image.bbclass
+                 and meta/packages/tasks/task-poky.bb 
+                 for more details.
+                    </literallayout> 
+
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm>
             <glossdef>
                 <para>Additional cmake options</para>