summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-04-03 15:04:32 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-04-04 14:13:46 +0100
commit3676e083ef313be2573d7929bca96fa2ab479266 (patch)
tree27c2dee1f61357ab26fc1996be45790c6bbcdd81 /documentation/dev-manual
parent56ce44aa805389427bb4d6fd02a49e53d7a33cad (diff)
downloadpoky-3676e083ef313be2573d7929bca96fa2ab479266.tar.gz
dev-manual: Edits to adding features through variables section.
I cleaned up the wording to indicate best places from which to use the IMAGE_FEATURES and EXTRA_IMAGE_FEATURES variables. (From yocto-docs rev: 68e9c8b3f8d9fe3a086ad77bc0c3b465380476b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml78
1 files changed, 56 insertions, 22 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 43dc61fb24..031d9fca37 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -606,28 +606,43 @@
606 <filename>EXTRA_IMAGE_FEATURES</filename></title> 606 <filename>EXTRA_IMAGE_FEATURES</filename></title>
607 607
608 <para> 608 <para>
609 Ultimately, you might want to add extra image features to the 609 You might want to customize your image by adding image
610 set by using the 610 features.
611 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'>IMAGE_FEATURES</ulink></filename> 611 You add features to the existing set by using the
612 variable. 612 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>
613 To create these features, the best reference is 613 and <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>
614 <filename>meta/classes/core-image.bbclass</filename>, which 614 variables.
615 shows how you can add features. 615 Although both variables are nearly identical, best practices
616 dictate using the <filename>IMAGE_FEATURES</filename> from
617 within a recipe and using
618 <filename>EXTRA_IMAGE_FEATURES</filename> from within
619 your <filename>local.conf</filename>, which is found in the
620 <link linkend='build-directory'></link>.
621 </para>
622
623 <para>
624 To understand how to add features from within a recipe,
625 the best reference is
626 <filename>meta/classes/core-image.bbclass</filename>.
616 In summary, the file looks at the contents of the 627 In summary, the file looks at the contents of the
617 <filename>IMAGE_FEATURES</filename> variable and then maps those 628 <filename>IMAGE_FEATURES</filename> variable and then maps
618 contents into a set of tasks or packages. 629 those contents into a set of package groups.
619 Based on this information, the build system automatically 630 Based on this information, the build system automatically
620 generates the 631 adds the appropriate packages to the
621 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'> IMAGE_INSTALL</ulink></filename> 632 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></ulink>
622 variable. 633 variable.
623 You can add extra features by extending the class or creating a 634 Effectively, you are adding extra features by extending the
624 custom class for use with specialized image 635 class or creating a custom class for use with specialized image
625 <filename>.bb</filename> files. 636 <filename>.bb</filename> files.
626 You can also add more features by configuring the 637 </para>
627 <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</ulink></filename> 638
628 variable in the <filename>local.conf</filename> file found in 639 <para>
629 the <filename>local.conf</filename> file, which is located in 640 Use the <filename>EXTRA_IMAGE_FEATURES</filename> variable
630 the <link linkend='build-directory'>Build Directory</link>. 641 from within your local configuration file.
642 Using a separate area from which to define features with
643 this variable helps you avoid conflicting situations that
644 might arise from using the variable in the same manner as
645 the <filename>IMAGE_FEATURES</filename> variable.
631 </para> 646 </para>
632 647
633 <para> 648 <para>
@@ -649,11 +664,21 @@
649 664
650 <para> 665 <para>
651 You can customize your image and change these defaults. 666 You can customize your image and change these defaults.
652 Edit <filename>IMAGE_FEATURES</filename> variable 667 Edit the <filename>IMAGE_FEATURES</filename> variable
653 so that it configures the image you are working with to 668 in your recipe or use the
654 include <filename>ssh-server-dropbear</filename> or 669 <filename>EXTRA_IMAGE_FEATURES</filename> in your
670 <filename>local.conf</filename> file so that it configures the
671 image you are working with to include
672 <filename>ssh-server-dropbear</filename> or
655 <filename>ssh-server-openssh</filename>. 673 <filename>ssh-server-openssh</filename>.
656 </para> 674 </para>
675
676 <note>
677 See the
678 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
679 section in the Yocto Project Reference Manual for a complete
680 list of image features that ship with the Yocto Project.
681 </note>
657 </section> 682 </section>
658 683
659 <section id='usingpoky-extend-customimage-localconf'> 684 <section id='usingpoky-extend-customimage-localconf'>
@@ -3092,13 +3117,19 @@
3092 variable. 3117 variable.
3093 </para></listitem> 3118 </para></listitem>
3094 <listitem><para> 3119 <listitem><para>
3095 You have a supported web server, such as Apache 2, 3120 You have a web server, such as Apache 2,
3096 installed and configured on the development host. 3121 installed and configured on the development host.
3097 </para></listitem> 3122 </para></listitem>
3098 <listitem><para> 3123 <listitem><para>
3099 You have <filename>createrepo</filename> installed on 3124 You have <filename>createrepo</filename> installed on
3100 the development host. 3125 the development host.
3101 </para></listitem> 3126 </para></listitem>
3127 <listitem><para>
3128 You enable package management on the target by
3129 listing "package-management" in the
3130 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></ulink>
3131 variable.
3132 </para></listitem>
3102 </itemizedlist> 3133 </itemizedlist>
3103 </para> 3134 </para>
3104 3135
@@ -3435,6 +3466,9 @@
3435 read-only root filesystem: 3466 read-only root filesystem:
3436 <literallayout class='monospaced'> 3467 <literallayout class='monospaced'>
3437 IMAGE_FEATURES = "read-only-rootfs" 3468 IMAGE_FEATURES = "read-only-rootfs"
3469 </literallayout>
3470 or
3471 <literallayout class='monospaced'>
3438 EXTRA_IMAGE_FEATURES = "read-only-rootfs" 3472 EXTRA_IMAGE_FEATURES = "read-only-rootfs"
3439 </literallayout> 3473 </literallayout>
3440 </para> 3474 </para>