summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml67
1 files changed, 37 insertions, 30 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 4316ea5dc6..973a761b95 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -6078,47 +6078,54 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
6078 6078
6079 <glossentry id='var-INITRAMFS_IMAGE'><glossterm>INITRAMFS_IMAGE</glossterm> 6079 <glossentry id='var-INITRAMFS_IMAGE'><glossterm>INITRAMFS_IMAGE</glossterm>
6080 <info> 6080 <info>
6081 INITRAMFS_IMAGE[doc] = "Causes the OpenEmbedded build system to build an additional recipe as a dependency to your root filesystem recipe (e.g. core-image-sato)." 6081 INITRAMFS_IMAGE[doc] = "Specifies the PROVIDES name of an image recipe that is used to build an initial RAM disk (initramfs) image."
6082 </info> 6082 </info>
6083 <glossdef> 6083 <glossdef>
6084 <para role="glossdeffirst"> 6084 <para role="glossdeffirst">
6085<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 6085<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
6086 Causes the OpenEmbedded build system to build an additional 6086 Specifies the
6087 recipe as a dependency to your root filesystem recipe 6087 <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>
6088 (e.g. <filename>core-image-sato</filename>). 6088 name of an image recipe that is used to build an initial
6089 The additional recipe is used to create an initial RAM disk 6089 RAM disk (initramfs) image.
6090 (initramfs) that might be needed during the initial boot of 6090 An initramfs provides a temporary root filesystem used for
6091 the target system to accomplish such things as loading 6091 early system initialization (e.g. loading of modules
6092 kernel modules prior to mounting the root file system. 6092 needed to locate and mount the "real" root filesystem).
6093 The specified recipe is added as a dependency of the root
6094 filesystem recipe (e.g.
6095 <filename>core-image-sato</filename>).
6096 See the <filename>core-image-sato-initramfs.bb</filename>
6097 recipe, which is created, for an example recipe.
6098 <note>
6099 The initramfs image recipe should set
6100 <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
6101 to
6102 <link linkend='var-INITRAMFS_FSTYPES'><filename>INITRAMFS_FSTYPES</filename></link>.
6103 </note>
6093 </para> 6104 </para>
6094 6105
6095 <para> 6106 <para>
6096 When you set the variable, specify the name of the 6107 You can also find more information by referencing the
6097 initramfs you want created. 6108 <filename>meta/poky/conf/local.conf.sample.extended</filename>
6098 The following example, which is set in the 6109 configuration file in the
6099 <filename>local.conf</filename> configuration file, causes 6110 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
6100 a separate recipe to be created that results in an 6111 the
6101 initramfs image named 6112 <link linkend='ref-classes-image'><filename>image</filename></link>
6102 <filename>core-image-sato-initramfs.bb</filename> to be 6113 class, and the
6103 created:
6104 <literallayout class='monospaced'>
6105 INITRAMFS_IMAGE = "core-image-minimal-initramfs"
6106 </literallayout>
6107 By default, the
6108 <link linkend='ref-classes-kernel'><filename>kernel</filename></link> 6114 <link linkend='ref-classes-kernel'><filename>kernel</filename></link>
6109 class sets this variable to a null string as follows: 6115 class to see how to use the
6110 <literallayout class='monospaced'> 6116 <filename>INITRAMFS_IMAGE</filename> variable.
6111 INITRAMFS_IMAGE = ""
6112 </literallayout>
6113 </para> 6117 </para>
6114 6118
6115 <para> 6119 <para>
6116 See the 6120 If <filename>INITRAMFS_IMAGE</filename> is empty, which is
6117 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended'><filename>local.conf.sample.extended</filename></ulink> 6121 the default, then no initramfs is built.
6118 file for additional information. 6122 </para>
6119 You can also reference the 6123
6120 <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/kernel.bbclass'><filename>kernel.bbclass</filename></ulink> 6124 <para>
6121 file to see how the variable is used. 6125 Finally, for more information you can also see the
6126 <link linkend='var-INITRAMFS_IMAGE_BUNDLE'><filename>INITRAMFS_IMAGE_BUNDLE</filename></link>
6127 variable, which allows the generated image to be bundled
6128 inside the kernel image.
6122 </para> 6129 </para>
6123 </glossdef> 6130 </glossdef>
6124 </glossentry> 6131 </glossentry>