# Getting Started with the Yocto Project

This chapter introduces the Yocto Project and gives you an idea of what you need to get started. You can find enough information to set up your development host and build or use images for hardware supported by the Yocto Project by reading The Yocto Project Quick Start.

The remainder of this chapter summarizes what is in the Yocto Project Quick Start and provides some higher-level concepts you might want to consider.

## Introducing the Yocto Project

The Yocto Project is an open-source collaboration project focused on embedded Linux development. The project currently provides a build system, which is sometimes referred to as "Poky", and provides various ancillary tools suitable for the embedded developer. The Yocto Project also features the Sato reference User Interface, which is optimized for stylus driven, low-resolution screens.

You can use the Yocto Project build system, which uses BitBake, to develop complete Linux images and associated user-space applications for architectures based on ARM, MIPS, PowerPC, x86 and x86-64. While the Yocto Project does not provide a strict testing framework, it does provide or generate for you artifacts that let you perform target-level and emulated testing and debugging. Additionally, if you are an Eclipse IDE user, you can install an Eclipse Yocto Plug-in to allow you to develop within that familiar environment.

## Getting Set Up

Here is what you need to get set up to use the Yocto Project:

- Host System: You should have a reasonably current Linux-based host system. You will have the best results with a recent release of Fedora, OpenSUSE, or Ubuntu as these releases are frequently tested against the Yocto Project and officially supported. You should also have about 100 gigabytes of free disk space for building images.

- Packages: The Yocto Project requires certain packages exist on your development system (e.g. Python 2.6 or 2.7). See "The Packages" section in the Yocto Project Quick start for the exact package requirements and the installation commands to install them for the supported distributions.

- Yocto Project Release: You need a release of the Yocto Project. You can get set up with local Yocto Project Files one of two ways depending on whether you are going to be contributing back into the Yocto Project source repository or not.

  Regardless of the method you use, this manual refers to the resulting hierarchical set of files as the "Yocto Project Files" or the "Yocto Project File Structure."

  - Tarball Extraction: If you are not going to contribute back into the Yocto Project, you can simply download the Yocto Project release you want from the website’s download page. Once you have the tarball, just extract it into a directory of your choice.

    For example, the following command extracts the Yocto Project &DISTRO; release tarball into the current working directory and sets up the Yocto Project file structure with a top-level directory named `&YOCTO_POKY;`:

             $ tar xfj &YOCTO_POKY_TARBALL;

    This method does not produce a Git repository. Instead, you simply end up with a local snapshot of the Yocto Project files that are based on the particular release in the tarball.

  - Git Repository Method: If you are going to be contributing back into the Yocto Project or you simply want to keep up with the latest developments, you should use Git commands to set up a local Git repository of the Yocto Project Files. Doing so creates a Git repository with a complete history of changes and allows you to easily submit your changes upstream to the project. Because you cloned the repository, you have access to all the Yocto Project development branches and tag names used in the upstream repository.

    The following transcript shows how to clone the Yocto Project Files' Git repository into the current working directory.

    The name of the Yocto Project Files Git repository in the Yocto Project Files Source Repositories is `poky`. You can view the Yocto Project Source Repositories at

    The command creates the local repository in a directory named `poky`. For information on Git used within the Yocto Project, see the "Git" section.

             $ git clone git://git.yoctoproject.org/poky
             Initialized empty Git repository in /home/scottrif/poky/.git/
             remote: Counting objects: 141863, done.
             remote: Compressing objects: 100% (38624/38624), done.
             remote: Total 141863 (delta 99661), reused 141816 (delta 99614)
             Receiving objects: 100% (141863/141863), 76.64 MiB | 126 KiB/s, done.
             Resolving deltas: 100% (99661/99661), done.

    For another example of how to set up your own local Git repositories, see this wiki page, which describes how to create both `poky` and `meta-intel` Git repositories.

- Linux Yocto Kernel: If you are going to be making modifications to a supported Linux Yocto kernel, you need to establish local copies of the source. You can find Git repositories of supported Linux Yocto Kernels organized under "Yocto Linux Kernel" in the Yocto Project Source Repositories at .

  This setup involves creating a bare clone of the Linux Yocto kernel and then copying that cloned repository. You can create the bare clone and the copy of the bare clone anywhere you like. For simplicity, it is recommended that you create these structures outside of the Yocto Project Files Git repository.

  As an example, the following transcript shows how to create the bare clone of the `linux-yocto-3.2` kernel and then create a copy of that clone.

  When you have a local Linux Yocto kernel Git repository, you can reference that repository rather than the upstream Git repository as part of the `clone` command. Doing so can speed up the process.

  In the following example, the bare clone is named `linux-yocto-3.2.git`, while the copy is named `my-linux-yocto-3.2-work`:

           $ git clone --bare git://git.yoctoproject.org/linux-yocto-3.2 linux-yocto-3.2.git
           Initialized empty Git repository in /home/scottrif/linux-yocto-3.2.git/
           remote: Counting objects: 2468027, done.
           remote: Compressing objects: 100% (392255/392255), done.
           remote: Total 2468027 (delta 2071693), reused 2448773 (delta 2052498)
           Receiving objects: 100% (2468027/2468027), 530.46 MiB | 129 KiB/s, done.
           Resolving deltas: 100% (2071693/2071693), done.

  Now create a clone of the bare clone just created:

           $ git clone linux-yocto-3.2.git my-linux-yocto-3.2-work
           Initialized empty Git repository in /home/scottrif/my-linux-yocto-3.2-work/.git/
           Checking out files: 100% (37619/37619), done.

