diff options
-rw-r--r-- | documentation/ref-manual/ref-images.xml | 8 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 78 |
2 files changed, 58 insertions, 28 deletions
diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml index 529decfc96..b12c49ac78 100644 --- a/documentation/ref-manual/ref-images.xml +++ b/documentation/ref-manual/ref-images.xml | |||
@@ -61,10 +61,14 @@ | |||
61 | The image includes headers and libraries you can use in a host development | 61 | The image includes headers and libraries you can use in a host development |
62 | environment. | 62 | environment. |
63 | </para></listitem> | 63 | </para></listitem> |
64 | <listitem><para><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis> | 64 | <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis> |
65 | A <filename>core-image-minimal</filename> image that has the Minimal RAM-based | 65 | A <filename>core-image-minimal</filename> image that has the Minimal RAM-based |
66 | Initial Root Filesystem (<filename>initramfs</filename>) as part of the kernel, | 66 | Initial Root Filesystem (initramfs) as part of the kernel, |
67 | which allows the system to find the first “init” program more efficiently. | 67 | which allows the system to find the first “init” program more efficiently. |
68 | See the | ||
69 | <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link> | ||
70 | variable for additional information helpful when working with | ||
71 | initramfs images. | ||
68 | </para></listitem> | 72 | </para></listitem> |
69 | <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis> | 73 | <listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis> |
70 | A <filename>core-image-minimal</filename> image that has support | 74 | A <filename>core-image-minimal</filename> image that has support |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 984d6b1e3d..0d62e67809 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -2962,33 +2962,52 @@ | |||
2962 | <glossdef> | 2962 | <glossdef> |
2963 | <para> | 2963 | <para> |
2964 | Specifies the packages to install into an image. | 2964 | Specifies the packages to install into an image. |
2965 | The <filename>IMAGE_INSTALL</filename> variable is a mechanism for an image | 2965 | The <filename>IMAGE_INSTALL</filename> variable is a |
2966 | recipe and you should use it with care to avoid ordering issues. | 2966 | mechanism for an image recipe and you should use it |
2967 | with care to avoid ordering issues. | ||
2968 | <note> | ||
2969 | When working with an | ||
2970 | <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link> | ||
2971 | image, do not use the <filename>IMAGE_INSTALL</filename> | ||
2972 | variable to specify packages for installation. | ||
2973 | Instead, use the | ||
2974 | <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link> | ||
2975 | variable, which allows the initial RAM disk (initramfs) | ||
2976 | recipe to use a fixed set of packages and not be | ||
2977 | affected by <filename>IMAGE_INSTALL</filename>. | ||
2978 | </note> | ||
2967 | </para> | 2979 | </para> |
2968 | 2980 | ||
2969 | <para> | 2981 | <para> |
2970 | Image recipes set <filename>IMAGE_INSTALL</filename> to specify the | 2982 | Image recipes set <filename>IMAGE_INSTALL</filename> |
2971 | packages to install into an image through <filename>image.bbclass</filename>. | 2983 | to specify the packages to install into an image through |
2972 | Additionally, "helper" classes exist, such as <filename>core-image.bbclass</filename>, | 2984 | <filename>image.bbclass</filename>. |
2973 | that can take | 2985 | Additionally, "helper" classes exist, such as |
2974 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> lists | 2986 | <filename>core-image.bbclass</filename>, that can take |
2975 | and turn these into auto-generated entries in | 2987 | <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> |
2976 | <filename>IMAGE_INSTALL</filename> in addition to its default contents. | 2988 | lists and turn these into auto-generated entries in |
2989 | <filename>IMAGE_INSTALL</filename> in addition to its | ||
2990 | default contents. | ||
2977 | </para> | 2991 | </para> |
2978 | 2992 | ||
2979 | <para> | 2993 | <para> |
2980 | Using <filename>IMAGE_INSTALL</filename> with the <filename>+=</filename> | 2994 | Using <filename>IMAGE_INSTALL</filename> with the |
2981 | operator from the <filename>/conf/local.conf</filename> file or from within | 2995 | <filename>+=</filename> operator from the |
2982 | an image recipe is not recommended as it can cause ordering issues. | 2996 | <filename>/conf/local.conf</filename> file or from within |
2983 | Since <filename>core-image.bbclass</filename> sets <filename>IMAGE_INSTALL</filename> | 2997 | an image recipe is not recommended as it can cause ordering |
2984 | to a default value using the <filename>?=</filename> operator, using a | 2998 | issues. |
2985 | <filename>+=</filename> operation against <filename>IMAGE_INSTALL</filename> | 2999 | Since <filename>core-image.bbclass</filename> sets |
2986 | will result in unexpected behavior when used in | 3000 | <filename>IMAGE_INSTALL</filename> to a default value using |
3001 | the <filename>?=</filename> operator, using a | ||
3002 | <filename>+=</filename> operation against | ||
3003 | <filename>IMAGE_INSTALL</filename> will result in | ||
3004 | unexpected behavior when used in | ||
2987 | <filename>conf/local.conf</filename>. | 3005 | <filename>conf/local.conf</filename>. |
2988 | Furthermore, the same operation from within an image recipe may or may not | 3006 | Furthermore, the same operation from within an image |
2989 | succeed depending on the specific situation. | 3007 | recipe may or may not succeed depending on the specific |
2990 | In both these cases, the behavior is contrary to how most users expect | 3008 | situation. |
2991 | the <filename>+=</filename> operator to work. | 3009 | In both these cases, the behavior is contrary to how most |
3010 | users expect the <filename>+=</filename> operator to work. | ||
2992 | </para> | 3011 | </para> |
2993 | 3012 | ||
2994 | <para> | 3013 | <para> |
@@ -2996,8 +3015,8 @@ | |||
2996 | <literallayout class='monospaced'> | 3015 | <literallayout class='monospaced'> |
2997 | IMAGE_INSTALL_append = " package-name" | 3016 | IMAGE_INSTALL_append = " package-name" |
2998 | </literallayout> | 3017 | </literallayout> |
2999 | Be sure to include the space between the quotation character and the start of the | 3018 | Be sure to include the space between the quotation character |
3000 | package name or names. | 3019 | and the start of the package name or names. |
3001 | </para> | 3020 | </para> |
3002 | </glossdef> | 3021 | </glossdef> |
3003 | </glossentry> | 3022 | </glossentry> |
@@ -5196,18 +5215,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
5196 | <para> | 5215 | <para> |
5197 | The final list of packages passed to the package manager | 5216 | The final list of packages passed to the package manager |
5198 | for installation into the image. | 5217 | for installation into the image. |
5218 | </para> | ||
5219 | |||
5220 | <para> | ||
5199 | Because the package manager controls actual installation | 5221 | Because the package manager controls actual installation |
5200 | of all packages, the list of packages passed using | 5222 | of all packages, the list of packages passed using |
5201 | <filename>PACKAGE_INSTALL</filename> is not the final list | 5223 | <filename>PACKAGE_INSTALL</filename> is not the final list |
5202 | of packages that are actually installed. | 5224 | of packages that are actually installed. |
5203 | </para> | ||
5204 | |||
5205 | <para> | ||
5206 | This variable is internal to the image construction | 5225 | This variable is internal to the image construction |
5207 | code. | 5226 | code. |
5208 | Use the | 5227 | Consequently, in general, you should use the |
5209 | <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link> | 5228 | <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link> |
5210 | variable to specify packages for installation. | 5229 | variable to specify packages for installation. |
5230 | The exception to this is when working with | ||
5231 | the | ||
5232 | <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link> | ||
5233 | image. | ||
5234 | When working with an initial RAM disk (initramfs) | ||
5235 | image, use the <filename>PACKAGE_INSTALL</filename> | ||
5236 | variable. | ||
5211 | </para> | 5237 | </para> |
5212 | </glossdef> | 5238 | </glossdef> |
5213 | </glossentry> | 5239 | </glossentry> |