summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-01-02 08:19:55 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-01-08 13:02:02 +0000
commit7e7103196816712e93d0ed6443bfb7f32a8b16cd (patch)
treee0414df76fa0120d7638ca9dcfab01d3191baf08 /documentation/ref-manual
parent1e8ba08aef748ca3348836472f9c598e5a8c1120 (diff)
downloadpoky-7e7103196816712e93d0ed6443bfb7f32a8b16cd.tar.gz
ref-manual: Added new INITRAMFS_IMAGE variable description.
Fixes [YOCTO #4072] Added a new description for the INITRAMFS_IMAGE variable. Also, made a formatting fix to the INITRAMFS_IMAGE_BUNDLE variable. (From yocto-docs rev: 87c5c0b1554233c3ce1c41291d852021ec62e0dc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml45
1 files changed, 44 insertions, 1 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 19a53e0417..759e708dac 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3034,6 +3034,49 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3034 </glossdef> 3034 </glossdef>
3035 </glossentry> 3035 </glossentry>
3036 3036
3037 <glossentry id='var-INITRAMFS_IMAGE'><glossterm>INITRAMFS_IMAGE</glossterm>
3038 <glossdef>
3039 <para>
3040 Causes the OpenEmbedded build system to build an additional
3041 recipe as a dependency to your root filesystem recipe
3042 (e.g. <filename>core-image-sato</filename>).
3043 The additional recipe is used to create an initial RAM disk
3044 (initramfs) that might be needed during the initial boot of
3045 the target system to accomplish such things as loading
3046 kernel modules prior to mounting the root file system.
3047 </para>
3048
3049 <para>
3050 When you set the variable, specify the name of the
3051 initramfs you want created.
3052 The following example, which is set in the
3053 <filename>local.conf</filename> configuration file, causes
3054 a separate recipe to be created that results in an
3055 initramfs image named
3056 <filename>core-image-sato-initramfs.bb</filename> to be
3057 created:
3058 <literallayout class='monospaced'>
3059 INITRAMFS_IMAGE = "core-image-minimal-initramfs"
3060 </literallayout>
3061 By default, the
3062 <link linkend='ref-classes-kernel'><filename>kernel</filename></link>
3063 class sets this variable to a null string as follows:
3064 <literallayout class='monospaced'>
3065 INITRAMFS_IMAGE = ""
3066 </literallayout>
3067 </para>
3068
3069 <para>
3070 See the
3071 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto/conf/local.conf.sample.extended'><filename>local.conf.sample.extended</filename></ulink>
3072 file for additional information.
3073 You can also reference the
3074 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/kernel.bbclass'><filename>kernel.bbclass</filename></ulink>
3075 file to see how the variable is used.
3076 </para>
3077 </glossdef>
3078 </glossentry>
3079
3037 <glossentry id='var-INITRAMFS_IMAGE_BUNDLE'><glossterm>INITRAMFS_IMAGE_BUNDLE</glossterm> 3080 <glossentry id='var-INITRAMFS_IMAGE_BUNDLE'><glossterm>INITRAMFS_IMAGE_BUNDLE</glossterm>
3038 <glossdef> 3081 <glossdef>
3039 <para> 3082 <para>
@@ -3068,7 +3111,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3068 You cannot set the variable in a recipe file. 3111 You cannot set the variable in a recipe file.
3069 </note> 3112 </note>
3070 See the 3113 See the
3071 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto/conf/local.conf.sample.extended'>local.conf.sample.extended</ulink> 3114 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-yocto/conf/local.conf.sample.extended'><filename>local.conf.sample.extended</filename></ulink>
3072 file for additional information. 3115 file for additional information.
3073 </para> 3116 </para>
3074 </glossdef> 3117 </glossdef>