path: root/documentation/adt-manual
diff options
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-03-06 17:06:44 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:08:09 -0800
commit2ede6c8c4481158a5bc713a105792e35ef9d362d (patch)
tree934b30e249240cf2b9901220ceebb7f3bd1753e9 /documentation/adt-manual
parenteebdda725bac9590b5090fa9e46f8e1d910f0056 (diff)
documentation/adt-manual: Converted manual to use the poky.ent file
Conversion of hard links to use the variables set up in the file documentation/poky.ent. (From yocto-docs rev: edbacc1b57f02c31ff6eaee666245be83fb17543) 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')
6 files changed, 46 insertions, 45 deletions
diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
index a916a03c85..43bd08b74f 100644
--- a/documentation/adt-manual/adt-command.xml
+++ b/documentation/adt-manual/adt-command.xml
@@ -1,5 +1,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<chapter id='using-the-command-line'>
<title>Using the Command Line</title>
diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml
index baba2b469e..cb642ebed7 100644
--- a/documentation/adt-manual/adt-eclipse.xml
+++ b/documentation/adt-manual/adt-eclipse.xml
@@ -1,5 +1,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<chapter id='adt-eclipse'>
<title>Working Within Eclipse</title>
@@ -43,7 +44,7 @@
It is recommended that you have the Indigo 3.7 version of the
Eclipse IDE installed on your development system.
If you don’t have this version, you can find it at
- <ulink url='http://www.eclipse.org/downloads'></ulink>.
+ <ulink url='&ECLIPSE_MAIN_URL;'></ulink>.
From that site, choose the Eclipse Classic version particular to your development
This version contains the Eclipse Platform, the Java Development
@@ -100,7 +101,7 @@
<listitem><para>Make sure you are in your Workbench and select
"Install New Software" from the "Help" pull-down menu.
- <listitem><para>Select <filename>indigo - http://download.eclipse.org/releases/indigo</filename>
+ <listitem><para>Select <filename>indigo - &ECLIPSE_INDIGO_URL;</filename>
from the "Work with:" pull-down menu.</para></listitem>
<listitem><para>Expand the box next to <filename>Programming Languages</filename>
and select the <filename>Autotools Support for CDT (incubation)</filename>
@@ -111,9 +112,9 @@
<listitem><para>Click the
"Available Software Sites" link.</para></listitem>
<listitem><para>Check the box next to
- <filename>http://download.eclipse.org/tm/updates/3.3</filename>
+ <filename>&ECLIPSE_UPDATES_URL;</filename>
and click "OK".</para></listitem>
- <listitem><para>Select <filename>http://download.eclipse.org/tm/updates/3.3</filename>
+ <listitem><para>Select <filename>&ECLIPSE_UPDATES_URL;</filename>
from the "Work with:" pull-down menu.</para></listitem>
<listitem><para>Check the box next to <filename>TM and RSE Main Features</filename>.
@@ -127,7 +128,7 @@
<listitem><para>After clicking "Available Software Sites", check the box next to
and click "OK".</para></listitem>
- <listitem><para>Select <filename>http://download.eclipse.org/tools/cdt/releases/indigo</filename>
+ <listitem><para>Select <filename>&ECLIPSE_INDIGO_CDT_URL;</filename>
from the "Work with:" pull-down menu.</para></listitem>
<listitem><para>Check the box next to <filename>CDT Main Features</filename>.
@@ -162,7 +163,7 @@
<listitem><para>In Eclipse, select "Install New Software" from the "Help" menu.</para></listitem>
<listitem><para>Click "Add..." in the "Work with:" area.</para></listitem>
- <filename>http://downloads.yoctoproject.org/releases/eclipse-plugin/1.1</filename>
+ <filename>&ECLIPSE_DL_PLUGIN_URL;</filename>
in the URL field and provide a meaningful name in the "Name" field.</para></listitem>
<listitem><para>Click "OK" to have the entry added to the "Work with:"
drop-down list.</para></listitem>
@@ -254,8 +255,8 @@
<listitem><para>In Eclipse, select "Import" from the "File" menu.</para></listitem>
<listitem><para>Expand the "General" box and select "existing projects into workspace"
and then click "Next".</para></listitem>
- <listitem><para>Select the root directory and browse to "~/yocto-eclipse/plugins".
- </para></listitem>
+ <listitem><para>Select the root directory and browse to
+ <filename>~/yocto-eclipse/plugins</filename>.</para></listitem>
<listitem><para>There will be three things there.
Select each one and install one at a time.
Do all three.</para></listitem>
@@ -354,7 +355,7 @@
The pull-down menu should have the supported architectures.
If the architecture you need is not listed in the menu, you
will need to build the image.
- See the "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#building-image'>Building an Image</ulink>" section
+ See the "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section
of The Yocto Project Quick Start for more information.</para></listitem>
@@ -581,7 +582,7 @@
host can use, you must have <filename>oprofile</filename> version 0.9.4 or
greater installed on the host.</para>
<para>You can locate both the viewer and server from
- <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/oprofileui/'></ulink>.
+ <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/oprofileui/'></ulink>.
<note>The <filename>oprofile-server</filename> is installed by default on
the <filename>core-image-sato-sdk</filename> image.</note></para></listitem>
<listitem><para><emphasis><filename>Lttng-ust</filename>:</emphasis> Selecting this tool runs
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml
index 9ae908fc11..83fe3094e6 100644
--- a/documentation/adt-manual/adt-intro.xml
+++ b/documentation/adt-manual/adt-intro.xml
@@ -1,5 +1,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<chapter id='adt-intro'>
diff --git a/documentation/adt-manual/adt-manual.xml b/documentation/adt-manual/adt-manual.xml
index 2d11b9f355..9576ae8450 100644
--- a/documentation/adt-manual/adt-manual.xml
+++ b/documentation/adt-manual/adt-manual.xml
@@ -1,5 +1,6 @@
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<book id='adt-manual' lang='en'
@@ -46,7 +47,7 @@
- <year>2010-2012</year>
+ <year>&COPYRIGHT_YEAR;</year>
<holder>Linux Foundation</holder>
@@ -58,9 +59,9 @@
Due to production processes, there could be differences between the Yocto Project
documentation bundled in the release tarball and the
- <ulink url='http://www.yoctoproject.org/docs/latest/adt-manual/adt-manual.html'>
+ <ulink url='&YOCTO_DOCS_ADT_URL;'>
Application Developer's Toolkit (ADT) User's Guide</ulink> on
- the <ulink url='http://www.yoctoproject.org'>Yocto Project</ulink> website.
+ the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website.
For the latest version of this manual, see the manual on the website.
diff --git a/documentation/adt-manual/adt-package.xml b/documentation/adt-manual/adt-package.xml
index 3289a32ff2..26b5dc18d8 100644
--- a/documentation/adt-manual/adt-package.xml
+++ b/documentation/adt-manual/adt-package.xml
@@ -1,5 +1,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<chapter id='adt-package'>
<title>Optionally Customizing the Development Packages Installation</title>
@@ -54,7 +55,7 @@
For build performance information related to the PMS, see
- <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink> in The Yocto Project Reference Manual.
+ <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink> in The Yocto Project Reference Manual.
diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml
index 37d355e275..9880fcc7d1 100644
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -1,5 +1,6 @@
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<chapter id='adt-prepare'>
@@ -56,9 +57,9 @@
The ADT Installer is contained in the ADT Installer tarball.
You can download the tarball into any directory from the
- <ulink url='http://downloads.yoctoproject.org/releases'>Index of Releases</ulink>, specifically
+ <ulink url='&YOCTO_DL_URL;/releases'>Index of Releases</ulink>, specifically
- <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1/adt_installer'></ulink>.
+ <ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>.
Or, you can use BitBake to generate the tarball inside the existing Yocto Project
build tree.
@@ -81,9 +82,9 @@
$ cd ~
$ mkdir yocto-project
$ cd yocto-project
- $ wget http://downloads.yoctoproject.org/releases/yocto/yocto-1.1/poky-edison-6.0.tar.bz2
- $ tar xjf poky-edison-6.0.tar.bz2
- $ source poky-edison-6.0/oe-init-build-env
+ $ tar xjf &YOCTO_POKY_TARBALL;
+ $ source &OE_INIT_PATH;
$ bitbake adt-installer
@@ -173,11 +174,9 @@
The ADT Installer requires the <filename>libtool</filename> package to complete.
- If you install the recommended packages as described in the
- "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#packages'>Packages</ulink>"
- section of
- <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'>
- The Yocto Project Quick Start</ulink>, then you will have libtool installed.
+ If you install the recommended packages as described in
+ "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>"
+ section of The Yocto Project Quick Start, then you will have libtool installed.
@@ -191,7 +190,7 @@
Once the installation completes, the ADT, which includes the cross-toolchain, is installed.
You will notice environment setup files for the cross-toolchain in
- <filename>/opt/poky/1.1</filename>,
+ <filename>&YOCTO_ADTPATH_DIR;</filename>,
and image tarballs in the <filename>adt-installer</filename>
directory according to your installer configurations, and the target sysroot located
according to the <filename>YOCTOADT_TARGET_SYSROOT_LOC_&lt;arch&gt;</filename> variable
@@ -214,17 +213,17 @@
Follow these steps:
<listitem><para>Go to
- <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1/toolchain'></ulink>
+ <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>
and find the folder that matches your host development system
(i.e. <filename>i686</filename> for 32-bit machines or
- <filename>x86_64</filename> for 64-bit machines).</para></listitem>
+ <filename>x86-64</filename> for 64-bit machines).</para></listitem>
<listitem><para>Go into that folder and download the toolchain tarball whose name
includes the appropriate target architecture.
For example, if your host development system is an Intel-based 64-bit system and
you are going to use your cross-toolchain for an Intel-based 32-bit target, go into the
<filename>x86_64</filename> folder and download the following tarball:
<literallayout class='monospaced'>
- poky-eglibc-x86_64-i586-toolchain-gmae-1.1.tar.bz2
+ poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2
<note><para>As an alternative to steps one and two, you can build the toolchain tarball
if you have a Yocto Project build tree.
@@ -241,7 +240,7 @@
<listitem><para>Make sure you are in the root directory with root privileges and then expand
the tarball.
- The tarball expands into <filename>/opt/poky/1.1</filename>.
+ The tarball expands into <filename>&YOCTO_ADTPATH_DIR;</filename>.
Once the tarball is expanded, the cross-toolchain is installed.
You will notice environment setup files for the cross-toolchain in the directory.
@@ -304,7 +303,7 @@
Before you can develop using the cross-toolchain, you need to set up the
cross-development environment by sourcing the toolchain's environment setup script.
If you used the ADT Installer or used an existing ADT tarball to install the ADT,
- then you can find this script in the <filename>/opt/poky/1.1</filename>
+ then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename>
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.
@@ -318,7 +317,7 @@
For example, the toolchain environment setup script for a 64-bit IA-based architecture would
be the following:
<literallayout class='monospaced'>
- /opt/poky/1.1/environment-setup-x86_64-poky-linux
+ &YOCTO_ADTPATH_DIR;/environment-setup-x86_64-poky-linux
@@ -340,10 +339,8 @@
To get the kernel and filesystem images, you either have to build them or download
pre-built versions.
You can find examples for both these situations in the
- "<ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html#test-run'>A
- Quick Test Run</ulink>" section of
- <ulink url='http://www.yoctoproject.org/docs/latest/yocto-project-qs/yocto-project-qs.html'>
- The Yocto Project Quick Start</ulink>.
+ "<ulink url='&YOCTO_DOCS_QS_URL;#test-run'>A Quick Test Run</ulink>" section of
+ The Yocto Project Quick Start.
@@ -352,12 +349,11 @@
<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
- area - <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1/machines/'></ulink>
+ 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
- "<ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink>" appendix in
- <ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html'>
- The Yocto Project Reference Manual</ulink>.
+ "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Reference: Images</ulink>" appendix in
+ The Yocto Project Reference Manual.