From 33e7953a5828a68d0468281a4e65df8092658a2b Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 21 Nov 2013 09:40:12 -0800 Subject: [PATCH] ref-manual: Cleaned up some instances of the term "working directory" This term should always reference a users current working directory and not be confused with the OpenEmbedded build system's "work directory (WORKDIR). I found several instances where the term "working directory" was not used correctly and fixed them. Reported-by: Robert P. J. Day (From yocto-docs rev: 80dcbf41fc57d0d527db13dd2f993233dd5c1675) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/closer-look.xml | 2 +- documentation/ref-manual/ref-variables.xml | 10 +++++----- documentation/ref-manual/technical-details.xml | 4 ++-- documentation/ref-manual/usingpoky.xml | 9 +++++---- 4 files changed, 13 insertions(+), 12 deletions(-) diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index 4883981985..e13f5c1601 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml @@ -693,7 +693,7 @@ The do_fetch and do_unpack tasks fetch the source files - and unpack them into a working directory. + and unpack them into the work directory. By default, everything is accomplished in the Build Directory, which has a defined structure. diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index cb8d9a5b39..bed4be0030 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -4825,7 +4825,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The location in the Build Directory where unpacked recipe source code resides. - This location is within the working directory + This location is within the work directory (WORKDIR), which is not static. The unpacked source location depends on the recipe name @@ -4840,7 +4840,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Source Directory top-level folder named poky and a default Build Directory at poky/build. - In this case, the working directory the build system uses + In this case, the work directory the build system uses to keep the unpacked recipe for db is the following: @@ -6008,7 +6008,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" WORKDIR - The pathname of the working directory in which the OpenEmbedded build system + The pathname of the work directory in which the OpenEmbedded build system builds a recipe. This directory is located within the TMPDIR directory structure and changes @@ -6039,7 +6039,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" folder name poky and a default Build Directory at poky/build. - In this case, the working directory the build system uses to build + In this case, the work directory the build system uses to build the v86d package is the following: poky/build/tmp/work/qemux86-poky-linux/v86d/01.9-r0 @@ -6055,7 +6055,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" As an example, again assume a Source Directory top-level folder named poky and a default Build Directory at poky/build. - In this case, the working directory the build system uses to build + In this case, the work directory the build system uses to build the acl recipe, which is being built for a MIPS-based device, is the following: diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml index 6d4c6b712c..51b9148e3e 100644 --- a/documentation/ref-manual/technical-details.xml +++ b/documentation/ref-manual/technical-details.xml @@ -434,11 +434,11 @@ the checksum. First, there is the actual specific build path of a given task - the WORKDIR. - It does not matter if the working directory changes because it should not + It does not matter if the work directory changes because it should not affect the output for target packages. Also, the build process has the objective of making native or cross packages relocatable. The checksum therefore needs to exclude WORKDIR. - The simplistic approach for excluding the working directory is to set + The simplistic approach for excluding the work directory is to set WORKDIR to some fixed value and create the checksum for the "run" script. diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml index b9df733f3f..94f113590a 100644 --- a/documentation/ref-manual/usingpoky.xml +++ b/documentation/ref-manual/usingpoky.xml @@ -169,14 +169,15 @@ - If you wish to rerun a task, use the -f force option. - For example, the following sequence forces recompilation after changing files in the - working directory. + If you wish to rerun a task, use the -f force + option. + For example, the following sequence forces recompilation after + changing files in the work directory. $ bitbake matchbox-desktop . . - [make some changes to the source code in the working directory] + [make some changes to the source code in the work directory] . . $ bitbake matchbox-desktop -c compile -f