summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/ref-variables.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/poky-ref-manual/ref-variables.xml')
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml39
1 files changed, 38 insertions, 1 deletions
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 1a958773b9..8efd46a848 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -533,7 +533,44 @@
533 533
534 <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm> 534 <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm>
535 <glossdef> 535 <glossdef>
536 <para>The list of packages used to build images.</para> 536 <para>
537 Specifies the packages to install into an image.
538 The <filename>IMAGE_INSTALL</filename> variable is a mechanism for an image
539 recipe and you should use it with care to avoid ordering issues.
540 </para>
541
542 <para>
543 Image recipes set <filename>IMAGE_INSTALL</filename> to specify the
544 packages to install into an image through <filename>image.bbclass</filename>.
545 Additionally, "helper" classes exist, such as <filename>core-image.bbclass</filename>,
546 that can take
547 <filename><link linkend='var-IMAGE_FEATURE'>IMAGE_FEATURE</link></filename> lists
548 and turn these into auto-generated entries in
549 <filename>IMAGE_INSTALL</filename> in addition to its default contents.
550 </para>
551
552 <para>
553 Using <filename>IMAGE_INSTALL</filename> with the <filename>+=</filename>
554 operator from the <filename>/conf/local.conf</filename> file or from within
555 an image recipe is not recommended as it can cause ordering issues.
556 Since <filename>core-image.bbclass</filename> sets <filename>IMAGE_INSTALL</filename>
557 to a default value using the <filename>?=</filename> operator, using a
558 <filename>+=</filename> operation against <filename>IMAGE_INSTALL</filename>
559 previously from the <filename>/conf/local.conf</filename> will almost always fail.
560 Furthermore, the same operation from with an image recipe may or may not
561 succeed depending on the specific situation.
562 In both these cases, the behavior is contrary to how most users expect
563 the <filename>+=</filename> append operator to work.
564 </para>
565
566 <para>
567 When you use this variable, it is best to use it as follows:
568 <literallayout class='monospaced'>
569 IMAGE_INSTALL_append " package-name"
570 </literallayout>
571 Be sure to include the space between the quotation character and the start of the
572 package name.
573 </para>
537 </glossdef> 574 </glossdef>
538 </glossentry> 575 </glossentry>
539 576