summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-05-04 15:29:03 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-07-28 18:02:28 +0100
commit113c4279e7b9082837ad70559dc70601c5ca33ed (patch)
treecdf08e9e8da0e26d5bcf35593bfcaa1a7270f9e5 /documentation/ref-manual
parent2a95850d641445e8b792c566f35209698ef1dd68 (diff)
downloadpoky-113c4279e7b9082837ad70559dc70601c5ca33ed.tar.gz
ref-manual: Added descriptions for four new variables
Fixes [YOCTO #7665] Added descriptions in the glossary for the following variables: * SDK_HOST_MANIFEST * SDK_TARGET_MANIFEST * SDK_VERSION * TOOLCHAIN_OUTPUTNAME (From yocto-docs rev: d8a7e3443d33d02d88e9d603dcff917a5508ae17) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml118
1 files changed, 118 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 71bd8e5260..c330fe04a1 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -10020,6 +10020,39 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10020 </glossdef> 10020 </glossdef>
10021 </glossentry> 10021 </glossentry>
10022 10022
10023 <glossentry id='var-SDK_HOST_MANIFEST'><glossterm>SDK_HOST_MANIFEST</glossterm>
10024 <info>
10025 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."
10026 </info>
10027 <glossdef>
10028 <para role="glossdeffirst">
10029<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
10030 The manifest file for the host part of the SDK.
10031 This file lists all the installed packages that make up
10032 the host part of SDK.
10033 The file contains package information on a line-per-package
10034 basis as follows:
10035 <literallayout class='monospaced'>
10036 <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable>
10037 </literallayout>
10038 </para>
10039
10040 <para>
10041 The
10042 <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
10043 class defines the manifest file as follows:
10044 <literallayout class='monospaced'>
10045 SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest"
10046 </literallayout>
10047 The location is derived using the
10048 <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>
10049 and
10050 <link linkend='var-TOOLCHAIN_OUTPUTNAME'><filename>TOOLCHAIN_OUTPUTNAME</filename></link>
10051 variables.
10052 </para>
10053 </glossdef>
10054 </glossentry>
10055
10023 <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm> 10056 <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm>
10024 <info> 10057 <info>
10025 SDK_NAME[doc] = "The base name for SDK output files." 10058 SDK_NAME[doc] = "The base name for SDK output files."
@@ -10146,6 +10179,39 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10146 </glossdef> 10179 </glossdef>
10147 </glossentry> 10180 </glossentry>
10148 10181
10182 <glossentry id='var-SDK_TARGET_MANIFEST'><glossterm>SDK_TARGET_MANIFEST</glossterm>
10183 <info>
10184 SDK_TARGET_MANIFEST[doc] = "The manifest file for the target part of the SDK. This file lists all the installed packages that make up the target part of the SDK."
10185 </info>
10186 <glossdef>
10187 <para role="glossdeffirst">
10188<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
10189 The manifest file for the target part of the SDK.
10190 This file lists all the installed packages that make up
10191 the target part of the SDK.
10192 The file contains package information on a line-per-package
10193 basis as follows:
10194 <literallayout class='monospaced'>
10195 <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable>
10196 </literallayout>
10197 </para>
10198
10199 <para>
10200 The
10201 <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
10202 class defines the manifest file as follows:
10203 <literallayout class='monospaced'>
10204 SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest"
10205 </literallayout>
10206 The location is derived using the
10207 <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>
10208 and
10209 <link linkend='var-TOOLCHAIN_OUTPUTNAME'><filename>TOOLCHAIN_OUTPUTNAME</filename></link>
10210 variables.
10211 </para>
10212 </glossdef>
10213 </glossentry>
10214
10149 <glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm> 10215 <glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm>
10150 <info> 10216 <info>
10151 SDK_VENDOR[doc] = "Specifies the name of the SDK vendor." 10217 SDK_VENDOR[doc] = "Specifies the name of the SDK vendor."
@@ -10158,6 +10224,32 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
10158 </glossdef> 10224 </glossdef>
10159 </glossentry> 10225 </glossentry>
10160 10226
10227 <glossentry id='var-SDK_VERSION'><glossterm>SDK_VERSION</glossterm>
10228 <info>
10229 SDK_VERSION[doc] = "Specifies the version for the SDK."
10230 </info>
10231 <glossdef>
10232 <para role="glossdeffirst">
10233<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
10234 Specifies the version of the SDK.
10235 The distribution configuration file (e.g.
10236 <filename>/meta-yocto/conf/distro/poky.conf</filename>)
10237 defines the <filename>SDK_VERSION</filename> as follows:
10238 <literallayout class='monospaced'>
10239 SDK_VERSION := "${@'${DISTRO_VERSION}'.replace('snapshot-${DATE}','snapshot')}"
10240 </literallayout>
10241 </para>
10242
10243 <para>
10244 For additional information, see the
10245 <link linkend='var-DISTRO_VERSION'><filename>DISTRO_VERSION</filename></link>
10246 and
10247 <link linkend='var-DATE'><filename>DATE</filename></link>
10248 variables.
10249 </para>
10250 </glossdef>
10251 </glossentry>
10252
10161 <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm> 10253 <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm>
10162 <info> 10254 <info>
10163 SDKIMAGE_FEATURES[doc] = "Equivalent to IMAGE_FEATURES. However, this variable applies to the SDK generated from an image using the command 'bitbake -c populate_sdk imagename'." 10255 SDKIMAGE_FEATURES[doc] = "Equivalent to IMAGE_FEATURES. However, this variable applies to the SDK generated from an image using the command 'bitbake -c populate_sdk imagename'."
@@ -12550,6 +12642,32 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
12550 </glossdef> 12642 </glossdef>
12551 </glossentry> 12643 </glossentry>
12552 12644
12645 <glossentry id='var-TOOLCHAIN_OUTPUTNAME'><glossterm>TOOLCHAIN_OUTPUTNAME</glossterm>
12646 <info>
12647 TOOLCHAIN_OUTPUTNAME[doc] = "Defines the name used for the toolchain output."
12648 </info>
12649 <glossdef>
12650 <para role="glossdeffirst">
12651<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
12652 This variable defines the name used for the toolchain
12653 output.
12654 The
12655 <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link>
12656 class sets the
12657 <filename>TOOLCHAIN_OUTPUTNAME</filename> variable as
12658 follows:
12659 <literallayout class='monospaced'>
12660 TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}"
12661 </literallayout>
12662 See the
12663 <link linkend='var-SDK_NAME'><filename>SDK_NAME</filename></link>
12664 and
12665 <link linkend='var-SDK_VERSION'><filename>SDK_VERSION</filename></link>
12666 variables for additional information.
12667 </para>
12668 </glossdef>
12669 </glossentry>
12670
12553 <glossentry id='var-TOOLCHAIN_TARGET_TASK'><glossterm>TOOLCHAIN_TARGET_TASK</glossterm> 12671 <glossentry id='var-TOOLCHAIN_TARGET_TASK'><glossterm>TOOLCHAIN_TARGET_TASK</glossterm>
12554 <info> 12672 <info>
12555 TOOLCHAIN_TARGET_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when it creates the target part of an SDK, which includes libraries and headers." 12673 TOOLCHAIN_TARGET_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when it creates the target part of an SDK, which includes libraries and headers."