diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 06555c3c51..28ff9c08e9 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -1317,46 +1317,45 @@ Running a Build on the Recipe - Creating a new recipe is an iterative process that requires - using BitBake to process the recipe multiple times in order to - progressively discover and add information to the recipe. + Creating a new recipe is usually an iterative process that + requires using BitBake to process the recipe multiple times in + order to progressively discover and add information to the + recipe. - To process the recipe, use the following BitBake command form - from within the - Build Directory: - - $ bitbake <base-recipe-name> - - Before you run BitBake, be sure that you source a build - environment setup script (i.e. + Assuming you have sourced a build environment setup script (i.e. &OE_INIT_FILE; or - oe-init-build-env-memres. + oe-init-build-env-memres) + and you are in the + Build Directory, + use BitBake to process your recipe. + All you need to provide is the base name of your recipe: + + $ bitbake <basename> + - The OpenEmbedded build system creates a temporary work - directory + During the build, the OpenEmbedded build system creates a + temporary work directory for the recipe (${WORKDIR}) where it keeps extracted source files, log files, images, and so forth. + You can find individual logs in this area for each task. - This temporary work directory is constructed depending on - several factors. - For packages that are not dependent on a particular machine, - WORKDIR is defined as follows: + The temporary work directory is constructed as follows and + depends on several factors: - ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${PV}-${PR} + ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} As an example, assume a Source Directory top-level folder name poky, a default Build Directory at - poky/build, a qemux86 - package architecture, and a linux target - operating system. + poky/build, and a + qemux86-poky-linux machine target system. Furthermore, suppose your recipe is named foo_1.3.0-r0.bb. In this case, the work directory the build system uses to @@ -1365,7 +1364,7 @@ poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 Inside this directory you can find sub-directories such as - image, package-split, + image, packages-split, and temp. After the build, you can examine these to determine how well the build went. @@ -1382,9 +1381,9 @@ Yocto Project Reference Manual's glossary for more information: The temporary directory - TMPDIR - The package architecture - PACKAGE_ARCH - The target operating system - TARGET_OS + The machine architecture - MULTIMACH_TARGET_SYS The recipe name - PN + The epoch - EXTENDPE The recipe version - PV The recipe revision - PR