summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-10-22 17:28:05 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-10-22 23:03:16 (GMT)
commita4266b454cad4cab43de4c6fc823ff2c4e53e5c9 (patch)
treeb633c034053e71259731f8b013dc8a37942fbe6e
parentb1c27ead60765c5ae66257e34ed3f80b8c68e9ed (diff)
downloadpoky-a4266b454cad4cab43de4c6fc823ff2c4e53e5c9.tar.gz
documentation: adt-manual - final edits before 1.3 lockdown.
Made some minor edits to the book before locking down the files for 1.3. (From yocto-docs rev: 2b941103585a31b5dbcb65b784cc3381467ed697) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/adt-manual/adt-command.xml6
-rw-r--r--documentation/adt-manual/adt-intro.xml10
-rw-r--r--documentation/adt-manual/adt-package.xml2
-rw-r--r--documentation/adt-manual/adt-prepare.xml38
4 files changed, 30 insertions, 26 deletions
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
index 074e51c..4000c92 100644
--- a/documentation/adt-manual/adt-command.xml
+++ b/documentation/adt-manual/adt-command.xml
@@ -8,9 +8,9 @@
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 <filename>/opt/poky</filename>,
11 which is outside of the build directory 11 which is outside of the
12 (see the section "<link linkend='using-an-existing-toolchain-tarball'>Using an Existing 12 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
13 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
15 initializes a suitable cross-toolchain development environment. 15 initializes a suitable cross-toolchain development environment.
16 During the setup, locations for the compiler, QEMU scripts, QEMU binary, 16 During the setup, locations for the compiler, QEMU scripts, QEMU binary,
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml
index c83880b..d8527b3 100644
--- a/documentation/adt-manual/adt-intro.xml
+++ b/documentation/adt-manual/adt-intro.xml
@@ -55,7 +55,9 @@
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, a toolchain installer 57 This toolchain is created either by running the ADT Installer script, a toolchain installer
58 script, or through a build directory that is based on your metadata 58 script, or through a
59 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> that
60 is based on your metadata
59 configuration or extension for your targeted device. 61 configuration or extension for your targeted device.
60 The cross-toolchain works with a matching target sysroot. 62 The cross-toolchain works with a matching target sysroot.
61 </para> 63 </para>
@@ -111,7 +113,9 @@
111 <listitem><para>If you use the ADT Installer script to install ADT, you can 113 <listitem><para>If you use the ADT Installer script to install ADT, you can
112 specify whether or not to install QEMU.</para></listitem> 114 specify whether or not to install QEMU.</para></listitem>
113 <listitem><para>If you have downloaded a Yocto Project release and unpacked 115 <listitem><para>If you have downloaded a Yocto Project release and unpacked
114 it to create a source directory and you have sourced 116 it to create a
117 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> and
118 you have sourced
115 the environment setup script, QEMU is installed and automatically 119 the environment setup script, QEMU is installed and automatically
116 available.</para></listitem> 120 available.</para></listitem>
117 <listitem><para>If you have installed the cross-toolchain 121 <listitem><para>If you have installed the cross-toolchain
@@ -139,7 +143,7 @@
139 <listitem><para><emphasis>PowerTOP:</emphasis> Helps you determine what 143 <listitem><para><emphasis>PowerTOP:</emphasis> Helps you determine what
140 software is using the most power. 144 software is using the most power.
141 You can find out more about PowerTOP at 145 You can find out more about PowerTOP at
142 <ulink url='http://www.linuxpowertop.org/'></ulink>.</para></listitem> 146 <ulink url='https://01.org/powertop/'></ulink>.</para></listitem>
143 <listitem><para><emphasis>OProfile:</emphasis> A system-wide profiler for Linux 147 <listitem><para><emphasis>OProfile:</emphasis> A system-wide profiler for Linux
144 systems that is capable of profiling all running code at low overhead. 148 systems that is capable of profiling all running code at low overhead.
145 You can find out more about OProfile at 149 You can find out more about OProfile at
diff --git a/documentation/adt-manual/adt-package.xml b/documentation/adt-manual/adt-package.xml
index c55c10d..da8d10f 100644
--- a/documentation/adt-manual/adt-package.xml
+++ b/documentation/adt-manual/adt-package.xml
@@ -78,7 +78,7 @@
78 78
79 <para> 79 <para>
80 Next, source the environment setup script found in the 80 Next, source the environment setup script found in the
81 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 81 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
82 Follow that by setting up the installation destination to point to your 82 Follow that by setting up the installation destination to point to your
83 sysroot as <filename>&lt;sysroot_dir&gt;</filename>. 83 sysroot as <filename>&lt;sysroot_dir&gt;</filename>.
84 Finally, have an OPKG configuration file <filename>&lt;conf_file&gt;</filename> 84 Finally, have an OPKG configuration file <filename>&lt;conf_file&gt;</filename>
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index d660480..2e57e0c 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -52,7 +52,7 @@
52 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>
53 <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>
54 If you already have a 54 If you already have a
55 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>, 55 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
56 you can build the cross-toolchain within the directory. 56 you can build the cross-toolchain within the directory.
57 However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you 57 However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you
58 do not get any of the other benefits without taking separate steps.</para></listitem> 58 do not get any of the other benefits without taking separate steps.</para></listitem>
@@ -77,21 +77,21 @@
77 at 77 at
78 <ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>. 78 <ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>.
79 Or, you can use BitBake to generate the tarball inside the existing 79 Or, you can use BitBake to generate the tarball inside the existing
80 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 80 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
81 </para> 81 </para>
82 82
83 <para> 83 <para>
84 If you use BitBake to generate the ADT Installer tarball, you must 84 If you use BitBake to generate the ADT Installer tarball, you must
85 <filename>source</filename> the environment setup script 85 <filename>source</filename> the environment setup script
86 (<filename>&OE_INIT_FILE;</filename>) located 86 (<filename>&OE_INIT_FILE;</filename>) located
87 in the source directory before running the <filename>bitbake</filename> 87 in the Source Directory before running the <filename>bitbake</filename>
88 command that creates the tarball. 88 command that creates the tarball.
89 </para> 89 </para>
90 90
91 <para> 91 <para>
92 The following example commands download the Poky tarball, set up the 92 The following example commands download the Poky tarball, set up the
93 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>, 93 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
94 set up the environment while also creating the default build directory, 94 set up the environment while also creating the default Build Directory,
95 and run the <filename>bitbake</filename> command that results in the tarball 95 and run the <filename>bitbake</filename> command that results in the tarball
96 <filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>: 96 <filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>:
97 <literallayout class='monospaced'> 97 <literallayout class='monospaced'>
@@ -251,7 +251,7 @@
251 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh 251 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh
252 </literallayout> 252 </literallayout>
253 <note><para>As an alternative to steps one and two, you can build the toolchain installer 253 <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>. 254 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> 255 If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename>
256 command. 256 command.
257 The resulting installation script when run will support such development. 257 The resulting installation script when run will support such development.
@@ -259,10 +259,10 @@
259 you can generate the toolchain installer using 259 you can generate the toolchain installer using
260 <filename>bitbake meta-toolchain</filename>.</para> 260 <filename>bitbake meta-toolchain</filename>.</para>
261 <para>Use the appropriate <filename>bitbake</filename> command only after you have 261 <para>Use the appropriate <filename>bitbake</filename> command only after you have
262 sourced the <filename>oe-build-init-env</filename> script located in the source 262 sourced the <filename>&OE_INIT_PATH;</filename> script located in the Source
263 directory. 263 Directory.
264 When the <filename>bitbake</filename> command completes, the toolchain installer will 264 When the <filename>bitbake</filename> command completes, the toolchain installer will
265 be in <filename>tmp/deploy/sdk</filename> in the build directory. 265 be in <filename>tmp/deploy/sdk</filename> in the Build Directory.
266 </para></note> 266 </para></note>
267 </para></listitem> 267 </para></listitem>
268 <listitem><para>Once you have the installer, run it to install the toolchain. 268 <listitem><para>Once you have the installer, run it to install the toolchain.
@@ -292,7 +292,7 @@
292 <para> 292 <para>
293 A final way of making the cross-toolchain available is to use BitBake 293 A final way of making the cross-toolchain available is to use BitBake
294 to generate the toolchain within an existing 294 to generate the toolchain within an existing
295 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>. 295 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
296 This method does not install the toolchain into the 296 This method does not install the toolchain into the
297 <filename>/opt</filename> directory. 297 <filename>/opt</filename> directory.
298 As with the previous method, if you need to install the target sysroot, you must 298 As with the previous method, if you need to install the target sysroot, you must
@@ -300,20 +300,20 @@
300 </para> 300 </para>
301 301
302 <para> 302 <para>
303 Follow these steps to generate the toolchain into the build directory: 303 Follow these steps to generate the toolchain into the Build Directory:
304 <orderedlist> 304 <orderedlist>
305 <listitem><para>Source the environment setup script 305 <listitem><para>Source the environment setup script
306 <filename>&OE_INIT_FILE;</filename> located in the 306 <filename>&OE_INIT_FILE;</filename> located in the
307 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. 307 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
308 </para></listitem> 308 </para></listitem>
309 <listitem><para>At this point, you should be sure that the 309 <listitem><para>At this point, you should be sure that the
310 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> variable 310 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> variable
311 in the <filename>local.conf</filename> file found in the 311 in the <filename>local.conf</filename> file found in the
312 <filename>conf</filename> directory of the build directory 312 <filename>conf</filename> directory of the Build Directory
313 is set for the target architecture. 313 is set for the target architecture.
314 Comments within the <filename>local.conf</filename> file list the values you 314 Comments within the <filename>local.conf</filename> file list the values you
315 can use for the <filename>MACHINE</filename> variable. 315 can use for the <filename>MACHINE</filename> variable.
316 <note>You can populate the build directory with the cross-toolchains for more 316 <note>You can populate the Build Directory with the cross-toolchains for more
317 than a single architecture. 317 than a single architecture.
318 You just need to edit the <filename>MACHINE</filename> variable in the 318 You just need to edit the <filename>MACHINE</filename> variable in the
319 <filename>local.conf</filename> file and re-run the BitBake 319 <filename>local.conf</filename> file and re-run the BitBake
@@ -327,9 +327,9 @@
327 after checking or editing the <filename>local.conf</filename> but without 327 after checking or editing the <filename>local.conf</filename> but without
328 changing out of your working directory.</note> 328 changing out of your working directory.</note>
329 Once the <filename>bitbake</filename> command finishes, 329 Once the <filename>bitbake</filename> command finishes,
330 the cross-toolchain is generated and populated within the build directory. 330 the cross-toolchain is generated and populated within the Build Directory.
331 You will notice environment setup files for the cross-toolchain in the 331 You will notice environment setup files for the cross-toolchain in the
332 build directory in the <filename>tmp</filename> directory. 332 Build Directory in the <filename>tmp</filename> directory.
333 Setup script filenames contain the strings <filename>environment-setup</filename>.</para> 333 Setup script filenames contain the strings <filename>environment-setup</filename>.</para>
334 <para>Be aware that when you use this method to install the toolchain you still need 334 <para>Be aware that when you use this method to install the toolchain you still need
335 to separately extract and install the sysroot filesystem. 335 to separately extract and install the sysroot filesystem.
@@ -351,9 +351,9 @@
351 then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename> 351 then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename>
352 directory. 352 directory.
353 If you installed the toolchain in the 353 If you installed the toolchain in the
354 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>, 354 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
355 you can find the environment setup 355 you can find the environment setup
356 script for the toolchain in the build directory's <filename>tmp</filename> directory. 356 script for the toolchain in the Build Directory's <filename>tmp</filename> directory.
357 </para> 357 </para>
358 358
359 <para> 359 <para>
@@ -426,7 +426,7 @@
426 you can do so one of two ways: 426 you can do so one of two ways:
427 <itemizedlist> 427 <itemizedlist>
428 <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in 428 <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in
429 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink> 429 the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
430 and then rebuild the image. 430 and then rebuild the image.
431 With this method, you need to modify the 431 With this method, you need to modify the
432 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink> 432 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>