diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2016-07-29 16:10:09 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-08-18 23:50:46 +0100 |
commit | 2996779354e618583e89e899194c6e7f63144156 (patch) | |
tree | 1df9360665a38012d1bb8fd4ba72131002ad7a19 /documentation | |
parent | 31b06fe3531d9404e7a76e67e9cadf343930df37 (diff) | |
download | openembedded-core-contrib-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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 37 |
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" <glossentry id='var-INITRAMFS_IMAGE_BUNDLE'><glossterm>INITRAMFS_IMAGE_BUNDLE</glossterm> <info> - 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)." + 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)." </info> <glossdef> <para role="glossdeffirst"> <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> Controls whether or not the image recipe specified by <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link> - 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). - Using an extra compilation pass ensures that when a kernel - attempts to use an initramfs, it does not encounter - circular dependencies should the initramfs include kernel - modules. + is run through an extra pass + (<link linkend='ref-tasks-bundle_initramfs'><filename>do_bundle_initramfs</filename></link>) + during kernel compilation in order to build a single binary + that contains both the kernel image and the initial RAM disk + (initramfs). + This makes use of the + <link linkend='var-CONFIG_INITRAMFS_SOURCE'><filename>CONFIG_INITRAMFS_SOURCE</filename></link> + kernel feature. + <note> + Using an extra compilation pass to bundle the initramfs + avoids a circular dependency between the kernel recipe and + the initramfs recipe should the initramfs include kernel + modules. + Should that be the case, the initramfs recipe depends on + the kernel for the kernel modules, and the kernel depends + on the initramfs recipe since the initramfs is bundled + inside the kernel image. + </note> </para> <para> @@ -6172,9 +6183,11 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" </para> <para> - Setting the variable to "1" in a configuration file causes - the OpenEmbedded build system to make the extra pass during - kernel compilation: + Setting the variable to "1" in a configuration file causes the + OpenEmbedded build system to generate a kernel image with the + initramfs specified in + <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link> + bundled within: <literallayout class='monospaced'> INITRAMFS_IMAGE_BUNDLE = "1" </literallayout> @@ -6182,7 +6195,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" <link linkend='ref-classes-kernel'><filename>kernel</filename></link> class sets this variable to a null string as follows: <literallayout class='monospaced'> - INITRAMFS_IMAGE_BUNDLE = "" + INITRAMFS_IMAGE_BUNDLE ?= "" </literallayout> <note> You must set the |