2008-02-26 11:31:34 +00:00
|
|
|
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
|
|
|
|
|
<chapter id='intro'>
|
|
|
|
<title>Introduction</title>
|
|
|
|
|
2010-10-15 14:14:06 +00:00
|
|
|
<section id='intro-welcome'>
|
|
|
|
<title>Welcome to Poky!</title>
|
2008-02-26 11:31:34 +00:00
|
|
|
|
|
|
|
<para>
|
2011-03-17 22:34:37 +00:00
|
|
|
Poky is the build tool in the Yocto Project.
|
|
|
|
The Yocto Project uses Poky to build images (kernel, system, and application software) for
|
2010-10-27 15:57:26 +00:00
|
|
|
targeted hardware.
|
2010-10-15 14:14:06 +00:00
|
|
|
</para>
|
2008-02-26 11:31:34 +00:00
|
|
|
|
2010-10-15 14:14:06 +00:00
|
|
|
<para>
|
2010-10-27 15:57:26 +00:00
|
|
|
Before diving into Poky, it helps to have an understanding of the Yocto Project.
|
|
|
|
Especially useful for newcomers is the information in the Yocto Project Quick Start, which
|
|
|
|
you can find on the <ulink url="http://www.yoctoproject.org">Yocto Project website</ulink>.
|
|
|
|
Specifically, the guide is
|
2010-11-09 20:58:33 +00:00
|
|
|
at <ulink url="http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html"/>.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
2010-10-15 14:14:06 +00:00
|
|
|
</section>
|
2008-02-26 11:31:34 +00:00
|
|
|
|
2010-11-09 20:47:25 +00:00
|
|
|
<section id='what-is-poky'>
|
2010-10-15 14:14:06 +00:00
|
|
|
<title>What is Poky?</title>
|
2008-02-26 11:31:34 +00:00
|
|
|
|
2010-10-15 14:14:06 +00:00
|
|
|
<para>
|
2010-10-27 15:57:26 +00:00
|
|
|
Within the Yocto Project, Poky provides an open source, full-platform build tool based on
|
|
|
|
Linux, X11, Matchbox, GTK+, Pimlico, Clutter,
|
|
|
|
and other <ulink url='http://gnome.org/mobile'>GNOME Mobile</ulink> technologies.
|
|
|
|
It provides a focused and stable subset of OpenEmbedded upon which you can easily and
|
|
|
|
reliably build and develop.
|
|
|
|
Poky fully supports a wide range of x86, ARM, MIPS and PowerPC hardware and device virtualization.
|
2010-10-15 14:14:06 +00:00
|
|
|
</para>
|
2008-02-26 11:31:34 +00:00
|
|
|
|
|
|
|
<para>
|
2010-10-27 15:57:26 +00:00
|
|
|
Poky is primarily a platform builder that generates filesystem images
|
2008-02-26 11:31:34 +00:00
|
|
|
based on open source software such as the Kdrive X server, the Matchbox
|
2010-10-27 15:57:26 +00:00
|
|
|
window manager, the GTK+ toolkit and the D-Bus message bus system. While images
|
|
|
|
for many kinds of devices can be generated, the standard example
|
|
|
|
machines target QEMU full-system emulation (x86, ARM, MIPS and PowerPC) and
|
2010-10-15 14:14:06 +00:00
|
|
|
real reference boards for each of these architectures.
|
|
|
|
Poky's ability to boot inside a QEMU
|
2010-10-27 15:57:26 +00:00
|
|
|
emulator makes it particularly suitable as a test platform for developing embedded software.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2010-10-27 15:57:26 +00:00
|
|
|
An important component integrated within Poky is Sato, a GNOME Mobile-based
|
|
|
|
user interface environment.
|
|
|
|
It is designed to work well with screens that use very high DPI and have restricted
|
|
|
|
sizes, such as those often found on smartphones and PDAs.
|
|
|
|
Because Sato is coded for speed and efficiency, it works smoothly on hand-held and
|
|
|
|
other embedded hardware.
|
|
|
|
It sits nicely on top of any device that uses the GNOME Mobile stack and it results in
|
|
|
|
a well-defined user experience.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
|
2008-02-28 16:10:56 +00:00
|
|
|
<screenshot>
|
|
|
|
<mediaobject>
|
|
|
|
<imageobject>
|
2011-05-09 17:01:11 +00:00
|
|
|
<imagedata fileref="figures/ss-sato.png" format="PNG" align='center' scalefit='1' width="100%" contentdepth="100%"/>
|
2008-02-28 16:10:56 +00:00
|
|
|
</imageobject>
|
|
|
|
<caption>
|
|
|
|
<para>The Sato Desktop - A screenshot from a machine running a Poky built image</para>
|
|
|
|
</caption>
|
|
|
|
</mediaobject>
|
|
|
|
</screenshot>
|
|
|
|
|
2008-02-26 11:31:34 +00:00
|
|
|
<para>
|
2010-10-27 15:57:26 +00:00
|
|
|
Poky has a growing open source community and is also backed up by commercial organizations
|
2011-03-17 22:25:08 +00:00
|
|
|
including Intel® Corporation.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
|
|
|
|
<section id='intro-manualoverview'>
|
|
|
|
<title>Documentation Overview</title>
|
|
|
|
<para>
|
2010-10-27 15:57:26 +00:00
|
|
|
The sections in this reference manual describe different aspects of Poky.
|
2010-11-09 20:58:33 +00:00
|
|
|
The <link linkend='usingpoky'>'Using Poky'</link> section provides an overview of the components
|
2011-03-17 22:34:37 +00:00
|
|
|
that make up Poky followed by information about using Poky and debugging images created in
|
|
|
|
the Yocto Project.
|
2010-10-27 15:57:26 +00:00
|
|
|
The <link linkend='extendpoky'>'Extending Poky'</link> and
|
|
|
|
<link linkend='bsp'>'Board Support Packages'</link> sections provide information
|
|
|
|
about how to extend and customize Poky along with advice on how to manage these changes.
|
2010-11-09 20:58:33 +00:00
|
|
|
The <link linkend='platdev'>'Platform Development with Poky'</link> section provides information about
|
2010-10-27 15:57:26 +00:00
|
|
|
interaction between Poky and target hardware for common platform development tasks such as software
|
|
|
|
development, debugging and profiling.
|
|
|
|
The rest of the manual consists of several reference sections, each providing details on a specific
|
|
|
|
area of Poky functionality.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2011-03-17 22:34:37 +00:00
|
|
|
This manual applies to Poky Release 5.0 (Bernard).
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<section id='intro-requirements'>
|
|
|
|
<title>System Requirements</title>
|
|
|
|
<para>
|
2010-10-27 15:57:26 +00:00
|
|
|
Although we recommend Debian-based distributions
|
|
|
|
(Ubuntu 10.04 or newer) as the host system for Poky, nothing in Poky is
|
|
|
|
distribution-specific. Consequently, other distributions should work as long
|
|
|
|
as the appropriate prerequisites are installed. For example, we know of Poky being used
|
2010-10-15 14:14:06 +00:00
|
|
|
successfully on Redhat, SUSE, Gentoo and Slackware host systems.
|
2010-10-27 15:57:26 +00:00
|
|
|
For information on what you need to develop images using Yocto Project and Poky,
|
|
|
|
you should see the Yocto Project Quick Start on the <ulink url="http://www.yoctoproject.org">
|
|
|
|
Yocto Project website</ulink>.
|
|
|
|
The direct link to the quick start is
|
2010-11-09 20:47:25 +00:00
|
|
|
<ulink url='http://yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html'/>.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
|
|
|
|
<section id='intro-getit'>
|
|
|
|
<title>Obtaining Poky</title>
|
|
|
|
|
|
|
|
<section id='intro-getit-releases'>
|
|
|
|
<title>Releases</title>
|
|
|
|
|
2010-10-27 15:57:26 +00:00
|
|
|
<para>Periodically, we make releases of Poky available
|
2011-02-25 20:42:56 +00:00
|
|
|
at <ulink url='http://yoctoproject.org/downloads/poky/'/>.
|
2010-11-09 20:47:25 +00:00
|
|
|
These releases are more stable and more rigorously tested than the nightly development images.
|
|
|
|
</para>
|
2008-02-26 11:31:34 +00:00
|
|
|
</section>
|
|
|
|
|
|
|
|
<section id='intro-getit-nightly'>
|
|
|
|
<title>Nightly Builds</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
We make nightly builds of Poky for testing purposes and to make the
|
|
|
|
latest developments available. The output from these builds is available
|
2011-02-25 19:37:17 +00:00
|
|
|
at <ulink url='http://autobuilder.yoctoproject.org/'/>.
|
2010-10-27 15:57:26 +00:00
|
|
|
The numbers used in the builds increase for each subsequent build and can be used to
|
|
|
|
reference a specific build.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2010-10-27 15:57:26 +00:00
|
|
|
Automated builds are available for "standard" Poky and for Poky SDKs and toolchains.
|
|
|
|
Additionally, testing versions such as poky-bleeding can be made available as
|
|
|
|
'experimental' builds.
|
|
|
|
The toolchains can
|
2008-02-26 11:31:34 +00:00
|
|
|
be used either as external standalone toolchains or can be combined with Poky as a
|
2010-12-01 18:33:12 +00:00
|
|
|
pre-built toolchain to reduce build time. Using the external toolchains is simply a
|
2008-02-26 11:31:34 +00:00
|
|
|
case of untarring the tarball into the root of your system (it only creates files in
|
2010-11-09 20:47:25 +00:00
|
|
|
<filename>/opt/poky</filename>) and then enabling the option
|
2008-02-26 11:31:34 +00:00
|
|
|
in <filename>local.conf</filename>.
|
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
|
|
|
|
<section id='intro-getit-dev'>
|
|
|
|
<title>Development Checkouts</title>
|
|
|
|
|
|
|
|
<para>
|
2010-10-27 15:57:26 +00:00
|
|
|
Poky is available from our git repository located at
|
2011-02-25 20:52:04 +00:00
|
|
|
git://git.yoctoproject.org/poky.git; a web interface to the repository
|
2011-02-25 19:54:07 +00:00
|
|
|
can be accessed at <ulink url='http://git.yoctoproject.org/'/>.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
2010-12-01 18:33:12 +00:00
|
|
|
The 'master' is where the development work takes place and you should use this if you're
|
2010-10-27 15:57:26 +00:00
|
|
|
interested in working with the latest cutting-edge developments. It is possible for the trunk
|
|
|
|
to suffer temporary periods of instability while new features are developed.
|
2010-12-01 18:33:12 +00:00
|
|
|
If these periods of instability are undesirable, we recommend using one of the release branches.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
</section>
|
|
|
|
</chapter>
|
|
|
|
<!--
|
|
|
|
vim: expandtab tw=80 ts=4
|
|
|
|
-->
|