diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 3511f38855..1911f33ba7 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -18,11 +18,11 @@ A B - C + C D E F - G + G H I @@ -307,6 +307,22 @@ + ASSUME_SHLIBS + + ASSUME_SHLIBS[doc] = "List of shlib:package[_version] mappings. Useful for lib packages in ASSUME_PROVIDED, for which automatic shlib dependency tracking does not work." + + + + List of shlib:package[_version] + mappings. + This variable is useful for library packages in + ASSUME_PROVIDED, + for which automatic shlib dependency + tracking does not work. + + + + AUTHOR AUTHOR[doc] = "Email address used to contact the original author or authors in order to send patches and forward bugs." @@ -875,6 +891,18 @@ + BBINCLUDELOGS_LINES + + BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure." + + + + The number of log lines the OpenEmbedded build system + prints upon failure. + + + + BBLAYERS BBLAYERS[doc] = "Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration file." @@ -1157,6 +1185,18 @@ + BUILD_ARCH + + BUILD_ARCH[doc] = "The name of the building architecture (e.g. i686)." + + + + Specifies the architecture of the build system + (e.g. i686). + + + + BUILD_CFLAGS BUILD_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the build host." @@ -1241,6 +1281,18 @@ + BUILD_OS + + BUILD_OS[doc] = "The operating system (in lower case) of the building architecture (e.g. Linux)." + + + + Specifies the operating system in use on the build + system (e.g. Linux). + + + + BUILDDIR BUILDDIR[doc] = "Points to the location of the Build Directory." @@ -1569,6 +1621,17 @@ C + CACHE + + CACHE[doc] = "The directory holding the cache of the metadata." + + + + The directory that contains the cache for the Metadata. + + + + CC CC[doc] = "Minimum command and arguments to run the C compiler." @@ -1774,6 +1837,20 @@ + CONF_VERSION + + CONF_VERSION[doc] = "Tracks the version of local.conf. Increased each time build/conf/ changes incompatibly." + + + + Tracks the version of the local configuration file + (i.e. local.conf). + The value for CONF_VERSION + increments each time build/conf/ + compatibility changes. + + + CONFFILES CONFFILES[doc] = "Identifies editable or configurable files that are part of a package." @@ -2022,6 +2099,18 @@ + CVSDIR + + CVSDIR[doc] = "The directory where cvs checkouts will be stored in." + + + + The directory in which files checked out under the + CVS system are stored. + + + + CXX CXX[doc] = "Minimum command and arguments to run the C++ compiler." @@ -2092,6 +2181,18 @@ + DATE + + DATE[doc] = "The date the build was started using YMD format." + + + + The date the build was started. + Dates appear using the year, month, and day (YMD) format. + + + + DATETIME DATETIME[doc] = "The date and time the build was started." @@ -3532,6 +3633,22 @@ + FONT_EXTRA_RDEPENDS + + FONT_EXTRA_RDEPENDS[doc] = "When a recipe inherits the fontcache class, this variable specifies runtime dependencies for font packages. This variable defaults to 'fontconfig-utils'." + + + + When inheriting the + fontcache + class, this variable specifies the runtime dependencies + for font packages. + By default, the FONT_EXTRA_RDEPENDS + is set to "fontconfig-utils". + + + + FONT_PACKAGES FONT_PACKAGES[doc] = "When a recipe inherits the fontcache class, this variable identifies packages containing font files that need to be cached by Fontconfig." @@ -3570,6 +3687,18 @@ G + GITDIR + + GITDIR[doc] = "The directory where Git clones will be stored." + + + + The directory in which a local copy of a Git repository + is stored when it is cloned. + + + + GLIBC_GENERATE_LOCALES GLIBC_GENERATE_LOCALES[doc]= "Specifies the list of GLIBC locales to generate should you not wish generate all LIBC locals, which can be time consuming." @@ -3821,6 +3950,34 @@ + HOST_ARCH + + HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH." + + + + + The name of the target architecture, which is normally + the same as + TARGET_ARCH. + The OpenEmbedded build system supports many + architectures. + Here is an example list of architectures supported. + This list is by no means complete as the architecture + is configurable: + + arm + i586 + x86_64 + powerpc + powerpc64 + mips + mipsel + + + + + HOST_CC_ARCH HOST_CC_ARCH[doc] = "The name of the host architecture. Normally same as the TARGET_CC_ARCH." @@ -3854,6 +4011,36 @@ + HOST_OS + + HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS." + + + + Specifies the name of the target operating system, which + is normally the same as the + TARGET_OS. + The variable can be set to "linux" for glibc-based systems and + to "linux-uclibc" for uclibc. + For ARM/EABI targets, there are also "linux-gnueabi" and + "linux-uclibc-gnueabi" values possible. + + + + + HOST_PREFIX + + HOST_PREFIX[doc] = "The prefix for the cross compile toolchain. Normally same as the TARGET_PREFIX." + + + + Specifies the prefix for the cross-comile toolchain. + HOST_PREFIX is normally the same as + TARGET_PREFIX. + + + + HOST_SYS HOST_SYS[doc] = "Specifies the system, including the architecture and the operating system, for with the build is occurring in the context of the current recipe." @@ -3861,9 +4048,8 @@ Specifies the system, including the architecture and the - operating system, for with the build is occurring - in the context of the current - recipe. + operating system, for which the build is occurring + in the context of the current recipe. The OpenEmbedded build system automatically sets this variable. You do not need to set the variable yourself. @@ -3885,6 +4071,19 @@ + HOST_VENDOR + + HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR." + + + + Specifies the name of the vendor. + HOST_VENDOR is normally the same as + TARGET_VENDOR. + + + + I @@ -7242,6 +7441,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + PACKAGE_INSTALL_ATTEMPTONLY + + PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed. If a listed package fails to install, the build system does not generate an error. This variable is generally not user-defined." + + + + Specifies a list of packages the OpenEmbedded build + system attempts to install. + If a listed package fails to install, the build system + does not generate an error. + This variable is generally not user-defined. + + + + PACKAGE_PREPROCESS_FUNCS PACKAGE_PREPROCESS_FUNCS[doc] = "Specifies a list of functions run to pre-process the PKGD directory prior to splitting the files out to individual packages." @@ -7997,6 +8211,21 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + PRIORITY + + PRIORITY[doc] = "Indicates the importance of a package. The default value is 'optional'. Other standard values are 'required', 'standard' and 'extra'." + + + + + Indicates the importance of a package. + You can set PRIORITY to "required", + "standard", "extra", and "optional", which is the default. + +--> + + + PRIVATE_LIBS PRIVATE_LIBS[doc] = "Specifies libraries installed within a recipe that should be ignored by the OpenEmbedded build system's shared library resolver." @@ -9266,6 +9495,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + SOURCE_MIRROR_FETCH + + SOURCE_MIRROR_FETCH[doc] = "Switch marking build as source fetcher. Used to skip COMPATIBLE_* checking." + + + + Switch marking build as source fetcher. + This variable is used to skip + COMPATIBLE_* checking. + + + + SOURCE_MIRROR_URL SOURCE_MIRROR_URL[doc] = "URL to source mirror that will be used before fetching from original SRC_URI." @@ -9999,6 +10241,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + SVNDIR + + SVNDIR[doc] = "The directory where Subversion checkouts will be stored." + + + + + The directory in which files checked out of a Subversion + system are stored. + + + + SYSLINUX_DEFAULT_CONSOLE SYSLINUX_DEFAULT_CONSOLE[doc] = "Specifies the kernel boot default console." @@ -10494,6 +10749,32 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + TARGET_SYS + + TARGET_SYS[doc] = "The target system is comprised of TARGET_ARCH,TARGET_VENDOR and TARGET_OS." + + + + The target system, which is comprised of + TARGET_ARCH, + TARGET_VENDOR, + and + TARGET_OS. + + + + + TARGET_VENDOR + + TARGET_VENDOR[doc] = "The name of the target vendor." + + + + Specifies the name of the target vendor. + + + + TCLIBCAPPEND TCLIBCAPPEND[doc] = "Specifies a suffix appended to TMPDIR that identifies the libc variant for the build." @@ -10982,6 +11263,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + TIME + + TIME[doc] = "The time the build was started using HMS format." + + + + The time the build was started. + Times appear using the hour, minute, and second (HMS) format. + + + + TMPDIR TMPDIR[doc] = "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 Build Directory." @@ -11640,7 +11933,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" USE_DEVFS - USE_DEVFS[doc] = "Determines if devtmpfs is used for/dev population." + USE_DEVFS[doc] = "Determines if devtmpfs is used for /dev population."