diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 7606c9c799..8284c73868 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -2447,6 +2447,35 @@ + COREBASE_FILES + + COREBASE_FILES[doc] = "Lists files from the COREBASE directory that should be copied other than the layers listed in the bblayers.conf file." + + + + + Lists files from the + COREBASE + directory that should be copied other than the layers + listed in the bblayers.conf file. + The COREBASE_FILES variable exists + for the purpose of copying metadata from the + OpenEmbedded build system into the extensible + SDK. + + + + Copying these files is needed because + COREBASE typically contains build + directories and other files that should not normally + be copied into the extensible SDK. + Consequently, the value of + COREBASE_FILES is used in order to + only copy the files that are actually needed. + + + + CPP CPP[doc] = "Minimum command and arguments to run the C preprocessor." @@ -5899,6 +5928,43 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + INHERIT + + INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable is 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. + + + + + INHERIT_DISTRO + + INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable." + + + + + Lists classes that will be inherited at the + distribution level. + It is unlikely that you want to edit this variable. + + + + The default value of the variable is set as follows in the + meta/conf/distro/defaultsetup.conf + file: + + INHERIT_DISTRO ?= "debian devshell sstate license" + + + + + INHIBIT_DEFAULT_DEPS INHIBIT_DEFAULT_DEPS[doc] = "Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to DEPENDS." @@ -5963,43 +6029,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" - INHERIT - - INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable is 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. - - - - - INHERIT_DISTRO - - INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable." - - - - - Lists classes that will be inherited at the - distribution level. - It is unlikely that you want to edit this variable. - - - - The default value of the variable is set as follows in the - meta/conf/distro/defaultsetup.conf - file: - - INHERIT_DISTRO ?= "debian devshell sstate license" - - - - - INITRAMFS_FSTYPES INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM disk (initramfs), which is used during boot." @@ -8202,6 +8231,28 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + OE_INIT_ENV_SCRIPT + + OE_INIT_ENV_SCRIPT[doc] = "The name of the build environment setup script for the purposes of setting up the environment within the extensible SDK." + + + + + The name of the build environment setup script for the + purposes of setting up the environment within the + extensible SDK. + The default value is "oe-init-build-env". + + + + If you use a custom script to set up your build + environment, set the + OE_INIT_ENV_SCRIPT variable to its + name. + + + + OE_TERMINAL OE_TERMINAL[doc] = "Controls how the OpenEmbedded build system spawns interactive terminals on the host development system." @@ -10673,6 +10724,30 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + SDK_EXT_TYPE + + SDK_EXT_TYPE[doc] = "Specifies the required shared state artifacts for the extensible SDK." + + + + + Specifies the required shared state artifacts for the + extensible SDK. + The default value of "full" copies all of the required + shared state artifacts into the extensible SDK. + The value "minimal" leaves these artifacts out of the + SDK. + + If you set the variable to "minimal", you need to + ensure + SSTATE_MIRRORS + is set in the SDK's configuration to enable the + artifacts to be fetched as needed. + + + + + SDK_HOST_MANIFEST SDK_HOST_MANIFEST[doc] = "The manifest file for the host part of the SDK. This file lists all the installed packages that make up the host part of the SDK." @@ -10706,6 +10781,88 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + SDK_INCLUDE_PKGDATA + + SDK_INCLUDE_PKGDATA[doc] = "When set to "1", specifies to include the packagedata for all recipes in the "world" target in the extensible SDK." + + + + + When set to "1", specifies to include the packagedata for + all recipes in the "world" target in the extensible SDK. + Including this data allows the + devtool search command to find these + recipes in search results, as well as allows the + devtool add command to map + dependencies more effectively. + + Enabling the SDK_INCLUDE_PKGDATA + variable significantly increases build time because + all of world needs to be built. + Enabling the variable also slightly increases the size + of the extensible SDK. + + + + + + SDK_INHERIT_BLACKLIST + + SDK_INHERIT_BLACKLIST[doc] = "A list of classes to remove from the INHERIT value globally within the extensible SDK configuration." + + + + + A list of classes to remove from the + INHERIT + value globally within the extensible SDK configuration. + The default value is "buildhistory icecc". + + + + Some classes are not generally applicable within + the extensible SDK context and you can use this variable + to disable them. + + + + + SDK_LOCAL_CONF_BLACKLIST + + SDK_LOCAL_CONF_BLACKLIST[doc] = "A list of variables allowed through from the build system configuration into the extensible SDK configuration." + + + + + A list of variables allowed through from the build system + configuration into the extensible SDK configuration. + Usually, these are variables that are specific to the + machine on which the build system is running and thus + would be potentially problematic within the extensible SDK. + + + + + SDK_LOCAL_CONF_WHITELIST + + SDK_LOCAL_CONF_WHITELIST[doc] = "A list of variables allowed through from the build system configuration into the extensible SDK configuration." + + + + + A list of variables allowed through from the build system + configuration into the extensible SDK configuration. + This list overrides the variables specified using the + SDK_LOCAL_CONF_BLACKLIST + variable as well as any variables identified by automatic + blacklisting due to the "/" character being found at the + start of the value, which is usually indicative of being a + path and thus might not be valid on the system where the + SDK is installed. + + + + SDK_NAME SDK_NAME[doc] = "The base name for SDK output files." @@ -10837,6 +10994,31 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + SDK_RECRDEP_TASKS + + SDK_RECRDEP_TASKS[doc] = "A list of shared state tasks added to the extensible SDK." + + + + + A list of shared state tasks added to the extensible SDK. + The default value is "" and adds the following tasks to + the SDK: + + do_populate_lic + do_package_qa + do_populate_sysroot + do_deploy + + If you are defining additional tasks that are needed in + order to build + SDK_TARGETS, + use the SDK_RECRDEP_TASKS variable to + specify them. + + + + SDK_SYS SDK_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the SDK will be built." @@ -10894,6 +11076,64 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + SDK_TARGETS + + SDK_TARGETS[doc] = "A list of targets to install from shared state as part of the standard or extensible SDK installation." + + + + + A list of targets to install from shared state as part of + the standard or extensible SDK installation. + The default value is "${PN}" (i.e. the image from which + the SDK is built). + + + + The SDK_TARGETS variable is an + internal variable and typically would not be changed. + + + + + SDK_TITLE + + SDK_TITLE[doc] = "Specifies a title to be printed when running the SDK installer." + + + + + Specifies a title to be printed when running the SDK + installer. + The SDK_TITLE variable defaults to + "distro SDK" for the standard + SDK and "distro Extensible SDK" + for the extensible SDK, where + distro is the first one of + DISTRO_NAME + or + DISTRO + that is set in your configuration. + + + + + SDK_UPDATE_URL + + SDK_UPDATE_URL[doc] = "An optional URL for an update server for the extensible SDK." + + + + + An optional URL for an update server for the extensible + SDK. + If set, the value is used as the default update server when + running devtool sdk-update within the + extensible SDK. + + + + SDK_VENDOR SDK_VENDOR[doc] = "Specifies the name of the SDK vendor."