From 5966b44893a39847d3d590566dd488323a11ff73 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 2 Jul 2012 14:34:39 -0700 Subject: documentation/poky-ref-manual: Yocto Project scrub I have changed as many "Yocto Project" terms as possible so that better reflect reality. (From yocto-docs rev: 5f729e53b0cb653c97621e4e6598d9295d60ada5) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/ref-variables.xml | 109 ++++++++++++------------ 1 file changed, 54 insertions(+), 55 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 c815d3cfa0..99edab592e 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml @@ -8,7 +8,7 @@ Reference: Variables Glossary - This section lists common variables used in the Yocto Project and gives an overview + This section lists common variables used in the OpenEmbedded build system and gives an overview of their function and contents. @@ -89,7 +89,7 @@ B - The directory in which the Yocto Project build system places + The directory in which the OpenEmbedded build system places generated objects during a recipe's build process. By default, this directory is the same as the S directory: @@ -99,7 +99,7 @@ You can separate the source directory (S) and the directory pointed to by the B variable. Most autotools-based recipes support separating these directories. - The Yocto Project defaults to using separate directories for gcc + The build system defaults to using separate directories for gcc and some kernel recipes. @@ -160,7 +160,7 @@ Use the BBMASK variable from within the conf/local.conf file found - in the Yocto Project build directory. + in the build directory. @@ -243,9 +243,9 @@ BBLAYERS - Lists the layers to enable during the Yocto Project build. + Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration - file in the Yocto Project build directory. + file in the build directory. Here is an example: BBLAYERS = " \ @@ -335,8 +335,8 @@ /etc or ${bindir} rather than /usr/bin. You can find a list of these variables at the top of the - /meta/conf/bitbake.conf file in the Yocto Project - files directory. + /meta/conf/bitbake.conf file in the + source directory. @@ -358,7 +358,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 - Yocto Project Build Directory. + build directory. @@ -479,7 +479,7 @@ This directory is self-maintaining and you should not have to touch it. By default, the directory is downloads in the - Yocto Project build directory. + build directory. #DL_DIR ?= "${TOPDIR}/downloads" @@ -635,8 +635,8 @@ /etc or ${bindir} rather than /usr/bin. You can find a list of these variables at the top of the - /meta/conf/bitbake.conf file in the Yocto Project - files directory. + /meta/conf/bitbake.conf file in the + source directory. @@ -655,7 +655,7 @@ FILESEXTRAPATHS - Extends the search path the Yocto Project build system uses when + Extends the search path the OpenEmbedded build system uses when looking for files and patches as it processes recipes. The directories BitBake uses when it processes recipes is defined by the FILESPATH variable. @@ -691,7 +691,7 @@ FILESPATH - The default set of directories the Yocto Project build system uses + The default set of directories the OpenEmbedded build system uses when searching for patches and files. During the build process, BitBake searches each directory in FILESPATH in the specified order when looking for @@ -702,7 +702,7 @@ The default value for the FILESPATH variable is defined in the base.bbclass class found in meta/classes in the - Yocto Project Files: + source directory: FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ "${FILE_DIRNAME}/${P}", "${FILE_DIRNAME}/${PN}", \ @@ -727,16 +727,17 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ possible. - By default, the Yocto Project uses the fs-perms.txt, which - is located in the meta/files directory of the Yocto Project - files directory. + By default, the OpenEmbedded build system uses the fs-perms.txt, which + is located in the meta/files folder in the + 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 Yocto Project's - build directory, to point to your custom fs-perms.txt. + conf/local.conf file, which is found in the + 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 BBPATH variable. @@ -785,7 +786,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ Note that you can add extra features to the image by using the EXTRA_IMAGE_FEATURES variable. See the "Reference: Images" section for the - list of features present in images built by the Yocto Project. + list of features present in images built by the OpenEmbedded build system. @@ -908,7 +909,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ Defines the size in Kbytes for the generated image. - The Yocto Project build system determines the final size for the generated + The OpenEmbedded build system determines the final size for the generated image using an algorithm that takes into account the initial disk space used for the generated image, a requested size for the image, and requested additional free disk space to be added to the image. @@ -1035,8 +1036,8 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ KERNEL_FEATURES - Includes additional metadata from the Linux Yocto kernel Git repository. - In the Yocto Project build system, the default Board Support Packages (BSPs) + Includes additional metadata from the Yocto Project kernel Git repository. + In the OpenEmbedded build system, the default Board Support Packages (BSPs) metadata is provided through the KMACHINE and KBRANCH variables. You can use the KERNEL_FEATURES variable to further @@ -1049,7 +1050,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ In this way, you can provide validated, but optional, sets of kernel configurations and features. For example, the following adds netfilter to all - the Linux Yocto kernels and adds sound support to the qemux86 + the Yocto Project kernels and adds sound support to the qemux86 machine: # Add netfilter to all linux-yocto kernels @@ -1137,7 +1138,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ LICENSE_DIR Path to additional licenses used during the build. - By default, the Yocto Project uses COMMON_LICENSE_DIR + By default, the OpenEmbedded build system uses COMMON_LICENSE_DIR to define the directory that holds common license text used during the build. The LICENSE_DIR variable allows you to extend that location to other areas that have additional licenses: @@ -1341,7 +1342,8 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ PACKAGE_CLASSES This variable, which is set in the local.conf configuration - file found in the Yocto Project file's conf directory, + file found in the conf folder of the + 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: @@ -1534,7 +1536,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ RDEPENDS variable. - The Yocto Project build process automatically installs the list of packages + The OpenEmbedded build process automatically installs the list of packages as part of the built package. However, you can remove them later if you want. If, during the build, a package from the list cannot be found, the build @@ -1572,8 +1574,8 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ S - The location in the - Yocto Project Build Directory where unpacked package source code resides. + The location in the build directory + where unpacked package source code resides. This location is within the working directory (WORKDIR), which is not static. @@ -1585,9 +1587,10 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ ${WORKDIR}/${PN}-${PV} As an example, assume a - - Yocto Project Files top-level directory named poky - and a default Yocto Project Build Directory of poky/build. + 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 db package is the following: @@ -1661,10 +1664,10 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ - By default, the Yocto Project automatically detects whether + By default, the OpenEmbedded build system automatically detects whether SRC_URI contains files that are machine-specific. - If so, the Yocto Project automatically changes + If so, the build system automatically changes PACKAGE_ARCH. Setting this variable to "0" disables this behavior. @@ -1728,7 +1731,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ TARGET_ARCH The architecture of the device being built. - While a number of values are possible, the Yocto Project primarily supports + While a number of values are possible, the OpenEmbedded build system primarily supports arm and i586. @@ -1790,11 +1793,11 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ The TCMODE variable selects the external toolchain - built from the Yocto Project or a few supported combinations of + built using the OpenEmbedded build system or a few supported combinations of the upstream GCC or CodeSourcery Labs toolchain. The variable determines which of the tcmode-* files in the meta/conf/distro/include directory, which is found in the - Yocto Project Files, + source directory, is used. @@ -1811,20 +1814,18 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ TMPDIR - This variable is the temporary directory the Yocto Project build system + This variable is the temporary directory the OpenEmbedded build system uses when it does its work building images. By default, the TMPDIR variable is named tmp within the - - Yocto Project 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 - - Yocto Project Files: + source directory: #TMPDIR = "${TOPDIR}/tmp" @@ -1836,10 +1837,9 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ This variable is the - - Yocto Project Build Directory. + build directory. BitBake automatically sets this variable. - The Yocto Project build system uses the build directory when building images. + The OpenEmbedded build system uses the build directory when building images. @@ -1857,7 +1857,7 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ WORKDIR - The pathname of the working directory in which the Yocto Project build system + The pathname of the working directory in which the OpenEmbedded build system builds packages. This directory is located within the TMPDIR directory structure and changes @@ -1884,11 +1884,10 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ ${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 Directory of poky/build. + source directory top-level + folder name poky and a default + build directory + at poky/build. In this case, the working directory the build system uses to build the v86d package is the following: @@ -1902,9 +1901,9 @@ FILESPATH = "${@base_set_filespath([ "${FILE_DIRNAME}/${PF}", \ ${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. + 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 package, which is dependent on a MIPS-based device, is the following: -- cgit v1.2.3-54-g00ecf