ref-manual: Added several extensible SDK variables to glossary.
SDK_EXT_TYPE SDK_RECRDEP_TASKS SDK_LOCAL_CONF_WHITELIST SDK_LOCAL_CONF_BLACKLIST SDK_INHERIT_BLACKLIST SDK_UPDATE_URL SDK_TARGETS OE_INIT_ENV_SCRIPT COREBASE_FILES SDK_TITLE SDK_INCLUDE_PKGDATA (From yocto-docs rev: c057b9c7027460fa6e53beb3431bf6aa1518b3aa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
6dfd441d08
commit
54490c06c6
|
@ -2447,6 +2447,35 @@
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-COREBASE_FILES'><glossterm>COREBASE_FILES</glossterm>
|
||||||
|
<info>
|
||||||
|
COREBASE_FILES[doc] = "Lists files from the COREBASE directory that should be copied other than the layers listed in the bblayers.conf file."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
Lists files from the
|
||||||
|
<link linkend='var-COREBASE'><filename>COREBASE</filename></link>
|
||||||
|
directory that should be copied other than the layers
|
||||||
|
listed in the <filename>bblayers.conf</filename> file.
|
||||||
|
The <filename>COREBASE_FILES</filename> variable exists
|
||||||
|
for the purpose of copying metadata from the
|
||||||
|
OpenEmbedded build system into the extensible
|
||||||
|
SDK.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Copying these files is needed because
|
||||||
|
<filename>COREBASE</filename> typically contains build
|
||||||
|
directories and other files that should not normally
|
||||||
|
be copied into the extensible SDK.
|
||||||
|
Consequently, the value of
|
||||||
|
<filename>COREBASE_FILES</filename> is used in order to
|
||||||
|
only copy the files that are actually needed.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-CPP'><glossterm>CPP</glossterm>
|
<glossentry id='var-CPP'><glossterm>CPP</glossterm>
|
||||||
<info>
|
<info>
|
||||||
CPP[doc] = "Minimum command and arguments to run the C preprocessor."
|
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"
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm>
|
||||||
|
<info>
|
||||||
|
INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable is only valid in configuration files."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
Causes the named class to be inherited at
|
||||||
|
this point during parsing.
|
||||||
|
The variable is only valid in configuration files.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-INHERIT_DISTRO'><glossterm>INHERIT_DISTRO</glossterm>
|
||||||
|
<info>
|
||||||
|
INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
Lists classes that will be inherited at the
|
||||||
|
distribution level.
|
||||||
|
It is unlikely that you want to edit this variable.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The default value of the variable is set as follows in the
|
||||||
|
<filename>meta/conf/distro/defaultsetup.conf</filename>
|
||||||
|
file:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
INHERIT_DISTRO ?= "debian devshell sstate license"
|
||||||
|
</literallayout>
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm>
|
<glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm>
|
||||||
<info>
|
<info>
|
||||||
INHIBIT_DEFAULT_DEPS[doc] = "Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to DEPENDS."
|
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"
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm>
|
|
||||||
<info>
|
|
||||||
INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable is only valid in configuration files."
|
|
||||||
</info>
|
|
||||||
<glossdef>
|
|
||||||
<para role="glossdeffirst">
|
|
||||||
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
|
||||||
Causes the named class to be inherited at
|
|
||||||
this point during parsing.
|
|
||||||
The variable is only valid in configuration files.
|
|
||||||
</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
|
|
||||||
<glossentry id='var-INHERIT_DISTRO'><glossterm>INHERIT_DISTRO</glossterm>
|
|
||||||
<info>
|
|
||||||
INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable."
|
|
||||||
</info>
|
|
||||||
<glossdef>
|
|
||||||
<para role="glossdeffirst">
|
|
||||||
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
|
||||||
Lists classes that will be inherited at the
|
|
||||||
distribution level.
|
|
||||||
It is unlikely that you want to edit this variable.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
The default value of the variable is set as follows in the
|
|
||||||
<filename>meta/conf/distro/defaultsetup.conf</filename>
|
|
||||||
file:
|
|
||||||
<literallayout class='monospaced'>
|
|
||||||
INHERIT_DISTRO ?= "debian devshell sstate license"
|
|
||||||
</literallayout>
|
|
||||||
</para>
|
|
||||||
</glossdef>
|
|
||||||
</glossentry>
|
|
||||||
|
|
||||||
<glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm>
|
<glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm>
|
||||||
<info>
|
<info>
|
||||||
INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM disk (initramfs), which is used during boot."
|
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"
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-OE_INIT_ENV_SCRIPT'><glossterm>OE_INIT_ENV_SCRIPT</glossterm>
|
||||||
|
<info>
|
||||||
|
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."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
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".
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
If you use a custom script to set up your build
|
||||||
|
environment, set the
|
||||||
|
<filename>OE_INIT_ENV_SCRIPT</filename> variable to its
|
||||||
|
name.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm>
|
<glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm>
|
||||||
<info>
|
<info>
|
||||||
OE_TERMINAL[doc] = "Controls how the OpenEmbedded build system spawns interactive terminals on the host development system."
|
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"
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-SDK_EXT_TYPE'><glossterm>SDK_EXT_TYPE</glossterm>
|
||||||
|
<info>
|
||||||
|
SDK_EXT_TYPE[doc] = "Specifies the required shared state artifacts for the extensible SDK."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
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.
|
||||||
|
<note>
|
||||||
|
If you set the variable to "minimal", you need to
|
||||||
|
ensure
|
||||||
|
<link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>
|
||||||
|
is set in the SDK's configuration to enable the
|
||||||
|
artifacts to be fetched as needed.
|
||||||
|
</note>
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-SDK_HOST_MANIFEST'><glossterm>SDK_HOST_MANIFEST</glossterm>
|
<glossentry id='var-SDK_HOST_MANIFEST'><glossterm>SDK_HOST_MANIFEST</glossterm>
|
||||||
<info>
|
<info>
|
||||||
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."
|
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"
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-SDK_INCLUDE_PKGDATA'><glossterm>SDK_INCLUDE_PKGDATA</glossterm>
|
||||||
|
<info>
|
||||||
|
SDK_INCLUDE_PKGDATA[doc] = "When set to "1", specifies to include the packagedata for all recipes in the "world" target in the extensible SDK."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
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
|
||||||
|
<filename>devtool search</filename> command to find these
|
||||||
|
recipes in search results, as well as allows the
|
||||||
|
<filename>devtool add</filename> command to map
|
||||||
|
dependencies more effectively.
|
||||||
|
<note>
|
||||||
|
Enabling the <filename>SDK_INCLUDE_PKGDATA</filename>
|
||||||
|
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.
|
||||||
|
</note>
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-SDK_INHERIT_BLACKLIST'><glossterm>SDK_INHERIT_BLACKLIST</glossterm>
|
||||||
|
<info>
|
||||||
|
SDK_INHERIT_BLACKLIST[doc] = "A list of classes to remove from the INHERIT value globally within the extensible SDK configuration."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
A list of classes to remove from the
|
||||||
|
<link linkend='var-INHERIT'><filename>INHERIT</filename></link>
|
||||||
|
value globally within the extensible SDK configuration.
|
||||||
|
The default value is "buildhistory icecc".
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Some classes are not generally applicable within
|
||||||
|
the extensible SDK context and you can use this variable
|
||||||
|
to disable them.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-SDK_LOCAL_CONF_BLACKLIST'><glossterm>SDK_LOCAL_CONF_BLACKLIST</glossterm>
|
||||||
|
<info>
|
||||||
|
SDK_LOCAL_CONF_BLACKLIST[doc] = "A list of variables allowed through from the build system configuration into the extensible SDK configuration."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
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.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-SDK_LOCAL_CONF_WHITELIST'><glossterm>SDK_LOCAL_CONF_WHITELIST</glossterm>
|
||||||
|
<info>
|
||||||
|
SDK_LOCAL_CONF_WHITELIST[doc] = "A list of variables allowed through from the build system configuration into the extensible SDK configuration."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
A list of variables allowed through from the build system
|
||||||
|
configuration into the extensible SDK configuration.
|
||||||
|
This list overrides the variables specified using the
|
||||||
|
<link linkend='var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></link>
|
||||||
|
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.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm>
|
<glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm>
|
||||||
<info>
|
<info>
|
||||||
SDK_NAME[doc] = "The base name for SDK output files."
|
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"
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-SDK_RECRDEP_TASKS'><glossterm>SDK_RECRDEP_TASKS</glossterm>
|
||||||
|
<info>
|
||||||
|
SDK_RECRDEP_TASKS[doc] = "A list of shared state tasks added to the extensible SDK."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
A list of shared state tasks added to the extensible SDK.
|
||||||
|
The default value is "" and adds the following tasks to
|
||||||
|
the SDK:
|
||||||
|
<literallayout class='monospaced'>
|
||||||
|
do_populate_lic
|
||||||
|
do_package_qa
|
||||||
|
do_populate_sysroot
|
||||||
|
do_deploy
|
||||||
|
</literallayout>
|
||||||
|
If you are defining additional tasks that are needed in
|
||||||
|
order to build
|
||||||
|
<link linkend='var-SDK_TARGETS'><filename>SDK_TARGETS</filename></link>,
|
||||||
|
use the <filename>SDK_RECRDEP_TASKS</filename> variable to
|
||||||
|
specify them.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-SDK_SYS'><glossterm>SDK_SYS</glossterm>
|
<glossentry id='var-SDK_SYS'><glossterm>SDK_SYS</glossterm>
|
||||||
<info>
|
<info>
|
||||||
SDK_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the SDK will be built."
|
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"
|
||||||
</glossdef>
|
</glossdef>
|
||||||
</glossentry>
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-SDK_TARGETS'><glossterm>SDK_TARGETS</glossterm>
|
||||||
|
<info>
|
||||||
|
SDK_TARGETS[doc] = "A list of targets to install from shared state as part of the standard or extensible SDK installation."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
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).
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The <filename>SDK_TARGETS</filename> variable is an
|
||||||
|
internal variable and typically would not be changed.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-SDK_TITLE'><glossterm>SDK_TITLE</glossterm>
|
||||||
|
<info>
|
||||||
|
SDK_TITLE[doc] = "Specifies a title to be printed when running the SDK installer."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
Specifies a title to be printed when running the SDK
|
||||||
|
installer.
|
||||||
|
The <filename>SDK_TITLE</filename> variable defaults to
|
||||||
|
"<replaceable>distro</replaceable> SDK" for the standard
|
||||||
|
SDK and "<replaceable>distro</replaceable> Extensible SDK"
|
||||||
|
for the extensible SDK, where
|
||||||
|
<replaceable>distro</replaceable> is the first one of
|
||||||
|
<link linkend='var-DISTRO_NAME'><filename>DISTRO_NAME</filename></link>
|
||||||
|
or
|
||||||
|
<link linkend='var-DISTRO'><filename>DISTRO</filename></link>
|
||||||
|
that is set in your configuration.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
|
<glossentry id='var-SDK_UPDATE_URL'><glossterm>SDK_UPDATE_URL</glossterm>
|
||||||
|
<info>
|
||||||
|
SDK_UPDATE_URL[doc] = "An optional URL for an update server for the extensible SDK."
|
||||||
|
</info>
|
||||||
|
<glossdef>
|
||||||
|
<para role="glossdeffirst">
|
||||||
|
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
|
||||||
|
An optional URL for an update server for the extensible
|
||||||
|
SDK.
|
||||||
|
If set, the value is used as the default update server when
|
||||||
|
running <filename>devtool sdk-update</filename> within the
|
||||||
|
extensible SDK.
|
||||||
|
</para>
|
||||||
|
</glossdef>
|
||||||
|
</glossentry>
|
||||||
|
|
||||||
<glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm>
|
<glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm>
|
||||||
<info>
|
<info>
|
||||||
SDK_VENDOR[doc] = "Specifies the name of the SDK vendor."
|
SDK_VENDOR[doc] = "Specifies the name of the SDK vendor."
|
||||||
|
|
Loading…
Reference in New Issue