diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2016-04-19 12:00:51 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-04-29 07:48:22 +0100 |
| commit | 64293699f66b1fdaf1fa4fc9eb6ee5878f629280 (patch) | |
| tree | e619ffe406e0a665c2d48563e6a9c4971d70c808 /documentation/sdk-manual/sdk-intro.xml | |
| parent | d4c4b2f7b80cf8d99a68b9a6245e54e0931c3efa (diff) | |
| download | poky-64293699f66b1fdaf1fa4fc9eb6ee5878f629280.tar.gz | |
sdk-manual: Applied review edits throughout the manual.
Updates included minor items for wordings and clarity. Review
comments from David Kinder, Stephen Ballard, and Paul Eggleton.
(From yocto-docs rev: b25e5cab60f9c1e059fadd844a3a75d9df450ebf)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual/sdk-intro.xml')
| -rw-r--r-- | documentation/sdk-manual/sdk-intro.xml | 68 |
1 files changed, 42 insertions, 26 deletions
diff --git a/documentation/sdk-manual/sdk-intro.xml b/documentation/sdk-manual/sdk-intro.xml index 88ae77831c..d2a41ce150 100644 --- a/documentation/sdk-manual/sdk-intro.xml +++ b/documentation/sdk-manual/sdk-intro.xml | |||
| @@ -11,12 +11,12 @@ | |||
| 11 | <para> | 11 | <para> |
| 12 | Welcome to the Yocto Project Software Development Kit (SDK) | 12 | Welcome to the Yocto Project Software Development Kit (SDK) |
| 13 | Developer's Guide. | 13 | Developer's Guide. |
| 14 | This manual provides information that lets you use both the standard | 14 | This manual provides information that explains how to use both the |
| 15 | Yocto Project SDK and an extensible SDK to develop applications and | 15 | standard Yocto Project SDK and an extensible SDK to develop |
| 16 | images using the Yocto Project. | 16 | applications and images using the Yocto Project. |
| 17 | Additionally, the manual also provides information on how to use | 17 | Additionally, the manual also provides information on how to use |
| 18 | the popular <trademark class='trade'>Eclipse</trademark> IDE as part | 18 | the popular <trademark class='trade'>Eclipse</trademark> IDE as part |
| 19 | of your application development workflow. | 19 | of your application development workflow within the SDK environment. |
| 20 | </para> | 20 | </para> |
| 21 | 21 | ||
| 22 | <para> | 22 | <para> |
| @@ -30,11 +30,24 @@ | |||
| 30 | </para> | 30 | </para> |
| 31 | 31 | ||
| 32 | <para> | 32 | <para> |
| 33 | A standard SDK consists of a cross-development toolchain that contains | 33 | A standard SDK consists of the following: |
| 34 | a compiler, debugger, and various miscellaneous tools; libraries, | 34 | <itemizedlist> |
| 35 | headers, and symbols to match an image; and environment setup script. | 35 | <listitem><para><emphasis>Cross-Development Toolchain</emphasis>: |
| 36 | You can use this SDK to independently develop and test code that is | 36 | This toolchain contains a compiler, debugger, and various |
| 37 | destined to run on some target machine. | 37 | miscellaneous tools. |
| 38 | </para></listitem> | ||
| 39 | <listitem><para><emphasis>Libraries, Headers, and Symbols</emphasis>: | ||
| 40 | The libraries, headers, and symbols are specific to the image | ||
| 41 | (i.e. they match the image). | ||
| 42 | </para></listitem> | ||
| 43 | <listitem><para><emphasis>Environment Setup Script</emphasis>: | ||
| 44 | This <filename>*.sh</filename> file, once run, sets up the | ||
| 45 | cross-development environment by defining variables and | ||
| 46 | preparing for SDK use. | ||
| 47 | </para></listitem> | ||
| 48 | </itemizedlist> | ||
| 49 | You can use the standard SDK to independently develop and test code | ||
| 50 | that is destined to run on some target machine. | ||
| 38 | </para> | 51 | </para> |
| 39 | 52 | ||
| 40 | <para> | 53 | <para> |
| @@ -59,7 +72,7 @@ | |||
| 59 | </para> | 72 | </para> |
| 60 | 73 | ||
| 61 | <para> | 74 | <para> |
| 62 | Another feature for the SDKs is that only one set of cross-canadian | 75 | Another feature for the SDKs is that only one set of cross-compiler |
| 63 | toolchain binaries are produced per architecture. | 76 | toolchain binaries are produced per architecture. |
| 64 | This feature takes advantage of the fact that the target hardware can | 77 | This feature takes advantage of the fact that the target hardware can |
| 65 | be passed to <filename>gcc</filename> as a set of compiler options. | 78 | be passed to <filename>gcc</filename> as a set of compiler options. |
| @@ -74,12 +87,12 @@ | |||
| 74 | </para> | 87 | </para> |
| 75 | 88 | ||
| 76 | <para> | 89 | <para> |
| 77 | Going beyond the actual SDK, the SDK development environment consists | 90 | The SDK development environment consists of the following: |
| 78 | of the following: | ||
| 79 | <itemizedlist> | 91 | <itemizedlist> |
| 80 | <listitem><para>An architecture-specific cross-toolchain and | 92 | <listitem><para>The self-contained SDK, which is an |
| 93 | architecture-specific cross-toolchain and | ||
| 81 | matching sysroots (target and native) all built by the | 94 | matching sysroots (target and native) all built by the |
| 82 | OpenEmbedded build system. | 95 | OpenEmbedded build system (e.g. the SDK). |
| 83 | The toolchain and sysroots are based on a | 96 | The toolchain and sysroots are based on a |
| 84 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> | 97 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> |
| 85 | configuration and extensions, | 98 | configuration and extensions, |
| @@ -91,10 +104,10 @@ | |||
| 91 | QEMU is not literally part of the SDK. | 104 | QEMU is not literally part of the SDK. |
| 92 | You must build and include this emulator separately. | 105 | You must build and include this emulator separately. |
| 93 | However, QEMU plays an important role in the development | 106 | However, QEMU plays an important role in the development |
| 94 | process that revolves around use of and SDK. | 107 | process that revolves around use of the SDK. |
| 95 | </para></listitem> | 108 | </para></listitem> |
| 96 | <listitem><para>The Eclipse IDE Yocto Plug-in. | 109 | <listitem><para>The Eclipse IDE Yocto Plug-in. |
| 97 | This plug-in is also available for you if you are an Eclipse | 110 | This plug-in is available for you if you are an Eclipse |
| 98 | user. | 111 | user. |
| 99 | In the same manner as QEMU, the plug-in is not literally part | 112 | In the same manner as QEMU, the plug-in is not literally part |
| 100 | of the SDK but is rather available for use as part of the | 113 | of the SDK but is rather available for use as part of the |
| @@ -201,8 +214,8 @@ | |||
| 201 | <title>User-Space Tools</title> | 214 | <title>User-Space Tools</title> |
| 202 | 215 | ||
| 203 | <para> | 216 | <para> |
| 204 | User-space tools are available as part of the SDK development | 217 | User-space tools, which are available as part of the SDK |
| 205 | process and can be helpful. | 218 | development environment, can be helpful. |
| 206 | The tools include LatencyTOP, PowerTOP, Perf, SystemTap, | 219 | The tools include LatencyTOP, PowerTOP, Perf, SystemTap, |
| 207 | and Lttng-ust. | 220 | and Lttng-ust. |
| 208 | These tools are common development tools for the Linux platform. | 221 | These tools are common development tools for the Linux platform. |
| @@ -264,7 +277,7 @@ | |||
| 264 | A developer can independently compile and test an object on their | 277 | A developer can independently compile and test an object on their |
| 265 | machine and then, when the object is ready for integration into an | 278 | machine and then, when the object is ready for integration into an |
| 266 | image, they can simply make it available to the machine that has the | 279 | image, they can simply make it available to the machine that has the |
| 267 | the Yocto Project. | 280 | Yocto Project. |
| 268 | Once the object is available, the image can be rebuilt using the | 281 | Once the object is available, the image can be rebuilt using the |
| 269 | Yocto Project to produce the modified image. | 282 | Yocto Project to produce the modified image. |
| 270 | </para> | 283 | </para> |
| @@ -303,12 +316,15 @@ | |||
| 303 | 64-bit architecture). | 316 | 64-bit architecture). |
| 304 | Download kernel, root filesystem, and any other files you | 317 | Download kernel, root filesystem, and any other files you |
| 305 | need for your process. | 318 | need for your process. |
| 306 | <note>In order to use the root filesystem in QEMU, you | 319 | <note> |
| 307 | need to extract it. | 320 | To use the root filesystem in QEMU, you |
| 308 | See the | 321 | need to extract it. |
| 309 | "<link url='sdk-extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" | 322 | See the |
| 310 | section for information on how to extract the root | 323 | "<link url='sdk-extracting-the-root-filesystem'>Extracting the Root Filesystem</link>" |
| 311 | filesystem.</note></para></listitem> | 324 | section for information on how to extract the root |
| 325 | filesystem. | ||
| 326 | </note> | ||
| 327 | </para></listitem> | ||
| 312 | <listitem><para><emphasis>Develop and Test your | 328 | <listitem><para><emphasis>Develop and Test your |
| 313 | Application:</emphasis> At this point, you have the tools | 329 | Application:</emphasis> At this point, you have the tools |
| 314 | to develop your application. | 330 | to develop your application. |
| @@ -316,7 +332,7 @@ | |||
| 316 | emulator, you can go to | 332 | emulator, you can go to |
| 317 | <ulink url='http://wiki.qemu.org/Main_Page'>QEMU Home Page</ulink> | 333 | <ulink url='http://wiki.qemu.org/Main_Page'>QEMU Home Page</ulink> |
| 318 | to download and learn about the emulator. | 334 | to download and learn about the emulator. |
| 319 | You can see the | 335 | See the |
| 320 | "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-qemu'>Using the Quick EMUlator (QEMU)</ulink>" | 336 | "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-qemu'>Using the Quick EMUlator (QEMU)</ulink>" |
| 321 | chapter in the Yocto Project Development Manual | 337 | chapter in the Yocto Project Development Manual |
| 322 | for information on using QEMU within the Yocto | 338 | for information on using QEMU within the Yocto |
