summaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual/adt-intro.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-09-01 09:18:33 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-09-02 23:38:51 +0100
commit77d1ba446c153afbe9fde7fcfa7afdd734104f9e (patch)
treef771e2243359e0e3814cef22dd220d1a4d01c70b /documentation/adt-manual/adt-intro.xml
parentb214cdc7e8105c59c806042d5d994216de409025 (diff)
downloadpoky-77d1ba446c153afbe9fde7fcfa7afdd734104f9e.tar.gz
documentation/adt-manual: General edits.
I made a pass through the manual and made some general formatting changes, updated some links in anticipation for the 1.1 release. (From yocto-docs rev: f2d3a012fbe4e8db3cf07e5497acfdf732e55d97) 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.xml108
1 files changed, 58 insertions, 50 deletions
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml
index 220eb4b54b..211b174dc6 100644
--- a/documentation/adt-manual/adt-intro.xml
+++ b/documentation/adt-manual/adt-intro.xml
@@ -13,29 +13,41 @@
13 13
14<section id='book-intro'> 14<section id='book-intro'>
15 <title>Introducing the Application Development Toolkit (ADT)</title> 15 <title>Introducing the Application Development Toolkit (ADT)</title>
16
16 <para> 17 <para>
17 Fundamentally, the ADT consists of an architecture-specific cross-toolchain and 18 Fundamentally, the ADT consists of an architecture-specific cross-toolchain and
18 a matching sysroot that are both built by the Poky build system. 19 a matching sysroot that are both built by the Yocto Project build system Poky.
19 The toolchain and sysroot are based on a metadata configuration and extensions, 20 The toolchain and sysroot are based on a metadata configuration and extensions,
20 which allows you to cross develop for the target on the host machine. 21 which allows you to cross-develop on the host machine for the target.
21 </para> 22 </para>
23
22 <para> 24 <para>
23 Additionally, to provide an effective development platform, the Yocto Project 25 Additionally, to provide an effective development platform, the Yocto Project
24 makes available and suggests other tools you can use with the ADT. 26 makes available and suggests other tools you can use with the ADT.
25 These other tools include the Eclipse IDE Yocto Plug-in, an emulator (QEMU), 27 These other tools include the Eclipse IDE Yocto Plug-in, an emulator (QEMU),
26 and various user-space tools that greatly enhance your development experience. 28 and various user-space tools that greatly enhance your development experience.
27 </para> 29 </para>
30
28 <para> 31 <para>
29 The resulting combination of the architecture-specific cross-toolchain and sysroot 32 The resulting combination of the architecture-specific cross-toolchain and sysroot
30 along with these additional tools yields a custom-built, cross-development platform 33 along with these additional tools yields a custom-built, cross-development platform
31 for a user-targeted product. 34 for a user-targeted product.
32 </para> 35 </para>
36</section>
37
38<section id='adt-components'>
39 <title>ADT Components</title>
40
41 <para>
42 This section provides a brief description of what comprises the ADT.
43 </para>
33 44
34 <section id='the-cross-toolchain'> 45 <section id='the-cross-toolchain'>
35 <title>The Cross-Toolchain</title> 46 <title>The Cross-Toolchain</title>
47
36 <para> 48 <para>
37 The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger 49 The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger
38 that are used to develop for targeted hardware. 50 that are used to develop user-space applications for targeted hardware.
39 This toolchain is created either by running the ADT Installer script or 51 This toolchain is created either by running the ADT Installer script or
40 through a Yocto Project build tree that is based on your metadata 52 through a Yocto Project build tree that is based on your metadata
41 configuration or extension for your targeted device. 53 configuration or extension for your targeted device.
@@ -45,80 +57,76 @@
45 57
46 <section id='sysroot'> 58 <section id='sysroot'>
47 <title>Sysroot</title> 59 <title>Sysroot</title>
60
48 <para> 61 <para>
49 The matching target sysroot contains needed headers and libraries for generating 62 The matching target sysroot contains needed headers and libraries for generating
50 binaries that run on the target architecture. 63 binaries that run on the target architecture.
51 The sysroot is based on the target root filesystem image that is built by 64 The sysroot is based on the target root filesystem image that is built by
52 Poky and uses the same metadata configuration used to build the cross-toolchain. 65 the Yocto Project's build system Poky and uses the same metadata configuration
66 used to build the cross-toolchain.
53 </para> 67 </para>
54 </section> 68 </section>
55 69
56 <section id='the-qemu-emulator'> 70 <section id='the-qemu-emulator'>
57 <title>The QEMU Emulator</title> 71 <title>The QEMU Emulator</title>
72
58 <para> 73 <para>
59 The QEMU emulator allows you to simulate your hardware while running your 74 The QEMU emulator allows you to simulate your hardware while running your
60 application or image. 75 application or image.
61 QEMU is made available a number of ways: 76 QEMU is made available a number of ways:
62 <itemizedlist> 77 <itemizedlist>
63 <listitem><para>If you use the ADT Installer script to install ADT you can 78 <listitem><para>If you use the ADT Installer script to install ADT, you can
64 specify whether or not to install QEMU.</para></listitem> 79 specify whether or not to install QEMU.</para></listitem>
65 <listitem><para>If you have downloaded a Yocto Project release and unpacked 80 <listitem><para>If you have downloaded a Yocto Project release and unpacked
66 it to create a Yocto Project source directory followed by sourcing 81 it to create a Yocto Project file structure and you have sourced
67 the Yocto Project environment setup script, QEMU is installed and automatically 82 the Yocto Project environment setup script, QEMU is installed and automatically
68 available.</para></listitem> 83 available.</para></listitem>
69 <listitem><para>If you have installed the cross-toolchain 84 <listitem><para>If you have installed the cross-toolchain
70 tarball followed by sourcing the toolchain's setup environment script, QEMU 85 tarball and you have sourcing the toolchain's setup environment script, QEMU
71 is installed and automatically available.</para></listitem> 86 is also installed and automatically available.</para></listitem>
72 </itemizedlist> 87 </itemizedlist>
73 </para> 88 </para>
74 </section> 89 </section>
75 90
76 <section id='user-space-tools'> 91 <section id='user-space-tools'>
77 <title>User-Space Tools</title> 92 <title>User-Space Tools</title>
93
78 <para> 94 <para>
79 User-space tools are included as part of the distribution. 95 User-space tools are included as part of the distribution.
80 You will find these tools helpful during development. 96 You will find these tools helpful during development.
81 The tools include LatencyTOP, PowerTOP, OProfile, Perf, SystemTap, and Lttng-ust. 97 The tools include LatencyTOP, PowerTOP, OProfile, Perf, SystemTap, and Lttng-ust.
82 These tools are common development tools for the Linux platform. 98 These tools are common development tools for the Linux platform.
83 <itemizedlist> 99 <itemizedlist>
84 <listitem><para><emphasis>LatencyTOP</emphasis> – LatencyTOP focuses on latency 100 <listitem><para><emphasis>LatencyTOP:</emphasis> LatencyTOP focuses on latency
85 that causes skips in audio, 101 that causes skips in audio,
86 stutters in your desktop experience, or situations that overload your server 102 stutters in your desktop experience, or situations that overload your server
87 even when you have plenty of CPU power left. 103 even when you have plenty of CPU power left.
88 You can find out more about LatencyTOP at 104 You can find out more about LatencyTOP at
89 <ulink url='http://www.latencytop.org/'></ulink>. 105 <ulink url='http://www.latencytop.org/'></ulink>.</para></listitem>
90 </para></listitem> 106 <listitem><para><emphasis>PowerTOP:</emphasis> Helps you determine what
91 <listitem><para><emphasis>PowerTOP</emphasis> – Helps you determine what 107 software is using the most power.
92 software is using the most power. 108 You can find out more about PowerTOP at
93 You can find out more about PowerTOP at 109 <ulink url='http://www.linuxpowertop.org/'></ulink>.</para></listitem>
94 <ulink url='http://www.linuxpowertop.org/'></ulink>. 110 <listitem><para><emphasis>OProfile:</emphasis> A system-wide profiler for Linux
95 </para></listitem> 111 systems that is capable of profiling all running code at low overhead.
96 <listitem><para><emphasis>OProfile</emphasis> – A system-wide profiler for Linux 112 You can find out more about OProfile at
97 systems that is capable 113 <ulink url='http://oprofile.sourceforge.net/about/'></ulink>.</para></listitem>
98 of profiling all running code at low overhead. 114 <listitem><para><emphasis>Perf:</emphasis> Performance counters for Linux used
99 You can find out more about OProfile at 115 to keep track of certain types of hardware and software events.
100 <ulink url='http://oprofile.sourceforge.net/about/'></ulink>. 116 For more information on these types of counters see
101 </para></listitem> 117 <ulink url='https://perf.wiki.kernel.org/index.php'></ulink> and click
102 <listitem><para><emphasis>Perf</emphasis> – Performance counters for Linux used 118 on “Perf tools.”</para></listitem>
103 to keep track of certain 119 <listitem><para><emphasis>SystemTap:</emphasis> A free software infrastructure
104 types of hardware and software events. 120 that simplifies information gathering about a running Linux system.
105 For more information on these types of counters see 121 This information helps you diagnose performance or functional problems.
106 <ulink url='https://perf.wiki.kernel.org/index.php'></ulink> and click 122 SystemTap is not available as a user-space tool through the Yocto Eclipse IDE Plug-in.
107 on “Perf tools.” 123 See <ulink url='http://sourceware.org/systemtap'></ulink> for more information
108 </para></listitem> 124 on SystemTap.</para></listitem>
109 <listitem><para><emphasis>SystemTap</emphasis> – A free software infrastructure 125 <listitem><para><emphasis>Lttng-ust:</emphasis> A User-space Tracer designed to
110 that simplifies 126 provide detailed information on user-space activity.
111 information gathering about a running Linux system. 127 See <ulink url='http://lttng.org/ust'></ulink> for more information on Lttng-ust.
112 This information helps you diagnose performance or functional problems. 128 </para></listitem>
113 SystemTap is not available as a user-space tool through the Yocto Eclipse IDE Plug-in. 129 </itemizedlist>
114 See <ulink url='http://sourceware.org/systemtap'></ulink> for more information
115 on SystemTap.
116 </para></listitem>
117 <listitem><para><emphasis>Lttng-ust</emphasis> – A User-space Tracer designed to
118 provide detailed information on user-space activity.
119 See <ulink url='http://lttng.org/ust'></ulink> for more information on Lttng-ust.
120 </para></listitem>
121 </itemizedlist>
122 </para> 130 </para>
123 </section> 131 </section>
124</section> 132</section>