summaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-03-01 20:22:44 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-03-02 12:57:21 (GMT)
commitd8e26e2b9f8b622d0cef3d3d1392dd0917343ded (patch)
tree7950c822e1a00ae43cf3e5e7230df8b5c9f3f743 /documentation/adt-manual
parentb7397f3559b2ca86943594122b3cf008e50f80a2 (diff)
downloadpoky-d8e26e2b9f8b622d0cef3d3d1392dd0917343ded.tar.gz
adt-manual: Updates to de-emphasize opt/poky and include sysroot
Fixes YOCTO #2645 Several changes to make sure that the default toolchain directory (opt/poky) is understood as the default. I changed some wordings to call it out as the default. Some examples I left alone as they used /opt/poky but I clearly indicated that the example was using the default installation directory. I also updated the note in the manual that talks about alternatively building the toolchain installer. Previously, it mentioned two methods. I have added the third and most significant method that uses bitbake image -c populate_sdk. This method creates a toolchain installer that contains the matching sysroot. (From yocto-docs rev: 2e5eeb7e0c9aa448149cc369572b31dbc1603e28) 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.xml13
-rw-r--r--documentation/adt-manual/adt-prepare.xml117
2 files changed, 80 insertions, 50 deletions
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
index e5b2cdb..18bfb8a 100644
--- a/documentation/adt-manual/adt-command.xml
+++ b/documentation/adt-manual/adt-command.xml
@@ -7,8 +7,8 @@
7 7
8 <para> 8 <para>
9 Recall that earlier the manual discussed how to use an existing toolchain 9 Recall that earlier the manual discussed how to use an existing toolchain
10 tarball that had been installed into <filename>/opt/poky</filename>, 10 tarball that had been installed into the default installation
11 which is outside of the 11 directory, <filename>/opt/poky</filename>, which is outside of the
12 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> 12 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
13 (see the section "<link linkend='using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball)</link>". 13 (see the section "<link linkend='using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball)</link>".
14 And, that sourcing your architecture-specific environment setup script 14 And, that sourcing your architecture-specific environment setup script
@@ -81,13 +81,15 @@
81 <listitem><para><emphasis>Source the cross-toolchain 81 <listitem><para><emphasis>Source the cross-toolchain
82 environment setup file:</emphasis> 82 environment setup file:</emphasis>
83 Installation of the cross-toolchain creates a cross-toolchain 83 Installation of the cross-toolchain creates a cross-toolchain
84 environment setup script in <filename>/opt/poky/&lt;release&gt;</filename>. 84 environment setup script in the directory that the ADT
85 was installed.
85 Before you can use the tools to develop your project, you must 86 Before you can use the tools to develop your project, you must
86 source this setup script. 87 source this setup script.
87 The script begins with the string "environment-setup" and contains 88 The script begins with the string "environment-setup" and contains
88 the machine architecture, which is followed by the string 89 the machine architecture, which is followed by the string
89 "poky-linux". 90 "poky-linux".
90 Here is an example for an environment setup using the 91 Here is an example that sources a script from the
92 default ADT installation directory that uses the
91 32-bit Intel x86 Architecture and using the 93 32-bit Intel x86 Architecture and using the
92 &DISTRO_NAME; Yocto Project release: 94 &DISTRO_NAME; Yocto Project release:
93 <literallayout class='monospaced'> 95 <literallayout class='monospaced'>
@@ -158,8 +160,7 @@
158 For an Autotools-based project, you can use the cross-toolchain by just 160 For an Autotools-based project, you can use the cross-toolchain by just
159 passing the appropriate host option to <filename>configure.sh</filename>. 161 passing the appropriate host option to <filename>configure.sh</filename>.
160 The host option you use is derived from the name of the environment setup 162 The host option you use is derived from the name of the environment setup
161 script in <filename>/opt/poky</filename> resulting from installation of the 163 script found in the directory in which you installed the cross-toolchain.
162 cross-toolchain tarball.
163 For example, the host option for an ARM-based target that uses the GNU EABI 164 For example, the host option for an ARM-based target that uses the GNU EABI
164 is <filename>armv5te-poky-linux-gnueabi</filename>. 165 is <filename>armv5te-poky-linux-gnueabi</filename>.
165 You will notice that the name of the script is 166 You will notice that the name of the script is
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index fa191da..4df10bf 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -198,24 +198,29 @@
198 $ cd ~/adt-installer 198 $ cd ~/adt-installer
199 $ ./adt_installer 199 $ ./adt_installer
200 </literallayout> 200 </literallayout>
201 Once the installer begins to run, you are asked to enter the location for 201 Once the installer begins to run, you are asked to enter the
202 cross-toolchain installation. 202 location for cross-toolchain installation.
203 The default location is <filename>/opt/poky/&lt;release&gt;</filename>. 203 The default location is
204 After selecting the location, you are prompted to run in 204 <filename>/opt/poky/&lt;release&gt;</filename>.
205 interactive or silent mode. 205 After either accepting the default location or selecting your
206 If you want to closely monitor the installation, choose “I” for interactive 206 own location, you are prompted to run the installation script
207 mode rather than “S” for silent mode. 207 interactively or in silent mode.
208 If you want to closely monitor the installation,
209 choose “I” for interactive mode rather than “S” for silent mode.
208 Follow the prompts from the script to complete the installation. 210 Follow the prompts from the script to complete the installation.
209 </para> 211 </para>
210 212
211 <para> 213 <para>
212 Once the installation completes, the ADT, which includes the cross-toolchain, is installed. 214 Once the installation completes, the ADT, which includes the
213 You will notice environment setup files for the cross-toolchain in 215 cross-toolchain, is installed in the selected installation
214 <filename>&YOCTO_ADTPATH_DIR;</filename>, 216 directory.
215 and image tarballs in the <filename>adt-installer</filename> 217 You will notice environment setup files for the cross-toolchain
216 directory according to your installer configurations, and the target sysroot located 218 in the installation directory, and image tarballs in the
217 according to the <filename>YOCTOADT_TARGET_SYSROOT_LOC_&lt;arch&gt;</filename> variable 219 <filename>adt-installer</filename> directory according to your
218 also in your configuration file. 220 installer configurations, and the target sysroot located
221 according to the
222 <filename>YOCTOADT_TARGET_SYSROOT_LOC_&lt;arch&gt;</filename>
223 variable also in your configuration file.
219 </para> 224 </para>
220 </section> 225 </section>
221 </section> 226 </section>
@@ -224,11 +229,12 @@
224 <title>Using a Cross-Toolchain Tarball</title> 229 <title>Using a Cross-Toolchain Tarball</title>
225 230
226 <para> 231 <para>
227 If you want to simply install the cross-toolchain by hand, you can do so by running the 232 If you want to simply install the cross-toolchain by hand, you can
228 toolchain installer. 233 do so by running the toolchain installer.
229 If you use this method to install the cross-toolchain and you still need to install the target 234 If you use this method to install the cross-toolchain and you
230 sysroot, you will have to extract and install sysroot separately. 235 might still need to install the target sysroot by installing and
231 For information on how to do this, see the 236 extracting it separately.
237 For information on how to install the sysroot, see the
232 "<link linkend='extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" section. 238 "<link linkend='extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" section.
233 </para> 239 </para>
234 240
@@ -248,29 +254,50 @@
248 <literallayout class='monospaced'> 254 <literallayout class='monospaced'>
249 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh 255 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh
250 </literallayout> 256 </literallayout>
251 <note><para>As an alternative to steps one and two, you can build the toolchain installer 257 <note><para>As an alternative to steps one and two, you can
252 if you have a <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 258 build the toolchain installer if you have a
253 If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename> 259 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
260 If you need GMAE, you should use the
261 <filename>bitbake meta-toolchain-gmae</filename>
254 command. 262 command.
255 The resulting installation script when run will support such development. 263 Running the resulting installation script will support
256 However, if you are not concerned with GMAE, 264 such development.
257 you can generate the toolchain installer using 265 If you are not concerned with GMAE, you can generate
258 <filename>bitbake meta-toolchain</filename>.</para> 266 the toolchain installer using
259 <para>Use the appropriate <filename>bitbake</filename> command only after you have 267 <filename>bitbake meta-toolchain</filename>.
260 sourced the <filename>&OE_INIT_PATH;</filename> script located in the Source 268 Either of these methods requires you to still
261 Directory and you have made sure your <filename>conf/local.conf</filename> 269 install the target sysroot by installing and
262 variables are correct. 270 extracting it separately.
271 For information on how to install the sysroot, see the
272 "<link linkend='extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" section.
273 </para>
274 <para>A final method of building the toolchain installer
275 exists that has significant advantages over the previous
276 two methods.
277 This method results in a toolchain installer that
278 contains the sysroot that matches your target root
279 filesystem.
280 To build this installer, use the
281 <filename>bitbake image -c populate_sdk</filename>
282 command.</para>
283 <para>Remember, before using any
284 <filename>bitbake</filename> command, you must source
285 the <filename>&OE_INIT_PATH;</filename> script
286 located in the Source Directory and you must make sure
287 your <filename>conf/local.conf</filename> variables are
288 correct.
263 In particular, you need to be sure the 289 In particular, you need to be sure the
264 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> 290 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
265 variable matches the architecture for which you are building and that the 291 variable matches the architecture for which you are
266 <filename>SDKMACHINE</filename> variable is correctly set if you are building 292 building and that the <filename>SDKMACHINE</filename>
267 a toolchain for an architecture that differs from your current 293 variable is correctly set if you are building
268 development host machine.</para> 294 a toolchain for an architecture that differs from your
269 <para>When the <filename>bitbake</filename> command completes, the 295 current development host machine.</para>
270 toolchain installer will be in <filename>tmp/deploy/sdk</filename> in the 296 <para>When the <filename>bitbake</filename> command
271 Build Directory. 297 completes, the toolchain installer will be in
272 </para></note> 298 <filename>tmp/deploy/sdk</filename> in the Build
273 </para></listitem> 299 Directory.</para>
300 </note></para></listitem>
274 <listitem><para>Once you have the installer, run it to install the toolchain. 301 <listitem><para>Once you have the installer, run it to install the toolchain.
275 You must change the permissions on the toolchain installer 302 You must change the permissions on the toolchain installer
276 script so that it is executable.</para> 303 script so that it is executable.</para>
@@ -354,7 +381,8 @@
354 Before you can develop using the cross-toolchain, you need to set up the 381 Before you can develop using the cross-toolchain, you need to set up the
355 cross-development environment by sourcing the toolchain's environment setup script. 382 cross-development environment by sourcing the toolchain's environment setup script.
356 If you used the ADT Installer or hand-installed cross-toolchain, 383 If you used the ADT Installer or hand-installed cross-toolchain,
357 then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename> 384 then you can find this script in the directory you chose for installation.
385 The default installation directory is the <filename>&YOCTO_ADTPATH_DIR;</filename>
358 directory. 386 directory.
359 If you installed the toolchain in the 387 If you installed the toolchain in the
360 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, 388 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
@@ -367,8 +395,9 @@
367 which you are developing. 395 which you are developing.
368 Environment setup scripts begin with the string “<filename>environment-setup</filename>” 396 Environment setup scripts begin with the string “<filename>environment-setup</filename>”
369 and include as part of their name the architecture. 397 and include as part of their name the architecture.
370 For example, the toolchain environment setup script for a 64-bit IA-based architecture would 398 For example, the toolchain environment setup script for a 64-bit
371 be the following: 399 IA-based architecture installed in the default installation directory
400 would be the following:
372 <literallayout class='monospaced'> 401 <literallayout class='monospaced'>
373 &YOCTO_ADTPATH_DIR;/environment-setup-x86_64-poky-linux 402 &YOCTO_ADTPATH_DIR;/environment-setup-x86_64-poky-linux
374 </literallayout> 403 </literallayout>
@@ -497,9 +526,9 @@
497 The example extracts the root filesystem into the <filename>$HOME/qemux86-sato</filename> 526 The example extracts the root filesystem into the <filename>$HOME/qemux86-sato</filename>
498 directory: 527 directory:
499 <literallayout class='monospaced'> 528 <literallayout class='monospaced'>
500 $ source $HOME/poky/build/tmp/environment-setup-i586-poky-linux 529 $ source $HOME/toolchain_dir/environment-setup-i586-poky-linux
501 $ runqemu-extract-sdk \ 530 $ runqemu-extract-sdk \
502 tmp/deploy/images/core-image-sato-sdk-qemux86-2011091411831.rootfs.tar.bz2 \ 531 ~Downloads/core-image-sato-sdk-qemux86-2011091411831.rootfs.tar.bz2 \
503 $HOME/qemux86-sato 532 $HOME/qemux86-sato
504 </literallayout> 533 </literallayout>
505 In this case, you could now point to the target sysroot at 534 In this case, you could now point to the target sysroot at