diff options
Diffstat (limited to 'import-layers/yocto-poky/documentation/sdk-manual/sdk-intro.xml')
| -rw-r--r-- | import-layers/yocto-poky/documentation/sdk-manual/sdk-intro.xml | 255 |
1 files changed, 161 insertions, 94 deletions
diff --git a/import-layers/yocto-poky/documentation/sdk-manual/sdk-intro.xml b/import-layers/yocto-poky/documentation/sdk-manual/sdk-intro.xml index 88ae77831..68401690d 100644 --- a/import-layers/yocto-poky/documentation/sdk-manual/sdk-intro.xml +++ b/import-layers/yocto-poky/documentation/sdk-manual/sdk-intro.xml @@ -11,41 +11,53 @@ <para> Welcome to the Yocto Project Software Development Kit (SDK) Developer's Guide. - This manual provides information that lets you use both the standard - Yocto Project SDK and an extensible SDK to develop applications and - images using the Yocto Project. + This manual provides information that explains how to use both the + Yocto Project extensible and standard SDKs to develop + applications and images. Additionally, the manual also provides information on how to use the popular <trademark class='trade'>Eclipse</trademark> IDE as part - of your application development workflow. + of your application development workflow within the SDK environment. + <note> + Prior to the 2.0 Release of the Yocto Project, application + development was primarily accomplished through the use of the + Application Development Toolkit (ADT) and the availability + of stand-alone cross-development toolchains and other tools. + With the 2.1 Release of the Yocto Project, application development + has transitioned to within a tool-rich extensible SDK and the more + traditional standard SDK. + </note> </para> <para> - Prior to the 2.0 Release of the Yocto Project, application - development was primarily accomplished through the use of the - Application Development Toolkit (ADT) and the availability - of stand-alone cross-development toolchains and other tools. - With the 2.1 Release of the Yocto Project, application development - has transitioned to within a more traditional SDK and extensible - SDK. - </para> - - <para> - A standard SDK consists of a cross-development toolchain that contains - a compiler, debugger, and various miscellaneous tools; libraries, - headers, and symbols to match an image; and environment setup script. - You can use this SDK to independently develop and test code that is - destined to run on some target machine. + All SDKs consist of the following: + <itemizedlist> + <listitem><para><emphasis>Cross-Development Toolchain</emphasis>: + This toolchain contains a compiler, debugger, and various + miscellaneous tools. + </para></listitem> + <listitem><para><emphasis>Libraries, Headers, and Symbols</emphasis>: + The libraries, headers, and symbols are specific to the image + (i.e. they match the image). + </para></listitem> + <listitem><para><emphasis>Environment Setup Script</emphasis>: + This <filename>*.sh</filename> file, once run, sets up the + cross-development environment by defining variables and + preparing for SDK use. + </para></listitem> + </itemizedlist> </para> <para> - An extensible SDK consists of everything that the standard SDK has plus - tools that allow you to easily add new applications and libraries to - an image, modify the source of an existing component, test changes on - the target hardware, and easily integrate an application into the + Additionally an extensible SDK has tools that allow you to easily add + new applications and libraries to an image, modify the source of an + existing component, test changes on the target hardware, and easily + integrate an application into the <ulink url='&YOCTO_DOCS_DEV_URL;#build-system-term'>OpenEmbedded build system</ulink>. </para> <para> + You can use an SDK to independently develop and test code + that is destined to run on some target machine. SDKs are completely self-contained. The binaries are linked against their own copy of <filename>libc</filename>, which results in no dependencies @@ -59,8 +71,8 @@ </para> <para> - Another feature for the SDKs is that only one set of cross-canadian - toolchain binaries are produced per architecture. + Another feature for the SDKs is that only one set of cross-compiler + toolchain binaries are produced for any given architecture. This feature takes advantage of the fact that the target hardware can be passed to <filename>gcc</filename> as a set of compiler options. Those options are set up by the environment script and contained in @@ -74,40 +86,122 @@ </para> <para> - Going beyond the actual SDK, the SDK development environment consists - of the following: + The SDK development environment consists of the following: <itemizedlist> - <listitem><para>An architecture-specific cross-toolchain and + <listitem><para>The self-contained SDK, which is an + architecture-specific cross-toolchain and matching sysroots (target and native) all built by the - OpenEmbedded build system. + OpenEmbedded build system (e.g. the SDK). The toolchain and sysroots are based on a <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> configuration and extensions, which allows you to cross-develop on the host machine for the target hardware. + Additionally, the extensible SDK contains the + <filename>devtool</filename> functionality. </para></listitem> <listitem><para>The Quick EMUlator (QEMU), which lets you simulate target hardware. QEMU is not literally part of the SDK. You must build and include this emulator separately. However, QEMU plays an important role in the development - process that revolves around use of and SDK. + process that revolves around use of the SDK. </para></listitem> <listitem><para>The Eclipse IDE Yocto Plug-in. - This plug-in is also available for you if you are an Eclipse + This plug-in is available for you if you are an Eclipse user. In the same manner as QEMU, the plug-in is not literally part of the SDK but is rather available for use as part of the development process. </para></listitem> - <listitem><para>Various user-space tools that greatly enhance - your application development experience. + <listitem><para>Various performance-related + <ulink url='http://www.eclipse.org/linuxtools/index.php'>tools</ulink> + that can enhance your development experience. These tools are also separate from the actual SDK but can be independently obtained and used in the development process. </para></listitem> </itemizedlist> </para> + <para> + In summary, the extensible and standard SDK share many features. + However, the extensible SDK has powerful development tools to help you + more quickly develop applications. + Following is a table that summarizes the primary differences between + the standard and extensible SDK types when considering which to + build: + <informaltable frame='none'> + <tgroup cols='3' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth='1*'/> + <colspec colname='c2' colwidth='1*'/> + <colspec colname='c3' colwidth='1*'/> + <thead> + <row> + <entry align="left"><emphasis>Feature</emphasis></entry> + <entry align="left"><emphasis>Standard SDK</emphasis></entry> + <entry align="left"><emphasis>Extensible SDK</emphasis></entry> + </row> + </thead> + <tbody> + <row> + <entry align="left">Toolchain</entry> + <entry align="left">Yes</entry> + <entry align="left">Yes*</entry> + </row> + <row> + <entry align="left">Debugger</entry> + <entry align="left">Yes</entry> + <entry align="left">Yes*</entry> + </row> + <row> + <entry align="left">Size</entry> + <entry align="left">100+ MBytes</entry> + <entry align="left">1+ GBytes (or 300+ MBytes for minimal w/toolchain)</entry> + </row> + <row> + <entry align="left"><filename>devtool</filename></entry> + <entry align="left">No</entry> + <entry align="left">Yes</entry> + </row> + <row> + <entry align="left">Build Images</entry> + <entry align="left">No</entry> + <entry align="left">Yes</entry> + </row> + <row> + <entry align="left">Updateable</entry> + <entry align="left">No</entry> + <entry align="left">Yes</entry> + </row> + <row> + <entry align="left">Managed Sysroot**</entry> + <entry align="left">No</entry> + <entry align="left">Yes</entry> + </row> + <row> + <entry align="left">Installed Packages</entry> + <entry align="left">No***</entry> + <entry align="left">Yes****</entry> + </row> + <row> + <entry align="left">Construction</entry> + <entry align="left">Packages</entry> + <entry align="left">Shared State</entry> + </row> + </tbody> + </tgroup> + </informaltable> + <literallayout class='monospaced'> + * Extensible SDK will contain the toolchain and debugger if <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_EXT_TYPE'><filename>SDK_EXT_TYPE</filename></ulink> is "full" or <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_INCLUDE_TOOLCHAIN'><filename>SDK_INCLUDE_TOOLCHAIN</filename></ulink> is "1", which is the default. + + ** Sysroot is managed through use of <filename>devtool</filename>. Thus, it is less likely that you will corrupt your SDK sysroot when you try to add additional libraries. + + *** Runtime package management can be added to the standard SDK but it is not supported by default. + + **** You must build and make the shared state available to extensible SDK users for "packages" you want to enable users to install. + </literallayout> + </para> + <section id='the-cross-development-toolchain'> <title>The Cross-Development Toolchain</title> @@ -117,7 +211,9 @@ 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 by running a toolchain installer script + Additionally, for an extensible SDK, the toolchain also has + built-in <filename>devtool</filename> functionality. + This toolchain is created by running a SDK installer script or through a <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> that is based on your Metadata configuration or extension for @@ -183,68 +279,36 @@ 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. + The environment also supports many performance-related + <ulink url='http://www.eclipse.org/linuxtools/index.php'>tools</ulink> + that enhance your development experience. + <note> + Previous releases of the Eclipse Yocto Plug-in supported + "user-space tools" (i.e. LatencyTOP, PowerTOP, Perf, SystemTap, + and Lttng-ust) that also added to the development experience. + These tools have been deprecated beginning with this release + of the plug-in. + </note> </para> <para> For information about the application development workflow that uses the Eclipse IDE and for a detailed example of how to install and configure the Eclipse Yocto Project Plug-in, see the - "<link link='sdk-developing-applications-using-eclipse'>Developing Applications Using <trademark class='trade'>Eclipse</trademark></link>" + "<link linkend='sdk-developing-applications-using-eclipse'>Developing Applications Using <trademark class='trade'>Eclipse</trademark></link>" section. </para> </section> - <section id='user-space-tools'> - <title>User-Space Tools</title> + <section id='performance-enhancing-tools'> + <title>Performance Enhancing Tools</title> <para> - User-space tools are available as part of the SDK development - process and can be helpful. - The tools include LatencyTOP, PowerTOP, 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. - </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='https://01.org/powertop/'></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>. - For examples on how to setup and use this tool, see the - "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-perf'>perf</ulink>" - section in the Yocto Project Profiling and Tracing Manual. - </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. - For examples on how to setup and use this tool, see the - "<ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual-systemtap'>SystemTap</ulink>" - section in the Yocto Project Profiling and Tracing Manual. - </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> + Supported performance enhancing tools are available that let you + profile, debug, and perform tracing on your projects developed + using Eclipse. + For information on these tools see + <ulink url='http://www.eclipse.org/linuxtools/'>http://www.eclipse.org/linuxtools/</ulink>. </para> </section> </section> @@ -264,7 +328,7 @@ A developer can independently compile and test an object on their machine and then, when the object is ready for integration into an image, they can simply make it available to the machine that has the - the Yocto Project. + Yocto Project. Once the object is available, the image can be rebuilt using the Yocto Project to produce the modified image. </para> @@ -274,9 +338,9 @@ <orderedlist> <listitem><para><emphasis>Install the SDK for your target hardware:</emphasis> For information on how to install the SDK, see the - "<link url='sdk-installing-the-sdk'>Installing the SDK</link>" + "<link linkend='sdk-installing-the-sdk'>Installing the SDK</link>" section.</para></listitem> - <listitem><para><emphasis>Download the Target Image:</emphasis> + <listitem><para><emphasis>Download or Build the Target Image:</emphasis> The Yocto Project supports several target architectures and has many pre-built kernel images and root filesystem images.</para> @@ -303,12 +367,15 @@ 64-bit architecture). Download kernel, root filesystem, and any other files you need for your process. - <note>In order to use the root filesystem in QEMU, you - need to extract it. - See the - "<link url='sdk-extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" - section for information on how to extract the root - filesystem.</note></para></listitem> + <note> + To use the root filesystem in QEMU, you + need to extract it. + See the + "<link linkend='sdk-extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" + section for information on how to extract the root + filesystem. + </note> + </para></listitem> <listitem><para><emphasis>Develop and Test your Application:</emphasis> At this point, you have the tools to develop your application. @@ -316,7 +383,7 @@ emulator, you can go to <ulink url='http://wiki.qemu.org/Main_Page'>QEMU Home Page</ulink> to download and learn about the emulator. - You can see the + See the "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-qemu'>Using the Quick EMUlator (QEMU)</ulink>" chapter in the Yocto Project Development Manual for information on using QEMU within the Yocto |
