summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-01-02 13:29:31 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-01-11 17:23:17 +0000
commit4460bed6c2f9a36d5887113f7999a69cd84389db (patch)
tree3ee4d3d339314f638d9ceda7c5f804bc741e23cc
parent62f7812b932d0441dace5b8070d1ac198ed8d5bc (diff)
downloadpoky-4460bed6c2f9a36d5887113f7999a69cd84389db.tar.gz
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>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml17
1 files changed, 9 insertions, 8 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 49d8f5c10c..b2a2e32c5d 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -5489,17 +5489,18 @@
5489 5489
5490 <para> 5490 <para>
5491 To build an initramfs image and bundle it into the kernel, set the 5491 To build an initramfs image and bundle it into the kernel, set the
5492 following variables: 5492 <ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE_BUNDLE'><filename>INITRAMFS_IMAGE_BUNDLE</filename></ulink>
5493 variable in your <filename>local.conf</filename> file, and set the
5494 <ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></ulink>
5495 variable in your <filename>machine.conf</filename> file:
5493 <literallayout class='monospaced'> 5496 <literallayout class='monospaced'>
5494 INITRAMFS_IMAGE_BUNDLE = "1" 5497 INITRAMFS_IMAGE_BUNDLE = "1"
5495 INITRAMFS_IMAGE = "<replaceable>image_recipe_name</replaceable>" 5498 INITRAMFS_IMAGE = "<replaceable>image_recipe_name</replaceable>"
5496 </literallayout> 5499 </literallayout>
5497 Setting the 5500 Setting the <filename>INITRAMFS_IMAGE_BUNDLE</filename>
5498 <ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE_BUNDLE'><filename>INITRAMFS_IMAGE_BUNDLE</filename></ulink> 5501 flag causes the initramfs created by the recipe and defined by
5499 flag causes the initramfs created by the recipe 5502 <filename>INITRAMFS_IMAGE</filename> to be unpacked into the
5500 and defined by 5503 <filename>${B}/usr/</filename> directory.
5501 <ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></ulink>
5502 to be unpacked into the <filename>${B}/usr/</filename> directory.
5503 The unpacked initramfs is then passed to the kernel's 5504 The unpacked initramfs is then passed to the kernel's
5504 <filename>Makefile</filename> using the 5505 <filename>Makefile</filename> using the
5505 <ulink url='&YOCTO_DOCS_REF_URL;#var-CONFIG_INITRAMFS_SOURCE'><filename>CONFIG_INITRAMFS_SOURCE</filename></ulink> 5506 <ulink url='&YOCTO_DOCS_REF_URL;#var-CONFIG_INITRAMFS_SOURCE'><filename>CONFIG_INITRAMFS_SOURCE</filename></ulink>
@@ -5528,7 +5529,7 @@
5528 <filename>.cpio.xz</filename> file. 5529 <filename>.cpio.xz</filename> file.
5529 You can ensure you produce one of these <filename>.cpio.*</filename> 5530 You can ensure you produce one of these <filename>.cpio.*</filename>
5530 files by setting the 5531 files by setting the
5531 <ulink url='&YOCTO_DOCS_REF_URL;#var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></ulink> 5532 <ulink url='&YOCTO_DOCS_REF_URL;#var-INITRAMFS_FSTYPES'><filename>INITRAMFS_FSTYPES</filename></ulink>
5532 variable in your configuration file to one or more of the above 5533 variable in your configuration file to one or more of the above
5533 file types. 5534 file types.
5534 <note> 5535 <note>