diff options
| -rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 129 |
1 files changed, 77 insertions, 52 deletions
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index 4e260cc35d..843b43b456 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
| @@ -369,22 +369,24 @@ | |||
| 369 | <title>A Quick Test Run</title> | 369 | <title>A Quick Test Run</title> |
| 370 | 370 | ||
| 371 | <para> | 371 | <para> |
| 372 | Now that you have your system requirements in order, you can give the Yocto Project a try. | 372 | Now that you have your system requirements in order, you can give |
| 373 | the Yocto Project a try. | ||
| 373 | This section presents some steps that let you do the following: | 374 | This section presents some steps that let you do the following: |
| 374 | </para> | 375 | <itemizedlist> |
| 375 | 376 | <listitem><para> | |
| 376 | <itemizedlist> | ||
| 377 | <listitem> | ||
| 378 | <para> | ||
| 379 | Build an image and run it in the QEMU emulator. | 377 | Build an image and run it in the QEMU emulator. |
| 380 | </para> | 378 | </para></listitem> |
| 381 | </listitem> | 379 | <listitem><para> |
| 382 | <listitem> | ||
| 383 | <para> | ||
| 384 | Use a pre-built image and run it in the QEMU emulator. | 380 | Use a pre-built image and run it in the QEMU emulator. |
| 385 | </para> | 381 | </para></listitem> |
| 386 | </listitem> | 382 | </itemizedlist> |
| 387 | </itemizedlist> | 383 | <note> |
| 384 | This section does not provide detail, but rather provides minimal, | ||
| 385 | working commands and examples designed to just get you started. | ||
| 386 | For more details, see the appropriate manuals in the | ||
| 387 | <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project manual set</ulink>. | ||
| 388 | </note> | ||
| 389 | </para> | ||
| 388 | 390 | ||
| 389 | <section id='building-image'> | 391 | <section id='building-image'> |
| 390 | <title>Building an Image</title> | 392 | <title>Building an Image</title> |
| @@ -463,8 +465,9 @@ | |||
| 463 | a local repository named <filename>poky</filename> that is a | 465 | a local repository named <filename>poky</filename> that is a |
| 464 | clone of the upstream Yocto Project | 466 | clone of the upstream Yocto Project |
| 465 | <filename>poky</filename> repository.</para></listitem> | 467 | <filename>poky</filename> repository.</para></listitem> |
| 466 | <listitem><para>The third command checks out a local branch and | 468 | <listitem><para>The third command checks out the current |
| 467 | names it <filename>&DISTRO_NAME;</filename>. | 469 | Yocto Project release into a local branch whose name matches |
| 470 | the release (i.e. <filename>&DISTRO_NAME;</filename>). | ||
| 468 | The local branch tracks the upstream branch of the same name. | 471 | The local branch tracks the upstream branch of the same name. |
| 469 | Creating your own branch based on the released branch ensures | 472 | Creating your own branch based on the released branch ensures |
| 470 | you are using the latest files for that release. | 473 | you are using the latest files for that release. |
| @@ -509,17 +512,17 @@ | |||
| 509 | </para> | 512 | </para> |
| 510 | 513 | ||
| 511 | <para> | 514 | <para> |
| 512 | Another three variables of interest are the | 515 | Three other variables of interest are the |
| 513 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>, | 516 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>, |
| 514 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>, | 517 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>, |
| 515 | and | 518 | and |
| 516 | <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> | 519 | <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> |
| 517 | variables. | 520 | variables. |
| 518 | By default, these variables are optimally set based on the | 521 | By default, the OpenEmbedded build system sets these variables |
| 519 | number of processor cores your build host uses. | 522 | based on the number of processor cores your build host uses. |
| 520 | Although it is possible to override these variables, the | 523 | Thus, you typically do not need to uncomment these variables in |
| 521 | default values the OpenEmbedded build system derives provide you | 524 | your <filename>local.conf</filename> file to gain optimal build |
| 522 | with parallelism during the build. | 525 | times. |
| 523 | </para> | 526 | </para> |
| 524 | 527 | ||
| 525 | <para> | 528 | <para> |
| @@ -533,39 +536,54 @@ | |||
| 533 | section in the Yocto Project Reference Manual. | 536 | section in the Yocto Project Reference Manual. |
| 534 | </para> | 537 | </para> |
| 535 | 538 | ||
| 536 | <para> | 539 | <para> |
| 537 | Continue with the following command to build an OS image for the target, which is | 540 | Continue with the following command to build an OS image for the |
| 538 | <filename>core-image-sato</filename> in this example. | 541 | target, which is <filename>core-image-sato</filename> in this |
| 539 | For information on the <filename>-k</filename> option use the | 542 | example. |
| 540 | <filename>bitbake --help</filename> command, see the | 543 | For information on the <filename>-k</filename> option use the |
| 541 | "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" | 544 | <filename>bitbake --help</filename> command, see the |
| 542 | section in the Yocto Project Reference Manual, or see the | 545 | "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" |
| 543 | "<ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual-command'>BitBake Command</ulink>" | 546 | section in the Yocto Project Reference Manual, or see the |
| 544 | section in the BitBake User Manual. | 547 | "<ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual-command'>BitBake Command</ulink>" |
| 545 | <literallayout class='monospaced'> | 548 | section in the BitBake User Manual. |
| 549 | For information on other targets, see the | ||
| 550 | "<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" | ||
| 551 | chapter in the Yocto Project Reference Manual. | ||
| 552 | <literallayout class='monospaced'> | ||
| 546 | $ bitbake -k core-image-sato | 553 | $ bitbake -k core-image-sato |
| 547 | </literallayout> | 554 | </literallayout> |
| 548 | <note> | 555 | <note> |
| 549 | BitBake requires Python 2.6 or 2.7. For more information on | 556 | BitBake requires Python 2.6 or 2.7. For more information on |
| 550 | this requirement, see the | 557 | this requirement, see the |
| 551 | "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python</ulink>" | 558 | "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python</ulink>" |
| 552 | section in the Yocto Project Reference Manual. | 559 | section in the Yocto Project Reference Manual. |
| 553 | </note> | 560 | </note> |
| 554 | The final command runs the image using the QEMU emulator: | 561 | The final command runs the image using the QEMU emulator: |
| 555 | <literallayout class='monospaced'> | 562 | <literallayout class='monospaced'> |
| 556 | $ runqemu qemux86 | 563 | $ runqemu qemux86 |
| 557 | </literallayout> | 564 | </literallayout> |
| 558 | <note> | 565 | <note> |
| 559 | <para> | 566 | <para> |
| 560 | Depending on the number of processors and cores, the amount | 567 | Depending on the number of processors and cores, the amount |
| 561 | of RAM, the speed of your Internet connection and other | 568 | of RAM, the speed of your Internet connection and other |
| 562 | factors, the build process could take several hours the | 569 | factors, the build process could take several hours the |
| 563 | first time you run it. | 570 | first time you run it. |
| 564 | Subsequent builds run much faster since parts of the build | 571 | Subsequent builds run much faster since parts of the build |
| 565 | are cached. | 572 | are cached. |
| 566 | </para> | 573 | </para> |
| 567 | </note> | 574 | </note> |
| 568 | </para> | 575 | If you want to learn more about running QEMU, see the |
| 576 | "<ulink url="&YOCTO_DOCS_DEV_URL;#dev-manual-qemu">Using the Quick EMUlator (QEMU)</ulink>" | ||
| 577 | chapter in the Yocto Project Development Manual. | ||
| 578 | </para> | ||
| 579 | |||
| 580 | <para> | ||
| 581 | For information on how to use a pre-built binary, continue reading | ||
| 582 | into the next section. | ||
| 583 | Otherwise, you might be interested in reading the early chapters | ||
| 584 | of the | ||
| 585 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>. | ||
| 586 | </para> | ||
| 569 | </section> | 587 | </section> |
| 570 | 588 | ||
| 571 | <section id='using-pre-built'> | 589 | <section id='using-pre-built'> |
| @@ -821,6 +839,13 @@ | |||
| 821 | </para> | 839 | </para> |
| 822 | </section> | 840 | </section> |
| 823 | </section> | 841 | </section> |
| 842 | |||
| 843 | <para> | ||
| 844 | For more detailed information on using the Yocto Project for | ||
| 845 | image and application develop, the best place to continue reading is | ||
| 846 | in the | ||
| 847 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>. | ||
| 848 | </para> | ||
| 824 | </section> | 849 | </section> |
| 825 | 850 | ||
| 826 | <section id='super-user'> | 851 | <section id='super-user'> |
