mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 17:39:31 +00:00
Code Issues Projects Releases Wiki Activity

yocto-project-qs: Updates to add more explanations and navigation

Browse Source 
Added some changes based on input from a new user.  Basically,
added a bit more explanation in a few spots and some suggestions
on where to read or go next after concluding the two basic
quick-use sections.

(From yocto-docs rev: 5381f1202957e171d16d97332b40e8d363828a20)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark
2015-03-03 09:17:47 -08:00
committed by Richard Purdie
parent 8951db67fd
commit 86f4cf8faf
1 changed files with 77 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/yocto-project-qs/yocto-project-qs.xml
+77 -52
View File
@@ -369,22 +369,24 @@
<title>A Quick Test Run</title> <title>A Quick Test Run</title>
<para> <para>
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: This section presents some steps that let you do the following:
</para> <itemizedlist>
<listitem><para>
<itemizedlist>
<listitem>
<para>
Build an image and run it in the QEMU emulator. Build an image and run it in the QEMU emulator.
</para> </para></listitem>
</listitem> <listitem><para>
<listitem>
<para>
Use a pre-built image and run it in the QEMU emulator. Use a pre-built image and run it in the QEMU emulator.
</para> </para></listitem>
</listitem> </itemizedlist>
</itemizedlist> <note>
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
<ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project manual set</ulink>.
</note>
</para>
<section id='building-image'> <section id='building-image'>
<title>Building an Image</title> <title>Building an Image</title>
@@ -463,8 +465,9 @@
a local repository named <filename>poky</filename> that is a a local repository named <filename>poky</filename> that is a
clone of the upstream Yocto Project clone of the upstream Yocto Project
<filename>poky</filename> repository.</para></listitem> <filename>poky</filename> repository.</para></listitem>
<listitem><para>The third command checks out a local branch and <listitem><para>The third command checks out the current
names it <filename>&DISTRO_NAME;</filename>. Yocto Project release into a local branch whose name matches
the release (i.e. <filename>&DISTRO_NAME;</filename>).
The local branch tracks the upstream branch of the same name. The local branch tracks the upstream branch of the same name.
Creating your own branch based on the released branch ensures Creating your own branch based on the released branch ensures
you are using the latest files for that release. you are using the latest files for that release.
@@ -509,17 +512,17 @@
</para> </para>
<para> <para>
Another three variables of interest are the Three other variables of interest are the
<ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>, <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>,
<ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>, <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink>,
and and
<ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink>
variables. variables.
By default, these variables are optimally set based on the By default, the OpenEmbedded build system sets these variables
number of processor cores your build host uses. based on the number of processor cores your build host uses.
Although it is possible to override these variables, the Thus, you typically do not need to uncomment these variables in
default values the OpenEmbedded build system derives provide you your <filename>local.conf</filename> file to gain optimal build
with parallelism during the build. times.
</para> </para>
<para> <para>
@@ -533,39 +536,54 @@
section in the Yocto Project Reference Manual. section in the Yocto Project Reference Manual.
</para> </para>
<para> <para>
Continue with the following command to build an OS image for the target, which is Continue with the following command to build an OS image for the
<filename>core-image-sato</filename> in this example. target, which is <filename>core-image-sato</filename> in this
For information on the <filename>-k</filename> option use the example.
<filename>bitbake --help</filename> command, see the For information on the <filename>-k</filename> option use the
"<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" <filename>bitbake --help</filename> command, see the
section in the Yocto Project Reference Manual, or see the "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>"
"<ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual-command'>BitBake Command</ulink>" section in the Yocto Project Reference Manual, or see the
section in the BitBake User Manual. "<ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual-command'>BitBake Command</ulink>"
<literallayout class='monospaced'> section in the BitBake User Manual.
For information on other targets, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>"
chapter in the Yocto Project Reference Manual.
<literallayout class='monospaced'>
$ bitbake -k core-image-sato $ bitbake -k core-image-sato
</literallayout> </literallayout>
<note> <note>
BitBake requires Python 2.6 or 2.7. For more information on BitBake requires Python 2.6 or 2.7. For more information on
this requirement, see the this requirement, see the
"<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python</ulink>" "<ulink url='&YOCTO_DOCS_REF_URL;#required-git-tar-and-python-versions'>Required Git, tar, and Python</ulink>"
section in the Yocto Project Reference Manual. section in the Yocto Project Reference Manual.
</note> </note>
The final command runs the image using the QEMU emulator: The final command runs the image using the QEMU emulator:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ runqemu qemux86 $ runqemu qemux86
</literallayout> </literallayout>
<note> <note>
<para> <para>
Depending on the number of processors and cores, the amount Depending on the number of processors and cores, the amount
of RAM, the speed of your Internet connection and other of RAM, the speed of your Internet connection and other
factors, the build process could take several hours the factors, the build process could take several hours the
first time you run it. first time you run it.
Subsequent builds run much faster since parts of the build Subsequent builds run much faster since parts of the build
are cached. are cached.
</para> </para>
</note> </note>
</para> If you want to learn more about running QEMU, see the
"<ulink url="&YOCTO_DOCS_DEV_URL;#dev-manual-qemu">Using the Quick EMUlator (QEMU)</ulink>"
chapter in the Yocto Project Development Manual.
</para>
<para>
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
<ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>.
</para>
</section> </section>
<section id='using-pre-built'> <section id='using-pre-built'>
@@ -821,6 +839,13 @@
</para> </para>
</section> </section>
</section> </section>
<para>
For more detailed information on using the Yocto Project for
image and application develop, the best place to continue reading is
in the
<ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink>.
</para>
</section> </section>
<section id='super-user'> <section id='super-user'>