summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-07-29 16:10:09 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-08-18 23:50:46 +0100
commit2996779354e618583e89e899194c6e7f63144156 (patch)
tree1df9360665a38012d1bb8fd4ba72131002ad7a19
parent31b06fe3531d9404e7a76e67e9cadf343930df37 (diff)
downloadpoky-2996779354e618583e89e899194c6e7f63144156.tar.gz
ref-manual: Updated the INITRAMFS_IMAGE_BUNDLE variable description.
Fixes [YOCTO #10013] I enhanced the description with more detail all around. (From yocto-docs rev: 319dabecf5abf0884295b991f681bed0e1dbf673) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/ref-manual/ref-variables.xml37
1 files changed, 25 insertions, 12 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 9c97ac1fb2..f85d682e79 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -6148,20 +6148,31 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6148 6148
6149 <glossentry id='var-INITRAMFS_IMAGE_BUNDLE'><glossterm>INITRAMFS_IMAGE_BUNDLE</glossterm> 6149 <glossentry id='var-INITRAMFS_IMAGE_BUNDLE'><glossterm>INITRAMFS_IMAGE_BUNDLE</glossterm>
6150 <info> 6150 <info>
6151 INITRAMFS_IMAGE_BUNDLE[doc] = "Controls whether or not the image recipe specified by INITRAMFS_IMAGE is run through an extra pass during kernel compilation in order to build a single binary that contains both the kernel image and the initial RAM disk (initramfs)." 6151 INITRAMFS_IMAGE_BUNDLE[doc] = "Controls whether or not the image recipe specified by INITRAMFS_IMAGE is run through an extra pass (do_bundle_initramfs) during kernel compilation in order to build a single binary that contains both the kernel image and the initial RAM disk (initramfs)."
6152 </info> 6152 </info>
6153 <glossdef> 6153 <glossdef>
6154 <para role="glossdeffirst"> 6154 <para role="glossdeffirst">
6155<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 6155<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
6156 Controls whether or not the image recipe specified by 6156 Controls whether or not the image recipe specified by
6157 <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link> 6157 <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link>
6158 is run through an extra pass during kernel compilation 6158 is run through an extra pass
6159 in order to build a single binary that contains both the 6159 (<link linkend='ref-tasks-bundle_initramfs'><filename>do_bundle_initramfs</filename></link>)
6160 kernel image and the initial RAM disk (initramfs). 6160 during kernel compilation in order to build a single binary
6161 Using an extra compilation pass ensures that when a kernel 6161 that contains both the kernel image and the initial RAM disk
6162 attempts to use an initramfs, it does not encounter 6162 (initramfs).
6163 circular dependencies should the initramfs include kernel 6163 This makes use of the
6164 modules. 6164 <link linkend='var-CONFIG_INITRAMFS_SOURCE'><filename>CONFIG_INITRAMFS_SOURCE</filename></link>
6165 kernel feature.
6166 <note>
6167 Using an extra compilation pass to bundle the initramfs
6168 avoids a circular dependency between the kernel recipe and
6169 the initramfs recipe should the initramfs include kernel
6170 modules.
6171 Should that be the case, the initramfs recipe depends on
6172 the kernel for the kernel modules, and the kernel depends
6173 on the initramfs recipe since the initramfs is bundled
6174 inside the kernel image.
6175 </note>
6165 </para> 6176 </para>
6166 6177
6167 <para> 6178 <para>
@@ -6172,9 +6183,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6172 </para> 6183 </para>
6173 6184
6174 <para> 6185 <para>
6175 Setting the variable to "1" in a configuration file causes 6186 Setting the variable to "1" in a configuration file causes the
6176 the OpenEmbedded build system to make the extra pass during 6187 OpenEmbedded build system to generate a kernel image with the
6177 kernel compilation: 6188 initramfs specified in
6189 <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link>
6190 bundled within:
6178 <literallayout class='monospaced'> 6191 <literallayout class='monospaced'>
6179 INITRAMFS_IMAGE_BUNDLE = "1" 6192 INITRAMFS_IMAGE_BUNDLE = "1"
6180 </literallayout> 6193 </literallayout>
@@ -6182,7 +6195,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6182 <link linkend='ref-classes-kernel'><filename>kernel</filename></link> 6195 <link linkend='ref-classes-kernel'><filename>kernel</filename></link>
6183 class sets this variable to a null string as follows: 6196 class sets this variable to a null string as follows:
6184 <literallayout class='monospaced'> 6197 <literallayout class='monospaced'>
6185 INITRAMFS_IMAGE_BUNDLE = "" 6198 INITRAMFS_IMAGE_BUNDLE ?= ""
6186 </literallayout> 6199 </literallayout>
6187 <note> 6200 <note>
6188 You must set the 6201 You must set the