- The `poky-extras` Git Repository: The `poky-extras` Git repository contains metadata needed only if you are modifying and building the kernel image. In particular, it contains the kernel BitBake append (`.bbappend`) files that you edit to point to your locally modified kernel source files and to build the kernel image. Pointing to these local files is much more efficient than requiring a download of the source files from upstream each time you make changes to the kernel.

  You can find the `poky-extras` Git Repository in the "Yocto Metadata Layers" area of the Yocto Project Source Repositories at . It is good practice to create this Git repository inside the Yocto Project files Git repository.

  Following is an example that creates the `poky-extras` Git repository inside the Yocto Project files Git repository, which is named `poky` in this case:

           $ git clone git://git.yoctoproject.org/poky-extras poky-extras
           Initialized empty Git repository in /home/scottrif/poky/poky-extras/.git/
           remote: Counting objects: 618, done.
           remote: Compressing objects: 100% (558/558), done.
           remote: Total 618 (delta 192), reused 307 (delta 39)
           Receiving objects: 100% (618/618), 526.26 KiB | 111 KiB/s, done.
           Resolving deltas: 100% (192/192), done.

- Supported Board Support Packages (BSPs): The Yocto Project provides a layer called `meta-intel` and it is maintained in its own separate Git repository. The `meta-intel` layer contains many supported BSP Layers.

  Similar considerations exist for setting up the `meta-intel` layer. You can get set up for BSP development one of two ways: tarball extraction or with a local Git repository. It is a good idea to use the same method used to set up the Yocto Project Files. Regardless of the method you use, the Yocto Project uses the following BSP layer naming scheme:

           meta-<BSP_name>

  where <BSP_name> is the recognized BSP name. Here are some examples:

           meta-crownbay
           meta-emenlow
           meta-n450

  See the "BSP Layers" section in the Yocto Project Board Support Package (BSP) Developer's Guide for more information on BSP Layers.

  - Tarball Extraction: You can download any released BSP tarball from the same download site used to get the Yocto Project release. Once you have the tarball, just extract it into a directory of your choice. Again, this method just produces a snapshot of the BSP layer in the form of a hierarchical directory structure.

  - Git Repository Method: If you are working with a Yocto Project Files Git repository, you should also use this method to set up the `meta-intel` Git repository. You can locate the `meta-intel` Git repository in the "Yocto Metadata Layers" area of the Yocto Project Source Repositories at .

    Typically, you set up the `meta-intel` Git repository inside the Yocto Project Files Git repository. For example, the following transcript shows the steps to clone the `meta-intel` Git repository inside the `poky` Git repository.

             $ git clone git://git.yoctoproject.org/meta-intel.git
             Initialized empty Git repository in /home/scottrif/poky/meta-intel/.git/
             remote: Counting objects: 3380, done.
             remote: Compressing objects: 100% (2750/2750), done.
             remote: Total 3380 (delta 1689), reused 227 (delta 113)
             Receiving objects: 100% (3380/3380), 1.77 MiB | 128 KiB/s, done.
             Resolving deltas: 100% (1689/1689), done.

    The same wiki page referenced earlier covers how to set up the `meta-intel` Git repository.

- Eclipse Yocto Plug-in: If you are developing applications using the Eclipse Integrated Development Environment (IDE), you will need this plug-in. See the "Setting up the Eclipse IDE" section in the Yocto Application Development Toolkit (ADT) User’s Guide for more information.

## Building Images

The build process creates an entire Linux distribution, including the toolchain, from source. For more information on this topic, see the "Building an Image" section in the Yocto Project Quick Start.

The build process is as follows:

1. Make sure you have the Yocto Project files as described in the previous section.

2. Initialize the build environment by sourcing a build environment script.

3. Optionally ensure the `/conf/local.conf` configuration file, which is found in the Yocto Project Build Directory, is set up how you want it. This file defines many aspects of the build environment including the target machine architecture through the `MACHINE` variable, the development machine's processor use through the `BB_NUMBER_THREADS` and `PARALLEL_MAKE` variables, and a centralized tarball download directory through the `DL_DIR` variable.

4. Build the image using the `bitbake` command. If you want information on BitBake, see the user manual at .

5. Run the image either on the actual hardware or using the QEMU emulator.

## Using Pre-Built Binaries and QEMU

Another option you have to get started is to use pre-built binaries. This scenario is ideal for developing software applications to run on your target hardware. To do this, you need to install the stand-alone Yocto Project cross-toolchain tarball and then download the pre-built kernel that you will boot in the QEMU emulator. Next, you must download and extract the target root filesystem for your target machine’s architecture. Finally, you set up the environment to emulate the hardware and then start the QEMU emulator.

You can find details on all these steps in the "Using Pre-Built Binaries and QEMU" section of the Yocto Project Quick Start.