From d5d0f08c3232c1d27194b8380b924a5dd2c245e5 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 15 Aug 2011 07:38:02 -0700 Subject: documentation/adt-manual/adt-prepare.xml: edit pass for new termninology Also added some general punctuation edits. (From yocto-docs rev: e9a689655c6e88e735944084e5dda32800a6e6ca) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/adt-manual/adt-prepare.xml | 81 +++++++++++++++++--------------- 1 file changed, 43 insertions(+), 38 deletions(-) (limited to 'documentation/adt-manual/adt-prepare.xml') diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml index 1abc9537f2..68bbbf75e3 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml @@ -13,22 +13,25 @@ This section describes how to be sure you meet these requirements. - Througout this section two important terms are used: + Throughout this section two important terms are used: - Yocto Project Source Tree: + The Yocto Project Files: This term refers to the directory structure created as a result of downloading - and unpacking a Yocto Project release tarball. - The Yocto Project source tree contains BitBake, Documentation, Meta-data and - other files. - The name of the top-level directory of the Yocto Project source tree + and unpacking a Yocto Project release tarball or setting up a Git repository + by cloning git://git.yoctoproject.org/poky. + The Yocto Project files contain BitBake, Documentation, metadata and + other files that all support the development environment. + The name of the top-level directory of the Yocto Project files is derived from the Yocto Project release tarball. For example, downloading and unpacking poky-bernard-5.0.1.tar.bz2 results in a Yocto Project source tree whose Yocto Project source directory is named - poky-bernard-5.0.1. + poky-bernard-5.0.1. + If you create a Git repository then you can name the repository anything you like. + Yocto Project Build Tree: - This term refers to the area where you run your builds. + This term refers to the area where Yocto Project builds images. The area is created when you source the Yocto Project setup environment script - that is found in the Yocto Project source directory + that is found in the Yocto Project files area. (e.g. poky-init-build-env). You can create the Yocto Project build tree anywhere you want on your development system. @@ -65,10 +68,10 @@ Use an Existing Toolchain Tarball: Using this method you select and download an architecture-specific toolchain tarball and then hand-install the toolchain. - If you use this method you just get the cross-toolchain and QEMU - you do not + 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 Yocto Project build tree you can install the cross-toolchain + Use the Toolchain from within a Yocto Project Build Tree: + If you already have a Yocto Project build tree, you can install the cross-toolchain using that tree. 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. @@ -79,7 +82,7 @@ Using the ADT Installer - To run the ADT Installer you need to first get the ADT Installer tarball and then run the ADT + To run the ADT Installer, you need to first get the ADT Installer tarball and then run the ADT Installer Script. @@ -96,12 +99,12 @@ If you use BitBake to generate the ADT Installer tarball, you must source the Yocto Project environment setup script located in the Yocto Project - source directory before running the BitBake command that creates the tarball. + files before running the BitBake command that creates the tarball. - The following example commands download the Yocto Project release tarball, create the Yocto - Project source tree, set up the environment while also creating the Yocto Project build tree, + The following example commands download the Yocto Project release tarball, set up the Yocto + Project files, set up the environment while also creating the Yocto Project build tree, and finally run the BitBake command that results in the tarball ~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2: @@ -121,7 +124,7 @@ Configuring and Running the ADT Installer Script - Before running the ADT Installer script you need to unpack the tarball. + Before running the ADT Installer script, you need to unpack the tarball. You can unpack the tarball in any directory you wish. Unpacking it creates the directory adt-installer, which contains the ADT Installer script and its configuration file. @@ -161,9 +164,9 @@ you should install NFS. To boot QEMU images using our userspace NFS server, you need - to be running portmap or rpcbind. - If you are running rpcbind, you will also need to add the -i - option when rpcbind starts up. + to be running portmap or rpcbind. + If you are running rpcbind, you will also need to add the + -i option when rpcbind starts up. Please make sure you understand the security implications of doing this. Your firewall settings may also have to be modified to allow NFS booting to work. @@ -180,7 +183,8 @@ For example, if you downloaded both minimal and sato-sdk images by setting YOCTOADT_ROOTFS_<arch> to "minimal sato-sdk", then YOCTOADT_ROOTFS_<arch> - must be set to either "minimal" or "sato-sdk". + must be set to either minimal or + sato-sdk. YOCTOADT_TARGET_SYSROOT_LOC_<arch> - The location on the development host where the target sysroot will be created. @@ -204,7 +208,7 @@ - Once the installer begins to run you are asked whether you want to run in + Once the installer begins to run, you are asked whether you want to run in interactive or silent mode. If you want to closely monitor the installation then choose “I” for interactive mode rather than “S” for silent mode. @@ -227,9 +231,9 @@
Using a Cross-Toolchain Tarball - If you want to simply install the cross-toolchain by hand you can do so by using an existing + If you want to simply install the cross-toolchain by hand, you can do so by using an existing cross-toolchain tarball. - If you install the cross-toolchain by hand you will have to set up the target sysroot separately. + If you install the cross-toolchain by hand, you will have to set up the target sysroot separately. @@ -238,28 +242,29 @@ Go to and find the folder that matches your host development system - (i.e. 'i686' for 32-bit machines or 'x86_64' for 64-bit machines). + (i.e. i686 for 32-bit machines or + x86_64 for 64-bit machines). 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 arm target go into the + you are going to use your cross-toolchain for an arm target, go into the x86_64 folder and download the following tarball: yocto-eglibc-x86_64-arm-toolchain-gmae-1.0.tar.bz2 - Alternatively you can build the toolchain tarball if you have a Yocto Project build tree. + Alternatively, you can build the toolchain tarball if you have a Yocto Project build tree. Use the bitbake meta-toolchain command after you have sourced the poky-build-init script located in the Yocto Project - source directory. - When the bitbake command completes the toolchain tarball will + files. + When the bitbake command completes, the toolchain tarball will be in tmp/deploy/sdk in the Yocto Project build tree. Make sure you are in the root directory and then expand the tarball. The tarball expands into /opt/poky/$SDKVERSION. - Once the tarball in unpacked the cross-toolchain is installed. + Once the tarball in unpacked, the cross-toolchain is installed. You will notice environment setup files for the cross-toolchain in the directory. @@ -274,14 +279,13 @@ Follow these steps: Source the environment setup script located in the Yocto Project - source directory. + files. The script has the string init-build-env as part of the name. At this point you should be sure that the MACHINE variable in the local.conf file is set for the target architecture. - You can find the local.conf file in the Yocto Project source - directory. + You can find the local.conf file in the Yocto Project files. 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 @@ -291,7 +295,7 @@ Run bitbake meta-ide-support to complete the cross-toolchain installation. If you change your working directory after you source the environment - setup script and before you run the BitBake command the command will not work. + setup script and before you run the BitBake command, the command will not work. Be sure to run the BitBake command immediately after checking or editing the local.conf but without changing your working directory. Once BitBake finishes, the cross-toolchain is installed. @@ -307,12 +311,12 @@
Setting Up the Environment - Before you can use the cross-toolchain you need to set up the toolchain environment by + Before you can use the cross-toolchain, you need to set up the toolchain environment by sourcing the 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 /opt/poky/$SDKVERSION directory. - If you used BitBake and the Yocto Project Build Tree to install the cross-toolchain + If you used BitBake and the Yocto Project Build Tree to install the cross-toolchain, then you can find the environment setup scripts in in the Yocto Project build tree in the tmp directory. @@ -341,8 +345,9 @@ . Yocto Project provides basic kernels and filesystem images for several - architectures (x86, x86-64, mips, powerpc, and arm) that you can use - unaltered in the QEMU emulator. + architectures (x86, x86-64, + mips, powerpc, and arm) + that you can use unaltered in the QEMU emulator. These kernels and filesystem images reside in the Yocto Project release area - and are ideal for experimentation within Yocto Project. -- cgit v1.2.3-54-g00ecf