ADT Manual
PATCH 1/13 documentation/adt-manual: New file structure for ADT Manual
In reply to [email protected]From: Scott Rifenbark <[email protected]>
I have added a new directory to documentation named adt-manual. This directory holds a Figures folder, and the 9 files needed for the ADT manual. The book consists of five chapters:
adt-intro, adt-prepare, adt-package, adt-eclipse, and adt-command. There is also a adt-manual.xml file called by the Makefile. There is also a style.css file. And finally, a adt-manual-customization.xsl file to control numbering.
--- documentation/adt-manual/Makefile | 42 + documentation/adt-manual/adt-command.xml | 57 ++ documentation/adt-manual/adt-eclipse.xml | 57 ++ documentation/adt-manual/adt-intro.xml | 57 ++ .../adt-manual/adt-manual-customization.xsl | 8 + documentation/adt-manual/adt-manual.xml | 66 ++ documentation/adt-manual/adt-package.xml | 57 ++ documentation/adt-manual/adt-prepare.xml | 57 ++ documentation/adt-manual/figures/kernel-title.png | Bin 0 -> 14305 bytes .../adt-manual/figures/yocto-project-transp.png | Bin 0 -> 8626 bytes documentation/adt-manual/style.css | 968 ++++++++++++++++++++ 11 files changed, 1369 insertions(+), 0 deletions(-) create mode 100644 documentation/adt-manual/Makefile create mode 100644 documentation/adt-manual/adt-command.xml create mode 100644 documentation/adt-manual/adt-eclipse.xml create mode 100644 documentation/adt-manual/adt-intro.xml create mode 100644 documentation/adt-manual/adt-manual-customization.xsl create mode 100644 documentation/adt-manual/adt-manual.xml create mode 100644 documentation/adt-manual/adt-package.xml create mode 100644 documentation/adt-manual/adt-prepare.xml create mode 100644 documentation/adt-manual/figures/kernel-title.png create mode 100755 documentation/adt-manual/figures/yocto-project-transp.png create mode 100644 documentation/adt-manual/style.css
documentation/adt-manual/Makefile new file +42 -0
@@ -0,0 +1,42 @@ +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 kernel-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 yocto-project-qs.html $(XSL_XHTML_URI) yocto-project-qs.xml + xsltproc $(XSLTOPTS) -o kernel-manual.html yocto-project-kernel-manual-customization.xsl kernel-manual.xml + +tarball: html + tar -cvzf kernel-manual.tgz kernel-manual.html style.css figures/kernel-title.png figures/kernel-big-picture.png figures/kernel-architecture-overview.png + +validate: + xmllint --postvalid --xinclude --noout kernel-manual.xml + +OUTPUTS = kernel-manual.tgz kernel-manual.html kernel-manual.pdf +SOURCES = *.png *.xml *.css + +publish: + scp -r $(OUTPUTS) $(SOURCES) o-hand.com:/srv/www/pokylinux.org/doc/ + +clean: + rm -f $(OUTPUTS)
documentation/adt-manual/adt-command.xml new file +57 -0
57 lines not on this page · raw message
documentation/adt-manual/adt-eclipse.xml new file +57 -0
57 lines not on this page · raw message
documentation/adt-manual/adt-intro.xml new file +57 -0
57 lines not on this page · raw message
documentation/adt-manual/adt-manual-customization.xsl new file +8 -0
@@ -0,0 +1,8 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> + + <xsl:import href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl" /> + +<!-- <xsl:param name="generate.toc" select="'article nop'"></xsl:param> --> + +</xsl:stylesheet>
documentation/adt-manual/adt-manual.xml new file +66 -0
66 lines not on this page · raw message
documentation/adt-manual/adt-package.xml new file +57 -0
57 lines not on this page · raw message
documentation/adt-manual/adt-prepare.xml new file +57 -0
57 lines not on this page · raw message
documentation/adt-manual/figures/kernel-title.png new file binary +0 -0
documentation/adt-manual/figures/yocto-project-transp.png new file binary +0 -0
documentation/adt-manual/style.css new file +968 -0
968 lines not on this page · raw message
Signature · 1 line
1.7.1
PATCH 3/13 documentation/adt-manual/adt-manual.xml: Initial file
In reply to [email protected]From: Scott Rifenbark <[email protected]>
This is the initial file that the Makefile calls. The changes in this commit reflect edits taking it from the copied kernel manual version.
--- documentation/adt-manual/adt-manual.xml | 26 +++++++++++++++----------- 1 files changed, 15 insertions(+), 11 deletions(-)
documentation/adt-manual/adt-manual.xml +15 -11
@@ -1,7 +1,7 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -<book id='kernel-manual' lang='en' +<book id='adt-manual' lang='en' xmlns:xi="http://www.w3.org/2003/XInclude" xmlns="http://docbook.org/ns/docbook" >
@@ -9,7 +9,7 @@ <mediaobject> <imageobject> - <imagedata fileref='figures/kernel-title.png' + <imagedata fileref='figures/adt-title.png' format='SVG' align='left' scalefit='1' width='100%'/> </imageobject>
@@ -19,19 +19,19 @@ <authorgroup> <author> - <firstname>Bruce</firstname> <surname>Ashfield</surname> + <firstname>Jessica</firstname> <surname>Zhang</surname> <affiliation> - <orgname>Wind River Corporation</orgname> + <orgname>Intel Corporation</orgname> </affiliation> - <email>[email protected]</email> + <email>[email protected]</email> </author> </authorgroup> <revhistory> <revision> - <revnumber>0.9</revnumber> - <date>24 November 2010</date> - <revremark>Beta Draft</revremark> + <revnumber>1.0</revnumber> + <date>14 March 2011</date> + <revremark>Initial Document released with Yocto Project 1.0.</revremark> </revision> </revhistory>
@@ -49,11 +49,15 @@ </bookinfo> - <xi:include href="kernel-doc-intro.xml"/> + <xi:include href="adt-intro.xml"/> - <xi:include href="kernel-concepts.xml"/> + <xi:include href="adt-prepare.xml"/> - <xi:include href="kernel-how-to.xml"/> + <xi:include href="adt-package.xml"/> + + <xi:include href="adt-eclipse.xml"/> + + <xi:include href="adt-command.xml"/> <!-- <index id='index'> <title>Index</title>
Signature · 1 line
1.7.1
PATCH 4/13 documentation/adt-manual/Makefile: Initial Makefile
In reply to [email protected]From: Scott Rifenbark <[email protected]>
These edits take the Makefile from the version I copied over from the Kernel manual to create the initial version for the ADT Manual.
--- documentation/adt-manual/Makefile | 12 ++++++------ 1 files changed, 6 insertions(+), 6 deletions(-)
documentation/adt-manual/Makefile +6 -6
@@ -14,7 +14,7 @@ XSL_XHTML_URI = $(XSL_BASE_URI)/xhtml/docbook.xsl all: html pdf tarball pdf: - ../tools/poky-docbook-to-pdf kernel-manual.xml ../template + ../tools/poky-docbook-to-pdf adt-manual.xml ../template ## # These URI should be rewritten by your distribution's xml catalog to
@@ -23,16 +23,16 @@ pdf: html: # See http://www.sagehill.net/docbookxsl/HtmlOutput.html -# xsltproc $(XSLTOPTS) -o yocto-project-qs.html $(XSL_XHTML_URI) yocto-project-qs.xml - xsltproc $(XSLTOPTS) -o kernel-manual.html yocto-project-kernel-manual-customization.xsl kernel-manual.xml +# 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 kernel-manual.tgz kernel-manual.html style.css figures/kernel-title.png figures/kernel-big-picture.png figures/kernel-architecture-overview.png + tar -cvzf adt-manual.tgz adt-manual.html style.css figures/adt-title.png figures/yocto-project-transp.png validate: - xmllint --postvalid --xinclude --noout kernel-manual.xml + xmllint --postvalid --xinclude --noout adt-manual.xml -OUTPUTS = kernel-manual.tgz kernel-manual.html kernel-manual.pdf +OUTPUTS = adt-manual.tgz adt-manual.html adt-manual.pdf SOURCES = *.png *.xml *.css publish:
Signature · 1 line
1.7.1
PATCH 6/13 documentation/adt-manual/style.css: Changed PNG file in the title page style
In reply to [email protected]From: Scott Rifenbark <[email protected]>
The .aurthorgroup style uses a 'background-image' item to add the book title image. This had to be changed to 'figures/adt-title.png' from 'figures/kernel-title.png' since it is for the ADT manual.
--- documentation/adt-manual/style.css | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
documentation/adt-manual/style.css +1 -1
@@ -122,7 +122,7 @@ h6 { background-color: transparent; background-repeat: no-repeat; padding-top: 256px; - background-image: url("figures/kernel-title.png"); + background-image: url("figures/adt-title.png"); background-position: left top; margin-top: -256px; padding-right: 50px;
Signature · 1 line
1.7.1
PATCH 7/13 documentation/adt-manual/adt-intro.xml: Initial text
In reply to [email protected]From: Scott Rifenbark <[email protected]>
This commit is the initial text for the introduction chapter.
--- documentation/adt-manual/adt-intro.xml | 132 +++++++++++++++++++++++--------- 1 files changed, 96 insertions(+), 36 deletions(-)
documentation/adt-manual/adt-intro.xml +96 -36
@@ -3,53 +3,113 @@ <chapter id='adt-intro'> -<title>Yocto Project Kernel Architecture and Use Manual</title> +<title>Application Development Toolkit (ADT) User's Guide</title> + +<para> + 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. +</para> <section id='book-intro'> - <title>Introduction</title> + <title>Introducing the Application Development Toolkit (ADT)</title> <para> - The Yocto Project presents the kernel as a fully patched, history-clean git - repository. - The git tree represents the selected features, board support, - and configurations extensively tested by Yocto Project. - The Yocto Project kernel allows the end user to leverage community - best practices to seamlessly manage the development, build and debug cycles. + 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. </para> <para> - This manual describes the Yocto Project kernel by providing information - on its history, organization, benefits, and use. - The manual consists of two sections: - <itemizedlist> - <listitem><para>Concepts - Describes concepts behind the kernel. - You will understand how the kernel is organized and why it is organized in - the way it is. You will understand the benefits of the kernel's organization - and the mechanisms used to work with the kernel and how to apply it in your - design process.</para></listitem> - <listitem><para>Using the Kernel - Describes best practices and "how-to" information - that lets you put the kernel to practical use. Some examples are "How to Build a - Project Specific Tree", "How to Examine Changes in a Branch", and "Saving Kernel - Modifications."</para></listitem> - </itemizedlist> + 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. </para> <para> - For more information on the kernel, see the following links: - <itemizedlist> - <listitem><para><ulink url='http://ldn.linuxfoundation.org/book/1-a-guide-kernel-development-process'></ulink></para></listitem> - <listitem><para><ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem> - <listitem><para><ulink url='http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob_plain;f=Documentation/HOWTO;hb=HEAD'></ulink></para></listitem> - </itemizedlist> - <para> - You can find more information on Yocto Project by visiting the website at - <ulink url='http://www.yoctoproject.org'></ulink>. - </para> + 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. </para> -</section> - - - + + <section id='the-cross-toolchain'> + <title>The Cross-Toolchain</title> + <para> + 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. + </para> + </section> + <section id='sysroot'> + <title>Sysroot</title> + <para> + 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. + </para> + </section> + <section id='the-qemu-emulator'> + <title>The QEMU Emulator</title> + <para> + 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. + </para> + </section> + <section id='user-space-tools'> + <title>User-Space Tools</title> + <para> + 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. + <itemizedlist> + <listitem><para><emphasis>LatencyTOP</emphasis> – 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 + <ulink url='http://www.latencytop.org/'></ulink>. + </para></listitem> + <listitem><para><emphasis>PowerTOP</emphasis> – Helps you determine what + software is using the most power. + You can find out more about PowerTOP at + <ulink url='http://www.linuxpowertop.org/'></ulink>. + </para></listitem> + <listitem><para><emphasis>OProfile</emphasis> – 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 + <ulink url='http://oprofile.sourceforge.net/about/'></ulink>. + </para></listitem> + <listitem><para><emphasis>Perf</emphasis> – 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 + <ulink url='https://perf.wiki.kernel.org/index.php'></ulink> and click + on “Perf tools.” + </para></listitem> + <listitem><para><emphasis>SystemTap</emphasis> – 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 <ulink url='http://sourceware.org/systemtap'></ulink> for more information + on SystemTap. + </para></listitem> + <listitem><para><emphasis>Lttng-ust</emphasis> – A User-space Tracer designed to + provide detailed information on user-space activity. + See <ulink url='http://lttng.org/ust'></ulink> for more information on Lttng-ust. + </para></listitem> + </itemizedlist> + </para> + </section> +</section> </chapter> <!--
Signature · 1 line
1.7.1
PATCH 8/13 documentation/adt-manual/adt-prepare.xml: Initial draft of preparation chapter
In reply to [email protected]From: Scott Rifenbark <[email protected]>
This commit is the initial draft of the preparation chapter (chapter 2).
--- documentation/adt-manual/adt-prepare.xml | 253 +++++++++++++++++++++++++----- 1 files changed, 216 insertions(+), 37 deletions(-)
documentation/adt-manual/adt-prepare.xml +216 -37
@@ -3,53 +3,232 @@ <chapter id='adt-prepare'> -<title>Yocto Project Kernel Architecture and Use Manual</title> +<title>Preparing to Use the Application Development Toolkit (ADT)</title> -<section id='prepare'> - <title>Introduction</title> - <para> - The Yocto Project presents the kernel as a fully patched, history-clean git - repository. - The git tree represents the selected features, board support, - and configurations extensively tested by Yocto Project. - The Yocto Project kernel allows the end user to leverage community - best practices to seamlessly manage the development, build and debug cycles. - </para> +<para> + 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. +</para> + +<section id='installing-the-adt'> + <title>Installing the ADT</title> <para> - This manual describes the Yocto Project kernel by providing information - on its history, organization, benefits, and use. - The manual consists of two sections: - <itemizedlist> - <listitem><para>Concepts - Describes concepts behind the kernel. - You will understand how the kernel is organized and why it is organized in - the way it is. You will understand the benefits of the kernel's organization - and the mechanisms used to work with the kernel and how to apply it in your - design process.</para></listitem> - <listitem><para>Using the Kernel - Describes best practices and "how-to" information - that lets you put the kernel to practical use. Some examples are "How to Build a - Project Specific Tree", "How to Examine Changes in a Branch", and "Saving Kernel - Modifications."</para></listitem> - </itemizedlist> + 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. </para> - <para> - For more information on the kernel, see the following links: - <itemizedlist> - <listitem><para><ulink url='http://ldn.linuxfoundation.org/book/1-a-guide-kernel-development-process'></ulink></para></listitem> - <listitem><para><ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem> - <listitem><para><ulink url='http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob_plain;f=Documentation/HOWTO;hb=HEAD'></ulink></para></listitem> - </itemizedlist> - <para> - You can find more information on Yocto Project by visiting the website at - <ulink url='http://www.yoctoproject.org'></ulink>. + + <section id='configuring-and-running-the-adt-installer'> + <title>Configuring and Running the ADT Installer</title> + <para> + The ADT Installer is contained in a tarball that can be built using + <filename>bitbake adt-installer</filename>. + Yocto Project has a pre-built ADT Installer tarball that you can download + from <filename>tmp/deploy/sdk</filename> located in the build directory. </para> - </para> -</section> + <note> + You can install and run the ADT Installer tarball in any directory you want. + </note> + + <para> + Before running the ADT Installer you need to configure it by editing + the <filename>adt-installer.conf</filename> 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 <filename>adt-installer.conf</filename> file: + <itemizedlist> + <listitem><para><filename>YOCTOADT_IPKG_REPO</filename> – 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 + <filename>YOCTOADT_IPKG_REPO</filename>, you need to be sure that the + directory structure follows the same layout as the reference directory + set up at <ulink url='http://adtrepo.yoctoproject.org'></ulink>. + Also, your repository needs to be accessible through HTTP. + </para></listitem> + <listitem><para><filename>YOCTOADT-TARGETS</filename> – The machine + target architectures for which you want to set up cross-development + environments. + </para></listitem> + <listitem><para><filename>YOCTOADT_QEMU</filename> – Indicates whether + or not to install the emulator QEMU. + </para></listitem> + <listitem><para><filename>YOCTOADT_NFS_UTIL</filename> – 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. + <note> + 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. + </note> + </para></listitem> + <listitem><para><filename>YOCTOADT_ROOTFS_<arch></filename> - The root + filesystem images you want to download. + </para></listitem> + <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_IMAGE_<arch></filename> - The + root filesystem used to extract and create the target sysroot. + </para></listitem> + <listitem><para><filename>YOCTOADT_TARGET_SYSROOT_LOC_<arch></filename> - The + location of the target sysroot that will be set up on the development machine. + </para></listitem> + </itemizedlist> + </para> + + <para> + After you have configured the <filename>adt-installer.conf</filename> file, + run the installer using the following command: + <literallayout class='monospaced'> + $ adt_installer + </literallayout> + </para> + + <para> + 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. + </para> + <para> + Once the installation completes, the cross-toolchain is installed in + <filename>/opt/poky/$SDKVERSION</filename>. + </para> + <para> + Before using the ADT you need to run the environment setup script for + your target architecture also located in <filename>/opt/poky/$SDKVERSION</filename>. + See the <xref linkend='setting-up-the-environment'>“Setting Up the Environment”</xref> + section for information. + </para> + </section> + <section id='using-an-existing-toolchain-tarball'> + <title>Using an Existing Toolchain Tarball</title> + <para> + If you don’t want to use the ADT Installer you can install the toolchain + and the sysroot by hand. + Follow these steps: + <orderedlist> + <listitem><para>Locate and download the architecture-specific toolchain + tarball from <ulink url='http://autobuilder.yoctoproject.org/downloads/yocto-0.9'></ulink>. + Look in the ‘toolchain’ folder and then open up the folder that matches your + host development system (i.e. 'i586' for 32-bit machines or 'x86_64' + for 64-bit machines). + Then, select the toolchain tarball whose name includes the appropriate + target architecture. + <note> + If you need to build the toolchain tarball use the + <filename>bitbake meta-toolchain</filename> command after you have + sourced the poky-build-init script. + The tarball will be located in the build directory at + <filename>tmp/deploy/sdk</filename> after the build. + </note> + </para></listitem> + <listitem><para>Make sure you are in the root directory and then expand + the tarball. + The tarball expands into the <filename>/opt/poky/$SDKVERSION</filename> directory. + </para></listitem> + <listitem><para>Set up the environment by sourcing the environment set up + script. + See the <xref linkend='setting-up-the-environment'>“Setting Up the Environment”</xref> + for information. + </para></listitem> + </orderedlist> + </para> + </section> + <section id='using-the-toolchain-from-within-the-build-tree'> + <title>Using the Toolchain from Within the Build Tree</title> + <para> + 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: + <literallayout class='monospaced'> + $ bitbake meta-ide-support + </literallayout> + </para> + + <para> + Before running the command you need to be sure that the + <filename>conf/local.conf</filename> file in the build directory has + the desired architecture specified for the <filename>MACHINE</filename> + variable. + See the <filename>local.conf</filename> 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 <filename>local.conf</filename> file and re-run + the BitBake command. + </para> + + <para> + 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 <xref linkend='setting-up-the-environment'>“Setting Up the Environment”</xref> + for information. + </para> + </section> +</section> + +<section id='setting-up-the-environment'> + <title>Setting Up the Environment</title> + <para> + 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 <filename>/opt/poky/$SDKVERSION</filename> + directory. + If you are using the ADT from a Poky build tree, then look in the build + directory in <filename>tmp</filename> for the setup script. + </para> + + <para> + 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: + <literallayout class='monospaced'> + /opt/poky/environment-setup-x86_64-poky-linux + </literallayout> + </para> +</section> + +<section id='kernels-and-filesystem-images'> + <title>Kernels and Filesystem Images</title> + <para> + 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 + <ulink url='http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html'></ulink>. + <note> + 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 - <ulink url='http://autobuilder.yoctoproject.org/downloads/yocto-0.9/'></ulink> + and are ideal for experimentation within Yocto Project. + </note> + </para> +</section> </chapter> <!--
Signature · 1 line
1.7.1
PATCH 10/13 documentation/adt-manual/adt-eclipse.xml: Initial draft for Eclipse chapter.
In reply to [email protected]From: Scott Rifenbark <[email protected]>
This is the initial draft of the Eclipse chapter.
--- documentation/adt-manual/adt-eclipse.xml | 443 +++++++++++++++++++++++++++--- 1 files changed, 408 insertions(+), 35 deletions(-)
documentation/adt-manual/adt-eclipse.xml +408 -35
@@ -2,54 +2,427 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> <chapter id='adt-eclipse'> - -<title>Yocto Project Kernel Architecture and Use Manual</title> - -<section id='eclipse'> - <title>Introduction</title> +<title>Working Within Eclipse</title> <para> - The Yocto Project presents the kernel as a fully patched, history-clean git - repository. - The git tree represents the selected features, board support, - and configurations extensively tested by Yocto Project. - The Yocto Project kernel allows the end user to leverage community - best practices to seamlessly manage the development, build and debug cycles. + 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 manual describes the Yocto Project kernel by providing information - on its history, organization, benefits, and use. - The manual consists of two sections: - <itemizedlist> - <listitem><para>Concepts - Describes concepts behind the kernel. - You will understand how the kernel is organized and why it is organized in - the way it is. You will understand the benefits of the kernel's organization - and the mechanisms used to work with the kernel and how to apply it in your - design process.</para></listitem> - <listitem><para>Using the Kernel - Describes best practices and "how-to" information - that lets you put the kernel to practical use. Some examples are "How to Build a - Project Specific Tree", "How to Examine Changes in a Branch", and "Saving Kernel - Modifications."</para></listitem> - </itemizedlist> + 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> - For more information on the kernel, see the following links: - <itemizedlist> - <listitem><para><ulink url='http://ldn.linuxfoundation.org/book/1-a-guide-kernel-development-process'></ulink></para></listitem> - <listitem><para><ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem> - <listitem><para><ulink url='http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob_plain;f=Documentation/HOWTO;hb=HEAD'></ulink></para></listitem> - </itemizedlist> - <para> - You can find more information on Yocto Project by visiting the website at - <ulink url='http://www.yoctoproject.org'></ulink>. - </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. + 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/'></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. + If you use this mode you must also supply the Poky Root Location + in the Preferences Dialog.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='configuring-the-sysroot'> + <title>Configuring the Sysroot</title> + <para> + 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. + </para> + </section> + + <section id='selecting-the-target-architecture'> + <title>Selecting the Target Architecture</title> + <para> + Use the pull-down Target Architecture menu and select the + target architecture. + </para> + <para> + 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 + <xref linkend='adt-prepare'> + “Preparing to Use the Application Development Toolkit (ADT)”</xref> + section earlier in this document. + </para> + </section> + + <section id='choosing-the-target-options'> + <title>Choosing the Target Options</title> + <para> + You can choose to emulate hardware using the QEMU emulator, or you + can choose to use actual hardware. + <itemizedlist> + <listitem><para><emphasis>External HW</emphasis> – Select this option + if you will be using actual hardware.</para></listitem> + <listitem><para><emphasis>QEMU</emphasis> – 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.</para> + <para>In Poky Tree Mode the kernel you built will be located in the + Poky Build tree in <filename>tmp/deploy/images</filename> directory. + In SDK Root Mode the pre-built kernel you downloaded is located + in the directory you specified when you downloaded the image.</para> + <para>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. + Use the <filename>man qemu</filename> command to get help on all the options. + The following is an example custom: + <literallayout class='monospaced'> + serial ‘<-m 256 –full-screen>’ + </literallayout> + </para> + <para> + Regardless of the mode, Sysroot is already defined in the “Sysroot” + field.</para></listitem> + </itemizedlist> + </para> + <para> + Click the “OK” button to save your plug-in configurations. + </para> + </section> + </section> </section> +<section id='creating-the-project'> +<title>Creating the Project</title> + <para> + 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 + <xref linkend='using-the-command-line'> “Using the Command Line”</xref> + section. + </para> + <para> + To create a project based on a Yocto template and then display the source code, + follow these steps: + <orderedlist> + <listitem><para>Select File -> New -> Project.</para></listitem> + <listitem><para>Double click “CC++”.</para></listitem> + <listitem><para>Double click “C Project” to create the project.</para></listitem> + <listitem><para>Double click “Yocto SDK Project”.</para></listitem> + <listitem><para>Select “Hello World ANSI C Autotools Project”. + This is an Autotools-based project based on a Yocto Project template.</para></listitem> + <listitem><para>Put a name in the “Project name:” field.</para></listitem> + <listitem><para>Click “Next”.</para></listitem> + <listitem><para>Add information in the “Author” field.</para></listitem> + <listitem><para>Use “GNU General Public License v2.0” for the License.</para></listitem> + <listitem><para>Click “Finish”.</para></listitem> + <listitem><para>Answer ‘Yes” to the open perspective prompt.</para></listitem> + <listitem><para>In the Project Explorer expand your project.</para></listitem> + <listitem><para>Expand ‘src’.</para></listitem> + <listitem><para>Double click on your source file and the code appears + in the window. + This is the template.</para></listitem> + </orderedlist> + </para> +</section> +<section id='configuring-the-cross-toolchains'> +<title>Configuring the Cross-Toolchains</title> + <para> + The previous section, <xref linkend='configuring-the-cross-compiler-options'> + “Configuring the Cross-Compiler Options”</xref>, set up the default project + configurations. + You can change these settings for a given project by following these steps: + <orderedlist> + <listitem><para>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.</para></listitem> + <listitem><para>Select Project -> Reconfigure Project. + This runs the <filename>autogen.sh</filename> in the workspace for your project. + The script runs <filename>libtoolize</filename>, <filename>aclocal</filename>, + <filename>autoconf</filename>, <filename>autoheader</filename>, + <filename>automake ‐‐a</filename>, and + <filename>./configure</filename>.</para></listitem> + </orderedlist> + </para> +</section> +<section id='building-the-project'> +<title>Building the Project</title> + <para> + To build the project, select Project -> Build Project. + You should see the console updated and you can note the cross-compiler you are using. + </para> +</section> +<section id='starting-qemu-in-user-space-nfs-mode'> +<title>Starting QEMU in User Space NFS Mode</title> + <para> + To start the QEMU emulator from within Eclipse, follow these steps: + <orderedlist> + <listitem><para>Select Run -> External Tools -> External Tools Configurations... + This selection brings up the External Tools Configurations Dialogue.</para></listitem> + <listitem><para>Go to the left navigation area and expand ‘Program’. + You should find the image listed. + For example, qemu-x86_64-poky-linux.</para></listitem> + <listitem><para>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.</para></listitem> + <listitem><para>Click “Run” next. + This brings up a shell window.</para></listitem> + <listitem><para>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.</para></listitem> + <listitem><para>Wait for QEMU to launch.</para></listitem> + <listitem><para>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 + <filename>ipconfig</filename> command.</para></listitem> + </orderedlist> + </para> +</section> +<section id='deploying-and-debugging-the-application'> +<title>Deploying and Debugging the Application</title> + <para> + Once QEMU is running you can deploy your application and use the emulator + to perform debugging. + Follow these steps to deploy the application. + <orderedlist> + <listitem><para>Select Run -> Debug Configurations...</para></listitem> + <listitem><para>In the left area expand “C/C++Remote Application”.</para></listitem> + <listitem><para>Locate your project and select it to bring up a new + tabbed view in the Debug Configurations dialogue.</para></listitem> + <listitem><para>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 <filename>/usr/bin/<programname></filename>.</para></listitem> + <listitem><para>Click on the Debugger tab to see the cross-tool debugger + you are using.</para></listitem> + <listitem><para>Create a new connection to the QEMU instance + by clicking on “new”.</para></listitem> + <listitem><para>Select “TCF, which means Target Communication Framework.</para></listitem> + <listitem><para>Click “Next”.</para></listitem> + <listitem><para>Clear out the “host name” field and enter the IP Address + determined earlier.</para></listitem> + <listitem><para>Click Finish to close the new connections dialogue.</para></listitem> + <listitem><para>Use the drop-down menu now in the “Connection” field and pick + the IP Address you entered.</para></listitem> + <listitem><para>Click “Debug” to bring up a login screen and login.</para></listitem> + <listitem><para>Accept the debug perspective.</para></listitem> + </orderedlist> + </para> +</section> +<section id='running-user-space-tools'> +<title>Running User-Space Tools</title> + <para> + 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. + </para> + <para> + 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. + </para> + <para> + Here are some specifics about the remote tools: + <itemizedlist> + <listitem><para><emphasis>OProfile:</emphasis> 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 + <ulink url='http://git.pokylinux.org/cgit/cgit.cgi/oprofileui/'></ulink>. + 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.</para></listitem> + <listitem><para><emphasis>Lttng-ust:</emphasis> 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 + <ulink url='http://lttng.org/files/ust/manual/ust.html'></ulink>.</para> + <para>For "Application" you must supply the absolute path name of the + application to be traced by user mode lttng. + For example, typing <filename>/path/to/foo</filename> triggers + <filename>usttrace /path/to/foo</filename> on the remote target to trace the + program <filename>/path/to/foo</filename>.</para> + <para>"Argument" is passed to <filename>usttrace</filename> + running on the remote target.</para></listitem> + <listitem><para><emphasis>PowerTOP:</emphasis> Selecting this tool runs + "PowerTOP" on the remote target machine and displays the results in a + new view called "powertop".</para> + <para>"Time to gather data(sec):" is the time passed in seconds before data + is gathered from the remote target for analysis.</para> + <para>"show pids in wakeups list:" corresponds to the -p argument + passed to "powertop".</para></listitem> + <listitem><para><emphasis>LatencyTOP and Perf:</emphasis> "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.</para></listitem> + </itemizedlist> + </para> +</section> </chapter> <!--
Signature · 1 line
1.7.1
PATCH 11/13 documentation/adt-manual/adt-command.xml: Initial draft of command line chapter
In reply to [email protected]From: Scott Rifenbark <[email protected]>
This is the initial draft of the Using the Command Line chapter.
--- documentation/adt-manual/adt-command.xml | 91 ++++++++++++++++------------- 1 files changed, 50 insertions(+), 41 deletions(-)
documentation/adt-manual/adt-command.xml +50 -41
@@ -1,55 +1,64 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -<chapter id='adt-command'> - -<title>Yocto Project Kernel Architecture and Use Manual</title> - -<section id='command'> - <title>Introduction</title> +<chapter id='using-the-command-line'> +<title>Using the Command Line</title> <para> - The Yocto Project presents the kernel as a fully patched, history-clean git - repository. - The git tree represents the selected features, board support, - and configurations extensively tested by Yocto Project. - The Yocto Project kernel allows the end user to leverage community - best practices to seamlessly manage the development, build and debug cycles. + 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> - This manual describes the Yocto Project kernel by providing information - on its history, organization, benefits, and use. - The manual consists of two sections: - <itemizedlist> - <listitem><para>Concepts - Describes concepts behind the kernel. - You will understand how the kernel is organized and why it is organized in - the way it is. You will understand the benefits of the kernel's organization - and the mechanisms used to work with the kernel and how to apply it in your - design process.</para></listitem> - <listitem><para>Using the Kernel - Describes best practices and "how-to" information - that lets you put the kernel to practical use. Some examples are "How to Build a - Project Specific Tree", "How to Examine Changes in a Branch", and "Saving Kernel - Modifications."</para></listitem> - </itemizedlist> + 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> - For more information on the kernel, see the following links: - <itemizedlist> - <listitem><para><ulink url='http://ldn.linuxfoundation.org/book/1-a-guide-kernel-development-process'></ulink></para></listitem> - <listitem><para><ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem> - <listitem><para><ulink url='http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob_plain;f=Documentation/HOWTO;hb=HEAD'></ulink></para></listitem> - </itemizedlist> - <para> - You can find more information on Yocto Project by visiting the website at - <ulink url='http://www.yoctoproject.org'></ulink>. - </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> <!--
Signature · 1 line
1.7.1
cover ADT Manual
From: Scott Rifenbark <[email protected]>
These commits represent the new Application Development Toolkit (ADT) User's Manual into the GIT repository. The changes are incremental and work from creation of the new directory within the 'documentation' directory through some final tweeks on one of the individual chapters.
These need to be merged with master before the git documentation cutoff date.
Pull URL: git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/adt-work
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/adt-work
Thanks,
<[email protected]>
---
Scott Rifenbark (13):
documentation/adt-manual: New file structure for ADT Manual documentation/adt-manual/figures: Added title PNG file, deleted
kernel title PNG file.
documentation/adt-manual/adt-manual.xml: Initial file documentation/adt-manual/Makefile: Initial Makefile documentation/adt-manual: cleaned up labels in chapter files documentation/adt-manual/style.css: Changed PNG file in the title
page style
documentation/adt-manual/adt-intro.xml: Initial text documentation/adt-manual/adt-prepare.xml: Initial draft of
preparation chapter
documentation/adt-manual/adt-package.xml: Initial file documentation/adt-manual/adt-eclipse.xml: Initial draft for Eclipse
chapter.
documentation/adt-manual/adt-command.xml: Initial draft of command
line chapter
documentation/adt-manual/adt-eclipse.xml: Removed Autotools plug-in
requirement
documentation/adt-manual/adt-eclipse.xml: Specified qemu options
outside of brackets.
documentation/adt-manual/Makefile | 42 + documentation/adt-manual/adt-command.xml | 66 ++ documentation/adt-manual/adt-eclipse.xml | 430 +++++++++ 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 | 236 +++++ documentation/adt-manual/figures/adt-title.png | Bin 0 -> 14349 bytes .../adt-manual/figures/yocto-project-transp.png | Bin 0 -> 8626 bytes documentation/adt-manual/style.css | 968 ++++++++++++++++++++ 11 files changed, 2019 insertions(+), 0 deletions(-) create mode 100644 documentation/adt-manual/Makefile create mode 100644 documentation/adt-manual/adt-command.xml create mode 100644 documentation/adt-manual/adt-eclipse.xml create mode 100644 documentation/adt-manual/adt-intro.xml create mode 100644 documentation/adt-manual/adt-manual-customization.xsl create mode 100644 documentation/adt-manual/adt-manual.xml create mode 100644 documentation/adt-manual/adt-package.xml create mode 100644 documentation/adt-manual/adt-prepare.xml create mode 100644 documentation/adt-manual/figures/adt-title.png create mode 100755 documentation/adt-manual/figures/yocto-project-transp.png create mode 100644 documentation/adt-manual/style.css
PATCH 2/13 documentation/adt-manual/figures: Added title PNG file, deleted kernel title PNG file.
From: Scott Rifenbark <[email protected]>
I added the title PNG file and removed the existing (copied) kernel title PNG file.
--- documentation/adt-manual/figures/adt-title.png | Bin 0 -> 14349 bytes documentation/adt-manual/figures/kernel-title.png | Bin 14305 -> 0 bytes 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 documentation/adt-manual/figures/adt-title.png delete mode 100644 documentation/adt-manual/figures/kernel-title.png
documentation/adt-manual/figures/adt-title.png new file binary +0 -0
documentation/adt-manual/figures/kernel-title.png deleted binary +0 -0
Signature · 1 line
1.7.1
PATCH 5/13 documentation/adt-manual: cleaned up labels in chapter files
In reply to [email protected]From: Scott Rifenbark <[email protected]>
The initial chapters were failing to make due to duplicate section identifiers that were created when I copied in the original files. I gave each of the five chapter files (adt-command.xml, adt-eclipse.xml, adt-intro.xml, adt-package.xml, and adt-prepare.xml) unique identifier tags.
--- documentation/adt-manual/adt-command.xml | 4 ++-- documentation/adt-manual/adt-eclipse.xml | 4 ++-- documentation/adt-manual/adt-intro.xml | 2 +- documentation/adt-manual/adt-package.xml | 4 ++-- documentation/adt-manual/adt-prepare.xml | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-)
documentation/adt-manual/adt-command.xml +2 -2
@@ -1,11 +1,11 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -<chapter id='kernel-doc-intro'> +<chapter id='adt-command'> <title>Yocto Project Kernel Architecture and Use Manual</title> -<section id='book-intro'> +<section id='command'> <title>Introduction</title> <para> The Yocto Project presents the kernel as a fully patched, history-clean git
documentation/adt-manual/adt-eclipse.xml +2 -2
@@ -1,11 +1,11 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -<chapter id='kernel-doc-intro'> +<chapter id='adt-eclipse'> <title>Yocto Project Kernel Architecture and Use Manual</title> -<section id='book-intro'> +<section id='eclipse'> <title>Introduction</title> <para> The Yocto Project presents the kernel as a fully patched, history-clean git
documentation/adt-manual/adt-intro.xml +1 -1
@@ -1,7 +1,7 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -<chapter id='kernel-doc-intro'> +<chapter id='adt-intro'> <title>Yocto Project Kernel Architecture and Use Manual</title>
documentation/adt-manual/adt-package.xml +2 -2
@@ -1,11 +1,11 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -<chapter id='kernel-doc-intro'> +<chapter id='adt-package'> <title>Yocto Project Kernel Architecture and Use Manual</title> -<section id='book-intro'> +<section id='package'> <title>Introduction</title> <para> The Yocto Project presents the kernel as a fully patched, history-clean git
documentation/adt-manual/adt-prepare.xml +2 -2
@@ -1,11 +1,11 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> -<chapter id='kernel-doc-intro'> +<chapter id='adt-prepare'> <title>Yocto Project Kernel Architecture and Use Manual</title> -<section id='book-intro'> +<section id='prepare'> <title>Introduction</title> <para> The Yocto Project presents the kernel as a fully patched, history-clean git
Signature · 1 line
1.7.1
PATCH 9/13 documentation/adt-manual/adt-package.xml: Initial file
In reply to [email protected]From: Scott Rifenbark <[email protected]>
This file is the initial XML file for the chapter on optionally customizing the development packages installation.
--- documentation/adt-manual/adt-package.xml | 105 ++++++++++++++++++----------- 1 files changed, 65 insertions(+), 40 deletions(-)
documentation/adt-manual/adt-package.xml +65 -40
@@ -2,55 +2,80 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> <chapter id='adt-package'> +<title>Optionally Customizing the Development Packages Installation</title> + <para> + 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. + </para> -<title>Yocto Project Kernel Architecture and Use Manual</title> +<section id='package-management-systems'> + <title>Package Management Systems</title> + <para> + The Yocto Project supports the generation of root filesystem files using + three different Package Management Systems (PMS): + <itemizedlist> + <listitem><para><emphasis>OPKG</emphasis> – A less well known PMS whose use + originated in the OpenEmbedded and OpenWrt embedded Linux projects. + This PMS works with files packaged in an <filename>.ipk</filename> format. + See <ulink url='http://en.wikipedia.org/wiki/Opkg'></ulink> for more + information about OPKG.</para></listitem> + <listitem><para><emphasis>RPM</emphasis> – A more widely known PMS intended for GNU/Linux + distributions. + This PMS works with files packaged in an <filename>.rms</filename> format. + The Yocto Project currently installs through this PMS by default. + See <ulink url='http://en.wikipedia.org/wiki/RPM_Package_Manager'></ulink> + for more information about RPM.</para></listitem> + <listitem><para><emphasis>Debian</emphasis> – 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 + <ulink url='http://en.wikipedia.org/wiki/Dpkg'></ulink>.</para></listitem> + </itemizedlist> + </para> +</section> -<section id='package'> - <title>Introduction</title> +<section id='configuring-the-pms'> + <title>Configuring the PMS</title> + <para> + Whichever PMS you are using you need to be sure that the + <filename>PACKAGE_CLASSES</filename> variable in the <filename>conf/local.conf</filename> + 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. + </para> <para> - The Yocto Project presents the kernel as a fully patched, history-clean git - repository. - The git tree represents the selected features, board support, - and configurations extensively tested by Yocto Project. - The Yocto Project kernel allows the end user to leverage community - best practices to seamlessly manage the development, build and debug cycles. + As an example, consider a scenario where you are using OPKG and you want to add + the libglade package to sysroot. </para> <para> - This manual describes the Yocto Project kernel by providing information - on its history, organization, benefits, and use. - The manual consists of two sections: - <itemizedlist> - <listitem><para>Concepts - Describes concepts behind the kernel. - You will understand how the kernel is organized and why it is organized in - the way it is. You will understand the benefits of the kernel's organization - and the mechanisms used to work with the kernel and how to apply it in your - design process.</para></listitem> - <listitem><para>Using the Kernel - Describes best practices and "how-to" information - that lets you put the kernel to practical use. Some examples are "How to Build a - Project Specific Tree", "How to Examine Changes in a Branch", and "Saving Kernel - Modifications."</para></listitem> - </itemizedlist> + First, you should generate the ipk file for the libglade package and add it + into a working opkg repository. + Use these commands: + <literallayout class='monospaced'> + $ bitbake libglade + $ bitbake package-index + </literallayout> </para> <para> - For more information on the kernel, see the following links: - <itemizedlist> - <listitem><para><ulink url='http://ldn.linuxfoundation.org/book/1-a-guide-kernel-development-process'></ulink></para></listitem> - <listitem><para><ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem> - <listitem><para><ulink url='http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob_plain;f=Documentation/HOWTO;hb=HEAD'></ulink></para></listitem> - </itemizedlist> - <para> - You can find more information on Yocto Project by visiting the website at - <ulink url='http://www.yoctoproject.org'></ulink>. - </para> + Next, source the environment setup script. + Follow that by setting up the installation destination to point to your + sysroot as <filename><sysroot dir></filename>. + Finally, have an opkg configuration file <filename><conf file></filename> + that corresponds to the opkg repository you have just created. + The following command forms should now work: + <literallayout class='monospaced'> + $ 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 + </literallayout> </para> </section> - - - - - - - </chapter> <!-- vim: expandtab tw=80 ts=4
Signature · 1 line
1.7.1
PATCH 13/13 documentation/adt-manual/adt-eclipse.xml: Specified qemu options outside of brackets.
In reply to [email protected]From: Scott Rifenbark <[email protected]>
Section 4.1.3.4 discusses custom options for when you want to run a QEMU image. Jessica felt that we needed to stress the fact that the options "serial", "nographic", and "kvm" must all appear outside of the angled brackets.
--- documentation/adt-manual/adt-eclipse.xml | 12 ++++++++---- 1 files changed, 8 insertions(+), 4 deletions(-)
documentation/adt-manual/adt-eclipse.xml +8 -4
@@ -215,11 +215,15 @@ <para>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. - Use the <filename>man qemu</filename> command to get help on all the options. - The following is an example custom: + Some options must be specified outside the brackets. + In particular, the options <filename>serial</filename>, + <filename>nographic</filename>, and <filename>kvm</filename> must all + be outside the brackets. + Use the <filename>man qemu</filename> command to get help on all the options + and their use. + The following is an example: <literallayout class='monospaced'> - serial ‘<-m 256 –full-screen>’ + serial ‘<-m 256 -full-screen>’ </literallayout> </para> <para>
Signature · 1 line
1.7.1
PATCH 12/13 documentation/adt-manual/adt-eclipse.xml: Removed Autotools plug-in requirement
In reply to [email protected]From: Scott Rifenbark <[email protected]>
Section 4.1.2 lists plug-ins that need to be installed prior to installing the Yocto Plug-in for Eclipse. I removed the Autotools plug-in requirement per Jessica Zhang's instructions.
--- documentation/adt-manual/adt-eclipse.xml | 8 ++------ 1 files changed, 2 insertions(+), 6 deletions(-)
documentation/adt-manual/adt-eclipse.xml +2 -6
@@ -78,8 +78,8 @@ <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. - After installing these three plug-ins, you can install the + CDT 7.0 and RSE 3.2 plug-ins are all installed. + After installing these two plug-ins, you can install the Eclipse Yocto Plug-in. Use the following URLs for the plug-ins: <orderedlist>
@@ -97,10 +97,6 @@ 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/'></ulink>: Check the box next to “Development tools & SDKs for Yocto Linux”
Signature · 1 line
1.7.1
Richard Purdie
AppliedQuoted 33 lines · On Tue, 2011-03-15 at 17:43 -0600, [email protected] wrote:
From: Scott Rifenbark <[email protected]>
These commits represent the new Application Development Toolkit (ADT) User's Manual into the GIT repository. The changes are incremental and work from creation of the new directory within the 'documentation' directory through some final tweeks on one of the individual chapters.
These need to be merged with master before the git documentation cutoff date.
Pull URL:
git://git.pokylinux.org/poky-contrib.git
Branch: srifenbark/adt-work
Browse: http://git.pokylinux.org/cgit.cgi/poky-contrib/log/?h=srifenbark/adt-workThanks,
<[email protected]>
---Scott Rifenbark (13):
documentation/adt-manual: New file structure for ADT Manual documentation/adt-manual/figures: Added title PNG file, deleted
kernel title PNG file.
documentation/adt-manual/adt-manual.xml: Initial file documentation/adt-manual/Makefile: InitialMakefiledocumentation/adt-manual: cleaned up labels in chapter files documentation/adt-manual/style.css: Changed PNG file in the title
page style
documentation/adt-manual/adt-intro.xml: Initial textdocumentation/adt-manual/adt-prepare.xml: Initial draft of
preparation chapter
documentation/adt-manual/adt-package.xml: Initial file
Quoted 8 lines
documentation/adt-manual/adt-eclipse.xml: Initial draft for Eclipse
chapter.
documentation/adt-manual/adt-command.xml: Initial draft of command
line chapter
documentation/adt-manual/adt-eclipse.xml: Removed Autotools plug-in
requirement
documentation/adt-manual/adt-eclipse.xml: Specified qemu options
outside of brackets.
Merged to master, thanks.
Richard