diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 09eb9b9dfc..705b1977d8 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -5951,54 +5951,21 @@
class.
You should use the IMAGE_INSTALL
variable with care to avoid ordering issues.
-
- When working with an
- core-image-minimal-initramfs
- image, do not use the IMAGE_INSTALL
- variable to specify packages for installation.
- Instead, use the
- PACKAGE_INSTALL
- variable, which allows the initial RAM filesystem
- (initramfs) recipe to use a fixed set of packages and
- not be affected by IMAGE_INSTALL.
- For information on creating an initramfs, see the
- "Building an Initial RAM Filesystem (initramfs) Image"
- section in the Yocto Project Development Tasks Manual.
-
Image recipes set IMAGE_INSTALL
to specify the packages to install into an image through
image.bbclass.
- Additionally, "helper" classes exist, such as
- core-image.bbclass, that can take
+ Additionally, "helper" classes exist, such as the
+ core-image,
+ class that can take
IMAGE_FEATURES
lists and turn these into auto-generated entries in
IMAGE_INSTALL in addition to its
default contents.
-
- Using IMAGE_INSTALL with the
- += operator from the
- /conf/local.conf file or from within
- an image recipe is not recommended as it can cause ordering
- issues.
- Since core-image.bbclass sets
- IMAGE_INSTALL to a default value using
- the ?= operator, using a
- += operation against
- IMAGE_INSTALL will result in
- unexpected behavior when used in
- conf/local.conf.
- Furthermore, the same operation from within an image
- recipe may or may not succeed depending on the specific
- situation.
- In both these cases, the behavior is contrary to how most
- users expect the += operator to work.
-
-
When you use this variable, it is best to use it as follows:
@@ -6006,6 +5973,53 @@
Be sure to include the space between the quotation character
and the start of the package name or names.
+ Caution
+
+
+ When working with a
+ core-image-minimal-initramfs
+ image, do not use the
+ IMAGE_INSTALL variable to
+ specify packages for installation.
+ Instead, use the
+ PACKAGE_INSTALL
+ variable, which allows the initial RAM
+ filesystem (initramfs) recipe to use a fixed
+ set of packages and not be affected by
+ IMAGE_INSTALL.
+ For information on creating an initramfs, see
+ the
+ "Building an Initial RAM Filesystem (initramfs) Image"
+ section in the Yocto Project Development Tasks
+ Manual.
+
+
+ Using IMAGE_INSTALL with
+ the
+ +=
+ BitBake operator within the
+ /conf/local.conf file or
+ from within an image recipe is not recommended.
+ Use of this operator in these ways can cause
+ ordering issues.
+ Since core-image.bbclass
+ sets IMAGE_INSTALL to a
+ default value using the
+ ?=
+ operator, using a +=
+ operation against
+ IMAGE_INSTALL results in
+ unexpected behavior when used within
+ conf/local.conf.
+ Furthermore, the same operation from within
+ an image recipe may or may not succeed
+ depending on the specific situation.
+ In both these cases, the behavior is contrary
+ to how most users expect the
+ += operator to work.
+
+
+