diff options
| author | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-04-20 14:20:19 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2011-04-20 15:49:17 +0100 |
| commit | 50021cba20a09b1ed685db5466f940b17d4880ac (patch) | |
| tree | 3bdafb797e6466ad58727b002f1235933010ab11 | |
| parent | 690e87a2ffe8caa16379be26eb356c5bded17c1f (diff) | |
| download | openembedded-core-50021cba20a09b1ed685db5466f940b17d4880ac.tar.gz openembedded-core-50021cba20a09b1ed685db5466f940b17d4880ac.tar.bz2 openembedded-core-50021cba20a09b1ed685db5466f940b17d4880ac.zip | |
Drop documentation directory, this is replaced by the new yocto-docs repository
87 files changed, 0 insertions, 18286 deletions
diff --git a/documentation/adt-manual/Makefile b/documentation/adt-manual/Makefile deleted file mode 100644 index 74e35bcdeb..0000000000 --- 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 e57c15a983..0000000000 --- a/documentation/adt-manual/adt-command.xml +++ /dev/null @@ -1,66 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - -<chapter id='using-the-command-line'> -<title>Using the Command Line</title> - <para> - Recall that earlier we talked about how to use an existing toolchain - tarball that had been installed into <filename>/opt/poky</filename>, - which is outside of the Poky build environment - (see <xref linkend='using-an-existing-toolchain-tarball'> - “Using an Existing Toolchain Tarball”)</xref>. - 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 <filename>pkgconfig</filename> and other useful - utilities to the <filename>PATH</filename> variable. - Variables to assist pkgconfig and autotools are also defined so that, - for example, <filename>configure.sh</filename> 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. - </para> - -<section id='autotools-based-projects'> -<title>Autotools-Based Projects</title> - <para> - For an autotools-based project you can use the cross-toolchain by just - passing the appropriate host option to <filename>configure.sh</filename>. - The host option you use is derived from the name of the environment setup - script in <filename>/opt/poky</filename> resulting from unpacking the - cross-toolchain tarball. - For example, the host option for an ARM-based target that uses the GNU EABI - is <filename>armv5te-poky-linux-gnueabi</filename>. - Note that the name of the script is - <filename>environment-setup-armv5te-poky-linux-gnueabi</filename>. - Thus, the following command works: - <literallayout class='monospaced'> - $ configure ‐‐host-armv5te-poky-linux-gnueabi ‐‐with-libtool-sysroot=<sysroot-dir> - </literallayout> - </para> - <para> - This single command updates your project and rebuilds it using the appropriate - cross-toolchain tools. - </para> -</section> - -<section id='makefile-based-projects'> -<title>Makefile-Based Projects</title> - <para> - For a makefile-based project you use the cross-toolchain by making sure - the tools are used. - You can do this as follows: - <literallayout class='monospaced'> - CC=arm-poky-linux-gnueabi-gcc - LD=arm-poky-linux-gnueabi-ld - CFLAGS=”${CFLAGS} ‐‐sysroot=<sysroot-dir>” - CXXFLAGS=”${CXXFLAGS} ‐‐sysroot=<sysroot-dir>” - </literallayout> - </para> -</section> - -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/adt-manual/adt-eclipse.xml b/documentation/adt-manual/adt-eclipse.xml deleted file mode 100644 index ee305fe585..0000000000 --- a/documentation/adt-manual/adt-eclipse.xml +++ /dev/null @@ -1,435 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - -<chapter id='adt-eclipse'> -<title>Working Within Eclipse</title> - <para> - 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. - </para> - <para> - This section describes how to install and configure the Eclipse IDE - Yocto Plug-in and how to use it to develop your Yocto Project. - </para> - -<section id='setting-up-the-eclipse-ide'> - <title>Setting Up the Eclipse IDE</title> - <para> - To develop within the Eclipse IDE you need to do the following: - <orderedlist> - <listitem><para>Be sure the optimal version of Eclipse IDE - is installed.</para></listitem> - <listitem><para>Install required Eclipse plug-ins prior to installing - the Eclipse Yocto Plug-in.</para></listitem> - <listitem><para>Configure the Eclipse Yocto Plug-in.</para></listitem> - </orderedlist> - </para> - - <section id='installing-eclipse-ide'> - <title>Installing Eclipse IDE</title> - <para> - 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 - <ulink url='http://www.eclipse.org/downloads'></ulink>. - 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. - </para> - <para> - Once you have downloaded the tarball, extract it into a clean - directory and complete the installation. - </para> - <para> - 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: - <literallayout class='monospaced'> - Java.lang.OutOfMemoryError: PermGen space - </literallayout> - </para> - <para> - This error causes the application to hang. - </para> - <para> - To fix this issue you can use the ‐‐vmargs option when you start - Eclipse to increase the size of the permanent generation space: - <literallayout class='monospaced'> - eclipse ‐‐vmargs ‐‐XX:PermSize=256M - </literallayout> - </para> - </section> - - <section id='installing-required-plug-ins-and-the-eclipse-yocto-plug-in'> - <title>Installing Required Plug-ins and the Eclipse Yocto Plug-in</title> - <para> - 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: - <orderedlist> - <listitem><para><emphasis>CDT 7.0</emphasis> – - <ulink url='http://download.eclipse.org/tools/cdt/releases/helios/'></ulink>: - 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”.</para></listitem> - <listitem><para><emphasis>RSE 3.2</emphasis> – - <ulink url='http://download.eclipse.org/tm/updates/3.2'></ulink>: - 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”.</para></listitem> - <listitem><para><emphasis>Autotools</emphasis> – - <ulink url='http://download.eclipse.org/technology/linuxtools/update/'></ulink>: - Expand the items under “Linux Tools” and select “Autotools support for - CDT (Incubation)”.</para></listitem> - <listitem><para><emphasis>Yocto Plug-in</emphasis> – - <ulink url='http://www.yoctoproject.org/downloads/eclipse-plugin/1.0'></ulink>: - Check the box next to “Development tools & SDKs for Yocto Linux” - to select all the items.</para></listitem> - </orderedlist> - </para> - <para> - Follow these general steps to install a plug-in: - <orderedlist> - <listitem><para>From within the Eclipse IDE select the - “Install New Software” item from the “Help” menu.</para></listitem> - <listitem><para>Click “Add…” in the “Work with:” area.</para></listitem> - <listitem><para>Enter the URL for the repository and leave the “Name” - field blank.</para></listitem> - <listitem><para>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.</para></listitem> - </orderedlist> - </para> - </section> - - <section id='configuring-the-plug-in'> - <title>Configuring the Plug-in</title> - <para> - 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. - </para> - <para> - To start, you need to do the following from within the Eclipse IDE: - <itemizedlist> - <listitem><para>Choose Windows -> Preferences to display - the Preferences Dialog</para></listitem> - <listitem><para>Click “Yocto SDK”</para></listitem> - </itemizedlist> - </para> - - <section id='configuring-the-cross-compiler-options'> - <title>Configuring the Cross-Compiler Options</title> - <para> - Choose between ‘SDK Root Mode’ and ‘Poky Tree Mode’ for Cross - Compiler Options. - <itemizedlist> - <listitem><para><emphasis>SDK Root Mode</emphasis> – 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 <filename>/opt/poky</filename> directory.</para></listitem> - <listitem><para><emphasis>Poky Tree Mode</emphasis> – 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. < |
