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>
This commit is contained in:
Scott Rifenbark 2014-03-20 08:38:01 -06:00 committed by Richard Purdie
parent 97cfb8c453
commit 7a5cd2123a
4 changed files with 48 additions and 0 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

@ -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.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 47 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

@ -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>