summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-06-28 15:02:25 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-06-29 13:31:02 +0100
commit347424e558a8d6db1c82f3bb1dbbf7b7b574566b (patch)
treebbbd956d7e1e39e7aeb5695418b376917d28e0fa /documentation
parent7a4cc0e8845fbee6a9066e8d83a90bcb8acc96be (diff)
downloadpoky-347424e558a8d6db1c82f3bb1dbbf7b7b574566b.tar.gz
documentation/adt-manual: Adjustments to Yocto Project term
Changes throughout the manual that either eliminate or change many of the "Yocto Project" strings. The file structure for the meta data is now called "source directory." The build directory is referred as just that - "build directory." Any where the build system is referred to it is called the "OpenEmbedded build system." (From yocto-docs rev: 1210c19f90d4a52042fec12657212ae3e58e13d6) 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-command.xml4
-rw-r--r--documentation/adt-manual/adt-eclipse.xml31
-rw-r--r--documentation/adt-manual/adt-intro.xml12
-rw-r--r--documentation/adt-manual/adt-package.xml6
-rw-r--r--documentation/adt-manual/adt-prepare.xml54
5 files changed, 53 insertions, 54 deletions
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
index 43bd08b74f..f5ed906962 100644
--- a/documentation/adt-manual/adt-command.xml
+++ b/documentation/adt-manual/adt-command.xml
@@ -8,7 +8,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 <filename>/opt/poky</filename>,
11 which is outside of the Yocto Project build tree 11 which is outside of the build directory
12 (see the section "<link linkend='using-an-existing-toolchain-tarball'>Using an Existing 12 (see the section "<link linkend='using-an-existing-toolchain-tarball'>Using an Existing
13 Toolchain Tarball)</link>". 13 Toolchain Tarball)</link>".
14 And, that sourcing your architecture-specific environment setup script 14 And, that sourcing your architecture-specific environment setup script
@@ -21,7 +21,7 @@
21 for example, <filename>configure.sh</filename> can find pre-generated 21 for example, <filename>configure.sh</filename> can find pre-generated
22 test results for tests that need target hardware on which to run. 22 test results for tests that need target hardware on which to run.
23 These conditions allow you to easily use the toolchain outside of the 23 These conditions allow you to easily use the toolchain outside of the
24 Yocto Project build environment on both autotools-based projects and 24 OpenEmbedded build environment on both autotools-based projects and
25 Makefile-based projects. 25 Makefile-based projects.
26 </para> 26 </para>
27 27
diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml
index 44909b8f5e..4d400ad6df 100644
--- a/documentation/adt-manual/adt-eclipse.xml
+++ b/documentation/adt-manual/adt-eclipse.xml
@@ -7,9 +7,9 @@
7 7
8 <para> 8 <para>
9 The Eclipse IDE is a popular development environment and it fully supports 9 The Eclipse IDE is a popular development environment and it fully supports
10 development using Yocto Project. 10 development using the Yocto Project.
11 When you install and configure the Eclipse Yocto Project Plug-in into 11 When you install and configure the Eclipse Yocto Project Plug-in into
12 the Eclipse IDE, you maximize your Yocto Project design experience. 12 the Eclipse IDE, you maximize your Yocto Project experience.
13 Installing and configuring the Plug-in results in an environment that 13 Installing and configuring the Plug-in results in an environment that
14 has extensions specifically designed to let you more easily develop software. 14 has extensions specifically designed to let you more easily develop software.
15 These extensions allow for cross-compilation, deployment, and execution of 15 These extensions allow for cross-compilation, deployment, and execution of
@@ -21,7 +21,7 @@
21 </para> 21 </para>
22 <para> 22 <para>
23 This section describes how to install and configure the Eclipse IDE 23 This section describes how to install and configure the Eclipse IDE
24 Yocto Plug-in and how to use it to develop your Yocto Project. 24 Yocto Plug-in and how to use it to develop your application.
25 </para> 25 </para>
26 26
27<section id='setting-up-the-eclipse-ide'> 27<section id='setting-up-the-eclipse-ide'>
@@ -152,7 +152,7 @@
152 152
153 <para> 153 <para>
154 You can install the Eclipse Yocto Plug-in into the Eclipse IDE 154 You can install the Eclipse Yocto Plug-in into the Eclipse IDE
155 one of two ways: use the Yocto Project update site to install the pre-built plug-in, 155 one of two ways: use the Yocto Project's Eclipse Update site to install the pre-built plug-in,
156 or build and install the plug-in from the latest source code. 156 or build and install the plug-in from the latest source code.
157 If you don't want to permanently install the plug-in but just want to try it out 157 If you don't want to permanently install the plug-in but just want to try it out
158 within the Eclipse environment, you can import the plug-in project from the 158 within the Eclipse environment, you can import the plug-in project from the
@@ -320,10 +320,10 @@
320 <listitem><para><emphasis> 320 <listitem><para><emphasis>
321 <filename>Build System Derived Toolchain:</filename></emphasis> 321 <filename>Build System Derived Toolchain:</filename></emphasis>
322 Select this mode if the cross-toolchain has been installed and built 322 Select this mode if the cross-toolchain has been installed and built
323 as part of the Yocto Project build tree. 323 as part of the build directory.
324 When you select <filename>Build system derived toolchain</filename>, 324 When you select <filename>Build system derived toolchain</filename>,
325 you are using the toolchain bundled 325 you are using the toolchain bundled
326 inside the Yocto Project build tree. 326 inside the build directory.
327 </para></listitem> 327 </para></listitem>
328 </itemizedlist> 328 </itemizedlist>
329 </para></listitem> 329 </para></listitem>
@@ -342,11 +342,10 @@
342 However, doing so is discouraged.</note></para> 342 However, doing so is discouraged.</note></para>
343 <para>If you are using a system-derived toolchain, the path you provide 343 <para>If you are using a system-derived toolchain, the path you provide
344 for the <filename>Toolchain Root Location</filename> 344 for the <filename>Toolchain Root Location</filename>
345 field is the Yocto Project's build directory. 345 field is the build directory.
346 See section "<link linkend='using-the-toolchain-from-within-the-build-tree'>Using 346 See section "<link linkend='using-the-toolchain-from-within-the-build-tree'>Using
347 BitBake and the Yocto Project Build Tree</link>" for 347 BitBake and the build directory</link>" for
348 information on how to install the toolchain into the Yocto 348 information on how to install the toolchain into the build directory.</para></listitem>
349 Project build tree.</para></listitem>
350 <listitem><para><emphasis>Specify the Sysroot Location:</emphasis> 349 <listitem><para><emphasis>Specify the Sysroot Location:</emphasis>
351 This location is where the root filesystem for the 350 This location is where the root filesystem for the
352 target hardware is created on the development system by the ADT Installer. 351 target hardware is created on the development system by the ADT Installer.
@@ -380,7 +379,7 @@
380 and specify any custom options.</para> 379 and specify any custom options.</para>
381 <para>If you selected <filename>Build system derived toolchain</filename>, 380 <para>If you selected <filename>Build system derived toolchain</filename>,
382 the target kernel you built will be located in the 381 the target kernel you built will be located in the
383 Yocto Project build tree in <filename>tmp/deploy/images</filename> directory. 382 build directory in <filename>tmp/deploy/images</filename> directory.
384 If you selected <filename>Standalone pre-built toolchain</filename>, the 383 If you selected <filename>Standalone pre-built toolchain</filename>, the
385 pre-built image you downloaded is located 384 pre-built image you downloaded is located
386 in the directory you specified when you downloaded the image.</para> 385 in the directory you specified when you downloaded the image.</para>
@@ -433,7 +432,7 @@
433 <listitem><para>Double click <filename>C Project</filename> to create the project.</para></listitem> 432 <listitem><para>Double click <filename>C Project</filename> to create the project.</para></listitem>
434 <listitem><para>Expand <filename>Yocto Project ADT Project</filename>.</para></listitem> 433 <listitem><para>Expand <filename>Yocto Project ADT Project</filename>.</para></listitem>
435 <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>. 434 <listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>.
436 This is an Autotools-based project based on a Yocto Project template.</para></listitem> 435 This is an Autotools-based project based on a Yocto template.</para></listitem>
437 <listitem><para>Put a name in the <filename>Project name:</filename> field. 436 <listitem><para>Put a name in the <filename>Project name:</filename> field.
438 Do not use hyphens as part of the name.</para></listitem> 437 Do not use hyphens as part of the name.</para></listitem>
439 <listitem><para>Click <filename>Next</filename>.</para></listitem> 438 <listitem><para>Click <filename>Next</filename>.</para></listitem>
@@ -677,7 +676,7 @@
677 <filename>&lt;project_location&gt;/&lt;project_name&gt;</filename>. 676 <filename>&lt;project_location&gt;/&lt;project_name&gt;</filename>.
678 If that directory does not exist, you need to check 677 If that directory does not exist, you need to check
679 the "Clone from Yocto Git Repository" box, which would execute a 678 the "Clone from Yocto Git Repository" box, which would execute a
680 <filename>git clone</filename> command to get the Yocto project's metadata files. 679 <filename>git clone</filename> command to get the project's metadata files.
681 </para></listitem> 680 </para></listitem>
682 <listitem><para>Select <filename>Finish</filename> to create the project.</para></listitem> 681 <listitem><para>Select <filename>Finish</filename> to create the project.</para></listitem>
683 </orderedlist> 682 </orderedlist>
@@ -702,9 +701,9 @@
702 <listitem><para>Select <filename>File -> New -> Yocto BitBake Commander -> BitBake Recipe</filename> 701 <listitem><para>Select <filename>File -> New -> Yocto BitBake Commander -> BitBake Recipe</filename>
703 to open a new recipe wizard.</para></listitem> 702 to open a new recipe wizard.</para></listitem>
704 <listitem><para>Point to your source by filling in the "SRC_URL" field. 703 <listitem><para>Point to your source by filling in the "SRC_URL" field.
705 For example, you can add a recipe in the 704 For example, you can add a recipe to your
706 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-source-files'>Yocto Project Source Files</ulink>, 705 <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-source-files'>source directory structure</ulink>
707 input the "SRC_URL" as follows: 706 by defining "SRC_URL" as follows:
708 <literallayout class='monospaced'> 707 <literallayout class='monospaced'>
709 ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz 708 ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz
710 </literallayout></para></listitem> 709 </literallayout></para></listitem>
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml
index 83fe3094e6..ac286a5840 100644
--- a/documentation/adt-manual/adt-intro.xml
+++ b/documentation/adt-manual/adt-intro.xml
@@ -17,7 +17,7 @@
17 17
18 <para> 18 <para>
19 Fundamentally, the ADT consists of an architecture-specific cross-toolchain and 19 Fundamentally, the ADT consists of an architecture-specific cross-toolchain and
20 a matching sysroot that are both built by the Yocto Project build system Poky. 20 a matching sysroot that are both built by the OpenEmbedded build system Poky.
21 The toolchain and sysroot are based on a metadata configuration and extensions, 21 The toolchain and sysroot are based on a metadata configuration and extensions,
22 which allows you to cross-develop on the host machine for the target. 22 which allows you to cross-develop on the host machine for the target.
23 </para> 23 </para>
@@ -50,7 +50,7 @@
50 The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger 50 The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger
51 that are used to develop user-space applications for targeted hardware. 51 that are used to develop user-space applications for targeted hardware.
52 This toolchain is created either by running the ADT Installer script or 52 This toolchain is created either by running the ADT Installer script or
53 through a Yocto Project build tree that is based on your metadata 53 through a build directory that is based on your metadata
54 configuration or extension for your targeted device. 54 configuration or extension for your targeted device.
55 The cross-toolchain works with a matching target sysroot. 55 The cross-toolchain works with a matching target sysroot.
56 </para> 56 </para>
@@ -63,7 +63,7 @@
63 The matching target sysroot contains needed headers and libraries for generating 63 The matching target sysroot contains needed headers and libraries for generating
64 binaries that run on the target architecture. 64 binaries that run on the target architecture.
65 The sysroot is based on the target root filesystem image that is built by 65 The sysroot is based on the target root filesystem image that is built by
66 the Yocto Project's build system Poky and uses the same metadata configuration 66 the OpenEmbedded build system Poky and uses the same metadata configuration
67 used to build the cross-toolchain. 67 used to build the cross-toolchain.
68 </para> 68 </para>
69 </section> 69 </section>
@@ -79,8 +79,8 @@
79 <listitem><para>If you use the ADT Installer script to install ADT, you can 79 <listitem><para>If you use the ADT Installer script to install ADT, you can
80 specify whether or not to install QEMU.</para></listitem> 80 specify whether or not to install QEMU.</para></listitem>
81 <listitem><para>If you have downloaded a Yocto Project release and unpacked 81 <listitem><para>If you have downloaded a Yocto Project release and unpacked
82 it to create a Yocto Project file structure and you have sourced 82 it to create a source directory and you have sourced
83 the Yocto Project environment setup script, QEMU is installed and automatically 83 the environment setup script, QEMU is installed and automatically
84 available.</para></listitem> 84 available.</para></listitem>
85 <listitem><para>If you have installed the cross-toolchain 85 <listitem><para>If you have installed the cross-toolchain
86 tarball and you have sourcing the toolchain's setup environment script, QEMU 86 tarball and you have sourcing the toolchain's setup environment script, QEMU
@@ -120,7 +120,7 @@
120 <listitem><para><emphasis>SystemTap:</emphasis> A free software infrastructure 120 <listitem><para><emphasis>SystemTap:</emphasis> A free software infrastructure
121 that simplifies information gathering about a running Linux system. 121 that simplifies information gathering about a running Linux system.
122 This information helps you diagnose performance or functional problems. 122 This information helps you diagnose performance or functional problems.
123 SystemTap is not available as a user-space tool through the Yocto Eclipse IDE Plug-in. 123 SystemTap is not available as a user-space tool through the Eclipse IDE Yocto Plug-in.
124 See <ulink url='http://sourceware.org/systemtap'></ulink> for more information 124 See <ulink url='http://sourceware.org/systemtap'></ulink> for more information
125 on SystemTap.</para></listitem> 125 on SystemTap.</para></listitem>
126 <listitem><para><emphasis>Lttng-ust:</emphasis> A User-space Tracer designed to 126 <listitem><para><emphasis>Lttng-ust:</emphasis> A User-space Tracer designed to
diff --git a/documentation/adt-manual/adt-package.xml b/documentation/adt-manual/adt-package.xml
index 26b5dc18d8..0da301b123 100644
--- a/documentation/adt-manual/adt-package.xml
+++ b/documentation/adt-manual/adt-package.xml
@@ -17,7 +17,7 @@
17 <title>Package Management Systems</title> 17 <title>Package Management Systems</title>
18 18
19 <para> 19 <para>
20 The Yocto Project supports the generation of sysroot files using 20 The OpenEmbedded build system supports the generation of sysroot files using
21 three different Package Management Systems (PMS): 21 three different Package Management Systems (PMS):
22 <itemizedlist> 22 <itemizedlist>
23 <listitem><para><emphasis>OPKG:</emphasis> A less well known PMS whose use 23 <listitem><para><emphasis>OPKG:</emphasis> A less well known PMS whose use
@@ -28,7 +28,7 @@
28 <listitem><para><emphasis>RPM:</emphasis> A more widely known PMS intended for GNU/Linux 28 <listitem><para><emphasis>RPM:</emphasis> A more widely known PMS intended for GNU/Linux
29 distributions. 29 distributions.
30 This PMS works with files packaged in an <filename>.rms</filename> format. 30 This PMS works with files packaged in an <filename>.rms</filename> format.
31 The Yocto Project currently installs through this PMS by default. 31 The build system currently installs through this PMS by default.
32 See <ulink url='http://en.wikipedia.org/wiki/RPM_Package_Manager'></ulink> 32 See <ulink url='http://en.wikipedia.org/wiki/RPM_Package_Manager'></ulink>
33 for more information about RPM.</para></listitem> 33 for more information about RPM.</para></listitem>
34 <listitem><para><emphasis>Debian:</emphasis> The PMS for Debian-based systems 34 <listitem><para><emphasis>Debian:</emphasis> The PMS for Debian-based systems
@@ -75,7 +75,7 @@
75 </para> 75 </para>
76 76
77 <para> 77 <para>
78 Next, source the environment setup script found in the Yocto Project files. 78 Next, source the environment setup script found in the source directory.
79 Follow that by setting up the installation destination to point to your 79 Follow that by setting up the installation destination to point to your
80 sysroot as <filename>&lt;sysroot_dir&gt;</filename>. 80 sysroot as <filename>&lt;sysroot_dir&gt;</filename>.
81 Finally, have an OPKG configuration file <filename>&lt;conf_file&gt;</filename> 81 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 c3e4f6e987..0cda17846c 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -51,8 +51,8 @@
51 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
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 a Yocto Project Build Tree:</emphasis> 53 <listitem><para><emphasis>Use the Toolchain from within a Yocto Project Build Tree:</emphasis>
54 If you already have a Yocto Project build tree, you can build the cross-toolchain 54 If you already have a build directory, you can build the cross-toolchain
55 within tree. 55 within that structure.
56 However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you 56 However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you
57 do not get any of the other benefits without taking separate steps.</para></listitem> 57 do not get any of the other benefits without taking separate steps.</para></listitem>
58 </itemizedlist> 58 </itemizedlist>
@@ -75,22 +75,21 @@
75 <ulink url='&YOCTO_DL_URL;/releases'>Index of Releases</ulink>, specifically 75 <ulink url='&YOCTO_DL_URL;/releases'>Index of Releases</ulink>, specifically
76 at 76 at
77 <ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>. 77 <ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>.
78 Or, you can use BitBake to generate the tarball inside the existing Yocto Project 78 Or, you can use BitBake to generate the tarball inside the existing build directory.
79 build tree.
80 </para> 79 </para>
81 80
82 <para> 81 <para>
83 If you use BitBake to generate the ADT Installer tarball, you must 82 If you use BitBake to generate the ADT Installer tarball, you must
84 <filename>source</filename> the Yocto Project environment setup script 83 <filename>source</filename> the environment setup script
85 (<filename>oe-init-build-env</filename>) located 84 (<filename>oe-init-build-env</filename>) located
86 in the Yocto Project file structure before running the <filename>bitbake</filename> 85 in the source directory before running the <filename>bitbake</filename>
87 command that creates the tarball. 86 command that creates the tarball.
88 </para> 87 </para>
89 88
90 <para> 89 <para>
91 The following example commands download the Yocto Project release tarball, set up the Yocto 90 The following example commands download the Yocto Project release tarball, set up the
92 Project files structure, set up the environment while also creating the 91 source directory, set up the environment while also creating the
93 default Yocto Project build tree, 92 default build directory,
94 and run the <filename>bitbake</filename> command that results in the tarball 93 and run the <filename>bitbake</filename> command that results in the tarball
95 <filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>: 94 <filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>:
96 <literallayout class='monospaced'> 95 <literallayout class='monospaced'>
@@ -151,7 +150,7 @@
151 or not to install the emulator QEMU.</para></listitem> 150 or not to install the emulator QEMU.</para></listitem>
152 <listitem><para><filename>YOCTOADT_NFS_UTIL</filename>: Indicates whether 151 <listitem><para><filename>YOCTOADT_NFS_UTIL</filename>: Indicates whether
153 or not to install user-mode NFS. 152 or not to install user-mode NFS.
154 If you plan to use the Yocto Eclipse IDE plug-in against QEMU, 153 If you plan to use the Eclipse IDE Yocto plug-in against QEMU,
155 you should install NFS. 154 you should install NFS.
156 <note>To boot QEMU images using our userspace NFS server, you need 155 <note>To boot QEMU images using our userspace NFS server, you need
157 to be running <filename>portmap</filename> or <filename>rpcbind</filename>. 156 to be running <filename>portmap</filename> or <filename>rpcbind</filename>.
@@ -244,17 +243,17 @@
244 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 243 poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2
245 </literallayout> 244 </literallayout>
246 <note><para>As an alternative to steps one and two, you can build the toolchain tarball 245 <note><para>As an alternative to steps one and two, you can build the toolchain tarball
247 if you have a Yocto Project build tree. 246 if you have a build directory.
248 If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename> 247 If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename>
249 command. 248 command.
250 The resulting tarball will support such development. 249 The resulting tarball will support such development.
251 However, if you are not concerned with GMAE, 250 However, if you are not concerned with GMAE,
252 you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para> 251 you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para>
253 <para>Use the appropriate <filename>bitbake</filename> command only after you have 252 <para>Use the appropriate <filename>bitbake</filename> command only after you have
254 sourced the <filename>oe-build-init-env</filename> script located in the Yocto 253 sourced the <filename>oe-build-init-env</filename> script located in the source
255 Project files. 254 directory.
256 When the <filename>bitbake</filename> command completes, the tarball will 255 When the <filename>bitbake</filename> command completes, the tarball will
257 be in <filename>tmp/deploy/sdk</filename> in the Yocto Project build tree. 256 be in <filename>tmp/deploy/sdk</filename> in the build directory.
258 </para></note></para></listitem> 257 </para></note></para></listitem>
259 <listitem><para>Make sure you are in the root directory with root privileges and then expand 258 <listitem><para>Make sure you are in the root directory with root privileges and then expand
260 the tarball. 259 the tarball.
@@ -267,11 +266,11 @@
267 </section> 266 </section>
268 267
269 <section id='using-the-toolchain-from-within-the-build-tree'> 268 <section id='using-the-toolchain-from-within-the-build-tree'>
270 <title>Using BitBake and the Yocto Project Build Tree</title> 269 <title>Using BitBake and the Build Directory</title>
271 270
272 <para> 271 <para>
273 A final way of making the cross-toolchain available is to use BitBake 272 A final way of making the cross-toolchain available is to use BitBake
274 to generate the toolchain within an existing Yocto Project build tree. 273 to generate the toolchain within an existing build directory.
275 This method does not install the toolchain into the 274 This method does not install the toolchain into the
276 <filename>/opt</filename> directory. 275 <filename>/opt</filename> directory.
277 As with the previous method, if you need to install the target sysroot, you must 276 As with the previous method, if you need to install the target sysroot, you must
@@ -282,12 +281,12 @@
282 Follow these steps to generate the toolchain into the build tree: 281 Follow these steps to generate the toolchain into the build tree:
283 <orderedlist> 282 <orderedlist>
284 <listitem><para>Source the environment setup script 283 <listitem><para>Source the environment setup script
285 <filename>oe-init-build-env</filename> located in the Yocto Project 284 <filename>oe-init-build-env</filename> located in the source directory.
286 files.</para></listitem> 285 </para></listitem>
287 <listitem><para>At this point, you should be sure that the 286 <listitem><para>At this point, you should be sure that the
288 <filename>MACHINE</filename> variable 287 <filename>MACHINE</filename> variable
289 in the <filename>local.conf</filename> file found in the 288 in the <filename>local.conf</filename> file found in the
290 <filename>conf</filename> directory of the Yocto Project build directory 289 <filename>conf</filename> directory of the build directory
291 is set for the target architecture. 290 is set for the target architecture.
292 Comments within the <filename>local.conf</filename> file list the values you 291 Comments within the <filename>local.conf</filename> file list the values you
293 can use for the <filename>MACHINE</filename> variable. 292 can use for the <filename>MACHINE</filename> variable.
@@ -305,9 +304,9 @@
305 after checking or editing the <filename>local.conf</filename> but without 304 after checking or editing the <filename>local.conf</filename> but without
306 changing out of your working directory.</note> 305 changing out of your working directory.</note>
307 Once the <filename>bitbake</filename> command finishes, 306 Once the <filename>bitbake</filename> command finishes,
308 the cross-toolchain is generated and populated within the Yocto Project build tree. 307 the cross-toolchain is generated and populated within the build directory.
309 You will notice environment setup files for the cross-toolchain in the 308 You will notice environment setup files for the cross-toolchain in the
310 Yocto Project build tree in the <filename>tmp</filename> directory. 309 build directory in the <filename>tmp</filename> directory.
311 Setup script filenames contain the strings <filename>environment-setup</filename>. 310 Setup script filenames contain the strings <filename>environment-setup</filename>.
312 </para></listitem> 311 </para></listitem>
313 </orderedlist> 312 </orderedlist>
@@ -325,7 +324,7 @@
325 then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename> 324 then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename>
326 directory. 325 directory.
327 If you installed the toolchain in the build tree, you can find the environment setup 326 If you installed the toolchain in the build tree, you can find the environment setup
328 script for the toolchain in the Yocto Project build tree's <filename>tmp</filename> directory. 327 script for the toolchain in the build directory's <filename>tmp</filename> directory.
329 </para> 328 </para>
330 329
331 <para> 330 <para>
@@ -363,14 +362,15 @@
363 </para> 362 </para>
364 363
365 <para> 364 <para>
366 The Yocto Project provides basic kernel and filesystem images for several 365 The Yocto Project ships basic kernel and filesystem images for several
367 architectures (<filename>x86</filename>, <filename>x86-64</filename>, 366 architectures (<filename>x86</filename>, <filename>x86-64</filename>,
368 <filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>) 367 <filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>)
369 that you can use unaltered in the QEMU emulator. 368 that you can use unaltered in the QEMU emulator.
370 These kernel images reside in the Yocto Project release 369 These kernel images reside in the release
371 area - <ulink url='&YOCTO_MACHINES_DL_URL;'></ulink> 370 area - <ulink url='&YOCTO_MACHINES_DL_URL;'></ulink>
372 and are ideal for experimentation within Yocto Project. 371 and are ideal for experimentation using Yocto Project.
373 For information on the image types you can build using the Yocto Project, see the 372 For information on the image types you can build using the OpenEmbedded build system,
373 see the
374 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in 374 "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in
375 The Yocto Project Reference Manual. 375 The Yocto Project Reference Manual.
376 </para> 376 </para>
@@ -389,7 +389,7 @@
389 you can do so one of two ways: 389 you can do so one of two ways:
390 <itemizedlist> 390 <itemizedlist>
391 <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in 391 <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in
392 the Yocto Project build directory and then rebuild the image. 392 the build directory and then rebuild the image.
393 With this method, you need to modify the <filename>EXTRA_IMAGE_FEATURES</filename> 393 With this method, you need to modify the <filename>EXTRA_IMAGE_FEATURES</filename>
394 variable to have the value of "tools-debug" before rebuilding the image. 394 variable to have the value of "tools-debug" before rebuilding the image.
395 Once the image is rebuilt, the <filename>tcf-agent</filename> will be included 395 Once the image is rebuilt, the <filename>tcf-agent</filename> will be included