summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2010-10-20 09:47:09 -0700
committerRichard Purdie <rpurdie@linux.intel.com>2010-10-27 07:50:34 +0100
commit5434a49f3dd71bc56c0e02470abc7c07bf5fd9a8 (patch)
tree11a4293907a76250ec9d6a73fa6e186ced8db2aa /documentation
parent11686d07a245dd93545d197fb9118a31de84464e (diff)
downloadpoky-5434a49f3dd71bc56c0e02470abc7c07bf5fd9a8.tar.gz
Review changes applied.
1. Added Richard Purdie's general editing feedback to the "Welcome" and "Introducing the Yocto Project Development Environment" sections. 2. Added Kevin Tian's feedback: 1) changed "Sudo" to "sudo", 2) reversed the order of the sample "cd" and "source" commands since the "source" command builds the directory structure first so changing to the directory before running "source" made no sense, 3) removed the "bitbake qemu-native" command. Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml80
1 files changed, 54 insertions, 26 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index d67ff41edc..3f2f73788a 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -12,23 +12,35 @@
12 <title>Welcome!</title> 12 <title>Welcome!</title>
13 <para> 13 <para>
14 Welcome to the Yocto Project! 14 Welcome to the Yocto Project!
15 The Yocto Project is an open-source Linux development environment. 15 The Yocto Project (YP) is an open-source collaboration project focused on embedded Linux
16 This short document will give you some basic information about the environment as well as let you experience it in its simplest form. 16 developers.
17 After reading this document you will have a basic understanding of what the Yocto Project is and how to work within it. 17 Amongst other things, YP uses the Poky build tool to construct complete Linux images.
18 This document also steps you through a simple example showing you how to build a small image and run it using the QEMU emulator.
19 </para> 18 </para>
20 <para> 19 <para>
21 For complete information on the Yocto Project you should check out the <ulink url='http://www.yoctolinux.org'>Public Yocto Website</ulink>. 20 This short document will give you some basic information about the environment as well
22 You can find the latest builds, breaking news, full development documentation, and a rich Yocto Project Development Community into which you can tap. 21 as let you experience it in its simplest form.
22 After reading this document you will have a basic understanding of what the Yocto Project is
23 and how to use some of its core components.
24 This document steps you through a simple example showing you how to build a small image
25 and run it using the QEMU emulator.
26 </para>
27 <para>
28 For complete information on the Yocto Project you should check out the
29 <ulink url='http://www.yoctolinux.org'>Yocto Project Website</ulink>.
30 You can find the latest builds, breaking news, full development documentation, and a
31 rich Yocto Project Development Community into which you can tap.
23 </para> 32 </para>
24</section> 33</section>
25 34
26<section id='yp-intro'> 35<section id='yp-intro'>
27 <title>Introducing the Yocto Project Development Environment</title> 36 <title>Introducing the Yocto Project Development Environment</title>
28
29 <para> 37 <para>
30 Yocto Project is an open source development environment that creates Linux-based images suitable for many types of devices (large or small) based on architectures such as x86, x86-64, Xeon, ARM, and MIPS as well as PowerPC and device emulation. 38 The Yocto Project through the Poky build tool provides an open source development
31 You can use Yocto Project to design, develop, build, debug, simulate, and test the complete software stack using Linux, the X Window System, GNOME Mobile-based application frameworks, and Qt frameworks. 39 environment targeting the ARM, MIPS, PowerPC and x86 architectures for a variety of
40 platforms including x86-64 and emulated ones.
41 You can use components from the the Yocto Project to design, develop, build, debug, simulate,
42 and test the complete software stack using Linux, the X Window System, GNOME Mobile-based
43 application frameworks, and Qt frameworks.
32 </para> 44 </para>
33 45
34 <para></para> 46 <para></para>
@@ -52,27 +64,38 @@
52 <para>Provides an open source Linux kernel along with a set of system commands and libraries suitable for the embedded environment.</para> 64 <para>Provides an open source Linux kernel along with a set of system commands and libraries suitable for the embedded environment.</para>
53 </listitem> 65 </listitem>
54 <listitem> 66 <listitem>
55 <para>Makes available system components such as X11, Matchbox, GTK+, Pimlico, Clutter, and Qt (among others) so you can create a richer user interface experience on devices that use displays or have a GUI. 67 <para>Makes available system components such as X11, Matchbox, GTK+, Pimlico, Clutter,
56For devices that don't have a GUI or display you simply would not employ these components.</para> 68 GuPNP and Qt (among others) so you can create a richer user interface experience on
69 devices that use displays or have a GUI.
70 For devices that don't have a GUI or display you simply would not employ these
71 components.</para>
57 </listitem> 72 </listitem>
58 <listitem> 73 <listitem>
59 <para>Creates a focused and stable subset of OpenEmbedded on which you can easily and reliably build and develop.</para> 74 <para>Creates a focused and stable core compatible with the OpenEmbedded
75 project with which you can easily and reliably build and develop.</para>
60 </listitem> 76 </listitem>
61 <listitem> 77 <listitem>
62 <para>Fully supports a wide range of hardware and device emulation through the QEMU Emulator or other supported emulators.</para> 78 <para>Fully supports a wide range of hardware and device emulation through the QEMU
79 Emulator.</para>
63 </listitem> 80 </listitem>
64 </itemizedlist> 81 </itemizedlist>
65 82
66 <para> 83 <para>
67 Yocto Project generates file system images 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.
68 Yocto Project can generate images for many kinds of devices. 84 Yocto Project can generate images for many kinds of devices.
69 However, the standard example machines target QEMU full system emulation for x86, ARM, MIPS, and PPC based architectures as well as specific hardware such as the Intel Desktop Board DH55TC. 85 However, the standard example machines target QEMU full system emulation for x86, ARM, MIPS,
70 Because an image developed with Yocto Project can boot inside a QEMU emulator, the development environment works nicely as a test platform for developing embedded software. 86 and PPC based architectures as well as specific hardware such as the Intel Desktop Board
87 DH55TC.
88 Because an image developed with Yocto Project can boot inside a QEMU emulator, the
89 development environment works nicely as a test platform for developing embedded software.
71 </para> 90 </para>
72 91
73 <para> 92 <para>
74 Another important Yocto Project feature is the Sato component. 93 Another important Yocto Project feature is the Sato reference User Interface.
75 The optional Sato component, a GNOME mobile-based user interface environment well suited for devices with restricted screen sizes, sits neatly on top of any device using the GNOME Mobile Stack providing a well defined user experience. 94 This optional GNOME mobile-based UI, which is intended for devices with
95 resolution but restricted size screens, sits neatly on top of a device using the
96 GNOME Mobile Stack providing a well defined user experience.
97 Implemented in its own layer, it makes it clear to developers how they can implement ]
98 their own UIs on top of Yocto Linux.
76 </para> 99 </para>
77</section> 100</section>
78 101
@@ -113,7 +136,7 @@ For devices that don't have a GUI or display you simply would not employ these c
113 </para> 136 </para>
114 137
115 <literallayout class='monospaced'> 138 <literallayout class='monospaced'>
116 Sudo apt-get install sed wget cvs subversion git-core coreutils 139 sudo apt-get install sed wget cvs subversion git-core coreutils
117 unzip texi2html texinfo libsdll.2-dev docbook-utils gawk 140 unzip texi2html texinfo libsdll.2-dev docbook-utils gawk
118 python-pysqlite2 diffstat help2man make gcc build-essential 141 python-pysqlite2 diffstat help2man make gcc build-essential
119 g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev 142 g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev
@@ -130,8 +153,10 @@ For devices that don't have a GUI or display you simply would not employ these c
130 <title>Yocto Project Release</title> 153 <title>Yocto Project Release</title>
131 154
132 <para> 155 <para>
133 The latest releases for Yocto Project are kept at http://yoctoproject.org/releases. 156 The latest releases for Yocto Project are kept at
134 Nightly and developmental builds are also maintained. However, for this document a released version of Yocto Project is used. 157 <ulink url="http://yoctoproject.org/releases"></ulink>.
158 Nightly and developmental builds are also maintained. However, for this
159 document a released version of Yocto Project is used.
135 </para> 160 </para>
136 </section> 161 </section>
137</section> 162</section>
@@ -182,9 +207,8 @@ For devices that don't have a GUI or display you simply would not employ these c
182 <literallayout class='monospaced'> 207 <literallayout class='monospaced'>
183 $ wget http://pokylinux.org/releases/poky-green-3.3.tar.bz2 208 $ wget http://pokylinux.org/releases/poky-green-3.3.tar.bz2
184 $ tar xjvf poky-green-3.3.tar.bz2 209 $ tar xjvf poky-green-3.3.tar.bz2
185 $ cd green-3.3-build
186 $ source green-3.3/poky-init-build-env green-3.3-build 210 $ source green-3.3/poky-init-build-env green-3.3-build
187 $ bitbake qemu-native 211 $ cd green-3.3-build
188 $ bitbake poky-image-sato 212 $ bitbake poky-image-sato
189 $ poky-qemu qemux86 213 $ poky-qemu qemux86
190 </literallayout> 214 </literallayout>
@@ -202,15 +226,19 @@ For devices that don't have a GUI or display you simply would not employ these c
202 </listitem> 226 </listitem>
203 <listitem> 227 <listitem>
204 <para> 228 <para>
205 After changing to the build directory the source command sets up the Yocto Project build environment. 229 The next two commands create the directory and place you there.
206 The build directory contains all the object files used during the build. 230 The build directory contains all the object files used during the build.
207 The default build directory is poky-dir/build. 231 The default build directory is poky-dir/build.
232 Note that you can change the target architecture by editing the
233 <command>&lt;build_directory&gt;/conf/local.conf</command> file.
234 By default the target architecture is qemux86.
208 </para> 235 </para>
209 </listitem> 236 </listitem>
210 <listitem> 237 <listitem>
211 <para> 238 <para>
212 The two bitbake commands build the OS image and the emulator for the target. 239 The bitbake command builds the OS image for the target.
213 Here poky-image-sato is the name of the target. The qemu-native target is the customized QEMU Emulator.</para> 240 Here poky-image-sato is the name of the target.
241 </para>
214 </listitem> 242 </listitem>
215 <listitem> 243 <listitem>
216 <para> 244 <para>