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>

diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml
index 074e51c1f152db14dcc6ede58f5be4c669bdad3a..4000c924c3aff65bc82244b046ca64eda64e281e 100644 (file)
--- a/documentation/adt-manual/adt-command.xml
+++ b/documentation/adt-manual/adt-command.xml
@@ -8,9 +8,9 @@
     <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 build directory 
-        (see the section "<link linkend='using-an-existing-toolchain-tarball'>Using an Existing 
-        Toolchain Tarball)</link>".  
+        which is outside of the 
+        <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
+        (see the section "<link linkend='using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball)</link>".  
         And, that sourcing your architecture-specific environment setup script 
         initializes a suitable cross-toolchain development environment.  
         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 c83880b2d6bc8b78bdacccdbfce1fae88de9f6a1..d8527b3aef11ed853ffaa85eefca105897f8bd2e 100644 (file)
--- a/documentation/adt-manual/adt-intro.xml
+++ b/documentation/adt-manual/adt-intro.xml
@@ -55,7 +55,9 @@
             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, a toolchain installer
-            script, or through a build directory that is based on your metadata 
+            script, or through a 
+            <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> that 
+            is based on your metadata 
             configuration or extension for your targeted device.  
             The cross-toolchain works with a matching target sysroot.
         </para>
@@ -111,7 +113,9 @@
                 <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 source directory and you have sourced  
+                    it to create a 
+                    <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> 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 
@@ -139,7 +143,7 @@
                 <listitem><para><emphasis>PowerTOP:</emphasis> Helps you determine what   
                     software is using the most power.  
                     You can find out more about PowerTOP at 
-                    <ulink url='http://www.linuxpowertop.org/'></ulink>.</para></listitem>
+                    <ulink url='https://01.org/powertop/'></ulink>.</para></listitem>
                 <listitem><para><emphasis>OProfile:</emphasis> A system-wide profiler for Linux 
                     systems that is capable of profiling all running code at low overhead.  
                     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 c55c10d1cd112f7ccdab697aed59cafa3becda90..da8d10fa4bbf8825c0dbec7bcb68ff2688bba50e 100644 (file)
--- a/documentation/adt-manual/adt-package.xml
+++ b/documentation/adt-manual/adt-package.xml
@@ -78,7 +78,7 @@
 
     <para>
         Next, source the environment setup script found in the 
-        <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.  
+        <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.  
         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 d660480b73e6019d001511c290fab3f587e1a86d..2e57e0cbe59fd618ecc4c73cb6a5ef8977f81178 100644 (file)
--- a/documentation/adt-manual/adt-prepare.xml
+++ b/documentation/adt-manual/adt-prepare.xml
@@ -52,7 +52,7 @@
                 get any of the other mentioned benefits had you run the ADT Installer script.</para></listitem>
             <listitem><para><emphasis>Use the Toolchain from within the Build Directory:</emphasis>
                 If you already have a 
-                <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>, 
+                <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, 
                 you can build the cross-toolchain within the directory.
                 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>
@@ -77,21 +77,21 @@
                 at  
                 <ulink url='&YOCTO_ADTINSTALLER_DL_URL;'></ulink>.
                 Or, you can use BitBake to generate the tarball inside the existing 
-                <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
+                <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
             </para>
 
             <para>
                 If you use BitBake to generate the ADT Installer tarball, you must 
                 <filename>source</filename> the environment setup script 
                 (<filename>&OE_INIT_FILE;</filename>) located 
-                in the source directory 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 Poky tarball, set up the 
-                <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>, 
-                set up the environment while also creating the default build directory, 
+                <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, 
+                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'>
@@ -251,7 +251,7 @@
      poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh
                     </literallayout>
                     <note><para>As an alternative to steps one and two, you can build the toolchain installer 
-                        if you have a <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
+                        if you have a <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
                         If you need GMAE, you should use the <filename>bitbake meta-toolchain-gmae</filename>
                         command. 
                         The resulting installation script when run will support such development.
@@ -259,10 +259,10 @@
                         you can generate the toolchain installer 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 source
-                        directory.  
+                        sourced the <filename>&OE_INIT_PATH;</filename> script located in the Source
+                        Directory.  
                         When the <filename>bitbake</filename> command completes, the toolchain installer will 
-                        be in <filename>tmp/deploy/sdk</filename> in the build directory.
+                        be in <filename>tmp/deploy/sdk</filename> in the Build Directory.
                         </para></note>
                     </para></listitem>
                 <listitem><para>Once you have the installer, run it to install the toolchain.
@@ -292,7 +292,7 @@
         <para>
             A final way of making the cross-toolchain available is to use BitBake 
             to generate the toolchain within an existing 
-            <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>.
+            <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
             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 
@@ -300,20 +300,20 @@
         </para>
 
         <para>
-            Follow these steps to generate the toolchain into the build directory:
+            Follow these steps to generate the toolchain into the Build Directory:
             <orderedlist>
                 <listitem><para>Source the environment setup script 
                     <filename>&OE_INIT_FILE;</filename> located in the 
-                    <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
+                    <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
                     </para></listitem> 
                 <listitem><para>At this point, you should be sure that the 
                     <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> variable 
                     in the <filename>local.conf</filename> file found in the 
-                    <filename>conf</filename> directory of the 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.  
-                    <note>You can populate the build directory with the cross-toolchains for more 
+                    <note>You can populate the Build Directory with the cross-toolchains for more 
                         than a single architecture.  
                         You just need to edit the <filename>MACHINE</filename> variable in the 
                         <filename>local.conf</filename> file and re-run the BitBake 
@@ -327,9 +327,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 build directory.
+                    the cross-toolchain is generated and populated within the Build Directory.
                     You will notice environment setup files for the cross-toolchain in the 
-                    build directory 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>
                     <para>Be aware that when you use this method to install the toolchain you still need
                     to separately extract and install the sysroot filesystem.
@@ -351,9 +351,9 @@
         then you can find this script in the <filename>&YOCTO_ADTPATH_DIR;</filename>
         directory.  
         If you installed the toolchain in the 
-        <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>, 
+        <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, 
         you can find the environment setup 
-        script for the toolchain in the build directory's <filename>tmp</filename> directory.
+        script for the toolchain in the Build Directory's <filename>tmp</filename> directory.
     </para>
 
     <para> 
@@ -426,7 +426,7 @@
             you can do so one of two ways:
             <itemizedlist>
                 <listitem><para>Modify the <filename>conf/local.conf</filename> configuration in 
-                    the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>
+                    the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
                     and then rebuild the image.
                     With this method, you need to modify the 
                     <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></ulink>