From a73fde8caf889e52b16fd774652cf9bd08b14204 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 22 Oct 2012 14:16:22 -0700 Subject: documentation: poky-ref-manual - Final changes before the 1.3 lockdown. various changes as required. (From yocto-docs rev: 7f166508337c9d4aadad23997470a8871c5e42a4) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/ref-variables.xml | 87 ++++++++++++------------- 1 file changed, 43 insertions(+), 44 deletions(-) (limited to 'documentation/poky-ref-manual/ref-variables.xml') diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 8663cc463c..ac068228cf 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml @@ -93,8 +93,8 @@ B - The build directory. - The OpenEmbedded build system places generated objects into the build directory + The Build Directory. + The OpenEmbedded build system places generated objects into the Build Directory during a recipe's build process. By default, this directory is the same as the S directory: @@ -165,7 +165,7 @@ Use the BBMASK variable from within the conf/local.conf file found - in the build directory. + in the Build Directory. @@ -250,7 +250,7 @@ Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration - file in the build directory. + file in the Build Directory. Here is an example: BBLAYERS = " \ @@ -362,7 +362,7 @@ than /usr/bin. You can find a list of these variables at the top of the /meta/conf/bitbake.conf file in the - source directory. + Source Directory. @@ -384,7 +384,7 @@ Specifies the list of packages to be added to the image. This variable should only be set in the local.conf configuration file found in the - build directory. + Build Directory. @@ -581,7 +581,7 @@ This directory is self-maintaining and you should not have to touch it. By default, the directory is downloads in the - build directory. + Build Directory. #DL_DIR ?= "${TOPDIR}/downloads" @@ -755,7 +755,7 @@ than /usr/bin. You can find a list of these variables at the top of the /meta/conf/bitbake.conf file in the - source directory. + Source Directory. @@ -821,7 +821,7 @@ The default value for the FILESPATH variable is defined in the base.bbclass class found in meta/classes in the - source directory: + Source Directory: FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \ @@ -848,14 +848,14 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ By default, the OpenEmbedded build system uses the fs-perms.txt, which is located in the meta/files folder in the - source directory. + Source Directory. If you create your own file permissions setting table, you should place it in your layer or the distros layer. You define the FILESYSTEM_PERMS_TABLES variable in the conf/local.conf file, which is found in the - build directory, to + Build Directory, to point to your custom fs-perms.txt. You can specify more than a single file permissions setting table. The paths you specify to these files must be defined within the @@ -1200,20 +1200,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Values for this variable are set in the kernel's recipe file and the kernel's append file. For example, if you are using the Yocto Project kernel that is based on the - Linux 3.2 kernel, the kernel recipe file is the - meta/recipes-kernel/linux/linux-yocto_3.2.bb file. - Following is the default value for KBRANCH and the five overrides - for the architectures the Yocto Project supports: + Linux 3.4 kernel, the kernel recipe file is the + meta/recipes-kernel/linux/linux-yocto_3.4.bb file. + Following is the default value for KBRANCH and the default + override for the architectures the Yocto Project supports: - KBRANCH = "standard/default/base" - KBRANCH_qemux86 = "standard/default/common-pc/base" - KBRANCH_qemux86-64 = "standard/default/common-pc-64/base" - KBRANCH_qemuppc = "standard/default/qemu-ppc32" - KBRANCH_qemumips = "standard/default/mti-malta32-be" - KBRANCH_qemuarm = "standard/default/arm-versatile-926ejs" + KBRANCH_DEFAULT = "standard/base" + KBRANCH = "${KBRANCH_DEFAULT}" - Each of the above branches exist in the linux-yocto-3.2 kernel Git - repository . + This branch exists in the linux-yocto-3.4 kernel Git + repository . @@ -1222,16 +1218,16 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" The kernel's append file is located in the BSP layer for a given machine. For example, the kernel append file for the Crown Bay BSP is in the meta-intel Git repository and is named - meta-crownbay/recipes-kernel/linux/linux-yocto_3.2.bbappend. + meta-crownbay/recipes-kernel/linux/linux-yocto_3.4.bbappend. Here are the related statements from the append file: COMPATIBLE_MACHINE_crownbay = "crownbay" KMACHINE_crownbay = "crownbay" - KBRANCH_crownbay = "standard/default/crownbay" - + KBRANCH_crownbay = "standard/crownbay" + COMPATIBLE_MACHINE_crownbay-noemgd = "crownbay-noemgd" KMACHINE_crownbay-noemgd = "crownbay" - KBRANCH_crownbay-noemgd = "standard/default/crownbay" + KBRANCH_crownbay-noemgd = "standard/crownbay" The KBRANCH_* statements identify the kernel branch to use when building for the Crown Bay BSP. @@ -1294,10 +1290,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" Kernel machine names are initially defined in the - Yocto Project Kernel in + Yocto Linux Kernel in + the meta branch. + From the meta branch, look in the meta/cfg/kernel-cache/bsp/<bsp_name>/<bsp-name>-<kernel-type>.scc file. - For example, in the linux-yocto-3.4 kernel in the - meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc file, + For example, from the meta branch in the + linux-yocto-3.0 kernel, the + meta/cfg/kernel-cache/bsp/cedartrail/cedartrail-standard.scc file has the following: define KMACHINE cedartrail @@ -1307,7 +1306,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" include ktypes/standard branch cedartrail - include cedartrail.scc + include cedartrail.scc You can see that the kernel understands the machine name for the Cedar Trail BSP as cedartrail. @@ -1795,7 +1794,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" This variable, which is set in the local.conf configuration file found in the conf folder of the - source directory, + Source Directory, specifies the package manager to use when packaging data. You can provide one or more arguments for the variable with the first argument being the package manager used to create images: @@ -2134,7 +2133,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" S - The location in the build directory + The location in the Build Directory where unpacked package source code resides. This location is within the working directory (WORKDIR), which @@ -2147,9 +2146,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" ${WORKDIR}/${PN}-${PV} As an example, assume a - source directory top-level + Source Directory top-level folder named poky - and a default build directory + and a default Build Directory at poky/build. In this case, the working directory the build system uses to build the db package is the following: @@ -2578,7 +2577,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" the upstream GCC or CodeSourcery Labs toolchain. The variable identifies the tcmode-* files used in the meta/conf/distro/include directory, which is found in the - source directory. + Source Directory. By default, TCMODE is set to "default", which @@ -2598,14 +2597,14 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" uses when it does its work building images. By default, the TMPDIR variable is named tmp within the - build directory. + Build Directory. If you want to establish this directory in a location other than the default, you can uncomment the following statement in the conf/local.conf file in the - source directory: + Source Directory: #TMPDIR = "${TOPDIR}/tmp" @@ -2617,9 +2616,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" This variable is the - build directory. + Build Directory. BitBake automatically sets this variable. - The OpenEmbedded build system uses the build directory when building images. + The OpenEmbedded build system uses the Build Directory when building images. @@ -2664,9 +2663,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} As an example, assume a - source directory top-level + Source Directory top-level folder name poky and a default - build directory + Build Directory at poky/build. In this case, the working directory the build system uses to build the v86d package is the following: @@ -2681,8 +2680,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} - As an example, again assume a source directory top-level folder - named poky and a default build directory + 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 the acl recipe, which is being built for a -- cgit v1.2.3-54-g00ecf