diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/mega-manual/figures/images.png | bin | 20886 -> 22926 bytes | |||
| -rw-r--r-- | documentation/ref-manual/closer-look.xml | 34 | ||||
| -rw-r--r-- | documentation/ref-manual/figures/images.png | bin | 20886 -> 22926 bytes | |||
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 31 |
4 files changed, 49 insertions, 16 deletions
diff --git a/documentation/mega-manual/figures/images.png b/documentation/mega-manual/figures/images.png index f81905d4b8..d99eac1fbf 100644 --- a/documentation/mega-manual/figures/images.png +++ b/documentation/mega-manual/figures/images.png | |||
| Binary files differ | |||
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 |
diff --git a/documentation/ref-manual/figures/images.png b/documentation/ref-manual/figures/images.png index f81905d4b8..d99eac1fbf 100644 --- a/documentation/ref-manual/figures/images.png +++ b/documentation/ref-manual/figures/images.png | |||
| Binary files differ | |||
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 51f4966349..9e2be223e7 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
| @@ -1059,8 +1059,8 @@ Core layer for images cannot be removed | |||
| 1059 | <glossentry id='var-DEPLOY_DIR'><glossterm>DEPLOY_DIR</glossterm> | 1059 | <glossentry id='var-DEPLOY_DIR'><glossterm>DEPLOY_DIR</glossterm> |
| 1060 | <glossdef> | 1060 | <glossdef> |
| 1061 | <para> | 1061 | <para> |
| 1062 | Points to the area that the OpenEmbedded build system uses | 1062 | Points to the general area that the OpenEmbedded build |
| 1063 | to place images, packages, SDKs and other output | 1063 | system uses to place images, packages, SDKs and other output |
| 1064 | files that are ready to be used outside of the build system. | 1064 | files that are ready to be used outside of the build system. |
| 1065 | By default, this directory resides within the | 1065 | By default, this directory resides within the |
| 1066 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | 1066 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> |
| @@ -1081,6 +1081,33 @@ Core layer for images cannot be removed | |||
| 1081 | </glossdef> | 1081 | </glossdef> |
| 1082 | </glossentry> | 1082 | </glossentry> |
| 1083 | 1083 | ||
| 1084 | <glossentry id='var-DEPLOY_DIR_IMAGE'><glossterm>DEPLOY_DIR_IMAGE</glossterm> | ||
| 1085 | <glossdef> | ||
| 1086 | <para> | ||
| 1087 | Points to the area that the OpenEmbedded build system uses | ||
| 1088 | to place images and other associated output files that are | ||
| 1089 | ready to be deployed onto the target machine. | ||
| 1090 | The directory is machine-specific as it contains the | ||
| 1091 | <filename>${MACHINE}</filename> name. | ||
| 1092 | By default, this directory resides within the | ||
| 1093 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> | ||
| 1094 | as <filename>tmp/deploy/images/${MACHINE}/</filename>. | ||
| 1095 | </para> | ||
| 1096 | |||
| 1097 | <para> | ||
| 1098 | For more information on the structure of the Build | ||
| 1099 | Directory, see | ||
| 1100 | "<link linkend='structure-build'>The Build Directory - <filename>build/</filename></link>" | ||
| 1101 | section. | ||
| 1102 | For more detail on the contents of the | ||
| 1103 | <filename>deploy</filename> directory, see the | ||
| 1104 | "<link linkend='images-dev-environment'>Images</link>" and | ||
| 1105 | "<link linkend='sdk-dev-environment'>Application Development SDK</link>" | ||
| 1106 | sections. | ||
| 1107 | </para> | ||
| 1108 | </glossdef> | ||
| 1109 | </glossentry> | ||
| 1110 | |||
| 1084 | <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> | 1111 | <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> |
| 1085 | <glossdef> | 1112 | <glossdef> |
| 1086 | <para>The package description used by package managers. | 1113 | <para>The package description used by package managers. |
