]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
yocto-project-qs, adt-manual: Updates to toolchain installer script
authorScott Rifenbark <scott.m.rifenbark@intel.com>
Mon, 26 Aug 2013 08:17:49 +0000 (11:17 +0300)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Mon, 26 Aug 2013 10:06:30 +0000 (11:06 +0100)
The way in which the toolchain installer scripts are named has
changed.  I have updated two sections that describe this so that
the new naming scheme is used.

(From yocto-docs rev: 71b70a12c72bca7cad565b5d6f44b2c6b311844d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
documentation/adt-manual/adt-prepare.xml
documentation/yocto-project-qs/yocto-project-qs.xml

index f8ba557f398a830492b72662b273217fc9afeab7..6900b0cd8cc0a99e96fdec178b66e7b7a299bdef 100644 (file)
         <title>Using a Cross-Toolchain Tarball</title>
 
         <para>
-            If you want to simply install the cross-toolchain by hand, you can
+            If you want to simply install a cross-toolchain by hand, you can
             do so by running the toolchain installer.
+            The installer includes the pre-built cross-toolchain, the
+            <filename>runqemu</filename> script, and support files.
             If you use this method to install the cross-toolchain, you
             might still need to install the target sysroot by installing and
             extracting it separately.
         <para>
             Follow these steps:
             <orderedlist>
-                <listitem><para>Get the toolchain installer using one of the
+                <listitem><para>Get your toolchain installer using one of the
                     following methods:
                     <itemizedlist>
                         <listitem><para>Go to
                             <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>
                             and find the folder that matches your host
                             development system (i.e. <filename>i686</filename>
-                            for 32-bit machines or <filename>x86-64</filename>
+                            for 32-bit machines or <filename>x86_64</filename>
                             for 64-bit machines).</para>
                             <para>Go into that folder and download the toolchain
                             installer whose name includes the appropriate target
                             architecture.
+                            The toolchains provided by the Yocto Project
+                            are based off of the
+                            <filename>core-image-sato</filename> image and
+                            contain libraries appropriate for developing
+                            against that image.
                             For example, if your host development system is a
                             64-bit x86 system and you are going to use
                             your cross-toolchain for a 32-bit x86
                             target, go into the <filename>x86_64</filename>
                             folder and download the following installer:
                             <literallayout class='monospaced'>
-     poky-eglibc-x86_64-i586-toolchain-&DISTRO;.sh
+     poky-eglibc-x86_64-core-image-sato-i586.sh
                             </literallayout></para></listitem>
                         <listitem><para>Build your own toolchain installer.
                             For cases where you cannot use an installer
                     The example assumes the toolchain installer is located
                     in <filename>~/Downloads/</filename>.
                     <literallayout class='monospaced'>
-     $ ~/Downloads/poky-eglibc-x86_64-i586-toolchain-&DISTRO;.sh
+     $ ~/Downloads/poky-eglibc-x86_64-core-image-sato-i586.sh
                     </literallayout>
                     <note>
                         If you do not have write permissions for the directory
index a8e8c3a35adafcca6270c7f8b692ff885fe2646b..372a86efd0c356d5ae09aa05d8bdb83cfdd0b9b4 100644 (file)
 
         <section id='installing-the-toolchain'>
             <title>Installing the Toolchain</title>
+
             <para>
-                You can download a tarball installer, which includes the pre-built toolchain, the
-                <filename>runqemu</filename>
+                You can download a tarball installer, which includes the
+                pre-built toolchain, the <filename>runqemu</filename>
                 script, and support files from the appropriate directory under
                 <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>.
-                Toolchains are available for 32-bit and 64-bit x86 development systems from the
-                <filename>i686</filename> and <filename>x86_64</filename> directories, respectively.
-                Each type of development system supports five target architectures.
-                The names of the tarball installer scripts are such that a string representing the
-                host system appears first in the filename and then is immediately followed by a
-                string representing the target architecture.
+                Toolchains are available for 32-bit and 64-bit x86 development
+                systems from the <filename>i686</filename> and
+                <filename>x86_64</filename> directories, respectively.
+                The toolchains the Yocto Project provides are based off the
+                <filename>core-image-sato</filename> image and contain
+                libraries appropriate for developing against that image.
+                Each type of development system supports five or more target
+                architectures.
+            </para>
+
+            <para>
+                The names of the tarball installer scripts are such that a
+                string representing the host system appears first in the
+                filename and then is immediately followed by a string
+                that represents the target architecture.
             </para>
 
             <literallayout class='monospaced'>
-     poky-eglibc-&lt;<emphasis>host_system</emphasis>&gt;-&lt;<emphasis>arch</emphasis>&gt;-toolchain-gmae-&lt;<emphasis>release</emphasis>&gt;.sh
+     poky-eglibc-&lt;<emphasis>host_system</emphasis>&gt;-&lt;<emphasis>image_type</emphasis>&gt;-&lt;<emphasis>arch</emphasis>&gt;.sh
 
      Where:
          &lt;<emphasis>host_system</emphasis>&gt; is a string representing your development system:
                 i686 or x86_64.
 
-         &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
-                i586, x86_64, powerpc, mips, or arm.
+         &lt;<emphasis>image_type</emphasis>&gt; is a string representing the image you wish to
+                develop a Software Development Toolkit (SDK) for use against.
+                The Yocto Project builds toolchain installers using the
+                following BitBake command:
+
+                    bitbake core-image-sato -c do_populatesdk core-image-sato
 
-         &lt;<emphasis>release</emphasis>&gt; is the version of Yocto Project.
+         &lt;<emphasis>arch</emphasis>&gt; is a string representing the tuned target architecture:
+
+                i586, x86_64, powerpc, mips, armv7a or armv5te
             </literallayout>
 
             <para>
-                For example, the following toolchain installer is for a 64-bit development
-                host system and a 32-bit target architecture:
+                For example, the following toolchain installer is for a 64-bit
+                development host system and a i586-tuned target architecture
+                based off the SDK for <filename>core-image-sato</filename>:
+                <literallayout class='monospaced'>
+     poky-eglibc-x86_64-core-image-sato-i586.sh
+                </literallayout>
             </para>
 
-            <literallayout class='monospaced'>
-     poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh
-            </literallayout>
-
             <para>
-                Toolchains are self-contained and by default are installed into <filename>/opt/poky</filename>.
-                However, when you run the toolchain installer, you can choose an installation directory.
+                Toolchains are self-contained and by default are installed into
+                <filename>/opt/poky</filename>.
+                However, when you run the toolchain installer, you can choose an
+                installation directory.
             </para>
 
             <para>
 
             <para>
                 <literallayout class='monospaced'>
-     $ ~/Downloads/poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh
+     $ ~/Downloads/poky-eglibc-x86_64-core-image-sato-i586.sh
                 </literallayout>
             </para>