documentation/yocto-project-qs/yocto-project-qs.xml: Scrub and edit

I did a scrub for the term "Yocto" and substituted appropriately.
This resulted in the term "Yocto Project build system" going away and
being replaced by "OpenEmbedded build system."  The "Yocto Project
build directory" was replaced by "build directory."  I also found a few
little things that were wrong like including the Debian distro in the
list of supported distros so I removed that.  Finally, a spell check
produced a couple of fixes.

(From yocto-docs rev: 6957658982516aa4b0e4726c9344c46854aa11d3)

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 2012-07-05 13:46:10 -07:00 committed by Richard Purdie
parent e92e0c904d
commit 9a4191fd72
1 changed files with 47 additions and 49 deletions

View File

@ -3,7 +3,7 @@
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
<article id='intro'> <article id='intro'>
<imagedata fileref="figures/yocto-project-transp.png" width="6in" depth="1in" align="right" scale="25" /> <imagedata fileref="figures/yocto-project-trans.png" width="6in" depth="1in" align="right" scale="25" />
<section id='fake-title'> <section id='fake-title'>
<title>The Yocto Project Quick Start</title> <title>The Yocto Project Quick Start</title>
@ -16,8 +16,9 @@
Welcome to the Yocto Project! Welcome to the Yocto Project!
The Yocto Project is an open-source collaboration project focused on embedded Linux The Yocto Project is an open-source collaboration project focused on embedded Linux
developers. developers.
Amongst other things, the Yocto Project uses the Poky build system to Among other things, the Yocto Project uses a build system based on the Poky project
construct complete Linux images. to construct complete Linux images.
The Poky project, in turn, draws from and contributes back to the OpenEmbedded project.
</para> </para>
<para> <para>
@ -42,7 +43,7 @@
After reading this document, you will have a basic understanding of what the Yocto Project is After reading this document, you will have a basic understanding of what the Yocto Project is
and how to use some of its core components. and how to use some of its core components.
This document steps you through a simple example showing you how to build a small image This document steps you through a simple example showing you how to build a small image
and run it using the QEMU emulator. and run it using the Quick EMUlator (QEMU emulator).
</para> </para>
<para> <para>
@ -55,8 +56,8 @@
<listitem><para><emphasis>FAQs:</emphasis> Lists commonly asked Yocto Project questions and answers. <listitem><para><emphasis>FAQs:</emphasis> Lists commonly asked Yocto Project questions and answers.
You can find two FAQs: <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>Yocto Project FAQ</ulink> on You can find two FAQs: <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>Yocto Project FAQ</ulink> on
a wiki, and the a wiki, and the
<ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> appendix in the <ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> appendix in
The Yocto Project Reference Manual. the Yocto Project Reference Manual.
</para></listitem> </para></listitem>
<listitem><para><emphasis>Developer Screencast:</emphasis> The <listitem><para><emphasis>Developer Screencast:</emphasis> The
<ulink url='http://vimeo.com/36450321'>Getting Started with the Yocto Project - New <ulink url='http://vimeo.com/36450321'>Getting Started with the Yocto Project - New
@ -66,9 +67,8 @@
</para> </para>
<note> <note>
Due to production processes, there could be differences between the Yocto Project Due to production processes, there could be differences between the Yocto Project
documentation bundled in the release tarball and the documentation bundled in a released tarball and the
<ulink url='&YOCTO_DOCS_QS_URL;'> <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink> on
Yocto Project Quick Start</ulink> on
the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website. the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website.
For the latest version of this manual, see the manual on the website. For the latest version of this manual, see the manual on the website.
</note> </note>
@ -77,7 +77,7 @@
<section id='yp-intro'> <section id='yp-intro'>
<title>Introducing the Yocto Project Development Environment</title> <title>Introducing the Yocto Project Development Environment</title>
<para> <para>
The Yocto Project through the Poky build system provides an open source development The Yocto Project through the OpenEmbedded build system provides an open source development
environment targeting the ARM, MIPS, PowerPC and x86 architectures for a variety of environment targeting the ARM, MIPS, PowerPC and x86 architectures for a variety of
platforms including x86-64 and emulated ones. platforms including x86-64 and emulated ones.
You can use components from the Yocto Project to design, develop, build, debug, simulate, You can use components from the Yocto Project to design, develop, build, debug, simulate,
@ -85,9 +85,6 @@
application frameworks, and Qt frameworks. application frameworks, and Qt frameworks.
</para> </para>
<para></para>
<para></para>
<mediaobject> <mediaobject>
<imageobject> <imageobject>
<imagedata fileref="figures/yocto-environment.png" <imagedata fileref="figures/yocto-environment.png"
@ -138,7 +135,7 @@
restricted screen sizes, sits neatly on top of a device using the restricted screen sizes, sits neatly on top of a device using the
GNOME Mobile Stack and provides a well-defined user experience. GNOME Mobile Stack and provides a well-defined user experience.
Implemented in its own layer, it makes it clear to developers how they can implement Implemented in its own layer, it makes it clear to developers how they can implement
their own user interface on top of Yocto Linux. their own user interface on top of a Linux image created with the Yocto Project.
</para> </para>
</section> </section>
@ -152,7 +149,7 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>A host system running a supported Linux distribution (i.e. recent releases of <para>A host system running a supported Linux distribution (i.e. recent releases of
Fedora, openSUSE, CentOS, Debian, and Ubuntu). Fedora, openSUSE, CentOS, and Ubuntu).
If the host system supports multiple cores and threads, you can configure the If the host system supports multiple cores and threads, you can configure the
Yocto Project build system to decrease the time needed to build images Yocto Project build system to decrease the time needed to build images
significantly. significantly.
@ -162,7 +159,7 @@
<para>The right packages.</para> <para>The right packages.</para>
</listitem> </listitem>
<listitem> <listitem>
<para>A release of Yocto Project.</para> <para>A release of the Yocto Project.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -190,7 +187,7 @@
</note> </note>
</para> </para>
<para> <para>
The build system should be able to run on any modern distribution with Python 2.6 or 2.7. The OpenEmbedded build system should be able to run on any modern distribution with Python 2.6 or 2.7.
Earlier releases of Python are known to not work and the system does not support Python 3 at this time. Earlier releases of Python are known to not work and the system does not support Python 3 at this time.
This document assumes you are running one of the previously noted distributions on your Linux-based This document assumes you are running one of the previously noted distributions on your Linux-based
host systems. host systems.
@ -232,7 +229,7 @@
unzip texi2html texinfo libsdl1.2-dev docbook-utils fop gawk \ unzip texi2html texinfo libsdl1.2-dev docbook-utils fop gawk \
python-pysqlite2 diffstat make gcc build-essential xsltproc \ python-pysqlite2 diffstat make gcc build-essential xsltproc \
g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev \ g++ desktop-file-utils chrpath libgl1-mesa-dev libglu1-mesa-dev \
autoconf automake groff libtool xterm libxml-parser-perl autoconf automake groff libtool xterm libxml-parser-perl dblatex
</literallayout> </literallayout>
</section> </section>
@ -253,7 +250,7 @@
groff linuxdoc-tools patch cmake \ groff linuxdoc-tools patch cmake \
perl-ExtUtils-MakeMaker tcl-devel gettext chrpath ncurses apr \ perl-ExtUtils-MakeMaker tcl-devel gettext chrpath ncurses apr \
SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \ SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \
autoconf automake libtool xterm autoconf automake libtool xterm dblatex
</literallayout> </literallayout>
</section> </section>
@ -269,7 +266,7 @@
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ sudo zypper install python gcc gcc-c++ libtool fop \ $ sudo zypper install python gcc gcc-c++ libtool fop \
subversion git chrpath automake make wget xsltproc \ subversion git chrpath automake make wget xsltproc \
diffstat texinfo freeglut-devel libSDL-devel diffstat texinfo freeglut-devel libSDL-devel dblatex
</literallayout> </literallayout>
</section> </section>
@ -291,7 +288,7 @@
groff linuxdoc-tools patch cmake \ groff linuxdoc-tools patch cmake \
tcl-devel gettext ncurses apr \ tcl-devel gettext ncurses apr \
SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \ SDL-devel mesa-libGL-devel mesa-libGLU-devel gnome-doc-utils \
autoconf automake libtool xterm autoconf automake libtool xterm dblatex
</literallayout> </literallayout>
<note><para> <note><para>
Depending on the CentOS version you are using, other requirements and dependencies Depending on the CentOS version you are using, other requirements and dependencies
@ -320,12 +317,13 @@
</para> </para>
<para> <para>
You can also get the Yocto Project files by setting up a Git repository on your host You can also get the Yocto Project files you need by setting up (cloning in Git terms)
development system. a local copy of the <filename>poky</filename> Git repository on your host development
Doing so allows you to contribute back to the project. system.
Doing so allows you to contribute back to the Yocto Project project.
For information on how to get set up using this method, see the For information on how to get set up using this method, see the
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto
Project Release</ulink>" item in The Yocto Project Development Manual. Project Release</ulink>" item in the Yocto Project Development Manual.
</para> </para>
</section> </section>
</section> </section>
@ -366,24 +364,22 @@
<para> <para>
Use the following commands to build your image. Use the following commands to build your image.
The build process creates an entire Linux distribution, including the toolchain, from source. The OpenEmbedded build process creates an entire Linux distribution, including the toolchain,
from source.
</para> </para>
<note><para> <note><para>
The build process using Sato currently consumes The build process using Sato currently consumes about 50GB of disk space.
about 50GB of disk space.
To allow for variations in the build process and for future package expansion, we To allow for variations in the build process and for future package expansion, we
recommend having at least 100GB of free disk space. recommend having at least 100GB of free disk space.
</para></note> </para></note>
<note><para> <note><para>
By default, the Yocto Project searches for source code using a pre-determined order By default, the build process searches for source code using a pre-determined order
through a set of locations. through a set of locations.
If you encounter problems with the Yocto Project finding and downloading source code, see If you encounter problems with the build process finding and downloading source code, see the
the FAQ entry "How does the Yocto Project build system obtain source code and will it work behind my "<ulink url='&YOCTO_DOCS_REF_URL;#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>How does the OpenEmbedded build system obtain source code and will it work behind my
firewall or proxy server?" in firewall or proxy server?</ulink>" in the Yocto Project Reference Manual.
<ulink url='&YOCTO_DOCS_REF_URL;#faq'>
The Yocto Project Reference Manual</ulink>.
</para></note> </para></note>
<para> <para>
@ -416,10 +412,11 @@
them into a directory named <filename>&YOCTO_POKY;</filename> in the current them into a directory named <filename>&YOCTO_POKY;</filename> in the current
directory.</para></listitem> directory.</para></listitem>
<listitem><para>The third command runs the Yocto Project environment setup script. <listitem><para>The third command runs the Yocto Project environment setup script.
Running this script defines Yocto Project build environment settings needed to Running this script defines OpenEmbedded build environment settings needed to
complete the build. complete the build.
The script also creates the Yocto Project The script also creates the
build directory, which is <filename>&YOCTO_POKY;-build</filename> in this case. <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>",
which is <filename>&YOCTO_POKY;-build</filename> in this case.
After the script runs, your current working directory is set After the script runs, your current working directory is set
to the build directory. to the build directory.
Later, when the build completes, the build directory contains all the files Later, when the build completes, the build directory contains all the files
@ -455,12 +452,12 @@
<para> <para>
Another consideration before you build is the package manager used when creating Another consideration before you build is the package manager used when creating
the image. the image.
By default, the Yocto Project build system uses the RPM package manager. By default, the OpenEmbedded build system uses the RPM package manager.
You can control this configuration by using the You can control this configuration by using the
<filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable. <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink></filename> variable.
For additional package manager selection information, see For additional package manager selection information, see
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>" "<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>"
in The Yocto Project Reference Manual. in the Yocto Project Reference Manual.
</para> </para>
<para> <para>
@ -469,14 +466,14 @@
For information on the <filename>-k</filename> option use the For information on the <filename>-k</filename> option use the
<filename>bitbake --help</filename> command or see the <filename>bitbake --help</filename> command or see the
"<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" section in "<ulink url='&YOCTO_DOCS_REF_URL;#usingpoky-components-bitbake'>BitBake</ulink>" section in
The Yocto Project Reference Manual. the Yocto Project Reference Manual.
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ bitbake -k core-image-sato $ bitbake -k core-image-sato
</literallayout> </literallayout>
<note><para> <note><para>
BitBake requires Python 2.6 or 2.7. For more information on this requirement, BitBake requires Python 2.6 or 2.7. For more information on this requirement,
see the see the
<ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> in The Yocto Project Reference <ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> in the Yocto Project Reference
Manual. Manual.
</para></note> </para></note>
The final command runs the image: The final command runs the image:
@ -515,7 +512,7 @@
</para> </para>
<itemizedlist> <itemizedlist>
<listitem><para>Install the appropriate stand-alone Yocto toolchain tarball.</para></listitem> <listitem><para>Install the appropriate stand-alone toolchain tarball.</para></listitem>
<listitem><para>Download the pre-built image that will boot with QEMU. <listitem><para>Download the pre-built image that will boot with QEMU.
You need to be sure to get the QEMU image that matches your target machines You need to be sure to get the QEMU image that matches your target machines
architecture (e.g. x86, ARM, etc.).</para></listitem> architecture (e.g. x86, ARM, etc.).</para></listitem>
@ -528,13 +525,14 @@
<section id='installing-the-toolchain'> <section id='installing-the-toolchain'>
<title>Installing the Toolchain</title> <title>Installing the Toolchain</title>
<para> <para>
You can download the pre-built toolchain, which includes the <filename>runqemu</filename> You can download a tarball with the pre-built toolchain, which includes the
<filename>runqemu</filename>
script and support files, from the appropriate directory under script and support files, from the appropriate directory under
<ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>. <ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>.
Toolchains are available for 32-bit and 64-bit development systems from the Toolchains are available for 32-bit and 64-bit development systems from the
<filename>i686</filename> and <filename>x86-64</filename> directories, respectively. <filename>i686</filename> and <filename>x86-64</filename> directories, respectively.
Each type of development system supports five target architectures. Each type of development system supports five target architectures.
The tarball files are named such that a string representing the host system appears The names of the tarballs are such that a string representing the host system appears
first in the filename and then is immediately followed by a string representing first in the filename and then is immediately followed by a string representing
the target architecture. the target architecture.
</para> </para>
@ -578,7 +576,7 @@
<para> <para>
For more information on how to install tarballs, see the For more information on how to install tarballs, see the
"<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and "<ulink url='&YOCTO_DOCS_ADT_URL;#using-an-existing-toolchain-tarball'>Using a Cross-Toolchain Tarball</ulink>" and
"<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in The Yocto Project Application Development Toolkit (ADT) "<ulink url='&YOCTO_DOCS_ADT_URL;#using-the-toolchain-from-within-the-build-tree'>Using BitBake and the Yocto Project Build Tree</ulink>" sections in the Yocto Project Application Development Toolkit (ADT)
User's Guide. User's Guide.
</para> </para>
</section> </section>
@ -610,7 +608,7 @@
<para> <para>
You can learn more about downloading a Yocto Project kernel in the You can learn more about downloading a Yocto Project kernel in the
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>" section of "<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Linux Yocto Kernel</ulink>" section of
The Yocto Project Development Manual. the Yocto Project Development Manual.
</para> </para>
</section> </section>
@ -733,7 +731,7 @@
<title>Getting the Yocto Project</title> <title>Getting the Yocto Project</title>
<para> <para>
Get the <ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-files'>Yocto Project Files</ulink> Set up your <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
one of two ways: one of two ways:
<itemizedlist> <itemizedlist>
<listitem><para><emphasis>Tarball:</emphasis> <listitem><para><emphasis>Tarball:</emphasis>
@ -766,9 +764,9 @@
<title>Initializing the Build Environment</title> <title>Initializing the Build Environment</title>
<para> <para>
From the parent directory of the Yocto Project Files, initialize your environment From the parent directory of local source directory, initialize your environment
and provide a meaningful and provide a meaningful
<ulink url='&YOCTO_DOCS_DEV_URL;#yocto-project-build-directory'>Yocto Project Build Directory</ulink> <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>build directory</ulink>
name: name:
<literallayout class='monospaced'> <literallayout class='monospaced'>
$ source poky/oe-init-build-env mybuilds $ source poky/oe-init-build-env mybuilds