sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

ref-manual: Resolving a conflict 

(From yocto-docs rev: b364516928d04da38ef3188f07f190ffac64762b)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2016-03-09 13:30:27 -08:00 committed by Richard Purdie
parent 4306f7f97a
commit 4c5157f7dc
19 changed files with 1187 additions and 1239 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/Makefile
View File

@ -128,7 +128,7 @@ TARFILES = dev-style.css dev-manual.html \
figures/wip.png
else
TARFILES = dev-style.css dev-manual.html \
figures/app-dev-flow.png figures/bsp-dev-flow.png \
figures/bsp-dev-flow.png \
figures/dev-title.png figures/git-workflow.png \
figures/index-downloads.png figures/kernel-dev-flow.png \
figures/kernel-overview-1.png figures/kernel-overview-2-generic.png \
@ -202,7 +202,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
figures/buildhistory-web.png \
figures/adt-title.png figures/sdk-title.png figures/bsp-title.png \
figures/kernel-dev-title.png figures/kernel-architecture-overview.png \
figures/app-dev-flow.png figures/bsp-dev-flow.png \
figures/bsp-dev-flow.png \
figures/dev-title.png \
figures/git-workflow.png figures/index-downloads.png \
figures/kernel-dev-flow.png \
@ -249,7 +249,7 @@ TARFILES = mega-manual.html mega-style.css figures/yocto-environment.png \
figures/compatible-layers.png figures/import-layer.png figures/new-project.png \
figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \
figures/sdk-devtool-add-flow.png figures/sdk-installed-extensible-sdk-directory.png \
figures/sdk-devtool-modify-flow.png
figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png
endif
MANUALS = $(DOC)/$(DOC).html
@ -293,7 +293,7 @@ ALLPREQ = html eclipse tarball
TARFILES = sdk-manual.html sdk-style.css figures/sdk-title.png \
figures/sdk-environment.png figures/sdk-installed-standard-sdk-directory.png \
figures/sdk-installed-extensible-sdk-directory.png figures/sdk-devtool-add-flow.png \
figures/sdk-devtool-modify-flow.png \
figures/sdk-devtool-modify-flow.png figures/sdk-eclipse-dev-flow.png \
eclipse
MANUALS = $(DOC)/$(DOC).html $(DOC)/eclipse
FIGURES = figures

10
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -9160,11 +9160,8 @@
Before you can initiate a remote debugging session, you need
to be sure you have set up the cross-development environment,
toolchain, and sysroot.
The "<ulink url='&YOCTO_DOCS_ADT_URL;#adt-prepare'>Preparing for Application Development</ulink>"
chapter of the Yocto Project Application Developer's Guide
The <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>
describes this process.
Be sure you have read that chapter and have set up
your environment.
</para>
</section>
@ -9273,9 +9270,8 @@
location is at <filename>/opt/poky/&DISTRO;</filename>
and begins with the string "environment-setup".
For more information, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#setting-up-the-cross-development-environment'>Setting Up the Cross-Development Environment</ulink>"
section in the Yocto Project Application Developer's
Guide.
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's
Guide</ulink>.
</para>
<para>

17
documentation/dev-manual/dev-manual-intro.xml
View File

@ -86,10 +86,9 @@
<itemizedlist>
<listitem><para><emphasis>Step-by-step instructions when those instructions exist in other Yocto
Project documentation:</emphasis>
For example, the Yocto Project Application Developer's Guide contains detailed
instructions on how to run the
<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>ADT Installer</ulink>,
which is used to set up a cross-development environment.</para></listitem>
For example, the Yocto Project Software Development Kit (SDK) Developer's Guide contains detailed
instructions on how to install an SDK, which is used to
develop applications for target hardware.</para></listitem>
<listitem><para><emphasis>Reference material:</emphasis>
This type of material resides in an appropriate reference manual.
For example, system variables are documented in the
@ -126,10 +125,12 @@
The build system is sometimes referred to as "Poky".
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>:</emphasis>
This guide provides information that lets you get going with the Application
Development Toolkit (ADT) and stand-alone cross-development toolchains to
develop projects using the Yocto Project.
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>:</emphasis>
This guide provides information that lets you get going
with the standard or extensible SDK.
An SDK, with its cross-development toolchains, allows you
to develop projects inside or outside of the Yocto Project
environment.
</para></listitem>
<listitem><para><emphasis>
<ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>:</emphasis>

