<!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 the
        <ulink url='&YOCTO_DOCS_DEV_URL;'>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='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 general 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.
        The remainder of this section provides details on system requirements
        not covered in the Yocto Project Quick Start.
    </para>

    <section id='detailed-supported-distros'>
    <title>Supported Linux Distributions</title>

        <para>
            TBD - a list of very specific distros and versions. 
            The list will be kept up-to-date via a script provided that can 
            be run prior to a release. 
            The scripts output will yield the list and it can be copied 
            into this section.
        </para>
    </section>

    <section id='required-packages-for-the-host-development-system'>
    <title>Required Packages for the Host Development System</title>

        <para>
            The list of packages you need on the host development system can 
            be large when covering all build scenarios using the Yocto Project. 
            This section provides required packages by Linux distribution and 
            further categorized by function.
        </para>

        <section id='ubuntu-packages'>
            <title>Ubuntu</title>

            <para>
                The following list shows the required packages by function
                given a supported Ubuntu Linux distribution:
                <itemizedlist>
                    <listitem><para><emphasis>Essentials:</emphasis>
                        Packages needed to build an image on a headless 
                        system:
                        <literallayout class='monospaced'>
     $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL;
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>Graphical Extras:</emphasis>
                        Packages recommended if the host system has graphics support:
                        <literallayout class='monospaced'>
     $ sudo apt-get install libsdl1.2-dev xterm
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>Documentation:</emphasis>
                        Packages needed if you are going to build out the 
                        Yocto Project documentation manuals:
                        <literallayout class='monospaced'>
     $ sudo apt-get install make xsltproc docbook-utils fop
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>ADT Installer Extras:</emphasis>
                        Packages needed if you are going to be using the 
                        <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
                        <literallayout class='monospaced'>
     $ sudo apt-get install autoconf automake libtool libglib2.0-dev
                        </literallayout></para></listitem>
                </itemizedlist>
            </para>
        </section>

        <section id='fedora-packages'>
            <title>Fedora Packages</title>

            <para>
                The following list shows the required packages by function
                given a supported Fedora Linux distribution:
                <itemizedlist>
                    <listitem><para><emphasis>Essentials:</emphasis>
                        Packages needed to build an image for a headless 
                        system:
                        <literallayout class='monospaced'>
     $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL;
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>Graphical Extras:</emphasis>
                        Packages recommended if the host system has graphics support:
                        <literallayout class='monospaced'>
     $ sudo yum install SDL-devel xterm
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>Documentation:</emphasis>
                        Packages needed if you are going to build out the 
                        Yocto Project documentation manuals:
                        <literallayout class='monospaced'>
     $ sudo yum install make docbook-style-dsssl docbook-style-xsl \
     docbook-dtds docbook-utils fop libxslt
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>ADT Installer Extras:</emphasis>
                        Packages needed if you are going to be using the 
                        <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
                        <literallayout class='monospaced'>
     $ sudo yum install autoconf automake libtool glib2-devel
                        </literallayout></para></listitem>
                </itemizedlist>
            </para>
        </section>

        <section id='opensuse-packages'>
            <title>OpenSUSE Packages</title>

            <para>
                The following list shows the required packages by function
                given a supported OpenSUSE Linux distribution:
                <itemizedlist>
                    <listitem><para><emphasis>Essentials:</emphasis>
                        Packages needed to build an image for a headless 
                        system:
                        <literallayout class='monospaced'>
     $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>Graphical Extras:</emphasis>
                        Packages recommended if the host system has graphics support:
                        <literallayout class='monospaced'>
     $ sudo zypper install libSDL-devel xterm
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>Documentation:</emphasis>
                        Packages needed if you are going to build out the 
                        Yocto Project documentation manuals:
                        <literallayout class='monospaced'>
     $ sudo zypper install make fop xsltproc
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>ADT Installer Extras:</emphasis>
                        Packages needed if you are going to be using the 
                        <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
                        <literallayout class='monospaced'>
     $ sudo zypper install autoconf automake libtool glib2-devel
                        </literallayout></para></listitem>
                </itemizedlist>
            </para>
        </section>

        <section id='centos-packages'>
            <title>CentOS Packages</title>

            <para>
                The following list shows the required packages by function
                given a supported CentOS Linux distribution:
                <itemizedlist>
                    <listitem><para><emphasis>Essentials:</emphasis>
                        Packages needed to build an image for a headless 
                        system:
                        <literallayout class='monospaced'>
     $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL;
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>Graphical Extras:</emphasis>
                        Packages recommended if the host system has graphics support:
                        <literallayout class='monospaced'>
     $ sudo yum -y install SDL-devel xterm
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>Documentation:</emphasis>
                        Packages needed if you are going to build out the 
                        Yocto Project documentation manuals:
                        <literallayout class='monospaced'>
     $ sudo yum -y install make docbook-style-dsssl docbook-style-xsl \
     docbook-dtds docbook-utils fop libxslt
                        </literallayout></para></listitem>
                    <listitem><para><emphasis>ADT Installer Extras:</emphasis>
                        Packages needed if you are going to be using the 
                        <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>:
                        <literallayout class='monospaced'>
     $ sudo yum -y install autoconf automake libtool glib2-devel
                        </literallayout></para></listitem>
                </itemizedlist>
                <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>
        </section>
    </section>
</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 tarball installation scripts, 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
-->
