%poky; ] >

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 Yocto Project Quick Start. For task-based information using the Yocto Project, see the Yocto Project Development Manual and the Yocto Project Linux Kernel Development Manual. You can also find lots of information on the Yocto Project on the Yocto Project website.

This reference manual consists of the following: Using the Yocto Project: 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. Technical Details: 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. Directory Structure: This chapter describes the source directory created either by unpacking a released Yocto Project tarball on your host development system, or by cloning the upstream Poky Git repository. BitBake: This chapter provides an overview of the BitBake tool and its role within the Yocto Project. Classes: This chapter describes the classes used in the Yocto Project. Images: This chapter describes the standard images that the Yocto Project supports. Features: This chapter describes mechanisms for creating distribution, machine, and image features during the build process using the OpenEmbedded build system. Variables Glossary: 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. Variable Context: This chapter provides variable locality or context. FAQ: This chapter provides answers for commonly asked questions in the Yocto Project development environment. Contributing to the Yocto Project: This chapter provides guidance on how you can contribute back to the Yocto Project.

For general Yocto Project system requirements, see the "What You Need and How You Get It" 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.

Currently, the Yocto Project is supported on the following distributions: Ubuntu 10.04.4 LTS Ubuntu 11.10 Ubuntu 12.04.1 LTS Ubuntu 12.04.1 LTS Ubuntu 12.10 Fedora release 16 (Verne) Fedora release 17 (Beefy Miracle) Fedora release 18 (Spherical Cow) CentOS release 5.6 (Final) CentOS release 5.7 (Final) CentOS release 5.8 (Final) CentOS release 6.3 (Final) Debian GNU/Linux 6.0.6 (squeeze) openSUSE 11.4 openSUSE 12.1 openSUSE 12.2 For additional information on distributions that support the Yocto Project, see the Distribution Support wiki page.

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.

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

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

The following list shows the required packages by function given a supported OpenSUSE Linux distribution: Essentials: Packages needed to build an image for a headless system: $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; Graphical Extras: Packages recommended if the host system has graphics support: $ sudo zypper install libSDL-devel xterm Documentation: Packages needed if you are going to build out the Yocto Project documentation manuals: $ sudo zypper install make fop xsltproc ADT Installer Extras: Packages needed if you are going to be using the Application Development Toolkit (ADT) Installer: $ sudo zypper install autoconf automake libtool glib2-devel

The following list shows the required packages by function given a supported CentOS Linux distribution: Essentials: Packages needed to build an image for a headless system: $ sudo yum -y install &CENTOS_HOST_PACKAGES_ESSENTIAL; Graphical Extras: Packages recommended if the host system has graphics support: $ sudo yum -y install SDL-devel xterm Documentation: Packages needed if you are going to build out the Yocto Project documentation manuals: $ sudo yum -y install make docbook-style-dsssl docbook-style-xsl \ docbook-dtds docbook-utils fop libxslt ADT Installer Extras: Packages needed if you are going to be using the Application Development Toolkit (ADT) Installer: $ sudo yum -y install autoconf automake libtool glib2-devel 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 Poky/GettingStarted/Dependencies wiki page.

The Yocto Project development team makes the Yocto Project available through a number of methods: Releases: Stable, tested releases are available through . Nightly Builds: These releases are available at . These builds include Yocto Project releases, meta-toolchain tarball installation scripts, and experimental builds. Yocto Project Website: You can find releases of the Yocto Project and supported BSPs at the Yocto Project website. Along with these downloads, you can find lots of other information at this site.

Development using the Yocto Project requires a local Source Directory. 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 Poky Git repository. For information on both these methods, see the "Getting Setup" section in the Yocto Project Development Manual.