diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-09-18 10:36:16 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-09-22 12:20:48 +0100 |
commit | 26354c27151a1053a69a669f7ebf6a5ed46735f9 (patch) | |
tree | abb5dad8e649dec82621949932bc9b9ecebf75d6 /documentation/ref-manual/closer-look.xml | |
parent | 33ed042d4f6de99efca7c6724b8966b9da79e330 (diff) | |
download | poky-26354c27151a1053a69a669f7ebf6a5ed46735f9.tar.gz |
ref-manual, mega-manual: Updates to "Image Generation"
Fixes [YOCTO #2808]
Updated the figure and placed it in the folders area for both
the ref-manual and mega-manual. I had to add the
DEPLOY_DIR_IMAGE variable and create a new machine-specific
directory below deploy. The text had to be adjusted to reflect
this change as well.
Also, created a new variable entry for DEPLOY_DIR_IMAGE for
the glossary of the ref-manual.
(From yocto-docs rev: 50a68810f854b32fa5dba477eafa8fd1eebbd7a4)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/closer-look.xml')
-rw-r--r-- | documentation/ref-manual/closer-look.xml | 34 |
1 files changed, 20 insertions, 14 deletions
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index f3f0db2dd6..0947340c07 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml | |||
@@ -1079,13 +1079,16 @@ | |||
1079 | <para> | 1079 | <para> |
1080 | Images are written out to the | 1080 | Images are written out to the |
1081 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 1081 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
1082 | inside the <filename>deploy/images</filename> folder as shown | 1082 | inside the <filename>deploy/images/<machine>/</filename> |
1083 | in the figure. | 1083 | folder as shown in the figure. |
1084 | This folder contains any files expected to be loaded on the | 1084 | This folder contains any files expected to be loaded on the |
1085 | target device. | 1085 | target device. |
1086 | The | 1086 | The |
1087 | <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link> | 1087 | <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link> |
1088 | variable points to the <filename>deploy</filename> directory. | 1088 | variable points to the <filename>deploy</filename> directory, |
1089 | while the | ||
1090 | <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> | ||
1091 | variable points to the machine-specific directory. | ||
1089 | <itemizedlist> | 1092 | <itemizedlist> |
1090 | <listitem><para><filename><kernel-image></filename>: | 1093 | <listitem><para><filename><kernel-image></filename>: |
1091 | A kernel binary file. | 1094 | A kernel binary file. |
@@ -1094,8 +1097,9 @@ | |||
1094 | kernel image file. | 1097 | kernel image file. |
1095 | Depending on that variable, the file could begin with | 1098 | Depending on that variable, the file could begin with |
1096 | a variety of naming strings. | 1099 | a variety of naming strings. |
1097 | The <filename>deploy/images</filename> directory can | 1100 | The <filename>deploy/images/<machine></filename> |
1098 | contain multiple image files.</para></listitem> | 1101 | directory can contain multiple image files for the |
1102 | machine.</para></listitem> | ||
1099 | <listitem><para><filename><root-filesystem-image></filename>: | 1103 | <listitem><para><filename><root-filesystem-image></filename>: |
1100 | Root filesystems for the target device (e.g. | 1104 | Root filesystems for the target device (e.g. |
1101 | <filename>*.ext3</filename> or <filename>*.bz2</filename> | 1105 | <filename>*.ext3</filename> or <filename>*.bz2</filename> |
@@ -1103,25 +1107,27 @@ | |||
1103 | The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> | 1107 | The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> |
1104 | variable setting determines the root filesystem image | 1108 | variable setting determines the root filesystem image |
1105 | type. | 1109 | type. |
1106 | The <filename>deploy/images</filename> directory can | 1110 | The <filename>deploy/images/<machine></filename> |
1107 | contain multiple root filesystems.</para></listitem> | 1111 | directory can contain multiple root filesystems for the |
1112 | machine.</para></listitem> | ||
1108 | <listitem><para><filename><kernel-modules></filename>: | 1113 | <listitem><para><filename><kernel-modules></filename>: |
1109 | Tarballs that contain all the modules built for the kernel. | 1114 | Tarballs that contain all the modules built for the kernel. |
1110 | Kernel module tarballs exist for legacy purposes and | 1115 | Kernel module tarballs exist for legacy purposes and |
1111 | can be suppressed by setting the | 1116 | can be suppressed by setting the |
1112 | <link linkend='var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></link> | 1117 | <link linkend='var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></link> |
1113 | variable to "0". | 1118 | variable to "0". |
1114 | The <filename>deploy/images</filename> directory can | 1119 | The <filename>deploy/images/<machine></filename> |
1115 | contain multiple kernel module tarballs. | 1120 | directory can contain multiple kernel module tarballs |
1116 | </para></listitem> | 1121 | for the machine.</para></listitem> |
1117 | <listitem><para><filename><bootloaders></filename>: | 1122 | <listitem><para><filename><bootloaders></filename>: |
1118 | Bootloaders supporting the image, if applicable to the | 1123 | Bootloaders supporting the image, if applicable to the |
1119 | target machine. | 1124 | target machine. |
1120 | The <filename>deploy/images</filename> directory can | 1125 | The <filename>deploy/images/<machine></filename> |
1121 | contain multiple bootloaders. | 1126 | directory can contain multiple bootloaders for the |
1122 | </para></listitem> | 1127 | machine.</para></listitem> |
1123 | <listitem><para><filename><symlinks></filename>: | 1128 | <listitem><para><filename><symlinks></filename>: |
1124 | The <filename>deploy/images</filename> folder contains | 1129 | The <filename>deploy/images/<machine></filename> |
1130 | folder contains | ||
1125 | a symbolic link that points to the most recently built file | 1131 | a symbolic link that points to the most recently built file |
1126 | for each machine. | 1132 | for each machine. |
1127 | These links might be useful for external scripts that | 1133 | These links might be useful for external scripts that |