sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

dev-manual: Updated "Building an Initial RAM Filesystem (initramfs) Image" section 

Fixes [YOCTO #7096]

Applied a couple review comments to the section to clarify where
to set key variables.  Also fixed an incorrect variable name used
to specify the *.cpio file.

(From yocto-docs rev: 24861b36804cbd636aafc36b1918bcfe33ca3811)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2017-01-02 13:29:31 -08:00 committed by Richard Purdie
parent 62f7812b93
commit 4460bed6c2
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -5489,17 +5489,18 @@
<para>
To build an initramfs image and bundle it into the kernel, set the
following variables:
<ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE_BUNDLE'><filename>INITRAMFS_IMAGE_BUNDLE</filename></ulink>
variable in your <filename>local.conf</filename> file, and set the
<ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></ulink>
variable in your <filename>machine.conf</filename> file:
<literallayout class='monospaced'>
INITRAMFS_IMAGE_BUNDLE = "1"
INITRAMFS_IMAGE = "<replaceable>image_recipe_name</replaceable>"
</literallayout>
Setting the
<ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE_BUNDLE'><filename>INITRAMFS_IMAGE_BUNDLE</filename></ulink>
flag causes the initramfs created by the recipe
and defined by
<ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></ulink>
to be unpacked into the <filename>${B}/usr/</filename> directory.
Setting the <filename>INITRAMFS_IMAGE_BUNDLE</filename>
flag causes the initramfs created by the recipe and defined by
<filename>INITRAMFS_IMAGE</filename> to be unpacked into the
<filename>${B}/usr/</filename> directory.
The unpacked initramfs is then passed to the kernel's
<filename>Makefile</filename> using the
<ulink url='&YOCTO_DOCS_REF_URL;#var-CONFIG_INITRAMFS_SOURCE'><filename>CONFIG_INITRAMFS_SOURCE</filename></ulink>
@ -5528,7 +5529,7 @@
<filename>.cpio.xz</filename> file.
You can ensure you produce one of these <filename>.cpio.*</filename>
files by setting the
<ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink>
<ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_FSTYPES'><filename>INITRAMFS_FSTYPES</filename></ulink>
variable in your configuration file to one or more of the above
file types.
<note>