diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-04-05 06:37:33 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-04-10 16:20:54 +0100 |
| commit | 2580fcde194ae2bcdf7ad73f2b462f16e01b06b4 (patch) | |
| tree | d481a541bf4e975dd73325e0141d6f4d1a5cfb8f /documentation | |
| parent | 3ccd6fde214b4514cc5cf68f8020bbcb355581a4 (diff) | |
| download | poky-2580fcde194ae2bcdf7ad73f2b462f16e01b06b4.tar.gz | |
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>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 29 |
1 files changed, 15 insertions, 14 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index f8b41bf54d..1b57e60d05 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml | |||
| @@ -606,23 +606,21 @@ | |||
| 606 | <filename>EXTRA_IMAGE_FEATURES</filename></title> | 606 | <filename>EXTRA_IMAGE_FEATURES</filename></title> |
| 607 | 607 | ||
| 608 | <para> | 608 | <para> |
| 609 | You might want to customize your image by adding image | 609 | You might want to customize your image by enabling or |
| 610 | features. | 610 | disabling high-level image features by using the |
| 611 | You add features to the existing set by using the | ||
| 612 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink> | 611 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink> |
| 613 | and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink> | 612 | and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink> |
| 614 | variables. | 613 | variables. |
| 615 | Although both variables are nearly identical, best practices | 614 | Although both variables function nearly equivalent, best |
| 616 | dictate using the <filename>IMAGE_FEATURES</filename> from | 615 | practices dictate using <filename>IMAGE_FEATURES</filename> |
| 617 | within a recipe and using | 616 | from within a recipe and using |
| 618 | <filename>EXTRA_IMAGE_FEATURES</filename> from within | 617 | <filename>EXTRA_IMAGE_FEATURES</filename> from within |
| 619 | your <filename>local.conf</filename>, which is found in the | 618 | your <filename>local.conf</filename>, which is found in the |
| 620 | <link linkend='build-directory'></link>. | 619 | <link linkend='build-directory'>Build Directory</link>. |
| 621 | </para> | 620 | </para> |
| 622 | 621 | ||
| 623 | <para> | 622 | <para> |
| 624 | To understand how to add features from within a recipe, | 623 | To understand how these features work, the best reference is |
| 625 | the best reference is | ||
| 626 | <filename>meta/classes/core-image.bbclass</filename>. | 624 | <filename>meta/classes/core-image.bbclass</filename>. |
| 627 | In summary, the file looks at the contents of the | 625 | In summary, the file looks at the contents of the |
| 628 | <filename>IMAGE_FEATURES</filename> variable and then maps | 626 | <filename>IMAGE_FEATURES</filename> variable and then maps |
| @@ -631,7 +629,7 @@ | |||
| 631 | adds the appropriate packages to the | 629 | adds the appropriate packages to the |
| 632 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink> | 630 | <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink> |
| 633 | variable. | 631 | variable. |
| 634 | Effectively, you are adding extra features by extending the | 632 | Effectively, you are enabling extra features by extending the |
| 635 | class or creating a custom class for use with specialized image | 633 | class or creating a custom class for use with specialized image |
| 636 | <filename>.bb</filename> files. | 634 | <filename>.bb</filename> files. |
| 637 | </para> | 635 | </para> |
| @@ -639,10 +637,13 @@ | |||
| 639 | <para> | 637 | <para> |
| 640 | Use the <filename>EXTRA_IMAGE_FEATURES</filename> variable | 638 | Use the <filename>EXTRA_IMAGE_FEATURES</filename> variable |
| 641 | from within your local configuration file. | 639 | from within your local configuration file. |
| 642 | Using a separate area from which to define features with | 640 | Using a separate area from which to enable features with |
| 643 | this variable helps you avoid conflicting situations that | 641 | this variable helps you avoid overwriting the features in the |
| 644 | might arise from using the variable in the same manner as | 642 | image recipe that are enabled with |
| 645 | the <filename>IMAGE_FEATURES</filename> variable. | 643 | <filename>IMAGE_FEATURES</filename>. |
| 644 | The value of <filename>EXTRA_IMAGE_FEATURES</filename> is added | ||
| 645 | to <filename>IMAGE_FEATURES</filename> within | ||
| 646 | <filename>meta/conf/bitbake.conf</filename>. | ||
| 646 | </para> | 647 | </para> |
| 647 | 648 | ||
| 648 | <para> | 649 | <para> |
