summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-04-10 10:13:02 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-04-11 18:15:32 +0100
commit19b9fde3b2b329b377ab406e2d4e52d04d06aa7f (patch)
treeafd6dffb8fdd43edb5d6748d5f95962fca846a14
parentbdc27cc40515916bda8c9c8b999be39ab85188f3 (diff)
downloadpoky-19b9fde3b2b329b377ab406e2d4e52d04d06aa7f.tar.gz
poky-19b9fde3b2b329b377ab406e2d4e52d04d06aa7f.tar.bz2
poky-19b9fde3b2b329b377ab406e2d4e52d04d06aa7f.zip
ref-manual: Updates to deal with installing packages in initramfs
Fixes [YOCTO #4961] Documented the user requirement to use PACKAGE_INSTALL to specify packages for installation into an initramfs image. Normally, you use IMAGE_INSTALL. To account for this user model, I updated the PACKAGE_INSTALL and IMAGE_INSTALL variables. I also added a bit more information to the "Images" chapter item that talks about the core-image-minimal-initramfs image. (From yocto-docs rev: a1ad649cf310f281a7de584d5b9a1820ca99d4eb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-images.xml8
-rw-r--r--documentation/ref-manual/ref-variables.xml78
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 @@
The image includes headers and libraries you can use in a host development
environment.
</para></listitem>
- <listitem><para><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis>
+ <listitem><para id='images-core-image-minimal-initramfs'><emphasis><filename>core-image-minimal-initramfs</filename>:</emphasis>
A <filename>core-image-minimal</filename> image that has the Minimal RAM-based
- Initial Root Filesystem (<filename>initramfs</filename>) as part of the kernel,
+ Initial Root Filesystem (initramfs) as part of the kernel,
which allows the system to find the first “init” program more efficiently.
+ See the
+ <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>
+ variable for additional information helpful when working with
+ initramfs images.
</para></listitem>
<listitem><para><emphasis><filename>core-image-minimal-mtdutils</filename>:</emphasis>
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 @@
<glossdef>
<para>
Specifies the packages to install into an image.
- The <filename>IMAGE_INSTALL</filename> variable is a mechanism for an image
- recipe and you should use it with care to avoid ordering issues.
+ The <filename>IMAGE_INSTALL</filename> variable is a
+ mechanism for an image recipe and you should use it
+ with care to avoid ordering issues.
+ <note>
+ When working with an
+ <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link>
+ image, do not use the <filename>IMAGE_INSTALL</filename>
+ variable to specify packages for installation.
+ Instead, use the
+ <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>
+ variable, which allows the initial RAM disk (initramfs)
+ recipe to use a fixed set of packages and not be
+ affected by <filename>IMAGE_INSTALL</filename>.
+ </note>
</para>
<para>
- Image recipes set <filename>IMAGE_INSTALL</filename> to specify the
- packages to install into an image through <filename>image.bbclass</filename>.
- Additionally, "helper" classes exist, such as <filename>core-image.bbclass</filename>,
- that can take
- <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> lists
- and turn these into auto-generated entries in
- <filename>IMAGE_INSTALL</filename> in addition to its default contents.
+ Image recipes set <filename>IMAGE_INSTALL</filename>
+ to specify the packages to install into an image through
+ <filename>image.bbclass</filename>.
+ Additionally, "helper" classes exist, such as
+ <filename>core-image.bbclass</filename>, that can take
+ <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>
+ lists and turn these into auto-generated entries in
+ <filename>IMAGE_INSTALL</filename> in addition to its
+ default contents.
</para>
<para>
- Using <filename>IMAGE_INSTALL</filename> with the <filename>+=</filename>
- operator from the <filename>/conf/local.conf</filename> file or from within
- an image recipe is not recommended as it can cause ordering issues.
- Since <filename>core-image.bbclass</filename> sets <filename>IMAGE_INSTALL</filename>
- to a default value using the <filename>?=</filename> operator, using a
- <filename>+=</filename> operation against <filename>IMAGE_INSTALL</filename>
- will result in unexpected behavior when used in
+ Using <filename>IMAGE_INSTALL</filename> with the
+ <filename>+=</filename> operator from the
+ <filename>/conf/local.conf</filename> file or from within
+ an image recipe is not recommended as it can cause ordering
+ issues.
+ Since <filename>core-image.bbclass</filename> sets
+ <filename>IMAGE_INSTALL</filename> to a default value using
+ the <filename>?=</filename> operator, using a
+ <filename>+=</filename> operation against
+ <filename>IMAGE_INSTALL</filename> will result in
+ unexpected behavior when used in
<filename>conf/local.conf</filename>.
- 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 <filename>+=</filename> operator to work.
+ 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 <filename>+=</filename> operator to work.
</para>
<para>
@@ -2996,8 +3015,8 @@
<literallayout class='monospaced'>
IMAGE_INSTALL_append = " package-name"
</literallayout>
- Be sure to include the space between the quotation character and the start of the
- package name or names.
+ Be sure to include the space between the quotation character
+ and the start of the package name or names.
</para>
</glossdef>
</glossentry>
@@ -5196,18 +5215,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<para>
The final list of packages passed to the package manager
for installation into the image.
+ </para>
+
+ <para>
Because the package manager controls actual installation
of all packages, the list of packages passed using
<filename>PACKAGE_INSTALL</filename> is not the final list
of packages that are actually installed.
- </para>
-
- <para>
This variable is internal to the image construction
code.
- Use the
+ Consequently, in general, you should use the
<link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>
variable to specify packages for installation.
+ The exception to this is when working with
+ the
+ <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link>
+ image.
+ When working with an initial RAM disk (initramfs)
+ image, use the <filename>PACKAGE_INSTALL</filename>
+ variable.
</para>
</glossdef>
</glossentry>