1168
documentation/dev-manual/dev-manual-model.xml
View File

File diff suppressed because it is too large Load Diff

10
documentation/dev-manual/dev-manual-newbie.xml
View File

@ -106,12 +106,9 @@
isolated applications.</para></listitem>
<listitem><para>When possible, use the Yocto Project
plug-in for the <trademark class='trade'>Eclipse</trademark> IDE
and other pieces of Application Development
Technology (ADT).
and SDK development practices.
For more information, see the
"<link linkend='application-development-workflow'>Application
Development Workflow</link>" section as well as the
<ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>.
"<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>".
</para></listitem>
<listitem><para>Keep your cross-development toolchains
updated.
@ -650,8 +647,7 @@
section in the Yocto Project Reference Manual.
You can also find more information on using the
relocatable toolchain in the
<ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project
Application Developer's Guide</ulink>.
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
</para></listitem>
<listitem><para><emphasis>Image:</emphasis>
An image is an artifact of the BitBake build process given

7
documentation/dev-manual/dev-manual-qemu.xml
View File

@ -47,11 +47,10 @@
<para>
QEMU is made available with the Yocto Project a number of ways.
The easiest and recommended method for getting QEMU is to run the
ADT installer. For more information on how to make sure you have
One method is to install a Software Development Kit (SDK).
For more information on how to make sure you have
QEMU available, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#the-qemu-emulator'>The QEMU Emulator</ulink>"
section in the Yocto Project Application Developer's Guide.
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
</para>
</section>

8
documentation/dev-manual/dev-manual-start.xml
View File

@ -279,8 +279,9 @@
applications using the Eclipse Integrated Development Environment (IDE),
you will need this plug-in.
See the
"<link linkend='setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</link>"
section for more information.</para></listitem>
"<ulink url='&YOCTO_DOCS_SDK_URL;#setting-up-the-eclipse-ide'>Setting up the Eclipse IDE</ulink>"
section in the Yocto Project Software Development Kit (SDK)
Developer's Guide for more information.</para></listitem>
</itemizedlist>
</para>
</section>
@ -366,8 +367,7 @@
by sourcing an environment setup script.
Finally, you start the QEMU emulator.
You can find details on all these steps in the
"<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Example Using Pre-Built Binaries and QEMU</ulink>"
section of the Yocto Project Application Developer's Guide.
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
You can learn more about using QEMU with the Yocto Project in the
"<link linkend='dev-manual-qemu'>Using the Quick EMUlator (QEMU)</link>"
section.

BIN
documentation/dev-manual/figures/app-dev-flow.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 52 KiB

BIN
documentation/mega-manual/figures/app-dev-flow.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 51 KiB

16
documentation/ref-manual/introduction.xml
View File

@ -245,9 +245,9 @@
<literallayout class='monospaced'>
$ sudo apt-get install make xsltproc docbook-utils fop dblatex xmlto
</literallayout></para></listitem>
<listitem><para><emphasis>ADT Installer Extras:</emphasis>
<listitem><para><emphasis>SDK Installer Extras:</emphasis>
Packages needed if you are going to be using the
<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
the standard or extensible SDK:
<literallayout class='monospaced'>
$ sudo apt-get install autoconf automake libtool libglib2.0-dev libarchive-dev
</literallayout></para></listitem>
@ -289,9 +289,9 @@
$ sudo dnf install make docbook-style-dsssl docbook-style-xsl \
docbook-dtds docbook-utils fop libxslt dblatex xmlto xsltproc
</literallayout></para></listitem>
<listitem><para><emphasis>ADT Installer Extras:</emphasis>
<listitem><para><emphasis>SDK Installer Extras:</emphasis>
Packages needed if you are going to be using the
<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
standard or extensible SDK:
<literallayout class='monospaced'>
$ sudo dnf install autoconf automake libtool glib2-devel libarchive-devel
</literallayout></para></listitem>
@ -332,9 +332,9 @@
<literallayout class='monospaced'>
$ sudo zypper install make fop xsltproc dblatex xmlto
</literallayout></para></listitem>
<listitem><para><emphasis>ADT Installer Extras:</emphasis>
<listitem><para><emphasis>SDK Installer Extras:</emphasis>
Packages needed if you are going to be using the
<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
standard or extensible SDK:
<literallayout class='monospaced'>
$ sudo zypper install autoconf automake libtool glib2-devel libarchive-devel
</literallayout></para></listitem>
@ -387,9 +387,9 @@
$ sudo yum install make docbook-style-dsssl docbook-style-xsl \
docbook-dtds docbook-utils fop libxslt dblatex xmlto xsltproc
</literallayout></para></listitem>
<listitem><para><emphasis>ADT Installer Extras:</emphasis>
<listitem><para><emphasis>SDK Installer Extras:</emphasis>
Packages needed if you are going to be using the
<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
standard or extensible SDK:
<literallayout class='monospaced'>
$ sudo yum install autoconf automake libtool glib2-devel libarchive-devel
</literallayout></para></listitem>

