Documentation: yocto-project-qs - Removed all trailing whitespace.
(From yocto-docs rev: 36376c49df34856b33bf8f4180ff6960f3280b48) 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
Richard Purdie
parent
73ffb8298b
commit
0b18e1dbc9
|
|
@ -1,5 +1,5 @@
|
|||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
||||
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
||||
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
|
||||
|
||||
<article id='intro'>
|
||||
|
|
@ -13,7 +13,7 @@
|
|||
<section id='welcome'>
|
||||
<title>Welcome!</title>
|
||||
<para>
|
||||
Welcome to the Yocto Project!
|
||||
Welcome to the Yocto Project!
|
||||
The Yocto Project is an open-source collaboration project focused on embedded Linux
|
||||
developers.
|
||||
Among other things, the Yocto Project uses a build system based on the Poky project
|
||||
|
|
@ -22,27 +22,27 @@
|
|||
</para>
|
||||
|
||||
<para>
|
||||
If you don't have a system that runs Linux and you want to give the Yocto Project a test run,
|
||||
If you don't have a system that runs Linux and you want to give the Yocto Project a test run,
|
||||
you might consider using the Yocto Project Build Appliance.
|
||||
The Build Appliance allows you to build and boot a custom embedded Linux image with the Yocto
|
||||
Project using a non-Linux development system.
|
||||
See the <ulink url='http://www.yoctoproject.org/documentation/build-appliance'>Yocto
|
||||
The Build Appliance allows you to build and boot a custom embedded Linux image with the Yocto
|
||||
Project using a non-Linux development system.
|
||||
See the <ulink url='http://www.yoctoproject.org/documentation/build-appliance'>Yocto
|
||||
Project Build Appliance</ulink> for more information.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
On the other hand, if you know all about open-source development, Linux development environments,
|
||||
On the other hand, if you know all about open-source development, Linux development environments,
|
||||
Git source repositories and the like and you just want some quick information that lets you try out
|
||||
the Yocto Project on your Linux system, skip right to the
|
||||
the Yocto Project on your Linux system, skip right to the
|
||||
"<link linkend='super-user'>Super User</link>" section at the end of this quick start.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For the rest of you, this short document will give you some basic information about the environment and
|
||||
let you experience it in its simplest form.
|
||||
For the rest of you, this short document will give you some basic information about the environment and
|
||||
let you experience it in its simplest form.
|
||||
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.
|
||||
This document steps you through a simple example showing you how to build a small image
|
||||
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
|
||||
and run it using the Quick EMUlator (QEMU emulator).
|
||||
</para>
|
||||
|
||||
|
|
@ -50,24 +50,24 @@
|
|||
For more detailed information on the Yocto Project, you should check out these resources:
|
||||
<itemizedlist>
|
||||
<listitem><para><emphasis>Website:</emphasis> The <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>
|
||||
provides the latest builds, breaking news, full development documentation, and a rich Yocto
|
||||
provides the latest builds, breaking news, full development documentation, and a rich Yocto
|
||||
Project Development Community into which you can tap.
|
||||
</para></listitem>
|
||||
<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
|
||||
a wiki, and the
|
||||
"<ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink>" chapter in
|
||||
You can find two FAQs: <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>Yocto Project FAQ</ulink> on
|
||||
a wiki, and the
|
||||
"<ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink>" chapter in
|
||||
the Yocto Project Reference Manual.
|
||||
</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
|
||||
Developer Screencast Tutorial</ulink> provides a 30-minute video for the user
|
||||
Developer Screencast Tutorial</ulink> provides a 30-minute video for the user
|
||||
new to the Yocto Project but familiar with Linux build systems.</para></listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
<note>
|
||||
Due to production processes, there could be differences between the Yocto Project
|
||||
documentation bundled in a released tarball and the
|
||||
documentation bundled in a released tarball and the
|
||||
<ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink> on
|
||||
the <ulink url='&YOCTO_HOME_URL;'>Yocto Project</ulink> website.
|
||||
For the latest version of this manual, see the manual on the website.
|
||||
|
|
@ -77,8 +77,8 @@
|
|||
<section id='yp-intro'>
|
||||
<title>Introducing the Yocto Project Development Environment</title>
|
||||
<para>
|
||||
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
|
||||
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
|
||||
platforms including x86-64 and emulated ones.
|
||||
You can use components from the Yocto Project to design, develop, build, debug, simulate,
|
||||
and test the complete software stack using Linux, the X Window System, GNOME Mobile-based
|
||||
|
|
@ -87,7 +87,7 @@
|
|||
|
||||
<mediaobject>
|
||||
<imageobject>
|
||||
<imagedata fileref="figures/yocto-environment.png"
|
||||
<imagedata fileref="figures/yocto-environment.png"
|
||||
format="PNG" align='center' scalefit='1' width="100%"/>
|
||||
</imageobject>
|
||||
<caption>
|
||||
|
|
@ -111,7 +111,7 @@
|
|||
frameworks, these components need not be installed.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>Creates a focused and stable core compatible with the OpenEmbedded
|
||||
<para>Creates a focused and stable core compatible with the OpenEmbedded
|
||||
project with which you can easily and reliably build and develop.</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
|
|
@ -121,20 +121,20 @@
|
|||
</itemizedlist>
|
||||
|
||||
<para>
|
||||
The Yocto Project can generate images for many kinds of devices.
|
||||
The Yocto Project can generate images for many kinds of devices.
|
||||
However, the standard example machines target QEMU full-system emulation for x86, x86-64, ARM, MIPS,
|
||||
and PPC-based architectures as well as specific hardware such as the
|
||||
<trademark class='registered'>Intel</trademark> Desktop Board DH55TC.
|
||||
Because an image developed with the Yocto Project can boot inside a QEMU emulator, the
|
||||
and PPC-based architectures as well as specific hardware such as the
|
||||
<trademark class='registered'>Intel</trademark> Desktop Board DH55TC.
|
||||
Because an image developed with the Yocto Project can boot inside a QEMU emulator, the
|
||||
development environment works nicely as a test platform for developing embedded software.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Another important Yocto Project feature is the Sato reference User Interface.
|
||||
Another important Yocto Project feature is the Sato reference User Interface.
|
||||
This optional GNOME mobile-based UI, which is intended for devices with
|
||||
restricted screen sizes, sits neatly on top of a device using the
|
||||
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
|
||||
restricted screen sizes, sits neatly on top of a device using the
|
||||
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
|
||||
their own user interface on top of a Linux image created with the Yocto Project.
|
||||
</para>
|
||||
</section>
|
||||
|
|
@ -150,7 +150,7 @@
|
|||
<listitem>
|
||||
<para>A host system running a supported Linux distribution (i.e. recent releases of
|
||||
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
|
||||
significantly.
|
||||
</para>
|
||||
|
|
@ -167,9 +167,9 @@
|
|||
<title>The Linux Distribution</title>
|
||||
|
||||
<para>
|
||||
The Yocto Project team is continually verifying more and more Linux
|
||||
The Yocto Project team is continually verifying more and more Linux
|
||||
distributions with each release.
|
||||
In general, if you have the current release minus one of the following
|
||||
In general, if you have the current release minus one of the following
|
||||
distributions you should have no problems.
|
||||
<itemizedlist>
|
||||
<listitem><para>Ubuntu</para></listitem>
|
||||
|
|
@ -177,8 +177,8 @@
|
|||
<listitem><para>openSUSE</para></listitem>
|
||||
<listitem><para>CentOS</para></listitem>
|
||||
</itemizedlist>
|
||||
For a more detailed list of distributions that support the Yocto Project,
|
||||
see the
|
||||
For a more detailed list of distributions that support the Yocto Project,
|
||||
see the
|
||||
"<ulink url='&YOCTO_DOCS_REF_URL;#detailed-supported-distros'>Supported Linux Distributions</ulink>" section
|
||||
in the Yocto Project Reference Manual.
|
||||
<note>
|
||||
|
|
@ -190,15 +190,15 @@
|
|||
<para>
|
||||
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.
|
||||
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.
|
||||
</para>
|
||||
<note><para>
|
||||
If you attempt to use a distribution not in the above list, you may or may not have success - you
|
||||
If you attempt to use a distribution not in the above list, you may or may not have success - you
|
||||
are venturing into untested territory.
|
||||
Refer to
|
||||
<ulink url='&OE_HOME_URL;/index.php?title=OEandYourDistro'>OE and Your Distro</ulink> and
|
||||
<ulink url='&OE_HOME_URL;/index.php?title=Required_software'>Required Software</ulink>
|
||||
Refer to
|
||||
<ulink url='&OE_HOME_URL;/index.php?title=OEandYourDistro'>OE and Your Distro</ulink> and
|
||||
<ulink url='&OE_HOME_URL;/index.php?title=Required_software'>Required Software</ulink>
|
||||
for information for other distributions used with the OpenEmbedded project, which might be
|
||||
a starting point for exploration.
|
||||
If you go down this path, you should expect problems.
|
||||
|
|
@ -213,18 +213,18 @@
|
|||
|
||||
<para>
|
||||
Packages and package installation vary depending on your development system
|
||||
and on your intent.
|
||||
and on your intent.
|
||||
For example, if you want to build an image that can run
|
||||
on QEMU in graphical mode (a minimal, basic build
|
||||
requirement), then the number of packages is different than if you want to
|
||||
build an image on a headless system or build out the Yocto Project
|
||||
documentation set.
|
||||
documentation set.
|
||||
Collectively, the number of required packages is large
|
||||
if you want to be able to cover all cases.
|
||||
<note>In general, you need to have root access and then install the
|
||||
<note>In general, you need to have root access and then install the
|
||||
required packages.
|
||||
Thus, the commands in the following section may or may not work
|
||||
depending on whether or not your Linux distribution has
|
||||
Thus, the commands in the following section may or may not work
|
||||
depending on whether or not your Linux distribution has
|
||||
<filename>sudo</filename> installed.</note>
|
||||
</para>
|
||||
|
||||
|
|
@ -234,9 +234,9 @@
|
|||
(e.g. essential plus graphics support).
|
||||
</para>
|
||||
|
||||
<para>
|
||||
For lists of required packages for other scenarios, see the
|
||||
"<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
|
||||
<para>
|
||||
For lists of required packages for other scenarios, see the
|
||||
"<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
|
||||
section in the Yocto Project Reference Manual.
|
||||
</para>
|
||||
|
||||
|
|
@ -244,7 +244,7 @@
|
|||
<title>Ubuntu</title>
|
||||
|
||||
<para>
|
||||
The essential packages you need for a supported Ubuntu distribution
|
||||
The essential packages you need for a supported Ubuntu distribution
|
||||
are shown in the following command:
|
||||
<literallayout class='monospaced'>
|
||||
$ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; libsdl1.2-dev xterm
|
||||
|
|
@ -256,7 +256,7 @@
|
|||
<title>Fedora</title>
|
||||
|
||||
<para>
|
||||
The essential packages you need for a supported Fedora distribution
|
||||
The essential packages you need for a supported Fedora distribution
|
||||
are shown in the following command:
|
||||
<literallayout class='monospaced'>
|
||||
$ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
|
||||
|
|
@ -268,7 +268,7 @@
|
|||
<title>openSUSE</title>
|
||||
|
||||
<para>
|
||||
The essential packages you need for a supported openSUSE
|
||||
The essential packages you need for a supported openSUSE
|
||||
distribution are shown in the following command:
|
||||
<literallayout class='monospaced'>
|
||||
$ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; libSDL-devel xterm
|
||||
|
|
@ -280,14 +280,14 @@
|
|||
<title>CentOS</title>
|
||||
|
||||
<para>
|
||||
The essential packages you need for a supported CentOS
|
||||
The essential packages you need for a supported CentOS
|
||||
distribution are shown in the following command:
|
||||
<literallayout class='monospaced'>
|
||||
$ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL; SDL-devel xterm
|
||||
</literallayout>
|
||||
<note>Depending on the CentOS version you are using, other requirements
|
||||
and dependencies might exist.
|
||||
For details, you should look at the CentOS sections on the
|
||||
<note>Depending on the CentOS version you are using, other requirements
|
||||
and dependencies might exist.
|
||||
For details, you should look at the CentOS sections on the
|
||||
<ulink url='https://wiki.yoctoproject.org/wiki/Poky/GettingStarted/Dependencies'>Poky/GettingStarted/Dependencies</ulink>
|
||||
wiki page.</note>
|
||||
</para>
|
||||
|
|
@ -296,26 +296,26 @@
|
|||
|
||||
<section id='releases'>
|
||||
<title>Yocto Project Release</title>
|
||||
|
||||
|
||||
<para>
|
||||
You can download the latest Yocto Project release by going to the
|
||||
You can download the latest Yocto Project release by going to the
|
||||
<ulink url="&YOCTO_HOME_URL;/download">Yocto Project Download page</ulink>.
|
||||
Just go to the page and click the "Yocto Downloads" link found in the "Download"
|
||||
navigation pane to the right to view all available Yocto Project releases.
|
||||
Then, click the "Yocto Release" link for the release you want from the list to
|
||||
begin the download.
|
||||
navigation pane to the right to view all available Yocto Project releases.
|
||||
Then, click the "Yocto Release" link for the release you want from the list to
|
||||
begin the download.
|
||||
Nightly and developmental builds are also maintained at
|
||||
<ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>.
|
||||
<ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>.
|
||||
However, for this document a released version of Yocto Project is used.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You can also get the Yocto Project files you need by setting up (cloning in Git terms)
|
||||
a local copy of the <filename>poky</filename> Git repository on your host development
|
||||
system.
|
||||
a local copy of the <filename>poky</filename> Git repository on your host development
|
||||
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
|
||||
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto
|
||||
For information on how to get set up using this method, see the
|
||||
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto
|
||||
Project Release</ulink>" item in the Yocto Project Development Manual.
|
||||
</para>
|
||||
</section>
|
||||
|
|
@ -325,7 +325,7 @@
|
|||
<title>A Quick Test Run</title>
|
||||
|
||||
<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:
|
||||
</para>
|
||||
|
||||
|
|
@ -340,9 +340,9 @@
|
|||
|
||||
<section id='building-image'>
|
||||
<title>Building an Image</title>
|
||||
|
||||
|
||||
<para>
|
||||
In the development environment you will need to build an image whenever you change hardware
|
||||
In the development environment you will need to build an image whenever you change hardware
|
||||
support, add or change system libraries, or add or change services that have dependencies.
|
||||
</para>
|
||||
|
||||
|
|
@ -356,21 +356,21 @@
|
|||
</mediaobject>
|
||||
|
||||
<para>
|
||||
Use the following commands to build your image.
|
||||
The OpenEmbedded build process creates an entire Linux distribution, including the toolchain,
|
||||
Use the following commands to build your image.
|
||||
The OpenEmbedded build process creates an entire Linux distribution, including the toolchain,
|
||||
from source.
|
||||
</para>
|
||||
|
||||
<note><para>
|
||||
The build process using Sato currently consumes 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.
|
||||
</para></note>
|
||||
|
||||
<note><para>
|
||||
By default, the build process searches for source code using a pre-determined order
|
||||
through a set of locations.
|
||||
If you encounter problems with the build process finding and downloading source code, see the
|
||||
If you encounter problems with the build process finding and downloading source code, see the
|
||||
"<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?</ulink>" in the Yocto Project Reference Manual.
|
||||
</para></note>
|
||||
|
|
@ -399,11 +399,11 @@
|
|||
<listitem><para>In the previous example, the first command retrieves the Yocto Project
|
||||
release tarball from the source repositories using the
|
||||
<filename>wget</filename> command.
|
||||
Alternatively, you can go to the
|
||||
Alternatively, you can go to the
|
||||
<ulink url='&YOCTO_HOME_URL;/download'>Yocto Project website's Downloads page</ulink>
|
||||
to retrieve the tarball.</para></listitem>
|
||||
<listitem><para>The second command extracts the files from the tarball and places
|
||||
them into a directory named <filename>&YOCTO_POKY;</filename> in the current
|
||||
<listitem><para>The second command extracts the files from the tarball and places
|
||||
them into a directory named <filename>&YOCTO_POKY;</filename> in the current
|
||||
directory.</para></listitem>
|
||||
<listitem><para>The third and fourth commands change the working directory to the
|
||||
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
|
||||
|
|
@ -411,67 +411,67 @@
|
|||
<ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'>environment setup script</ulink>.
|
||||
Running this script defines OpenEmbedded build environment settings needed to
|
||||
complete the build.
|
||||
The script also creates the
|
||||
The script also creates the
|
||||
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>,
|
||||
which is <filename>build</filename> in this case and is located in the
|
||||
which is <filename>build</filename> in this case and is located in the
|
||||
Source Directory.
|
||||
After the script runs, your current working directory is set
|
||||
After the script runs, your current working directory is set
|
||||
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
|
||||
created during the build.
|
||||
</para></listitem>
|
||||
</itemizedlist>
|
||||
<para>
|
||||
Take some time to examine your <filename>local.conf</filename> file
|
||||
Take some time to examine your <filename>local.conf</filename> file
|
||||
in your project's configuration directory, which is found in the Build Directory.
|
||||
The defaults in that file should work fine.
|
||||
However, there are some variables of interest at which you might look.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
By default, the target architecture for the build is <filename>qemux86</filename>,
|
||||
<para>
|
||||
By default, the target architecture for the build is <filename>qemux86</filename>,
|
||||
which produces an image that can be used in the QEMU emulator and is targeted at an
|
||||
<trademark class='registered'>Intel</trademark> 32-bit based architecture.
|
||||
To change this default, edit the value of the <filename>MACHINE</filename> variable
|
||||
To change this default, edit the value of the <filename>MACHINE</filename> variable
|
||||
in the configuration file before launching the build.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Another couple of variables of interest are the
|
||||
<ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the
|
||||
Another couple of variables of interest are the
|
||||
<ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink> and the
|
||||
<ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> variables.
|
||||
By default, these variables are commented out.
|
||||
By default, these variables are commented out.
|
||||
However, if you have a multi-core CPU you might want to uncomment
|
||||
the lines and set both variables equal to twice the number of your
|
||||
the lines and set both variables equal to twice the number of your
|
||||
host's processor cores.
|
||||
Setting these variables can significantly shorten your build time.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Another consideration before you build is the package manager used when creating
|
||||
the image.
|
||||
Another consideration before you build is the package manager used when creating
|
||||
the image.
|
||||
By default, the OpenEmbedded build system uses the RPM package manager.
|
||||
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.
|
||||
For additional package manager selection information, see
|
||||
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>"
|
||||
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.
|
||||
For additional package manager selection information, see
|
||||
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-package'>Packaging - <filename>package*.bbclass</filename></ulink>"
|
||||
in the Yocto Project Reference Manual.
|
||||
</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 target, which is
|
||||
<filename>core-image-sato</filename> in this example.
|
||||
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
|
||||
"<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.
|
||||
<literallayout class='monospaced'>
|
||||
$ bitbake -k core-image-sato
|
||||
</literallayout>
|
||||
<note><para>
|
||||
BitBake requires Python 2.6 or 2.7. For more information on this requirement,
|
||||
see the
|
||||
<ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> in the Yocto Project Reference
|
||||
BitBake requires Python 2.6 or 2.7. For more information on this requirement,
|
||||
see the
|
||||
<ulink url='&YOCTO_DOCS_REF_URL;#faq'>FAQ</ulink> in the Yocto Project Reference
|
||||
Manual.
|
||||
</para></note>
|
||||
The final command runs the image:
|
||||
|
|
@ -489,10 +489,10 @@
|
|||
|
||||
<section id='using-pre-built'>
|
||||
<title>Using Pre-Built Binaries and QEMU</title>
|
||||
|
||||
|
||||
<para>
|
||||
If hardware, libraries and services are stable, you can get started by using a pre-built binary
|
||||
of the filesystem image, kernel, and toolchain and run it using the QEMU emulator.
|
||||
If hardware, libraries and services are stable, you can get started by using a pre-built binary
|
||||
of the filesystem image, kernel, and toolchain and run it using the QEMU emulator.
|
||||
This scenario is useful for developing application software.
|
||||
</para>
|
||||
|
||||
|
|
@ -511,8 +511,8 @@
|
|||
|
||||
<itemizedlist>
|
||||
<listitem><para>Install the appropriate stand-alone toolchain tarball.</para></listitem>
|
||||
<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 machine’s
|
||||
<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 machine’s
|
||||
architecture (e.g. x86, ARM, etc.).</para></listitem>
|
||||
<listitem><para>Download the filesystem image for your target machine's architecture.
|
||||
</para></listitem>
|
||||
|
|
@ -523,15 +523,15 @@
|
|||
<section id='installing-the-toolchain'>
|
||||
<title>Installing the Toolchain</title>
|
||||
<para>
|
||||
You can download a tarball installer, which includes the pre-built toolchain, the
|
||||
<filename>runqemu</filename>
|
||||
You can download a tarball installer, which includes the pre-built toolchain, the
|
||||
<filename>runqemu</filename>
|
||||
script, and support files from the appropriate directory under
|
||||
<ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>.
|
||||
Toolchains are available for 32-bit and 64-bit development systems from the
|
||||
<filename>i686</filename> and <filename>x86-64</filename> directories, respectively.
|
||||
<ulink url='&YOCTO_TOOLCHAIN_DL_URL;'></ulink>.
|
||||
Toolchains are available for 32-bit and 64-bit development systems from the
|
||||
<filename>i686</filename> and <filename>x86-64</filename> directories, respectively.
|
||||
Each type of development system supports five target architectures.
|
||||
The names of the tarball installer scripts are such that a string representing the
|
||||
host system appears first in the filename and then is immediately followed by a
|
||||
The names of the tarball installer scripts are such that a string representing the
|
||||
host system appears first in the filename and then is immediately followed by a
|
||||
string representing the target architecture.
|
||||
</para>
|
||||
|
||||
|
|
@ -539,17 +539,17 @@
|
|||
poky-eglibc-<<emphasis>host_system</emphasis>>-<<emphasis>arch</emphasis>>-toolchain-gmae-<<emphasis>release</emphasis>>.sh
|
||||
|
||||
Where:
|
||||
<<emphasis>host_system</emphasis>> is a string representing your development system:
|
||||
<<emphasis>host_system</emphasis>> is a string representing your development system:
|
||||
i686 or x86_64.
|
||||
|
||||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||||
|
||||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||||
i586, x86_64, powerpc, mips, or arm.
|
||||
|
||||
|
||||
<<emphasis>release</emphasis>> is the version of Yocto Project.
|
||||
</literallayout>
|
||||
|
||||
<para>
|
||||
For example, the following toolchain installer is for a 64-bit development
|
||||
<para>
|
||||
For example, the following toolchain installer is for a 64-bit development
|
||||
host system and a 32-bit target architecture:
|
||||
</para>
|
||||
|
||||
|
|
@ -563,17 +563,17 @@
|
|||
</para>
|
||||
|
||||
<para>
|
||||
The following command shows how to run the installer given a toolchain tarball
|
||||
The following command shows how to run the installer given a toolchain tarball
|
||||
for a 64-bit development host system and a 32-bit target architecture.
|
||||
You must change the permissions on the toolchain
|
||||
You must change the permissions on the toolchain
|
||||
installer script so that it is executable.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The example assumes the toolchain installer is located in <filename>~/Downloads/</filename>.
|
||||
<note>
|
||||
If you do not have write permissions for the directory into which you are installing
|
||||
the toolchain, the toolchain installer notifies you and exits.
|
||||
If you do not have write permissions for the directory into which you are installing
|
||||
the toolchain, the toolchain installer notifies you and exits.
|
||||
Be sure you have write permissions in the directory and run the installer again.
|
||||
</note>
|
||||
</para>
|
||||
|
|
@ -585,39 +585,39 @@
|
|||
</para>
|
||||
|
||||
<para>
|
||||
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
|
||||
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-the-toolchain-from-within-the-build-tree'>Using BitBake and the Build Directory</ulink>" sections in the Yocto Project Application Developer's Guide.
|
||||
</para>
|
||||
</section>
|
||||
|
||||
<section id='downloading-the-pre-built-linux-kernel'>
|
||||
<title>Downloading the Pre-Built Linux Kernel</title>
|
||||
|
||||
|
||||
<para>
|
||||
You can download the pre-built Linux kernel suitable for running in the QEMU emulator from
|
||||
You can download the pre-built Linux kernel suitable for running in the QEMU emulator from
|
||||
<ulink url='&YOCTO_QEMU_DL_URL;'></ulink>.
|
||||
Be sure to use the kernel that matches the architecture you want to simulate.
|
||||
Download areas exist for the five supported machine architectures:
|
||||
<filename>qemuarm</filename>, <filename>qemumips</filename>, <filename>qemuppc</filename>,
|
||||
<filename>qemux86</filename>, and <filename>qemux86-64</filename>.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
|
||||
<para>
|
||||
Most kernel files have one of the following forms:
|
||||
<literallayout class='monospaced'>
|
||||
*zImage-qemu<<emphasis>arch</emphasis>>.bin
|
||||
vmlinux-qemu<<emphasis>arch</emphasis>>.bin
|
||||
|
||||
Where:
|
||||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||||
x86, x86-64, ppc, mips, or arm.
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
You can learn more about downloading a Yocto Project kernel in the
|
||||
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Yocto Project Kernel</ulink>"
|
||||
You can learn more about downloading a Yocto Project kernel in the
|
||||
"<ulink url='&YOCTO_DOCS_DEV_URL;#local-kernel-files'>Yocto Project Kernel</ulink>"
|
||||
bulleted item in the Yocto Project Development Manual.
|
||||
</para>
|
||||
</section>
|
||||
|
|
@ -628,14 +628,14 @@
|
|||
<para>
|
||||
You can also download the filesystem image suitable for your target architecture from
|
||||
<ulink url='&YOCTO_QEMU_DL_URL;'></ulink>.
|
||||
Again, be sure to use the filesystem that matches the architecture you want
|
||||
Again, be sure to use the filesystem that matches the architecture you want
|
||||
to simulate.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The filesystem image has two tarball forms: <filename>ext3</filename> and
|
||||
The filesystem image has two tarball forms: <filename>ext3</filename> and
|
||||
<filename>tar</filename>.
|
||||
You must use the <filename>ext3</filename> form when booting an image using the
|
||||
You must use the <filename>ext3</filename> form when booting an image using the
|
||||
QEMU emulator.
|
||||
The <filename>tar</filename> form can be flattened out in your host development system
|
||||
and used for build purposes with the Yocto Project.
|
||||
|
|
@ -650,7 +650,7 @@
|
|||
"<ulink url='&YOCTO_DOCS_REF_URL;#ref-images'>Images</ulink>" chapter
|
||||
in the Yocto Project Reference Manual.
|
||||
|
||||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||||
x86, x86-64, ppc, mips, or arm.
|
||||
</literallayout>
|
||||
</para>
|
||||
|
|
@ -658,15 +658,15 @@
|
|||
|
||||
<section id='setting-up-the-environment-and-starting-the-qemu-emulator'>
|
||||
<title>Setting Up the Environment and Starting the QEMU Emulator</title>
|
||||
|
||||
|
||||
<para>
|
||||
Before you start the QEMU emulator, you need to set up the emulation environment.
|
||||
The following command form sets up the emulation environment.
|
||||
<literallayout class='monospaced'>
|
||||
$ source &YOCTO_ADTPATH_DIR;/environment-setup-<<emphasis>arch</emphasis>>-poky-linux-<<emphasis>if</emphasis>>
|
||||
$ source &YOCTO_ADTPATH_DIR;/environment-setup-<<emphasis>arch</emphasis>>-poky-linux-<<emphasis>if</emphasis>>
|
||||
|
||||
Where:
|
||||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||||
<<emphasis>arch</emphasis>> is a string representing the target architecture:
|
||||
i586, x86_64, ppc603e, mips, or armv5te.
|
||||
|
||||
<<emphasis>if</emphasis>> is a string representing an embedded application binary interface.
|
||||
|
|
@ -675,12 +675,12 @@
|
|||
</para>
|
||||
|
||||
<para>
|
||||
Finally, this command form invokes the QEMU emulator
|
||||
Finally, this command form invokes the QEMU emulator
|
||||
<literallayout class='monospaced'>
|
||||
$ runqemu <<emphasis>qemuarch</emphasis>> <<emphasis>kernel-image</emphasis>> <<emphasis>filesystem-image</emphasis>>
|
||||
|
||||
Where:
|
||||
<<emphasis>qemuarch</emphasis>> is a string representing the target architecture: qemux86, qemux86-64,
|
||||
<<emphasis>qemuarch</emphasis>> is a string representing the target architecture: qemux86, qemux86-64,
|
||||
qemuppc, qemumips, or qemuarm.
|
||||
|
||||
<<emphasis>kernel-image</emphasis>> is the architecture-specific kernel image.
|
||||
|
|
@ -691,50 +691,50 @@
|
|||
</para>
|
||||
|
||||
<para>
|
||||
Continuing with the example, the following two commands setup the emulation
|
||||
Continuing with the example, the following two commands setup the emulation
|
||||
environment and launch QEMU.
|
||||
This example assumes the root filesystem (<filename>.ext3</filename> file) and
|
||||
the pre-built kernel image file both reside in your home directory.
|
||||
This example assumes the root filesystem (<filename>.ext3</filename> file) and
|
||||
the pre-built kernel image file both reside in your home directory.
|
||||
The kernel and filesystem are for a 32-bit target architecture.
|
||||
<literallayout class='monospaced'>
|
||||
$ cd $HOME
|
||||
$ source &YOCTO_ADTPATH_DIR;/environment-setup-i586-poky-linux
|
||||
$ source &YOCTO_ADTPATH_DIR;/environment-setup-i586-poky-linux
|
||||
$ runqemu qemux86 bzImage-qemux86.bin \
|
||||
core-image-sato-qemux86.ext3
|
||||
</literallayout>
|
||||
</para>
|
||||
|
||||
<para>
|
||||
The environment in which QEMU launches varies depending on the filesystem image and on the
|
||||
target architecture.
|
||||
For example, if you source the environment for the ARM target
|
||||
architecture and then boot the minimal QEMU image, the emulator comes up in a new
|
||||
shell in command-line mode.
|
||||
The environment in which QEMU launches varies depending on the filesystem image and on the
|
||||
target architecture.
|
||||
For example, if you source the environment for the ARM target
|
||||
architecture and then boot the minimal QEMU image, the emulator comes up in a new
|
||||
shell in command-line mode.
|
||||
However, if you boot the SDK image, QEMU comes up with a GUI.
|
||||
<note>Booting the PPC image results in QEMU launching in the same shell in
|
||||
<note>Booting the PPC image results in QEMU launching in the same shell in
|
||||
command-line mode.</note>
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
<section id='super-user'>
|
||||
<title>Super User
|
||||
<title>Super User
|
||||
</title>
|
||||
|
||||
<para>
|
||||
This section
|
||||
This section
|
||||
<footnote>
|
||||
<para>
|
||||
Kudos and thanks to Robert P. J. Day of
|
||||
Kudos and thanks to Robert P. J. Day of
|
||||
<ulink url='http://www.crashcourse.ca'>CrashCourse</ulink> for providing the basis
|
||||
for this "expert" section with information from one of his
|
||||
<ulink url='http://www.crashcourse.ca/wiki/index.php/Yocto_Project_Quick_Start'>wiki</ulink>
|
||||
pages.
|
||||
</para>
|
||||
</footnote>
|
||||
gives you a minimal description of how to use the Yocto Project to build images
|
||||
for a BeagleBoard xM starting from scratch.
|
||||
gives you a minimal description of how to use the Yocto Project to build images
|
||||
for a BeagleBoard xM starting from scratch.
|
||||
The steps were performed on a 64-bit Ubuntu 10.04 system.
|
||||
</para>
|
||||
|
||||
|
|
@ -745,7 +745,7 @@
|
|||
Set up your <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>
|
||||
one of two ways:
|
||||
<itemizedlist>
|
||||
<listitem><para><emphasis>Tarball:</emphasis>
|
||||
<listitem><para><emphasis>Tarball:</emphasis>
|
||||
Use if you want the latest stable release:
|
||||
<literallayout class='monospaced'>
|
||||
$ wget &YOCTO_RELEASE_DL_URL;/&YOCTO_POKY_TARBALL;
|
||||
|
|
@ -765,7 +765,7 @@
|
|||
<title>Setting Up Your Host</title>
|
||||
|
||||
<para>
|
||||
You need some packages for everything to work.
|
||||
You need some packages for everything to work.
|
||||
Rather than duplicate them here, look at the "<link linkend='packages'>The Packages</link>"
|
||||
section earlier in this quick start.
|
||||
</para>
|
||||
|
|
@ -776,14 +776,14 @@
|
|||
|
||||
<para>
|
||||
From the parent directory your
|
||||
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
|
||||
initialize your environment and provide a meaningful
|
||||
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>,
|
||||
initialize your environment and provide a meaningful
|
||||
<ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
|
||||
name:
|
||||
<literallayout class='monospaced'>
|
||||
$ source poky/&OE_INIT_FILE; mybuilds
|
||||
</literallayout>
|
||||
At this point, the <filename>mybuilds</filename> directory has been created for you
|
||||
At this point, the <filename>mybuilds</filename> directory has been created for you
|
||||
and it is now your current working directory.
|
||||
If you don't provide your own directory name it defaults to <filename>build</filename>,
|
||||
which is inside the Source Directory.
|
||||
|
|
@ -804,20 +804,20 @@
|
|||
PARALLEL_MAKE = "-j 8"
|
||||
MACHINE ?= "beagleboard"
|
||||
</literallayout>
|
||||
Briefly, set <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>
|
||||
Briefly, set <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></ulink>
|
||||
and <ulink url='&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></ulink> to
|
||||
twice your host processor's number of cores.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
A good deal that goes into a Yocto Project build is simply downloading all of the source
|
||||
tarballs.
|
||||
Maybe you have been working with another build system (OpenEmbedded or Angstrom) for which
|
||||
A good deal that goes into a Yocto Project build is simply downloading all of the source
|
||||
tarballs.
|
||||
Maybe you have been working with another build system (OpenEmbedded or Angstrom) for which
|
||||
you've built up a sizable directory of source tarballs.
|
||||
Or perhaps someone else has such a directory for which you have read access.
|
||||
Or perhaps someone else has such a directory for which you have read access.
|
||||
If so, you can save time by adding the <filename>PREMIRRORS</filename>
|
||||
statement to your configuration file so that the build process checks
|
||||
local directories first for existing tarballs before checking the
|
||||
local directories first for existing tarballs before checking the
|
||||
Internet.
|
||||
Here is an efficient way to set it up in your <filename>local.conf</filename>
|
||||
file:
|
||||
|
|
@ -850,7 +850,7 @@
|
|||
<literallayout class='monospaced'>
|
||||
$ bitbake -c fetchall core-image-minimal
|
||||
</literallayout>
|
||||
This variation guarantees that you have all the sources for that BitBake target
|
||||
This variation guarantees that you have all the sources for that BitBake target
|
||||
should you disconnect from the net and want to do the build later offline.
|
||||
</para></listitem>
|
||||
<listitem><para>Specify to continue the build even if BitBake encounters an error.
|
||||
|
|
|
|||
Loading…
Reference in New Issue