diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-07-17 11:25:27 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-07-18 12:43:51 +0100 |
commit | bf1cc56becccad23a8a86dd352689db8cdceac22 (patch) | |
tree | 5d50a9e8bde31b4438c17b997eac8d752965732b /documentation/adt-manual | |
parent | e6d3b5c6778c3c751ca2fb773f9179dc20d775f7 (diff) | |
download | poky-bf1cc56becccad23a8a86dd352689db8cdceac22.tar.gz |
documentation/adt-manual/adt-intro.xml: Edits to introduction chapter
I edited the text so that the purpose of the manual is clearer.
I have segmented out the ADT into distinct components and made sure
the overviews of each is good. Edits to clarify the role of the
ADT as well.
(From yocto-docs rev: c4abd8305dcdba986f1e761887c740e8322bb331)
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')
-rw-r--r-- | documentation/adt-manual/adt-intro.xml | 76 |
1 files changed, 49 insertions, 27 deletions
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml index ac286a5840..04c47369f9 100644 --- a/documentation/adt-manual/adt-intro.xml +++ b/documentation/adt-manual/adt-intro.xml | |||
@@ -3,46 +3,49 @@ | |||
3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > |
4 | 4 | ||
5 | <chapter id='adt-intro'> | 5 | <chapter id='adt-intro'> |
6 | <title>Introduction</title> | ||
6 | 7 | ||
7 | <title>Application Development Toolkit (ADT) User's Guide</title> | 8 | <para> |
9 | Welcome to the Yocto Project Application Developer's Guide. | ||
10 | This manual provides information that lets you begin developing applications | ||
11 | using the Yocto Project. | ||
12 | </para> | ||
8 | 13 | ||
9 | <para> | 14 | <para> |
10 | Welcome to the Application Development Toolkit User’s Guide. This manual provides | 15 | The Yocto Project provides an application development environment based on |
11 | information that lets you get going with the ADT to develop projects using the Yocto | 16 | an Application Development Toolkit (ADT). |
12 | Project. | 17 | This manual describes the ADT and how you can configure and install it. |
18 | You will also learn how to customize the development packages installation, | ||
19 | learn about the Eclipse Yocto Plug-in, and learn how to use command line | ||
20 | development for both Autotools-based and Makefile-based projects. | ||
13 | </para> | 21 | </para> |
14 | 22 | ||
15 | <section id='book-intro'> | 23 | <section id='book-intro'> |
16 | <title>Introducing the Application Development Toolkit (ADT)</title> | 24 | <title>The Application Development Toolkit (ADT)</title> |
17 | 25 | ||
18 | <para> | 26 | <para> |
19 | Fundamentally, the ADT consists of an architecture-specific cross-toolchain and | 27 | Part of the Yocto Project development solution is an Application Development |
20 | a matching sysroot that are both built by the OpenEmbedded build system Poky. | 28 | Toolkit (ADT). |
21 | The toolchain and sysroot are based on a metadata configuration and extensions, | 29 | The ADT provides you with a custom-built, cross-development |
22 | which allows you to cross-develop on the host machine for the target. | 30 | platform suited for developing a user-targeted product application. |
23 | </para> | 31 | </para> |
24 | 32 | ||
25 | <para> | 33 | <para> |
26 | Additionally, to provide an effective development platform, the Yocto Project | 34 | Fundamentally, the ADT consists of the following: |
27 | makes available and suggests other tools you can use with the ADT. | 35 | <itemizedlist> |
28 | These other tools include the Eclipse IDE Yocto Plug-in, an emulator (QEMU), | 36 | <listitem><para>An architecture-specific cross-toolchain and matching |
29 | and various user-space tools that greatly enhance your development experience. | 37 | sysroot both built by the OpenEmbedded build system, which uses Poky. |
38 | The toolchain and sysroot are based on a metadata configuration and extensions, | ||
39 | which allows you to cross-develop on the host machine for the target hardware. | ||
40 | </para></listitem> | ||
41 | <listitem><para>The Eclipse IDE Yocto Plug-in.</para></listitem> | ||
42 | <listitem><para>The Quick EMUlator (QEMU), which lets you simulate target hardware. | ||
43 | </para></listitem> | ||
44 | <listitem><para>Various user-space tools that greatly enhance your application | ||
45 | development experience.</para></listitem> | ||
46 | </itemizedlist> | ||
30 | </para> | 47 | </para> |
31 | 48 | ||
32 | <para> | ||
33 | The resulting combination of the architecture-specific cross-toolchain and sysroot | ||
34 | along with these additional tools yields a custom-built, cross-development platform | ||
35 | for a user-targeted product. | ||
36 | </para> | ||
37 | </section> | ||
38 | |||
39 | <section id='adt-components'> | ||
40 | <title>ADT Components</title> | ||
41 | |||
42 | <para> | ||
43 | This section provides a brief description of what comprises the ADT. | ||
44 | </para> | ||
45 | |||
46 | <section id='the-cross-toolchain'> | 49 | <section id='the-cross-toolchain'> |
47 | <title>The Cross-Toolchain</title> | 50 | <title>The Cross-Toolchain</title> |
48 | 51 | ||
@@ -68,6 +71,25 @@ | |||
68 | </para> | 71 | </para> |
69 | </section> | 72 | </section> |
70 | 73 | ||
74 | <section id='eclipse-overview'> | ||
75 | <title>Eclipse Yocto Plug-in</title> | ||
76 | |||
77 | <para> | ||
78 | The Eclipse IDE is a popular development environment and it fully supports | ||
79 | development using the Yocto Project. | ||
80 | When you install and configure the Eclipse Yocto Project Plug-in into | ||
81 | the Eclipse IDE, you maximize your Yocto Project experience. | ||
82 | Installing and configuring the Plug-in results in an environment that | ||
83 | has extensions specifically designed to let you more easily develop software. | ||
84 | These extensions allow for cross-compilation, deployment, and execution of | ||
85 | your output into a QEMU emulation session. | ||
86 | You can also perform cross-debugging and profiling. | ||
87 | The environment also supports a suite of tools that allows you to perform | ||
88 | remote profiling, tracing, collection of power data, collection of | ||
89 | latency data, and collection of performance data. | ||
90 | </para> | ||
91 | </section> | ||
92 | |||
71 | <section id='the-qemu-emulator'> | 93 | <section id='the-qemu-emulator'> |
72 | <title>The QEMU Emulator</title> | 94 | <title>The QEMU Emulator</title> |
73 | 95 | ||