2008-02-26 11:31:34 +00:00
|
|
|
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
2012-03-09 23:38:00 +00:00
|
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
|
|
|
|
[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] >
|
2008-02-26 11:31:34 +00:00
|
|
|
|
|
|
|
<chapter id='intro'>
|
|
|
|
<title>Introduction</title>
|
|
|
|
|
2010-10-15 14:14:06 +00:00
|
|
|
<section id='intro-welcome'>
|
2011-08-18 16:38:15 +00:00
|
|
|
<title>Introduction</title>
|
2008-02-26 11:31:34 +00:00
|
|
|
|
|
|
|
<para>
|
2011-08-18 16:38:15 +00:00
|
|
|
This manual provides reference information for the current release of the Yocto Project.
|
|
|
|
The Yocto Project is an open-source collaboration project focused on embedded Linux
|
|
|
|
developers.
|
2012-07-02 21:34:39 +00:00
|
|
|
Amongst other things, the Yocto Project uses the OpenEmbedded build system, which
|
|
|
|
is based on the Poky project, to construct complete Linux images.
|
2011-08-18 16:38:15 +00:00
|
|
|
You can find complete introductory and getting started information on the Yocto Project
|
|
|
|
by reading the
|
2012-03-09 23:38:00 +00:00
|
|
|
<ulink url='&YOCTO_DOCS_QS_URL;'>
|
2011-08-18 16:38:15 +00:00
|
|
|
Yocto Project Quick Start</ulink>.
|
2011-12-08 21:02:50 +00:00
|
|
|
For task-based information using the Yocto Project, see
|
2012-03-09 23:38:00 +00:00
|
|
|
<ulink url='&YOCTO_DOCS_DEV_URL;'>
|
2011-12-08 21:02:50 +00:00
|
|
|
The Yocto Project Development Manual</ulink>.
|
2011-08-18 16:38:15 +00:00
|
|
|
You can also find lots of information on the Yocto Project on the
|
2012-03-09 23:38:00 +00:00
|
|
|
<ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
2010-10-15 14:14:06 +00:00
|
|
|
</section>
|
2008-02-26 11:31:34 +00:00
|
|
|
|
2011-08-18 16:38:15 +00:00
|
|
|
<section id='intro-manualoverview'>
|
|
|
|
<title>Documentation Overview</title>
|
2008-02-26 11:31:34 +00:00
|
|
|
<para>
|
2011-08-18 16:38:15 +00:00
|
|
|
This reference manual consists of the following:
|
|
|
|
<itemizedlist>
|
|
|
|
<listitem><para><emphasis>
|
|
|
|
<link linkend='usingpoky'>Using the Yocto Project</link>:</emphasis> This chapter
|
|
|
|
provides an overview of the components that make up the Yocto Project
|
|
|
|
followed by information about debugging images created in the Yocto Project.
|
|
|
|
</para></listitem>
|
2011-12-08 20:52:21 +00:00
|
|
|
<listitem><para><emphasis>
|
|
|
|
<link linkend='technical-details'>Technical Details</link>:</emphasis>
|
|
|
|
This chapter describes fundamental Yocto Project components as well as an explanation
|
|
|
|
behind how the Yocto Project uses shared state (sstate) cache to speed build time.
|
|
|
|
</para></listitem>
|
2011-08-18 16:38:15 +00:00
|
|
|
<listitem><para><emphasis>
|
|
|
|
<link linkend='bsp'>Board Support Packages (BSP) - Developer's Guide</link>:</emphasis>
|
|
|
|
This chapter describes the example filesystem layout for BSP development and
|
|
|
|
the click-through licensing scheme.</para></listitem>
|
|
|
|
<listitem><para><emphasis>
|
2012-07-16 17:10:27 +00:00
|
|
|
<link linkend='ref-structure'>Directory Structure</link>:</emphasis>
|
|
|
|
This chapter describes the
|
2012-07-13 18:28:34 +00:00
|
|
|
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> created
|
|
|
|
either by unpacking a released Yocto Project tarball on your host development system,
|
|
|
|
or by cloning the upstream
|
|
|
|
<ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
|
2011-08-18 16:38:15 +00:00
|
|
|
</para></listitem>
|
|
|
|
<listitem><para><emphasis>
|
2012-07-16 17:19:15 +00:00
|
|
|
<link linkend='ref-bitbake'>BitBake</link>:</emphasis>
|
|
|
|
This chapter provides an overview of the BitBake tool and its role within
|
2011-08-18 16:38:15 +00:00
|
|
|
the Yocto Project.</para></listitem>
|
|
|
|
<listitem><para><emphasis>
|
2012-07-16 17:31:19 +00:00
|
|
|
<link linkend='ref-classes'>Classes</link>:</emphasis>
|
|
|
|
This chapter describes the classes used in the Yocto Project.</para></listitem>
|
2011-08-18 16:38:15 +00:00
|
|
|
<listitem><para><emphasis>
|
2012-07-16 17:53:16 +00:00
|
|
|
<link linkend='ref-images'>Images</link>:</emphasis>
|
|
|
|
This chapter describes the standard images that the Yocto Project supports.
|
2011-08-18 16:38:15 +00:00
|
|
|
</para></listitem>
|
|
|
|
<listitem><para><emphasis>
|
2012-07-16 17:53:16 +00:00
|
|
|
<link linkend='ref-features'>Features</link>:</emphasis>
|
|
|
|
This chapter describes mechanisms for creating distribution, machine, and image
|
2012-07-02 21:34:39 +00:00
|
|
|
features during the build process using the OpenEmbedded build system.</para></listitem>
|
2011-08-18 16:38:15 +00:00
|
|
|
<listitem><para><emphasis>
|
2012-07-16 18:02:19 +00:00
|
|
|
<link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis>
|
|
|
|
This chapter presents most variables used by the OpenEmbedded build system, which
|
2012-07-13 18:28:34 +00:00
|
|
|
using BitBake.
|
2011-08-18 16:38:15 +00:00
|
|
|
Entries describe the function of the variable and how to apply them.
|
|
|
|
</para></listitem>
|
|
|
|
<listitem><para><emphasis>
|
2012-07-16 18:08:02 +00:00
|
|
|
<link linkend='ref-varlocality'>Variable Context</link>:</emphasis>
|
|
|
|
This chapter provides variable locality or context.</para></listitem>
|
2011-08-18 16:38:15 +00:00
|
|
|
<listitem><para><emphasis>
|
2012-07-16 18:12:26 +00:00
|
|
|
<link linkend='faq'>FAQ</link>:</emphasis>
|
|
|
|
This chapter provides answers for commonly asked questions in the Yocto Project
|
2011-08-18 16:38:15 +00:00
|
|
|
development environment.</para></listitem>
|
|
|
|
<listitem><para><emphasis>
|
2012-07-16 18:20:29 +00:00
|
|
|
<link linkend='resources'>Contributing to the Yocto Project</link>:</emphasis>
|
|
|
|
This chapter provides guidance on how you can contribute back to the Yocto
|
2011-08-18 16:38:15 +00:00
|
|
|
Project.</para></listitem>
|
|
|
|
</itemizedlist>
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
2011-08-18 16:38:15 +00:00
|
|
|
</section>
|
2008-02-26 11:31:34 +00:00
|
|
|
|
2008-02-28 16:10:56 +00:00
|
|
|
|
2011-08-18 16:38:15 +00:00
|
|
|
<section id='intro-requirements'>
|
|
|
|
<title>System Requirements</title>
|
2008-02-26 11:31:34 +00:00
|
|
|
<para>
|
2011-11-09 15:58:24 +00:00
|
|
|
For Yocto Project system requirements, see the
|
2012-07-17 15:15:16 +00:00
|
|
|
<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>
|
2012-03-09 23:38:00 +00:00
|
|
|
What You Need and How You Get It</ulink> section in the Yocto Project Quick Start.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
|
2011-08-18 16:38:15 +00:00
|
|
|
<section id='intro-getit'>
|
|
|
|
<title>Obtaining the Yocto Project</title>
|
2008-02-26 11:31:34 +00:00
|
|
|
<para>
|
2011-08-18 16:38:15 +00:00
|
|
|
The Yocto Project development team makes the Yocto Project available through a number
|
|
|
|
of methods:
|
|
|
|
<itemizedlist>
|
|
|
|
<listitem><para><emphasis>Releases:</emphasis> Stable, tested releases are available through
|
2012-03-09 23:38:00 +00:00
|
|
|
<ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem>
|
2011-08-18 16:38:15 +00:00
|
|
|
<listitem><para><emphasis>Nightly Builds:</emphasis> These releases are available at
|
2011-10-05 12:26:52 +00:00
|
|
|
<ulink url='http://autobuilder.yoctoproject.org/nightly'/>.
|
2011-08-18 16:38:15 +00:00
|
|
|
These builds include Yocto Project releases, meta-toolchain tarballs, and
|
|
|
|
experimental builds.</para></listitem>
|
|
|
|
<listitem><para><emphasis>Yocto Project Website:</emphasis> You can find releases
|
|
|
|
of the Yocto Project and supported BSPs at the
|
2012-03-09 23:38:00 +00:00
|
|
|
<ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>.
|
2011-08-18 16:38:15 +00:00
|
|
|
Along with these downloads, you can find lots of other information at this site.
|
|
|
|
</para></listitem>
|
|
|
|
</itemizedlist>
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
|
2011-08-18 16:38:15 +00:00
|
|
|
<section id='intro-getit-dev'>
|
|
|
|
<title>Development Checkouts</title>
|
2008-02-26 11:31:34 +00:00
|
|
|
<para>
|
2012-07-13 18:28:34 +00:00
|
|
|
Development using the Yocto Project requires a local
|
|
|
|
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
|
|
|
|
You can set up the source directory by downloading a Yocto Project release tarball and unpacking it,
|
2012-07-02 21:34:39 +00:00
|
|
|
or by cloning a copy of the upstream
|
|
|
|
<ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
|
2012-02-06 21:29:08 +00:00
|
|
|
For information on both these methods, see the
|
2012-03-09 23:38:00 +00:00
|
|
|
"<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Setup</ulink>"
|
2012-02-06 21:29:08 +00:00
|
|
|
section in The Yocto Project Development Manual.
|
2008-02-26 11:31:34 +00:00
|
|
|
</para>
|
|
|
|
</section>
|
|
|
|
|
|
|
|
</chapter>
|
|
|
|
<!--
|
|
|
|
vim: expandtab tw=80 ts=4
|
|
|
|
-->
|