From: Scott Rifenbark Date: Wed, 18 Sep 2013 17:36:16 +0000 (-0700) Subject: ref-manual, mega-manual: Updates to "Image Generation" X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=26354c27151a1053a69a669f7ebf6a5ed46735f9;p=thirdparty%2Fopenembedded%2Fopenembedded-core-contrib.git 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 Signed-off-by: Richard Purdie --- diff --git a/documentation/mega-manual/figures/images.png b/documentation/mega-manual/figures/images.png index f81905d4b8b..d99eac1fbfa 100644 Binary files a/documentation/mega-manual/figures/images.png and b/documentation/mega-manual/figures/images.png differ diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index f3f0db2dd6f..0947340c07b 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml @@ -1079,13 +1079,16 @@ Images are written out to the Build Directory - inside the deploy/images folder as shown - in the figure. + inside the deploy/images/<machine>/ + folder as shown in the figure. This folder contains any files expected to be loaded on the target device. The DEPLOY_DIR - variable points to the deploy directory. + variable points to the deploy directory, + while the + DEPLOY_DIR_IMAGE + variable points to the machine-specific directory. <kernel-image>: A kernel binary file. @@ -1094,8 +1097,9 @@ kernel image file. Depending on that variable, the file could begin with a variety of naming strings. - The deploy/images directory can - contain multiple image files. + The deploy/images/<machine> + directory can contain multiple image files for the + machine. <root-filesystem-image>: Root filesystems for the target device (e.g. *.ext3 or *.bz2 @@ -1103,25 +1107,27 @@ The IMAGE_FSTYPES variable setting determines the root filesystem image type. - The deploy/images directory can - contain multiple root filesystems. + The deploy/images/<machine> + directory can contain multiple root filesystems for the + machine. <kernel-modules>: Tarballs that contain all the modules built for the kernel. Kernel module tarballs exist for legacy purposes and can be suppressed by setting the MODULE_TARBALL_DEPLOY variable to "0". - The deploy/images directory can - contain multiple kernel module tarballs. - + The deploy/images/<machine> + directory can contain multiple kernel module tarballs + for the machine. <bootloaders>: Bootloaders supporting the image, if applicable to the target machine. - The deploy/images directory can - contain multiple bootloaders. - + The deploy/images/<machine> + directory can contain multiple bootloaders for the + machine. <symlinks>: - The deploy/images folder contains + The deploy/images/<machine> + folder contains a symbolic link that points to the most recently built file for each machine. 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 f81905d4b8b..d99eac1fbfa 100644 Binary files a/documentation/ref-manual/figures/images.png and b/documentation/ref-manual/figures/images.png differ diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 51f4966349c..9e2be223e78 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 DEPLOY_DIR - Points to the area that the OpenEmbedded build system uses - to place images, packages, SDKs and other output + Points to the general area that the OpenEmbedded build + system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system. By default, this directory resides within the Build Directory @@ -1081,6 +1081,33 @@ Core layer for images cannot be removed + DEPLOY_DIR_IMAGE + + + Points to the area that the OpenEmbedded build system uses + to place images and other associated output files that are + ready to be deployed onto the target machine. + The directory is machine-specific as it contains the + ${MACHINE} name. + By default, this directory resides within the + Build Directory + as tmp/deploy/images/${MACHINE}/. + + + + For more information on the structure of the Build + Directory, see + "The Build Directory - build/" + section. + For more detail on the contents of the + deploy directory, see the + "Images" and + "Application Development SDK" + sections. + + + + DESCRIPTION The package description used by package managers.