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>
This commit is contained in:
Scott Rifenbark 2016-09-13 13:17:57 -07:00 committed by Richard Purdie
parent 4824bb4fda
commit 6cecded9ef
3 changed files with 41 additions and 0 deletions

View File

@ -1591,6 +1591,10 @@
Specifies whether or not packagedata will be included in
the extensible SDK for all recipes in the "world" target.
</para></listitem>
<listitem><para><link linkend='var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></link>:
Specifies whether or not the toolchain will be included
when building the extensible SDK.
</para></listitem>
<listitem><para><link linkend='var-SDK_LOCAL_CONF_WHITELIST'><filename>SDK_LOCAL_CONF_WHITELIST</filename></link>:
A list of variables allowed through from the build system
configuration into the extensible SDK configuration.

View File

@ -11290,6 +11290,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</glossdef>
</glossentry>
<glossentry id='var-SDK_INCLUDE_TOOLCHAIN'><glossterm>SDK_INCLUDE_TOOLCHAIN</glossterm>
<info>
SDK_INCLUDE_TOOLCHAIN[doc] = "When set to "1", specifies to include the toolchain 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 toolchain in the
extensible SDK.
Including the toolchain is useful particularly when
<link linkend='var-SDK_EXT_TYPE'><filename>SDK_EXT_TYPE</filename></link>
is set to "minimal" to keep the SDK reasonably small
but you still want to provide a usable toolchain.
For example, suppose you want to use the toolchain from an
IDE (e.g. Eclipse) or from other tools and you do not
want to perform additional steps to install the toolchain.
</para>
<para>
The <filename>SDK_INCLUDE_TOOLCHAIN</filename> variable
defaults to "0" if <filename>SDK_EXT_TYPE</filename>
is set to "minimal", and defaults to "1" if
<filename>SDK_EXT_TYPE</filename> is set to "full".
</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."

View File

@ -381,6 +381,16 @@
section for more information.
</note>
</para>
<para>
You can explicitly control whether or not to include the toolchain
when you build and SDK by setting the
<ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></ulink>
variable.
When you set this variable to "1", you cause the toolchain to be
included even when <filename>SDK_EXT_TYPE</filename> is set to
"minimal".
</para>
</section>
</appendix>
<!--