diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index c8c6a669c9..e9bc81fe7b 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml @@ -1774,8 +1774,62 @@ WORKDIR - The path to directory in tmp/work/ where - the package is built. + + The pathname of the working directory in which the Yocto Project build system + builds packages. + This directory is located within the + TMPDIR directory structure and changes + as different packages are built. + + + + The actual WORKDIR directory depends on several things: + + The temporary directory - TMPDIR + The package architecture - PACKAGE_ARCH + The target machine - MACHINE + The target operating system - TARGET_OS + The package name - PN + The package version - PV + The package revision - PR + + + + + For packages that are not dependent on a particular machine, + WORKDIR is defined as follows: + + ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} + + As an example, assume a + + Yocto Project Files top-level directory named poky + and a default + + Yocto Project Build Birectory of poky/build. + In this case, the working directory the build system uses to build + the v86d package is the following: + + ~/poky/build/tmp/work/qemux86-poky-linux/v86d-01.9-r0 + + + + + For packages that are dependent on a particular machine, WORKDIR + is defined slightly different: + + ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} + + As an example, again assume a Yocto Project Files top-level directory + named poky and a default Yocto Project build directory + of poky/build. + In this case, the working directory the build system uses to build + the acl package, which is dependent on a + MIPS-based device, is the following: + + ~/poky/build/tmp/work/mips-poky-linux/acl-2.2.51-r2 + +