summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-20 14:38:01 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-25 12:29:44 (GMT)
commit7a5cd2123a5665afaa41ed97914650e711ac8682 (patch)
tree01f36d219b595205dbeaa2c4bac00101f3f56c55
parent97cfb8c453aedf1d9c1e645a63b3243bb5d4ec48 (diff)
downloadpoky-7a5cd2123a5665afaa41ed97914650e711ac8682.tar.gz
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>
-rw-r--r--documentation/mega-manual/figures/image-generation.pngbin47713 -> 50418 bytes
-rw-r--r--documentation/ref-manual/closer-look.xml15
-rw-r--r--documentation/ref-manual/figures/image-generation.pngbin47713 -> 50418 bytes
-rw-r--r--documentation/ref-manual/ref-variables.xml33
4 files changed, 48 insertions, 0 deletions
diff --git a/documentation/mega-manual/figures/image-generation.png b/documentation/mega-manual/figures/image-generation.png
index 5594658..ab96258 100644
--- a/documentation/mega-manual/figures/image-generation.png
+++ b/documentation/mega-manual/figures/image-generation.png
Binary files differ
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
index 683fa42..136f938 100644
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/closer-look.xml
@@ -971,6 +971,21 @@
971 </para> 971 </para>
972 972
973 <para> 973 <para>
974 Along with writing out the root filesystem image, the
975 <filename>do_rootfs</filename> task creates a manifest file
976 (<filename>.manifest</filename>) in the same directory as
977 the root filesystem image that lists out, line-by-line, the
978 installed packages.
979 This manifest file is useful for the
980 <link linkend='ref-classes-testimage'><filename>testimage</filename></link>
981 class, for example, to determine whether or not to run
982 specific tests.
983 See the
984 <link linkend='var-IMAGE_MANIFEST'><filename>IMAGE_MANIFEST</filename></link>
985 variable for additional information.
986 </para>
987
988 <para>
974 Part of the image generation process includes compressing the 989 Part of the image generation process includes compressing the
975 root filesystem image. 990 root filesystem image.
976 Compression is accomplished through several optimization 991 Compression is accomplished through several optimization
diff --git a/documentation/ref-manual/figures/image-generation.png b/documentation/ref-manual/figures/image-generation.png
index 5594658..ab96258 100644
--- a/documentation/ref-manual/figures/image-generation.png
+++ b/documentation/ref-manual/figures/image-generation.png
Binary files differ
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 033661a..5f2b76b 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2903,6 +2903,39 @@
2903 </glossdef> 2903 </glossdef>
2904 </glossentry> 2904 </glossentry>
2905 2905
2906 <glossentry id='var-IMAGE_MANIFEST'><glossterm>IMAGE_MANIFEST</glossterm>
2907 <glossdef>
2908 <para>
2909 The manifest file for the image.
2910 This file lists all the installed packages that make up
2911 the image.
2912 The file contains package information on a line-per-package
2913 basis as follows:
2914 <literallayout class='monospaced'>
2915 &lt;packagename&gt; &lt;packagearch&gt; &lt;version&gt;
2916 </literallayout>
2917 </para>
2918
2919 <para>
2920 The
2921 <link linkend='ref-classes-image'><filename>image</filename></link>
2922 class defines the manifest file as follows:
2923 <literallayout class='monospaced'>
2924 IMAGE_MANIFEST = "${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest"
2925 </literallayout>
2926 The location is derived using the
2927 <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>
2928 and
2929 <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link>
2930 variables.
2931 You can find information on how the image
2932 is created in the
2933 "<link linkend='image-generation-dev-environment'>Image Generation</link>"
2934 section.
2935 </para>
2936 </glossdef>
2937 </glossentry>
2938
2906 <glossentry id='var-IMAGE_NAME'><glossterm>IMAGE_NAME</glossterm> 2939 <glossentry id='var-IMAGE_NAME'><glossterm>IMAGE_NAME</glossterm>
2907 <glossdef> 2940 <glossdef>
2908 <para> 2941 <para>