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:10 +0000
commit1b3d0e516819d0ab3b4a3c0c5163db610f0d3f95 (patch)
treeeaab9581f049c2db6fd3e2bcd0160ffd65e1ea6e
parent0a94b71878894f2495570452c8eb51de4f7ce1db (diff)
downloadopenembedded-core-contrib-1b3d0e516819d0ab3b4a3c0c5163db610f0d3f95.tar.gz
openembedded-core-contrib-1b3d0e516819d0ab3b4a3c0c5163db610f0d3f95.tar.bz2
openembedded-core-contrib-1b3d0e516819d0ab3b4a3c0c5163db610f0d3f95.zip
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: 1ef9bb89057be46878a70c558268b5ace43967f8) 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 @@
<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>