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 @@ EXTRA_IMAGE_FEATURES - Ultimately, you might want to add extra image features to the - set by using the - IMAGE_FEATURES - variable. - To create these features, the best reference is - meta/classes/core-image.bbclass, which - shows how you can add features. + You might want to customize your image by adding image + features. + You add features to the existing set by using the + IMAGE_FEATURES + and EXTRA_IMAGE_FEATURES + variables. + Although both variables are nearly identical, best practices + dictate using the IMAGE_FEATURES from + within a recipe and using + EXTRA_IMAGE_FEATURES from within + your local.conf, which is found in the + . + + + + To understand how to add features from within a recipe, + the best reference is + meta/classes/core-image.bbclass. In summary, the file looks at the contents of the - IMAGE_FEATURES variable and then maps those - contents into a set of tasks or packages. + IMAGE_FEATURES variable and then maps + those contents into a set of package groups. Based on this information, the build system automatically - generates the - IMAGE_INSTALL + adds the appropriate packages to the + IMAGE_INSTALL variable. - You can add extra features by extending the class or creating a - custom class for use with specialized image + Effectively, you are adding extra features by extending the + class or creating a custom class for use with specialized image .bb files. - You can also add more features by configuring the - EXTRA_IMAGE_FEATURES - variable in the local.conf file found in - the local.conf file, which is located in - the Build Directory. + + + + Use the EXTRA_IMAGE_FEATURES variable + from within your local configuration file. + Using a separate area from which to define features with + this variable helps you avoid conflicting situations that + might arise from using the variable in the same manner as + the IMAGE_FEATURES variable. @@ -649,11 +664,21 @@ You can customize your image and change these defaults. - Edit IMAGE_FEATURES variable - so that it configures the image you are working with to - include ssh-server-dropbear or + Edit the IMAGE_FEATURES variable + in your recipe or use the + EXTRA_IMAGE_FEATURES in your + local.conf file so that it configures the + image you are working with to include + ssh-server-dropbear or ssh-server-openssh. + + + See the + "Images" + section in the Yocto Project Reference Manual for a complete + list of image features that ship with the Yocto Project. +
@@ -3092,13 +3117,19 @@ variable. - You have a supported web server, such as Apache 2, + You have a web server, such as Apache 2, installed and configured on the development host. You have createrepo installed on the development host. + + You enable package management on the target by + listing "package-management" in the + IMAGE_FEATURES + variable. + @@ -3435,6 +3466,9 @@ read-only root filesystem: IMAGE_FEATURES = "read-only-rootfs" + + or + EXTRA_IMAGE_FEATURES = "read-only-rootfs"