9
documentation/ref-manual/ref-classes.xml
View File

@ -2638,8 +2638,8 @@
toolchain using the
<link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link>
task, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
section in the Yocto Project Application Developer's Guide.
"<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
section in the Yocto Project Software Development Kit (SDK) Developer's Guide.
</para>
</section>
@ -2718,8 +2718,9 @@
cross-development toolchain using the
<link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link>
task, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
section in the Yocto Project Application Developer's Guide.
"<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
section in the Yocto Project Software Development Kit (SDK) Developer's
Guide.
</para>
</section>

4
documentation/ref-manual/ref-features.xml
View File

@ -333,9 +333,7 @@
<filename>oprofile</filename>, <filename>exmap</filename>,
and <filename>LTTng</filename>.
For general information on user-space tools, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#user-space-tools'>User-Space Tools</ulink>"
section in the Yocto Project Application Developer's
Guide.
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
</para></listitem>
<listitem><para><emphasis>tools-sdk:</emphasis>
Installs a full SDK that runs on the device.

4
documentation/ref-manual/ref-structure.xml
View File

@ -766,8 +766,8 @@
toolchain installer scripts, which when executed, install the
sysroot that matches your target hardware.
You can find out more about these installers in the
"<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
section in the Yocto Project Application Developer's Guide.
"<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
section in the Yocto Project Software Development Kit (SDK) Developer's Guide.
</para>
</section>

13
documentation/ref-manual/ref-variables.xml
View File

@ -11140,14 +11140,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
<glossentry id='var-SDKMACHINE'><glossterm>SDKMACHINE</glossterm>
<info>
SDKMACHINE[doc] = "Specifies the architecture (i.e. i686 or x86_64) for which to build SDK and ADT items."
SDKMACHINE[doc] = "Specifies the architecture (i.e. i686 or x86_64) for which to build SDK items."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
The machine for which the Application Development Toolkit
(ADT) or SDK is built.
In other words, the SDK or ADT is built such that it
The machine for which the SDK is built.
In other words, the SDK is built such that it
runs on the target you specify with the
<filename>SDKMACHINE</filename> value.
The value points to a corresponding
@ -13577,8 +13576,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
section.
For information on setting up a cross-development
environment, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>"
section in the Yocto Project Application Developer's Guide.
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
</para>
</glossdef>
</glossentry>
@ -13629,8 +13627,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
section.
For information on setting up a cross-development
environment, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#installing-the-adt'>Installing the ADT and Toolchains</ulink>"
section in the Yocto Project Application Developer's Guide.
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
</para>
</glossdef>
</glossentry>

7
documentation/ref-manual/technical-details.xml
View File

@ -187,7 +187,7 @@
This section provides some technical background on how
cross-development toolchains are created and used.
For more information on toolchains, you can also see the
<ulink url='&YOCTO_DOCS_ADT_URL;'>Yocto Project Application Developer's Guide</ulink>.
<ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
</para>
<para>
@ -371,8 +371,9 @@
<note>
For information on advantages gained when building a
cross-development toolchain installer, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
section in the Yocto Project Application Developer's Guide.
"<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
section in the Yocto Project Software Development Kit (SDK) Developer's
Guide.
</note>
</section>

12
documentation/ref-manual/usingpoky.xml
View File

