summaryrefslogtreecommitdiffstats
path: root/documentation/adt-manual/adt-intro.xml
blob: 04c47369f9443d315a1d12a18d54224c4cad08fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >

<chapter id='adt-intro'>
<title>Introduction</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>
    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>The Application Development Toolkit (ADT)</title>

    <para>
        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>
        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>

    <section id='the-cross-toolchain'>
        <title>The Cross-Toolchain</title>

        <para>
            The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger 
            that are used to develop user-space applications for targeted hardware.
            This toolchain is created either by running the ADT Installer script or 
            through a build directory that is based on your metadata 
            configuration or extension for your targeted device.  
            The cross-toolchain works with a matching target sysroot.
        </para>
    </section>

    <section id='sysroot'>
        <title>Sysroot</title>

        <para>
            The matching target sysroot contains needed headers and libraries for generating 
            binaries that run on the target architecture.  
            The sysroot is based on the target root filesystem image that is built by 
            the OpenEmbedded build system Poky and uses the same metadata configuration 
            used to build the cross-toolchain.
        </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>

        <para>
            The QEMU emulator allows you to simulate your hardware while running your 
            application or image.
            QEMU is made available a number of ways:
            <itemizedlist>
                <listitem><para>If you use the ADT Installer script to install ADT, you can 
                    specify whether or not to install QEMU.</para></listitem>
                <listitem><para>If you have downloaded a Yocto Project release and unpacked 
                    it to create a source directory and you have sourced  
                    the environment setup script, QEMU is installed and automatically 
                    available.</para></listitem>
                <listitem><para>If you have installed the cross-toolchain 
                    tarball and you have sourcing the toolchain's setup environment script, QEMU
                    is also installed and automatically available.</para></listitem>
            </itemizedlist>
        </para>
    </section>

    <section id='user-space-tools'>
        <title>User-Space Tools</title>

        <para>
            User-space tools are included as part of the distribution.  
            You will find these tools helpful during development.  
            The tools include LatencyTOP, PowerTOP, OProfile, Perf, SystemTap, and Lttng-ust.  
            These tools are common development tools for the Linux platform.
            <itemizedlist>
                <listitem><para><emphasis>LatencyTOP:</emphasis> LatencyTOP focuses on latency 
                    that causes skips in audio,
                    stutters in your desktop experience, or situations that overload your server 
                    even when you have plenty of CPU power left.  
                    You can find out more about LatencyTOP at 
                    <ulink url='http://www.latencytop.org/'></ulink>.</para></listitem>
                <listitem><para><emphasis>PowerTOP:</emphasis> Helps you determine what   
                    software is using the most power.  
                    You can find out more about PowerTOP at 
                    <ulink url='http://www.linuxpowertop.org/'></ulink>.</para></listitem>
                <listitem><para><emphasis>OProfile:</emphasis> A system-wide profiler for Linux 
                    systems that is capable of profiling all running code at low overhead.  
                    You can find out more about OProfile at 
                    <ulink url='http://oprofile.sourceforge.net/about/'></ulink>.</para></listitem>
                <listitem><para><emphasis>Perf:</emphasis> Performance counters for Linux used 
                    to keep track of certain types of hardware and software events.  
                    For more information on these types of counters see 
                    <ulink url='https://perf.wiki.kernel.org/'></ulink> and click 
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >

<chapter id='adt-intro'>
<title>Introduction</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>
    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>The Application Development Toolkit (ADT)</title>

    <para>
        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>
        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>

    <section id='the-cross-toolchain'>
        <title>The Cross-Toolchain</title>

        <para>
            The cross-toolchain consists of a cross-compiler, cross-linker, and cross-debugger 
            that are used to develop user-space applications for targeted hardware.
            This toolchain is created either by running the ADT Installer script or 
            through a build directory that is based on your metadata 
            configuration or extension for your targeted device.  
            The cross-toolchain works with a matching target sysroot.
        </para>
    </section>

    <section id='sysroot'>
        <title>Sysroot</title>

        <para>
            The matching target sysroot contains needed headers and libraries for generating 
            binaries that run on the target architecture.  
            The sysroot is based on the target root filesystem image that is built by 
            the OpenEmbedded build system Poky and uses the same metadata configuration 
            used to build the cross-toolchain.
        </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>

        <para>
            The QEMU emulator allows you to simulate your hardware while running your 
            application or image.
            QEMU is made available a number of ways:
            <itemizedlist>
                <listitem><para>If you use the ADT Installer script to install ADT, you can 
                    specify whether or not to install QEMU.</para></listitem>
                <listitem><para>If you have downloaded a Yocto Project release and unpacked 
                    it to create a source directory and you have sourced  
                    the environment setup script, QEMU is installed and automatically 
                    available.</para></listitem>
                <listitem><para>If you have installed the cross-toolchain 
                    tarball and you have sourcing the toolchain's setup environment script, QEMU
                    is also installed and automatically available.</para></listitem>
            </itemizedlist>
        </para>
    </section>

    <section id='user-space-tools'>
        <title>User-Space Tools</title>

        <para>
            User-space tools are included as part of the distribution.  
            You will find these tools helpful during development.  
            The tools include LatencyTOP, PowerTOP, OProfile, Perf, SystemTap, and Lttng-ust.  
            These tools are common development tools for the Linux platform.
            <itemizedlist>
                <listitem><para><emphasis>LatencyTOP:</emphasis> LatencyTOP focuses on latency 
                    that causes skips in audio,
                    stutters in your desktop experience, or situations that overload your server 
                    even when you have plenty of CPU power left.  
                    You can find out more about LatencyTOP at 
                    <ulink url='http://www.latencytop.org/'></ulink>.</para></listitem>
                <listitem><para><emphasis>PowerTOP:</emphasis> Helps you determine what   
                    software is using the most power.  
                    You can find out more about PowerTOP at 
                    <ulink url='http://www.linuxpowertop.org/'></ulink>.</para></listitem>
                <listitem><para><emphasis>OProfile:</emphasis> A system-wide profiler for Linux 
                    systems that is capable of profiling all running code at low overhead.  
                    You can find out more about OProfile at 
                    <ulink url='http://oprofile.sourceforge.net/about/'></ulink>.</para></listitem>
                <listitem><para><emphasis>Perf:</emphasis> Performance counters for Linux used 
                    to keep track of certain types of hardware and software events.  
                    For more information on these types of counters see 
                    <ulink url='https://perf.wiki.kernel.org/'></ulink> and click 
                    on “Perf tools.”</para></listitem>
                <listitem><para><emphasis>SystemTap:</emphasis> A free software infrastructure 
                    that simplifies information gathering about a running Linux system.  
                    This information helps you diagnose performance or functional problems.  
                    SystemTap is not available as a user-space tool through the Eclipse IDE Yocto Plug-in.  
                    See <ulink url='http://sourceware.org/systemtap'></ulink> for more information 
                    on SystemTap.</para></listitem>
                <listitem><para><emphasis>Lttng-ust:</emphasis> A User-space Tracer designed to 
                    provide detailed information on user-space activity.  
                    See <ulink url='http://lttng.org/ust'></ulink> for more information on Lttng-ust.
                    </para></listitem>
            </itemizedlist>
        </para>
    </section>
</section>

</chapter>
<!--
vim: expandtab tw=80 ts=4
-->