aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual
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/adt-manual
parent7a4cc0e8845fbee6a9066e8d83a90bcb8acc96be (diff)
downloadpoky-347424e558a8d6db1c82f3bb1dbbf7b7b574566b.tar.gz
poky-347424e558a8d6db1c82f3bb1dbbf7b7b574566b.tar.bz2
poky-347424e558a8d6db1c82f3bb1dbbf7b7b574566b.zip
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/adt-manual')
-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 @@
<para>
Recall that earlier the manual discussed how to use an existing toolchain
tarball that had been installed into <filename>/opt/poky</filename>,
- which is outside of the Yocto Project build tree
+ which is outside of the build directory
(see the section "<link linkend='using-an-existing-toolchain-tarball'>Using an Existing
Toolchain Tarball)</link>".
And, that sourcing your architecture-specific environment setup script
@@ -21,7 +21,7 @@
for example, <filename>configure.sh</filename> can find pre-generated
test results for tests that need target hardware on which to run.
These conditions allow you to easily use the toolchain outside of the
- Yocto Project build environment on both autotools-based projects and
+ OpenEmbedded build environment on both autotools-based projects and
Makefile-based projects.
</para>
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 @@
<para>
The Eclipse IDE is a popular development environment and it fully supports
- development using Yocto Project.
+ development using the Yocto Project.
When you install and configure the Eclipse Yocto Project Plug-in into
- the Eclipse IDE, you maximize your Yocto Project design experience.
+ the Eclipse IDE, you maximize your Yocto Project experience.
Installing and configuring the Plug-in results in an environment that
has extensions specifically designed to let you more easily develop software.
These extensions allow for cross-compilation, deployment, and execution of
@@ -21,7 +21,7 @@
</para>
<para>
This section describes how to install and configure the Eclipse IDE
- Yocto Plug-in and how to use it to develop your Yocto Project.
+ Yocto Plug-in and how to use it to develop your application.
</para>
<section id='setting-up-the-eclipse-ide'>
@@ -152,7 +152,7 @@
<para>
You can install the Eclipse Yocto Plug-in into the Eclipse IDE
- one of two ways: use the Yocto Project update site to install the pre-built plug-in,
+ one of two ways: use the Yocto Project's Eclipse Update site to install the pre-built plug-in,
or build and install the plug-in from the latest source code.
If you don't want to permanently install the plug-in but just want to try it out
within the Eclipse environment, you can import the plug-in project from the
@@ -320,10 +320,10 @@
<listitem><para><emphasis>
<filename>Build System Derived Toolchain:</filename></emphasis>
Select this mode if the cross-toolchain has been installed and built
- as part of the Yocto Project build tree.
+ as part of the build directory.
When you select <filename>Build system derived toolchain</filename>,
you are using the toolchain bundled
- inside the Yocto Project build tree.
+ inside the build directory.
</para></listitem>
</itemizedlist>
</para></listitem>
@@ -342,11 +342,10 @@
However, doing so is discouraged.</note></para>
<para>If you are using a system-derived toolchain, the path you provide
for the <filename>Toolchain Root Location</filename>
- field is the Yocto Project's build directory.
+ field is the build directory.
See section "<link linkend='using-the-toolchain-from-within-the-build-tree'>Using
- BitBake and the Yocto Project Build Tree</link>" for
- information on how to install the toolchain into the Yocto
- Project build tree.</para></listitem>
+ BitBake and the build directory</link>" for
+ information on how to install the toolchain into the build directory.</para></listitem>
<listitem><para><emphasis>Specify the Sysroot Location:</emphasis>
This location is where the root filesystem for the
target hardware is created on the development system by the ADT Installer.
@@ -380,7 +379,7 @@
and specify any custom options.</para>
<para>If you selected <filename>Build system derived toolchain</filename>,
the target kernel you built will be located in the
- Yocto Project build tree in <filename>tmp/deploy/images</filename> directory.
+ build directory in <filename>tmp/deploy/images</filename> directory.
If you selected <filename>Standalone pre-built toolchain</filename>, the
pre-built image you downloaded is located
in the directory you specified when you downloaded the image.</para>
@@ -433,7 +432,7 @@
<listitem><para>Double click <filename>C Project</filename> to create the project.</para></listitem>
<listitem><para>Expand <filename>Yocto Project ADT Project</filename>.</para></listitem>
<listitem><para>Select <filename>Hello World ANSI C Autotools Project</filename>.
- This is an Autotools-based project based on a Yocto Project template.</para></listitem>
+ This is an Autotools-based project based on a Yocto template.</para></listitem>
<listitem><para>Put a name in the <filename>Project name:</filename> field.
Do not use hyphens as part of the name.</para></listitem>
<listitem><para>Click <filename>Next</filename>.</para></listitem>
@@ -677,7 +676,7 @@
<filename>&lt;project_location&gt;/&lt;project_name&gt;</filename>.
If that directory does not exist, you need to check
the "Clone from Yocto Git Repository" box, which would execute a
- <filename>git clone</filename> command to get the Yocto project's metadata files.
+ <filename>git clone</filename> command to get the project's metadata files.
</para></listitem>
<listitem><para>Select <filename>Finish</filename> to create the project.</para></listitem>
</orderedlist>
@@ -702,9 +701,9 @@
<listitem><para>Select <filename>File -> New -> Yocto BitBake Commander -> BitBake Recipe</filename>
to open a new recipe wizard.</para></listitem>
<listitem><para>Point to your source by filling in the "SRC_URL" field.
- For example, you can add a recipe in the
- <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-source-files'>Yocto Project Source Files</ulink>,
- input the "SRC_URL" as follows:
+ For example, you can add a recipe to your
+ <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-source-files'>source directory structure</ulink>
+ by defining "SRC_URL" as follows:
<literallayout class='monospaced'>
ftp://ftp.gnu.org/gnu/m4/m4-1.4.9.tar.gz
</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 @@
<para>
Fundamentally, the ADT consists of an architecture-specific cross-toolchain and
- a matching sysroot that are both built by the Yocto Project build system Poky.
+ a matching sysroot that are both built by the OpenEmbedded build system Poky.
The toolchain and sysroot are based on a metadata configuration and extensions,
which allows you to cross-develop on the host machine for the target.
</para>
@@ -50,7 +50,7 @@
The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger
that are used to develop user-space applications for targeted hardware.
This toolchain is created either by running the ADT Installer script or
- through a Yocto Project build tree that is based on your metadata
+ through a build directory that is based on your metadata
configuration or extension for your targeted device.
The cross-toolchain works with a matching target sysroot.
</para>
@@ -63,7 +63,7 @@
The matching target sysroot contains needed headers and libraries for generating
binaries that run on the target architecture.
The sysroot is based on the target root filesystem image that is built by
- the Yocto Project's build system Poky and uses the same metadata configuration
+ the OpenEmbedded build system Poky and uses the same metadata configuration
used to build the cross-toolchain.
</para>
</section>
@@ -79,8 +79,8 @@
<listitem><para>If you use the ADT Installer script to install ADT, you can
specify whether or not to install QEMU.</para></listitem>
<listitem><para>If you have downloaded a Yocto Project release and unpacked
- it to create a Yocto Project file structure and you have sourced
- the Yocto Project environment setup script, QEMU is installed and automatically
+ it to create a source directory and you have sourced
+ the environment setup script, QEMU is installed and automatically
available.</para></listitem>
<listitem><para>If you have installed the cross-toolchain
tarball and you have sourcing the toolchain's setup environment script, QEMU
@@ -120,7 +120,7 @@
<listitem><para><emphasis>SystemTap:</emphasis> A free software infrastructure
that simplifies information gathering about a running Linux system.
This information helps you diagnose performance or functional problems.
- SystemTap is not available as a user-space tool through the Yocto Eclipse IDE Plug-in.
+ SystemTap is not available as a user-space tool through the Eclipse IDE Yocto Plug-in.
See <ulink url='http://sourceware.org/systemtap'></ulink> for more information
on SystemTap.</para></listitem>
<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 @@
<title>Package Management Systems</title>
<para>
- The Yocto Project supports the generation of sysroot files using
+ The OpenEmbedded build system supports the generation of sysroot files using
three different Package Management Systems (PMS):
<itemizedlist>
<listitem><para><emphasis>OPKG:</emphasis> A less well known PMS whose use
@@ -28,7 +28,7 @@
<listitem><para><emphasis>RPM:</emphasis> A more widely known PMS intended for GNU/Linux
distributions.
This PMS works with files packaged in an <filename>.rms</filename> format.
- The Yocto Project currently installs through this PMS by default.
+ The build system currently installs through this PMS by default.
See <ulink url='http://en.wikipedia.org/wiki/RPM_Package_Manager'></ulink>
for more information about RPM.</para></listitem>
<listitem><para><emphasis>Debian:</emphasis> The PMS for Debian-based systems
@@ -75,7 +75,7 @@
</para>
<para>
- Next, source the environment setup script found in the Yocto Project files.
+ Next, source the environment setup script found in the source directory.
Follow that by setting up the installation destination to point to your
sysroot as <filename>&lt;sysroot_dir&gt;</filename>.
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 @@
If you use this method, you just get the cross-toolchain and QEMU - you do not
get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem>
<listitem><para><emphasis>Use the Toolchain from within a Yocto Project Build Tree:</emphasis>
- If you already have a Yocto Project build tree, you can build the cross-toolchain
- within tree.
+ If you already have a build directory, you can build the cross-toolchain
+ within that structure.
However, like the previous method mentioned, you only get the cross-toolchain and QEMU - you
do not get any of the other benefits without taking separate steps.</para></listitem>
</itemizedlist>
@@ -75,22 +75,21 @@
<ulink url='&YOCTO_DL_URL;/releases'>Index of Releases</ulink>, specifically
at
<ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>.
- Or, you can use BitBake to generate the tarball inside the existing Yocto Project
- build tree.
+ Or, you can use BitBake to generate the tarball inside the existing build directory.
</para>
<para>
If you use BitBake to generate the ADT Installer tarball, you must
- <filename>source</filename> the Yocto Project environment setup script
+ <filename>source</filename> the environment setup script
(<filename>oe-init-build-env</filename>) located
- in the Yocto Project file structure before running the <filename>bitbake</filename>
+ in the source directory before running the <filename>bitbake</filename>
command that creates the tarball.
</para>
<para>
- The following example commands download the Yocto Project release tarball, set up the Yocto
- Project files structure, set up the environment while also creating the
- default Yocto Project build tree,
+ The following example commands download the Yocto Project release tarball, set up the
+ source directory, set up the environment while also creating the
+ default build directory,
and run the <filename>bitbake</filename> command that results in the tarball
<filename>~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2</filename>:
<literallayout class='monospaced'>
@@ -151,7 +150,7 @@
or not to install the emulator QEMU.</para></listitem>
<listitem><para><filename>YOCTOADT_NFS_UTIL</filename>: Indicates whether
or not to install user-mode NFS.
- If you plan to use the Yocto Eclipse IDE plug-in against QEMU,
+ If you plan to use the Eclipse IDE Yocto plug-in against QEMU,
you should install NFS.
<note>To boot QEMU images using our userspace NFS server, you need
to be running <filename>portmap</filename> or <filename>rpcbind</filename>.
@@ -244,17 +243,17 @@
poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2
</literallayout>
<note><para>As an alternative to steps one and two, you can build the toolchain tarball
- if you have a Yocto Project build tree.
+ if you have a build directory.
If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename>
command.
The resulting tarball will support such development.
However, if you are not concerned with GMAE,
you can generate the tarball using <filename>bitbake meta-toolchain</filename>.</para>
<para>Use the appropriate <filename>bitbake</filename> command only after you have
- sourced the <filename>oe-build-init-env</filename> script located in the Yocto
- Project files.
+ sourced the <filename>oe-build-init-env</filename> script located in the source
+ directory.
When the <filename>bitbake</filename> command completes, the tarball will
- be in <filename>tmp/deploy/sdk</filename> in the Yocto Project build tree.
+ be in <filename>tmp/deploy/sdk</filename> in the build directory.
</para></note></para></listitem>
<listitem><para>Make sure you are in the root directory with root privileges and then expand
the tarball.
@@ -267,11 +266,11 @@
</section>
<section id='using-the-toolchain-from-within-the-build-tree'>
- <title>Using BitBake and the Yocto Project Build Tree</title>
+ <title>Using BitBake and the Build Directory</title>
<para>
A final way of making the cross-toolchain available is to use BitBake
- to generate the toolchain within an existing Yocto Project build tree.
+ to generate the toolchain within an existing build directory.
This method does not install the toolchain into the
<filename>/opt</filename> directory.
As with the previous method, if you need to install the target sysroot, you must
@@ -282,12 +281,12 @@
Follow these steps to generate the toolchain into the build tree:
<orderedlist>
<listitem><para>Source the environment setup script
- <filename>oe-init-build-env</filename> located in the Yocto Project
- files.</para></listitem>
+ <filename>oe-init-build-env</filename> located in the source directory.
+ </para></listitem>
<listitem><para>At this point, you should be sure that the
<filename>MACHINE</filename> variable
in the <filename>local.conf</filename> file found in the
- <filename>conf</filename> directory of the Yocto Project build directory
+ <filename>conf</filename> directory of the build directory
is set for the target architecture.
Comments within the <filename>local.conf</filename> file list the values you
can use for the <filename>MACHINE</filename> variable.
@@ -305,9 +304,9 @@
after checking or editing the <filename>local.conf</filename> but without
changing out of your working directory.</note>
Once the <filename>bitbake</filename> command finishes,
- the cross-toolchain is generated and populated within the Yocto Project build tree.
+ the cross-toolchain is generated and populated within the build directory.
You will notice environment setup files for the cross-toolchain in the
- Yocto Project build tree in the <filename>tmp</filename> directory.
+ build directory in the <filename>tmp</filename> directory.
Setup script filenames contain the strings <filename>environment-setup</filename>.
</para></listitem>
</orderedlist>
@@ -325,7 +324,7 @@
then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename>
directory.
If you installed the toolchain in the build tree, you can find the environment setup
- script for the toolchain in the Yocto Project build tree's <filename>tmp</filename> directory.
+ script for the toolchain in the build directory's <filename>tmp</filename> directory.
</para>
<para>
@@ -363,14 +362,15 @@
</para>
<para>
- The Yocto Project provides basic kernel and filesystem images for several
+ The Yocto Project ships basic kernel and filesystem images for several
architectures (<filename>x86</filename>, <filename>x86-64</filename>,
<filename>mips</filename>, <filename>powerpc</filename>, and <filename>arm</filename>)
that you can use unaltered in the QEMU emulator.
- These kernel images reside in the Yocto Project release
+ These kernel images reside in the release
area - <ulink url='&YOCTO_MACHINES_DL_URL;'></ulink>
- and are ideal for experimentation within Yocto Project.
- For information on the image types you can build using the Yocto Project, see the
+ and are ideal for experimentation using Yocto Project.
+ For information on the image types you can build using the OpenEmbedded build system,
+ see the
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in
The Yocto Project Reference Manual.
</para>
@@ -389,7 +389,7 @@
you can do so one of two ways:
<itemizedlist>
<listitem><para>Modify the <filename>conf/local.conf</filename> configuration in
- the Yocto Project build directory and then rebuild the image.
+ the build directory and then rebuild the image.
With this method, you need to modify the <filename>EXTRA_IMAGE_FEATURES</filename>
variable to have the value of "tools-debug" before rebuilding the image.
Once the image is rebuilt, the <filename>tcf-agent</filename> will be included