From a4266b454cad4cab43de4c6fc823ff2c4e53e5c9 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 22 Oct 2012 10:28:05 -0700 Subject: 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 Signed-off-by: Richard Purdie --- documentation/adt-manual/adt-command.xml | 6 ++--- documentation/adt-manual/adt-intro.xml | 10 ++++++--- documentation/adt-manual/adt-package.xml | 2 +- documentation/adt-manual/adt-prepare.xml | 38 ++++++++++++++++---------------- 4 files changed, 30 insertions(+), 26 deletions(-) (limited to 'documentation') diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml index 074e51c1f1..4000c924c3 100644 --- a/documentation/adt-manual/adt-command.xml +++ b/documentation/adt-manual/adt-command.xml @@ -8,9 +8,9 @@ Recall that earlier the manual discussed how to use an existing toolchain tarball that had been installed into /opt/poky, - which is outside of the build directory - (see the section "Using an Existing - Toolchain Tarball)". + which is outside of the + Build Directory + (see the section "Using a Cross-Toolchain Tarball)". 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 c83880b2d6..d8527b3aef 100644 --- 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 + Build Directory that + is based on your metadata configuration or extension for your targeted device. The cross-toolchain works with a matching target sysroot. @@ -111,7 +113,9 @@ If you use the ADT Installer script to install ADT, you can specify whether or not to install QEMU. If you have downloaded a Yocto Project release and unpacked - it to create a source directory and you have sourced + it to create a + Source Directory and + you have sourced the environment setup script, QEMU is installed and automatically available. If you have installed the cross-toolchain @@ -139,7 +143,7 @@ PowerTOP: Helps you determine what software is using the most power. You can find out more about PowerTOP at - . + . OProfile: 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 c55c10d1cd..da8d10fa4b 100644 --- a/documentation/adt-manual/adt-package.xml +++ b/documentation/adt-manual/adt-package.xml @@ -78,7 +78,7 @@ Next, source the environment setup script found in the - source directory. + Source Directory. Follow that by setting up the installation destination to point to your sysroot as <sysroot_dir>. Finally, have an OPKG configuration file <conf_file> diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index d660480b73..2e57e0cbe5 100644 --- 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. Use the Toolchain from within the Build Directory: If you already have a - build directory, + Build Directory, 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. @@ -77,21 +77,21 @@ at . Or, you can use BitBake to generate the tarball inside the existing - build directory. + Build Directory. If you use BitBake to generate the ADT Installer tarball, you must source the environment setup script (&OE_INIT_FILE;) located - in the source directory before running the bitbake + in the Source Directory before running the bitbake command that creates the tarball. The following example commands download the Poky tarball, set up the - source directory, - set up the environment while also creating the default build directory, + Source Directory, + set up the environment while also creating the default Build Directory, and run the bitbake command that results in the tarball ~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2: @@ -251,7 +251,7 @@ poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.sh As an alternative to steps one and two, you can build the toolchain installer - if you have a build directory. + if you have a Build Directory. If you need GMAE, you should use the bitbake meta-toolchain-gmae command. The resulting installation script when run will support such development. @@ -259,10 +259,10 @@ you can generate the toolchain installer using bitbake meta-toolchain. Use the appropriate bitbake command only after you have - sourced the oe-build-init-env script located in the source - directory. + sourced the &OE_INIT_PATH; script located in the Source + Directory. When the bitbake command completes, the toolchain installer will - be in tmp/deploy/sdk in the build directory. + be in tmp/deploy/sdk in the Build Directory. Once you have the installer, run it to install the toolchain. @@ -292,7 +292,7 @@ A final way of making the cross-toolchain available is to use BitBake to generate the toolchain within an existing - build directory. + Build Directory. This method does not install the toolchain into the /opt directory. As with the previous method, if you need to install the target sysroot, you must @@ -300,20 +300,20 @@ - Follow these steps to generate the toolchain into the build directory: + Follow these steps to generate the toolchain into the Build Directory: Source the environment setup script &OE_INIT_FILE; located in the - source directory. + Source Directory. At this point, you should be sure that the MACHINE variable in the local.conf file found in the - conf directory of the build directory + conf directory of the Build Directory is set for the target architecture. Comments within the local.conf file list the values you can use for the MACHINE variable. - You can populate the build directory with the cross-toolchains for more + You can populate the Build Directory with the cross-toolchains for more than a single architecture. You just need to edit the MACHINE variable in the local.conf file and re-run the BitBake @@ -327,9 +327,9 @@ after checking or editing the local.conf but without changing out of your working directory. Once the bitbake 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 tmp directory. + Build Directory in the tmp directory. Setup script filenames contain the strings environment-setup. 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 &YOCTO_ADTPATH_DIR; directory. If you installed the toolchain in the - build directory, + Build Directory, you can find the environment setup - script for the toolchain in the build directory's tmp directory. + script for the toolchain in the Build Directory's tmp directory. @@ -426,7 +426,7 @@ you can do so one of two ways: Modify the conf/local.conf configuration in - the build directory + the Build Directory and then rebuild the image. With this method, you need to modify the EXTRA_IMAGE_FEATURES -- cgit v1.2.3-54-g00ecf