From bd456271e4a26dbbc24b2d1be7bafc43f9d25df9 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 17 Jul 2012 14:03:51 -0700 Subject: documentation/adt-manual/adt-prepare.xml: Edits affecting rename and clarity I made a pass through this chapter and focused on better descriptions for getting the system ready for application development. I made adjustments to better represent what is really being done. It is not all ADT here as was being described before. Miscellaneous edits and improvements throughout. (From yocto-docs rev: 3544beda4794005fe139d7620fd13618fab05534) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/adt-manual/adt-prepare.xml | 78 ++++++++++++++++++-------------- 1 file changed, 44 insertions(+), 34 deletions(-) (limited to 'documentation') diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index 845c783d24..e67487b224 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml @@ -4,29 +4,30 @@ -Preparing to Use the Application Development Toolkit (ADT) +Preparing for Application Development - In order to use the ADT, you must install it, source a script to set up the - environment, and be sure both the kernel and filesystem image specific to the target architecture - exist. - This chapter describes how to be sure you meet the ADT requirements. + In order to develop applications, you need set up your host development system. + Several ways exist that allow you to install cross-development tools, QEMU, the + Eclipse Yocto Plug-in, and other tools. + This chapter describes how to prepare for application development.
- Installing the ADT + Installing the ADT and Toolchains - The following list describes how you can install the ADT, which includes the cross-toolchain. - Regardless of the installation you choose, you must source the cross-toolchain - environment setup script before you use the toolchain. + The following list describes installation methods that set up varying degrees of tool + availabiltiy on your system. + Regardless of the installation method you choose, + you must source the cross-toolchain + environment setup script before you use a toolchain. See the "Setting Up the - Cross-Development Environment" - section for more information. + Cross-Development Environment" section for more information. - Avoid mixing installation methods when installing the ADT for different architectures. + Avoid mixing installation methods when installing toolchains for different architectures. For example, avoid using the ADT Installer to install some toolchains and then hand-installing cross-development toolchains from downloaded tarballs to install toolchains for different architectures. @@ -50,9 +51,10 @@ toolchain tarball and then hand-install the toolchain. 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. - Use the Toolchain from within a Yocto Project Build Tree: - If you already have a build directory, you can build the cross-toolchain - within that structure. + Use the Toolchain from within the Build Directory: + If you already have a + 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. @@ -75,7 +77,8 @@ Index of Releases, specifically at . - Or, you can use BitBake to generate the tarball inside the existing build directory. + Or, you can use BitBake to generate the tarball inside the existing + build directory. @@ -87,9 +90,9 @@ - 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, + The following example commands download the Poky tarball, set up the + 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: @@ -243,7 +246,7 @@ poky-eglibc-x86_64-i586-toolchain-gmae-&DISTRO;.tar.bz2 As an alternative to steps one and two, you can build the toolchain tarball - 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 tarball will support such development. @@ -270,27 +273,29 @@ A final way of making the cross-toolchain available is to use BitBake - to generate the toolchain within an existing build directory. + to generate the toolchain within an existing + 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 - do this separately. + do that separately as well. - Follow these steps to generate the toolchain into the build tree: + Follow these steps to generate the toolchain into the build directory: Source the environment setup script - oe-init-build-env located in the source directory. + oe-init-build-env located in the + source directory. At this point, you should be sure that the - MACHINE variable + MACHINE variable in the local.conf file found in the 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 tree 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 @@ -320,10 +325,12 @@ 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, + If you used the ADT Installer or hand-installed cross-toolchain, then you can find this script in the &YOCTO_ADTPATH_DIR; directory. - If you installed the toolchain in the build tree, you can find the environment setup + If you installed the toolchain in the + build directory, + you can find the environment setup script for the toolchain in the build directory's tmp directory. @@ -358,7 +365,7 @@ pre-built versions. You can find examples for both these situations in the "A Quick Test Run" section of - The Yocto Project Quick Start. + the Yocto Project Quick Start. @@ -372,7 +379,7 @@ For information on the image types you can build using the OpenEmbedded build system, see the "Images" chapter in - The Yocto Project Reference Manual. + the Yocto Project Reference Manual. @@ -389,8 +396,10 @@ you can do so one of two ways: Modify the conf/local.conf configuration in - the build directory and then rebuild the image. - With this method, you need to modify the EXTRA_IMAGE_FEATURES + the build directory + and then rebuild the image. + With this method, you need to modify the + EXTRA_IMAGE_FEATURES variable to have the value of "tools-debug" before rebuilding the image. Once the image is rebuilt, the tcf-agent will be included in the image and is launched automatically after the boot. @@ -398,7 +407,7 @@ To build the agent, follow these steps: Be sure the ADT is installed as described in the - "Installing the ADT" section. + "Installing the ADT and Toolchains" section. Set up the cross-development environment as described in the "Setting @@ -411,7 +420,8 @@ Modify the Makefile.inc file for the cross-compilation environment by setting the - OPSYS and MACHINE + OPSYS and + MACHINE variables according to your target. Use the cross-development tools to build the tcf-agent. -- cgit v1.2.3-54-g00ecf