mirror of
https://git.yoctoproject.org/poky
synced 2026-03-04 06:19:40 +01:00
4b95ba2341
The string used for the link anchor for the "What You Need and How You Get It" section in the YP QS used "resources". This string is actually used as the chapter id for the resources chapter in the YP ref manual. I changed the string in the QS from "resources" to "yp-resourses" to make it unique. There was one instance in the YP ref manual where a cross-reference to the section occurred. I fixed that as well. (From yocto-docs rev: 58c1e4e327cb489e037bbde170c4c495f4567392) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
141 lines
7.1 KiB
XML
141 lines
7.1 KiB
XML
<!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; ] >
|
|
|
|
<chapter id='intro'>
|
|
<title>Introduction</title>
|
|
|
|
<section id='intro-welcome'>
|
|
<title>Introduction</title>
|
|
|
|
<para>
|
|
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.
|
|
Amongst other things, the Yocto Project uses the OpenEmbedded build system, which
|
|
is based on the Poky project, to construct complete Linux images.
|
|
You can find complete introductory and getting started information on the Yocto Project
|
|
by reading the
|
|
<ulink url='&YOCTO_DOCS_QS_URL;'>
|
|
Yocto Project Quick Start</ulink>.
|
|
For task-based information using the Yocto Project, see
|
|
<ulink url='&YOCTO_DOCS_DEV_URL;'>
|
|
The Yocto Project Development Manual</ulink>.
|
|
You can also find lots of information on the Yocto Project on the
|
|
<ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>.
|
|
</para>
|
|
</section>
|
|
|
|
<section id='intro-manualoverview'>
|
|
<title>Documentation Overview</title>
|
|
<para>
|
|
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>
|
|
<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>
|
|
<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>
|
|
<link linkend='ref-structure'>Directory Structure</link>:</emphasis>
|
|
This chapter describes the
|
|
<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.
|
|
</para></listitem>
|
|
<listitem><para><emphasis>
|
|
<link linkend='ref-bitbake'>BitBake</link>:</emphasis>
|
|
This chapter provides an overview of the BitBake tool and its role within
|
|
the Yocto Project.</para></listitem>
|
|
<listitem><para><emphasis>
|
|
<link linkend='ref-classes'>Classes</link>:</emphasis>
|
|
This chapter describes the classes used in the Yocto Project.</para></listitem>
|
|
<listitem><para><emphasis>
|
|
<link linkend='ref-images'>Images</link>:</emphasis>
|
|
This chapter describes the standard images that the Yocto Project supports.
|
|
</para></listitem>
|
|
<listitem><para><emphasis>
|
|
<link linkend='ref-features'>Features</link>:</emphasis>
|
|
This chapter describes mechanisms for creating distribution, machine, and image
|
|
features during the build process using the OpenEmbedded build system.</para></listitem>
|
|
<listitem><para><emphasis>
|
|
<link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis>
|
|
This chapter presents most variables used by the OpenEmbedded build system, which
|
|
using BitBake.
|
|
Entries describe the function of the variable and how to apply them.
|
|
</para></listitem>
|
|
<listitem><para><emphasis>
|
|
<link linkend='ref-varlocality'>Variable Context</link>:</emphasis>
|
|
This chapter provides variable locality or context.</para></listitem>
|
|
<listitem><para><emphasis>
|
|
<link linkend='faq'>FAQ</link>:</emphasis>
|
|
This chapter provides answers for commonly asked questions in the Yocto Project
|
|
development environment.</para></listitem>
|
|
<listitem><para><emphasis>
|
|
<link linkend='resources'>Contributing to the Yocto Project</link>:</emphasis>
|
|
This chapter provides guidance on how you can contribute back to the Yocto
|
|
Project.</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
|
|
<section id='intro-requirements'>
|
|
<title>System Requirements</title>
|
|
<para>
|
|
For Yocto Project system requirements, see the
|
|
<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>
|
|
What You Need and How You Get It</ulink> section in the Yocto Project Quick Start.
|
|
</para>
|
|
</section>
|
|
|
|
<section id='intro-getit'>
|
|
<title>Obtaining the Yocto Project</title>
|
|
<para>
|
|
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
|
|
<ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem>
|
|
<listitem><para><emphasis>Nightly Builds:</emphasis> These releases are available at
|
|
<ulink url='http://autobuilder.yoctoproject.org/nightly'/>.
|
|
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
|
|
<ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>.
|
|
Along with these downloads, you can find lots of other information at this site.
|
|
</para></listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</section>
|
|
|
|
<section id='intro-getit-dev'>
|
|
<title>Development Checkouts</title>
|
|
<para>
|
|
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,
|
|
or by cloning a copy of the upstream
|
|
<ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository.
|
|
For information on both these methods, see the
|
|
"<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Setup</ulink>"
|
|
section in The Yocto Project Development Manual.
|
|
</para>
|
|
</section>
|
|
|
|
</chapter>
|
|
<!--
|
|
vim: expandtab tw=80 ts=4
|
|
-->
|