summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2010-10-27 08:57:26 -0700
committerRichard Purdie <rpurdie@linux.intel.com>2010-11-04 20:20:06 +0000
commite53470656ed6fb2595c75d7f3b7a2fb72900a831 (patch)
tree52f2896c2b83b5683f4b947b3d4ef6ef8b3f76f9 /documentation
parent81d3811b2f91031db1f9b6c3c2c4a0776bb76314 (diff)
downloadpoky-e53470656ed6fb2595c75d7f3b7a2fb72900a831.tar.gz
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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/poky-ref-manual/introduction.xml112
1 files changed, 63 insertions, 49 deletions
diff --git a/documentation/poky-ref-manual/introduction.xml b/documentation/poky-ref-manual/introduction.xml
index 301086a824..afe1028b73 100644
--- a/documentation/poky-ref-manual/introduction.xml
+++ b/documentation/poky-ref-manual/introduction.xml
@@ -8,15 +8,17 @@
8 <title>Welcome to Poky!</title> 8 <title>Welcome to Poky!</title>
9 9
10 <para> 10 <para>
11 Poky is the the build tool in Yocto Project. 11 Poky is the build tool in Yocto Project.
12 It is at the heart of Yocto Project. 12 Yocto Project uses Poky to build images (kernel, system, and application software) for
13 You use Poky within Yocto Project to build the images (kernel software) for targeted hardware. 13 targeted hardware.
14 </para> 14 </para>
15 15
16 <para> 16 <para>
17 Before jumping into Poky you should have an understanding of Yokto Project. 17 Before diving into Poky, it helps to have an understanding of the Yocto Project.
18 Be sure you are familiar with the information in the Yocto Project Quick Start. 18 Especially useful for newcomers is the information in the Yocto Project Quick Start, which
19 You can find this documentation on the public <ulink rul='http://yoctoproject.org/'>Yocto Project Website</ulink>. 19 you can find on the <ulink url="http://www.yoctoproject.org">Yocto Project website</ulink>.
20 Specifically, the guide is
21 at <ulink url="http://www.yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html"></ulink>
20 </para> 22 </para>
21</section> 23</section>
22 24
@@ -24,31 +26,34 @@
24 <title>What is Poky?</title> 26 <title>What is Poky?</title>
25 27
26 <para> 28 <para>
27 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. 29 Within the Yocto Project, Poky provides an open source, full-platform build tool based on
28 It creates a focused, stable, subset of OpenEmbedded that can be easily and reliably built and developed upon. 30 Linux, X11, Matchbox, GTK+, Pimlico, Clutter,
29 Poky fully supports a wide range of x86 ARM, MIPS and PowerPC hardware and device virtulisation. 31 and other <ulink url='http://gnome.org/mobile'>GNOME Mobile</ulink> technologies.
32 It provides a focused and stable subset of OpenEmbedded upon which you can easily and
33 reliably build and develop.
34 Poky fully supports a wide range of x86, ARM, MIPS and PowerPC hardware and device virtualization.
30 </para> 35 </para>
31 36
32 <para> 37 <para>
33 Poky is primarily a platform builder which generates filesystem images 38 Poky is primarily a platform builder that generates filesystem images
34 based on open source software such as the Kdrive X server, the Matchbox 39 based on open source software such as the Kdrive X server, the Matchbox
35 window manager, the GTK+ toolkit and the D-Bus message bus system. Images 40 window manager, the GTK+ toolkit and the D-Bus message bus system. While images
36 for many kinds of devices can be generated, however the standard example 41 for many kinds of devices can be generated, the standard example
37 machines target QEMU full system emulation(x86, ARM, MIPS and PowerPC) and 42 machines target QEMU full-system emulation (x86, ARM, MIPS and PowerPC) and
38 real reference boards for each of these architectures. 43 real reference boards for each of these architectures.
39 Poky's ability to boot inside a QEMU 44 Poky's ability to boot inside a QEMU
40 emulator makes it particularly suitable as a test platform for development 45 emulator makes it particularly suitable as a test platform for developing embedded software.
41 of embedded software.
42 </para> 46 </para>
43 47
44 <para> 48 <para>
45 An important component integrated within Poky is Sato, a GNOME Mobile 49 An important component integrated within Poky is Sato, a GNOME Mobile-based
46 based user interface environment. 50 user interface environment.
47 It is designed to work well with screens at very high DPI and restricted 51 It is designed to work well with screens that use very high DPI and have restricted
48 size, such as those often found on smartphones and PDAs. It is coded with 52 sizes, such as those often found on smartphones and PDAs.
49 focus on efficiency and speed so that it works smoothly on hand-held and 53 Because Sato is coded for speed and efficiency, it works smoothly on hand-held and
50 other embedded hardware. It will sit neatly on top of any device 54 other embedded hardware.
51 using the GNOME Mobile stack, providing a well defined user experience. 55 It sits nicely on top of any device that uses the GNOME Mobile stack and it results in
56 a well-defined user experience.
52 </para> 57 </para>
53 58
54 <screenshot> 59 <screenshot>
@@ -62,26 +67,30 @@
62 </mediaobject> 67 </mediaobject>
63 </screenshot> 68 </screenshot>
64 69
65
66 <para> 70 <para>
67 71 Poky has a growing open source community and is also backed up by commercial organizations
68 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>. 72 including <ulink url="http://www.intel.com/">Intel Corporation</ulink>.
69
70 </para> 73 </para>
71</section> 74</section>
72 75
73<section id='intro-manualoverview'> 76<section id='intro-manualoverview'>
74 <title>Documentation Overview</title> 77 <title>Documentation Overview</title>
75 <para> 78 <para>
76 The Poky User Guide is split into sections covering different aspects of Poky. 79 The sections in this reference manual describe different aspects of Poky.
77 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. 80 The <link linkend='usingpoky'>'Using Poky' section</link> provides an overview of the components
78 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. 81 that make up Poky followed by information about using Poky and debugging images created in Yocto Project.
79 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. 82 The <link linkend='extendpoky'>'Extending Poky'</link> and
80 The rest of the manual consists of several reference sections each giving details on a specific section of Poky functionality. 83 <link linkend='bsp'>'Board Support Packages'</link> sections provide information
84 about how to extend and customize Poky along with advice on how to manage these changes.
85 The <link linkend='platdev'>'Platform Development with Poky' section</link> provides information about
86 interaction between Poky and target hardware for common platform development tasks such as software
87 development, debugging and profiling.
88 The rest of the manual consists of several reference sections, each providing details on a specific
89 area of Poky functionality.
81 </para> 90 </para>
82 91
83 <para> 92 <para>
84 This manual applies to Poky Release 3.3 (Green). 93 This manual applies to Poky Release 4.0 (laverne).
85 </para> 94 </para>
86</section> 95</section>
87 96
@@ -89,14 +98,16 @@
89<section id='intro-requirements'> 98<section id='intro-requirements'>
90 <title>System Requirements</title> 99 <title>System Requirements</title>
91 <para> 100 <para>
92 We recommend Debian-based distributions, in particular a recent Ubuntu 101 Although we recommend Debian-based distributions
93 release (10.04 or newer), as the host system for Poky. Nothing in Poky is 102 (Ubuntu 10.04 or newer) as the host system for Poky, nothing in Poky is
94 distribution specific and other distributions will most likely work as long 103 distribution-specific. Consequently, other distributions should work as long
95 as the appropriate prerequisites are installed - we know of Poky being used 104 as the appropriate prerequisites are installed. For example, we know of Poky being used
96 successfully on Redhat, SUSE, Gentoo and Slackware host systems. 105 successfully on Redhat, SUSE, Gentoo and Slackware host systems.
97 For information on what you need to develop images using Yocto Project and Poky 106 For information on what you need to develop images using Yocto Project and Poky,
98 you should see the Yocto Project Quick Start on the public 107 you should see the Yocto Project Quick Start on the <ulink url="http://www.yoctoproject.org">
99 <ulink rul='http://yoctoproject.org/'>Yocto Project Website</ulink>. 108 Yocto Project website</ulink>.
109 The direct link to the quick start is
110 <ulink url='http://yoctoproject.org/docs/yocto-quick-start/yocto-project-qs.html'></ulink>.
100 </para> 111 </para>
101</section> 112</section>
102 113
@@ -106,9 +117,9 @@
106 <section id='intro-getit-releases'> 117 <section id='intro-getit-releases'>
107 <title>Releases</title> 118 <title>Releases</title>
108 119
109 <para>Periodically, we make releases of Poky and these are available 120 <para>Periodically, we make releases of Poky available
110 at <ulink url='http://pokylinux.org/releases/'/>. 121 at <ulink url='http://pokylinux.org/releases/'/>.
111 These are more stable and tested than the nightly development images.</para> 122 These releases are more stable and more rigorously tested than the nightly development images.</para>
112 </section> 123 </section>
113 124
114 <section id='intro-getit-nightly'> 125 <section id='intro-getit-nightly'>
@@ -117,13 +128,16 @@
117 <para> 128 <para>
118 We make nightly builds of Poky for testing purposes and to make the 129 We make nightly builds of Poky for testing purposes and to make the
119 latest developments available. The output from these builds is available 130 latest developments available. The output from these builds is available
120 at <ulink url='http://autobuilder.pokylinux.org/'/> 131 at <ulink url='http://autobuilder.pokylinux.org/'/>.
121 where the numbers increase for each subsequent build and can be used to reference it. 132 The numbers used in the builds increase for each subsequent build and can be used to
133 reference a specific build.
122 </para> 134 </para>
123 135
124 <para> 136 <para>
125 Automated builds are available for "standard" Poky and for Poky SDKs and toolchains as well 137 Automated builds are available for "standard" Poky and for Poky SDKs and toolchains.
126 as any testing versions we might have such as poky-bleeding. The toolchains can 138 Additionally, testing versions such as poky-bleeding can be made available as
139 'experimental' builds.
140 The toolchains can
127 be used either as external standalone toolchains or can be combined with Poky as a 141 be used either as external standalone toolchains or can be combined with Poky as a
128 prebuilt toolchain to reduce build time. Using the external toolchains is simply a 142 prebuilt toolchain to reduce build time. Using the external toolchains is simply a
129 case of untarring the tarball into the root of your system (it only creates files in 143 case of untarring the tarball into the root of your system (it only creates files in
@@ -136,16 +150,16 @@
136 <title>Development Checkouts</title> 150 <title>Development Checkouts</title>
137 151
138 <para> 152 <para>
139 Poky is available from our GIT repository located at 153 Poky is available from our git repository located at
140 git://git.pokylinux.org/poky.git; a web interface to the repository 154 git://git.pokylinux.org/poky.git; a web interface to the repository
141 can be accessed at <ulink url='http://git.pokylinux.org/'/>. 155 can be accessed at <ulink url='http://git.pokylinux.org/'/>.
142 </para> 156 </para>
143 157
144 <para> 158 <para>
145 The 'master' is where the deveopment work takes place and you should use this if you're 159 The 'master' is where the deveopment work takes place and you should use this if you're
146 after to work with the latest cutting edge developments. It is possible trunk 160 interested in working with the latest cutting-edge developments. It is possible for the trunk
147 can suffer temporary periods of instability while new features are developed and 161 to suffer temporary periods of instability while new features are developed.
148 if this is undesireable we recommend using one of the release branches. 162 If these periods of instability are undesireable, we recommend using one of the release branches.
149 </para> 163 </para>
150 </section> 164 </section>
151</section> 165</section>