From 597aceb920af7afa67eaf63260d93d770862b310 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 16 Sep 2013 10:11:28 -0700 Subject: [PATCH] ref-manual: Updated the ROOTFS_POSTPROCESS_COMMAND variable description. Fixes [YOCTO #2808] Review comments from Paul. (From yocto-docs rev: d8ab45eb0533ccbcc9ec34105b5fe4163122bc4a) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-variables.xml | 90 +++++++++++----------- 1 file changed, 47 insertions(+), 43 deletions(-) diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 7025041f23..a5d5ea2ab9 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -714,7 +714,7 @@ Core layer for images cannot be removed Points to the server that runs memory-resident BitBake. - This variable is set by the + This variable is set by the oe-init-build-env-memres setup script and should not be hand-edited. The variable is only used when you employ memory-resident @@ -723,10 +723,10 @@ Core layer for images cannot be removed export BBSERVER=localhost:$port - For more information on how the - BBSERVER is used, see the + For more information on how the + BBSERVER is used, see the oe-init-build-env-memres script, which - is located in the + is located in the Source Directory. @@ -789,9 +789,9 @@ Core layer for images cannot be removed Build Directory. You can define this directory indirectly through the &OE_INIT_FILE; - and + and oe-init-build-env-memres - scripts by passing in a Build Directory path when you run + scripts by passing in a Build Directory path when you run the scripts. If you run the scripts and do not provide a Build Directory path, the BUILDDIR defaults to @@ -1230,39 +1230,39 @@ Core layer for images cannot be removed DL_DIR - The central download directory used by the build process to + The central download directory used by the build process to store downloads. - You can set this directory by defining the - DL_DIR variable in the + You can set this directory by defining the + DL_DIR variable in the /conf/local.conf file. This directory is self-maintaining and you should not have to touch it. - By default, the directory is downloads + By default, the directory is downloads in the Build Directory. #DL_DIR ?= "${TOPDIR}/downloads" - To specify a different download directory, simply remove + To specify a different download directory, simply remove the comment from the line and provide your directory. - During a first build, the system downloads many different + During a first build, the system downloads many different source code tarballs from various upstream projects. Downloading can take a while, particularly if your network connection is slow. Tarballs are all stored in the directory defined by - DL_DIR and the build system looks there + DL_DIR and the build system looks there first to find source tarballs. - When wiping and rebuilding, you can preserve this + When wiping and rebuilding, you can preserve this directory to speed up this part of subsequent builds. - You can safely share this directory between multiple builds + You can safely share this directory between multiple builds on the same development machine. For additional information on how the build process gets source files when working behind a firewall or proxy server, @@ -1801,25 +1801,25 @@ Core layer for images cannot be removed IMAGE_CLASSES - A list of classes that all images should inherit. - You typically use this variable to specify the list of - classes that register the different types of images + A list of classes that all images should inherit. + You typically use this variable to specify the list of + classes that register the different types of images the OpenEmbedded build system creates. The default value for IMAGE_CLASSES is image_types.bbclass. - You can set this variable in your - local.conf or in a distribution + You can set this variable in your + local.conf or in a distribution configuration file. - For more information, see + For more information, see meta/classes/image_types.bbclass in the Source Directory. - + @@ -1982,7 +1982,7 @@ Core layer for images cannot be removed IMAGE_POSTPROCESS_COMMAND - Added by classes to run post processing commands once the + Added by classes to run post processing commands once the OpenEmbedded build system has created the image. You can specify shell commands and, if necessary, the path to the root filesystem image: @@ -1996,8 +1996,8 @@ Core layer for images cannot be removed IMAGE_ROOTFS - The location of the root filesystem. - This variable is not configurable. + The location of the root filesystem. + This variable is not configurable. Do not change it. @@ -3411,17 +3411,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The directory from which the top-level build environment setup script is sourced. The Yocto Project makes two top-level build environment - setup scripts available: + setup scripts available: &OE_INIT_FILE; - and + and oe-init-build-env-memres. - When you run one of these scripts, the - OEROOT variable resolves to the + When you run one of these scripts, the + OEROOT variable resolves to the directory that holds the script. - For additional information on how this variable is used, + For additional information on how this variable is used, see the initialization scripts. @@ -3710,15 +3710,15 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The default value of "noop" causes the build to simply fail - when the OpenEmbedded build system cannot successfully + when the OpenEmbedded build system cannot successfully apply a patch. - Setting the value to "user" causes the build system to - launch a shell and places you in the right location so that + Setting the value to "user" causes the build system to + launch a shell and places you in the right location so that you can manually resolve the conflicts. - Set this variable in your + Set this variable in your local.conf file. @@ -4169,13 +4169,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" ROOTFS_POSTPROCESS_COMMAND - Added by classes to run post processing commands once the + Added by classes to run post processing commands once the OpenEmbedded build system has created the root filesystem. You can specify shell commands and, if necessary, the path to the root filesystem image: - ROOTFS_POSTPROCESS_COMMAND += "${IMAGE_ROOTFS}<shell_command>; ... " + ROOTFS_POSTPROCESS_COMMAND += "<shell_command>; ... " + If you need to pass the path to the root filesystem within + the command, you can use + ${IMAGE_ROOTFS}, which points to + the root filesystem image. @@ -5167,22 +5171,22 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" USER_CLASSES - A list of classes to globally inherit. - These classes are used by the OpenEmbedded build system - to enable extra features (e.g. - buildstats, + A list of classes to globally inherit. + These classes are used by the OpenEmbedded build system + to enable extra features (e.g. + buildstats, image-mklibs, and so forth). - The default list is set in your + The default list is set in your local.conf file: USER_CLASSES ?= "buildstats image-mklibs image-prelink" For more information, see - meta-yocto/conf/local.conf.sample in - the + meta-yocto/conf/local.conf.sample in + the Source Directory.