]> git.ipfire.org Git - thirdparty/openembedded/openembedded-core-contrib.git/commitdiff
documentation/adt-manual/adt-intro.xml: Edits to introduction chapter
authorScott Rifenbark <scott.m.rifenbark@intel.com>
Tue, 17 Jul 2012 18:25:27 +0000 (11:25 -0700)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Wed, 18 Jul 2012 11:43:51 +0000 (12:43 +0100)
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>
documentation/adt-manual/adt-intro.xml

index ac286a58407e0f0af7e3e2b614b0f1d3eead3135..04c47369f9443d315a1d12a18d54224c4cad08fb 100644 (file)
@@ -3,46 +3,49 @@
 [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
 
 <chapter id='adt-intro'>
+<title>Introduction</title>
 
-<title>Application Development Toolkit (ADT) User's Guide</title>
+<para>
+    Welcome to the Yocto Project Application Developer's Guide.  
+    This manual provides information that lets you begin developing applications 
+    using the Yocto Project.
+</para>
 
 <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.
+    The Yocto Project provides an application development environment based on 
+    an Application Development Toolkit (ADT).
+    This manual describes the ADT and how you can configure and install it.
+    You will also learn how to customize the development packages installation,
+    learn about the Eclipse Yocto Plug-in, and learn how to use command line
+    development for both Autotools-based and Makefile-based projects. 
 </para>
 
 <section id='book-intro'>
-    <title>Introducing the Application Development Toolkit (ADT)</title>
+    <title>The Application Development Toolkit (ADT)</title>
 
     <para>
-        Fundamentally, the ADT consists of an architecture-specific cross-toolchain and 
-        a matching sysroot that are both built by the OpenEmbedded build system Poky.  
-        The toolchain and sysroot are based on a metadata configuration and extensions, 
-        which allows you to cross-develop on the host machine for the target.
+        Part of the Yocto Project development solution is an Application Development 
+        Toolkit (ADT).
+        The ADT provides you with a custom-built, cross-development 
+        platform suited for developing a user-targeted product application.
     </para>
 
     <para>
-        Additionally, to provide an effective development platform, the Yocto Project 
-        makes available and suggests other tools you can use with 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.
+        Fundamentally, the ADT consists of the following:
+        <itemizedlist>
+            <listitem><para>An architecture-specific cross-toolchain and matching 
+                sysroot both built by the OpenEmbedded build system, which uses Poky.
+                The toolchain and sysroot are based on a metadata configuration and extensions, 
+                which allows you to cross-develop on the host machine for the target hardware.
+                </para></listitem>
+            <listitem><para>The Eclipse IDE Yocto Plug-in.</para></listitem>
+            <listitem><para>The Quick EMUlator (QEMU), which lets you simulate target hardware.
+                </para></listitem>
+            <listitem><para>Various user-space tools that greatly enhance your application 
+                development experience.</para></listitem>
+        </itemizedlist>
     </para>
 
-    <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='adt-components'>
-    <title>ADT Components</title>
-
-    <para>
-        This section provides a brief description of what comprises the ADT.
-    </para>
-    
     <section id='the-cross-toolchain'>
         <title>The Cross-Toolchain</title>
 
         </para>
     </section>
 
+    <section id='eclipse-overview'>
+        <title>Eclipse Yocto Plug-in</title>
+
+        <para>
+            The Eclipse IDE is a popular development environment and it fully supports 
+            development using the Yocto Project.  
+            When you install and configure the Eclipse Yocto Project Plug-in into 
+            the Eclipse IDE, you maximize your Yocto Project 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, deployment, and execution of 
+            your output into a QEMU emulation session.  
+            You can also perform cross-debugging and profiling.  
+            The environment also supports 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>
+    </section>
+
     <section id='the-qemu-emulator'>
         <title>The QEMU Emulator</title>