summaryrefslogtreecommitdiffstats
path: root/documentation/yocto-project-qs
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2011-11-01 08:08:55 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2011-11-01 17:44:01 +0000
commit8c11cbc2fe27dae90f2a347b1cc3ccd11f67477d (patch)
treebeab07daeb3029163f58c4abcfaada0db2b79f93 /documentation/yocto-project-qs
parent1d63630d891be524bfd0e82c92072fc574ad267a (diff)
downloadpoky-8c11cbc2fe27dae90f2a347b1cc3ccd11f67477d.tar.gz
documentation/yocto-project-qs/yocto-project-qs.xml: Robert P. J. Day Review
As Reported By: Robert P. J. Day. Community member Robert P. J. Day scrubbed the Quick Start manual for Release 1.1. He found several areas that were incorrect. Many items were documented pre-release and changed during the actual realeas. Naming conventions for images and such had to be changed. Robert also found and suggested several wording changes that resulted in clearer text. I was not able to patch all the changes using the 'patch' command. I need to work out some process issues still in order to apply patches directly to the yocto-docs repository. Meanwhile, I hand-inserted the changes. Also, some text changes were modified slightly by me to conform to the books style, etc. Kudos to Robert for such a detailed look at the YP Quick Start. (From yocto-docs rev: 6bc2e9c289a802f511441ca5b31ca6163e4fdfac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/yocto-project-qs')
-rw-r--r--documentation/yocto-project-qs/yocto-project-qs.xml80
1 files changed, 35 insertions, 45 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml
index daa1f0efb1..3003f06cd0 100644
--- a/documentation/yocto-project-qs/yocto-project-qs.xml
+++ b/documentation/yocto-project-qs/yocto-project-qs.xml
@@ -149,7 +149,7 @@
149 The Yocto Project team is continually verifying more and more Linux 149 The Yocto Project team is continually verifying more and more Linux
150 distributions with each release. 150 distributions with each release.
151 In general, if you have the current release minus one of the following 151 In general, if you have the current release minus one of the following
152 distributions you should no problems. 152 distributions you should have no problems.
153 <itemizedlist> 153 <itemizedlist>
154 <listitem><para>Ubuntu</para></listitem> 154 <listitem><para>Ubuntu</para></listitem>
155 <listitem><para>Fedora</para></listitem> 155 <listitem><para>Fedora</para></listitem>
@@ -278,7 +278,7 @@
278 <para>Build an image and run it in the QEMU emulator</para> 278 <para>Build an image and run it in the QEMU emulator</para>
279 </listitem> 279 </listitem>
280 <listitem> 280 <listitem>
281 <para>Or, use a pre-built image and run it in the QEMU emulator</para> 281 <para>Use a pre-built image and run it in the QEMU emulator</para>
282 </listitem> 282 </listitem>
283 </itemizedlist> 283 </itemizedlist>
284 284
@@ -331,9 +331,8 @@
331 331
332 <tip><para> 332 <tip><para>
333 To help conserve disk space during builds, you can add the following statement 333 To help conserve disk space during builds, you can add the following statement
334 to your <filename>local.conf</filename> file in the Yocto Project build 334 to your project's configuration file, which for this example
335 directory, which for this example 335 is <filename>edison-6.0-build/conf/local.conf</filename>.
336 is <filename>edison-6.0-build</filename>.
337 Adding this statement deletes the work directory used for building a package 336 Adding this statement deletes the work directory used for building a package
338 once the package is built. 337 once the package is built.
339 <literallayout class='monospaced'> 338 <literallayout class='monospaced'>
@@ -342,16 +341,15 @@
342 </para></tip> 341 </para></tip>
343 342
344 <itemizedlist> 343 <itemizedlist>
345 <listitem><para>The first command retrieves the Yocto Project release tarball from the 344 <listitem><para>In the previous example, the first command retrieves the Yocto Project
346 source repositories. 345 release tarball from the source repositories using the
347 Notice, the example uses the <filename>wget</filename> shell command. 346 <filename>wget</filename> command.
348 Alternatively, you can go to the 347 Alternatively, you can go to the
349 <ulink url='http://www.yoctoproject.org'>Yocto Project website</ulink> downloads 348 <ulink url='http://www.yoctoproject.org/download'>Yocto Project website</ulink>
350 area to retrieve the tarball.</para></listitem> 349 Downloads page to retrieve the tarball.</para></listitem>
351 <listitem><para>The second command extracts the files from the tarball and places 350 <listitem><para>The second command extracts the files from the tarball and places
352 them into a directory named <filename>poky-edison-6.0</filename> in the current 351 them into a directory named <filename>poky-edison-6.0</filename> in the current
353 directory. 352 directory.</para></listitem>
354 </para></listitem>
355 <listitem><para>The third command runs the Yocto Project environment setup script. 353 <listitem><para>The third command runs the Yocto Project environment setup script.
356 Running this script defines Yocto Project build environment settings needed to 354 Running this script defines Yocto Project build environment settings needed to
357 complete the build. 355 complete the build.
@@ -364,19 +362,18 @@
364 </para></listitem> 362 </para></listitem>
365 </itemizedlist> 363 </itemizedlist>
366 <para> 364 <para>
367 Take some time to examine your <filename>conf/local.conf</filename> file found in the 365 Take some time to examine your <filename>local.conf</filename> file
368 Yocto Project build directory. 366 in your project's configuration directory.
369 The defaults in the <filename>local.conf</filename> should work fine. 367 The defaults in that file should work fine.
370 However, there are some variables of interest at which you might look. 368 However, there are some variables of interest at which you might look.
371 </para> 369 </para>
372 370
373 <para> 371 <para>
374 By default, the target architecture for the build is <filename>qemux86</filename>, 372 By default, the target architecture for the build is <filename>qemux86</filename>,
375 which is an image that can be used in the QEMU emulator and is targeted for an 373 which produces an image that can be used in the QEMU emulator and is targeted at an
376 <trademark class='registered'>Intel</trademark> 32-bit based architecture. 374 <trademark class='registered'>Intel</trademark> 32-bit based architecture.
377 To change this default, edit the value of the <filename>MACHINE</filename> variable in the 375 To change this default, edit the value of the <filename>MACHINE</filename> variable
378 <filename>conf/local.conf</filename> file in the build directory before 376 in the configuration file before launching the build.
379 launching the build.
380 </para> 377 </para>
381 378
382 <para> 379 <para>
@@ -384,12 +381,12 @@
384 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the 381 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the
385 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables. 382 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables.
386 By default, these variables are commented out. 383 By default, these variables are commented out.
387 However, if you have a multi-core CPU you might want to remove the comment 384 However, if you have a multi-core CPU you might want to uncomment
388 and set the variable 385 the lines and set the variable
389 <filename>BB_NUMBER_THREADS</filename> equal to twice the number of your 386 <filename>BB_NUMBER_THREADS</filename> equal to twice the number of your
390 host's processor cores. 387 host's processor cores.
391 Also, you could set the variable <filename>PARALLEL_MAKE</filename> equal to the number 388 Also, you could set the variable <filename>PARALLEL_MAKE</filename> equal to
392 of processor cores. 389 1.5 times the number of processor cores.
393 Setting these variables can significantly shorten your build time. 390 Setting these variables can significantly shorten your build time.
394 </para> 391 </para>
395 392
@@ -471,10 +468,10 @@
471 <title>Installing the Toolchain</title> 468 <title>Installing the Toolchain</title>
472 <para> 469 <para>
473 You can download the pre-built toolchain, which includes the <filename>runqemu</filename> 470 You can download the pre-built toolchain, which includes the <filename>runqemu</filename>
474 script and support files, from 471 script and support files, from the appropriate directory under
475 <ulink url='http://yoctoproject.org/downloads/yocto-1.1/toolchain/'></ulink>. 472 <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1/toolchain/'></ulink>.
476 Toolchains are available for 32-bit and 64-bit development systems from the 473 Toolchains are available for 32-bit and 64-bit development systems from the
477 <filename>i686</filename> and <filename>x86_64</filename> folders, respectively. 474 <filename>i686</filename> and <filename>x86_64</filename> directories, respectively.
478 Each type of development system supports five target architectures. 475 Each type of development system supports five target architectures.
479 The tarball files are named such that a string representing the host system appears 476 The tarball files are named such that a string representing the host system appears
480 first in the filename and then is immediately followed by a string representing 477 first in the filename and then is immediately followed by a string representing
@@ -482,7 +479,7 @@
482 </para> 479 </para>
483 480
484 <literallayout class='monospaced'> 481 <literallayout class='monospaced'>
485 yocto-eglibc&lt;<emphasis>host_system</emphasis>&gt;-&lt;<emphasis>arch</emphasis>&gt;-toolchain-gmae-&lt;<emphasis>release</emphasis>&gt;.tar.bz2 482 poky-eglibc&lt;<emphasis>host_system</emphasis>&gt;-&lt;<emphasis>arch</emphasis>&gt;-toolchain-gmae-&lt;<emphasis>release</emphasis>&gt;.tar.bz2
486 483
487 Where: 484 Where:
488 &lt;<emphasis>host_system</emphasis>&gt; is a string representing your development system: 485 &lt;<emphasis>host_system</emphasis>&gt; is a string representing your development system:
@@ -500,7 +497,7 @@
500 </para> 497 </para>
501 498
502 <literallayout class='monospaced'> 499 <literallayout class='monospaced'>
503 yocto-eglibc-x86_64-i586-toolchain-gmae-1.1.tar.bz2 500 poky-eglibc-x86_64-i586-toolchain-gmae-1.1.tar.bz2
504 </literallayout> 501 </literallayout>
505 502
506 <para> 503 <para>
@@ -513,7 +510,7 @@
513 <para> 510 <para>
514 <literallayout class='monospaced'> 511 <literallayout class='monospaced'>
515 $ cd / 512 $ cd /
516 $ sudo tar -xvjf ~/toolchains/yocto-eglibc-x86_64-i586-toolchain-gmae-1.1.tar.bz2 513 $ sudo tar -xvjf ~/toolchains/poky-eglibc-x86_64-i586-toolchain-gmae-1.1.tar.bz2
517 </literallayout> 514 </literallayout>
518 </para> 515 </para>
519 516
@@ -522,7 +519,7 @@
522 "<ulink url='http://www.yoctoproject.org/docs/1.1/adt-manual/adt-manual.html#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and 519 "<ulink url='http://www.yoctoproject.org/docs/1.1/adt-manual/adt-manual.html#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and
523 "<ulink url='http://www.yoctoproject.org/docs/1.1/adt-manual/adt-manual.html#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in 520 "<ulink url='http://www.yoctoproject.org/docs/1.1/adt-manual/adt-manual.html#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in
524 <ulink url='http://www.yoctoproject.org/docs/1.1/adt-manual/adt-manual.html'>The Yocto Project 521 <ulink url='http://www.yoctoproject.org/docs/1.1/adt-manual/adt-manual.html'>The Yocto Project
525 Application Development Toolkit (ADT) Development Manual</ulink>. 522 Application Development Toolkit (ADT) User's Guide</ulink>.
526 </para> 523 </para>
527 </section> 524 </section>
528 525
@@ -531,7 +528,7 @@
531 528
532 <para> 529 <para>
533 You can download the pre-built Linux kernel suitable for running in the QEMU emulator from 530 You can download the pre-built Linux kernel suitable for running in the QEMU emulator from
534 <ulink url='http://yoctoproject.org/downloads/yocto-1.1/machines/qemu'></ulink>. 531 <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1/machines/qemu'></ulink>.
535 Be sure to use the kernel that matches the architecture you want to simulate. 532 Be sure to use the kernel that matches the architecture you want to simulate.
536 Download areas exist for the five supported machine architectures: 533 Download areas exist for the five supported machine architectures:
537 <filename>qemuarm</filename>, <filename>qemumips</filename>, <filename>qemuppc</filename>, 534 <filename>qemuarm</filename>, <filename>qemumips</filename>, <filename>qemuppc</filename>,
@@ -541,17 +538,12 @@
541 <para> 538 <para>
542 Most kernel files have one of the following forms: 539 Most kernel files have one of the following forms:
543 <literallayout class='monospaced'> 540 <literallayout class='monospaced'>
544 *zImage-&lt;<emphasis>kernel-rev</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;-&lt;<emphasis>release</emphasis>&gt;*.bin 541 *zImage-qemu&lt;<emphasis>arch</emphasis>&gt;.bin
545 vmlinux-&lt;<emphasis>kernel-rev</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;-&lt;<emphasis>release</emphasis>&gt;*.bin 542 vmlinux-qemu&lt;<emphasis>arch</emphasis>&gt;.bin
546 543
547 Where: 544 Where:
548 &lt;<emphasis>kernel-rev</emphasis>&gt; is the base Linux kernel revision
549 (e.g. 2.6.37).
550
551 &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture: 545 &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
552 x86, x86-64, ppc, mips, or arm. 546 x86, x86-64, ppc, mips, or arm.
553
554 &lt;<emphasis>release</emphasis>&gt; is the version of Yocto Project.
555 </literallayout> 547 </literallayout>
556 </para> 548 </para>
557 549
@@ -568,7 +560,7 @@
568 560
569 <para> 561 <para>
570 You can also download the filesystem image suitable for your target architecture from 562 You can also download the filesystem image suitable for your target architecture from
571 <ulink url='http://yoctoproject.org/downloads/yocto-1.1/machines/qemu'></ulink>. 563 <ulink url='http://downloads.yoctoproject.org/releases/yocto/yocto-1.1/machines/qemu'></ulink>.
572 Again, be sure to use the filesystem that matches the architecture you want 564 Again, be sure to use the filesystem that matches the architecture you want
573 to simulate. 565 to simulate.
574 </para> 566 </para>
@@ -581,19 +573,17 @@
581 The <filename>tar</filename> form can be flattened out in your host development system 573 The <filename>tar</filename> form can be flattened out in your host development system
582 and used for Yocto Project build purposes. 574 and used for Yocto Project build purposes.
583 <literallayout class='monospaced'> 575 <literallayout class='monospaced'>
584 yocto-image-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;-&lt;<emphasis>release</emphasis>&gt;.rootfs.ext3.bz2 576 core-image-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;.ext3
585 yocto-image-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;-&lt;<emphasis>release</emphasis>&gt;.rootfs.tar.bz2 577 core-image-&lt;<emphasis>profile</emphasis>&gt;-qemu&lt;<emphasis>arch</emphasis>&gt;.tar.bz2
586 578
587 Where: 579 Where:
588 &lt;<emphasis>profile</emphasis>&gt; is the filesystem image's profile: 580 &lt;<emphasis>profile</emphasis>&gt; is the filesystem image's profile:
589 lsb, lsb-dev, lsb-sdk, minimal, minimal-dev, sato, sato-dev, or sato-sdk. 581 lsb, lsb-dev, lsb-sdk, lsb-qt3, minimal, minimal-dev, sato, sato-dev, or sato-sdk.
590 For information on these types of image profiles, see 582 For information on these types of image profiles, see
591 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink> in the Yocto Project Reference Manual. 583 <ulink url='http://www.yoctoproject.org/docs/1.1/poky-ref-manual/poky-ref-manual.html#ref-images'>Reference: Images</ulink> in the Yocto Project Reference Manual.
592 584
593 &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture: 585 &lt;<emphasis>arch</emphasis>&gt; is a string representing the target architecture:
594 x86, x86-64, ppc, mips, or arm. 586 x86, x86-64, ppc, mips, or arm.
595
596 &lt;<emphasis>release</emphasis>&gt; is the version of Yocto Project.
597 </literallayout> 587 </literallayout>
598 </para> 588 </para>
599 </section> 589 </section>
@@ -640,7 +630,7 @@
640 <literallayout class='monospaced'> 630 <literallayout class='monospaced'>
641 $ source /opt/poky/1.1/environment-setup-i686-poky-linux 631 $ source /opt/poky/1.1/environment-setup-i686-poky-linux
642 $ runqemu qemux86 bzImage-3.0-qemux86-1.1.bin \ 632 $ runqemu qemux86 bzImage-3.0-qemux86-1.1.bin \
643 yocto-image-sato-qemux86-1.1.rootfs.ext3 633 core-image-sato-qemux86.ext3
644 </literallayout> 634 </literallayout>
645 </para> 635 </para>
646 636