summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-09-13 13:17:57 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-09-23 15:27:34 +0100
commit6cecded9ef1bd09fb7b89ed28c4268c40272665d (patch)
tree5f3a55f37e3c584bd23ae8ce317e5f7af9d8e25a /documentation
parent4824bb4fdaf0778620658d1a901509ad76ad2092 (diff)
downloadpoky-6cecded9ef1bd09fb7b89ed28c4268c40272665d.tar.gz
sdk-manual, ref-manual: New variable for including toolchain
Added a new variable description for SDK_INCLUDE_TOOLCHAIN. Along with the new glossary entry, I updated a couple places where it would be relevant to cross-reference the new variable. (From yocto-docs rev: df99b097595e7488a93354082b8d9f33acd9c229) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/closer-look.xml4
-rw-r--r--documentation/ref-manual/ref-variables.xml27
-rw-r--r--documentation/sdk-manual/sdk-appendix-customizing.xml10
3 files changed, 41 insertions, 0 deletions
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
index a9eb1b6c7f..bcd1707236 100644
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/closer-look.xml
@@ -1591,6 +1591,10 @@
1591 Specifies whether or not packagedata will be included in 1591 Specifies whether or not packagedata will be included in
1592 the extensible SDK for all recipes in the "world" target. 1592 the extensible SDK for all recipes in the "world" target.
1593 </para></listitem> 1593 </para></listitem>
1594 <listitem><para><link linkend='var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></link>:
1595 Specifies whether or not the toolchain will be included
1596 when building the extensible SDK.
1597 </para></listitem>
1594 <listitem><para><link linkend='var-SDK_LOCAL_CONF_WHITELIST'><filename>SDK_LOCAL_CONF_WHITELIST</filename></link>: 1598 <listitem><para><link linkend='var-SDK_LOCAL_CONF_WHITELIST'><filename>SDK_LOCAL_CONF_WHITELIST</filename></link>:
1595 A list of variables allowed through from the build system 1599 A list of variables allowed through from the build system
1596 configuration into the extensible SDK configuration. 1600 configuration into the extensible SDK configuration.
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 21c1e42388..a10a0dca75 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -11290,6 +11290,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
11290 </glossdef> 11290 </glossdef>
11291 </glossentry> 11291 </glossentry>
11292 11292
11293 <glossentry id='var-SDK_INCLUDE_TOOLCHAIN'><glossterm>SDK_INCLUDE_TOOLCHAIN</glossterm>
11294 <info>
11295 SDK_INCLUDE_TOOLCHAIN[doc] = "When set to "1", specifies to include the toolchain in the extensible SDK."
11296 </info>
11297 <glossdef>
11298 <para role="glossdeffirst">
11299<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
11300 When set to "1", specifies to include the toolchain in the
11301 extensible SDK.
11302 Including the toolchain is useful particularly when
11303 <link linkend='var-SDK_EXT_TYPE'><filename>SDK_EXT_TYPE</filename></link>
11304 is set to "minimal" to keep the SDK reasonably small
11305 but you still want to provide a usable toolchain.
11306 For example, suppose you want to use the toolchain from an
11307 IDE (e.g. Eclipse) or from other tools and you do not
11308 want to perform additional steps to install the toolchain.
11309 </para>
11310
11311 <para>
11312 The <filename>SDK_INCLUDE_TOOLCHAIN</filename> variable
11313 defaults to "0" if <filename>SDK_EXT_TYPE</filename>
11314 is set to "minimal", and defaults to "1" if
11315 <filename>SDK_EXT_TYPE</filename> is set to "full".
11316 </para>
11317 </glossdef>
11318 </glossentry>
11319
11293 <glossentry id='var-SDK_INHERIT_BLACKLIST'><glossterm>SDK_INHERIT_BLACKLIST</glossterm> 11320 <glossentry id='var-SDK_INHERIT_BLACKLIST'><glossterm>SDK_INHERIT_BLACKLIST</glossterm>
11294 <info> 11321 <info>
11295 SDK_INHERIT_BLACKLIST[doc] = "A list of classes to remove from the INHERIT value globally within the extensible SDK configuration." 11322 SDK_INHERIT_BLACKLIST[doc] = "A list of classes to remove from the INHERIT value globally within the extensible SDK configuration."
diff --git a/documentation/sdk-manual/sdk-appendix-customizing.xml b/documentation/sdk-manual/sdk-appendix-customizing.xml
index 79326077f5..0695707af3 100644
--- a/documentation/sdk-manual/sdk-appendix-customizing.xml
+++ b/documentation/sdk-manual/sdk-appendix-customizing.xml
@@ -381,6 +381,16 @@
381 section for more information. 381 section for more information.
382 </note> 382 </note>
383 </para> 383 </para>
384
385 <para>
386 You can explicitly control whether or not to include the toolchain
387 when you build and SDK by setting the
388 <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></ulink>
389 variable.
390 When you set this variable to "1", you cause the toolchain to be
391 included even when <filename>SDK_EXT_TYPE</filename> is set to
392 "minimal".
393 </para>
384</section> 394</section>
385</appendix> 395</appendix>
386<!-- 396<!--