dev-manual: Updated to customizing image through variables section.

Applied Paul Eggleton's review comments on the section that
tells about enabling and disabling features through the
IMAGE_FEATURES and EXTRA_IMAGE_FEATURES variables.  Using
different wording other than "add" features.  Also, some
rewriting of an area that was rather clunky.

(From yocto-docs rev: 13e44345830130318e11b6877e2aff03e6c8ea4f)

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-04-05 06:37:33 -07:00 committed by Richard Purdie
parent 3ccd6fde21
commit 2580fcde19
1 changed files with 15 additions and 14 deletions

View File

@ -606,23 +606,21 @@
<filename>EXTRA_IMAGE_FEATURES</filename></title> <filename>EXTRA_IMAGE_FEATURES</filename></title>
<para> <para>
You might want to customize your image by adding image You might want to customize your image by enabling or
features. disabling high-level image features by using the
You add features to the existing set by using the
<ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>
and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink> and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>
variables. variables.
Although both variables are nearly identical, best practices Although both variables function nearly equivalent, best
dictate using the <filename>IMAGE_FEATURES</filename> from practices dictate using <filename>IMAGE_FEATURES</filename>
within a recipe and using from within a recipe and using
<filename>EXTRA_IMAGE_FEATURES</filename> from within <filename>EXTRA_IMAGE_FEATURES</filename> from within
your <filename>local.conf</filename>, which is found in the your <filename>local.conf</filename>, which is found in the
<link linkend='build-directory'></link>. <link linkend='build-directory'>Build Directory</link>.
</para> </para>
<para> <para>
To understand how to add features from within a recipe, To understand how these features work, the best reference is
the best reference is
<filename>meta/classes/core-image.bbclass</filename>. <filename>meta/classes/core-image.bbclass</filename>.
In summary, the file looks at the contents of the In summary, the file looks at the contents of the
<filename>IMAGE_FEATURES</filename> variable and then maps <filename>IMAGE_FEATURES</filename> variable and then maps
@ -631,7 +629,7 @@
adds the appropriate packages to the adds the appropriate packages to the
<ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink> <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>
variable. variable.
Effectively, you are adding extra features by extending the Effectively, you are enabling extra features by extending the
class or creating a custom class for use with specialized image class or creating a custom class for use with specialized image
<filename>.bb</filename> files. <filename>.bb</filename> files.
</para> </para>
@ -639,10 +637,13 @@
<para> <para>
Use the <filename>EXTRA_IMAGE_FEATURES</filename> variable Use the <filename>EXTRA_IMAGE_FEATURES</filename> variable
from within your local configuration file. from within your local configuration file.
Using a separate area from which to define features with Using a separate area from which to enable features with
this variable helps you avoid conflicting situations that this variable helps you avoid overwriting the features in the
might arise from using the variable in the same manner as image recipe that are enabled with
the <filename>IMAGE_FEATURES</filename> variable. <filename>IMAGE_FEATURES</filename>.
The value of <filename>EXTRA_IMAGE_FEATURES</filename> is added
to <filename>IMAGE_FEATURES</filename> within
<filename>meta/conf/bitbake.conf</filename>.
</para> </para>
<para> <para>