diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml
index 1c9b3798e7..cca03a1b03 100644
--- a/documentation/poky-ref-manual/ref-variables.xml
+++ b/documentation/poky-ref-manual/ref-variables.xml
@@ -66,22 +66,26 @@
BB_NUMBER_THREADS
- The maximum number of tasks BitBake should run in parallel at any one time
+ The maximum number of tasks BitBake should run in parallel at any one time.
+ If your host development system supports mulitiple cores a good rule of thumb
+ is to set this variable to twice the number of cores.BBFILE_COLLECTIONS
- Identifies layer-specific bbfiles, which contain recipes used by BitBake to build software.
+ Identifies layer-specific .bbfiles, which contain recipes
+ used by BitBake to build software.
The Variable is appended with a layer name.BBFILE_PATTERN
- Variable that expands to match files from BBFILES in a particular layer. BBFILE_PATTERN
- is used in the conf/layer.conf file and must contain the name of the
- specific layer (e.g. BBFILE_PATTERN_emenlow).
+ Variable that expands to match files from BBFILES in a particular layer.
+ This variable is used in the conf/layer.conf file and must
+ contain the name of the
+ specific layer (e.g. BBFILE_PATTERN_emenlow).
@@ -90,19 +94,18 @@
Assigns different priorities to recipe files in different layers.This variable is useful in situations where the same package appears in
more than one layer.
- Setting BBFILE_PRIORITY allows you to prioritize a
+ Setting this variable allows you to prioritize a
layer against other layers that contain the same package - effectively
letting you control the precedence for the multiple layers.
The precedence established through this variable stands regardless of a
- layer's package version (PV variable).
- For example, a layer that has a package with a higher PV value but for
- which the BBFILE_PRIORITY is set to have a lower precedence still has a
+ layer's package version (PV variable).
+ For example, a layer that has a package with a higher PV value but for
+ which the BBFILE_PRIORITY is set to have a lower precedence still has a
lower precedence.
- A larger value for the BBFILE_PRIORITY variable results in a higher
+ A larger value for the BBFILE_PRIORITY variable results in a higher
precedence.
- For example, the value 6 has a higher precedence than the
- value 5.
- By default, the BBFILE_PRIORITY variable is set to the value 5.
+ For example, the value 6 has a higher precedence than the value 5.
+ By default, the BBFILE_PRIORITY variable is set to the value 5.
@@ -114,27 +117,39 @@
BBPATH
- Used by Bitbake to locate bbclass and configuration files. This variable is analogous to
- the PATH variable.
+ Used by BitBake to locate .bbclass and configuration files.
+ This variable is analogous to the PATH variable.BBINCLUDELOGS
- Variable which controls how BitBake displays logs on build failure.
+ Variable that controls how BitBake displays logs on build failure.BBLAYERS
- Lists in the bblayers.conf file layers to enable in the Poky build.
+ Lists the layers to enable during the Yocto Project build.
+ This variable is defined in the bblayers.conf configuration
+ file in the Yocto Project build directory.
+ Here is an example:
+
+ BBLAYERS = " \
+ /home/scottrif/poky/meta \
+ /home/scottrif/poky/meta-yocto \
+ /home/scottrif/poky/meta-mykernel \
+ "
+
+ This example enables three layers, one of which is a custom, user-defined layer
+ named meta-mykernel.
+ BPN
- Bare name of package with any suffixes like -cross -native
- removed.
+ Bare name of package with any suffixes like -cross -native removed.
@@ -145,8 +160,9 @@
CFLAGS
- Flags passed to C compiler for the target system. Evaluates to the same
- as TARGET_CFLAGS.
+ Flags passed to C compiler for the target system.
+ This variable evaluates to the same as
+ TARGET_CFLAGS.
@@ -154,19 +170,21 @@
COMPATIBLE_MACHINEA regular expression which evaluates to match the machines the recipe
- works with. It stops recipes being run on machines they're incompatible with,
- which is particularly useful with kernels. It also helps to increase parsing
- speed as further parsing of the recipe is skipped as if it found the current
- machine is not compatible.
+ works with.
+ It stops recipes being run on machines for which they are not compatible.
+ This is particularly useful with kernels.
+ It also helps to increase parsing speed as further parsing of the recipe is skipped
+ if it is found the current machine is not compatible.
CONFIG_SITE
- A list of files which contains autoconf test results relevant
- to the current build. This variable is used by the autotools utilities
- when running configure.
+ A list of files that contains autoconf test results relevant
+ to the current build.
+ This variable is used by the Autotools utilities when running
+ configure.
@@ -177,16 +195,17 @@
D
- Destination directory
+ The destination directory.DEBUG_BUILD
- Build packages with debugging information. This influences the value
- SELECTED_OPTIMIZATION
- takes.
+ Specifies to build packages with debugging information.
+ This influences the value of the
+ SELECTED_OPTIMIZATION
+ variable.
@@ -194,94 +213,91 @@
DEBUG_OPTIMIZATION
- The options to pass in TARGET_CFLAGS
- and CFLAGS when compiling a system for debugging.
- This defaults to "-O -fno-omit-frame-pointer -g".
+ The options to pass in
+ TARGET_CFLAGS
+ and CFLAGS when compiling
+ a system for debugging.
+ This variable defaults to "-O -fno-omit-frame-pointer -g".
DEFAULT_PREFERENCE
- Priority of recipe
+ Specifies the priority of recipes.DEPENDS
- A list of build time dependencies for a given recipe. These indicate
- recipes that must have staged before this recipe can configure.
+ A list of build-time dependencies for a given recipe.
+ The variable indicates recipes that must have been staged before a
+ particular recipe can configure.
DESCRIPTION
- Package description used by package
- managers
+ The package description used by package managers.DESTDIR
- Destination directory
+ the destination directory.DISTRO
- Short name of distribution
+ The short name of the distribution.DISTRO_EXTRA_RDEPENDS
- List of packages required by distribution.
+ The list of packages required by the distribution.DISTRO_EXTRA_RRECOMMENDS
- List of packages which extend usability of
- image. Those packages will be automatically
- installed but can be removed by user.
+ The list of packages which extend usability of the image.
+ Those packages will automatically be installed but can be removed by user.DISTRO_FEATURES
- Features of the distribution.
+ The features of the distribution.DISTRO_NAME
- Long name of distribution
+ The long name of the distribution.DISTRO_PN_ALIAS
- Alias names of the recipe in various Linux distributions.
- More information in
-
- Configuring the DISTRO_PN_ALIAS variable section
-
-
+ Alias names used for the recipe in various Linux distributions.
+ See
+ Handling a Package Name Alias section for more information.DISTRO_VERSION
- Version of distribution
+ the version of the distribution.DL_DIR
- Directory where all fetched sources will be stored
+ The directory where all fetched sources will be stored.
@@ -291,9 +307,9 @@
ENABLE_BINARY_LOCALE_GENERATION
- Variable which control which locales for glibc are
- to be generated during build (useful if target device
- has 64M RAM or less)
+ Variable that controls which locales for glibc are
+ to be generated during the build (useful if the target device has 64Mbytes
+ of RAM or less).
@@ -303,58 +319,58 @@
You set this variable in the local.conf
configuration file.
Note that some image features are also added using the
- IMAGE_FEATURES
+ IMAGE_FEATURES
variable generally configured in image recipes.
- You can use the EXTRA_IMAGE_FEATURES variable to add more features
- in addition to those.
+ You can use this variable to add more features in addition to those.
Here are some exmaples of features you can add:
-"dbg-pkgs" - Adds -dbg packages for all installed packages
- including symbol information for debugging and
- profiling.
+ "dbg-pkgs" - Adds -dbg packages for all installed packages
+ including symbol information for debugging and
+ profiling.
-"dev-pkgs" - Adds -dev packages for all installed packages.
- This is useful if you want to develop against
- the libraries in the image.
+ "dev-pkgs" - Adds -dev packages for all installed packages.
+ This is useful if you want to develop against
+ the libraries in the image.
-"tools-sdk" - Adds development tools such as gcc, make,
- pkgconfig and so forth.
+ "tools-sdk" - Adds development tools such as gcc, make,
+ pkgconfig and so forth.
-"tools-debug" - Adds debugging tools such as gdb and
- strace.
+ "tools-debug" - Adds debugging tools such as gdb and
+ strace.
-"tools-profile" - Adds profiling tools such as oprofile,
- exmap, lttng and valgrind (x86 only).
+ "tools-profile" - Adds profiling tools such as oprofile,
+ exmap, lttng and valgrind (x86 only).
-"tools-testapps" - Adds useful testing tools such as ts_print,
- aplay, arecord and so forth.
+ "tools-testapps" - Adds useful testing tools such as
+ ts_print, aplay, arecord and so
+ forth.
-"debug-tweaks" - Makes an image suitable for development.
- For example, ssh root access has a blank
- password. There are other application
- targets too, see meta/classes/poky-image.bbclass
- and meta/packages/tasks/task-poky.bb
- for more details.
+ "debug-tweaks" - Makes an image suitable for development.
+ For example, ssh root access has a blank
+ password. There are other application
+ targets too, see
+ meta/classes/poky-image.bbclass
+ and meta/packages/tasks/task-poky.bb
+ for more details.
-
EXTRA_OECMAKE
- Additional cmake options
+ Additional cmake options.EXTRA_OECONF
- Additional 'configure' script options
+ Additional configure script options.EXTRA_OEMAKE
- Additional GNU make options
+ Additional GNU make options.
@@ -364,17 +380,19 @@
FILES
- list of directories/files which will be placed
- in packages
+ list of directories or files that are placed in packages.FULL_OPTIMIZATION
- The options to pass in TARGET_CFLAGS
- and CFLAGS when compiling an optimised system.
- This defaults to "-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2".
+ The options to pass in
+ TARGET_CFLAGS
+ and CFLAGS
+ when compiling an optimised system.
+ This variable defaults to
+ -fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2.
@@ -398,53 +416,52 @@
IMAGE_FEATURES
- List of
- features present in resulting images.
- Typically you configure this variable in image recipes.
+ The list of features present in images.
+ Typically, you configure this variable in image recipes.
Note that you can add extra features to the image by using the
- EXTRA_IMAGE_FEATURES
- variable.
+ EXTRA_IMAGE_FEATURES variable.
+ See the Reference: Images section for the
+ list of features present in images built by the Yocto Project.IMAGE_FSTYPES
- Formats of rootfs images which we want to have
- created
+ Formats of root filesystem images that you want to have created.IMAGE_INSTALL
- List of packages used to build image
+ The list of packages used to build images.INC_PRDefines the Package revision.
- You manually combine values for INC_PR into the PR field of the parent recipe.
- When you change INC_PR you change the PR value for every person that includes the file.
-
+ You manually combine values for INC_PR into the
+ PR field of the parent recipe.
+ When you change this variable, you change the PR
+ value for every person that includes the file.
- The following example shows how to use INC_PR given a common .inc
- that defines the variable.
- Once defined, the variable can be used to set the PR value:
+ The following example shows how to use the INC_PR variable
+ given a common .inc file that defines the variable.
+ Once defined, you can use the variable to set the PR value:
-
-recipes-graphics/xorg-font/font-util_1.1.1.bb:PR - "$(INC_PR).1"
-recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR - "r1"
-recipes-graphics/xorg-font/encondings_1.0.3.bb:PR - "$(INC_PR).1"
-recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
-
+
+ recipes-graphics/xorg-font/font-util_1.1.1.bb:PR - "$(INC_PR).1"
+ recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR - "r1"
+ recipes-graphics/xorg-font/encondings_1.0.3.bb:PR - "$(INC_PR).1"
+ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
+ INHIBIT_PACKAGE_STRIP
- This variable causes the build to not strip binaries in
- resulting packages.
+ Causes the build to not strip binaries in resulting packages.
@@ -453,9 +470,9 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
INHERIT
- This variable causes the named class to be inherited at
- this point during parsing. Its only valid in configuration
- files.
+ Causes the named class to be inherited at
+ this point during parsing.
+ The variable is only valid in configuration files.
@@ -464,23 +481,24 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
INITSCRIPT_PACKAGES
- Scope: Used in recipes when using update-rc.d.bbclass. Optional, defaults to PN.
+ A list of the packages that contain initscripts.
+ If multiple packages are specified, you need to append the package name
+ to the other INITSCRIPT_* as an override.
+
+ This variable is used in recipes when using update-rc.d.bbclass.
+ The variable is optional and defaults to PN.
-
- A list of the packages which contain initscripts. If multiple
- packages are specified you need to append the package name
- to the other INITSCRIPT_* as an override.
-
-
+
INITSCRIPT_NAME
- Scope: Used in recipes when using update-rc.d.bbclass. Mandatory.
+ The filename of the initscript (as installed to ${etcdir}/init.d).
- The filename of the initscript (as installed to ${etcdir}/init.d).
+ This variable is used in recipes when using update-rc.d.bbclass.
+ The variable is Mandatory.
@@ -488,13 +506,14 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
INITSCRIPT_PARAMS
- Scope: Used in recipes when using update-rc.d.bbclass. Mandatory.
+ Specifies the options to pass to update-rc.d.
+ An example is start 99 5 2 . stop 20 0 1 6 ., which gives the script a
+ runlevel of 99, starts the script in initlevels 2 and 5, and
+ stops the script in levels 0, 1 and 6.
- Specifies the options to pass to update-rc.d. An example is
- "start 99 5 2 . stop 20 0 1 6 ." which gives the script a
- runlevel of 99, starts the script in initlevels 2 and 5 and
- stops it in levels 0, 1 and 6.
+ The variable is mandatory and is used in recipes when using
+ update-rc.d.bbclass.
@@ -510,9 +529,10 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
KERNEL_IMAGETYPEThe type of kernel to build for a device, usually set by the
- machine configuration files and defaults to "zImage". This is used
- when building the kernel and is passed to "make" as the target to
- build.
+ machine configuration files and defaults to "zImage".
+ This variable is used
+ when building the kernel and is passed to make as the target to
+ build.
@@ -522,33 +542,35 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
LAYERDIR
- When used inside a layer.conf gives the path of the
- current layer. This variable requires immediate expansion
- (see the Bitbake manual) as lazy expansion can result in
- the expansion happening in the wrong directory and therefore
- giving the wrong value.
+ When used inside the layer.conf configuration
+ file, this variable provides the path of the current layer.
+ This variable requires immediate expansion
+ (see the BitBake manual) as lazy expansion can result in
+ the expansion happening in the wrong directory and therefore
+ giving the wrong value.
+
LICENSE
- List of package source licenses.
+ The list of package source licenses.
+
LIC_FILES_CHKSUM
- Checksums of the license text in the recipe source code.
-
+ Checksums of the license text in the recipe source code.This variable tracks changes in license text of the source
- code files. If the license text is changed, it will trigger the build
- failure, which gives developer an opportunity to review any
- license change
- This is an optional variable now, and the plan is to make
- it a required variable in the future
- See "meta/package/zlib/zlib_${PV}.bb" file for an example
-
- More information in
- Configuring the LIC_FILES_CHKSUM variable section
+ code files.
+ If the license text is changed, it will trigger the build
+ failure, which gives the developer an opportunity to review any
+ license change
+
+ Currently, this variable is optional.
+ The plan is to make it a required variable in the future.
+ For more information, see the
+
+ Track License Change section
@@ -558,47 +580,47 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
MACHINE
- Target device
+ Specifies the target device.MACHINE_ESSENTIAL_RDEPENDS
- List of packages required to boot device
+ Specifies the list of packages required to boot the device.MACHINE_ESSENTIAL_RRECOMMENDS
- List of packages required to boot device (usually
- additional kernel modules)
+ Specifies the list of packages required to boot the device (usually
+ additional kernel modules).MACHINE_EXTRA_RDEPENDS
- List of packages required to use device
+ Specifies the list of packages required to use the devicesMACHINE_EXTRA_RRECOMMNEDS
- List of packages useful to use device (for example
+ Specifies the list of packages useful to use the device (e.g.
additional kernel modules)MACHINE_FEATURES
- List of device features - defined in machine
- features section
+ Specifies the list of device features.
+ See the Machine section for
+ more information.MAINTAINER
- E-mail of distribution maintainer
+ The email address of the distribution maintainer.
@@ -613,74 +635,85 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
PACKAGE_ARCH
- Architecture of resulting package
+ The architecture of the resulting package.PACKAGE_CLASSES
- List of resulting packages formats
+ Specifies the list of resulting package formats.PACKAGE_DESCRIPTION
- Long form description of binary package for packaging sytems such as ipkg, rpm or debian, inherits DESCRIPTION by default
+ The long form description of the binary package for packaging sytems such as
+ ipkg, rpm or debian.
+ This variable inherits DESCRIPTION by default.PACKAGE_EXTRA_ARCHS
- List of architectures compatible with device
- CPU. Usable when build is done for few different
- devices with misc processors (like XScale and
- ARM926-EJS)
+ Specifies the list of architectures compatible with the device CPU.
+ This variable is useful when you build for several different devices that use
+ miscellaneous processors such as XScale and ARM926-EJS).PACKAGE_SUMMARY
- Short (72 char suggested) Summary of binary package for packaging sytems such as ipkg, rpm or debian, inherits DESCRIPTION by default
+ The short (72 character limit suggested) summary of the binary
+ package for packaging sytems such as ipkg,
+ rpm or debian.
+ By default, this variable inherits DESCRIPTION.PACKAGES
- List of packages to be created from recipe.
- The default value is "${PN}-dbg ${PN} ${PN}-doc ${PN}-dev"
+ The list of packages to be created from the recipe.
+ The default value is ${PN}-dbg ${PN} ${PN}-doc ${PN}-dev.PARALLEL_MAKE
- Extra options that are passed to the make command during the
- compile tasks. This is usually of the form '-j 4' where the number
- represents the maximum number of parallel threads make can run.
+ Specifies extra options that are passed to the make command during the
+ compile tasks.
+ This variable is usually in the form -j 4, where the number
+ represents the maximum number of parallel threads make can run.
+ If you development host supports multiple cores a good rule of thumb is to set
+ this variable to one and a half times the number of cores on the host.PN
- Name of package.
+ The name of the package.
PR
- Revision of package. The default value is "r0".
+ The revision of the package.
+ The default value for this variable is "r0".
PV
- Version of package.
- This is normally extracted from the recipe name, e.g. if the recipe is named
- "expat_2.0.1.bb" then PV will be "2.0.1". PV is generally not overridden within
+ The version of the package.
+ The version is normally extracted from the recipe name.
+ For example, if the recipe is named
+ expat_2.0.1.bb, then PV
+ will be 2.0.1.
+ PV is generally not overridden within
a recipe unless it is building an unstable version from a source code repository
- (git, svn, etc.).
+ (e.g. Git or Subversion).
@@ -688,8 +721,9 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
PE
- Epoch of the package. The default value is "0". The field is used
- to make upgrades possible when the versioning scheme changes in
+ the epoch of the package.
+ The default value is "0".
+ The field is used to make upgrades possible when the versioning scheme changes in
some backwards incompatible way.
@@ -698,39 +732,46 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
PREFERRED_PROVIDERIf multiple recipes provide an item, this variable
- determines which one should be given preference. It
- should be set to the "$PN" of the recipe to be preferred.
+ determines which recipe should be given preference.
+ The variable should be set to the $PN of the recipe
+ to which you want to give precedence.
PREFERRED_VERSION
- If there are multiple versions of recipe available, this
- variable determines which one should be given preference. It
- should be set to the "$PV" of the recipe to be preferred.
+ If there are multiple versions of recipes available, this
+ variable determines which recipe should be given preference.
+ The variable should be set to the $PV of the recipe
+ to whichy you want to give precedence.
POKY_EXTRA_INSTALL
- List of packages to be added to the image. This should
- only be set in local.conf.
+ 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's build directory.POKYLIBC
- Libc implementation selector - glibc, eglibc, or uclibc can be selected.
+ The libc implementation selector.
+ You can select glibc, eglibc,
+ or uclibc.POKYMODE
- Toolchain selector. It can be external toolchain
- built from Poky or few supported combinations of
- upstream GCC or CodeSourcery Labs toolchain.
+ The toolchain selector.
+ This variable has been replaced by TCMODE.
+ The POKYMODE would select the external toolchain
+ built from the Yocto Project or a few supported combinations of
+ upstream GCC or CodeSourcery Labs toolchain.
@@ -743,46 +784,46 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
RCONFLICTS
- List of packages which conflict with this
- one. Package will not be installed if they are not
- removed first.
+ The list of packages that conflict with this package.
+ Note that the package will not be installed if the conflicting packages are not
+ first removed.RDEPENDS
- A list of run-time dependencies for a package. These packages
- need to be installed alongside the package it applies to so
- the package will run correctly, an example is a perl script
- which would rdepend on perl. Since this variable applies to
- output packages there would usually be an override attached
- to this variable like RDEPENDS_${PN}-dev. Names in this field
- should be as they are in PACKAGES
- namespace before any renaming of the output package
- by classes like debian.bbclass.
+ A list of run-time dependencies for a package.
+ These packages need to be installed alongside the package to which
+ they apply.
+ This enables the package to run correctly.
+ For example, consider a Perl script, which depends on the Perl package.
+ Since this variable applies to
+ output packages, there would usually be an override attached
+ to this variable such as RDEPENDS_${PN}-dev.
+ Names in this field must appear as they appear in the
+ PACKAGES namespace before any
+ renaming of the output package by classes like debian.bbclass.
ROOT_FLASH_SIZE
- Size of rootfs in megabytes
+ The size of root filesystem as measured in megabytes.RRECOMMENDS
- List of packages which extend usability of the
- package. Those packages will be automatically
- installed but can be removed by user.
+ The list of packages that extend usability of the package.
+ The packages are automatically installed but can be removed by user.RREPLACES
- List of packages which are replaced with this
- one.
+ The list of packages that are replaced with this package.
@@ -793,25 +834,28 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
S
- Path to unpacked sources (by default:
- "${WORKDIR}/${PN}-${PV}")
+ The path to unpacked sources.
+ By default, this path is
+ "${WORKDIR}/${PN}-${PV}".
SECTION
- Section where package should be put - used
- by package managers
+ The section where package should be put.
+ Package managers use this variable.SELECTED_OPTIMIZATION
- The variable takes the value of FULL_OPTIMIZATION
- unless DEBUG_BUILD = "1" in which case
- DEBUG_OPTIMIZATION is used.
+ The variable takes the value of
+ FULL_OPTIMIZATION
+ unless DEBUG_BUILD = "1".
+ In this case the value of
+ DEBUG_OPTIMIZATION is used.
@@ -819,24 +863,24 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
SERIAL_CONSOLE
- Speed and device for serial port used to attach
- serial console. This is given to kernel as "console"
- param and after boot getty is started on that port
+ The speed and device for the serial port used to attach the serial console.
+ This variable is given to the kernel as the "console"
+ parameter and after booting occurs getty is started on that port
so remote login is possible.SSTATE_DIR
- Directory for the shared state.
+ The directory for the shared state.SHELLCMDS
- A list of commands to run within the a shell, used by TERMCMDRUN.
+ A list of commands to run within the shell.
+ The list is used by TERMCMDRUN.
@@ -844,8 +888,8 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
SITEINFO_ENDIANESS
- Contains "le" for little-endian or "be" for big-endian depending
- on the endian byte order of the target system.
+ Specifies the endian byte order of the target system.
+ The variable is either "le" for little-endian or "be" for big-endian.
@@ -853,27 +897,27 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
SITEINFO_BITS
- Contains "32" or "64" depending on the number of bits for the
- CPU of the target system.
+ Specifies the number of bits for the target system CPU.
+ The variable is either "32" or "64".
SRC_URI
- List of source files (local or remote ones)
+ The list of source files - local or remote.SRC_URI_OVERRIDES_PACKAGE_ARCH
- By default there is code which automatically detects whether
- SRC_URI
- contains files which are machine specific and if this is the case it
- automatically changes
- PACKAGE_ARCH.
- Setting this variable to "0" disables that behaviour.
+ By default, the Yocto Project automatically detects whether
+ SRC_URI
+ contains files that are machine-specific.
+ If so, the Yocto Project automatically changes
+ PACKAGE_ARCH.
+ Setting this variable to "0" disables this behaviour.
@@ -881,8 +925,8 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
SRCDATE
- Date of source code used to build package (if it was fetched
- from SCM).
+ The date of the source code used to build the package.
+ This variable applies only if the source was fetched from a Source Code Manager (SCM).
@@ -890,8 +934,8 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
SRCREV
- Revision of source code used to build package (Subversion,
- GIT, Bazaar only).
+ The revision of the source code used to build the package.
+ This variable applies to Subversion, GitT, or Bazaar only.
@@ -899,7 +943,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
STAGING_KERNEL_DIR
- Directory with kernel headers required to build out-of-tree
+ The directory with kernel headers that are required to build out-of-tree
modules.
@@ -908,7 +952,7 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
STAMPS
- Directory (usually TMPDIR/stamps) with timestamps of
+ The directory (usually TMPDIR/stamps) with timestamps of
executed tasks.
@@ -916,7 +960,10 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
SUMMARY
- Short (72 char suggested) Summary of binary package for packaging systems such as ipkg, rpm or debian, inherits DESCRIPTION by default
+ The short (72 characters or less) summary of the binary package for packaging
+ systems such as ipkg, rpm or
+ debian.
+ By default, this variable inherits DESCRIPTION.
@@ -926,17 +973,18 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
TARGET_ARCH
- The architecture of the device we're building for.
- A number of values are possible but Poky primarily supports
- "arm" and "i586".
+ The architecture of the device being built.
+ While a number of values are possible, the Yocto Project primarily supports
+ arm and i586.TARGET_CFLAGS
- Flags passed to C compiler for the target system. Evaluates to the same
- as CFLAGS.
+ Flags passed to the C compiler for the target system.
+ This variable evaluates to the same as
+ CFLAGS.
@@ -944,29 +992,45 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
TARGET_FPU
- Method of handling FPU code. For FPU-less targets
- (most of ARM cpus) it has to be set to "soft" otherwise
- kernel emulation will get used which will result in
- performance penalty.
+ Specifies the method for handling FPU code.
+ For FPU-less targets, which include most ARM CPUs, the variable must be
+ set to "soft".
+ If not, the kernel emulation gets used, which results in a performance penalty.TARGET_OS
- Type of target operating system. Can be "linux"
- for glibc based system, "linux-uclibc" for uClibc. For
- ARM/EABI targets there are also "linux-gnueabi" and
- "linux-uclibc-gnueabi" values possible.
+ Specifies the target's operating system.
+ The variable can be set to "linux" for glibc-based systems and
+ "linux-uclibc" for uClibc.
+ For ARM/EABI targets, there are also "linux-gnueabi" and
+ "linux-uclibc-gnueabi" values possible.
+ TCMODE
+
+ The toolchain selector.
+ This variable replaces POKYMODE.
+ The variable determines which of the files in
+ meta/conf/distro/include/tcmode-* is used.
+ By default, TCMODE is set to "default", which
+ chooses tcmode-default.inc.
+ The variable is similar to TCLIBC, which controls the
+ libc used: eglibc or uclibc.
+
+
+
+
TERMCMD
- This command is used by bitbake to lauch a terminal window with a
- shell. The shell is unspecified so the user's default shell is used.
- By default it is set to gnome-terminal but it can
- be any X11 terminal application or terminal multiplexers like screen.
+ This command is used by BitBake to lauch a terminal window with a
+ shell.
+ The shell is unspecified so the user's default shell is used.
+ By default, the variable is set to gnome-terminal but it can
+ be any X11 terminal application or terminal multiplexers-like screen.
@@ -974,9 +1038,11 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
TERMCMDRUN
- This command is similar to TERMCMD however instead of the users shell it runs the command specified by the SHELLCMDS variable.
+ This variable is similar to
+ TERMCMD.
+ However, instead of running the user's shell, the command specified by
+ the SHELLCMDS
+ variable is run.
@@ -993,8 +1059,8 @@ recipes-graphics/xorg-font/fiont-alias_1.0.2.bb:PR - "$(INC_PR).0"
WORKDIR
- Path to directory in tmp/work/ where package
- will be built.
+ The path to directory in tmp/work/ where
+ the package is built.