summaryrefslogtreecommitdiffstats
path: root/handbook
diff options
context:
space:
mode:
authorYu Ke <ke.yu@intel.com>2010-09-09 02:34:34 (GMT)
committerRichard Purdie <rpurdie@linux.intel.com>2010-09-10 11:32:13 (GMT)
commit0a217cd18f09c837f67bf54956904a79fb013876 (patch)
treec080173ebcb98034b1809b17b092102ffbab9908 /handbook
parent8627258ac3bae635c2ff54cfa24863e50a2a136c (diff)
downloadpoky-0a217cd18f09c837f67bf54956904a79fb013876.tar.gz
handbook: review and update CH1(introduction) and CH2(using Poky)
Signed-off-by: Yu Ke <ke.yu@intel.com> Signed-off-by: Kevin Tian <kevin.tian@intel.com>
Diffstat (limited to 'handbook')
-rw-r--r--handbook/introduction.xml23
-rw-r--r--handbook/usingpoky.xml16
2 files changed, 28 insertions, 11 deletions
diff --git a/handbook/introduction.xml b/handbook/introduction.xml
index 27427c9..95017c6 100644
--- a/handbook/introduction.xml
+++ b/handbook/introduction.xml
@@ -30,7 +30,7 @@
30 <para>Create a focused, stable, subset of OpenEmbedded that can be easily and reliably built and developed upon.</para> 30 <para>Create a focused, stable, subset of OpenEmbedded that can be easily and reliably built and developed upon.</para>
31 </listitem> 31 </listitem>
32 <listitem> 32 <listitem>
33 <para>Fully support a wide range of x86 and ARM hardware and device virtulisation</para> 33 <para>Fully support a wide range of x86, ARM, MIPS, PowerPC hardware and device virtulisation</para>
34 </listitem> 34 </listitem>
35 </itemizedlist> 35 </itemizedlist>
36 36
@@ -39,7 +39,7 @@
39 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
40 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. Images
41 for many kinds of devices can be generated, however the standard example 41 for many kinds of devices can be generated, however the standard example
42 machines target QEMU full system emulation (both x86 and ARM) and the ARM based 42 machines target QEMU full system emulation(x86, ARM, MIPS and PowerPC) and the ARM based
43 Sharp Zaurus series of devices. Poky's ability to boot inside a QEMU 43 Sharp Zaurus series of devices. Poky's ability to boot inside a QEMU
44 emulator makes it particularly suitable as a test platform for development 44 emulator makes it particularly suitable as a test platform for development
45 of embedded software. 45 of embedded software.
@@ -83,7 +83,11 @@
83 of the components that make up Poky followed by information about using and 83 of the components that make up Poky followed by information about using and
84 debugging the Poky build system. The <link linkend='extendpoky'>'Extending Poky' section</link> 84 debugging the Poky build system. The <link linkend='extendpoky'>'Extending Poky' section</link>
85 gives information about how to extend and customise Poky along with advice 85 gives information about how to extend and customise Poky along with advice
86 on how to manage these changes. The <link linkend='platdev'>'Platform Development with Poky' 86 on how to manage these changes.
87 The <link linkend='bsp'>'Board Support Packages (BSP) - Developers Guide' section</link>
88 gives information about how to develop BSP such as the common layout, the
89 software hardware configuration options etc.
90 The <link linkend='platdev'>'Platform Development with Poky'
87 section</link> gives information about interaction between Poky and target 91 section</link> gives information about interaction between Poky and target
88 hardware for common platform development tasks such as software development, 92 hardware for common platform development tasks such as software development,
89 debugging and profiling. The rest of the manual 93 debugging and profiling. The rest of the manual
@@ -92,7 +96,7 @@
92 </para> 96 </para>
93 97
94 <para> 98 <para>
95 This manual applies to Poky Release 3.1 (Pinky). 99 This manual applies to Poky Release 3.3 (Green).
96 </para> 100 </para>
97 101
98</section> 102</section>
@@ -200,13 +204,14 @@ $ tar xjvf poky-green-3.3.tar.bz2
200$ cd green-3.3/ 204$ cd green-3.3/
201$ source poky-init-build-env 205$ source poky-init-build-env
202$ bitbake poky-image-sato 206$ bitbake poky-image-sato
207$ bitbake qemu-native
203$ runqemu qemux86 208$ runqemu qemux86
204</literallayout> 209</literallayout>
205 </para> 210 </para>
206 211
207 <note> 212 <note>
208 <para> 213 <para>
209 This process will need Internet access, about 3 GB of disk space 214 This process will need Internet access, about 20 GB of disk space
210 available, and you should expect the build to take about 4 - 5 hours since 215 available, and you should expect the build to take about 4 - 5 hours since
211 it is building an entire Linux system from source including the toolchain! 216 it is building an entire Linux system from source including the toolchain!
212 </para> 217 </para>
@@ -266,8 +271,8 @@ $ apt-get install qemu poky-scripts
266 Download a Poky QEMU release kernel (*zImage*qemu*.bin) and compressed 271 Download a Poky QEMU release kernel (*zImage*qemu*.bin) and compressed
267 filesystem image (poky-image-*-qemu*.ext2.bz2) which 272 filesystem image (poky-image-*-qemu*.ext2.bz2) which
268 you'll need to decompress with 'bzip2 -d'. These are available from the 273 you'll need to decompress with 'bzip2 -d'. These are available from the
269 <ulink url='http://pokylinux.org/releases/blinky-3.0/'>last release</ulink> 274 <ulink url='http://pokylinux.org/releases/green-3.3/'>last release</ulink>
270 or from the <ulink url='http://pokylinux.org/autobuild/poky/'>autobuilder</ulink>. 275 or from the <ulink url='http://autobuilder.pokylinux.org/'>autobuilder</ulink>.
271 </para> 276 </para>
272 </listitem> 277 </listitem>
273 <listitem> 278 <listitem>
@@ -306,7 +311,7 @@ $ poky-qemu &lt;kernel&gt; &lt;image&gt;
306 <para> 311 <para>
307 We make nightly builds of Poky for testing purposes and to make the 312 We make nightly builds of Poky for testing purposes and to make the
308 latest developments available. The output from these builds is available 313 latest developments available. The output from these builds is available
309 at <ulink url='http://pokylinux.org/autobuild/'/> 314 at <ulink url='http://autobuilder.pokylinux.org/'/>
310 where the numbers increase for each subsequent build and can be used to reference it. 315 where the numbers increase for each subsequent build and can be used to reference it.
311 </para> 316 </para>
312 317
@@ -316,7 +321,7 @@ $ poky-qemu &lt;kernel&gt; &lt;image&gt;
316 be used either as external standalone toolchains or can be combined with Poky as a 321 be used either as external standalone toolchains or can be combined with Poky as a
317 prebuilt toolchain to reduce build time. Using the external toolchains is simply a 322 prebuilt toolchain to reduce build time. Using the external toolchains is simply a
318 case of untarring the tarball into the root of your system (it only creates files in 323 case of untarring the tarball into the root of your system (it only creates files in
319 <filename class="directory">/usr/local/poky</filename>) and then enabling the option 324 <filename class="directory">/opt/poky</filename>) and then enabling the option
320 in <filename>local.conf</filename>. 325 in <filename>local.conf</filename>.
321 </para> 326 </para>
322 327
diff --git a/handbook/usingpoky.xml b/handbook/usingpoky.xml
index 07b8f6c..50816c9 100644
--- a/handbook/usingpoky.xml
+++ b/handbook/usingpoky.xml
@@ -118,15 +118,23 @@
118 </para> 118 </para>
119 <para> 119 <para>
120 <literallayout class='monospaced'> 120 <literallayout class='monospaced'>
121$ source poky-init-build-env 121$ source poky-init-build-env [build_dir]
122</literallayout> 122</literallayout>
123 </para> 123 </para>
124 <para> 124 <para>
125 The build_dir is the dir containing all the building object files. The default
126 build dir is poky-dir/build. Multiple build_dir can be used for different targets.
127 For example, ~/build/x86 for qemux86 target, and ~/build/arm for qemuarm target.
128 Please refer to <link linkend="structure-core-script">poky-init-build-env</link>
129 for detail info
130 </para>
131 <para>
125 Once the Poky build environment is set up, a target can now be built using: 132 Once the Poky build environment is set up, a target can now be built using:
126 </para> 133 </para>
127 <para> 134 <para>
128 <literallayout class='monospaced'> 135 <literallayout class='monospaced'>
129$ bitbake &lt;target&gt; 136$ bitbake &lt;target&gt;
137$ bitbake qemu-native
130</literallayout> 138</literallayout>
131 </para> 139 </para>
132 <para> 140 <para>
@@ -135,6 +143,8 @@ $ bitbake &lt;target&gt;
135 or the name of a recipe for a specific piece of software like 143 or the name of a recipe for a specific piece of software like
136 <application>busybox</application>. More details about the standard images 144 <application>busybox</application>. More details about the standard images
137 are available in the <link linkend='ref-images'>image reference section</link>. 145 are available in the <link linkend='ref-images'>image reference section</link>.
146 The qemu-native target will build the poky customized qemu, and will be used
147 by runqemu script later.
138 </para> 148 </para>
139</section> 149</section>
140 150
@@ -301,7 +311,7 @@ route add default gw 192.168.0.202 usb0
301 <para> 311 <para>
302 You can view a list of tasks in a given package by running 312 You can view a list of tasks in a given package by running
303 the listtasks task e.g. <command>bitbake matchbox-desktop -c 313 the listtasks task e.g. <command>bitbake matchbox-desktop -c
304 listtasks</command>. 314 listtasks</command>, and the result is in file ${WORKDIR}/temp/log.do_listtasks.pid.
305 </para> 315 </para>
306 </section> 316 </section>
307 317
@@ -317,6 +327,8 @@ route add default gw 192.168.0.202 usb0
317 directory. They show 327 directory. They show
318 which packages and tasks depend on which other packages and 328 which packages and tasks depend on which other packages and
319 tasks and are useful for debugging purposes. 329 tasks and are useful for debugging purposes.
330 <command>"bitbake -g -u depexp targetname"</command> will show result
331 in more human-readable GUI style.
320 </para> 332 </para>
321 </section> 333 </section>
322 334