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 @@ A Quick Test Run - Now that you have your system requirements in order, you can give the Yocto Project a try. + Now that you have your system requirements in order, you can give + the Yocto Project a try. This section presents some steps that let you do the following: - - - - - + + Build an image and run it in the QEMU emulator. - - - - + + Use a pre-built image and run it in the QEMU emulator. - - - + + + + This section does not provide detail, but rather provides minimal, + working commands and examples designed to just get you started. + For more details, see the appropriate manuals in the + Yocto Project manual set. + +
Building an Image @@ -463,8 +465,9 @@ a local repository named poky that is a clone of the upstream Yocto Project poky repository. - The third command checks out a local branch and - names it &DISTRO_NAME;. + The third command checks out the current + Yocto Project release into a local branch whose name matches + the release (i.e. &DISTRO_NAME;). The local branch tracks the upstream branch of the same name. Creating your own branch based on the released branch ensures you are using the latest files for that release. @@ -509,17 +512,17 @@ - Another three variables of interest are the + Three other variables of interest are the BB_NUMBER_THREADS, PARALLEL_MAKE, and BB_NUMBER_PARSE_THREADS variables. - By default, these variables are optimally set based on the - number of processor cores your build host uses. - Although it is possible to override these variables, the - default values the OpenEmbedded build system derives provide you - with parallelism during the build. + By default, the OpenEmbedded build system sets these variables + based on the number of processor cores your build host uses. + Thus, you typically do not need to uncomment these variables in + your local.conf file to gain optimal build + times. @@ -533,39 +536,54 @@ section in the Yocto Project Reference Manual. - - Continue with the following command to build an OS image for the target, which is - core-image-sato in this example. - For information on the -k option use the - bitbake --help command, see the - "BitBake" - section in the Yocto Project Reference Manual, or see the - "BitBake Command" - section in the BitBake User Manual. - + + Continue with the following command to build an OS image for the + target, which is core-image-sato in this + example. + For information on the -k option use the + bitbake --help command, see the + "BitBake" + section in the Yocto Project Reference Manual, or see the + "BitBake Command" + section in the BitBake User Manual. + For information on other targets, see the + "Images" + chapter in the Yocto Project Reference Manual. + $ bitbake -k core-image-sato - - - BitBake requires Python 2.6 or 2.7. For more information on - this requirement, see the - "Required Git, tar, and Python" - section in the Yocto Project Reference Manual. - - The final command runs the image using the QEMU emulator: - + + + BitBake requires Python 2.6 or 2.7. For more information on + this requirement, see the + "Required Git, tar, and Python" + section in the Yocto Project Reference Manual. + + The final command runs the image using the QEMU emulator: + $ runqemu qemux86 - - - - Depending on the number of processors and cores, the amount - of RAM, the speed of your Internet connection and other - factors, the build process could take several hours the - first time you run it. - Subsequent builds run much faster since parts of the build - are cached. - - - + + + + Depending on the number of processors and cores, the amount + of RAM, the speed of your Internet connection and other + factors, the build process could take several hours the + first time you run it. + Subsequent builds run much faster since parts of the build + are cached. + + + If you want to learn more about running QEMU, see the + "Using the Quick EMUlator (QEMU)" + chapter in the Yocto Project Development Manual. + + + + For information on how to use a pre-built binary, continue reading + into the next section. + Otherwise, you might be interested in reading the early chapters + of the + Yocto Project Development Manual. +
@@ -821,6 +839,13 @@
+ + + For more detailed information on using the Yocto Project for + image and application develop, the best place to continue reading is + in the + Yocto Project Development Manual. +