diff options
Diffstat (limited to 'documentation/adt-manual/adt-intro.xml')
-rw-r--r-- | documentation/adt-manual/adt-intro.xml | 132 |
1 files changed, 96 insertions, 36 deletions
diff --git a/documentation/adt-manual/adt-intro.xml b/documentation/adt-manual/adt-intro.xml index c1e283a65f..8740e5cf3e 100644 --- a/documentation/adt-manual/adt-intro.xml +++ b/documentation/adt-manual/adt-intro.xml | |||
@@ -3,53 +3,113 @@ | |||
3 | 3 | ||
4 | <chapter id='adt-intro'> | 4 | <chapter id='adt-intro'> |
5 | 5 | ||
6 | <title>Yocto Project Kernel Architecture and Use Manual</title> | 6 | <title>Application Development Toolkit (ADT) User's Guide</title> |
7 | |||
8 | <para> | ||
9 | Welcome to the Application Development Toolkit User’s Guide. This manual provides | ||
10 | information that lets you get going with the ADT to develop projects using the Yocto | ||
11 | Project. | ||
12 | </para> | ||
7 | 13 | ||
8 | <section id='book-intro'> | 14 | <section id='book-intro'> |
9 | <title>Introduction</title> | 15 | <title>Introducing the Application Development Toolkit (ADT)</title> |
10 | <para> | 16 | <para> |
11 | The Yocto Project presents the kernel as a fully patched, history-clean git | 17 | Fundamentally, the ADT consists of an architecture-specific cross-toolchain and |
12 | repository. | 18 | a matching sysroot that are both built by the Poky build system. |
13 | The git tree represents the selected features, board support, | 19 | The toolchain and sysroot are based on a metadata configuration and extensions, |
14 | and configurations extensively tested by Yocto Project. | 20 | which allows you to cross develop for the target on the host machine. |
15 | The Yocto Project kernel allows the end user to leverage community | ||
16 | best practices to seamlessly manage the development, build and debug cycles. | ||
17 | </para> | 21 | </para> |
18 | <para> | 22 | <para> |
19 | This manual describes the Yocto Project kernel by providing information | 23 | Additionally, to provide an effective development platform, the Yocto Project |
20 | on its history, organization, benefits, and use. | 24 | makes available and suggests other tools as part of the ADT. |
21 | The manual consists of two sections: | 25 | These other tools include the Eclipse IDE Yocto Plug-in, an emulator (QEMU), |
22 | <itemizedlist> | 26 | and various user-space tools that greatly enhance your development experience. |
23 | <listitem><para>Concepts - Describes concepts behind the kernel. | ||
24 | You will understand how the kernel is organized and why it is organized in | ||
25 | the way it is. You will understand the benefits of the kernel's organization | ||
26 | and the mechanisms used to work with the kernel and how to apply it in your | ||
27 | design process.</para></listitem> | ||
28 | <listitem><para>Using the Kernel - Describes best practices and "how-to" information | ||
29 | that lets you put the kernel to practical use. Some examples are "How to Build a | ||
30 | Project Specific Tree", "How to Examine Changes in a Branch", and "Saving Kernel | ||
31 | Modifications."</para></listitem> | ||
32 | </itemizedlist> | ||
33 | </para> | 27 | </para> |
34 | <para> | 28 | <para> |
35 | For more information on the kernel, see the following links: | 29 | The resulting combination of the architecture-specific cross-toolchain and sysroot |
36 | <itemizedlist> | 30 | along with these additional tools yields a custom-built, cross-development platform |
37 | <listitem><para><ulink url='http://ldn.linuxfoundation.org/book/1-a-guide-kernel-development-process'></ulink></para></listitem> | 31 | for a user-targeted product. |
38 | <listitem><para><ulink url='http://userweb.kernel.org/~akpm/stuff/tpp.txt'></ulink></para></listitem> | ||
39 | <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> | ||
40 | </itemizedlist> | ||
41 | <para> | ||
42 | You can find more information on Yocto Project by visiting the website at | ||
43 | <ulink url='http://www.yoctoproject.org'></ulink>. | ||
44 | </para> | ||
45 | </para> | 32 | </para> |
46 | </section> | 33 | |
47 | 34 | <section id='the-cross-toolchain'> | |
48 | 35 | <title>The Cross-Toolchain</title> | |
49 | 36 | <para> | |
37 | The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger | ||
38 | that are all generated through a Poky build that is based on your metadata | ||
39 | configuration or extension for your targeted device. | ||
40 | The cross-toolchain works with a matching target sysroot. | ||
41 | </para> | ||
42 | </section> | ||
50 | 43 | ||
44 | <section id='sysroot'> | ||
45 | <title>Sysroot</title> | ||
46 | <para> | ||
47 | The matching target sysroot contains needed headers and libraries for generating | ||
48 | binaries that run on the target architecture. | ||
49 | The sysroot is based on the target root filesystem image that is built by | ||
50 | Poky and uses the same metadata configuration used to build the cross-toolchain. | ||
51 | </para> | ||
52 | </section> | ||
51 | 53 | ||
54 | <section id='the-qemu-emulator'> | ||
55 | <title>The QEMU Emulator</title> | ||
56 | <para> | ||
57 | The QEMU emulator allows you to simulate your hardware while running your | ||
58 | application or image. | ||
59 | QEMU is installed several ways: as part of the Poky tree, ADT installation | ||
60 | through a toolchain tarball, or through the ADT Installer. | ||
61 | </para> | ||
62 | </section> | ||
52 | 63 | ||
64 | <section id='user-space-tools'> | ||
65 | <title>User-Space Tools</title> | ||
66 | <para> | ||
67 | User-space tools are included as part of the distribution. | ||
68 | You will find these tools helpful during development. | ||
69 | The tools include LatencyTOP, PowerTOP, OProfile, Perf, SystemTap, and Lttng-ust. | ||
70 | These tools are common development tools for the Linux platform. | ||
71 | <itemizedlist> | ||
72 | <listitem><para><emphasis>LatencyTOP</emphasis> – LatencyTOP focuses on latency | ||
73 | that causes skips in audio, | ||
74 | stutters in your desktop experience, or situations that overload your server | ||
75 | even when you have plenty of CPU power left. | ||
76 | You can find out more about LatencyTOP at | ||
77 | <ulink url='http://www.latencytop.org/'></ulink>. | ||
78 | </para></listitem> | ||
79 | <listitem><para><emphasis>PowerTOP</emphasis> – Helps you determine what | ||
80 | software is using the most power. | ||
81 | You can find out more about PowerTOP at | ||
82 | <ulink url='http://www.linuxpowertop.org/'></ulink>. | ||
83 | </para></listitem> | ||
84 | <listitem><para><emphasis>OProfile</emphasis> – A system-wide profiler for Linux | ||
85 | systems that is capable | ||
86 | of profiling all running code at low overhead. | ||
87 | You can find out more about OProfile at | ||
88 | <ulink url='http://oprofile.sourceforge.net/about/'></ulink>. | ||
89 | </para></listitem> | ||
90 | <listitem><para><emphasis>Perf</emphasis> – Performance counters for Linux used | ||
91 | to keep track of certain | ||
92 | types of hardware and software events. | ||
93 | For more information on these types of counters see | ||
94 | <ulink url='https://perf.wiki.kernel.org/index.php'></ulink> and click | ||
95 | on “Perf tools.” | ||
96 | </para></listitem> | ||
97 | <listitem><para><emphasis>SystemTap</emphasis> – A free software infrastructure | ||
98 | that simplifies | ||
99 | information gathering about a running Linux system. | ||
100 | This information helps you diagnose performance or functional problems. | ||
101 | SystemTap is not available as a user-space tool through the Yocto Eclipse IDE Plug-in. | ||
102 | See <ulink url='http://sourceware.org/systemtap'></ulink> for more information | ||
103 | on SystemTap. | ||
104 | </para></listitem> | ||
105 | <listitem><para><emphasis>Lttng-ust</emphasis> – A User-space Tracer designed to | ||
106 | provide detailed information on user-space activity. | ||
107 | See <ulink url='http://lttng.org/ust'></ulink> for more information on Lttng-ust. | ||
108 | </para></listitem> | ||
109 | </itemizedlist> | ||
110 | </para> | ||
111 | </section> | ||
112 | </section> | ||
53 | 113 | ||
54 | </chapter> | 114 | </chapter> |
55 | <!-- | 115 | <!-- |