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>
This commit is contained in:
parent
d4c4b2f7b8
commit
64293699f6
|
@ -168,7 +168,7 @@
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The following figure shows the resulting directory structure after
|
The following figure shows the resulting directory structure after
|
||||||
you install the Standard SDK by running the <filename>.sh</filename>
|
you install the Standard SDK by running the <filename>*.sh</filename>
|
||||||
SDK installation script:
|
SDK installation script:
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
@ -209,7 +209,7 @@
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The following figure shows the resulting directory structure after
|
The following figure shows the resulting directory structure after
|
||||||
you install the Extensible SDK by running the <filename>.sh</filename>
|
you install the Extensible SDK by running the <filename>*.sh</filename>
|
||||||
SDK installation script:
|
SDK installation script:
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
|
|
@ -11,12 +11,12 @@
|
||||||
<para>
|
<para>
|
||||||
Welcome to the Yocto Project Software Development Kit (SDK)
|
Welcome to the Yocto Project Software Development Kit (SDK)
|
||||||
Developer's Guide.
|
Developer's Guide.
|
||||||
This manual provides information that lets you use both the standard
|
This manual provides information that explains how to use both the
|
||||||
Yocto Project SDK and an extensible SDK to develop applications and
|
standard Yocto Project SDK and an extensible SDK to develop
|
||||||
images using the Yocto Project.
|
applications and images using the Yocto Project.
|
||||||
Additionally, the manual also provides information on how to use
|
Additionally, the manual also provides information on how to use
|
||||||
the popular <trademark class='trade'>Eclipse</trademark> IDE as part
|
the popular <trademark class='trade'>Eclipse</trademark> IDE as part
|
||||||
of your application development workflow.
|
of your application development workflow within the SDK environment.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
@ -30,11 +30,24 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
A standard SDK consists of a cross-development toolchain that contains
|
A standard SDK consists of the following:
|
||||||
a compiler, debugger, and various miscellaneous tools; libraries,
|
<itemizedlist>
|
||||||
headers, and symbols to match an image; and environment setup script.
|
<listitem><para><emphasis>Cross-Development Toolchain</emphasis>:
|
||||||
You can use this SDK to independently develop and test code that is
|
This toolchain contains a compiler, debugger, and various
|
||||||
destined to run on some target machine.
|
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>
|
||||||
|
You can use the standard SDK to independently develop and test code
|
||||||
|
that is destined to run on some target machine.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
@ -59,7 +72,7 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Another feature for the SDKs is that only one set of cross-canadian
|
Another feature for the SDKs is that only one set of cross-compiler
|
||||||
toolchain binaries are produced per architecture.
|
toolchain binaries are produced per architecture.
|
||||||
This feature takes advantage of the fact that the target hardware can
|
This feature takes advantage of the fact that the target hardware can
|
||||||
be passed to <filename>gcc</filename> as a set of compiler options.
|
be passed to <filename>gcc</filename> as a set of compiler options.
|
||||||
|
@ -74,12 +87,12 @@
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
Going beyond the actual SDK, the SDK development environment consists
|
The SDK development environment consists of the following:
|
||||||
of the following:
|
|
||||||
<itemizedlist>
|
<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
|
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
|
The toolchain and sysroots are based on a
|
||||||
<ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
|
<ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
|
||||||
configuration and extensions,
|
configuration and extensions,
|
||||||
|
@ -91,10 +104,10 @@
|
||||||
QEMU is not literally part of the SDK.
|
QEMU is not literally part of the SDK.
|
||||||
You must build and include this emulator separately.
|
You must build and include this emulator separately.
|
||||||
However, QEMU plays an important role in the development
|
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>
|
</para></listitem>
|
||||||
<listitem><para>The Eclipse IDE Yocto Plug-in.
|
<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.
|
user.
|
||||||
In the same manner as QEMU, the plug-in is not literally part
|
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
|
of the SDK but is rather available for use as part of the
|
||||||
|
@ -201,8 +214,8 @@
|
||||||
<title>User-Space Tools</title>
|
<title>User-Space Tools</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
User-space tools are available as part of the SDK development
|
User-space tools, which are available as part of the SDK
|
||||||
process and can be helpful.
|
development environment, can be helpful.
|
||||||
The tools include LatencyTOP, PowerTOP, Perf, SystemTap,
|
The tools include LatencyTOP, PowerTOP, Perf, SystemTap,
|
||||||
and Lttng-ust.
|
and Lttng-ust.
|
||||||
These tools are common development tools for the Linux platform.
|
These tools are common development tools for the Linux platform.
|
||||||
|
@ -264,7 +277,7 @@
|
||||||
A developer can independently compile and test an object on their
|
A developer can independently compile and test an object on their
|
||||||
machine and then, when the object is ready for integration into an
|
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
|
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
|
Once the object is available, the image can be rebuilt using the
|
||||||
Yocto Project to produce the modified image.
|
Yocto Project to produce the modified image.
|
||||||
</para>
|
</para>
|
||||||
|
@ -303,12 +316,15 @@
|
||||||
64-bit architecture).
|
64-bit architecture).
|
||||||
Download kernel, root filesystem, and any other files you
|
Download kernel, root filesystem, and any other files you
|
||||||
need for your process.
|
need for your process.
|
||||||
<note>In order to use the root filesystem in QEMU, you
|
<note>
|
||||||
need to extract it.
|
To use the root filesystem in QEMU, you
|
||||||
See the
|
need to extract it.
|
||||||
"<link url='sdk-extracting-the-root-filesystem'>Extracting the Root Filesystem</link>"
|
See the
|
||||||
section for information on how to extract the root
|
"<link url='sdk-extracting-the-root-filesystem'>Extracting the Root Filesystem</link>"
|
||||||
filesystem.</note></para></listitem>
|
section for information on how to extract the root
|
||||||
|
filesystem.
|
||||||
|
</note>
|
||||||
|
</para></listitem>
|
||||||
<listitem><para><emphasis>Develop and Test your
|
<listitem><para><emphasis>Develop and Test your
|
||||||
Application:</emphasis> At this point, you have the tools
|
Application:</emphasis> At this point, you have the tools
|
||||||
to develop your application.
|
to develop your application.
|
||||||
|
@ -316,7 +332,7 @@
|
||||||
emulator, you can go to
|
emulator, you can go to
|
||||||
<ulink url='http://wiki.qemu.org/Main_Page'>QEMU Home Page</ulink>
|
<ulink url='http://wiki.qemu.org/Main_Page'>QEMU Home Page</ulink>
|
||||||
to download and learn about the emulator.
|
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>"
|
"<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-qemu'>Using the Quick EMUlator (QEMU)</ulink>"
|
||||||
chapter in the Yocto Project Development Manual
|
chapter in the Yocto Project Development Manual
|
||||||
for information on using QEMU within the Yocto
|
for information on using QEMU within the Yocto
|
||||||
|
|
|
@ -14,7 +14,7 @@
|
||||||
The tasks you can perform using a standard SDK are also applicable
|
The tasks you can perform using a standard SDK are also applicable
|
||||||
when you are using an extensible SDK.
|
when you are using an extensible SDK.
|
||||||
For information on the differences when using an extensible SDK as
|
For information on the differences when using an extensible SDK as
|
||||||
compared to an extensible SDK, see the
|
compared to a standard SDK, see the
|
||||||
"<link linkend='sdk-extensible'>Using the Extensible SDK</link>"
|
"<link linkend='sdk-extensible'>Using the Extensible SDK</link>"
|
||||||
chapter.
|
chapter.
|
||||||
</note>
|
</note>
|
||||||
|
@ -46,7 +46,7 @@
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The first thing you need to do is install the SDK on your host
|
The first thing you need to do is install the SDK on your host
|
||||||
development machine by running the <filename>.sh</filename>
|
development machine by running the <filename>*.sh</filename>
|
||||||
installation script.
|
installation script.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
|
@ -382,8 +382,8 @@
|
||||||
To illustrate this, consider the following four cross-toolchain
|
To illustrate this, consider the following four cross-toolchain
|
||||||
environment variables:
|
environment variables:
|
||||||
<literallayout class='monospaced'>
|
<literallayout class='monospaced'>
|
||||||
<ulink url='&YOCTO_DOCS_REF_URL;#var-CC'>CC</ulink>=i586-poky-linux-gcc -m32 -march=i586 --sysroot=/opt/poky/1.8/sysroots/i586-poky-linux
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-CC'>CC</ulink>=i586-poky-linux-gcc -m32 -march=i586 --sysroot=/opt/poky/&DISTRO;/sysroots/i586-poky-linux
|
||||||
<ulink url='&YOCTO_DOCS_REF_URL;#var-LD'>LD</ulink>=i586-poky-linux-ld --sysroot=/opt/poky/1.8/sysroots/i586-poky-linux
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-LD'>LD</ulink>=i586-poky-linux-ld --sysroot=/opt/poky/&DISTRO;/sysroots/i586-poky-linux
|
||||||
<ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink>=-O2 -pipe -g -feliminate-unused-debug-types
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'>CFLAGS</ulink>=-O2 -pipe -g -feliminate-unused-debug-types
|
||||||
<ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'>CXXFLAGS</ulink>=-O2 -pipe -g -feliminate-unused-debug-types
|
<ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'>CXXFLAGS</ulink>=-O2 -pipe -g -feliminate-unused-debug-types
|
||||||
</literallayout>
|
</literallayout>
|
||||||
|
|
Loading…
Reference in New Issue