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>

diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 49d8f5c10c0afd9e4d6762f3dbe7fe961f5384d0..b2a2e32c5d2b81573f7a38fa8d706506455eac03 100644 (file)
--- 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>