diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-12-07 17:19:36 -0600 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-12-11 16:15:24 +0000 |
| commit | 3bcdba62b186c554033357bb50de0b20d115a54d (patch) | |
| tree | abc1731f63ac3faeec778c39e45344d61c3d7949 /documentation/adt-manual/adt-intro.xml | |
| parent | 205c7961f31fced8f42a8fc483618ed3d54dc109 (diff) | |
| download | poky-3bcdba62b186c554033357bb50de0b20d115a54d.tar.gz | |
documentation: adt-manual - Removed all trailing whitespace.
(From yocto-docs rev: c1c271c0404dff9ed49597a4582a56def8237dd7)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/adt-manual/adt-intro.xml')
| -rw-r--r-- | documentation/adt-manual/adt-intro.xml | 128 |
1 files changed, 64 insertions, 64 deletions
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml index d8527b3aef..fcbceb4de1 100644 --- a/documentation/adt-manual/adt-intro.xml +++ b/documentation/adt-manual/adt-intro.xml | |||
| @@ -6,44 +6,44 @@ | |||
| 6 | <title>Introduction</title> | 6 | <title>Introduction</title> |
| 7 | 7 | ||
| 8 | <para> | 8 | <para> |
| 9 | Welcome to the Yocto Project Application Developer's Guide. | 9 | Welcome to the Yocto Project Application Developer's Guide. |
| 10 | This manual provides information that lets you begin developing applications | 10 | This manual provides information that lets you begin developing applications |
| 11 | using the Yocto Project. | 11 | using the Yocto Project. |
| 12 | </para> | 12 | </para> |
| 13 | 13 | ||
| 14 | <para> | 14 | <para> |
| 15 | The Yocto Project provides an application development environment based on | 15 | The Yocto Project provides an application development environment based on |
| 16 | an Application Development Toolkit (ADT) and the availability of stand-alone | 16 | an Application Development Toolkit (ADT) and the availability of stand-alone |
| 17 | cross-development toolchains and other tools. | 17 | cross-development toolchains and other tools. |
| 18 | This manual describes the ADT and how you can configure and install it, | 18 | This manual describes the ADT and how you can configure and install it, |
| 19 | how to access and use the cross-development toolchains, how to | 19 | how to access and use the cross-development toolchains, how to |
| 20 | customize the development packages installation, | 20 | customize the development packages installation, |
| 21 | how to use command line development for both Autotools-based and Makefile-based projects, | 21 | how to use command line development for both Autotools-based and Makefile-based projects, |
| 22 | and an introduction to the Eclipse Yocto Plug-in. | 22 | and an introduction to the Eclipse Yocto Plug-in. |
| 23 | </para> | 23 | </para> |
| 24 | 24 | ||
| 25 | <section id='adt-intro-section'> | 25 | <section id='adt-intro-section'> |
| 26 | <title>The Application Development Toolkit (ADT)</title> | 26 | <title>The Application Development Toolkit (ADT)</title> |
| 27 | 27 | ||
| 28 | <para> | 28 | <para> |
| 29 | Part of the Yocto Project development solution is an Application Development | 29 | Part of the Yocto Project development solution is an Application Development |
| 30 | Toolkit (ADT). | 30 | Toolkit (ADT). |
| 31 | The ADT provides you with a custom-built, cross-development | 31 | The ADT provides you with a custom-built, cross-development |
| 32 | platform suited for developing a user-targeted product application. | 32 | platform suited for developing a user-targeted product application. |
| 33 | </para> | 33 | </para> |
| 34 | 34 | ||
| 35 | <para> | 35 | <para> |
| 36 | Fundamentally, the ADT consists of the following: | 36 | Fundamentally, the ADT consists of the following: |
| 37 | <itemizedlist> | 37 | <itemizedlist> |
| 38 | <listitem><para>An architecture-specific cross-toolchain and matching | 38 | <listitem><para>An architecture-specific cross-toolchain and matching |
| 39 | sysroot both built by the OpenEmbedded build system, which uses Poky. | 39 | sysroot both built by the OpenEmbedded build system, which uses Poky. |
| 40 | The toolchain and sysroot are based on a metadata configuration and extensions, | 40 | The toolchain and sysroot are based on a metadata configuration and extensions, |
| 41 | which allows you to cross-develop on the host machine for the target hardware. | 41 | which allows you to cross-develop on the host machine for the target hardware. |
| 42 | </para></listitem> | 42 | </para></listitem> |
| 43 | <listitem><para>The Eclipse IDE Yocto Plug-in.</para></listitem> | 43 | <listitem><para>The Eclipse IDE Yocto Plug-in.</para></listitem> |
| 44 | <listitem><para>The Quick EMUlator (QEMU), which lets you simulate target hardware. | 44 | <listitem><para>The Quick EMUlator (QEMU), which lets you simulate target hardware. |
| 45 | </para></listitem> | 45 | </para></listitem> |
| 46 | <listitem><para>Various user-space tools that greatly enhance your application | 46 | <listitem><para>Various user-space tools that greatly enhance your application |
| 47 | development experience.</para></listitem> | 47 | development experience.</para></listitem> |
| 48 | </itemizedlist> | 48 | </itemizedlist> |
| 49 | </para> | 49 | </para> |
| @@ -52,13 +52,13 @@ | |||
| 52 | <title>The Cross-Toolchain</title> | 52 | <title>The Cross-Toolchain</title> |
| 53 | 53 | ||
| 54 | <para> | 54 | <para> |
| 55 | The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger | 55 | The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger |
| 56 | that are used to develop user-space applications for targeted hardware. | 56 | that are used to develop user-space applications for targeted hardware. |
| 57 | This toolchain is created either by running the ADT Installer script, a toolchain installer | 57 | This toolchain is created either by running the ADT Installer script, a toolchain installer |
| 58 | script, or through a | 58 | script, or through a |
| 59 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> that | 59 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> that |
| 60 | is based on your metadata | 60 | is based on your metadata |
| 61 | configuration or extension for your targeted device. | 61 | configuration or extension for your targeted device. |
| 62 | The cross-toolchain works with a matching target sysroot. | 62 | The cross-toolchain works with a matching target sysroot. |
| 63 | </para> | 63 | </para> |
| 64 | </section> | 64 | </section> |
| @@ -67,10 +67,10 @@ | |||
| 67 | <title>Sysroot</title> | 67 | <title>Sysroot</title> |
| 68 | 68 | ||
| 69 | <para> | 69 | <para> |
| 70 | The matching target sysroot contains needed headers and libraries for generating | 70 | The matching target sysroot contains needed headers and libraries for generating |
| 71 | binaries that run on the target architecture. | 71 | binaries that run on the target architecture. |
| 72 | The sysroot is based on the target root filesystem image that is built by | 72 | The sysroot is based on the target root filesystem image that is built by |
| 73 | the OpenEmbedded build system Poky and uses the same metadata configuration | 73 | the OpenEmbedded build system Poky and uses the same metadata configuration |
| 74 | used to build the cross-toolchain. | 74 | used to build the cross-toolchain. |
| 75 | </para> | 75 | </para> |
| 76 | </section> | 76 | </section> |
| @@ -79,24 +79,24 @@ | |||
| 79 | <title>Eclipse Yocto Plug-in</title> | 79 | <title>Eclipse Yocto Plug-in</title> |
| 80 | 80 | ||
| 81 | <para> | 81 | <para> |
| 82 | The Eclipse IDE is a popular development environment and it fully supports | 82 | The Eclipse IDE is a popular development environment and it fully supports |
| 83 | development using the Yocto Project. | 83 | development using the Yocto Project. |
| 84 | When you install and configure the Eclipse Yocto Project Plug-in into | 84 | When you install and configure the Eclipse Yocto Project Plug-in into |
| 85 | the Eclipse IDE, you maximize your Yocto Project experience. | 85 | the Eclipse IDE, you maximize your Yocto Project experience. |
| 86 | Installing and configuring the Plug-in results in an environment that | 86 | Installing and configuring the Plug-in results in an environment that |
| 87 | has extensions specifically designed to let you more easily develop software. | 87 | has extensions specifically designed to let you more easily develop software. |
| 88 | These extensions allow for cross-compilation, deployment, and execution of | 88 | These extensions allow for cross-compilation, deployment, and execution of |
| 89 | your output into a QEMU emulation session. | 89 | your output into a QEMU emulation session. |
| 90 | You can also perform cross-debugging and profiling. | 90 | You can also perform cross-debugging and profiling. |
| 91 | The environment also supports a suite of tools that allows you to perform | 91 | The environment also supports a suite of tools that allows you to perform |
| 92 | remote profiling, tracing, collection of power data, collection of | 92 | remote profiling, tracing, collection of power data, collection of |
| 93 | latency data, and collection of performance data. | 93 | latency data, and collection of performance data. |
| 94 | </para> | 94 | </para> |
| 95 | 95 | ||
| 96 | <para> | 96 | <para> |
| 97 | For information about the application development workflow that uses the Eclipse | 97 | For information about the application development workflow that uses the Eclipse |
| 98 | IDE and for a detailed example of how to install and configure the Eclipse | 98 | IDE and for a detailed example of how to install and configure the Eclipse |
| 99 | Yocto Project Plug-in, see the | 99 | Yocto Project Plug-in, see the |
| 100 | "<ulink url='&YOCTO_DOCS_DEV_URL;#adt-eclipse'>Working Within Eclipse</ulink>" section | 100 | "<ulink url='&YOCTO_DOCS_DEV_URL;#adt-eclipse'>Working Within Eclipse</ulink>" section |
| 101 | of the Yocto Project Development Manual. | 101 | of the Yocto Project Development Manual. |
| 102 | </para> | 102 | </para> |
| @@ -106,19 +106,19 @@ | |||
| 106 | <title>The QEMU Emulator</title> | 106 | <title>The QEMU Emulator</title> |
| 107 | 107 | ||
| 108 | <para> | 108 | <para> |
| 109 | The QEMU emulator allows you to simulate your hardware while running your | 109 | The QEMU emulator allows you to simulate your hardware while running your |
| 110 | application or image. | 110 | application or image. |
| 111 | QEMU is made available a number of ways: | 111 | QEMU is made available a number of ways: |
| 112 | <itemizedlist> | 112 | <itemizedlist> |
| 113 | <listitem><para>If you use the ADT Installer script to install ADT, you can | 113 | <listitem><para>If you use the ADT Installer script to install ADT, you can |
| 114 | specify whether or not to install QEMU.</para></listitem> | 114 | specify whether or not to install QEMU.</para></listitem> |
| 115 | <listitem><para>If you have downloaded a Yocto Project release and unpacked | 115 | <listitem><para>If you have downloaded a Yocto Project release and unpacked |
| 116 | it to create a | 116 | it to create a |
| 117 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> and | 117 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> and |
| 118 | you have sourced | 118 | you have sourced |
| 119 | the environment setup script, QEMU is installed and automatically | 119 | the environment setup script, QEMU is installed and automatically |
| 120 | available.</para></listitem> | 120 | available.</para></listitem> |
| 121 | <listitem><para>If you have installed the cross-toolchain | 121 | <listitem><para>If you have installed the cross-toolchain |
| 122 | tarball and you have sourcing the toolchain's setup environment script, QEMU | 122 | tarball and you have sourcing the toolchain's setup environment script, QEMU |
| 123 | is also installed and automatically available.</para></listitem> | 123 | is also installed and automatically available.</para></listitem> |
| 124 | </itemizedlist> | 124 | </itemizedlist> |
| @@ -129,38 +129,38 @@ | |||
| 129 | <title>User-Space Tools</title> | 129 | <title>User-Space Tools</title> |
| 130 | 130 | ||
| 131 | <para> | 131 | <para> |
| 132 | User-space tools are included as part of the distribution. | 132 | User-space tools are included as part of the distribution. |
| 133 | You will find these tools helpful during development. | 133 | You will find these tools helpful during development. |
| 134 | The tools include LatencyTOP, PowerTOP, OProfile, Perf, SystemTap, and Lttng-ust. | 134 | The tools include LatencyTOP, PowerTOP, OProfile, Perf, SystemTap, and Lttng-ust. |
| 135 | These tools are common development tools for the Linux platform. | 135 | These tools are common development tools for the Linux platform. |
| 136 | <itemizedlist> | 136 | <itemizedlist> |
| 137 | <listitem><para><emphasis>LatencyTOP:</emphasis> LatencyTOP focuses on latency | 137 | <listitem><para><emphasis>LatencyTOP:</emphasis> LatencyTOP focuses on latency |
| 138 | that causes skips in audio, | 138 | that causes skips in audio, |
| 139 | stutters in your desktop experience, or situations that overload your server | 139 | stutters in your desktop experience, or situations that overload your server |
| 140 | even when you have plenty of CPU power left. | 140 | even when you have plenty of CPU power left. |
| 141 | You can find out more about LatencyTOP at | 141 | You can find out more about LatencyTOP at |
| 142 | <ulink url='http://www.latencytop.org/'></ulink>.</para></listitem> | 142 | <ulink url='http://www.latencytop.org/'></ulink>.</para></listitem> |
| 143 | <listitem><para><emphasis>PowerTOP:</emphasis> Helps you determine what | 143 | <listitem><para><emphasis>PowerTOP:</emphasis> Helps you determine what |
| 144 | software is using the most power. | 144 | software is using the most power. |
| 145 | You can find out more about PowerTOP at | 145 | You can find out more about PowerTOP at |
| 146 | <ulink url='https://01.org/powertop/'></ulink>.</para></listitem> | 146 | <ulink url='https://01.org/powertop/'></ulink>.</para></listitem> |
| 147 | <listitem><para><emphasis>OProfile:</emphasis> A system-wide profiler for Linux | 147 | <listitem><para><emphasis>OProfile:</emphasis> A system-wide profiler for Linux |
| 148 | systems that is capable of profiling all running code at low overhead. | 148 | systems that is capable of profiling all running code at low overhead. |
| 149 | You can find out more about OProfile at | 149 | You can find out more about OProfile at |
| 150 | <ulink url='http://oprofile.sourceforge.net/about/'></ulink>.</para></listitem> | 150 | <ulink url='http://oprofile.sourceforge.net/about/'></ulink>.</para></listitem> |
| 151 | <listitem><para><emphasis>Perf:</emphasis> Performance counters for Linux used | 151 | <listitem><para><emphasis>Perf:</emphasis> Performance counters for Linux used |
| 152 | to keep track of certain types of hardware and software events. | 152 | to keep track of certain types of hardware and software events. |
| 153 | For more information on these types of counters see | 153 | For more information on these types of counters see |
| 154 | <ulink url='https://perf.wiki.kernel.org/'></ulink> and click | 154 | <ulink url='https://perf.wiki.kernel.org/'></ulink> and click |
| 155 | on “Perf tools.”</para></listitem> | 155 | on “Perf tools.”</para></listitem> |
| 156 | <listitem><para><emphasis>SystemTap:</emphasis> A free software infrastructure | 156 | <listitem><para><emphasis>SystemTap:</emphasis> A free software infrastructure |
| 157 | that simplifies information gathering about a running Linux system. | 157 | that simplifies information gathering about a running Linux system. |
| 158 | This information helps you diagnose performance or functional problems. | 158 | This information helps you diagnose performance or functional problems. |
| 159 | SystemTap is not available as a user-space tool through the Eclipse IDE Yocto Plug-in. | 159 | SystemTap is not available as a user-space tool through the Eclipse IDE Yocto Plug-in. |
| 160 | See <ulink url='http://sourceware.org/systemtap'></ulink> for more information | 160 | See <ulink url='http://sourceware.org/systemtap'></ulink> for more information |
| 161 | on SystemTap.</para></listitem> | 161 | on SystemTap.</para></listitem> |
| 162 | <listitem><para><emphasis>Lttng-ust:</emphasis> A User-space Tracer designed to | 162 | <listitem><para><emphasis>Lttng-ust:</emphasis> A User-space Tracer designed to |
| 163 | provide detailed information on user-space activity. | 163 | provide detailed information on user-space activity. |
| 164 | See <ulink url='http://lttng.org/ust'></ulink> for more information on Lttng-ust. | 164 | See <ulink url='http://lttng.org/ust'></ulink> for more information on Lttng-ust. |
| 165 | </para></listitem> | 165 | </para></listitem> |
| 166 | </itemizedlist> | 166 | </itemizedlist> |
