From 50021cba20a09b1ed685db5466f940b17d4880ac Mon Sep 17 00:00:00 2001 From: Richard Purdie Date: Wed, 20 Apr 2011 14:20:19 +0100 Subject: Drop documentation directory, this is replaced by the new yocto-docs repository --- documentation/adt-manual/Makefile | 42 - documentation/adt-manual/adt-command.xml | 66 -- documentation/adt-manual/adt-eclipse.xml | 435 --------- documentation/adt-manual/adt-intro.xml | 117 --- .../adt-manual/adt-manual-customization.xsl | 8 - documentation/adt-manual/adt-manual.xml | 70 -- documentation/adt-manual/adt-package.xml | 82 -- documentation/adt-manual/adt-prepare.xml | 244 ------ documentation/adt-manual/figures/adt-title.png | Bin 14349 -> 0 bytes .../adt-manual/figures/yocto-project-transp.png | Bin 8626 -> 0 bytes documentation/adt-manual/style.css | 968 --------------------- 11 files changed, 2032 deletions(-) delete mode 100644 documentation/adt-manual/Makefile delete mode 100644 documentation/adt-manual/adt-command.xml delete mode 100644 documentation/adt-manual/adt-eclipse.xml delete mode 100644 documentation/adt-manual/adt-intro.xml delete mode 100644 documentation/adt-manual/adt-manual-customization.xsl delete mode 100644 documentation/adt-manual/adt-manual.xml delete mode 100644 documentation/adt-manual/adt-package.xml delete mode 100644 documentation/adt-manual/adt-prepare.xml delete mode 100644 documentation/adt-manual/figures/adt-title.png delete mode 100755 documentation/adt-manual/figures/yocto-project-transp.png delete mode 100644 documentation/adt-manual/style.css (limited to 'documentation/adt-manual') diff --git a/documentation/adt-manual/Makefile b/documentation/adt-manual/Makefile deleted file mode 100644 index 74e35bcde..000000000 --- a/documentation/adt-manual/Makefile +++ /dev/null @@ -1,42 +0,0 @@ -XSLTOPTS = --stringparam html.stylesheet style.css \ - --stringparam chapter.autolabel 1 \ - --stringparam appendix.autolabel A \ - --stringparam section.autolabel 1 \ - --stringparam section.label.includes.component.label 1 \ - --xinclude - -## -# These URI should be rewritten by your distribution's xml catalog to -# match your localy installed XSL stylesheets. -XSL_BASE_URI = http://docbook.sourceforge.net/release/xsl/current -XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl - -all: html pdf tarball - -pdf: - ../tools/poky-docbook-to-pdf adt-manual.xml ../template - -## -# These URI should be rewritten by your distribution's xml catalog to -# match your localy installed XSL stylesheets. - -html: -# See http://www.sagehill.net/docbookxsl/HtmlOutput.html - -# xsltproc $(XSLTOPTS) -o adt-manual.html $(XSL_XHTML_URI) adt-manual.xml - xsltproc $(XSLTOPTS) -o adt-manual.html adt-manual-customization.xsl adt-manual.xml - -tarball: html - tar -cvzf adt-manual.tgz adt-manual.html adt-manual.pdf style.css figures/adt-title.png figures/yocto-project-transp.png - -validate: - xmllint --postvalid --xinclude --noout adt-manual.xml - -OUTPUTS = adt-manual.tgz adt-manual.html adt-manual.pdf -SOURCES = *.png *.xml *.css - -publish: - scp -r $(OUTPUTS) $(SOURCES) o-hand.com:/srv/www/pokylinux.org/doc/ - -clean: - rm -f $(OUTPUTS) diff --git a/documentation/adt-manual/adt-command.xml b/documentation/adt-manual/adt-command.xml deleted file mode 100644 index e57c15a98..000000000 --- a/documentation/adt-manual/adt-command.xml +++ /dev/null @@ -1,66 +0,0 @@ - - - -Using the Command Line - - Recall that earlier we talked about how to use an existing toolchain - tarball that had been installed into /opt/poky, - which is outside of the Poky build environment - (see - “Using an Existing Toolchain Tarball”). - And, that sourcing your architecture-specific environment setup script - initializes a suitable development environment. - This setup occurs by adding the compiler, QEMU scripts, QEMU binary, - a special version of pkgconfig and other useful - utilities to the PATH variable. - Variables to assist pkgconfig and autotools are also defined so that, - for example, configure.sh can find pre-generated - test results for tests that need target hardware on which to run. - These conditions allow you to easily use the toolchain outside of the - Poky build environment on both autotools-based projects and - makefile-based projects. - - -
-Autotools-Based Projects - - For an autotools-based project you can use the cross-toolchain by just - passing the appropriate host option to configure.sh. - The host option you use is derived from the name of the environment setup - script in /opt/poky resulting from unpacking the - cross-toolchain tarball. - For example, the host option for an ARM-based target that uses the GNU EABI - is armv5te-poky-linux-gnueabi. - Note that the name of the script is - environment-setup-armv5te-poky-linux-gnueabi. - Thus, the following command works: - - $ configure ‐‐host-armv5te-poky-linux-gnueabi ‐‐with-libtool-sysroot=<sysroot-dir> - - - - This single command updates your project and rebuilds it using the appropriate - cross-toolchain tools. - -
- -
-Makefile-Based Projects - - For a makefile-based project you use the cross-toolchain by making sure - the tools are used. - You can do this as follows: - - CC=arm-poky-linux-gnueabi-gcc - LD=arm-poky-linux-gnueabi-ld - CFLAGS=”${CFLAGS} ‐‐sysroot=<sysroot-dir>” - CXXFLAGS=”${CXXFLAGS} ‐‐sysroot=<sysroot-dir>” - - -
- - - diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml deleted file mode 100644 index ee305fe58..000000000 --- a/documentation/adt-manual/adt-eclipse.xml +++ /dev/null @@ -1,435 +0,0 @@ - - - -Working Within Eclipse - - The Eclipse IDE is a popular development environment and it fully supports - development using Yocto Project. - When you install and configure the Eclipse Yocto Project Plug-in into - the Eclipse IDE you maximize your Yocto Project design experience. - Installing and configuring the Plug-in results in an environment that - has extensions specifically designed to let you more easily develop software. - These extensions allow for cross-compilation and deployment and execution of - your output into a QEMU emulation session. - You can also perform cross-debugging and profiling. - The environment also has a suite of tools that allows you to perform - remote profiling, tracing, collection of power data, collection of - latency data, and collection of performance data. - - - This section describes how to install and configure the Eclipse IDE - Yocto Plug-in and how to use it to develop your Yocto Project. - - -
- Setting Up the Eclipse IDE - - To develop within the Eclipse IDE you need to do the following: - - Be sure the optimal version of Eclipse IDE - is installed. - Install required Eclipse plug-ins prior to installing - the Eclipse Yocto Plug-in. - Configure the Eclipse Yocto Plug-in. - - - -
- Installing Eclipse IDE - - It is recommended that you have the Helios 3.6.1 version of the - Eclipse IDE installed on your development system. - If you don’t have this version you can find it at - . - From that site, choose the Eclipse Classic version. - This version contains the Eclipse Platform, the Java Development - Tools (JDT), and the Plug-in Development Environment. - - - Once you have downloaded the tarball, extract it into a clean - directory and complete the installation. - - - One issue exists that you need to be aware of regarding the Java - Virtual machine’s garbage collection (GC) process. - The GC process does not clean up the permanent generation - space (PermGen). - This space stores meta-data descriptions of classes. - The default value is set too small and it could trigger an - out-of-memory error such as the following: - - Java.lang.OutOfMemoryError: PermGen space - - - - This error causes the application to hang. - - - To fix this issue you can use the ‐‐vmargs option when you start - Eclipse to increase the size of the permanent generation space: - - eclipse ‐‐vmargs ‐‐XX:PermSize=256M - - -
- -
- Installing Required Plug-ins and the Eclipse Yocto Plug-in - - Before installing the Yocto Plug-in you need to be sure that the - CDT 7.0, RSE 3.2, and Autotools plug-ins are all installed in the - following order. - After installing these three plug-ins, you can install the - Eclipse Yocto Plug-in. - Use the following URLs for the plug-ins: - - CDT 7.0 – - : - For CDT main features select the checkbox so you get all items. - For CDT optional features expand the selections and check - “C/C++ Remote Launch”. - RSE 3.2 – - : - Check the box next to “TM and RSE Main Features” so you select all - those items. - Note that all items in the main features depend on 3.2.1 version. - Expand the items under “TM and RSE Uncategorized 3.2.1” and - select the following: “Remote System Explorer End-User Runtime”, - “Remote System Explorer Extended SDK”, “Remote System Explorer User Actions”, - “RSE Core”, “RSE Terminals UI”, and “Target Management Terminal”. - Autotools – - : - Expand the items under “Linux Tools” and select “Autotools support for - CDT (Incubation)”. - Yocto Plug-in – - : - Check the box next to “Development tools & SDKs for Yocto Linux” - to select all the items. - - - - Follow these general steps to install a plug-in: - - From within the Eclipse IDE select the - “Install New Software” item from the “Help” menu. - Click “Add…” in the “Work with:” area. - Enter the URL for the repository and leave the “Name” - field blank. - Check the boxes next to the software you need to - install and then complete the installation. - For information on the specific software packages you need to include, - see the previous list. - - -
- -
- Configuring the Plug-in - - Configuring the Eclipse Yocto Plug-in involves choosing the Cross - Compiler Options, selecting the Target Architecture, and choosing - the Target Options. - These settings are the default settings for all projects. - You do have opportunities to change them later if you choose to when - you configure the project. - See “Configuring the Cross Toolchain” section later in the manual. - - - To start, you need to do the following from within the Eclipse IDE: - - Choose Windows -> Preferences to display - the Preferences Dialog - Click “Yocto SDK” - - - -
- Configuring the Cross-Compiler Options - - Choose between ‘SDK Root Mode’ and ‘Poky Tree Mode’ for Cross - Compiler Options. - - SDK Root Mode – Select this mode - when you are not concerned with building an image or you do not have - a Poky build tree on your system. - For example, suppose you are an application developer and do not - need to build an image. - You just want to use an architecture-specific toolchain on an - existing kernel and root filesystem. - When you use SDK Root Mode you are using the toolchain installed - in the /opt/poky directory. - Poky Tree Mode – Select this mode - if you are concerned with building images for hardware or your - development environment already has a build tree. - In this case you likely already have a Poky build tree installed on - your system or you (or someone else) will be building one. - When you use the Poky Tree Mode you are using the toolchain bundled - inside the Poky build tree. - If you use this mode you must also supply the Poky Root Location - in the Preferences Dialog. - - -
- -
- Configuring the Sysroot - - Specify the sysroot, which is used by both the QEMU user-space - NFS boot process and by the cross-toolchain regardless of the - mode you select (SDK Root Mode or Poky Tree Mode). - For example, sysroot is the location to which you extract the - downloaded image’s root filesystem to through the ADT Installer. - -
- -
- Selecting the Target Architecture - - Use the pull-down Target Architecture menu and select the - target architecture. - - - The Target Architecture is the type of hardware you are - going to use or emulate. - This pull-down menu should have the supported architectures. - If the architecture you need is not listed in the menu then you - will need to re-visit - - “Preparing to Use the Application Development Toolkit (ADT)” - section earlier in this document. - -
- -
- Choosing the Target Options - - You can choose to emulate hardware using the QEMU emulator, or you - can choose to use actual hardware. - - External HW – Select this option - if you will be using actual hardware. - QEMU – Select this option if - you will be using the QEMU emulator. - If you are using the emulator you also need to locate the Kernel - and you can specify custom options. - In Poky Tree Mode the kernel you built will be located in the - Poky Build tree in tmp/deploy/images directory. - In SDK Root Mode the pre-built kernel you downloaded is located - in the directory you specified when you downloaded the image. - Most custom options are for advanced QEMU users to further - customize their QEMU instance. - These options are specified between paired angled brackets. - Some options must be specified outside the brackets. - In particular, the options serial, - nographic, and kvm must all - be outside the brackets. - Use the man qemu command to get help on all the options - and their use. - The following is an example: - - serial ‘<-m 256 -full-screen>’ - - - - Regardless of the mode, Sysroot is already defined in the “Sysroot” - field. - - - - Click the “OK” button to save your plug-in configurations. - -
-
-
- -
-Creating the Project - - You can create two types of projects: Autotools-based, or Makefile-based. - This section describes how to create autotools-based projects from within - the Eclipse IDE. - For information on creating projects in a terminal window see - “Using the Command Line” - section. - - - To create a project based on a Yocto template and then display the source code, - follow these steps: - - Select File -> New -> Project. - Double click “CC++”. - Double click “C Project” to create the project. - Double click “Yocto SDK Project”. - Select “Hello World ANSI C Autotools Project”. - This is an Autotools-based project based on a Yocto Project template. - Put a name in the “Project name:” field. - Click “Next”. - Add information in the “Author” field. - Use “GNU General Public License v2.0” for the License. - Click “Finish”. - Answer ‘Yes” to the open perspective prompt. - In the Project Explorer expand your project. - Expand ‘src’. - Double click on your source file and the code appears - in the window. - This is the template. - - -
- -
-Configuring the Cross-Toolchains - - The previous section, - “Configuring the Cross-Compiler Options”, set up the default project - configurations. - You can change these settings for a given project by following these steps: - - Select Project -> Invoke Yocto Tools -> Reconfigure Yocto. - This brings up the project Yocto Settings Dialog. - Settings are inherited from the default project configuration. - The information in this dialogue is identical to that chosen earlier - for the Cross Compiler Option (SDK Root Mode or Poky Tree Mode), - the Target Architecture, and the Target Options. - The settings are inherited from the Yocto Plug-in configuration performed - after installing the plug-in. - Select Project -> Reconfigure Project. - This runs the autogen.sh in the workspace for your project. - The script runs libtoolize, aclocal, - autoconf, autoheader, - automake ‐‐a, and - ./configure. - - -
- -
-Building the Project - - To build the project, select Project -> Build Project. - You should see the console updated and you can note the cross-compiler you are using. - -
- -
-Starting QEMU in User Space NFS Mode - - To start the QEMU emulator from within Eclipse, follow these steps: - - Select Run -> External Tools -> External Tools Configurations... - This selection brings up the External Tools Configurations Dialogue. - Go to the left navigation area and expand ‘Program’. - You should find the image listed. - For example, qemu-x86_64-poky-linux. - Click on the image. - This brings up a new environment in the main area of the External - Tools Configurations Dialogue. - The Main tab is selected. - Click “Run” next. - This brings up a shell window. - Enter your host root password in the shell window at the prompt. - This sets up a Tap 0 connection needed for running in user-space NFS mode. - Wait for QEMU to launch. - Once QEMU launches you need to determine the IP Address - for the user-space NFS. - You can do that by going to a terminal in the QEMU and entering the - ipconfig command. - - -
- -
-Deploying and Debugging the Application - - Once QEMU is running you can deploy your application and use the emulator - to perform debugging. - Follow these steps to deploy the application. - - Select Run -> Debug Configurations... - In the left area expand “C/C++Remote Application”. - Locate your project and select it to bring up a new - tabbed view in the Debug Configurations dialogue. - Enter the absolute path into which you want to deploy - the application. - Use the Remote Absolute File Path for C/C++Application:. - For example, enter /usr/bin/<programname>. - Click on the Debugger tab to see the cross-tool debugger - you are using. - Create a new connection to the QEMU instance - by clicking on “new”. - Select “TCF, which means Target Communication Framework. - Click “Next”. - Clear out the “host name” field and enter the IP Address - determined earlier. - Click Finish to close the new connections dialogue. - Use the drop-down menu now in the “Connection” field and pick - the IP Address you entered. - Click “Debug” to bring up a login screen and login. - Accept the debug perspective. - - -
- -
-Running User-Space Tools - - As mentioned earlier in the manual several tools exist that enhance - your development experience. - These tools are aids in developing and debugging applications and images. - You can run these user-space tools from within the Yocto Eclipse - Plug-in through the Window -> YoctoTools menu. - - - Once you pick a tool you need to configure it for the remote target. - Every tool needs to have the connection configured. - You must select an existing TCF-based RSE connection to the remote target. - If one does not exist, click "New" to create one. - - - Here are some specifics about the remote tools: - - OProfile: Selecting this tool causes - the oprofile-server on the remote target to launch on the local host machine. - The oprofile-viewer must be installed on the local host machine and the - oprofile-server must be installed on the remote target, respectively, in order - to use. - You can locate both the viewer and server from - . - You need to compile and install the oprofile-viewer from the source code - on your local host machine. - The oprofile-server is installed by default in the image. - Lttng-ust: Selecting this tool runs - "usttrace" on the remote target, transfers the output data back to the - local host machine and uses "lttv-gui" to graphically display the output. - The "lttv-gui" must be installed on the local host machine to use this tool. - For information on how to use "lttng" to trace an application, see - . - For "Application" you must supply the absolute path name of the - application to be traced by user mode lttng. - For example, typing /path/to/foo triggers - usttrace /path/to/foo on the remote target to trace the - program /path/to/foo. - "Argument" is passed to usttrace - running on the remote target. - PowerTOP: Selecting this tool runs - "PowerTOP" on the remote target machine and displays the results in a - new view called "powertop". - "Time to gather data(sec):" is the time passed in seconds before data - is gathered from the remote target for analysis. - "show pids in wakeups list:" corresponds to the -p argument - passed to "powertop". - LatencyTOP and Perf: "LatencyTOP" - identifies system latency, while "perf" monitors the system's - performance counter registers. - Selecting either of these tools causes an RSE terminal view to appear - from which you can run the tools. - Both tools refresh the entire screen to display results while they run. - - -
- - - diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml deleted file mode 100644 index 8740e5cf3..000000000 --- a/documentation/adt-manual/adt-intro.xml +++ /dev/null @@ -1,117 +0,0 @@ - - - - -Application Development Toolkit (ADT) User's Guide - - - Welcome to the Application Development Toolkit User’s Guide. This manual provides - information that lets you get going with the ADT to develop projects using the Yocto - Project. - - -
- Introducing the Application Development Toolkit (ADT) - - Fundamentally, the ADT consists of an architecture-specific cross-toolchain and - a matching sysroot that are both built by the Poky build system. - The toolchain and sysroot are based on a metadata configuration and extensions, - which allows you to cross develop for the target on the host machine. - - - Additionally, to provide an effective development platform, the Yocto Project - makes available and suggests other tools as part of the ADT. - These other tools include the Eclipse IDE Yocto Plug-in, an emulator (QEMU), - and various user-space tools that greatly enhance your development experience. - - - The resulting combination of the architecture-specific cross-toolchain and sysroot - along with these additional tools yields a custom-built, cross-development platform - for a user-targeted product. - - -
- The Cross-Toolchain - - The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger - that are all generated through a Poky build that is based on your metadata - configuration or extension for your targeted device. - The cross-toolchain works with a matching target sysroot. - -
- -
- Sysroot - - The matching target sysroot contains needed headers and libraries for generating - binaries that run on the target architecture. - The sysroot is based on the target root filesystem image that is built by - Poky and uses the same metadata configuration used to build the cross-toolchain. - -
- -
- The QEMU Emulator - - The QEMU emulator allows you to simulate your hardware while running your - application or image. - QEMU is installed several ways: as part of the Poky tree, ADT installation - through a toolchain tarball, or through the ADT Installer. - -
- -
- User-Space Tools - - User-space tools are included as part of the distribution. - You will find these tools helpful during development. - The tools include LatencyTOP, PowerTOP, OProfile, Perf, SystemTap, and Lttng-ust. - These tools are common development tools for the Linux platform. - - LatencyTOP – LatencyTOP focuses on latency - that causes skips in audio, - stutters in your desktop experience, or situations that overload your server - even when you have plenty of CPU power left. - You can find out more about LatencyTOP at - . - - 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 - . - - Perf – Performance counters for Linux used - to keep track of certain - types of hardware and software events. - For more information on these types of counters see - and click - on “Perf tools.” - - SystemTap – A free software infrastructure - that simplifies - information gathering about a running Linux system. - This information helps you diagnose performance or functional problems. - SystemTap is not available as a user-space tool through the Yocto Eclipse IDE Plug-in. - See for more information - on SystemTap. - - Lttng-ust – A User-space Tracer designed to - provide detailed information on user-space activity. - See for more information on Lttng-ust. - - - -
-
- - - diff --git a/documentation/adt-manual/adt-manual-customization.xsl b/documentation/adt-manual/adt-manual-customization.xsl deleted file mode 100644 index 8eb69050b..000000000 --- a/documentation/adt-manual/adt-manual-customization.xsl +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/documentation/adt-manual/adt-manual.xml b/documentation/adt-manual/adt-manual.xml deleted file mode 100644 index 7182d037a..000000000 --- a/documentation/adt-manual/adt-manual.xml +++ /dev/null @@ -1,70 +0,0 @@ - - - - - - - - - - - - - - - - Jessica Zhang - - Intel Corporation - - jessica.zhang@intel.com - - - - - - 1.0 - 6 April 2011 - Initial Document released with Yocto Project 1.0 on 6 April 2011. - - - - - 2010-2011 - Linux Foundation - - - - - Permission is granted to copy, distribute and/or modify this document under - the terms of the Creative Commons Attribution-Share Alike 2.0 UK: England & Wales as published by Creative Commons. - - - - - - - - - - - - - - - - - - - diff --git a/documentation/adt-manual/adt-package.xml b/documentation/adt-manual/adt-package.xml deleted file mode 100644 index fc2a1a0cb..000000000 --- a/documentation/adt-manual/adt-package.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - -Optionally Customizing the Development Packages Installation - - Because the Yocto Project is suited for embedded Linux development it is - likely that you will need to customize your development packages installation. - For example, if you are developing a minimal image then you might not need - certain packages (e.g. graphics support packages). - Thus, you would like to be able to remove those packages from your sysroot. - - -
- Package Management Systems - - The Yocto Project supports the generation of root filesystem files using - three different Package Management Systems (PMS): - - OPKG – A less well known PMS whose use - originated in the OpenEmbedded and OpenWrt embedded Linux projects. - This PMS works with files packaged in an .ipk format. - See for more - information about OPKG. - RPM – A more widely known PMS intended for GNU/Linux - distributions. - This PMS works with files packaged in an .rms format. - The Yocto Project currently installs through this PMS by default. - See - for more information about RPM. - Debian – The PMS for Debian-based systems - is built on many PMS tools. - The lower-level PMS tool dpkg forms the base of the Debian PMS. - For information on dpkg see - . - - -
- -
- Configuring the PMS - - Whichever PMS you are using you need to be sure that the - PACKAGE_CLASSES variable in the conf/local.conf - file is set to reflect that system. - The first value you choose for the variable specifies the package file format for the root - filesystem. - Additional values specify additional formats for convenience or testing. - See the configuration file for details. - - - As an example, consider a scenario where you are using OPKG and you want to add - the libglade package to sysroot. - - - First, you should generate the ipk file for the libglade package and add it - into a working opkg repository. - Use these commands: - - $ bitbake libglade - $ bitbake package-index - - - - Next, source the environment setup script. - Follow that by setting up the installation destination to point to your - sysroot as <sysroot dir>. - Finally, have an opkg configuration file <conf file> - that corresponds to the opkg repository you have just created. - The following command forms should now work: - - $ opkg-cl –f <conf file> -o <sysroot dir> update - $ opkg-cl –f <conf file>> -o <sysroot dir> --force-overwrite install libglade - $ opkg-cl –f <conf file> -o <sysroot dir> --force-overwrite install libglade-dbg - $ opkg-cl –f <conf file> -o <sysroot dir> --force-overwrite install libglade-dev - - -
- - diff --git a/documentation/adt-manual/adt-prepare.xml b/documentation/adt-manual/adt-prepare.xml deleted file mode 100644 index f27f603e1..000000000 --- a/documentation/adt-manual/adt-prepare.xml +++ /dev/null @@ -1,244 +0,0 @@ - - - - -Preparing to Use the Application Development Toolkit (ADT) - - - In order to use the ADT it must be installed, the environment setup script must be - sourced, and the kernel and filesystem image specific to the target architecture must exist. - This section describes how to install the ADT, set up the environment, and provides - some reference information on kernels and filesystem images. - - -
- Installing the ADT - - You can install the ADT three ways. - However, we recommend configuring and running the ADT Installer script. - Running this script automates much of the process for you. - For example, the script allows you to install the QEMU emulator and - user-space NFS, define which root filesystem profiles to download, - and allows you to define the target sysroot location. - - - If you need to generate the ADT tarball you can do so using the following command: - - $ bitbake adt-installer - - This command generates the file adt-installer.tar.bz2 - in the ../build/tmp/deploy/sdk directory. - - -
- Configuring and Running the ADT Installer - - The ADT Installer is contained in a tarball that can be built using - bitbake adt-installer. - Yocto Project has a pre-built ADT Installer tarball that you can download - from tmp/deploy/sdk located in the build directory. - - - - You can install and run the ADT Installer tarball in any directory you want. - - - - Before running the ADT Installer you need to configure it by editing - the adt-installer.conf file, which is located in the - directory where the ADT Installer tarball was installed. - Your configurations determine which kernel and filesystem image are downloaded. - The following list describes the variables you can define for the ADT Installer. - 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. - - YOCTOADT_TARGET_SYSROOT_IMAGE_<arch> - The - root filesystem used to extract and create the target sysroot. - - YOCTOADT_TARGET_SYSROOT_LOC_<arch> - The - location of the target sysroot that will be set up on the development machine. - - - - - - After you have configured the adt-installer.conf file, - run the installer using the following command: - - $ adt_installer - - - - - 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. - Follow the prompts from the script to complete the installation. - - - - Once the installation completes, the cross-toolchain is installed in - /opt/poky/$SDKVERSION. - - - - Before using the ADT you need to run the environment setup script for - your target architecture also located in /opt/poky/$SDKVERSION. - See the “Setting Up the Environment” - section for information. - -
- -
- Using an Existing Toolchain Tarball - - If you do not want to use the ADT Installer you can install the toolchain - and the sysroot by hand. - Follow these steps: - - Locate and download the architecture-specific toolchain - tarball from . - Look in the ‘toolchain’ folder and then open up the folder that matches your - host development system (i.e. 'i686' for 32-bit machines or 'x86_64' - for 64-bit machines). - Then, select the toolchain tarball whose name includes the appropriate - target architecture. - - If you need to build the toolchain tarball use the - bitbake meta-toolchain command after you have - sourced the poky-build-init script. - The tarball will be located in the build directory at - tmp/deploy/sdk after the build. - - - Make sure you are in the root directory and then expand - the tarball. - The tarball expands into the /opt/poky/$SDKVERSION directory. - - Set up the environment by sourcing the environment set up - script. - See the “Setting Up the Environment” - for information. - - - -
- -
- Using the Toolchain from Within the Build Tree - - A final way of accessing the toolchain is from the build tree. - The build tree can be set up to contain the architecture-specific cross toolchain. - To populate the build tree with the toolchain you need to run the following command: - - $ bitbake meta-ide-support - - - - - Before running the command you need to be sure that the - conf/local.conf file in the build directory has - the desired architecture specified for the MACHINE - variable. - See the local.conf file for a list of values you - can supply for this variable. - You can populate the build tree with the cross-toolchains for more - than a single architecture. - You just need to edit the local.conf file and re-run - the BitBake command. - - - - Once the build tree has the toolchain you need to source the environment - setup script so that you can run the cross-tools without having to locate them. - See the “Setting Up the Environment” - for information. - -
-
- -
- Setting Up the Environment - - Before you can use the cross-toolchain you need to set up the environment by - sourcing the environment setup script. - If you used 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 are using the ADT from a Poky build tree, then look in the build - directory in tmp for the setup script. - - - - 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. - For example, the environment setup script for a 64-bit IA-based architecture would - be the following: - - /opt/poky/environment-setup-x86_64-poky-linux - - -
- -
- 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 - . - - Yocto Project provides basic kernels and filesystem images for several - architectures (x86, x86-64, mips, powerpc, and arm) that can be used - 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. - - -
- - - diff --git a/documentation/adt-manual/figures/adt-title.png b/documentation/adt-manual/figures/adt-title.png deleted file mode 100644 index fe6ed26dc..000000000 Binary files a/documentation/adt-manual/figures/adt-title.png and /dev/null differ diff --git a/documentation/adt-manual/figures/yocto-project-transp.png b/documentation/adt-manual/figures/yocto-project-transp.png deleted file mode 100755 index 31d2b147f..000000000 Binary files a/documentation/adt-manual/figures/yocto-project-transp.png and /dev/null differ diff --git a/documentation/adt-manual/style.css b/documentation/adt-manual/style.css deleted file mode 100644 index 7c24fe5d2..000000000 --- a/documentation/adt-manual/style.css +++ /dev/null @@ -1,968 +0,0 @@ -/* - Generic XHTML / DocBook XHTML CSS Stylesheet. - - Browser wrangling and typographic design by - Oyvind Kolas / pippin@gimp.org - - Customised for Poky by - Matthew Allum / mallum@o-hand.com - - Thanks to: - Liam R. E. Quin - William Skaggs - Jakub Steiner - - Structure - --------- - - The stylesheet is divided into the following sections: - - Positioning - Margins, paddings, width, font-size, clearing. - Decorations - Borders, style - Colors - Colors - Graphics - Graphical backgrounds - Nasty IE tweaks - Workarounds needed to make it work in internet explorer, - currently makes the stylesheet non validating, but up until - this point it is validating. - Mozilla extensions - Transparency for footer - Rounded corners on boxes - -*/ - - - /*************** / - / Positioning / -/ ***************/ - -body { - font-family: Verdana, Sans, sans-serif; - - min-width: 640px; - width: 80%; - margin: 0em auto; - padding: 2em 5em 5em 5em; - color: #333; -} - -.reviewer { - color: red; -} - -h1,h2,h3,h4,h5,h6,h7 { - font-family: Arial, Sans; - color: #00557D; - clear: both; -} - -h1 { - font-size: 2em; - text-align: left; - padding: 0em 0em 0em 0em; - margin: 2em 0em 0em 0em; -} - -h2.subtitle { - margin: 0.10em 0em 3.0em 0em; - padding: 0em 0em 0em 0em; - font-size: 1.8em; - padding-left: 20%; - font-weight: normal; - font-style: italic; -} - -h2 { - margin: 2em 0em 0.66em 0em; - padding: 0.5em 0em 0em 0em; - font-size: 1.5em; - font-weight: bold; -} - -h3.subtitle { - margin: 0em 0em 1em 0em; - padding: 0em 0em 0em 0em; - font-size: 142.14%; - text-align: right; -} - -h3 { - margin: 1em 0em 0.5em 0em; - padding: 1em 0em 0em 0em; - font-size: 140%; - font-weight: bold; -} - -h4 { - margin: 1em 0em 0.5em 0em; - padding: 1em 0em 0em 0em; - font-size: 120%; - font-weight: bold; -} - -h5 { - margin: 1em 0em 0.5em 0em; - padding: 1em 0em 0em 0em; - font-size: 110%; - font-weight: bold; -} - -h6 { - margin: 1em 0em 0em 0em; - padding: 1em 0em 0em 0em; - font-size: 80%; - font-weight: bold; -} - -.authorgroup { - background-color: transparent; - background-repeat: no-repeat; - padding-top: 256px; - background-image: url("figures/adt-title.png"); - background-position: left top; - margin-top: -256px; - padding-right: 50px; - margin-left: 0px; - text-align: right; - width: 740px; -} - -h3.author { - margin: 0em 0me 0em 0em; - padding: 0em 0em 0em 0em; - font-weight: normal; - font-size: 100%; - color: #333; - clear: both; -} - -.author tt.email { - font-size: 66%; -} - -.titlepage hr { - width: 0em; - clear: both; -} - -.revhistory { - padding-top: 2em; - clear: both; -} - -.toc, -.list-of-tables, -.list-of-examples, -.list-of-figures { - padding: 1.33em 0em 2.5em 0em; - color: #00557D; -} - -.toc p, -.list-of-tables p, -.list-of-figures p, -.list-of-examples p { - padding: 0em 0em 0em 0em; - padding: 0em 0em 0.3em; - margin: 1.5em 0em 0em 0em; -} - -.toc p b, -.list-of-tables p b, -.list-of-figures p b, -.list-of-examples p b{ - font-size: 100.0%; - font-weight: bold; -} - -.toc dl, -.list-of-tables dl, -.list-of-figures dl, -.list-of-examples dl { - margin: 0em 0em 0.5em 0em; - padding: 0em 0em 0em 0em; -} - -.toc dt { - margin: 0em 0em 0em 0em; - padding: 0em 0em 0em 0em; -} - -.toc dd { - margin: 0em 0em 0em 2.6em; - padding: 0em 0em 0em 0em; -} - -div.glossary dl, -div.variablelist dl { -} - -.glossary dl dt, -.variablelist dl dt, -.variablelist dl dt span.term { - font-weight: normal; - width: 20em; - text-align: right; -} - -.variablelist dl dt { - margin-top: 0.5em; -} - -.glossary dl dd, -.variablelist dl dd { - margin-top: -1em; - margin-left: 25.5em; -} - -.glossary dd p, -.variablelist dd p { - margin-top: 0em; - margin-bottom: 1em; -} - - -div.calloutlist table td { - padding: 0em 0em 0em 0em; - margin: 0em 0em 0em 0em; -} - -div.calloutlist table td p { - margin-top: 0em; - margin-bottom: 1em; -} - -div p.copyright { - text-align: left; -} - -div.legalnotice p.legalnotice-title { - margin-bottom: 0em; -} - -p { - line-height: 1.5em; - margin-top: 0em; - -} - -dl { - padding-top: 0em; -} - -hr { - border: solid 1px; -} - - -.mediaobject, -.mediaobjectco { - text-align: center; -} - -img { - border: none; -} - -ul { - padding: 0em 0em 0em 1.5em; -} - -ul li { - padding: 0em 0em 0em 0em; -} - -ul li p { - text-align: left; -} - -table { - width :100%; -} - -th { - padding: 0.25em; - text-align: left; - font-weight: normal; - vertical-align: top; -} - -td { - padding: 0.25em; - vertical-align: top; -} - -p a[id] { - margin: 0px; - padding: 0px; - display: inline; - background-image: none; -} - -a { - text-decoration: underline; - color: #444; -} - -pre { - overflow: auto; -} - -a:hover { - text-decoration: underline; - /*font-weight: bold;*/ -} - - -div.informalfigure, -div.informalexample, -div.informaltable, -div.figure, -div.table, -div.example { - margin: 1em 0em; - padding: 1em; - page-break-inside: avoid; -} - - -div.informalfigure p.title b, -div.informalexample p.title b, -div.informaltable p.title b, -div.figure p.title b, -div.example p.title b, -div.table p.title b{ - padding-top: 0em; - margin-top: 0em; - font-size: 100%; - font-weight: normal; -} - -.mediaobject .caption, -.mediaobject .caption p { - text-align: center; - font-size: 80%; - padding-top: 0.5em; - padding-bottom: 0.5em; -} - -.epigraph { - padding-left: 55%; - margin-bottom: 1em; -} - -.epigraph p { - text-align: left; -} - -.epigraph .quote { - font-style: italic; -} -.epigraph .attribution { - font-style: normal; - text-align: right; -} - -span.application { - font-style: italic; -} - -.programlisting { - font-family: monospace; - font-size: 80%; - white-space: pre; - margin: 1.33em 0em; - padding: 1.33em; -} - -.tip, -.warning, -.caution, -.note { - margin-top: 1em; - margin-bottom: 1em; - -} - -/* force full width of table within div */ -.tip table, -.warning table, -.caution table, -.note table { - border: none; - width: 100%; -} - - -.tip table th, -.warning table th, -.caution table th, -.note table th { - padding: 0.8em 0.0em 0.0em 0.0em; - margin : 0em 0em 0em 0em; -} - -.tip p, -.warning p, -.caution p, -.note p { - margin-top: 0.5em; - margin-bottom: 0.5em; - padding-right: 1em; - text-align: left; -} - -.acronym { - text-transform: uppercase; -} - -b.keycap, -.keycap { - padding: 0.09em 0.3em; - margin: 0em; -} - -.itemizedlist li { - clear: none; -} - -.filename { - font-size: medium; - font-family: Courier, monospace; -} - - -div.navheader, div.heading{ - position: absolute; - left: 0em; - top: 0em; - width: 100%; - background-color: #cdf; - width: 100%; -} - -div.navfooter, div.footing{ - position: fixed; - left: 0em; - bottom: 0em; - background-color: #eee; - width: 100%; -} - - -div.navheader td, -div.navfooter td { - font-size: 66%; -} - -div.navheader table th { - /*font-family: Georgia, Times, serif;*/ - /*font-size: x-large;*/ - font-size: 80%; -} - -div.navheader table { - border-left: 0em; - border-right: 0em; - border-top: 0em; - width: 100%; -} - -div.navfooter table { - border-left: 0em; - border-right: 0em; - border-bottom: 0em; - width: 100%; -} - -div.navheader table td a, -div.navfooter table td a { - color: #777; - text-decoration: none; -} - -/* normal text in the footer */ -div.navfooter table td { - color: black; -} - -div.navheader table td a:visited, -div.navfooter table td a:visited { - color: #444; -} - - -/* links in header and footer */ -div.navheader table td a:hover, -div.navfooter table td a:hover { - text-decoration: underline; - background-color: transparent; - color: #33a; -} - -div.navheader hr, -div.navfooter hr { - display: none; -} - - -.qandaset tr.question td p { - margin: 0em 0em 1em 0em; - padding: 0em 0em 0em 0em; -} - -.qandaset tr.answer td p { - margin: 0em 0em 1em 0em; - padding: 0em 0em 0em 0em; -} -.answer td { - padding-bottom: 1.5em; -} - -.emphasis { - font-weight: bold; -} - - - /************* / - / decorations / -/ *************/ - -.titlepage { -} - -.part .title { -} - -.subtitle { - border: none; -} - -/* -h1 { - border: none; -} - -h2 { - border-top: solid 0.2em; - border-bottom: solid 0.06em; -} - -h3 { - border-top: 0em; - border-bottom: solid 0.06em; -} - -h4 { - border: 0em; - border-bottom: solid 0.06em; -} - -h5 { - border: 0em; -} -*/ - -.programlisting { - border: solid 1px; -} - -div.figure, -div.table, -div.informalfigure, -div.informaltable, -div.informalexample, -div.example { - border: 1px solid; -} - - - -.tip, -.warning, -.caution, -.note { - border: 1px solid; -} - -.tip table th, -.warning table th, -.caution table th, -.note table th { - border-bottom: 1px solid; -} - -.question td { - border-top: 1px solid black; -} - -.answer { -} - - -b.keycap, -.keycap { - border: 1px solid; -} - - -div.navheader, div.heading{ - border-bottom: 1px solid; -} - - -div.navfooter, div.footing{ - border-top: 1px solid; -} - - /********* / - / colors / -/ *********/ - -body { - color: #333; - background: white; -} - -a { - background: transparent; -} - -a:hover { - background-color: #dedede; -} - - -h1, -h2, -h3, -h4, -h5, -h6, -h7, -h8 { - background-color: transparent; -} - -hr { - border-color: #aaa; -} - - -.tip, .warning, .caution, .note { - border-color: #aaa; -} - - -.tip table th, -.warning table th, -.caution table th, -.note table th { - border-bottom-color: #aaa; -} - - -.warning { - background-color: #fea; -} - -.caution { - background-color: #fea; -} - -.tip { - background-color: #eff; -} - -.note { - background-color: #dfc; -} - -.glossary dl dt, -.variablelist dl dt, -.variablelist dl dt span.term { - color: #044; -} - -div.figure, -div.table, -div.example, -div.informalfigure, -div.informaltable, -div.informalexample { - border-color: #aaa; -} - -pre.programlisting { - color: black; - background-color: #fff; - border-color: #aaa; - border-width: 2px; -} - -.guimenu, -.guilabel, -.guimenuitem { - background-color: #eee; -} - - -b.keycap, -.keycap { - background-color: #eee; - border-color: #999; -} - - -div.navheader { - border-color: black; -} - - -div.navfooter { - border-color: black; -} - - - /*********** / - / graphics / -/ ***********/ - -/* -body { - background-image: url("images/body_bg.jpg"); - background-attachment: fixed; -} - -.navheader, -.note, -.tip { - background-image: url("images/note_bg.jpg"); - background-attachment: fixed; -} - -.warning, -.caution { - background-image: url("images/warning_bg.jpg"); - background-attachment: fixed; -} - -.figure, -.informalfigure, -.example, -.informalexample, -.table, -.informaltable { - background-image: url("images/figure_bg.jpg"); - background-attachment: fixed; -} - -*/ -h1, -h2, -h3, -h4, -h5, -h6, -h7{ -} - -/* -Example of how to stick an image as part of the title. - -div.article .titlepage .title -{ - background-image: url("figures/white-on-black.png"); - background-position: center; - background-repeat: repeat-x; -} -*/ - -div.preface .titlepage .title, -div.colophon .title, -div.chapter .titlepage .title, -div.article .titlepage .title -{ -} - -div.section div.section .titlepage .title, -div.sect2 .titlepage .title { - background: none; -} - - -h1.title { - background-color: transparent; - background-image: url("figures/yocto-project-bw.png"); - background-repeat: no-repeat; - height: 256px; - text-indent: -9000px; - overflow:hidden; -} - -h2.subtitle { - background-color: transparent; - text-indent: -9000px; - overflow:hidden; - width: 0px; - display: none; -} - - /*************************************** / - / pippin.gimp.org specific alterations / -/ ***************************************/ - -/* -div.heading, div.navheader { - color: #777; - font-size: 80%; - padding: 0; - margin: 0; - text-align: left; - position: absolute; - top: 0px; - left: 0px; - width: 100%; - height: 50px; - background: url('/gfx/heading_bg.png') transparent; - background-repeat: repeat-x; - background-attachment: fixed; - border: none; -} - -div.heading a { - color: #444; -} - -div.footing, div.navfooter { - border: none; - color: #ddd; - font-size: 80%; - text-align:right; - - width: 100%; - padding-top: 10px; - position: absolute; - bottom: 0px; - left: 0px; - - background: url('/gfx/footing_bg.png') transparent; -} -*/ - - - - /****************** / - / nasty ie tweaks / -/ ******************/ - -/* -div.heading, div.navheader { - width:expression(document.body.clientWidth + "px"); -} - -div.footing, div.navfooter { - width:expression(document.body.clientWidth + "px"); - margin-left:expression("-5em"); -} -body { - padding:expression("4em 5em 0em 5em"); -} -*/ - - /**************************************** / - / mozilla vendor specific css extensions / -/ ****************************************/ -/* -div.navfooter, div.footing{ - -moz-opacity: 0.8em; -} - -div.figure, -div.table, -div.informalfigure, -div.informaltable, -div.informalexample, -div.example, -.tip, -.warning, -.caution, -.note { - -moz-border-radius: 0.5em; -} - -b.keycap, -.keycap { - -moz-border-radius: 0.3em; -} -*/ - -table tr td table tr td { - display: none; -} - - -hr { - display: none; -} - -table { - border: 0em; -} - - .photo { - float: right; - margin-left: 1.5em; - margin-bottom: 1.5em; - margin-top: 0em; - max-width: 17em; - border: 1px solid gray; - padding: 3px; - background: white; -} - .seperator { - padding-top: 2em; - clear: both; - } - - #validators { - margin-top: 5em; - text-align: right; - color: #777; - } - @media print { - body { - font-size: 8pt; - } - .noprint { - display: none; - } - } - - -.tip, -.note { - background: #666666; - color: #fff; - padding: 20px; - margin: 20px; -} - -.tip h3, -.note h3 { - padding: 0em; - margin: 0em; - font-size: 2em; - font-weight: bold; - color: #fff; -} - -.tip a, -.note a { - color: #fff; - text-decoration: underline; -} -- cgit v1.2.3