summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-02-12 13:32:59 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-02-17 15:17:03 +0000
commit3dad9aee73f1da4e911d7d42953bb06e5a26b770 (patch)
tree41638d0d68673dac48f505d82438491d438d89f9 /documentation
parent6d17aa00f9fe6bd1c00b383b8863c99be07e9d2c (diff)
downloadpoky-3dad9aee73f1da4e911d7d42953bb06e5a26b770.tar.gz
adt-manual, ref-manual: Detail on using an external toolchain.
Fixes [YOCTO #4907] I created a new section in the toolchain chapter of the adt-manual called "optionally Using an External Toolchain". This provides some fundamental information for the user that wants to use an external toolchain. Additionally, it references Mentor Graphics Sourcery toolchain as an example. In the ref-manual, I updated the TCMODE variable description to better integrate the MGC Sourcery toolchain as the overriding example. (From yocto-docs rev: 51e9c3b88f7e5a16da2aa101589b0f2612fff11d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 260e1f18a0..3d0cfd42fb 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -709,6 +709,45 @@
709 </para> 709 </para>
710</section> 710</section>
711 711
712<section id='optionally-using-an-external-toolchain'>
713 <title>Optionally Using an External Toolchain</title>
714
715 <para>
716 You might want to use an external toolchain as part of your
717 development.
718 If this is the case, the fundamental steps you need to accomplish
719 are as follows:
720 <itemizedlist>
721 <listitem><para>
722 Understand where the installed toolchain resides.
723 For cases where you need to build the external toolchain, you
724 would need to take separate steps to build and install the
725 toolchain.
726 </para></listitem>
727 <listitem><para>
728 Make sure you add the layer that contains the toolchain to
729 your <filename>bblayers.conf</filename> file through the
730 <ulink url='&YOCTO_DOCS_REF_URL;#var-BBLAYERS'><filename>BBLAYERS</filename></ulink>
731 variable.
732 </para></listitem>
733 <listitem><para>
734 Set the
735 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTERNAL_TOOLCHAIN'><filename>EXTERNAL_TOOLCHAIN</filename></ulink>
736 variable in your <filename>local.conf</filename> file
737 to the location in which you installed the toolchain.
738 </para></listitem>
739 </itemizedlist>
740 A good example of an external toolchain used with the Yocto Project
741 is <trademark class='registered'>Mentor Graphics</trademark>
742 Sourcery G++ Toolchain.
743 You can see information on how to use that particular layer in the
744 <filename>README</filename> file at
745 <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>.
746 You can find further information by reading about the
747 <ulink url='&YOCTO_DOCS_REF_URL;#var-TCMODE'><filename>TCMODE</filename></ulink>
748 variable in the Yocto Project Reference Manual's variable glossary.
749 </para>
750</section>
712</chapter> 751</chapter>
713<!-- 752<!--
714vim: expandtab tw=80 ts=4 753vim: expandtab tw=80 ts=4
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 8f0d8917b5..971a89806d 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"
11141 </para> 11141 </para>
11142 11142
11143 <para> 11143 <para>
11144 The <filename>TCMODE</filename> variable is similar to
11145 <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>,
11146 which controls the variant of the GNU standard C library
11147 (<filename>libc</filename>) used during the build process:
11148 <filename>glibc</filename> or <filename>uclibc</filename>.
11149 </para>
11150
11151 <para>
11144 With additional layers, it is possible to use a pre-compiled 11152 With additional layers, it is possible to use a pre-compiled
11145 external toolchain. 11153 external toolchain.
11146 One example is the Sourcery G++ Toolchain. 11154 One example is the Sourcery G++ Toolchain.
11147 The support for this toolchain resides in the separate 11155 The support for this toolchain resides in the separate
11156 <trademark class='registered'>Mentor Graphics</trademark>
11148 <filename>meta-sourcery</filename> layer at 11157 <filename>meta-sourcery</filename> layer at
11149 <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>. 11158 <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>.
11150 You can use <filename>meta-sourcery</filename> as a
11151 template for adding support for other external toolchains.
11152 </para> 11159 </para>
11153 11160
11154 <para> 11161 <para>
11155 The <filename>TCMODE</filename> variable points the build 11162 The layer's <filename>README</filename> file contains
11156 system to a file in 11163 information on how to use the Sourcery G++ Toolchain as
11157 <filename>conf/distro/include/tcmode-${TCMODE}.inc</filename>. 11164 an external toolchain.
11158 Thus, for <filename>meta-sourcery</filename>, 11165 In summary, you must be sure to add the layer to your
11159 which has <filename>conf/distro/include/tcmode-external-sourcery.inc</filename>, 11166 <filename>bblayers.conf</filename> file in front of the
11160 you would set the variable as follows: 11167 <filename>meta</filename> layer and then set the
11161 <literallayout class='monospaced'> 11168 <link linkend='var-EXTERNAL_TOOLCHAIN'><filename>EXTERNAL_TOOLCHAIN</filename></link>
11162 TCMODE ?= "external-sourcery" 11169 variable in your <filename>local.conf</filename> file
11163 </literallayout> 11170 to the location in which you installed the toolchain.
11164 </para> 11171 </para>
11165 11172
11166 <para> 11173 <para>
11167 The variable is similar to 11174 The fundamentals used for this example apply to any
11168 <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, 11175 external toolchain.
11169 which controls the variant of the GNU standard C library 11176 You can use <filename>meta-sourcery</filename> as a
11170 (<filename>libc</filename>) used during the build process: 11177 template for adding support for other external toolchains.
11171 <filename>glibc</filename> or <filename>uclibc</filename>.
11172 </para> 11178 </para>
11173 </glossdef> 11179 </glossdef>
11174 </glossentry> 11180 </glossentry>