path: root/documentation/poky-ref-manual/extendpoky.xml

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<chapter id='extendpoky'>

<title>Extending the Yocto Project</title>
    <para>
        This chapter provides information about how to extend the functionality
        already present in the Yocto Project.
        The chapter also documents standard tasks such as adding new
        software packages, extending or customizing images or porting the Yocto Project to
        new hardware (adding a new machine). 
        Finally, the chapter contains advice about how to make changes to the 
        Yocto Project to achieve the best results.
    </para>

    <section id='usingpoky-extend-addpkg'>
        <title>Adding a Package</title>

        <para>
            To add a package into the Yocto Project you need to write a recipe for it. 
            Writing a recipe means creating a <filename>.bb</filename> file that sets some
            variables.
            For information on variables that are useful for recipes and for information about recipe naming
            issues, see the 
            <link linkend='ref-varlocality-recipe-required'>Recipe Variables - Required</link> section.
        </para>

        <para>
            Before writing a recipe from scratch, it is often useful to check
            whether someone else has written one already. 
            OpenEmbedded is a good place to look as it has a wider scope and range of packages.
            Because the Yocto Project aims to be compatible with OpenEmbedded, most recipes 
            you find there should work in Yocto Project.
        </para>

        <para>
            For new packages, the simplest way to add a recipe is to base it on a similar
            pre-existing recipe. 
            The sections that follow provide some examples that show how to add standard 
            types of packages.
        </para>

        <section id='usingpoky-extend-addpkg-singlec'>
            <title>Single .c File Package (Hello World!)</title>

            <para>
                Building an application from a single file that is stored locally (e.g. under 
                <filename>files/</filename>) requires a recipe that has the file listed in 
                the <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> variable. 
                Additionally, you need to manually write the <filename>do_compile</filename> and
                <filename>do_install</filename> tasks.
                The <filename><link linkend='var-S'>S</link></filename> variable defines the 
                directory containing the source code, which is set to <filename><link linkend='var-WORKDIR'>
                WORKDIR</link></filename> in this case - the directory BitBake uses for the build.
                <literallayout class='monospaced'>
     DESCRIPTION = "Simple helloworld application"
     SECTION = "examples"
     LICENSE = "MIT"
     PR = "r0"

     SRC_URI = "file://helloworld.c"

     S = "${WORKDIR}"

     do_compile() {
     	${CC} helloworld.c -o helloworld
     }

     do_install() {
     	install -d ${D}${bindir}
     	install -m 0755 helloworld ${D}${bindir}
     }
                </literallayout>
            </para>

            <para>
                By default, the <filename>helloworld</filename>, <filename>helloworld-dbg</filename>,
                and <filename>helloworld-dev</filename> packages are built. 
                For information on how to customize the packaging process, see the
                <link linkend='usingpoky-extend-addpkg-files'>Controlling Package Content</link> section.
            </para>
        </section>

        <section id='usingpoky-extend-addpkg-autotools'>
            <title>Autotooled Package</title>
            <para>
                Applications that use Autotools such as <filename>autoconf</filename> and 
                <filename>automake</filename> require a recipe that has a source archive listed in 
                <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> and 
                also inherits Autotools, which instructs BitBake to use the
                <filename>autotools.bbclass</filename> file, which contains the definitions of all the steps
                needed to build an Autotool-based application.
                The result of the build is automatically packaged. 
                And, if the application uses NLS for localization, packages with local information are 
                generated (one package per language). 
                Following is one example: (<filename>hello_2.3.bb</filename>)
                <literallayout class='monospaced'>
     DESCRIPTION = "GNU Helloworld application"
     SECTION = "examples"
     LICENSE = "GPLv2+"
     LIC_FILES_CHKSUM = "file://COPYING;md5=751419260aa954499f7abaabaa882bbe"
     PR = "r0"

     SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.gz"

     inherit autotools gettext
                 </literallayout>
            </para>

            <para>
                The variable <filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link>
                </filename> is used to track source license changes as described in the
                <link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'>Track License Change</link>
                section. 
                You can quickly create Autotool-based recipes in a manner similar to the previous example.
            </para>
        </section>

        <section id='usingpoky-extend-addpkg-makefile'>
            <title>Makefile-Based Package</title>

            <para>
                Applications that use GNU <filename>make</filename> also require a recipe that has
                the source archive listed in <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>. 
                You do not need to add a <filename>do_compile</filename> step since by default BitBake 
                starts the <filename>make</filename> command to compile the application. 
                If you need additional <filename>make</filename> options you should store them in the 
                <filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></filename> variable.
                BitBake passes these options into the <filename>make</filename> GNU invocation. 
                Note that a <filename>do_install</filename> task is still required.
                Otherwise BitBake runs an empty <filename>do_install</filename> task by default. 
            </para>

            <para>
                Some applications might require extra parameters to be passed to the compiler.
                For example, the application might need an additional header path. 
                You can accomplish this by adding to the <filename><link linkend='var-CFLAGS'>CFLAGS</link>
                </filename> variable.
                The following example shows this:
                <literallayout class='monospaced'>
     CFLAGS_prepend = "-I ${S}/include "
                </literallayout>
            </para>

            <para>
            In the following example, <filename>mtd-utils</filename> is a makefile-based package:
                <literallayout class='monospaced'>
     DESCRIPTION = "Tools for managing memory technology devices."
     SECTION = "base"
     DEPENDS = "zlib lzo e2fsprogs util-linux"
     HOMEPAGE = "http://www.linux-mtd.infradead.org/"
     LICENSE = "GPLv2"

     SRC_URI = "git://git.infradead.org/mtd-utils.git;protocol=git;tag=v${PV}"

     S = "${WORKDIR}/git/"

     EXTRA_OEMAKE = "'CC=${CC}' 'CFLAGS=${CFLAGS} -I${S}/include -DWITHOUT_XATTR' \
                     'BUILDDIR=${S}'"

     do_install () {
             oe_runmake install DESTDIR=${D} SBINDIR=${sbindir} MANDIR=${mandir} \
                                INCLUDEDIR=${includedir}
             install -d ${D}${includedir}/mtd/
             for f in ${S}/include/mtd/*.h; do
                     install -m 0644 $f ${D}${includedir}/mtd/
             done
     }
                </literallayout>
            </para>
        </section>

        <section id='usingpoky-extend-addpkg-files'>
            <title>Controlling Package Content</title>

            <para>                        
                You can use the variables <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> and 
                <filename><link linkend='var-FILES'>FILES</link></filename> to split an application into 
                multiple packages.
            </para>

            <para>
                Following is an example that uses the <filename>libXpm</filename> recipe. 
                By default, this recipe generates a single package that contains the library along 
                with a few binaries.  
                You can modify the recipe to split the binaries into separate packages:
                <literallayout class='monospaced'>
     require xorg-lib-common.inc

     DESCRIPTION = "X11 Pixmap library"
     LICENSE = "X-BSD"
     DEPENDS += "libxext libsm libxt"
     PR = "r3"
     PE = "1"

     XORG_PN = "libXpm"

     PACKAGES =+ "sxpm cxpm"
     FILES_cxpm = "${bindir}/cxpm"
     FILES_sxpm = "${bindir}/sxpm"
                </literallayout>
            </para>

            <para>
                In the previous example, we want to ship the <filename>sxpm</filename>
                and <filename>cxpm</filename> binaries in separate packages. 
                Since <filename>bindir</filename> would be packaged into the main 
                <filename><link linkend='var-PN'>PN</link></filename> 
                package by default, we prepend the <filename><link linkend='var-PACKAGES'>PACKAGES</link>
                </filename> variable so additional package names are added to the start of list. 
                This results in the extra <filename><link linkend='var-FILES'>FILES</link></filename>_*
                variables then containing information that define which files and
                directories go into which packages. 
                Files included by earlier packages are skipped by latter packages.
                Thus, the main <filename><link linkend='var-PN'>PN</link></filename> package 
                does not include the above listed files.
            </para>
        </section>

        <section id='usingpoky-extend-addpkg-postinstalls'>
            <title>Post Install Scripts</title>

            <para>
                To add a post-installation script to a package, add a <filename>pkg_postinst_PACKAGENAME()
                </filename> function to the <filename>.bb</filename> file and use 
                <filename>PACKAGENAME</filename> as the name of the package you want to attach to the 
                <filename>postinst</filename> script.
                Normally <filename><link linkend='var-PN'>PN</link></filename> can be used, which 
                automatically expands to PACKAGENAME.
                A post-installation function has the following structure:
                <literallayout class='monospaced'>
     pkg_postinst_PACKAGENAME () {
     #!/bin/sh -e
     # Commands to carry out
     }
                </literallayout>
            </para>

            <para>
                The script defined in the post-installation function is called when the 
                root filesystem is created. 
                If the script succeeds, the package is marked as installed. 
                If the script fails, the package is marked as unpacked and the script is
                executed when the image boots again.
            </para>

            <para>
                Sometimes it is necessary for the execution of a post-installation
                script to be delayed until the first boot.  
                For example, the script might need to be executed on the device itself. 
                To delay script execution until boot time, use the following structure in the 
                post-installation script:
                <literallayout class='monospaced'>
     pkg_postinst_PACKAGENAME () {
     #!/bin/sh -e
     if [ x"$D" = "x" ]; then
          # Actions to carry out on the device go here
     else
          exit 1
     fi
     }
                </literallayout>
            </para>

            <para>
                The previous example delays execution until the image boots again because the 
                <filename><link linkend='var-D'>D</link></filename> variable points
                to the directory containing the image when the root filesystem is created at build time but
                is unset when executed on the first boot. 
            </para>
        </section>
    </section>

    <section id='usingpoky-extend-customimage'>
        <title>Customizing Images</title>

        <para>
            You can customize Yocto Project images to satisfy particular requirements. 
            This section describes several methods and provides guidelines for each.
        </para>

        <section id='usingpoky-extend-customimage-custombb'>
            <title>Customizing Images Using Custom .bb Files</title>

            <para>
                One way to get additional software into an image is to create a custom image. 
                The following example shows the form for the two lines you need:
                <literallayout class='monospaced'>
     IMAGE_INSTALL = "task-core-x11-base package1 package2"

     inherit core-image
                </literallayout>
            </para>

            <para>
                By creating a custom image, a developer has total control
                over the contents of the image. 
                It is important to use the correct names of packages in the 
                <filename><link linkend='var-IMAGE_INSTALL'>IMAGE_INSTALL</link></filename> variable. 
                You must use the OpenEmbedded notation and not the Debian notation for the names 
                (e.g. <filename>glibc-dev</filename> instead of <filename>libc6-dev</filename>).
            </para>

            <para>
                The other method for creating a custom image is to modify an existing image. 
                For example, if a developer wants to add <filename>strace</filename> into 
                the <filename>core-image-sato</filename> image, they can use the following recipe:
                <literallayout class='monospaced'>
     require core-image-sato.bb

     IMAGE_INSTALL += "strace"
                </literallayout>
            </para>
        </section>

        <section id='usingpoky-extend-customimage-customtasks'>
            <title>Customizing Images Using Custom Tasks</title>

            <para>
                For complex custom images, the best approach is to create a custom task package
                that is used to build the image or images. 
                A good example of a tasks package is 
                <filename>meta/recipes-sato/tasks/task-poky.bb</filename>. 
                The <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> 
                variable lists the task packages to build along with the complementary
                <filename>-dbg</filename> and <filename>-dev</filename> packages. 
                For each package added, you can use 
                <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>
                and <filename><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link></filename> 
                entries to provide a list of packages the parent task package should contain. 
                Following is an example:
                <literallayout class='monospaced'>
     DESCRIPTION = "My Custom Tasks"

     PACKAGES = "\
         task-custom-apps \
         task-custom-apps-dbg \
         task-custom-apps-dev \
         task-custom-tools \
         task-custom-tools-dbg \
         task-custom-tools-dev \
         "

     RDEPENDS_task-custom-apps = "\
         dropbear \
         portmap \
         psplash"

     RDEPENDS_task-custom-tools = "\
         oprofile \
         oprofileui-server \
         lttng-control \
         lttng-viewer"

     RRECOMMENDS_task-custom-tools = "\
         kernel-module-oprofile"
                </literallayout>
            </para>

            <para>
                In the previous example, two task packages are created with their dependencies and their
                recommended package dependencies listed: <filename>task-custom-apps</filename>, and 
                <filename>task-custom-tools</filename>. 
                To build an image using these task packages, you need to add 
                <filename>task-custom-apps</filename> and/or 
                <filename>task-custom-tools</filename> to 
                <filename><link linkend='var-IMAGE_INSTALL'>IMAGE_INSTALL</link></filename>.
                For other forms of image dependencies see the other areas of this section.
            </para>
        </section>

        <section id='usingpoky-extend-customimage-imagefeatures'>
            <title>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and 
                <filename>EXTRA_IMAGE_FEATURES</filename></title>

            <para>
                Ultimately users might want to add extra image features to the set used by 
                Yocto Project with the 
                <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>
                variable. 
                To create these features, the best reference is 
                <filename>meta/classes/core-image.bbclass</filename>, which shows how the 
                Yocto Project achieves this. 
                In summary, the file looks at the contents of the 
                <filename>IMAGE_FEATURES</filename>
                variable and then maps that into a set of tasks or packages. 
                Based on this information the 
                <filename><link linkend='var-IMAGE_INSTALL'> IMAGE_INSTALL</link></filename> variable 
                is generated automatically. 
                Users can add extra features by extending the class or creating a custom class for use 
                with specialized image <filename>.bb</filename> files.
                You can also add more features by configuring the 
                <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename>
                variable in the <filename>local.conf</filename> file found in the Yocto Project
                files located in the build directory.
            </para>

            <para>
                The Yocto Project ships with two SSH servers you can use in your images: 
                Dropbear and OpenSSH. 
                Dropbear is a minimal SSH server appropriate for resource-constrained environments,
                while OpenSSH is a well-known standard SSH server implementation.
                By default, the <filename>core-image-sato</filename> image is configured to use Dropbear.
                The <filename>core-image-basic</filename> and <filename>core-image-lsb</filename>
                images both include OpenSSH.
                To change these defaults, edit the <filename>IMAGE_FEATURES</filename> variable
                so that it sets the image you are working with to include 
                <filename>ssh-server-dropbear</filename> or <filename>ssh-server-openssh</filename>.
            </para>
        </section>

        <section id='usingpoky-extend-customimage-localconf'>
            <title>Customizing Images Using <filename>local.conf</filename></title>

            <para>
                It is possible to customize image contents by using variables used by distribution 
                maintainers in the <filename>local.conf</filename> found in the Yocto Project 
                build directory.
                This method only allows the addition of packages and is not recommended.
            </para>

            <para>
                For example, to add the <filename>strace</filename> package into the image,
                you would add this package to the <filename>local.conf</filename> file:
                <literallayout class='monospaced'>
     DISTRO_EXTRA_RDEPENDS += "strace"
                </literallayout>
            </para>

            <para>
                However, since the 
                <filename><link linkend='var-DISTRO_EXTRA_RDEPENDS'>DISTRO_EXTRA_RDEPENDS</link></filename> 
                variable is for
                distribution maintainers, adding packages using this method is not as simple as adding 
                them using a custom <filename>.bb</filename> file. 
                Using the <filename>local.conf</filename> file method could result in some packages 
                needing to be recreated.
                For example, if packages were previously created and the image was rebuilt, then the packages
                would need to be recreated.
            </para>

            <para>
                Cleaning <filename>task-*</filename> packages are required because they use the
                <filename>DISTRO_EXTRA_RDEPENDS</filename> variable. 
                You do not have to build them by hand because Yocto Project images depend on the 
                packages they contain.
                This means dependencies are automatically built when the image builds. 
                For this reason we do not use the <filename>rebuild</filename> task.
                In this case the <filename>rebuild</filename> task does not care about
                dependencies - it only rebuilds the specified package.
                <literallayout class='monospaced'>
     $ bitbake -c clean task-boot task-base task-poky
     $ bitbake core-image-sato
                </literallayout>
            </para>
        </section>
    </section>

    <section id="platdev-newmachine">
        <title>Porting the Yocto Project to a New Machine</title>

        <para>
            Adding a new machine to the Yocto Project is a straightforward process. 
            This section provides information that gives you an idea of the changes you must make.
            The information covers adding machines similar to those the Yocto Project already supports. 
            Although well within the capabilities of the Yocto Project, adding a totally new architecture 
            might require 
            changes to <filename>gcc/glibc</filename> and to the site information, which is 
            beyond the scope of this manual.
        </para>

        <section id="platdev-newmachine-conffile">
            <title>Adding the Machine Configuration File</title>

            <para>
                To add a machine configuration you need to add a <filename>.conf</filename> file
                with details of the device being added to the <filename>conf/machine/</filename> file.
                The name of the file determines the name the Yocto Project uses to reference the new machine.
            </para>

            <para>
                The most important variables to set in this file are as follows:
                <itemizedlist>
                    <listitem><para><filename><link linkend='var-TARGET_ARCH'>
                        TARGET_ARCH</link></filename> (e.g. "arm")</para></listitem>
                    <listitem><para><filename><link linkend='var-PREFERRED_PROVIDER'>
                        PREFERRED_PROVIDER</link></filename>_virtual/kernel (see below)</para></listitem>
                    <listitem><para><filename><link linkend='var-MACHINE_FEATURES'>
                        MACHINE_FEATURES</link></filename> (e.g. "kernel26 apm screen wifi")</para></listitem>
                </itemizedlist>
            </para>

            <para> 
                You might also need these variables:
                <itemizedlist>
                    <listitem><para><filename><link linkend='var-SERIAL_CONSOLE'>
                        SERIAL_CONSOLE</link></filename> (e.g. "115200 ttyS0")</para></listitem>
                    <listitem><para><filename><link linkend='var-KERNEL_IMAGETYPE'>
                        KERNEL_IMAGETYPE</link></filename> (e.g. "zImage")</para></listitem>
                    <listitem><para><filename><link linkend='var-IMAGE_FSTYPES'>
                        IMAGE_FSTYPES</link></filename> (e.g. "tar.gz jffs2")</para></listitem>
                </itemizedlist>
            </para>

            <para> 
                You can find full details on these variables in the reference section. 
                You can leverage many existing machine <filename>.conf</filename> files from 
                <filename>meta/conf/machine/</filename>.
            </para>
        </section>

        <section id="platdev-newmachine-kernel">
            <title>Adding a Kernel for the Machine</title>

            <para>
                The Yocto Project needs to be able to build a kernel for the machine. 
                You need to either create a new kernel recipe for this machine, or extend an 
                existing recipe. 
                You can find several kernel examples in the 
                Yocto Project file's <filename>meta/recipes-kernel/linux</filename>
                directory that you can use as references.
            </para>

            <para>
                If you are creating a new recipe, normal recipe-writing rules apply for setting 
                up a <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>. 
                Thus, you need to specify any necessary patches and set 
                <filename><link linkend='var-S'>S</link></filename> to point at the source code. 
                You need to create a <filename>configure</filename> task that configures the 
                unpacked kernel with a defconfig.
                You can do this by using a <filename>make defconfig</filename> command or,
                more commonly, by copying in a suitable <filename>defconfig</filename> file and and then running 
                <filename>make oldconfig</filename>. 
                By making use of <filename>inherit kernel</filename> and potentially some of the 
                <filename>linux-*.inc</filename> files, most other functionality is 
                centralized and the the defaults of the class normally work well.
            </para>

            <para>
                If you are extending an existing kernel, it is usually a matter of adding a 
                suitable defconfig file.
                The file needs to be added into a location similar to defconfig files
                used for other machines in a given kernel. 
                A possible way to do this is by listing the file in the 
                <filename>SRC_URI</filename> and adding the machine to the expression in 
                <filename><link linkend='var-COMPATIBLE_MACHINE'>COMPATIBLE_MACHINE</link></filename>:
                <literallayout class='monospaced'>
     COMPATIBLE_MACHINE = '(qemux86|qemumips)'
                </literallayout>
            </para>
        </section>

        <section id="platdev-newmachine-formfactor">
            <title>Adding a Formfactor Configuration File</title>

            <para>
                A formfactor configuration file provides information about the 
                target hardware for which the Yocto Project is building and information that 
                the Yocto Project cannot obtain from other sources such as the kernel.  
                Some examples of information contained in a formfactor configuration file include 
                framebuffer orientation, whether or not the system has a keyboard, 
                the positioning of the keyboard in relation to the screen, and 
                the screen resolution.
            </para>

            <para>
                The Yocto Project uses reasonable defaults in most cases, but if customization is 
                necessary you need to create a <filename>machconfig</filename> file 
                in the Yocto Project file's <filename>meta/recipes-bsp/formfactor/files</filename>
                directory.
                This directory contains directories for specific machines such as 
                <filename>qemuarm</filename> and <filename>qemux86</filename>.
                For information about the settings available and the defaults, see the 
                <filename>meta/recipes-bsp/formfactor/files/config</filename> file found in the
                same area. 
                Following is an example for qemuarm:
                <literallayout class='monospaced'>
     HAVE_TOUCHSCREEN=1
     HAVE_KEYBOARD=1

     DISPLAY_CAN_ROTATE=0
     DISPLAY_ORIENTATION=0
     #DISPLAY_WIDTH_PIXELS=640
     #DISPLAY_HEIGHT_PIXELS=480
     #DISPLAY_BPP=16
     DISPLAY_DPI=150
     DISPLAY_SUBPIXEL_ORDER=vrgb
                </literallayout>
            </para>
        </section>
    </section>

    <section id="usingpoky-changes">
        <title>Making and Maintaining Changes</title>
        <para>
            Because the Yocto Project is extremely configurable and flexible, 
            we recognize that developers will want 
            to extend, configure or optimize it for their specific uses.
            To best keep pace with future Yocto Project changes,
            we recommend you make controlled changes to the Yocto Project.
        </para>

        <para>
            The Yocto Project supports a <link linkend='usingpoky-changes-layers'>"layers"</link> concept.
            If you use layers properly, you can ease future upgrades and allow segregation
            between the Yocto Project core and a given developer's changes. 
            The following section provides more advice on managing changes to the Yocto Project.
        </para>

        <section id="usingpoky-changes-layers">
          <title>BitBake Layers</title>
          <para>
                Often, developers want to extend the Yocto Project either by adding packages
                or by overriding files contained within the Yocto Project to add their own
                functionality. 
                BitBake has a powerful mechanism called
                "layers", which provides a way to handle this extension in a fully
                supported and non-invasive fashion.
           </para>

           <para>
               The Yocto Project files include several additional layers such as 
               <filename>meta-rt</filename> and <filename>meta-yocto</filename>
               that demonstrate this functionality.
               The <filename>meta-rt</filename> layer is not enabled by default.
               However, the <filename>meta-yocto</filename> layer is.
           </para>

           <para>
               To enable a layer, you simply add the layer's path to the 
               <filename><link linkend='var-BBLAYERS'>BBLAYERS</link></filename> variable in your 
               <filename>bblayers.conf</filename> file, which is found in the Yocto Project file's
               build directory. 
               The following example shows how to enable the <filename>meta-rt</filename>:
               <literallayout class='monospaced'>
     LCONF_VERSION = "1"

      BBFILES ?= ""
      BBLAYERS = " \
       /path/to/poky/meta \
       /path/to/poky/meta-yocto \
       /path/to/poky/meta-rt \
       "
               </literallayout>
           </para>

          <para>
               BitBake parses each <filename>conf/layer.conf</filename> file for each layer in 
               <filename>BBLAYERS</filename>
               and adds the recipes, classes and configurations contained within the layer to 
               the Yocto Project.
               To create your own layer, independent of the Yocto Project files, 
               simply create a directory with a <filename>conf/layer.conf</filename> file and
               add the directory to your <filename>bblayers.conf</filename> file.
          </para>

          <para>
               The <filename>meta-yocto/conf/layer.conf</filename> file demonstrates the 
               required syntax:
               <literallayout class='monospaced'>
     # We have a conf and classes directory, add to BBPATH
     BBPATH := "${BBPATH}:${LAYERDIR}"

     # We have a packages directory, add to BBFILES
     BBFILES := "${BBFILES} ${LAYERDIR}/recipes-*/*/*.bb \
                 ${LAYERDIR}/recipes-*/*/*.bbappend"

     BBFILE_COLLECTIONS += "yocto"
     BBFILE_PATTERN_yocto := "^${LAYERDIR}/"
     BBFILE_PRIORITY_yocto = "5" 
               </literallayout>
          </para>

          <para>
                In the previous example, the recipes for the layers are added to 
                <filename><link linkend='var-BBFILES'>BBFILES</link></filename>. 
                The <filename><link linkend='var-BBFILE_COLLECTIONS'>BBFILE_COLLECTIONS</link></filename>
                variable is then appended with the layer name. 
                The <filename><link linkend='var-BBFILE_PATTERN'>BBFILE_PATTERN</link></filename> variable
                immediately expands with a regular expression used to match files from 
                <filename>BBFILES</filename> into
                a particular layer, in this case by using the base pathname.
                The <filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename> variable 
                then assigns different priorities to the files in different layers. 
                Applying priorities is useful in situations where the same package might appear in multiple
                layers and allows you to choose what layer should take precedence.
            </para>

            <para>
                Note the use of the <filename><link linkend='var-LAYERDIR'>LAYERDIR</link></filename> 
                variable with the immediate expansion operator.
                The <filename>LAYERDIR</filename> variable expands to the directory of the current layer and
                requires the immediate expansion operator so that BitBake does not wait to expand the variable 
                when it's parsing a different directory.
            </para>

            <para>
                BitBake can locate where other <filename>.bbclass</filename> and configuration files 
                are applied through the <filename>BBPATH</filename> environment variable. 
                For these cases, BitBake uses the first file with the matching name found in 
                <filename>BBPATH</filename>.
                This is similar to the way the <filename>PATH</filename> variable is used for binaries. 
                We recommend, therefore, that you use unique <filename>.bbclass</filename>
                and configuration file names in your custom layer.
            </para>

            <para>
                We also recommend the following:
                <itemizedlist>
                    <listitem><para>Store custom layers in a Git repository that uses the 
                        <filename>meta-prvt-XXXX</filename> format.</para></listitem>
                    <listitem><para>Clone the repository alongside other <filename>meta</filename>
                        directories in the Yocto Project source files area.</para></listitem>
                </itemizedlist>
                Following these recommendations keeps your Yocto Project files area and 
                its configuration entirely inside the Yocto Project's core base.
            </para>
        </section>

        <section id="usingpoky-changes-commits">
            <title>Committing Changes</title>

            <para>
                Modifications to the Yocto Project are often managed under some kind of source
                revision control system. 
                Because some simple practices can significantly improve usability, policy for committing changes
                is important.
                It helps to use a consistent documentation style when committing changes. 
                The Yocto Project development team has found the following practices work well: 
                <itemizedlist>
                    <listitem><para>The first line of the commit summarizes the change and begins with the 
                        name of the affected package or packages.
                        However, not all changes apply to specific packages. 
                        Consequently, the prefix could also be a machine name or class name.</para></listitem>
                    <listitem><para>The second part of the commit (if needed) is a longer more detailed 
                        description of the changes.  
                        Placing a blank line between the first and second parts helps with 
                        readability.</para></listitem>
                </itemizedlist>
            </para>

            <para>
                Following is an example commit:
                <literallayout class='monospaced'>
    bitbake/data.py: Add emit_func() and generate_dependencies() functions
    
    These functions allow generation of dependency data between functions and
    variables allowing moves to be made towards generating checksums and allowing
    use of the dependency information in other parts of BitBake.
    
    Signed-off-by: Richard Purdie richard.purdie@linuxfoundation.org
                </literallayout>
            </para>

            <para>
                All commits should be self-contained such that they leave the 
                metadata in a consistent state that builds both before and after the 
                commit is made. 
                Besides being a good practice to follow, it helps ensure autobuilder test results
                are valid.
            </para>
        </section>

        <section id="usingpoky-changes-prbump">
            <title>Package Revision Incrementing</title>

            <para>
                If a committed change results in changing the package output,
                then the value of the 
                <filename><link linkend='var-PR'>PR</link></filename> variable needs to be increased 
                (or "bumped") as part of that commit. 
                This means that for new recipes you must be sure to add the <filename>PR</filename>
                variable and set its initial value equal to "r0".  
                Failing to define <filename>PR</filename> makes it easy to miss when you bump a package.
                Note that you can only use integer values following the "r" in the 
                <filename>PR</filename> variable.
            </para>

            <para>
                If you are sharing a common <filename>.inc</filename> file with multiple recipes, 
                you can also use the 
                <filename><link linkend='var-INC_PR'>INC_PR</link></filename> variable to ensure that 
                the recipes sharing the <filename>.inc</filename> file are rebuilt when the 
                <filename>.inc</filename> file itself is changed. 
                The <filename>.inc</filename> file must set <filename>INC_PR</filename>
                (initially to "r0"), and all recipes referring to it should set <filename>PR</filename>
                to "$(INC_PR).0" initially, incrementing the last number when the recipe is changed.
                If the <filename>.inc</filename> file is changed then its 
                <filename>INC_PR</filename> should be incremented.
            </para>

            <para> 
                When upgrading the version of a package, assuming the 
                <filename><link linkend='var-PV'>PV</link></filename> changes, 
                the <filename>PR</filename> variable should be reset to "r0"
                (or "$(INC_PR).0" if you are using <filename>INC_PR</filename>).
            </para>

            <para>
                Usually, version increases occur only to packages.
                However, if for some reason <filename>PV</filename> changes but does not 
                increase, you can increase the 
                <filename><link linkend='var-PE'>PE</link></filename> variable (Package Epoch).
                The <filename>PE</filename> variable defaults to "0".
            </para>

            <para>
                Version numbering strives to follow the 
                <ulink url='http://www.debian.org/doc/debian-policy/ch-controlfields.html'>
                Debian Version Field Policy Guidelines</ulink>.
                These guidelines define how versions are compared and what "increasing" a version means.
            </para>

            <para>
                There are two reasons for following the previously mentioned guidelines.
                First, to ensure that when a developer updates and rebuilds, they get all the changes to
                the repository and do not have to remember to rebuild any sections.
                Second, to ensure that target users are able to upgrade their
                devices using package manager commands such as <filename>opkg upgrade</filename> 
                (or similar commands for dpkg/apt or rpm-based systems). 
            </para>

            <para>
                The goal is to ensure the Yocto Project has packages that can be upgraded in all cases.
            </para>
        </section>

        <section id="usingpoky-changes-collaborate">
            <title>Using The Yocto Project in a Team Environment</title>

            <para>
                It might not be immediately clear how you can use the Yocto Project in a team environment, 
                or scale it for a large team of developers. 
                The specifics of any situation determine the best solution.
                Granted that the Yocto Project offers immense flexibility regarding this, practices do exist 
                that experience has shown work well.
            </para>

            <para>
                The core component of any development effort with the Yocto Project is often an 
                automated build and testing framework along with an image generation process. 
                You can use these core components to check that the metadata can be built, 
                highlight when commits break the build, and provide up-to-date images that 
                allow developers to test the end result and use it as a base platform for further 
                development. 
                Experience shows that buildbot is a good fit for this role. 
                What works well is to configure buildbot to make two types of builds:
                incremental and full (from scratch).  
                See <ulink url='http://autobuilder.yoctoproject.org:8010'>the buildbot for the 
                Yocto Project</ulink> for an example implementation that uses buildbot.
            </para>

            <para>
                You can tie incremental builds to a commit hook that triggers the build
                each time a commit is made to the metadata.  
                This practice results in useful acid tests that determine whether a given commit 
                breaks the build in some serious way. 
                Associating a build to a commit can catch a lot of simple errors.
                Furthermore, the tests are fast so developers can get quick feedback on changes.
            </para>

            <para>
                Full builds build and test everything from the ground up. 
                These types of builds usually happen at predetermined times like during the 
                night when the machine load is low.
            </para>

            <para>
                Most teams have many pieces of software undergoing active development at any given time. 
                You can derive large benefits by putting these pieces under the control of a source 
                control system that is compatible with the Yocto Project (i.e. Git or Subversion (SVN).
                You can then set the autobuilder to pull the latest revisions of the packages 
                and test the latest commits by the builds.
                This practice quickly highlights issues. 
                The Yocto Project easily supports testing configurations that use both a 
                stable known good revision and a floating revision.
                The Yocto Project can also take just the changes from specific source control branches.
                This capability allows you to track and test specific changes.
            </para>

            <para>
                Perhaps the hardest part of setting this up is defining the software project or 
                the Yocto Project metadata policies that surround the different source control systems.
                Of course circumstances will be different in each case.
                However, this situation reveals one of the Yocto Project's advantages - 
                the system itself does not
                force any particular policy on users, unlike a lot of build systems. 
                The system allows the best policies to be chosen for the given circumstances.
            </para>
        </section>

        <section id="usingpoky-changes-updatingimages">
            <title>Updating Existing Images</title>

            <para>
                Often, rather than re-flashing a new image, you might wish to install updated 
                packages into an existing running system. 
                You can do this by first sharing the <filename>tmp/deploy/ipk/</filename> directory
                through a web server and then by changing <filename>/etc/opkg/base-feeds.conf</filename> 
                to point at the shared server.
                Following is an example:
                <literallayout class='monospaced'>
     $ src/gz all http://www.mysite.com/somedir/deploy/ipk/all
     $ src/gz armv7a http://www.mysite.com/somedir/deploy/ipk/armv7a
     $ src/gz beagleboard http://www.mysite.com/somedir/deploy/ipk/beagleboard
                </literallayout>
            </para>
        </section>
    </section>

    <section id="usingpoky-modifing-packages">
        <title>Modifying Package Source Code</title>
        <para>
            Although the Yocto Project is usually used to build software, you can use it to modify software. 
        </para>

        <para>
            During a build, source is available in the 
            <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename> directory.
            The actual location depends on the type of package and the architecture of the target device. 
            For a standard recipe not related to 
            <filename><link linkend='var-MACHINE'>MACHINE</link></filename>, the location is
            <filename>tmp/work/PACKAGE_ARCH-poky-TARGET_OS/PN-PV-PR/</filename>.
            For target device-dependent packages, you should use the <filename>MACHINE</filename>
            variable instead of 
            <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename> 
            in the directory name.
        </para>

        <tip>
            Be sure the package recipe sets the 
            <filename><link linkend='var-S'>S</link></filename> variable to something
            other than the standard <filename>WORKDIR/PN-PV/</filename> value.
        </tip>

        <para>
            After building a package, you can modify the package source code without problems. 
            The easiest way to test your changes is by calling the 
            <filename>compile</filename> task as shown in the following example:
            <literallayout class='monospaced'>
     $ bitbake -c compile -f NAME_OF_PACKAGE
            </literallayout>
        </para>

        <para>
            The <filename>-f</filename> or <filename>--force</filename>
            option forces re-execution of the specified task.
            You can call other tasks this way as well. 
            But note that all the modifications in 
            <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>
            are gone once you execute <filename>-c clean</filename> for a package.
        </para>
    </section>

    <section id="usingpoky-modifying-packages-quilt">
        <title>Modifying Package Source Code with Quilt</title>
            
        <para>
            By default Poky uses <ulink url='http://savannah.nongnu.org/projects/quilt'>Quilt</ulink>
            to manage patches in the <filename>do_patch</filename> task. 
            This is a powerful tool that you can use to track all modifications to package sources.
        </para>

        <para>
            Before modifying source code, it is important to notify Quilt so it can track the changes 
            into the new patch file:
            <literallayout class='monospaced'>
     $ quilt new NAME-OF-PATCH.patch
            </literallayout>
        </para>

        <para>
            After notifying Quilt, add all modified files into that patch:
            <literallayout class='monospaced'>
     $ quilt add file1 file2 file3
            </literallayout>
        </para>

        <para>
            You can now start editing. 
            Once you are done editing, you need to use Quilt to generate the final patch that 
            will contain all your modifications.
            <literallayout class='monospaced'>
     $ quilt refresh
            </literallayout>
        </para>

        <para>
            You can find the resulting patch file in the
            <filename>patches/</filename> subdirectory of the source 
            (<filename><link linkend='var-S'>S</link></filename>) directory. 
            For future builds, you should copy the patch into the Yocto Project metadata and add it into the 
            <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> of a recipe.  
            Here is an example:
            <literallayout class='monospaced'>
     SRC_URI += "file://NAME-OF-PATCH.patch"
            </literallayout>
        </para>

        <para>
            Finally, don't forget to 'bump' the 
            <glossterm><link linkend='var-PR'>PR</link></glossterm> value in the same recipe since 
            the resulting packages have changed.
        </para>
    </section>

    <section id="usingpoky-configuring-LIC_FILES_CHKSUM">
        <title>Track License Change</title>

        <para>
            The license of an upstream project might change in the future.
            The Yocto Project uses the 
            <filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></filename> variable
            to track license changes.
        </para>

        <section id="usingpoky-specifying-LIC_FILES_CHKSUM">
            <title>Specifying the <filename>LIC_FILES_CHKSUM</filename> Variable</title>

            <para>
                The <filename>LIC_FILES_CHKSUM</filename>
                variable contains checksums of the license text in the recipe source code. 
                The Yocto Project uses checksums to track changes in the license text of the 
                source code files.
                Following is an example of <filename>LIC_FILES_CHKSUM</filename>:
                <literallayout class='monospaced'>
     LIC_FILES_CHKSUM = "file://COPYING; md5=xxxx \
                         file://licfile1.txt; beginline=5; endline=29;md5=yyyy \
                         file://licfile2.txt; endline=50;md5=zzzz \
                         ..."
                </literallayout>
            </para>

            <para>
                The Yocto Project uses the 
                <filename><link linkend='var-S'>S</link></filename> variable as the 
                default directory used when searching files listed in 
                <filename>LIC_FILES_CHKSUM</filename>.
                The previous example employs the default directory.
            </para>

            <para>
                You can also use relative paths as shown in the following example: 
                <literallayout class='monospaced'>
     LIC_FILES_CHKSUM = "file://src/ls.c;startline=5;endline=16;\
                                         md5=bb14ed3c4cda583abc85401304b5cd4e"
     LIC_FILES_CHKSUM = "file://../license.html;md5=5c94767cedb5d6987c902ac850ded2c6"
                </literallayout>
            </para>

            <para>
                In this example, the first line locates a file in 
                <filename><link linkend='var-S'>S</link>/src/ls.c</filename>. 
                The second line refers to a file in 
                <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, which is the parent
                of <filename>S</filename>.
            </para>
        </section>

        <section id="usingpoky-LIC_FILES_CHKSUM-explanation-of-syntax">
            <title>Explanation of Syntax</title>
            <para>
                As mentioned in the previous section, the 
                <filename>LIC_FILES_CHKSUM</filename> variable lists all the 
                important files that contain the license text for the source code. 
                Using this variable, you can specify the line on which the license text starts and ends
                by supplying "beginline" and "endline" parameters. 
                If you do not use the "beginline" parameter, then it is assumed that the text begins on the 
                first line of the file. 
                Similarly, if you do not use the "endline" parameter, it is assumed that the license text 
                ends as the last line of the file. 
            </para>

            <para>
                The "md5" parameter stores the md5 checksum of the license text. 
                If the license text changes in any way as compared to this parameter
                then a mis-match occurs. 
                This mismatch triggers a build failure and notifies the developer.
                Notification allows the developer to review and address the license text changes.
                Also note that if a mis-match occurs during the build, the correct md5 
                checksum is placed in the build log and can be easily copied to a 
                <filename>.bb</filename> file.
            </para>

            <para>
                There is no limit to how many files you can specify using the 
                <filename>LIC_FILES_CHKSUM</filename> variable.
                Generally, however, every project requires a few specifications for license tracking. 
                Many projects have a "COPYING" file that stores the license information for all the source 
                code files.
                This practice allow you to just track the "COPYING" file as long as it is kept up to date. 
            </para>

            <tip>
                If you specify an empty or invalid "md5" parameter, BitBake returns an md5 mis-match 
                error and displays the correct "md5" parameter value during the build. 
                The correct parameter is also captured in the build log. 
            </tip>

            <tip>
                If the whole file contains only license text, you do not need to use the "beginline" and 
                "endline" parameters. 
            </tip>
        </section>
    </section>

    <section id="usingpoky-configuring-DISTRO_PN_ALIAS">
        <title>Handling a Package Name Alias</title>
        <para>
            Sometimes a package name you are using might exist under an alias or as a similarly named
            package in a different distribution.
            The Yocto Project implements a <filename>distro_check</filename>
            task that automatically connects to major distributions
            and checks for these situations. 
            If the package exists under a different name in a different distribution, you get a 
            <filename>distro_check</filename> mismatch.  
            You can resolve this problem by defining a per-distro recipe name alias using the 
            <filename><link linkend='var-DISTRO_PN_ALIAS'>DISTRO_PN_ALIAS</link></filename> variable.
        </para>

        <para>
            Following is an example that shows how you specify the <filename>DISTRO_PN_ALIAS</filename>
            variable:
            <literallayout class='monospaced'>
     DISTRO_PN_ALIAS_pn-PACKAGENAME = "distro1=package_name_alias1 \
                                       distro2=package_name_alias2 \
                                       distro3=package_name_alias3 \
                                       ..."
            </literallayout>
        </para>
        
        <para>
            If you have more than one distribution alias, separate them with a space.
            Note that the Yocto Project currently automatically checks the 
            Fedora, OpenSuSE, Debian, Ubuntu, 
            and Mandriva distributions for source package recipes without having to specify them 
            using the <filename>DISTRO_PN_ALIAS</filename> variable.
            For example, the following command generates a report that lists the Linux distributions
            that include the sources for each of the Yocto Project recipes.
            <literallayout class='monospaced'>
     $ bitbake world -f -c distro_check
            </literallayout>
            The results are stored in the <filename>build/tmp/log/distro_check-${DATETIME}.results</filename> 
            file found in the Yocto Project files area.
        </para>
    </section>
</chapter>

<!-- 
vim: expandtab tw=80 ts=4 
-->