@ -113,8 +113,7 @@
<filename class="directory">tmp/deploy/images</filename>.
For information on how to run pre-built images such as <filename>qemux86</filename>
and <filename>qemuarm</filename>, see the
"<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Example Using Pre-Built Binaries and QEMU</ulink>"
section in the Yocto Project Application Developer's Guide.
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
For information about how to install these images, see the documentation for your
particular board or machine.
</para>
@ -150,10 +149,11 @@
<para>
For discussions on debugging, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>"
and
"<ulink url='&YOCTO_DOCS_DEV_URL;#adt-eclipse'>Working within Eclipse</ulink>"
sections in the Yocto Project Development Manual.
"<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" section
in the Yocto Project Developer's Manual
and the
"<ulink url='&YOCTO_DOCS_SDK_URL;#adt-eclipse'>Working within Eclipse</ulink>"
section in the Yocto Project Software Development Kit (SDK) Developer's Guide.
</para>
<note>

58
documentation/sdk-manual/sdk-intro.xml
View File

@ -14,6 +14,9 @@
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.
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.
</para>
<para>
@ -63,6 +66,61 @@
Yocto Project to produce the modified image.
</para>
<para>
You just need to follow these general steps:
<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>"
section.</para></listitem>
<listitem><para><emphasis>Download the Target Image:</emphasis>
The Yocto Project supports several target architectures
and has many pre-built kernel images and root filesystem
images.</para>
<para>If you are going to develop your application on
hardware, go to the
<ulink url='&YOCTO_MACHINES_DL_URL;'><filename>machines</filename></ulink>
download area and choose a target machine area
from which to download the kernel image and root filesystem.
This download area could have several files in it that
support development using actual hardware.
For example, the area might contain
<filename>.hddimg</filename> files that combine the
kernel image with the filesystem, boot loaders, and
so forth.
Be sure to get the files you need for your particular
development process.</para>
<para>If you are going to develop your application and
then run and test it using the QEMU emulator, go to the
<ulink url='&YOCTO_QEMU_DL_URL;'><filename>machines/qemu</filename></ulink>
download area.
From this area, go down into the directory for your
target architecture (e.g. <filename>qemux86_64</filename>
for an <trademark class='registered'>Intel</trademark>-based
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>
<listitem><para><emphasis>Develop and Test your
Application:</emphasis> At this point, you have the tools
to develop your application.
If you need to separately install and use the QEMU
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
"<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
Project.</para></listitem>
</orderedlist>
</para>
<para>
The remainder of this manual describes how to use both the standard
SDK and the extensible SDK.

1053
documentation/sdk-manual/sdk-using.xml
View File

File diff suppressed because it is too large Load Diff

22
documentation/yocto-project-qs/yocto-project-qs.xml
View File

@ -758,11 +758,9 @@
Project.
The manual contains conceptual and procedural information
that covers
<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-model'>common development models</ulink>,
introduces
<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-newbie'>the Yocto Project open source development environment</ulink>,
and describes the
<ulink url='&YOCTO_DOCS_DEV_URL;#workflow-using-the-adt-and-eclipse'>workflow using Eclipse™</ulink>.
<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-model'>common development models</ulink>
and introduces
<ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-newbie'>the Yocto Project open source development environment</ulink>.
The manual also contains several targeted sections that
cover specific
<ulink url='&YOCTO_DOCS_DEV_URL;#extendpoky'>common tasks</ulink>
@ -770,10 +768,22 @@
images, writing new recipes, working with libraries, and
configuring and patching the kernel.
</para></listitem>
<listitem><para><emphasis>Look Through the Yocto Project Software Development Kit (SDK) Developer's Guide:</emphasis>
The
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>
describes how to use both the standard SDK and the
extensible SDK.
This manual also provides an example workflow that uses
the popular <trademark class='trade'>Eclipse</trademark>
development environment.
See the
"<ulink url='&YOCTO_DOCS_SDK_URL;#workflow-using-eclipse'>Workflow using Eclipse™</ulink>"
section.
</para></listitem>
<listitem><para><emphasis>Learn About Application Development:</emphasis>
If your primary interests lie in developing applications,
you can reference the
<ulink url='&YOCTO_DOCS_ADT_URL;#adt-manual-intro'>Yocto Project Application Developer's Guide</ulink>.
<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>.
</para></listitem>
<listitem><para><emphasis>Learn About Board Support Packages (BSPs):</emphasis>
If you want to learn about BSPs, see the