aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/adt-manual/adt-prepare.xml39
-rw-r--r--documentation/ref-manual/ref-variables.xml38
2 files changed, 61 insertions, 16 deletions
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index 260e1f18a02..3d0cfd42fb0 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -709,6 +709,45 @@
</para>
</section>
+<section id='optionally-using-an-external-toolchain'>
+ <title>Optionally Using an External Toolchain</title>
+
+ <para>
+ You might want to use an external toolchain as part of your
+ development.
+ If this is the case, the fundamental steps you need to accomplish
+ are as follows:
+ <itemizedlist>
+ <listitem><para>
+ Understand where the installed toolchain resides.
+ For cases where you need to build the external toolchain, you
+ would need to take separate steps to build and install the
+ toolchain.
+ </para></listitem>
+ <listitem><para>
+ Make sure you add the layer that contains the toolchain to
+ your <filename>bblayers.conf</filename> file through the
+ <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
+ variable.
+ </para></listitem>
+ <listitem><para>
+ Set the
+ <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTERNAL_TOOLCHAIN'><filename>EXTERNAL_TOOLCHAIN</filename></ulink>
+ variable in your <filename>local.conf</filename> file
+ to the location in which you installed the toolchain.
+ </para></listitem>
+ </itemizedlist>
+ A good example of an external toolchain used with the Yocto Project
+ is <trademark class='registered'>Mentor Graphics</trademark>
+ Sourcery G++ Toolchain.
+ You can see information on how to use that particular layer in the
+ <filename>README</filename> file at
+ <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>.
+ You can find further information by reading about the
+ <ulink url='&YOCTO_DOCS_REF_URL;#var-TCMODE'><filename>TCMODE</filename></ulink>
+ variable in the Yocto Project Reference Manual's variable glossary.
+ </para>
+</section>
</chapter>
<!--
vim: expandtab tw=80 ts=4
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 8f0d8917b5e..971a89806db 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -11141,34 +11141,40 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
</para>
<para>
+ The <filename>TCMODE</filename> variable is similar to
+ <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>,
+ which controls the variant of the GNU standard C library
+ (<filename>libc</filename>) used during the build process:
+ <filename>glibc</filename> or <filename>uclibc</filename>.
+ </para>
+
+ <para>
With additional layers, it is possible to use a pre-compiled
external toolchain.
One example is the Sourcery G++ Toolchain.
The support for this toolchain resides in the separate
+ <trademark class='registered'>Mentor Graphics</trademark>
<filename>meta-sourcery</filename> layer at
<ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>.
- You can use <filename>meta-sourcery</filename> as a
- template for adding support for other external toolchains.
</para>
<para>
- The <filename>TCMODE</filename> variable points the build
- system to a file in
- <filename>conf/distro/include/tcmode-${TCMODE}.inc</filename>.
- Thus, for <filename>meta-sourcery</filename>,
- which has <filename>conf/distro/include/tcmode-external-sourcery.inc</filename>,
- you would set the variable as follows:
- <literallayout class='monospaced'>
- TCMODE ?= "external-sourcery"
- </literallayout>
+ The layer's <filename>README</filename> file contains
+ information on how to use the Sourcery G++ Toolchain as
+ an external toolchain.
+ In summary, you must be sure to add the layer to your
+ <filename>bblayers.conf</filename> file in front of the
+ <filename>meta</filename> layer and then set the
+ <link linkend='var-EXTERNAL_TOOLCHAIN'><filename>EXTERNAL_TOOLCHAIN</filename></link>
+ variable in your <filename>local.conf</filename> file
+ to the location in which you installed the toolchain.
</para>
<para>
- The variable is similar to
- <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>,
- which controls the variant of the GNU standard C library
- (<filename>libc</filename>) used during the build process:
- <filename>glibc</filename> or <filename>uclibc</filename>.
+ The fundamentals used for this example apply to any
+ external toolchain.
+ You can use <filename>meta-sourcery</filename> as a
+ template for adding support for other external toolchains.
</para>
</glossdef>
</glossentry>