diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 240201068d..18f358737f 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -67,6 +67,141 @@ + ALTERNATIVE + + + Lists commands in a package that need an alternative + binary naming scheme. + Sometimes the same command is provided in multiple packages. + When this occurs, the OpenEmbedded build system needs to + use the alternatives system to create a different binary + naming scheme so the commands can co-exist. + + + + To use the variable, list out the package's commands + that also exist as part of another package. + For example, if the busybox package + has four commands that also exist as part of another + package, you identify them as follows: + + ALTERNATIVE_busybox = "sh sed test bracket" + + For more information on the alternatives system, see the + "Alternatives - update-alternatives.bbclass" + section. + + + + + ALTERNATIVE_LINK_NAME + + + Used by the alternatives system to map duplicated commands + to actual locations. + For example, if the bracket command + provided by the busybox package is + duplicated through another package, you must use the + ALTERNATIVE_LINK_NAME variable to + specify the actual location: + + ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/[" + + In this example, the binary for the + bracket command (i.e. + [) from the + busybox package resides in + /usr/bin/. + + If ALTERNATIVE_LINK_NAME is not + defined, it defaults to + ${bindir}/<name>. + + + + + For more information on the alternatives system, see the + "Alternatives - update-alternatives.bbclass" + section. + + + + + ALTERNATIVE_PRIORITY + + + Used by the alternatives system to create default + priorities for duplicated commands. + You can use the variable to create a single default + regardless of the command name or package, a default for + specific duplicated commands regardless of the package, or + a default for specific commands tied to particular packages. + Here are the available syntax forms: + + ALTERNATIVE_PRIORITY = "<priority>" + ALTERNATIVE_PRIORITY[<name>] = "<priority>" + ALTERNATIVE_PRIORITY_<pkg>[<name>] = "<priority>" + + + + + For more information on the alternatives system, see the + "Alternatives - update-alternatives.bbclass" + section. + + + + + ALTERNATIVE_TARGET + + + Used by the alternatives system to create default link + locations for duplicated commands. + You can use the variable to create a single default + location for all duplicated commands regardless of the + command name or package, a default for + specific duplicated commands regardless of the package, or + a default for specific commands tied to particular packages. + Here are the available syntax forms: + + ALTERNATIVE_TARGET = "<target>" + ALTERNATIVE_TARGET[<name>] = "<target>" + ALTERNATIVE_TARGET_<pkg>[<name>] = "<target>" + + + + If ALTERNATIVE_TARGET is not + defined, it inherits the value from the + ALTERNATIVE_LINK_NAME + variable. + + + + If ALTERNATIVE_LINK_NAME and + ALTERNATIVE_TARGET are the + same, the target for + ALTERNATIVE_TARGET + has ".{BPN}" appended to it. + + + + Finally, if the file referenced has not been + renamed, the alternatives system will rename it to + avoid the need to rename alternative files in the + do_install task while + retaining support for the command if necessary. + + + + + + For more information on the alternatives system, see the + "Alternatives - update-alternatives.bbclass" + section. + + + + AUTHOR The email address used to contact the original author @@ -579,19 +714,6 @@ Core layer for images cannot be removed - C @@ -615,6 +737,17 @@ Core layer for images cannot be removed + COMMON_LICENSE_DIR + + + Points to meta/files/common-licenses + in the + Source Directory, + which is where generic license files reside. + + + + COMPATIBLE_HOST A regular expression that resolves to one or more hosts @@ -1043,6 +1176,30 @@ Core layer for images cannot be removed + EXCLUDE_FROM_WORLD + + + Directs BitBake to exclude a recipe from world builds (i.e. + bitbake world). + This variable is intrinsically understood by BitBake. + + + + During world builds, BitBake locates, parses and builds all + recipes found in every layer exposed in the + bblayers.conf configuration file. + + + + To exclude a recipe from a world build using this variable, + set the variable to "1" in the recipe. + Alternatively, if a recipe inherits a class where + EXCLUDE_FROM_WORLD is set to "1", that + recipe will also be excluded from world builds. + + + + EXTENDPKGV @@ -1798,7 +1955,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" - Set the variable to "1" to prevent the default dependencies. + Set the variable to "1" to prevent the default dependencies + from being added. @@ -1821,6 +1979,17 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + INITRAMFS_FSTYPES + + + Defines the format for the output image of an initial + RAM disk (initramfs), which is used during boot. + Supported formats are the same as those supported by the + IMAGE_FSTYPES + variable. + + + INITSCRIPT_PACKAGES @@ -1889,6 +2058,38 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + INTERCEPT_DIR + + + An environment variable that defines the directory where + post installation hooks are installed for the + post install environment. + This variable is fixed as follows: + + ${WORKDIR}/intercept_scripts + + + + + After installation of a target's root filesystem, + post installation scripts, which are essentially bash scripts, + are all executed just a single time. + Limiting execution of these scripts minimizes installation + time that would be lengthened due to certain packages + triggering redundant operations. + For example, consider the installation of font packages + as a common example. + Without limiting the execution of post installation scripts, + all font directories would be rescanned to create the + cache after each individual font package was installed. + + + + Do not edit the INTERCEPT_DIR + variable. + + + @@ -2875,6 +3076,25 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + OLDEST_KERNEL + + + Declares the oldest version of the Linux kernel that the + produced binaries must support. + This variable is passed into the build of the Embedded + GNU C Library (eglibc). + + + + The default for this variable comes from the + meta/conf/bitbake.conf configuration + file. + You can override this default by setting the variable + in a custom distribution configuration file. + + + + OVERRIDES @@ -3091,8 +3311,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" during do_patch. The default utility used is "quilt" except for the quilt-native recipe itself. - Because the quilt-native recipe is not available at the - time it is being patched, it uses "patch". + Because the quilt tool is not available at the + time quilt-native is being patched, it uses "patch". @@ -3648,10 +3868,19 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" SERIAL_CONSOLE - This variable is deprecated. - See the - SERIAL_CONSOLES - variable. + Define a serial console (TTY) to enable using getty. + Provide a value that specifies the baud rate followed by + the TTY device name separated by a space. + You cannot specify more than one TTY device: + + SERIAL_CONSOLE = "115200 ttyS0" + + + The SERIAL_CONSOLE is deprecated. + Please use the + SERIAL_CONSOLES + variable. + @@ -3767,6 +3996,42 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + SOLIBS + + + Defines the suffix for shared libraries used on the + target platform. + By default, this suffix is ".so.*" for all Linux + distributions and is defined in the + meta/conf/bitbake.conf configuration + file. + + + + You will see this variable referenced in the default values + of FILES_${PN}. + + + + + SOLIBSDEV + + + Defines the suffix for the development symbolic link + (symlink) for shared libraries on the target platform. + By default, this suffix is ".so" for all Linux + distributions and is defined in the + meta/conf/bitbake.conf configuration + file. + + + + You will see this variable referenced in the default values + of FILES_${PN}. + + + + SPECIAL_PKGSUFFIX @@ -4319,6 +4584,23 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + TRANSLATED_TARGET_ARCH + + + A sanitized version of + TARGET_ARCH. + This variable is used when package filenames contain + underscore characters that would otherwise not be allowed. + In this case, dash characters replace the underscore + characters used in the package names. + + + + Do not edit this variable. + + + +