From 77d1ba446c153afbe9fde7fcfa7afdd734104f9e Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 1 Sep 2011 09:18:33 -0700 Subject: documentation/adt-manual: General edits. I made a pass through the manual and made some general formatting changes, updated some links in anticipation for the 1.1 release. (From yocto-docs rev: f2d3a012fbe4e8db3cf07e5497acfdf732e55d97) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/adt-manual/adt-prepare.xml | 351 ++++++++++++++++--------------- 1 file changed, 182 insertions(+), 169 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 63ff1131f9..c2cf1721fa 100644 --- a/documentation/adt-manual/adt-prepare.xml +++ b/documentation/adt-manual/adt-prepare.xml @@ -6,75 +6,84 @@ Preparing to Use the Application Development Toolkit (ADT) - In order to use the ADT you must install it, source a script to set up the - environment, and be sure the kernel and filesystem image specific to the target architecture - exists. + 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 section describes how to be sure you meet these requirements. - Throughout this section two important terms are used: - - The Yocto Project Files: - This term refers to the directory structure created as a result of downloading - 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. - 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 Yocto Project builds images. - The area is created when you source the Yocto Project setup environment script - 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. - Here is an example that creates the tree in mybuilds - and names the Yocto Project build directory YP-5.0.1: - - $ source poky-bernard-5.0.1/poky-init-build-env $HOME/mybuilds/YP-5.0.1 - - If you don't specifically name the build directory then BitBake creates it - in the current directory and uses the name build. - Also, if you supply an existing directory then BitBake uses that - directory as the Yocto Project build directory and populates the build tree - beneath it. - + This chapter describes two important terms and how to be sure you meet the ADT requirements. +
+ Yocto Project Files and Build Areas + + + Before learning how to prepare your system for the ADT, you need to understand + two important terms used throughout this manual: + + The Yocto Project Files: + This term refers to the directory structure created as a result of downloading + 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. + Consequently, you must have the Yocto Project files in place on your development + system in order to do any development using the Yocto Project. + The name of the top-level directory of the Yocto Project file structure + is derived from the Yocto Project release tarball. + For example, downloading and unpacking poky-edison-6.0.tar.bz2 + results in a Yocto Project source tree whose Yocto Project source directory is named + poky-edison-6.0. + 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 the Yocto Project builds images. + The area is created when you source the Yocto Project setup + environment script that is found in the Yocto Project files area. + (e.g. oe-init-build-env). + You can create the Yocto Project build tree anywhere you want on your + development system. + Here is an example that creates the tree in mybuilds + and names the Yocto Project build directory YP-6.0: + + $ source poky-edison-6.0/oe-init-build-env $HOME/mybuilds/YP-6.0 + + If you don't specifically name the build directory, then BitBake creates it + in the current directory and uses the name build. + Also, if you supply an existing directory, then BitBake uses that + directory as the Yocto Project build directory and populates the build tree + beneath it. + + +
+
Installing the ADT The following list describes how you can install the ADT, which includes the cross-toolchain. - Regardless of the installation you choose, however, you must source the cross-toolchain + Regardless of the installation you choose, you must source the cross-toolchain environment setup script before you use the toolchain. - See the “Setting Up the Environment” + See the "Setting Up the Environment" section for more information. Use the ADT Installer Script: - This method is the recommended way to install the ADT because it - automates much of the process for you. - For example, you can configure the installation to install the QEMU emulator - and the user-space NFS, specify which root filesystem profiles to download, - and define the target sysroot location. - + This method is the recommended way to install the ADT because it + automates much of the process for you. + For example, you can configure the installation to install the QEMU emulator + and the user-space NFS, specify which root filesystem profiles to download, + and define the target sysroot location. 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 - get any of the other mentioned benefits had you run the ADT Installer script. + 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 + 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 - 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. + 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. @@ -92,32 +101,34 @@ The ADT Installer is contained in the ADT Installer tarball. You can download the tarball into any directory from - . - Or, you can use BitBake to generate the tarball inside the existing Yocto Project build tree. + . + Or, you can use BitBake to generate the tarball inside the existing Yocto Project + build tree. If you use BitBake to generate the ADT Installer tarball, you must - source the Yocto Project environment setup script located in the Yocto Project - files before running the BitBake command that creates the tarball. + source the Yocto Project environment setup script located + in the Yocto Project file structure before running the bitbake + command that creates the tarball. 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 + Project files structure, set up the environment while also creating the + default Yocto Project build tree, + and run the bitbake command that results in the tarball ~/yocto-project/build/tmp/deploy/sdk/adt_installer.tar.bz2: $ cd ~ $ mkdir yocto-project $ cd yocto-project - $ wget http://www.yoctoproject.org/downloads/poky/poky-bernard-5.0.1.tar.bz2 - $ tar xjf poky-bernard-5.0.1.tar.bz2 - $ source poky-bernard-5.0.1/poky-init-build-env poky-5.0.1-build + $ wget http://www.yoctoproject.org/downloads/poky/poky-edison-6.0.tar.bz2 + $ tar xjf poky-edison-6.0.tar.bz2 + $ source poky-edison-6.0/oe-init-build-env $ bitbake adt-installer -
@@ -138,57 +149,50 @@ The following list describes the configurations you can define for the ADT Installer. - For configuration values and restrictions see the comments in + For configuration values and restrictions, see the comments in the adt-installer.conf file: - YOCTOADT_IPKG_REPO – This area - includes the IPKG-based packages and the root filesystem upon which - the installation is based. - If you want to set up your own IPKG repository pointed to by - YOCTOADT_IPKG_REPO, you need to be sure that the - directory structure follows the same layout as the reference directory - set up at . - Also, your repository needs to be accessible through HTTP. - - YOCTOADT-TARGETS – The machine - target architectures for which you want to set up cross-development - environments. - - YOCTOADT_QEMU – Indicates whether - or not to install the emulator QEMU. - - YOCTOADT_NFS_UTIL – Indicates whether - or not to install user-mode NFS. - If you plan to use the Yocto Eclipse IDE plug-in against QEMU, - 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. - 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. - - - YOCTOADT_ROOTFS_<arch> - The root - filesystem images you want to download from the YOCTOADT_IPKG_REPO - repository. - - YOCTOADT_TARGET_SYSROOT_IMAGE_<arch> - The - particular root filesystem used to extract and create the target sysroot. - The value of this variable must have been specified with - YOCTOADT_ROOTFS_<arch>. - 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. - - YOCTOADT_TARGET_SYSROOT_LOC_<arch> - The - location on the development host where the target sysroot will be created. - + YOCTOADT_IPKG_REPO: This area + includes the IPKG-based packages and the root filesystem upon which + the installation is based. + If you want to set up your own IPKG repository pointed to by + YOCTOADT_IPKG_REPO, you need to be sure that the + directory structure follows the same layout as the reference directory + set up at . + Also, your repository needs to be accessible through HTTP. + YOCTOADT-TARGETS: The machine + target architectures for which you want to set up cross-development + environments. + YOCTOADT_QEMU: Indicates whether + or not to install the emulator QEMU. + YOCTOADT_NFS_UTIL: Indicates whether + or not to install user-mode NFS. + If you plan to use the Yocto Eclipse IDE plug-in against QEMU, + 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. + Please make sure you understand the security implications of doing this. + You might also have to modify your firewall settings to allow + NFS booting to work. + YOCTOADT_ROOTFS_<arch>: The root + filesystem images you want to download from the + YOCTOADT_IPKG_REPO repository. + YOCTOADT_TARGET_SYSROOT_IMAGE_<arch>: The + particular root filesystem used to extract and create the target sysroot. + The value of this variable must have been specified with + YOCTOADT_ROOTFS_<arch>. + 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. + YOCTOADT_TARGET_SYSROOT_LOC_<arch>: The + location on the development host where the target sysroot is created. + @@ -203,14 +207,16 @@ The ADT Installer requires the libtool package to complete. If you install the recommended packages as described in the - - Yocto Project Quick Start then you will have libtool installed. + + Packages section of + + The Yocto Project Quick Start, then you will have libtool installed. 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 + If you want to closely monitor the installation, choose “I” for interactive mode rather than “S” for silent mode. Follow the prompts from the script to complete the installation. @@ -224,12 +230,12 @@ according to the YOCTOADT_TARGET_SYSROOT_LOC_<arch> variable also in your configuration file. - -
+
Using a Cross-Toolchain Tarball + If you want to simply install the cross-toolchain by hand, you can do so by using an existing cross-toolchain tarball. @@ -240,69 +246,73 @@ Follow these steps: 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). - + + and find the folder that matches your host development system + (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 - x86_64 folder and download the following tarball: - + 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-based target, go into the + x86_64 folder and download the following tarball: + yocto-eglibc-x86_64-arm-toolchain-gmae-1.1.tar.bz2 - - - 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 - files. - When the bitbake command completes, the toolchain tarball will - be in tmp/deploy/sdk in the 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 oe-build-init script located in the Yocto + Project 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. - You will notice environment setup files for the cross-toolchain in the directory. - + the tarball. + The tarball expands into /opt/poky/$SDKVERSION. + Once the tarball in unpacked, the cross-toolchain is installed. + You will notice environment setup files for the cross-toolchain in the directory. +
Using BitBake and the Yocto Project Build Tree + A final way of installing just the cross-toolchain is to use BitBake within an existing Yocto Project build tree. Follow these steps: Source the environment setup script located in the Yocto Project - 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 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 - than a single architecture. - You just need to edit the MACHINE variable in the - local.conf file and re-run the BitBake command. + 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 found in the Yocto Project + file structure's conf 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 + than a single architecture. + You just need to edit the MACHINE variable in the + local.conf file and re-run the BitBake + command. 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. - 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. - You will notice environment setup files for the cross-toolchain in the - Yocto Project build tree in the tmp directory. - Setup script filenames contain the strings environment-setup. - + 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. + 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. + You will notice environment setup files for the cross-toolchain in the + Yocto Project build tree in the tmp directory. + Setup script filenames contain the strings environment-setup. +
@@ -310,6 +320,7 @@
Setting Up the Environment + Before you can use the cross-toolchain, you need to set up the toolchain environment by sourcing the environment setup script. @@ -324,8 +335,8 @@ Be sure to run the environment setup script that matches the architecture for which you are developing. - Environment setup scripts begin with the string “environment-setup” and include as - part of their name the architecture. + Environment setup scripts begin with the string “environment-setup” + and include as part of their name the architecture. For example, the environment setup script for a 64-bit IA-based architecture would be the following: @@ -336,20 +347,22 @@
Kernels and Filesystem Images + You will need to have a kernel and filesystem image to boot using your hardware or the QEMU emulator. That means you either have to build them or know where to get them. You can find lots of details on how to get or build images and kernels for your - architecture in the "Yocto Project Quick Start" found at - . + architecture in + + The Yocto Project Quick Start. - Yocto Project provides basic kernels and filesystem images for several + The 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. These kernels and filesystem images reside in the Yocto Project release - area - + area - and are ideal for experimentation within Yocto Project. -- cgit v1.2.3-54-g00ecf