summaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-09-13 21:01:58 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-09-14 08:50:52 (GMT)
commitc4a923bcb0194c05b14d40be7ad4ecd193eb7a69 (patch)
tree6bec21f8000bfb08a8405124b78cdbdc1c22b0b6 /documentation/adt-manual
parent4c90692716feb5e52f7859e2013b02f6f6703062 (diff)
downloadpoky-c4a923bcb0194c05b14d40be7ad4ecd193eb7a69.tar.gz
documentation: Toolchain corrections from tarball to .sh file
For 1.3 there is not longer a toolchain tarball. Instead, there is a wrapper script that lets you install the tarball. This fundamental usage model change caused several ripples throughout the documentation set. I have changed wordings and examples to reflect the new paradigm. (From yocto-docs rev: afb2069daa91e04c0f78ba425a6b184cb820d888) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/adt-manual')
-rw-r--r--documentation/adt-manual/adt-command.xml2
-rw-r--r--documentation/adt-manual/adt-intro.xml4
-rw-r--r--documentation/adt-manual/adt-prepare.xml44
3 files changed, 30 insertions, 20 deletions
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
index f5ed906..074e51c 100644
--- a/documentation/adt-manual/adt-command.xml
+++ b/documentation/adt-manual/adt-command.xml
@@ -32,7 +32,7 @@
32 For an Autotools-based project, you can use the cross-toolchain by just 32 For an Autotools-based project, you can use the cross-toolchain by just
33 passing the appropriate host option to <filename>configure.sh</filename>. 33 passing the appropriate host option to <filename>configure.sh</filename>.
34 The host option you use is derived from the name of the environment setup 34 The host option you use is derived from the name of the environment setup
35 script in <filename>/opt/poky</filename> resulting from unpacking the 35 script in <filename>/opt/poky</filename> resulting from installation of the
36 cross-toolchain tarball. 36 cross-toolchain tarball.
37 For example, the host option for an ARM-based target that uses the GNU EABI 37 For example, the host option for an ARM-based target that uses the GNU EABI
38 is <filename>armv5te-poky-linux-gnueabi</filename>. 38 is <filename>armv5te-poky-linux-gnueabi</filename>.
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml
index 47e4c36..c83880b 100644
--- a/documentation/adt-manual/adt-intro.xml
+++ b/documentation/adt-manual/adt-intro.xml
@@ -54,8 +54,8 @@
54 <para> 54 <para>
55 The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger 55 The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger
56 that are used to develop user-space applications for targeted hardware. 56 that are used to develop user-space applications for targeted hardware.
57 This toolchain is created either by running the ADT Installer script or 57 This toolchain is created either by running the ADT Installer script, a toolchain installer
58 through a build directory that is based on your metadata 58 script, or through a build directory that is based on your metadata
59 configuration or extension for your targeted device. 59 configuration or extension for your targeted device.
60 The cross-toolchain works with a matching target sysroot. 60 The cross-toolchain works with a matching target sysroot.
61 </para> 61 </para>
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index e512c89..0b74505 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -29,8 +29,7 @@
29 <note> 29 <note>
30 <para>Avoid mixing installation methods when installing toolchains for different architectures. 30 <para>Avoid mixing installation methods when installing toolchains for different architectures.
31 For example, avoid using the ADT Installer to install some toolchains and then hand-installing 31 For example, avoid using the ADT Installer to install some toolchains and then hand-installing
32 cross-development toolchains from downloaded tarballs to install toolchains 32 cross-development toolchains by running the toolchain installer for different architectures.
33 for different architectures.
34 Mixing installation methods can result in situations where the ADT Installer becomes 33 Mixing installation methods can result in situations where the ADT Installer becomes
35 unreliable and might not install the toolchain.</para> 34 unreliable and might not install the toolchain.</para>
36 <para>If you must mix installation methods, you might avoid problems by deleting 35 <para>If you must mix installation methods, you might avoid problems by deleting
@@ -46,9 +45,9 @@
46 For example, you can configure the installation to install the QEMU emulator 45 For example, you can configure the installation to install the QEMU emulator
47 and the user-space NFS, specify which root filesystem profiles to download, 46 and the user-space NFS, specify which root filesystem profiles to download,
48 and define the target sysroot location.</para></listitem> 47 and define the target sysroot location.</para></listitem>
49 <listitem><para><emphasis>Use an Existing Toolchain Tarball:</emphasis> 48 <listitem><para><emphasis>Use an Existing Toolchain:</emphasis>
50 Using this method, you select and download an architecture-specific 49 Using this method, you select and download an architecture-specific
51 toolchain tarball and then hand-install the toolchain. 50 toolchain installer and then run the script to hand-install the toolchain.
52 If you use this method, you just get the cross-toolchain and QEMU - you do not 51 If you use this method, you just get the cross-toolchain and QEMU - you do not
53 get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem> 52 get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem>
54 <listitem><para><emphasis>Use the Toolchain from within the Build Directory:</emphasis> 53 <listitem><para><emphasis>Use the Toolchain from within the Build Directory:</emphasis>
@@ -226,8 +225,8 @@
226 <title>Using a Cross-Toolchain Tarball</title> 225 <title>Using a Cross-Toolchain Tarball</title>
227 226
228 <para> 227 <para>
229 If you want to simply install the cross-toolchain by hand, you can do so by using an existing 228 If you want to simply install the cross-toolchain by hand, you can do so by running the
230 cross-toolchain tarball. 229 toolchain installer.
231 If you use this method to install the cross-toolchain and you still need to install the target 230 If you use this method to install the cross-toolchain and you still need to install the target
232 sysroot, you will have to extract and install sysroot separately. 231 sysroot, you will have to extract and install sysroot separately.
233 For information on how to do this, see the 232 For information on how to do this, see the
@@ -242,30 +241,41 @@
242 and find the folder that matches your host development system 241 and find the folder that matches your host development system
243 (i.e. <filename>i686</filename> for 32-bit machines or 242 (i.e. <filename>i686</filename> for 32-bit machines or
244 <filename>x86-64</filename> for 64-bit machines).</para></listitem> 243 <filename>x86-64</filename> for 64-bit machines).</para></listitem>
245 <listitem><para>Go into that folder and download the toolchain tarball whose name 244 <listitem><para>Go into that folder and download the toolchain installer whose name
246 includes the appropriate target architecture. 245 includes the appropriate target architecture.
247 For example, if your host development system is an Intel-based 64-bit system and 246 For example, if your host development system is an Intel-based 64-bit system and
248 you are going to use your cross-toolchain for an Intel-based 32-bit target, go into the 247 you are going to use your cross-toolchain for an Intel-based 32-bit target, go into the
249 <filename>x86_64</filename> folder and download the following tarball: 248 <filename>x86_64</filename> folder and download the following installer:
250 <literallayout class='monospaced'> 249 <literallayout class='monospaced'>
251 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 250 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh
252 </literallayout> 251 </literallayout>
253 <note><para>As an alternative to steps one and two, you can build the toolchain tarball 252 <note><para>As an alternative to steps one and two, you can build the toolchain installer
254 if you have a <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 253 if you have a <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
255 If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename> 254 If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename>
256 command. 255 command.
257 The resulting tarball will support such development. 256 The resulting installation script when run will support such development.
258 However, if you are not concerned with GMAE, 257 However, if you are not concerned with GMAE,
259 you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para> 258 you can generate the toolchain installer using
259 <filename>bitbake meta-toolchain</filename>.</para>
260 <para>Use the appropriate <filename>bitbake</filename> command only after you have 260 <para>Use the appropriate <filename>bitbake</filename> command only after you have
261 sourced the <filename>oe-build-init-env</filename> script located in the source 261 sourced the <filename>oe-build-init-env</filename> script located in the source
262 directory. 262 directory.
263 When the <filename>bitbake</filename> command completes, the tarball will 263 When the <filename>bitbake</filename> command completes, the toolchain installer will
264 be in <filename>tmp/deploy/sdk</filename> in the build directory. 264 be in <filename>tmp/deploy/sdk</filename> in the build directory.
265 </para></note></para></listitem> 265 </para></note>
266 <listitem><para>Make sure you are in the root directory with root privileges and then expand 266 </para></listitem>
267 the tarball. 267 <listitem><para>Once you have the installer, run it to install the toolchain.
268 The tarball expands into <filename>&YOCTO_ADTPATH_DIR;</filename>. 268 The following command shows how to run the installer given a toolchain tarball
269 for a 64-bit development host system and a 32-bit target architecture.
270 The example assumes the toolchain installer is located in <filename>~/Downloads/</filename>.
271 <literallayout class='monospaced'>
272 $ ~/Downloads/poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh
273 </literallayout>
274 <note>
275 If you do not have write permissions for the directory into which you are installing
276 the toolchain, the toolchain installer notifies you and exits.
277 Be sure you have write permissions in the directory and run the installer again.
278 </note>
269 Once the tarball is expanded, the cross-toolchain is installed. 279 Once the tarball is expanded, the cross-toolchain is installed.
270 You will notice environment setup files for the cross-toolchain in the directory. 280 You will notice environment setup files for the cross-toolchain in the directory.
271 </para></listitem> 281 </para></listitem>