1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-30 00:20:08 +00:00

Editing pass through the Introduction chapter.

I did a complete edit pass through this chapter.  The manual has
not been fully edited from its original state.  One critical technical
correction was corrected where the green-3.3 release was referenced.
I changed this to laverne 4.0.

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
This commit is contained in:
Scott Rifenbark
2010-10-27 08:57:26 -07:00
committed by Richard Purdie
parent 81d3811b2f
commit e53470656e
+63 -49
View File
@@ -8,15 +8,17 @@
<title>Welcome to Poky!</title> <title>Welcome to Poky!</title>
<para> <para>
Poky is the the build tool in Yocto Project. Poky is the build tool in Yocto Project.
It is at the heart of Yocto Project. Yocto Project uses Poky to build images (kernel, system, and application software) for
You use Poky within Yocto Project to build the images (kernel software) for targeted hardware. targeted hardware.
</para> </para>
<para> <para>
Before jumping into Poky you should have an understanding of Yokto Project. Before diving into Poky, it helps to have an understanding of the Yocto Project.
Be sure you are familiar with the information in the Yocto Project Quick Start. Especially useful for newcomers is the information in the Yocto Project Quick Start, which
You can find this documentation on the public <ulink rul='http://yoctoproject.org/'>Yocto Project Website</ulink>. you can find on the <ulink url="http://www.yoctoproject.org">Yocto Project website</ulink>.
Specifically, the guide is
at <ulink url="http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html"></ulink>
</para> </para>
</section> </section>
@@ -24,31 +26,34 @@
<title>What is Poky?</title> <title>What is Poky?</title>
<para> <para>
Poky provides an open source Linux, X11, Matchbox, GTK+, Pimlico, Clutter, and other <ulink url='http://gnome.org/mobile'>GNOME Mobile</ulink> technologies based full platform build tool within Yocto Project. Within the Yocto Project, Poky provides an open source, full-platform build tool based on
It creates a focused, stable, subset of OpenEmbedded that can be easily and reliably built and developed upon. Linux, X11, Matchbox, GTK+, Pimlico, Clutter,
Poky fully supports a wide range of x86 ARM, MIPS and PowerPC hardware and device virtulisation. 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.
</para> </para>
<para> <para>
Poky is primarily a platform builder which generates filesystem images Poky is primarily a platform builder that generates filesystem images
based on open source software such as the Kdrive X server, the Matchbox based on open source software such as the Kdrive X server, the Matchbox
window manager, the GTK+ toolkit and the D-Bus message bus system. Images window manager, the GTK+ toolkit and the D-Bus message bus system. While images
for many kinds of devices can be generated, however the standard example for many kinds of devices can be generated, the standard example
machines target QEMU full system emulation(x86, ARM, MIPS and PowerPC) and machines target QEMU full-system emulation (x86, ARM, MIPS and PowerPC) and
real reference boards for each of these architectures. real reference boards for each of these architectures.
Poky's ability to boot inside a QEMU Poky's ability to boot inside a QEMU
emulator makes it particularly suitable as a test platform for development emulator makes it particularly suitable as a test platform for developing embedded software.
of embedded software.
</para> </para>
<para> <para>
An important component integrated within Poky is Sato, a GNOME Mobile An important component integrated within Poky is Sato, a GNOME Mobile-based
based user interface environment. user interface environment.
It is designed to work well with screens at very high DPI and restricted It is designed to work well with screens that use very high DPI and have restricted
size, such as those often found on smartphones and PDAs. It is coded with sizes, such as those often found on smartphones and PDAs.
focus on efficiency and speed so that it works smoothly on hand-held and Because Sato is coded for speed and efficiency, it works smoothly on hand-held and
other embedded hardware. It will sit neatly on top of any device other embedded hardware.
using the GNOME Mobile stack, providing a well defined user experience. It sits nicely on top of any device that uses the GNOME Mobile stack and it results in
a well-defined user experience.
</para> </para>
<screenshot> <screenshot>
@@ -62,26 +67,30 @@
</mediaobject> </mediaobject>
</screenshot> </screenshot>
<para> <para>
Poky has a growing open source community and is also backed up by commercial organizations
Poky has a growing open source community and is also backed up by commercial organisations including <ulink url="http://www.intel.com/">Intel Corporation</ulink>. including <ulink url="http://www.intel.com/">Intel Corporation</ulink>.
</para> </para>
</section> </section>
<section id='intro-manualoverview'> <section id='intro-manualoverview'>
<title>Documentation Overview</title> <title>Documentation Overview</title>
<para> <para>
The Poky User Guide is split into sections covering different aspects of Poky. The sections in this reference manual describe different aspects of Poky.
The <link linkend='usingpoky'>'Using Poky' section</link> gives an overview of the components that make up Poky followed by information about using Poky and debugging images created in Yocto Project. The <link linkend='usingpoky'>'Using Poky' section</link> provides an overview of the components
The <link linkend='extendpoky'>'Extending Poky' section</link> gives information about how to extend and customise Poky along with advice on how to manage these changes. that make up Poky followed by information about using Poky and debugging images created in Yocto Project.
The <link linkend='platdev'>'Platform Development with Poky' section</link> gives information about interaction between Poky and target hardware for common platform development tasks such as software development, debugging and profiling. The <link linkend='extendpoky'>'Extending Poky'</link> and
The rest of the manual consists of several reference sections each giving details on a specific section of Poky functionality. <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.
The <link linkend='platdev'>'Platform Development with Poky' section</link> provides information about
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.
</para> </para>
<para> <para>
This manual applies to Poky Release 3.3 (Green). This manual applies to Poky Release 4.0 (laverne).
</para> </para>
</section> </section>
@@ -89,14 +98,16 @@
<section id='intro-requirements'> <section id='intro-requirements'>
<title>System Requirements</title> <title>System Requirements</title>
<para> <para>
We recommend Debian-based distributions, in particular a recent Ubuntu Although we recommend Debian-based distributions
release (10.04 or newer), as the host system for Poky. Nothing in Poky is (Ubuntu 10.04 or newer) as the host system for Poky, nothing in Poky is
distribution specific and other distributions will most likely work as long distribution-specific. Consequently, other distributions should work as long
as the appropriate prerequisites are installed - we know of Poky being used as the appropriate prerequisites are installed. For example, we know of Poky being used
successfully on Redhat, SUSE, Gentoo and Slackware host systems. successfully on Redhat, SUSE, Gentoo and Slackware host systems.
For information on what you need to develop images using Yocto Project and Poky For information on what you need to develop images using Yocto Project and Poky,
you should see the Yocto Project Quick Start on the public you should see the Yocto Project Quick Start on the <ulink url="http://www.yoctoproject.org">
<ulink rul='http://yoctoproject.org/'>Yocto Project Website</ulink>. Yocto Project website</ulink>.
The direct link to the quick start is
<ulink url='http://yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html'></ulink>.
</para> </para>
</section> </section>
@@ -106,9 +117,9 @@
<section id='intro-getit-releases'> <section id='intro-getit-releases'>
<title>Releases</title> <title>Releases</title>
<para>Periodically, we make releases of Poky and these are available <para>Periodically, we make releases of Poky available
at <ulink url='http://pokylinux.org/releases/'/>. at <ulink url='http://pokylinux.org/releases/'/>.
These are more stable and tested than the nightly development images.</para> These releases are more stable and more rigorously tested than the nightly development images.</para>
</section> </section>
<section id='intro-getit-nightly'> <section id='intro-getit-nightly'>
@@ -117,13 +128,16 @@
<para> <para>
We make nightly builds of Poky for testing purposes and to make the We make nightly builds of Poky for testing purposes and to make the
latest developments available. The output from these builds is available latest developments available. The output from these builds is available
at <ulink url='http://autobuilder.pokylinux.org/'/> at <ulink url='http://autobuilder.pokylinux.org/'/>.
where the numbers increase for each subsequent build and can be used to reference it. The numbers used in the builds increase for each subsequent build and can be used to
reference a specific build.
</para> </para>
<para> <para>
Automated builds are available for "standard" Poky and for Poky SDKs and toolchains as well Automated builds are available for "standard" Poky and for Poky SDKs and toolchains.
as any testing versions we might have such as poky-bleeding. The toolchains can Additionally, testing versions such as poky-bleeding can be made available as
'experimental' builds.
The toolchains can
be used either as external standalone toolchains or can be combined with Poky as a be used either as external standalone toolchains or can be combined with Poky as a
prebuilt toolchain to reduce build time. Using the external toolchains is simply a prebuilt toolchain to reduce build time. Using the external toolchains is simply a
case of untarring the tarball into the root of your system (it only creates files in case of untarring the tarball into the root of your system (it only creates files in
@@ -136,16 +150,16 @@
<title>Development Checkouts</title> <title>Development Checkouts</title>
<para> <para>
Poky is available from our GIT repository located at Poky is available from our git repository located at
git://git.pokylinux.org/poky.git; a web interface to the repository git://git.pokylinux.org/poky.git; a web interface to the repository
can be accessed at <ulink url='http://git.pokylinux.org/'/>. can be accessed at <ulink url='http://git.pokylinux.org/'/>.
</para> </para>
<para> <para>
The 'master' is where the deveopment work takes place and you should use this if you're The 'master' is where the deveopment work takes place and you should use this if you're
after to work with the latest cutting edge developments. It is possible trunk interested in working with the latest cutting-edge developments. It is possible for the trunk
can suffer temporary periods of instability while new features are developed and to suffer temporary periods of instability while new features are developed.
if this is undesireable we recommend using one of the release branches. If these periods of instability are undesireable, we recommend using one of the release branches.
</para> </para>
</section> </section>
</section> </section>