From 7a5cd2123a5665afaa41ed97914650e711ac8682 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Thu, 20 Mar 2014 08:38:01 -0600
Subject: ref-manual, mega-manual: Added manifest file information

Fixes [YOCTO #5410]

I updated the figure that shows what do_rootfs does to create
the image.  The new addition is the creation of the .manifest file
that lists out package information in the image.  Supporting text
was also added in the section.

The updated figure was needed in both the ref-manual and
mega-manual figures folders.

Also, part of the fix included a new variable description for the
IMAGE_MANIFEST variable.

(From yocto-docs rev: 770448e0e8ce2e2c517ced5e71f5a916fefe5cf2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../mega-manual/figures/image-generation.png       | Bin 47713 -> 50418 bytes
 documentation/ref-manual/closer-look.xml           |  15 ++++++++++
 .../ref-manual/figures/image-generation.png        | Bin 47713 -> 50418 bytes
 documentation/ref-manual/ref-variables.xml         |  33 +++++++++++++++++++++
 4 files changed, 48 insertions(+)

diff --git a/documentation/mega-manual/figures/image-generation.png b/documentation/mega-manual/figures/image-generation.png
index 5594658200..ab962580c3 100644
Binary files a/documentation/mega-manual/figures/image-generation.png and b/documentation/mega-manual/figures/image-generation.png differ
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
index 683fa42259..136f9389f7 100644
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/closer-look.xml
@@ -970,6 +970,21 @@
                 executables.
             </para>
 
+            <para>
+                Along with writing out the root filesystem image, the
+                <filename>do_rootfs</filename> task creates a manifest file
+                (<filename>.manifest</filename>) in the same directory as
+                the root filesystem image that lists out, line-by-line, the
+                installed packages.
+                This manifest file is useful for the
+                <link linkend='ref-classes-testimage'><filename>testimage</filename></link>
+                class, for example, to determine whether or not to run
+                specific tests.
+                See the
+                <link linkend='var-IMAGE_MANIFEST'><filename>IMAGE_MANIFEST</filename></link>
+                variable for additional information.
+            </para>
+
             <para>
                 Part of the image generation process includes compressing the
                 root filesystem image.
diff --git a/documentation/ref-manual/figures/image-generation.png b/documentation/ref-manual/figures/image-generation.png
index 5594658200..ab962580c3 100644
Binary files a/documentation/ref-manual/figures/image-generation.png and b/documentation/ref-manual/figures/image-generation.png differ
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 033661af1c..5f2b76be8c 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2903,6 +2903,39 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-IMAGE_MANIFEST'><glossterm>IMAGE_MANIFEST</glossterm>
+            <glossdef>
+                <para>
+                    The manifest file for the image.
+                    This file lists all the installed packages that make up
+                    the image.
+                    The file contains package information on a line-per-package
+                    basis as follows:
+                    <literallayout class='monospaced'>
+     &lt;packagename&gt; &lt;packagearch&gt; &lt;version&gt;
+                    </literallayout>
+                </para>
+
+                <para>
+                    The
+                    <link linkend='ref-classes-image'><filename>image</filename></link>
+                    class defines the manifest file as follows:
+                    <literallayout class='monospaced'>
+     IMAGE_MANIFEST = "${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest"
+                    </literallayout>
+                    The location is derived using the
+                    <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
+                    and
+                    <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link>
+                    variables.
+                    You can find information on how the image
+                    is created in the
+                    "<link linkend='image-generation-dev-environment'>Image Generation</link>"
+                    section.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-IMAGE_NAME'><glossterm>IMAGE_NAME</glossterm>
             <glossdef>
                 <para>
-- 
cgit v1.2.3-54-g00ecf