diff options
Diffstat (limited to 'import-layers/yocto-poky/documentation/ref-manual')
45 files changed, 33155 insertions, 0 deletions
diff --git a/import-layers/yocto-poky/documentation/ref-manual/TODO b/import-layers/yocto-poky/documentation/ref-manual/TODO new file mode 100644 index 000000000..ee0db977c --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/TODO @@ -0,0 +1,11 @@ +Handbook Todo List: + + * Document adding a new IMAGE_FEATURE to the customising images section + * Add instructions about using zaurus/openmoko emulation + * Add component overview/block diagrams + * Software Deevelopment intro should mention its software development for + intended target and could be a different arch etc and thus special case. + * Expand insane.bbclass documentation to cover tests + * Document remaining classes (see list in ref-classes) + * Document formfactor + diff --git a/import-layers/yocto-poky/documentation/ref-manual/closer-look.xml b/import-layers/yocto-poky/documentation/ref-manual/closer-look.xml new file mode 100644 index 000000000..84ff584ba --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/closer-look.xml @@ -0,0 +1,1426 @@ +<!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='closer-look'> +<title>A Closer Look at the Yocto Project Development Environment</title> + + <para> + This chapter takes a more detailed look at the Yocto Project + development environment. + The following diagram represents the development environment at a + high level. + The remainder of this chapter expands on the fundamental input, output, + process, and + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>) blocks + in the Yocto Project development environment. + </para> + + <para id='general-yocto-environment-figure'> + <imagedata fileref="figures/yocto-environment-ref.png" align="center" width="8in" depth="4.25in" /> + </para> + + <para> + The generalized Yocto Project Development Environment consists of + several functional areas: + <itemizedlist> + <listitem><para><emphasis>User Configuration:</emphasis> + Metadata you can use to control the build process. + </para></listitem> + <listitem><para><emphasis>Metadata Layers:</emphasis> + Various layers that provide software, machine, and + distro Metadata.</para></listitem> + <listitem><para><emphasis>Source Files:</emphasis> + Upstream releases, local projects, and SCMs.</para></listitem> + <listitem><para><emphasis>Build System:</emphasis> + Processes under the control of + <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>. + This block expands on how BitBake fetches source, applies + patches, completes compilation, analyzes output for package + generation, creates and tests packages, generates images, and + generates cross-development tools.</para></listitem> + <listitem><para><emphasis>Package Feeds:</emphasis> + Directories containing output packages (RPM, DEB or IPK), + which are subsequently used in the construction of an image or + SDK, produced by the build system. + These feeds can also be copied and shared using a web server or + other means to facilitate extending or updating existing + images on devices at runtime if runtime package management is + enabled.</para></listitem> + <listitem><para><emphasis>Images:</emphasis> + Images produced by the development process. + </para></listitem> + <listitem><para><emphasis>Application Development SDK:</emphasis> + Cross-development tools that are produced along with an image + or separately with BitBake.</para></listitem> + </itemizedlist> + </para> + + <section id="user-configuration"> + <title>User Configuration</title> + + <para> + User configuration helps define the build. + Through user configuration, you can tell BitBake the + target architecture for which you are building the image, + where to store downloaded source, and other build properties. + </para> + + <para> + The following figure shows an expanded representation of the + "User Configuration" box of the + <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>: + </para> + + <para> + <imagedata fileref="figures/user-configuration.png" align="center" /> + </para> + + <para> + BitBake needs some basic configuration files in order to complete + a build. + These files are <filename>*.conf</filename> files. + The minimally necessary ones reside as example files in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + For simplicity, this section refers to the Source Directory as + the "Poky Directory." + </para> + + <para> + When you clone the <filename>poky</filename> Git repository or you + download and unpack a Yocto Project release, you can set up the + Source Directory to be named anything you want. + For this discussion, the cloned repository uses the default + name <filename>poky</filename>. + <note> + The Poky repository is primarily an aggregation of existing + repositories. + It is not a canonical upstream source. + </note> + </para> + + <para> + The <filename>meta-poky</filename> layer inside Poky contains + a <filename>conf</filename> directory that has example + configuration files. + These example files are used as a basis for creating actual + configuration files when you source the build environment + script + (i.e. + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). + </para> + + <para> + Sourcing the build environment script creates a + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + if one does not already exist. + BitBake uses the Build Directory for all its work during builds. + The Build Directory has a <filename>conf</filename> directory that + contains default versions of your <filename>local.conf</filename> + and <filename>bblayers.conf</filename> configuration files. + These default configuration files are created only if versions + do not already exist in the Build Directory at the time you + source the build environment setup script. + </para> + + <para> + Because the Poky repository is fundamentally an aggregation of + existing repositories, some users might be familiar with running + the <filename>&OE_INIT_FILE;</filename> or + <filename>oe-init-build-env-memres</filename> script in the context + of separate OpenEmbedded-Core and BitBake repositories rather than a + single Poky repository. + This discussion assumes the script is executed from within a cloned + or unpacked version of Poky. + </para> + + <para> + Depending on where the script is sourced, different sub-scripts + are called to set up the Build Directory (Yocto or OpenEmbedded). + Specifically, the script + <filename>scripts/oe-setup-builddir</filename> inside the + poky directory sets up the Build Directory and seeds the directory + (if necessary) with configuration files appropriate for the + Yocto Project development environment. + <note> + The <filename>scripts/oe-setup-builddir</filename> script + uses the <filename>$TEMPLATECONF</filename> variable to + determine which sample configuration files to locate. + </note> + </para> + + <para> + The <filename>local.conf</filename> file provides many + basic variables that define a build environment. + Here is a list of a few. + To see the default configurations in a <filename>local.conf</filename> + file created by the build environment script, see the + <filename>local.conf.sample</filename> in the + <filename>meta-poky</filename> layer: + <itemizedlist> + <listitem><para><emphasis>Parallelism Options:</emphasis> + Controlled by the + <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link>, + <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>, + and + <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename></ulink> + variables.</para></listitem> + <listitem><para><emphasis>Target Machine Selection:</emphasis> + Controlled by the + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + variable.</para></listitem> + <listitem><para><emphasis>Download Directory:</emphasis> + Controlled by the + <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> + variable.</para></listitem> + <listitem><para><emphasis>Shared State Directory:</emphasis> + Controlled by the + <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link> + variable.</para></listitem> + <listitem><para><emphasis>Build Output:</emphasis> + Controlled by the + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + variable.</para></listitem> + </itemizedlist> + <note> + Configurations set in the <filename>conf/local.conf</filename> + file can also be set in the + <filename>conf/site.conf</filename> and + <filename>conf/auto.conf</filename> configuration files. + </note> + </para> + + <para> + The <filename>bblayers.conf</filename> file tells BitBake what + layers you want considered during the build. + By default, the layers listed in this file include layers + minimally needed by the build system. + However, you must manually add any custom layers you have created. + You can find more information on working with the + <filename>bblayers.conf</filename> file in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#enabling-your-layer'>Enabling Your Layer</ulink>" + section in the Yocto Project Development Manual. + </para> + + <para> + The files <filename>site.conf</filename> and + <filename>auto.conf</filename> are not created by the environment + initialization script. + If you want the <filename>site.conf</filename> file, you need to + create that yourself. + The <filename>auto.conf</filename> file is typically created by + an autobuilder: + <itemizedlist> + <listitem><para><emphasis><filename>site.conf</filename>:</emphasis> + You can use the <filename>conf/site.conf</filename> + configuration file to configure multiple build directories. + For example, suppose you had several build environments and + they shared some common features. + You can set these default build properties here. + A good example is perhaps the packaging format to use + through the + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + variable.</para> + <para>One useful scenario for using the + <filename>conf/site.conf</filename> file is to extend your + <link linkend='var-BBPATH'><filename>BBPATH</filename></link> + variable to include the path to a + <filename>conf/site.conf</filename>. + Then, when BitBake looks for Metadata using + <filename>BBPATH</filename>, it finds the + <filename>conf/site.conf</filename> file and applies your + common configurations found in the file. + To override configurations in a particular build directory, + alter the similar configurations within that build + directory's <filename>conf/local.conf</filename> file. + </para></listitem> + <listitem><para><emphasis><filename>auto.conf</filename>:</emphasis> + The file is usually created and written to by + an autobuilder. + The settings put into the file are typically the same as + you would find in the <filename>conf/local.conf</filename> + or the <filename>conf/site.conf</filename> files. + </para></listitem> + </itemizedlist> + </para> + + <para> + You can edit all configuration files to further define + any particular build environment. + This process is represented by the "User Configuration Edits" + box in the figure. + </para> + + <para> + When you launch your build with the + <filename>bitbake <replaceable>target</replaceable></filename> + command, BitBake sorts out the configurations to ultimately + define your build environment. + It is important to understand that the OpenEmbedded build system + reads the configuration files in a specific order: + <filename>site.conf</filename>, <filename>auto.conf</filename>, + and <filename>local.conf</filename>. + And, the build system applies the normal assignment statement + rules. + Because the files are parsed in a specific order, variable + assignments for the same variable could be affected. + For example, if the <filename>auto.conf</filename> file and + the <filename>local.conf</filename> set + <replaceable>variable1</replaceable> to different values, because + the build system parses <filename>local.conf</filename> after + <filename>auto.conf</filename>, + <replaceable>variable1</replaceable> is assigned the value from + the <filename>local.conf</filename> file. + </para> + </section> + + <section id="metadata-machine-configuration-and-policy-configuration"> + <title>Metadata, Machine Configuration, and Policy Configuration</title> + + <para> + The previous section described the user configurations that + define BitBake's global behavior. + This section takes a closer look at the layers the build system + uses to further control the build. + These layers provide Metadata for the software, machine, and + policy. + </para> + + <para> + In general, three types of layer input exist: + <itemizedlist> + <listitem><para><emphasis>Policy Configuration:</emphasis> + Distribution Layers provide top-level or general + policies for the image or SDK being built. + For example, this layer would dictate whether BitBake + produces RPM or IPK packages.</para></listitem> + <listitem><para><emphasis>Machine Configuration:</emphasis> + Board Support Package (BSP) layers provide machine + configurations. + This type of information is specific to a particular + target architecture.</para></listitem> + <listitem><para><emphasis>Metadata:</emphasis> + Software layers contain user-supplied recipe files, + patches, and append files. + </para></listitem> + </itemizedlist> + </para> + + <para> + The following figure shows an expanded representation of the + Metadata, Machine Configuration, and Policy Configuration input + (layers) boxes of the + <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>: + </para> + + <para> + <imagedata fileref="figures/layer-input.png" align="center" width="8in" depth="7.5in" /> + </para> + + <para> + In general, all layers have a similar structure. + They all contain a licensing file + (e.g. <filename>COPYING</filename>) if the layer is to be + distributed, a <filename>README</filename> file as good practice + and especially if the layer is to be distributed, a + configuration directory, and recipe directories. + </para> + + <para> + The Yocto Project has many layers that can be used. + You can see a web-interface listing of them on the + <ulink url="http://git.yoctoproject.org/">Source Repositories</ulink> + page. + The layers are shown at the bottom categorized under + "Yocto Metadata Layers." + These layers are fundamentally a subset of the + <ulink url="http://layers.openembedded.org/layerindex/layers/">OpenEmbedded Metadata Index</ulink>, + which lists all layers provided by the OpenEmbedded community. + <note> + Layers exist in the Yocto Project Source Repositories that + cannot be found in the OpenEmbedded Metadata Index. + These layers are either deprecated or experimental in nature. + </note> + </para> + + <para> + BitBake uses the <filename>conf/bblayers.conf</filename> file, + which is part of the user configuration, to find what layers it + should be using as part of the build. + </para> + + <para> + For more information on layers, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" + section in the Yocto Project Development Manual. + </para> + + <section id="distro-layer"> + <title>Distro Layer</title> + + <para> + The distribution layer provides policy configurations for your + distribution. + Best practices dictate that you isolate these types of + configurations into their own layer. + Settings you provide in + <filename>conf/distro/<replaceable>distro</replaceable>.conf</filename> override + similar + settings that BitBake finds in your + <filename>conf/local.conf</filename> file in the Build + Directory. + </para> + + <para> + The following list provides some explanation and references + for what you typically find in the distribution layer: + <itemizedlist> + <listitem><para><emphasis>classes:</emphasis> + Class files (<filename>.bbclass</filename>) hold + common functionality that can be shared among + recipes in the distribution. + When your recipes inherit a class, they take on the + settings and functions for that class. + You can read more about class files in the + "<link linkend='ref-classes'>Classes</link>" section. + </para></listitem> + <listitem><para><emphasis>conf:</emphasis> + This area holds configuration files for the + layer (<filename>conf/layer.conf</filename>), + the distribution + (<filename>conf/distro/<replaceable>distro</replaceable>.conf</filename>), + and any distribution-wide include files. + </para></listitem> + <listitem><para><emphasis>recipes-*:</emphasis> + Recipes and append files that affect common + functionality across the distribution. + This area could include recipes and append files + to add distribution-specific configuration, + initialization scripts, custom image recipes, + and so forth.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id="bsp-layer"> + <title>BSP Layer</title> + + <para> + The BSP Layer provides machine configurations. + Everything in this layer is specific to the machine for which + you are building the image or the SDK. + A common structure or form is defined for BSP layers. + You can learn more about this structure in the + <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. + <note> + In order for a BSP layer to be considered compliant with the + Yocto Project, it must meet some structural requirements. + </note> + </para> + + <para> + The BSP Layer's configuration directory contains + configuration files for the machine + (<filename>conf/machine/<replaceable>machine</replaceable>.conf</filename>) and, + of course, the layer (<filename>conf/layer.conf</filename>). + </para> + + <para> + The remainder of the layer is dedicated to specific recipes + by function: <filename>recipes-bsp</filename>, + <filename>recipes-core</filename>, + <filename>recipes-graphics</filename>, and + <filename>recipes-kernel</filename>. + Metadata can exist for multiple formfactors, graphics + support systems, and so forth. + <note> + While the figure shows several <filename>recipes-*</filename> + directories, not all these directories appear in all + BSP layers. + </note> + </para> + </section> + + <section id="software-layer"> + <title>Software Layer</title> + + <para> + The software layer provides the Metadata for additional + software packages used during the build. + This layer does not include Metadata that is specific to the + distribution or the machine, which are found in their + respective layers. + </para> + + <para> + This layer contains any new recipes that your project needs + in the form of recipe files. + </para> + </section> + </section> + + <section id="sources-dev-environment"> + <title>Sources</title> + + <para> + In order for the OpenEmbedded build system to create an image or + any target, it must be able to access source files. + The + <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> + represents source files using the "Upstream Project Releases", + "Local Projects", and "SCMs (optional)" boxes. + The figure represents mirrors, which also play a role in locating + source files, with the "Source Mirror(s)" box. + </para> + + <para> + The method by which source files are ultimately organized is + a function of the project. + For example, for released software, projects tend to use tarballs + or other archived files that can capture the state of a release + guaranteeing that it is statically represented. + On the other hand, for a project that is more dynamic or + experimental in nature, a project might keep source files in a + repository controlled by a Source Control Manager (SCM) such as + Git. + Pulling source from a repository allows you to control + the point in the repository (the revision) from which you want to + build software. + Finally, a combination of the two might exist, which would give the + consumer a choice when deciding where to get source files. + </para> + + <para> + BitBake uses the + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + variable to point to source files regardless of their location. + Each recipe must have a <filename>SRC_URI</filename> variable + that points to the source. + </para> + + <para> + Another area that plays a significant role in where source files + come from is pointed to by the + <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> + variable. + This area is a cache that can hold previously downloaded source. + You can also instruct the OpenEmbedded build system to create + tarballs from Git repositories, which is not the default behavior, + and store them in the <filename>DL_DIR</filename> by using the + <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> + variable. + </para> + + <para> + Judicious use of a <filename>DL_DIR</filename> directory can + save the build system a trip across the Internet when looking + for files. + A good method for using a download directory is to have + <filename>DL_DIR</filename> point to an area outside of your + Build Directory. + Doing so allows you to safely delete the Build Directory + if needed without fear of removing any downloaded source file. + </para> + + <para> + The remainder of this section provides a deeper look into the + source files and the mirrors. + Here is a more detailed look at the source file area of the + base figure: + <imagedata fileref="figures/source-input.png" align="center" width="7in" depth="7.5in" /> + </para> + + <section id='upstream-project-releases'> + <title>Upstream Project Releases</title> + + <para> + Upstream project releases exist anywhere in the form of an + archived file (e.g. tarball or zip file). + These files correspond to individual recipes. + For example, the figure uses specific releases each for + BusyBox, Qt, and Dbus. + An archive file can be for any released product that can be + built using a recipe. + </para> + </section> + + <section id='local-projects'> + <title>Local Projects</title> + + <para> + Local projects are custom bits of software the user provides. + These bits reside somewhere local to a project - perhaps + a directory into which the user checks in items (e.g. + a local directory containing a development source tree + used by the group). + </para> + + <para> + The canonical method through which to include a local project + is to use the + <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> + class to include that local project. + You use either the <filename>local.conf</filename> or a + recipe's append file to override or set the + recipe to point to the local directory on your disk to pull + in the whole source tree. + </para> + + <para> + For information on how to use the + <filename>externalsrc</filename> class, see the + "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>" + section. + </para> + </section> + + <section id='scms'> + <title>Source Control Managers (Optional)</title> + + <para> + Another place the build system can get source files from is + through an SCM such as Git or Subversion. + In this case, a repository is cloned or checked out. + The + <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> + task inside BitBake uses + the <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + variable and the argument's prefix to determine the correct + fetcher module. + </para> + + <note> + For information on how to have the OpenEmbedded build system + generate tarballs for Git repositories and place them in the + <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> + directory, see the + <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> + variable. + </note> + + <para> + When fetching a repository, BitBake uses the + <link linkend='var-SRCREV'><filename>SRCREV</filename></link> + variable to determine the specific revision from which to + build. + </para> + </section> + + <section id='source-mirrors'> + <title>Source Mirror(s)</title> + + <para> + Two kinds of mirrors exist: pre-mirrors and regular mirrors. + The <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> + and + <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> + variables point to these, respectively. + BitBake checks pre-mirrors before looking upstream for any + source files. + Pre-mirrors are appropriate when you have a shared directory + that is not a directory defined by the + <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> + variable. + A Pre-mirror typically points to a shared directory that is + local to your organization. + </para> + + <para> + Regular mirrors can be any site across the Internet that is + used as an alternative location for source code should the + primary site not be functioning for some reason or another. + </para> + </section> + </section> + + <section id="package-feeds-dev-environment"> + <title>Package Feeds</title> + + <para> + When the OpenEmbedded build system generates an image or an SDK, + it gets the packages from a package feed area located in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + The + <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> + shows this package feeds area in the upper-right corner. + </para> + + <para> + This section looks a little closer into the package feeds area used + by the build system. + Here is a more detailed look at the area: + <imagedata fileref="figures/package-feeds.png" align="center" width="7in" depth="6in" /> + </para> + + <para> + Package feeds are an intermediary step in the build process. + The OpenEmbedded build system provides classes to generate + different package types, and you specify which classes to enable + through the + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + variable. + Before placing the packages into package feeds, + the build process validates them with generated output quality + assurance checks through the + <link linkend='ref-classes-insane'><filename>insane</filename></link> + class. + </para> + + <para> + The package feed area resides in the Build Directory. + The directory the build system uses to temporarily store packages + is determined by a combination of variables and the particular + package manager in use. + See the "Package Feeds" box in the illustration and note the + information to the right of that area. + In particular, the following defines where package files are + kept: + <itemizedlist> + <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + Defined as <filename>tmp/deploy</filename> in the Build + Directory. + </para></listitem> + <listitem><para><filename>DEPLOY_DIR_*</filename>: + Depending on the package manager used, the package type + sub-folder. + Given RPM, IPK, or DEB packaging and tarball creation, the + <link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link>, + <link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link>, + <link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link>, + or + <link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link>, + variables are used, respectively. + </para></listitem> + <listitem><para><link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link>: + Defines architecture-specific sub-folders. + For example, packages could exist for the i586 or qemux86 + architectures. + </para></listitem> + </itemizedlist> + </para> + + <para> + BitBake uses the <filename>do_package_write_*</filename> tasks to + generate packages and place them into the package holding area (e.g. + <filename>do_package_write_ipk</filename> for IPK packages). + See the + "<link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link>", + "<link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link>", + "<link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link>", + and + "<link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link>" + sections for additional information. + As an example, consider a scenario where an IPK packaging manager + is being used and package architecture support for both i586 + and qemux86 exist. + Packages for the i586 architecture are placed in + <filename>build/tmp/deploy/ipk/i586</filename>, while packages for + the qemux86 architecture are placed in + <filename>build/tmp/deploy/ipk/qemux86</filename>. + </para> + </section> + + <section id='bitbake-dev-environment'> + <title>BitBake</title> + + <para> + The OpenEmbedded build system uses + <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink> + to produce images. + You can see from the + <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>, + the BitBake area consists of several functional areas. + This section takes a closer look at each of those areas. + </para> + + <para> + Separate documentation exists for the BitBake tool. + See the + <ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual'>BitBake User Manual</ulink> + for reference material on BitBake. + </para> + + <section id='source-fetching-dev-environment'> + <title>Source Fetching</title> + + <para> + The first stages of building a recipe are to fetch and unpack + the source code: + <imagedata fileref="figures/source-fetching.png" align="center" width="6.5in" depth="5in" /> + </para> + + <para> + The + <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> + and + <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> + tasks fetch the source files and unpack them into the work + directory. + <note> + For every local file (e.g. <filename>file://</filename>) + that is part of a recipe's + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + statement, the OpenEmbedded build system takes a checksum + of the file for the recipe and inserts the checksum into + the signature for the <filename>do_fetch</filename>. + If any local file has been modified, the + <filename>do_fetch</filename> task and all tasks that + depend on it are re-executed. + </note> + By default, everything is accomplished in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + which has a defined structure. + For additional general information on the Build Directory, + see the + "<link linkend='structure-core-build'><filename>build/</filename></link>" + section. + </para> + + <para> + Unpacked source files are pointed to by the + <link linkend='var-S'><filename>S</filename></link> variable. + Each recipe has an area in the Build Directory where the + unpacked source code resides. + The name of that directory for any given recipe is defined from + several different variables. + You can see the variables that define these directories + by looking at the figure: + <itemizedlist> + <listitem><para><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - + The base directory where the OpenEmbedded build system + performs all its work during the build. + </para></listitem> + <listitem><para><link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link> - + The architecture of the built package or packages. + </para></listitem> + <listitem><para><link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link> - + The operating system of the target device. + </para></listitem> + <listitem><para><link linkend='var-PN'><filename>PN</filename></link> - + The name of the built package. + </para></listitem> + <listitem><para><link linkend='var-PV'><filename>PV</filename></link> - + The version of the recipe used to build the package. + </para></listitem> + <listitem><para><link linkend='var-PR'><filename>PR</filename></link> - + The revision of the recipe used to build the package. + </para></listitem> + <listitem><para><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> - + The location within <filename>TMPDIR</filename> where + a specific package is built. + </para></listitem> + <listitem><para><link linkend='var-S'><filename>S</filename></link> - + Contains the unpacked source files for a given recipe. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='patching-dev-environment'> + <title>Patching</title> + + <para> + Once source code is fetched and unpacked, BitBake locates + patch files and applies them to the source files: + <imagedata fileref="figures/patching.png" align="center" width="6in" depth="5in" /> + </para> + + <para> + The + <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> + task processes recipes by + using the + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + variable to locate applicable patch files, which by default + are <filename>*.patch</filename> or + <filename>*.diff</filename> files, or any file if + "apply=yes" is specified for the file in + <filename>SRC_URI</filename>. + </para> + + <para> + BitBake finds and applies multiple patches for a single recipe + in the order in which it finds the patches. + Patches are applied to the recipe's source files located in the + <link linkend='var-S'><filename>S</filename></link> directory. + </para> + + <para> + For more information on how the source directories are + created, see the + "<link linkend='source-fetching-dev-environment'>Source Fetching</link>" + section. + </para> + </section> + + <section id='configuration-and-compilation-dev-environment'> + <title>Configuration and Compilation</title> + + <para> + After source code is patched, BitBake executes tasks that + configure and compile the source code: + <imagedata fileref="figures/configuration-compile-autoreconf.png" align="center" width="7in" depth="5in" /> + </para> + + <para> + This step in the build process consists of three tasks: + <itemizedlist> + <listitem><para><emphasis><filename>do_configure</filename>:</emphasis> + This task configures the source by enabling and + disabling any build-time and configuration options for + the software being built. + Configurations can come from the recipe itself as well + as from an inherited class. + Additionally, the software itself might configure itself + depending on the target for which it is being built. + </para> + + <para>The configurations handled by the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task are specific + to source code configuration for the source code + being built by the recipe.</para> + + <para>If you are using the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class, + you can add additional configuration options by using + the <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> + variable. + For information on how this variable works within + that class, see the + <filename>meta/classes/autotools.bbclass</filename> file. + </para></listitem> + <listitem><para><emphasis><filename>do_compile</filename>:</emphasis> + Once a configuration task has been satisfied, BitBake + compiles the source using the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + task. + Compilation occurs in the directory pointed to by the + <link linkend='var-B'><filename>B</filename></link> + variable. + Realize that the <filename>B</filename> directory is, by + default, the same as the + <link linkend='var-S'><filename>S</filename></link> + directory.</para></listitem> + <listitem><para><emphasis><filename>do_install</filename>:</emphasis> + Once compilation is done, BitBake executes the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task. + This task copies files from the <filename>B</filename> + directory and places them in a holding area pointed to + by the + <link linkend='var-D'><filename>D</filename></link> + variable.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='package-splitting-dev-environment'> + <title>Package Splitting</title> + + <para> + After source code is configured and compiled, the + OpenEmbedded build system analyzes + the results and splits the output into packages: + <imagedata fileref="figures/analysis-for-package-splitting.png" align="center" width="7in" depth="7in" /> + </para> + + <para> + The + <link linkend='ref-tasks-package'><filename>do_package</filename></link> + and + <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link> + tasks combine to analyze + the files found in the + <link linkend='var-D'><filename>D</filename></link> directory + and split them into subsets based on available packages and + files. + The analyzing process involves the following as well as other + items: splitting out debugging symbols, + looking at shared library dependencies between packages, + and looking at package relationships. + The <filename>do_packagedata</filename> task creates package + metadata based on the analysis such that the + OpenEmbedded build system can generate the final packages. + Working, staged, and intermediate results of the analysis + and package splitting process use these areas: + <itemizedlist> + <listitem><para><link linkend='var-PKGD'><filename>PKGD</filename></link> - + The destination directory for packages before they are + split. + </para></listitem> + <listitem><para><link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> - + A shared, global-state directory that holds data + generated during the packaging process. + </para></listitem> + <listitem><para><link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link> - + A temporary work area used by the + <filename>do_package</filename> task. + </para></listitem> + <listitem><para><link linkend='var-PKGDEST'><filename>PKGDEST</filename></link> - + The parent directory for packages after they have + been split. + </para></listitem> + </itemizedlist> + The <link linkend='var-FILES'><filename>FILES</filename></link> + variable defines the files that go into each package in + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>. + If you want details on how this is accomplished, you can + look at the + <link linkend='ref-classes-package'><filename>package</filename></link> + class. + </para> + + <para> + Depending on the type of packages being created (RPM, DEB, or + IPK), the <filename>do_package_write_*</filename> task + creates the actual packages and places them in the + Package Feed area, which is + <filename>${TMPDIR}/deploy</filename>. + You can see the + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + section for more detail on that part of the build process. + <note> + Support for creating feeds directly from the + <filename>deploy/*</filename> directories does not exist. + Creating such feeds usually requires some kind of feed + maintenance mechanism that would upload the new packages + into an official package feed (e.g. the + Ă…ngström distribution). + This functionality is highly distribution-specific + and thus is not provided out of the box. + </note> + </para> + </section> + + <section id='image-generation-dev-environment'> + <title>Image Generation</title> + + <para> + Once packages are split and stored in the Package Feeds area, + the OpenEmbedded build system uses BitBake to generate the + root filesystem image: + <imagedata fileref="figures/image-generation.png" align="center" width="6in" depth="7in" /> + </para> + + <para> + The image generation process consists of several stages and + depends on several tasks and variables. + The + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + task creates the root filesystem (file and directory structure) + for an image. + This task uses several key variables to help create the list + of packages to actually install: + <itemizedlist> + <listitem><para><link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>: + Lists out the base set of packages to install from + the Package Feeds area.</para></listitem> + <listitem><para><link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link>: + Specifies packages that should not be installed. + </para></listitem> + <listitem><para><link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>: + Specifies features to include in the image. + Most of these features map to additional packages for + installation.</para></listitem> + <listitem><para><link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>: + Specifies the package backend to use and consequently + helps determine where to locate packages within the + Package Feeds area.</para></listitem> + <listitem><para><link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link>: + Determines the language(s) for which additional + language support packages are installed. + </para></listitem> + <listitem><para><link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link>: + The final list of packages passed to the package manager + for installation into the image. + </para></listitem> + </itemizedlist> + </para> + + <para> + With + <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> + pointing to the location of the filesystem under construction and + the <filename>PACKAGE_INSTALL</filename> variable providing the + final list of packages to install, the root file system is + created. + </para> + + <para> + Package installation is under control of the package manager + (e.g. smart/rpm, opkg, or apt/dpkg) regardless of whether or + not package management is enabled for the target. + At the end of the process, if package management is not + enabled for the target, the package manager's data files + are deleted from the root filesystem. + As part of the final stage of package installation, postinstall + scripts that are part of the packages are run. + Any scripts that fail to run + on the build host are run on the target when the target system + is first booted. + If you are using a + <ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>read-only root filesystem</ulink>, + all the post installation scripts must succeed during the + package installation phase since the root filesystem is + read-only. + </para> + + <para> + The final stages of the <filename>do_rootfs</filename> task + handle post processing. + Post processing includes creation of a manifest file and + optimizations. + </para> + + <para> + The manifest file (<filename>.manifest</filename>) resides + in the same directory as the root filesystem image. + This file lists out, line-by-line, the installed packages. + The manifest file is useful for the + <link linkend='ref-classes-testimage*'><filename>testimage</filename></link> + class, for example, to determine whether or not to run + specific tests. + See the + <link linkend='var-IMAGE_MANIFEST'><filename>IMAGE_MANIFEST</filename></link> + variable for additional information. + </para> + + <para> + Optimizing processes run across the image include + <filename>mklibs</filename>, <filename>prelink</filename>, + and any other post-processing commands as defined by the + <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></link> + variable. + The <filename>mklibs</filename> process optimizes the size + of the libraries, while the + <filename>prelink</filename> process optimizes the dynamic + linking of shared libraries to reduce start up time of + executables. + </para> + + <para> + After the root filesystem is built, processing begins on + the image through the <filename>do_image</filename> task. + The build system runs any pre-processing commands as defined + by the + <link linkend='var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></link> + variable. + This variable specifies a list of functions to call before + the OpenEmbedded build system creates the final image output + files. + </para> + + <para> + The <filename>do_image</filename> task dynamically creates + other <filename>do_image_*</filename> tasks as needed, which + include compressing the root filesystem image to reduce the + overall size of the image. + The process turns everything into an image file or a set of + image files. + The formats used for the root filesystem depend on the + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + variable. + </para> + + <para> + The final task involved in image creation is the + <filename>do_image_complete</filename> task. + This task completes the image by applying any image + post processing as defined through the + <link linkend='var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></link> + variable. + The variable specifies a list of functions to call once the + OpenEmbedded build system has created the final image output + files. + </para> + + <note> + The entire image generation process is run under Pseudo. + Running under Pseudo ensures that the files in the root + filesystem have correct ownership. + </note> + </section> + + <section id='sdk-generation-dev-environment'> + <title>SDK Generation</title> + + <para> + The OpenEmbedded build system uses BitBake to generate the + Software Development Kit (SDK) installer script for both the + standard and extensible SDKs: + <imagedata fileref="figures/sdk-generation.png" align="center" /> + </para> + + <note> + For more information on the cross-development toolchain + generation, see the + "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" + section. + For information on advantages gained when building a + cross-development toolchain using the + <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> + task, see the + "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" + section in the Yocto Project Software Development Kit (SDK) + Developer's Guide. + </note> + + <para> + Like image generation, the SDK script process consists of + several stages and depends on many variables. + The <filename>do_populate_sdk</filename> and + <filename>do_populate_sdk_ext</filename> tasks use these + key variables to help create the list of packages to actually + install. + For information on the variables listed in the figure, see the + "<link linkend='sdk-dev-environment'>Application Development SDK</link>" + section. + </para> + + <para> + The <filename>do_populate_sdk</filename> task helps create + the standard SDK and handles two parts: a target part and a + host part. + The target part is the part built for the target hardware and + includes libraries and headers. + The host part is the part of the SDK that runs on the + <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>. + </para> + + <para> + The <filename>do_populate_sdk_ext</filename> task helps create + the extensible SDK and handles host and target parts + differently than its counter part does for the standard SDK. + For the extensible SDK, the task encapsulates the build system, + which includes everything needed (host and target) for the SDK. + </para> + + <para> + Regardless of the type of SDK being constructed, the + tasks perform some cleanup after which a cross-development + environment setup script and any needed configuration files + are created. + The final output is the Cross-development + toolchain installation script (<filename>.sh</filename> file), + which includes the environment setup script. + </para> + </section> + </section> + + <section id='images-dev-environment'> + <title>Images</title> + + <para> + The images produced by the OpenEmbedded build system + are compressed forms of the + root filesystem that are ready to boot on a target device. + You can see from the + <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link> + that BitBake output, in part, consists of images. + This section is going to look more closely at this output: + <imagedata fileref="figures/images.png" align="center" width="5.5in" depth="5.5in" /> + </para> + + <para> + For a list of example images that the Yocto Project provides, + see the + "<link linkend='ref-images'>Images</link>" chapter. + </para> + + <para> + Images are written out to the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + inside the <filename>tmp/deploy/images/<replaceable>machine</replaceable>/</filename> + folder as shown in the figure. + This folder contains any files expected to be loaded on the + target device. + The + <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link> + variable points to the <filename>deploy</filename> directory, + while the + <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> + variable points to the appropriate directory containing images for + the current configuration. + <itemizedlist> + <listitem><para><filename><replaceable>kernel-image</replaceable></filename>: + A kernel binary file. + The <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> + variable setting determines the naming scheme for the + kernel image file. + Depending on that variable, the file could begin with + a variety of naming strings. + The <filename>deploy/images/<replaceable>machine</replaceable></filename> + directory can contain multiple image files for the + machine.</para></listitem> + <listitem><para><filename><replaceable>root-filesystem-image</replaceable></filename>: + Root filesystems for the target device (e.g. + <filename>*.ext3</filename> or <filename>*.bz2</filename> + files). + The <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + variable setting determines the root filesystem image + type. + The <filename>deploy/images/<replaceable>machine</replaceable></filename> + directory can contain multiple root filesystems for the + machine.</para></listitem> + <listitem><para><filename><replaceable>kernel-modules</replaceable></filename>: + Tarballs that contain all the modules built for the kernel. + Kernel module tarballs exist for legacy purposes and + can be suppressed by setting the + <link linkend='var-MODULE_TARBALL_DEPLOY'><filename>MODULE_TARBALL_DEPLOY</filename></link> + variable to "0". + The <filename>deploy/images/<replaceable>machine</replaceable></filename> + directory can contain multiple kernel module tarballs + for the machine.</para></listitem> + <listitem><para><filename><replaceable>bootloaders</replaceable></filename>: + Bootloaders supporting the image, if applicable to the + target machine. + The <filename>deploy/images/<replaceable>machine</replaceable></filename> + directory can contain multiple bootloaders for the + machine.</para></listitem> + <listitem><para><filename><replaceable>symlinks</replaceable></filename>: + The <filename>deploy/images/<replaceable>machine</replaceable></filename> + folder contains + a symbolic link that points to the most recently built file + for each machine. + These links might be useful for external scripts that + need to obtain the latest version of each file. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='sdk-dev-environment'> + <title>Application Development SDK</title> + + <para> + In the + <link linkend='general-yocto-environment-figure'>general Yocto Project Development Environment figure</link>, + the output labeled "Application Development SDK" represents an + SDK. + The SDK generation process differs depending on whether you build + a standard SDK + (e.g. <filename>bitbake -c populate_sdk</filename> <replaceable>imagename</replaceable>) + or an extensible SDK + (e.g. <filename>bitbake -c populate_sdk_ext</filename> <replaceable>imagename</replaceable>). + This section is going to take a closer look at this output: + <imagedata fileref="figures/sdk.png" align="center" width="9in" depth="7.25in" /> + </para> + + <para> + The specific form of this output is a self-extracting + SDK installer (<filename>*.sh</filename>) that, when run, + installs the SDK, which consists of a cross-development + toolchain, a set of libraries and headers, and an SDK + environment setup script. + Running this installer essentially sets up your + cross-development environment. + You can think of the cross-toolchain as the "host" + part because it runs on the SDK machine. + You can think of the libraries and headers as the "target" + part because they are built for the target hardware. + The environment setup script is added so that you can initialize + the environment before using the tools. + </para> + + <note> + <para> + The Yocto Project supports several methods by which you can + set up this cross-development environment. + These methods include downloading pre-built SDK installers + or building and installing your own SDK installer. + </para> + + <para> + For background information on cross-development toolchains + in the Yocto Project development environment, see the + "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" + section. + For information on setting up a cross-development + environment, see the + <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>. + </para> + </note> + + <para> + Once built, the SDK installers are written out to the + <filename>deploy/sdk</filename> folder inside the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + as shown in the figure at the beginning of this section. + Depending on the type of SDK, several variables exist that help + configure these files. + The following list shows the variables associated with a standard + SDK: + <itemizedlist> + <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + Points to the <filename>deploy</filename> + directory.</para></listitem> + <listitem><para><link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>: + Specifies the architecture of the machine + on which the cross-development tools are run to + create packages for the target hardware. + </para></listitem> + <listitem><para><link linkend='var-SDKIMAGE_FEATURES'><filename>SDKIMAGE_FEATURES</filename></link>: + Lists the features to include in the "target" part + of the SDK. + </para></listitem> + <listitem><para><link linkend='var-TOOLCHAIN_HOST_TASK'><filename>TOOLCHAIN_HOST_TASK</filename></link>: + Lists packages that make up the host + part of the SDK (i.e. the part that runs on + the <filename>SDKMACHINE</filename>). + When you use + <filename>bitbake -c populate_sdk <replaceable>imagename</replaceable></filename> + to create the SDK, a set of default packages + apply. + This variable allows you to add more packages. + </para></listitem> + <listitem><para><link linkend='var-TOOLCHAIN_TARGET_TASK'><filename>TOOLCHAIN_TARGET_TASK</filename></link>: + Lists packages that make up the target part + of the SDK (i.e. the part built for the + target hardware). + </para></listitem> + <listitem><para><link linkend='var-SDKPATH'><filename>SDKPATH</filename></link>: + Defines the default SDK installation path offered by the + installation script. + </para></listitem> + </itemizedlist> + This next list, shows the variables associated with an extensible + SDK: + <itemizedlist> + <listitem><para><link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + Points to the <filename>deploy</filename> directory. + </para></listitem> + <listitem><para><link linkend='var-SDK_EXT_TYPE'><filename>SDK_EXT_TYPE</filename></link>: + Controls whether or not shared state artifacts are copied + into the extensible SDK. + By default, all required shared state artifacts are copied + into the SDK. + </para></listitem> + <listitem><para><link linkend='var-SDK_INCLUDE_PKGDATA'><filename>SDK_INCLUDE_PKGDATA</filename></link>: + Specifies whether or not packagedata will be included in + the extensible SDK for all recipes in the "world" target. + </para></listitem> + <listitem><para><link linkend='var-SDK_LOCAL_CONF_WHITELIST'><filename>SDK_LOCAL_CONF_WHITELIST</filename></link>: + A list of variables allowed through from the build system + configuration into the extensible SDK configuration. + </para></listitem> + <listitem><para><link linkend='var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></link>: + A list of variables not allowed through from the build + system configuration into the extensible SDK configuration. + </para></listitem> + <listitem><para><link linkend='var-SDK_INHERIT_BLACKLIST'><filename>SDK_INHERIT_BLACKLIST</filename></link>: + A list of classes to remove from the + <link linkend='var-INHERIT'><filename>INHERIT</filename></link> + value globally within the extensible SDK configuration. + </para></listitem> + </itemizedlist> + </para> + </section> + +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/examples/hello-autotools/hello_2.3.bb b/import-layers/yocto-poky/documentation/ref-manual/examples/hello-autotools/hello_2.3.bb new file mode 100644 index 000000000..5dfb0b30c --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/examples/hello-autotools/hello_2.3.bb @@ -0,0 +1,8 @@ +DESCRIPTION = "GNU Helloworld application" +SECTION = "examples" +LICENSE = "GPLv3" +LIC_FILES_CHKSUM = "file://COPYING;md5=adefda309052235aa5d1e99ce7557010" + +SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.bz2" + +inherit autotools diff --git a/import-layers/yocto-poky/documentation/ref-manual/examples/hello-single/files/helloworld.c b/import-layers/yocto-poky/documentation/ref-manual/examples/hello-single/files/helloworld.c new file mode 100644 index 000000000..fc7169b7b --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/examples/hello-single/files/helloworld.c @@ -0,0 +1,8 @@ +#include <stdio.h> + +int main(void) +{ + printf("Hello world!\n"); + + return 0; +} diff --git a/import-layers/yocto-poky/documentation/ref-manual/examples/hello-single/hello.bb b/import-layers/yocto-poky/documentation/ref-manual/examples/hello-single/hello.bb new file mode 100644 index 000000000..0812743e3 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/examples/hello-single/hello.bb @@ -0,0 +1,17 @@ +DESCRIPTION = "Simple helloworld application" +SECTION = "examples" +LICENSE = "MIT" +LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302" + +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} +} diff --git a/import-layers/yocto-poky/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb b/import-layers/yocto-poky/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb new file mode 100644 index 000000000..b58d4d7bd --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb @@ -0,0 +1,14 @@ +require xorg-lib-common.inc + +DESCRIPTION = "X11 Pixmap library" +LICENSE = "X-BSD" +LIC_FILES_CHKSUM = "file://COPYING;md5=3e07763d16963c3af12db271a31abaa5" +DEPENDS += "libxext" +PR = "r2" +PE = "1" + +XORG_PN = "libXpm" + +PACKAGES =+ "sxpm cxpm" +FILES_cxpm = "${bindir}/cxpm" +FILES_sxpm = "${bindir}/sxpm" diff --git a/import-layers/yocto-poky/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb b/import-layers/yocto-poky/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb new file mode 100644 index 000000000..5d05a437a --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb @@ -0,0 +1,15 @@ +DESCRIPTION = "Tools for managing memory technology devices." +SECTION = "base" +DEPENDS = "zlib" +HOMEPAGE = "http://www.linux-mtd.infradead.org/" +LICENSE = "GPLv2" +LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \ + file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c" + +SRC_URI = "ftp://ftp.infradead.org/pub/mtd-utils/mtd-utils-${PV}.tar.gz" + +CFLAGS_prepend = "-I ${S}/include " + +do_install() { + oe_runmake install DESTDIR=${D} +} diff --git a/import-layers/yocto-poky/documentation/ref-manual/faq.xml b/import-layers/yocto-poky/documentation/ref-manual/faq.xml new file mode 100644 index 000000000..d2e4e8eb1 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/faq.xml @@ -0,0 +1,836 @@ +<!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='faq'> +<title>FAQ</title> +<qandaset> + <qandaentry> + <question> + <para> + How does Poky differ from <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>? + </para> + </question> + <answer> + <para> + The term "<ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink>" + refers to the specific reference build system that + the Yocto Project provides. + Poky is based on <ulink url='&YOCTO_DOCS_DEV_URL;#oe-core'>OE-Core</ulink> + and <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>. + Thus, the generic term used here for the build system is + the "OpenEmbedded build system." + Development in the Yocto Project using Poky is closely tied to OpenEmbedded, with + changes always being merged to OE-Core or BitBake first before being pulled back + into Poky. + This practice benefits both projects immediately. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para id='faq-not-meeting-requirements'> + My development system does not meet the + required Git, tar, and Python versions. + In particular, I do not have Python 2.7.3 or greater, or + I do have Python 3.x, which is specifically not supported by + the Yocto Project. + Can I still use the Yocto Project? + </para> + </question> + <answer> + <para> + You can get the required tools on your host development + system a couple different ways (i.e. building a tarball or + downloading a tarball). + See the + "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" + section for steps on how to update your build tools. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + How can you claim Poky / OpenEmbedded-Core is stable? + </para> + </question> + <answer> + <para> + There are three areas that help with stability; + <itemizedlist> + <listitem><para>The Yocto Project team keeps + <ulink url='&YOCTO_DOCS_DEV_URL;#oe-core'>OE-Core</ulink> small + and focused, containing around 830 recipes as opposed to the thousands + available in other OpenEmbedded community layers. + Keeping it small makes it easy to test and maintain.</para></listitem> + <listitem><para>The Yocto Project team runs manual and automated tests + using a small, fixed set of reference hardware as well as emulated + targets.</para></listitem> + <listitem><para>The Yocto Project uses an autobuilder, + which provides continuous build and integration tests.</para></listitem> + </itemizedlist> + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + How do I get support for my board added to the Yocto Project? + </para> + </question> + <answer> + <para> + Support for an additional board is added by creating a + Board Support Package (BSP) layer for it. + For more information on how to create a BSP layer, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" + section in the Yocto Project Development Manual and the + <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. + </para> + <para> + Usually, if the board is not completely exotic, adding support in + the Yocto Project is fairly straightforward. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + Are there any products built using the OpenEmbedded build system? + </para> + </question> + <answer> + <para> + The software running on the <ulink url='http://vernier.com/labquest/'>Vernier LabQuest</ulink> + is built using the OpenEmbedded build system. + See the <ulink url='http://www.vernier.com/products/interfaces/labq/'>Vernier LabQuest</ulink> + website for more information. + There are a number of pre-production devices using the OpenEmbedded build system + and the Yocto Project team + announces them as soon as they are released. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + What does the OpenEmbedded build system produce as output? + </para> + </question> + <answer> + <para> + Because you can use the same set of recipes to create output of + various formats, the output of an OpenEmbedded build depends on + how you start it. + Usually, the output is a flashable image ready for the target + device. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + How do I add my package to the Yocto Project? + </para> + </question> + <answer> + <para> + To add a package, you need to create a BitBake recipe. + For information on how to create a BitBake recipe, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-writing-a-new-recipe'>Writing a New Recipe</ulink>" + in the Yocto Project Development Manual. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + Do I have to reflash my entire board with a new Yocto Project image when recompiling + a package? + </para> + </question> + <answer> + <para> + The OpenEmbedded build system can build packages in various + formats such as IPK for OPKG, Debian package + (<filename>.deb</filename>), or RPM. + You can then upgrade the packages using the package tools on + the device, much like on a desktop distribution such as + Ubuntu or Fedora. + However, package management on the target is entirely optional. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + I see the error '<filename>chmod: XXXXX new permissions are r-xrwxrwx, not r-xr-xr-x</filename>'. + What is wrong? + </para> + </question> + <answer> + <para> + You are probably running the build on an NTFS filesystem. + Use <filename>ext2</filename>, <filename>ext3</filename>, or <filename>ext4</filename> instead. + </para> + </answer> + </qandaentry> + +<!-- <qandaentry> + <question> + <para> + How do I make the Yocto Project work in RHEL/CentOS? + </para> + </question> + <answer> + <para> + To get the Yocto Project working under RHEL/CentOS 5.1 you need to first + install some required packages. + The standard CentOS packages needed are: + <itemizedlist> + <listitem><para>"Development tools" (selected during installation)</para></listitem> + <listitem><para><filename>texi2html</filename></para></listitem> + <listitem><para><filename>compat-gcc-34</filename></para></listitem> + </itemizedlist> + On top of these, you need the following external packages: + <itemizedlist> + <listitem><para><filename>python-sqlite2</filename> from + <ulink url='http://dag.wieers.com/rpm/packages/python-sqlite2/'>DAG repository</ulink> + </para></listitem> + <listitem><para><filename>help2man</filename> from + <ulink url='http://centos.karan.org/el4/extras/stable/x86_64/RPMS/repodata/repoview/help2man-0-1.33.1-2.html'>Karan repository</ulink></para></listitem> + </itemizedlist> + </para> + + <para> + Once these packages are installed, the OpenEmbedded build system will be able + to build standard images. + However, there might be a problem with the QEMU emulator segfaulting. + You can either disable the generation of binary locales by setting + <filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>ENABLE_BINARY_LOCALE_GENERATION</link> + </filename> to "0" or by removing the <filename>linux-2.6-execshield.patch</filename> + from the kernel and rebuilding it since that is the patch that causes the problems with QEMU. + </para> + + <note> + <para>For information on distributions that the Yocto Project + uses during validation, see the + <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink> + Wiki page.</para> + <para>For notes about using the Yocto Project on a RHEL 4-based + host, see the + <ulink url='&YOCTO_WIKI_URL;/wiki/BuildingOnRHEL4'>Building on RHEL4</ulink> + Wiki page.</para> + </note> + </answer> + </qandaentry> --> + + <qandaentry> + <question> + <para> + I see lots of 404 responses for files on + <filename>&YOCTO_HOME_URL;/sources/*</filename>. Is something wrong? + </para> + </question> + <answer> + <para> + Nothing is wrong. + The OpenEmbedded build system checks any configured source mirrors before downloading + from the upstream sources. + The build system does this searching for both source archives and + pre-checked out versions of SCM-managed software. + These checks help in large installations because it can reduce load on the SCM servers + themselves. + The address above is one of the default mirrors configured into the + build system. + Consequently, if an upstream source disappears, the team + can place sources there so builds continue to work. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + I have machine-specific data in a package for one machine only but the package is + being marked as machine-specific in all cases, how do I prevent this? + </para> + </question> + <answer> + <para> + Set <filename><link linkend='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'>SRC_URI_OVERRIDES_PACKAGE_ARCH</link> + </filename> = "0" in the <filename>.bb</filename> file but make sure the package is + manually marked as + machine-specific for the case that needs it. + The code that handles + <filename>SRC_URI_OVERRIDES_PACKAGE_ARCH</filename> is in + the <filename>meta/classes/base.bbclass</filename> file. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para id='i-am-behind-a-firewall-and-need-to-use-a-proxy-server'> + I'm behind a firewall and need to use a proxy server. How do I do that? + </para> + </question> + <answer> + <para> + Most source fetching by the OpenEmbedded build system is done + by <filename>wget</filename> and you therefore need to specify + the proxy settings in a <filename>.wgetrc</filename> file, + which can be in your home directory if you are a single user + or can be in <filename>/usr/local/etc/wgetrc</filename> as + a global user file. + </para> + + <para> + Following is the applicable code for setting various proxy + types in the <filename>.wgetrc</filename> file. + By default, these settings are disabled with comments. + To use them, remove the comments: + <literallayout class='monospaced'> + # You can set the default proxies for Wget to use for http, https, and ftp. + # They will override the value in the environment. + #https_proxy = http://proxy.yoyodyne.com:18023/ + #http_proxy = http://proxy.yoyodyne.com:18023/ + #ftp_proxy = http://proxy.yoyodyne.com:18023/ + + # If you do not want to use proxy at all, set this to off. + #use_proxy = on + </literallayout> + The Yocto Project also includes a + <filename>meta-poky/conf/site.conf.sample</filename> file that + shows how to configure CVS and Git proxy servers if needed. + For more information on setting up various proxy types and + configuring proxy servers, see the + "<ulink url='&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>" + Wiki page. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + What’s the difference between <replaceable>target</replaceable> and <replaceable>target</replaceable><filename>-native</filename>? + </para> + </question> + <answer> + <para> + The <filename>*-native</filename> targets are designed to run on the system + being used for the build. + These are usually tools that are needed to assist the build in some way such as + <filename>quilt-native</filename>, which is used to apply patches. + The non-native version is the one that runs on the target device. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + I'm seeing random build failures. Help?! + </para> + </question> + <answer> + <para> + If the same build is failing in totally different and random + ways, the most likely explanation is: + <itemizedlist> + <listitem><para>The hardware you are running the build on + has some problem.</para></listitem> + <listitem><para>You are running the build under + virtualization, in which case the virtualization + probably has bugs.</para></listitem> + </itemizedlist> + The OpenEmbedded build system processes a massive amount of + data that causes lots of network, disk and CPU activity and + is sensitive to even single-bit failures in any of these areas. + True random failures have always been traced back to hardware + or virtualization issues. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + When I try to build a native recipe, the build fails with <filename>iconv.h</filename> problems. + </para> + </question> + <answer> + <para> + If you get an error message that indicates GNU + <filename>libiconv</filename> is not in use but + <filename>iconv.h</filename> has been included from + <filename>libiconv</filename>, you need to check to see if + you have a previously installed version of the header file + in <filename>/usr/local/include</filename>. + <literallayout class='monospaced'> + #error GNU libiconv not in use but included iconv.h is from libiconv + </literallayout> + If you find a previously installed file, you should either + uninstall it or temporarily rename it and try the build again. + </para> + + <para> + This issue is just a single manifestation of "system + leakage" issues caused when the OpenEmbedded build system + finds and uses previously installed files during a native + build. + This type of issue might not be limited to + <filename>iconv.h</filename>. + Be sure that leakage cannot occur from + <filename>/usr/local/include</filename> and + <filename>/opt</filename> locations. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + What do we need to ship for license compliance? + </para> + </question> + <answer> + <para> + This is a difficult question and you need to consult your lawyer + for the answer for your specific case. + It is worth bearing in mind that for GPL compliance, there needs + to be enough information shipped to allow someone else to + rebuild and produce the same end result you are shipping. + This means sharing the source code, any patches applied to it, + and also any configuration information about how that package + was configured and built. + </para> + + <para> + You can find more information on licensing in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#licensing'>Licensing</ulink>" + and "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" + sections, both of which are in the Yocto Project Development + Manual. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + How do I disable the cursor on my touchscreen device? + </para> + </question> + <answer> + <para> + You need to create a form factor file as described in the + "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-misc-recipes'>Miscellaneous BSP-Specific Recipe Files</ulink>" + section in the Yocto Project Board Support Packages (BSP) + Developer's Guide. + Set the <filename>HAVE_TOUCHSCREEN</filename> variable equal to + one as follows: + <literallayout class='monospaced'> + HAVE_TOUCHSCREEN=1 + </literallayout> + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + How do I make sure connected network interfaces are brought up by default? + </para> + </question> + <answer> + <para> + The default interfaces file provided by the netbase recipe does not + automatically bring up network interfaces. + Therefore, you will need to add a BSP-specific netbase that includes an interfaces + file. + See the "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-misc-recipes'>Miscellaneous BSP-Specific Recipe Files</ulink>" + section in the Yocto Project Board Support Packages (BSP) + Developer's Guide for information on creating these types of + miscellaneous recipe files. + </para> + <para> + For example, add the following files to your layer: + <literallayout class='monospaced'> + meta-MACHINE/recipes-bsp/netbase/netbase/MACHINE/interfaces + meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend + </literallayout> + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + How do I create images with more free space? + </para> + </question> + <answer> + <para> + By default, the OpenEmbedded build system creates images + that are 1.3 times the size of the populated root filesystem. + To affect the image size, you need to set various + configurations: + <itemizedlist> + <listitem><para><emphasis>Image Size:</emphasis> + The OpenEmbedded build system uses the + <link linkend='var-IMAGE_ROOTFS_SIZE'><filename>IMAGE_ROOTFS_SIZE</filename></link> + variable to define the size of the image in Kbytes. + The build system determines the size by taking into + account the initial root filesystem size before any + modifications such as requested size for the image and + any requested additional free disk space to be + added to the image.</para></listitem> + <listitem><para><emphasis>Overhead:</emphasis> + Use the + <link linkend='var-IMAGE_OVERHEAD_FACTOR'><filename>IMAGE_OVERHEAD_FACTOR</filename></link> + variable to define the multiplier that the build system + applies to the initial image size, which is 1.3 by + default.</para></listitem> + <listitem><para><emphasis>Additional Free Space:</emphasis> + Use the + <link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'><filename>IMAGE_ROOTFS_EXTRA_SPACE</filename></link> + variable to add additional free space to the image. + The build system adds this space to the image after + it determines its + <filename>IMAGE_ROOTFS_SIZE</filename>. + </para></listitem> + </itemizedlist> + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + Why don't you support directories with spaces in the pathnames? + </para> + </question> + <answer> + <para> + The Yocto Project team has tried to do this before but too + many of the tools the OpenEmbedded build system depends on, + such as <filename>autoconf</filename>, break when they find + spaces in pathnames. + Until that situation changes, the team will not support spaces + in pathnames. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + How do I use an external toolchain? + </para> + </question> + <answer> + <para> + The toolchain configuration is very flexible and customizable. + It is primarily controlled with the + <filename><link linkend='var-TCMODE'>TCMODE</link></filename> + variable. + This variable controls which <filename>tcmode-*.inc</filename> + file to include from the + <filename>meta/conf/distro/include</filename> directory within + the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + + <para> + The default value of <filename>TCMODE</filename> is "default", + which tells the OpenEmbedded build system to use its internally + built toolchain (i.e. <filename>tcmode-default.inc</filename>). + However, other patterns are accepted. + In particular, "external-*" refers to external toolchains. + One example is the Sourcery G++ Toolchain. + The support for this toolchain resides in the separate + <filename>meta-sourcery</filename> layer at + <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>. + </para> + + <para> + In addition to the toolchain configuration, you also need a + corresponding toolchain recipe file. + This recipe file needs to package up any pre-built objects in + the toolchain such as <filename>libgcc</filename>, + <filename>libstdcc++</filename>, any locales, and + <filename>libc</filename>. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para id='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'> + How does the OpenEmbedded build system obtain source code and + will it work behind my firewall or proxy server? + </para> + </question> + <answer> + <para> + The way the build system obtains source code is highly + configurable. + You can setup the build system to get source code in most + environments if HTTP transport is available. + </para> + <para> + When the build system searches for source code, it first + tries the local download directory. + If that location fails, Poky tries + <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>, + the upstream source, and then + <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> + in that order. + </para> + <para> + Assuming your distribution is "poky", the OpenEmbedded build + system uses the Yocto Project source + <filename>PREMIRRORS</filename> by default for SCM-based + sources, upstreams for normal tarballs, and then falls back + to a number of other mirrors including the Yocto Project + source mirror if those fail. + </para> + <para> + As an example, you could add a specific server for the + build system to attempt before any others by adding something + like the following to the <filename>local.conf</filename> + configuration file: + <literallayout class='monospaced'> + PREMIRRORS_prepend = "\ + git://.*/.* http://www.yoctoproject.org/sources/ \n \ + ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ + http://.*/.* http://www.yoctoproject.org/sources/ \n \ + https://.*/.* http://www.yoctoproject.org/sources/ \n" + </literallayout> + </para> + <para> + These changes cause the build system to intercept Git, FTP, + HTTP, and HTTPS requests and direct them to the + <filename>http://</filename> sources mirror. + You can use <filename>file://</filename> URLs to point to + local directories or network shares as well. + </para> + <para> + Aside from the previous technique, these options also exist: + <literallayout class='monospaced'> + BB_NO_NETWORK = "1" + </literallayout> + This statement tells BitBake to issue an error instead of + trying to access the Internet. + This technique is useful if you want to ensure code builds + only from local sources. + </para> + <para> + Here is another technique: + <literallayout class='monospaced'> + BB_FETCH_PREMIRRORONLY = "1" + </literallayout> + This statement limits the build system to pulling source + from the <filename>PREMIRRORS</filename> only. + Again, this technique is useful for reproducing builds. + </para> + <para> + Here is another technique: + <literallayout class='monospaced'> + BB_GENERATE_MIRROR_TARBALLS = "1" + </literallayout> + This statement tells the build system to generate mirror + tarballs. + This technique is useful if you want to create a mirror server. + If not, however, the technique can simply waste time during + the build. + </para> + <para> + Finally, consider an example where you are behind an + HTTP-only firewall. + You could make the following changes to the + <filename>local.conf</filename> configuration file as long as + the <filename>PREMIRRORS</filename> server is current: + <literallayout class='monospaced'> + PREMIRRORS_prepend = "\ + ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ + http://.*/.* http://www.yoctoproject.org/sources/ \n \ + https://.*/.* http://www.yoctoproject.org/sources/ \n" + BB_FETCH_PREMIRRORONLY = "1" + </literallayout> + These changes would cause the build system to successfully + fetch source over HTTP and any network accesses to anything + other than the <filename>PREMIRRORS</filename> would fail. + </para> + <para> + The build system also honors the standard shell environment + variables <filename>http_proxy</filename>, + <filename>ftp_proxy</filename>, + <filename>https_proxy</filename>, and + <filename>all_proxy</filename> to redirect requests through + proxy servers. + </para> + <note> + You can find more information on the + "<ulink url='&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>" + Wiki page. + </note> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + Can I get rid of build output so I can start over? + </para> + </question> + <answer> + <para> + Yes - you can easily do this. + When you use BitBake to build an image, all the build output + goes into the directory created when you run the + build environment setup script (i.e. + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). + By default, this <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + is named <filename>build</filename> but can be named + anything you want. + </para> + + <para> + Within the Build Directory, is the <filename>tmp</filename> + directory. + To remove all the build output yet preserve any source code or + downloaded files from previous builds, simply remove the + <filename>tmp</filename> directory. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + Why do <filename>${bindir}</filename> and <filename>${libdir}</filename> have strange values for <filename>-native</filename> recipes? + </para> + </question> + <answer> + <para> + Executables and libraries might need to be used from a + directory other than the directory into which they were + initially installed. + Complicating this situation is the fact that sometimes these + executables and libraries are compiled with the expectation + of being run from that initial installation target directory. + If this is the case, moving them causes problems. + </para> + + <para> + This scenario is a fundamental problem for package maintainers + of mainstream Linux distributions as well as for the + OpenEmbedded build system. + As such, a well-established solution exists. + Makefiles, Autotools configuration scripts, and other build + systems are expected to respect environment variables such as + <filename>bindir</filename>, <filename>libdir</filename>, + and <filename>sysconfdir</filename> that indicate where + executables, libraries, and data reside when a program is + actually run. + They are also expected to respect a + <filename>DESTDIR</filename> environment variable, which is + prepended to all the other variables when the build system + actually installs the files. + It is understood that the program does not actually run from + within <filename>DESTDIR</filename>. + </para> + + <para> + When the OpenEmbedded build system uses a recipe to build a + target-architecture program (i.e. one that is intended for + inclusion on the image being built), that program eventually + runs from the root file system of that image. + Thus, the build system provides a value of "/usr/bin" for + <filename>bindir</filename>, a value of "/usr/lib" for + <filename>libdir</filename>, and so forth. + </para> + + <para> + Meanwhile, <filename>DESTDIR</filename> is a path within the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + However, when the recipe builds a native program (i.e. one + that is intended to run on the build machine), that program + is never installed directly to the build machine's root + file system. + Consequently, the build system uses paths within the Build + Directory for <filename>DESTDIR</filename>, + <filename>bindir</filename> and related variables. + To better understand this, consider the following two paths + where the first is relatively normal and the second is not: + <note> + Due to these lengthy examples, the paths are artificially + broken across lines for readability. + </note> + <literallayout class='monospaced'> + /home/maxtothemax/poky-bootchart2/build/tmp/work/i586-poky-linux/zlib/ + 1.2.8-r0/sysroot-destdir/usr/bin + + /home/maxtothemax/poky-bootchart2/build/tmp/work/x86_64-linux/ + zlib-native/1.2.8-r0/sysroot-destdir/home/maxtothemax/poky-bootchart2/ + build/tmp/sysroots/x86_64-linux/usr/bin + </literallayout> + Even if the paths look unusual, they both are correct - + the first for a target and the second for a native recipe. + These paths are a consequence of the + <filename>DESTDIR</filename> mechanism and while they + appear strange, they are correct and in practice very effective. + </para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para> + The files provided by my <filename>*-native</filename> recipe do + not appear to be available to other recipes. + Files are missing from the native sysroot, my recipe is + installing to the wrong place, or I am getting permissions + errors during the do_install task in my recipe! What is wrong? + </para> + </question> + <answer> + <para> + This situation results when a build system does + not recognize the environment variables supplied to it by + <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>. + The incident that prompted this FAQ entry involved a Makefile + that used an environment variable named + <filename>BINDIR</filename> instead of the more standard + variable <filename>bindir</filename>. + The makefile's hardcoded default value of "/usr/bin" worked + most of the time, but not for the recipe's + <filename>-native</filename> variant. + For another example, permissions errors might be caused + by a Makefile that ignores <filename>DESTDIR</filename> or uses + a different name for that environment variable. + Check the the build system to see if these kinds of + issues exist. + </para> + </answer> + </qandaentry> + +</qandaset> +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/analysis-for-package-splitting.png b/import-layers/yocto-poky/documentation/ref-manual/figures/analysis-for-package-splitting.png Binary files differnew file mode 100644 index 000000000..04f2794ea --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/analysis-for-package-splitting.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/buildhistory-web.png b/import-layers/yocto-poky/documentation/ref-manual/figures/buildhistory-web.png Binary files differnew file mode 100644 index 000000000..f6db86c97 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/buildhistory-web.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/buildhistory.png b/import-layers/yocto-poky/documentation/ref-manual/figures/buildhistory.png Binary files differnew file mode 100644 index 000000000..bd5f8a490 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/buildhistory.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/building-an-image.png b/import-layers/yocto-poky/documentation/ref-manual/figures/building-an-image.png Binary files differnew file mode 100755 index 000000000..1fbea5ab0 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/building-an-image.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/configuration-compile-autoreconf.png b/import-layers/yocto-poky/documentation/ref-manual/figures/configuration-compile-autoreconf.png Binary files differnew file mode 100644 index 000000000..a07464f04 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/configuration-compile-autoreconf.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/cross-development-toolchains.png b/import-layers/yocto-poky/documentation/ref-manual/figures/cross-development-toolchains.png Binary files differnew file mode 100644 index 000000000..d36670a19 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/cross-development-toolchains.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/define-generic.png b/import-layers/yocto-poky/documentation/ref-manual/figures/define-generic.png Binary files differnew file mode 100644 index 000000000..bd22718a5 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/define-generic.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/image-generation.png b/import-layers/yocto-poky/documentation/ref-manual/figures/image-generation.png Binary files differnew file mode 100644 index 000000000..71a48dc6f --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/image-generation.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/images.png b/import-layers/yocto-poky/documentation/ref-manual/figures/images.png Binary files differnew file mode 100644 index 000000000..d99eac1fb --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/images.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/layer-input.png b/import-layers/yocto-poky/documentation/ref-manual/figures/layer-input.png Binary files differnew file mode 100644 index 000000000..0a4f2e74f --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/layer-input.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/package-feeds.png b/import-layers/yocto-poky/documentation/ref-manual/figures/package-feeds.png Binary files differnew file mode 100644 index 000000000..37c9c3250 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/package-feeds.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/patching.png b/import-layers/yocto-poky/documentation/ref-manual/figures/patching.png Binary files differnew file mode 100644 index 000000000..8ecd01850 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/patching.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/poky-title.png b/import-layers/yocto-poky/documentation/ref-manual/figures/poky-title.png Binary files differnew file mode 100644 index 000000000..2893d8462 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/poky-title.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/sdk-generation.png b/import-layers/yocto-poky/documentation/ref-manual/figures/sdk-generation.png Binary files differnew file mode 100755 index 000000000..adbe1f4ac --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/sdk-generation.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/sdk.png b/import-layers/yocto-poky/documentation/ref-manual/figures/sdk.png Binary files differnew file mode 100644 index 000000000..5c36b7548 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/sdk.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/source-fetching.png b/import-layers/yocto-poky/documentation/ref-manual/figures/source-fetching.png Binary files differnew file mode 100644 index 000000000..26aefb50c --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/source-fetching.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/source-input.png b/import-layers/yocto-poky/documentation/ref-manual/figures/source-input.png Binary files differnew file mode 100644 index 000000000..f7515058e --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/source-input.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/user-configuration.png b/import-layers/yocto-poky/documentation/ref-manual/figures/user-configuration.png Binary files differnew file mode 100755 index 000000000..c298401fc --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/user-configuration.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/figures/yocto-environment-ref.png b/import-layers/yocto-poky/documentation/ref-manual/figures/yocto-environment-ref.png Binary files differnew file mode 100644 index 000000000..650c6c803 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/figures/yocto-environment-ref.png diff --git a/import-layers/yocto-poky/documentation/ref-manual/introduction.xml b/import-layers/yocto-poky/documentation/ref-manual/introduction.xml new file mode 100644 index 000000000..ce8fa5c65 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/introduction.xml @@ -0,0 +1,624 @@ +<!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='ref-manual-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>. + </para> + + <para> + For task-based information using the Yocto Project, see the + <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink> + and the <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>. + For Board Support Package (BSP) structure information, see the + <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. + For information on how to use a Software Development Kit, (SDK), see the + <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>. + You can find information on tracing and profiling in the + <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>. + For information on BitBake, which is the task execution tool the + OpenEmbedded build system is based on, see the + <ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual'>BitBake User Manual</ulink>. + Finally, you can also find lots of Yocto Project information 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> + Provides an overview of the components that make up the Yocto Project + followed by information about debugng images created in the Yocto Project. + </para></listitem> + <listitem><para><emphasis> + <link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>:</emphasis> + Provides a more detailed look at the Yocto Project development + environment within the context of development. + </para></listitem> + <listitem><para><emphasis> + <link linkend='technical-details'>Technical Details</link>:</emphasis> + 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='migration'>Migrating to a Newer Yocto Project Release</link>:</emphasis> + Describes release-specific information that helps you move from + one Yocto Project Release to another. + </para></listitem> + <listitem><para><emphasis> + <link linkend='ref-structure'>Directory Structure</link>:</emphasis> + 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-classes'>Classes</link>:</emphasis> + Describes the classes used in the Yocto Project.</para></listitem> + <listitem><para><emphasis> + <link linkend='ref-tasks'>Tasks</link>:</emphasis> + Describes the tasks defined by the OpenEmbedded build system. + </para></listitem> + <listitem><para><emphasis> + <link linkend='ref-qa-checks'>QA Error and Warning Messages</link>:</emphasis> + Lists and describes QA warning and error messages. + </para></listitem> + <listitem><para><emphasis> + <link linkend='ref-images'>Images</link>:</emphasis> + Describes the standard images that the Yocto Project supports. + </para></listitem> + <listitem><para><emphasis> + <link linkend='ref-features'>Features</link>:</emphasis> + 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> + Presents most variables used by the OpenEmbedded build system, which + uses 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> + Provides variable locality or context.</para></listitem> + <listitem><para><emphasis> + <link linkend='faq'>FAQ</link>:</emphasis> + 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> + 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'>Setting Up to Use the Yocto Project</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> + Currently, the Yocto Project is supported on the following + distributions: + <note> + <para> + Yocto Project releases are tested against the stable Linux + distributions in the following list. + The Yocto Project should work on other distributions but + validation is not performed against them. + </para> + + <para> + In particular, the Yocto Project does not support + and currently has no plans to support + rolling-releases or development distributions due to their + constantly changing nature. + We welcome patches and bug reports, but keep in mind that + our priority is on the supported platforms listed below. + </para> + + <para> + If you encounter problems, please go to + <ulink url='&YOCTO_BUGZILLA_URL;'>Yocto Project Bugzilla</ulink> + and submit a bug. + We are interested in hearing about your experience. + </para> + </note> + <itemizedlist> +<!-- + <listitem><para>Ubuntu 10.04</para></listitem> + <listitem><para>Ubuntu 11.10</para></listitem> + <listitem><para>Ubuntu 12.04 (LTS)</para></listitem> + <listitem><para>Ubuntu 13.10</para></listitem> --> + <listitem><para>Ubuntu 14.04 (LTS)</para></listitem> + <listitem><para>Ubuntu 14.10</para></listitem> + <listitem><para>Ubuntu 15.04</para></listitem> + <listitem><para>Ubuntu 15.10</para></listitem> +<!-- <listitem><para>Fedora 16 (Verne)</para></listitem> + <listitem><para>Fedora 17 (Spherical)</para></listitem> + <listitem><para>Fedora release 19 (Schrödinger's Cat)</para></listitem> + <listitem><para>Fedora release 20 (Heisenbug)</para></listitem> --> + <listitem><para>Fedora release 21</para></listitem> + <listitem><para>Fedora release 22</para></listitem> +<!-- <listitem><para>CentOS release 5.6 (Final)</para></listitem> + <listitem><para>CentOS release 5.7 (Final)</para></listitem> + <listitem><para>CentOS release 5.8 (Final)</para></listitem> + <listitem><para>CentOS release 6.3 (Final)</para></listitem> --> + <listitem><para>CentOS release 6.x</para></listitem> + <listitem><para>CentOS release 7.x</para></listitem> +<!-- <listitem><para>Debian GNU/Linux 6.0 (Squeeze)</para></listitem> --> + <listitem><para>Debian GNU/Linux 7.x (Wheezy)</para></listitem> + <listitem><para>Debian GNU/Linux 8.x (Jessie)</para></listitem> +<!-- <listitem><para>Debian GNU/Linux 7.1 (Wheezy)</para></listitem> + <listitem><para>Debian GNU/Linux 7.2 (Wheezy)</para></listitem> + <listitem><para>Debian GNU/Linux 7.3 (Wheezy)</para></listitem> + <listitem><para>Debian GNU/Linux 7.4 (Wheezy)</para></listitem> + <listitem><para>Debian GNU/Linux 7.5 (Wheezy)</para></listitem> + <listitem><para>Debian GNU/Linux 7.6 (Wheezy)</para></listitem> --> +<!-- <listitem><para>openSUSE 11.4</para></listitem> + <listitem><para>openSUSE 12.1</para></listitem> + <listitem><para>openSUSE 12.2</para></listitem> + <listitem><para>openSUSE 12.3</para></listitem> + <listitem><para>openSUSE 13.1</para></listitem> --> + <listitem><para>openSUSE 13.2</para></listitem> + </itemizedlist> + </para> + + <note> + While the Yocto Project Team attempts to ensure all Yocto Project + releases are one hundred percent compatible with each officially + supported Linux distribution, instances might exist where you + encounter a problem while using the Yocto Project on a specific + distribution. + </note> + </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 according to + Linux distribution and function. + </para> + + <section id='ubuntu-packages'> + <title>Ubuntu and Debian</title> + + <para> + The following list shows the required packages by function + given a supported Ubuntu or Debian Linux distribution: + <note> + If your build system has the + <filename>oss4-dev</filename> package installed, you + might experience QEMU build failures due to the package + installing its own custom + <filename>/usr/include/linux/soundcard.h</filename> on + the Debian system. + If you run into this situation, either of the following + solutions exist: + <literallayout class='monospaced'> + $ sudo apt-get build-dep qemu + $ sudo apt-get remove oss4-dev + </literallayout> + </note> + <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 and Eclipse Plug-In Extras:</emphasis> + Packages recommended if the host system has graphics + support or if you are going to use the Eclipse + IDE: + <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 dblatex xmlto + </literallayout></para></listitem> + <listitem><para><emphasis>SDK Installer Extras:</emphasis> + Packages needed if you are going to be using the + the standard or extensible SDK: + <literallayout class='monospaced'> + $ sudo apt-get install autoconf automake libtool libglib2.0-dev libarchive-dev + </literallayout></para></listitem> + <listitem><para><emphasis>OpenEmbedded Self-Test (<filename>oe-selftest</filename>):</emphasis> + Packages needed if you are going to run + <filename>oe-selftest</filename>: + <literallayout class='monospaced'> + $ sudo apt-get install python-git + </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 dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; + </literallayout></para></listitem> + <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis> + Packages recommended if the host system has graphics + support or if you are going to use the Eclipse + IDE: + <literallayout class='monospaced'> + $ sudo dnf 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 dnf install make docbook-style-dsssl docbook-style-xsl \ + docbook-dtds docbook-utils fop libxslt dblatex xmlto xsltproc + </literallayout></para></listitem> + <listitem><para><emphasis>SDK Installer Extras:</emphasis> + Packages needed if you are going to be using the + standard or extensible SDK: + <literallayout class='monospaced'> + $ sudo dnf install autoconf automake libtool glib2-devel libarchive-devel + </literallayout></para></listitem> + <listitem><para><emphasis>OpenEmbedded Self-Test (<filename>oe-selftest</filename>):</emphasis> + Packages needed if you are going to run + <filename>oe-selftest</filename>: + <literallayout class='monospaced'> + $ sudo dnf install GitPython + </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 and Eclipse Plug-In Extras:</emphasis> + Packages recommended if the host system has graphics + support or if you are going to use the Eclipse + IDE: + <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 dblatex xmlto + </literallayout></para></listitem> + <listitem><para><emphasis>SDK Installer Extras:</emphasis> + Packages needed if you are going to be using the + standard or extensible SDK: + <literallayout class='monospaced'> + $ sudo zypper install autoconf automake libtool glib2-devel libarchive-devel + </literallayout></para></listitem> + <listitem><para><emphasis>OpenEmbedded Self-Test (<filename>oe-selftest</filename>):</emphasis> + Packages needed if you are going to run + <filename>oe-selftest</filename>: + <literallayout class='monospaced'> + $ sudo zypper install python-GitPython + </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: + <note> + For CentOS 6.x, some of the versions of the components + provided by the distribution are too old (e.g. Git, Python, + and tar). + It is recommended that you install the buildtools in order + to provide versions that will work with the OpenEmbedded + build system. + For information on how to install the buildtools tarball, + see the + "<link linkend='required-git-tar-and-python-versions'>Required Git, Tar, and Python Versions</link>" + section. + </note> + <itemizedlist> + <listitem><para><emphasis>Essentials:</emphasis> + Packages needed to build an image for a headless + system: + <literallayout class='monospaced'> + $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL; + </literallayout></para></listitem> + <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis> + Packages recommended if the host system has graphics + support or if you are going to use the Eclipse + IDE: + <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 dblatex xmlto xsltproc + </literallayout></para></listitem> + <listitem><para><emphasis>SDK Installer Extras:</emphasis> + Packages needed if you are going to be using the + standard or extensible SDK: + <literallayout class='monospaced'> + $ sudo yum install autoconf automake libtool glib2-devel libarchive-devel + </literallayout></para></listitem> + <listitem><para><emphasis>OpenEmbedded Self-Test (<filename>oe-selftest</filename>):</emphasis> + Packages needed if you are going to run + <filename>oe-selftest</filename>: + <literallayout class='monospaced'> + $ sudo yum install GitPython + </literallayout> + </para></listitem> + </itemizedlist> + </para> + </section> + </section> + + <section id='required-git-tar-and-python-versions'> + <title>Required Git, tar, and Python Versions</title> + + <para> + In order to use the build system, your host development system + must meet the following version requirements for Git, tar, and + Python: + <itemizedlist> + <listitem><para>Git 1.8.3.1 or greater</para></listitem> + <listitem><para>tar 1.24 or greater</para></listitem> + <listitem><para>Python 2.7.3 or greater not including + Python 3.x, which is not supported.</para></listitem> + </itemizedlist> + </para> + + <para> + If your host development system does not meet all these requirements, + you can resolve this by installing a <filename>buildtools</filename> + tarball that contains these tools. + You can get the tarball one of two ways: download a pre-built + tarball or use BitBake to build the tarball. + </para> + + <section id='downloading-a-pre-built-buildtools-tarball'> + <title>Downloading a Pre-Built <filename>buildtools</filename> Tarball</title> + + <para> + Downloading and running a pre-built buildtools installer is + the easiest of the two methods by which you can get these tools: + <orderedlist> + <listitem><para> + Locate and download the <filename>*.sh</filename> at + <ulink url='&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;/buildtools/'></ulink>. + </para></listitem> + <listitem><para> + Execute the installation script. + Here is an example: + <literallayout class='monospaced'> + $ sh poky-glibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh + </literallayout> + During execution, a prompt appears that allows you to + choose the installation directory. + For example, you could choose the following: + <literallayout class='monospaced'> + /home/<replaceable>your-username</replaceable>/buildtools + </literallayout> + </para></listitem> + <listitem><para> + Source the tools environment setup script by using a + command like the following: + <literallayout class='monospaced'> + $ source /home/<replaceable>your_username</replaceable>/buildtools/environment-setup-i586-poky-linux + </literallayout> + Of course, you need to supply your installation directory and be + sure to use the right file (i.e. i585 or x86-64). + </para> + <para> + After you have sourced the setup script, + the tools are added to <filename>PATH</filename> + and any other environment variables required to run the + tools are initialized. + The results are working versions versions of Git, tar, + Python and <filename>chrpath</filename>. + </para></listitem> + </orderedlist> + </para> + </section> + + <section id='building-your-own-buildtools-tarball'> + <title>Building Your Own <filename>buildtools</filename> Tarball</title> + + <para> + Building and running your own buildtools installer applies + only when you have a build host that can already run BitBake. + In this case, you use that machine to build the + <filename>.sh</filename> file and then + take steps to transfer and run it on a + machine that does not meet the minimal Git, tar, and Python + requirements. + </para> + + <para> + Here are the steps to take to build and run your own + buildtools installer: + <orderedlist> + <listitem><para> + On the machine that is able to run BitBake, + be sure you have set up your build environment with + the setup script + (<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). + </para></listitem> + <listitem><para> + Run the BitBake command to build the tarball: + <literallayout class='monospaced'> + $ bitbake buildtools-tarball + </literallayout> + <note> + The + <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link> + variable in your <filename>local.conf</filename> file + determines whether you build tools for a 32-bit + or 64-bit system. + </note> + Once the build completes, you can find the + <filename>.sh</filename> file that installs + the tools in the <filename>tmp/deploy/sdk</filename> + subdirectory of the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + The installer file has the string "buildtools" + in the name. + </para></listitem> + <listitem><para> + Transfer the <filename>.sh</filename> file from the + build host to the machine that does not meet the + Git, tar, or Python requirements. + </para></listitem> + <listitem><para> + On the machine that does not meet the requirements, + run the <filename>.sh</filename> file + to install the tools. + Here is an example: + <literallayout class='monospaced'> + $ sh poky-glibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh + </literallayout> + During execution, a prompt appears that allows you to + choose the installation directory. + For example, you could choose the following: + <literallayout class='monospaced'> + /home/<replaceable>your_username</replaceable>/buildtools + </literallayout> + </para></listitem> + <listitem><para> + Source the tools environment setup script by using a + command like the following: + <literallayout class='monospaced'> + $ source /home/<replaceable>your_username</replaceable>/buildtools/environment-setup-i586-poky-linux + </literallayout> + Of course, you need to supply your installation directory and be + sure to use the right file (i.e. i585 or x86-64). + </para> + <para> + After you have sourced the setup script, + the tools are added to <filename>PATH</filename> + and any other environment variables required to run the + tools are initialized. + The results are working versions versions of Git, tar, + Python and <filename>chrpath</filename>. + </para></listitem> + </orderedlist> + </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>Source Repositories:</emphasis> + Working from a copy of the upstream + <filename>poky</filename> repository is the + preferred method for obtaining and using a Yocto Project + release. + You can view the Yocto Project Source Repositories at + <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. + In particular, you can find the + <filename>poky</filename> repository at + <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/'></ulink>. + </para></listitem> + <listitem><para><emphasis>Releases:</emphasis> Stable, tested + releases are available as tarballs through + <ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem> + <listitem><para><emphasis>Nightly Builds:</emphasis> These + tarball releases are available at + <ulink url='&YOCTO_AB_NIGHTLY_URL;'/>. + These builds include Yocto Project releases, SDK installation + scripts, and experimental builds. + </para></listitem> + <listitem><para><emphasis>Yocto Project Website:</emphasis> You can + find tarball 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 cloning a copy of the upstream + <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>poky</ulink> Git repository. + For information on how to do this, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>" + section in the Yocto Project Development Manual. + </para> +</section> + +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/migration.xml b/import-layers/yocto-poky/documentation/ref-manual/migration.xml new file mode 100644 index 000000000..e6c0aa36b --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/migration.xml @@ -0,0 +1,3286 @@ +<!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='migration'> +<title>Migrating to a Newer Yocto Project Release</title> + + <para> + This chapter provides information you can use to migrate work to a + newer Yocto Project release. You can find the same information in the + release notes for a given release. + </para> + +<section id='general-migration-considerations'> + <title>General Migration Considerations</title> + + <para> + Some considerations are not tied to a specific Yocto Project + release. + This section presents information you should consider when + migrating to any new Yocto Project release. + <itemizedlist> + <listitem><para><emphasis>Dealing with Customized Recipes</emphasis>: + Issues could arise if you take older recipes that contain + customizations and simply copy them forward expecting them + to work after you migrate to new Yocto Project metadata. + For example, suppose you have a recipe in your layer that is + a customized version of a core recipe copied from the earlier + release, rather than through the use of an append file. + When you migrate to a newer version of Yocto Project, the + metadata (e.g. perhaps an include file used by the recipe) + could have changed in a way that would break the build. + Say, for example, a function is removed from an include file + and the customized recipe tries to call that function. + </para> + + <para>You could "forward-port" all your customizations in your + recipe so that everything works for the new release. + However, this is not the optimal solution as you would have + to repeat this process with each new release if changes + occur that give rise to problems.</para> + + <para>The better solution (where practical) is to use append + files (<filename>*.bbappend</filename>) to capture any + customizations you want to make to a recipe. + Doing so, isolates your changes from the main recipe making + them much more manageable. + However, sometimes it is not practical to use an append + file. + A good example of this is when introducing a newer or older + version of a recipe in another layer.</para> + </listitem> + <listitem><para><emphasis>Updating Append Files</emphasis>: + Since append files generally only contain your customizations, + they often do not need to be adjusted for new releases. + However, if the <filename>.bbappend</filename> file is + specific to a particular version of the recipe (i.e. its + name does not use the % wildcard) and the version of the + recipe to which it is appending has changed, then you will + at a minimum need to rename the append file to match the + name of the recipe file. + A mismatch between an append file and its corresponding + recipe file (<filename>.bb</filename>) will + trigger an error during parsing.</para> + <para>Depending on the type of customization the append file + applies, other incompatibilities might occur when you + upgrade. + For example, if your append file applies a patch and the + recipe to which it is appending is updated to a newer + version, the patch might no longer apply. + If this is the case and assuming the patch is still needed, + you must modify the patch file so that it does apply. + </para></listitem> + </itemizedlist> + </para> +</section> + +<section id='moving-to-the-yocto-project-1.3-release'> + <title>Moving to the Yocto Project 1.3 Release</title> + + <para> + This section provides migration information for moving to the + Yocto Project 1.3 Release from the prior release. + </para> + + <section id='1.3-local-configuration'> + <title>Local Configuration</title> + + <para> + Differences include changes for + <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> + and <filename>bblayers.conf</filename>. + </para> + + <section id='migration-1.3-sstate-mirrors'> + <title>SSTATE_MIRRORS</title> + + <para> + The shared state cache (sstate-cache), as pointed to by + <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>, + by default now has two-character subdirectories to prevent + issues arising from too many files in the same directory. + Also, native sstate-cache packages, which are built to run + on the host system, will go into a subdirectory named using + the distro ID string. + If you copy the newly structured sstate-cache to a mirror + location (either local or remote) and then point to it in + <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>, + you need to append "PATH" to the end of the mirror URL so that + the path used by BitBake before the mirror substitution is + appended to the path used to access the mirror. + Here is an example: + <literallayout class='monospaced'> + SSTATE_MIRRORS = "file://.* http://<replaceable>someserver</replaceable>.tld/share/sstate/PATH" + </literallayout> + </para> + </section> + + <section id='migration-1.3-bblayers-conf'> + <title>bblayers.conf</title> + + <para> + The <filename>meta-yocto</filename> layer consists of two parts + that correspond to the Poky reference distribution and the + reference hardware Board Support Packages (BSPs), respectively: + <filename>meta-yocto</filename> and + <filename>meta-yocto-bsp</filename>. + When running BitBake for the first time after upgrading, + your <filename>conf/bblayers.conf</filename> file will be + updated to handle this change and you will be asked to + re-run or restart for the changes to take effect. + </para> + </section> + </section> + + <section id='1.3-recipes'> + <title>Recipes</title> + + <para> + Differences include changes for the following: + <itemizedlist> + <listitem><para>Python function whitespace</para></listitem> + <listitem><para><filename>proto=</filename> in <filename>SRC_URI</filename></para></listitem> + <listitem><para><filename>nativesdk</filename></para></listitem> + <listitem><para>Task recipes</para></listitem> + <listitem><para><filename>IMAGE_FEATURES</filename></para></listitem> + <listitem><para>Removed recipes</para></listitem> + </itemizedlist> + </para> + + <section id='migration-1.3-python-function-whitespace'> + <title>Python Function Whitespace</title> + + <para> + All Python functions must now use four spaces for indentation. + Previously, an inconsistent mix of spaces and tabs existed, + which made extending these functions using + <filename>_append</filename> or <filename>_prepend</filename> + complicated given that Python treats whitespace as + syntactically significant. + If you are defining or extending any Python functions (e.g. + <filename>populate_packages</filename>, <filename>do_unpack</filename>, + <filename>do_patch</filename> and so forth) in custom recipes + or classes, you need to ensure you are using consistent + four-space indentation. + </para> + </section> + + <section id='migration-1.3-proto=-in-src-uri'> + <title>proto= in SRC_URI</title> + + <para> + Any use of <filename>proto=</filename> in + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + needs to be changed to <filename>protocol=</filename>. + In particular, this applies to the following URIs: + <itemizedlist> + <listitem><para><filename>svn://</filename></para></listitem> + <listitem><para><filename>bzr://</filename></para></listitem> + <listitem><para><filename>hg://</filename></para></listitem> + <listitem><para><filename>osc://</filename></para></listitem> + </itemizedlist> + Other URIs were already using <filename>protocol=</filename>. + This change improves consistency. + </para> + </section> + + <section id='migration-1.3-nativesdk'> + <title>nativesdk</title> + + <para> + The suffix <filename>nativesdk</filename> is now implemented + as a prefix, which simplifies a lot of the packaging code for + <filename>nativesdk</filename> recipes. + All custom <filename>nativesdk</filename> recipes, which are + relocatable packages that are native to + <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>, + and any references need to be updated to use + <filename>nativesdk-*</filename> instead of + <filename>*-nativesdk</filename>. + </para> + </section> + + <section id='migration-1.3-task-recipes'> + <title>Task Recipes</title> + + <para> + "Task" recipes are now known as "Package groups" and have + been renamed from <filename>task-*.bb</filename> to + <filename>packagegroup-*.bb</filename>. + Existing references to the previous <filename>task-*</filename> + names should work in most cases as there is an automatic + upgrade path for most packages. + However, you should update references in your own recipes and + configurations as they could be removed in future releases. + You should also rename any custom <filename>task-*</filename> + recipes to <filename>packagegroup-*</filename>, and change + them to inherit <filename>packagegroup</filename> instead of + <filename>task</filename>, as well as taking the opportunity + to remove anything now handled by + <filename>packagegroup.bbclass</filename>, such as providing + <filename>-dev</filename> and <filename>-dbg</filename> + packages, setting + <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>, + and so forth. + See the + "<link linkend='ref-classes-packagegroup'><filename>packagegroup.bbclass</filename></link>" + section for further details. + </para> + </section> + + <section id='migration-1.3-image-features'> + <title>IMAGE_FEATURES</title> + + <para> + Image recipes that previously included "apps-console-core" + in <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> + should now include "splash" instead to enable the boot-up + splash screen. + Retaining "apps-console-core" will still include the splash + screen but generates a warning. + The "apps-x11-core" and "apps-x11-games" + <filename>IMAGE_FEATURES</filename> features have been removed. + </para> + </section> + + <section id='migration-1.3-removed-recipes'> + <title>Removed Recipes</title> + + <para> + The following recipes have been removed. + For most of them, it is unlikely that you would have any + references to them in your own + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>. + However, you should check your metadata against this list to be sure: + <itemizedlist> + <listitem><para><emphasis><filename>libx11-trim</filename></emphasis>: + Replaced by <filename>libx11</filename>, which has a negligible + size difference with modern Xorg.</para></listitem> + <listitem><para><emphasis><filename>xserver-xorg-lite</filename></emphasis>: + Use <filename>xserver-xorg</filename>, which has a negligible + size difference when DRI and GLX modules are not installed.</para></listitem> + <listitem><para><emphasis><filename>xserver-kdrive</filename></emphasis>: + Effectively unmaintained for many years.</para></listitem> + <listitem><para><emphasis><filename>mesa-xlib</filename></emphasis>: + No longer serves any purpose.</para></listitem> + <listitem><para><emphasis><filename>galago</filename></emphasis>: + Replaced by telepathy.</para></listitem> + <listitem><para><emphasis><filename>gail</filename></emphasis>: + Functionality was integrated into GTK+ 2.13.</para></listitem> + <listitem><para><emphasis><filename>eggdbus</filename></emphasis>: + No longer needed.</para></listitem> + <listitem><para><emphasis><filename>gcc-*-intermediate</filename></emphasis>: + The build has been restructured to avoid the need for + this step.</para></listitem> + <listitem><para><emphasis><filename>libgsmd</filename></emphasis>: + Unmaintained for many years. + Functionality now provided by + <filename>ofono</filename> instead.</para></listitem> + <listitem><para><emphasis>contacts, dates, tasks, eds-tools</emphasis>: + Largely unmaintained PIM application suite. + It has been moved to <filename>meta-gnome</filename> + in <filename>meta-openembedded</filename>.</para></listitem> + </itemizedlist> + In addition to the previously listed changes, the + <filename>meta-demoapps</filename> directory has also been removed + because the recipes in it were not being maintained and many + had become obsolete or broken. + Additionally, these recipes were not parsed in the default configuration. + Many of these recipes are already provided in an updated and + maintained form within the OpenEmbedded community layers such as + <filename>meta-oe</filename> and <filename>meta-gnome</filename>. + For the remainder, you can now find them in the + <filename>meta-extras</filename> repository, which is in the + Yocto Project + <ulink url='&YOCTO_DOCS_DEV_URL;#source-repositories'>Source Repositories</ulink>. + </para> + </section> + </section> + + <section id='1.3-linux-kernel-naming'> + <title>Linux Kernel Naming</title> + + <para> + The naming scheme for kernel output binaries has been changed to + now include + <link linkend='var-PE'><filename>PE</filename></link> as part of the + filename: + <literallayout class='monospaced'> + KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}" + </literallayout> + </para> + + <para> + Because the <filename>PE</filename> variable is not set by default, + these binary files could result with names that include two dash + characters. + Here is an example: + <literallayout class='monospaced'> + bzImage--3.10.9+git0+cd502a8814_7144bcc4b8-r0-qemux86-64-20130830085431.bin + </literallayout> + </para> + </section> +</section> + +<section id='moving-to-the-yocto-project-1.4-release'> + <title>Moving to the Yocto Project 1.4 Release</title> + + <para> + This section provides migration information for moving to the + Yocto Project 1.4 Release from the prior release. + </para> + + <section id='migration-1.4-bitbake'> + <title>BitBake</title> + + <para> + Differences include the following: + <itemizedlist> + <listitem><para><emphasis>Comment Continuation:</emphasis> + If a comment ends with a line continuation (\) character, + then the next line must also be a comment. + Any instance where this is not the case, now triggers + a warning. + You must either remove the continuation character, or be + sure the next line is a comment. + </para></listitem> + <listitem><para><emphasis>Package Name Overrides:</emphasis> + The runtime package specific variables + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, + <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, + <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, + <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>, + <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, + <link linkend='var-FILES'><filename>FILES</filename></link>, + <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>, + and the pre, post, install, and uninstall script functions + <filename>pkg_preinst</filename>, + <filename>pkg_postinst</filename>, + <filename>pkg_prerm</filename>, and + <filename>pkg_postrm</filename> should always have a + package name override. + For example, use <filename>RDEPENDS_${PN}</filename> for + the main package instead of <filename>RDEPENDS</filename>. + BitBake uses more strict checks when it parses recipes. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.4-build-behavior'> + <title>Build Behavior</title> + + <para> + Differences include the following: + <itemizedlist> + <listitem><para><emphasis>Shared State Code:</emphasis> + The shared state code has been optimized to avoid running + unnecessary tasks. + For example, the following no longer populates the target + sysroot since that is not necessary: + <literallayout class='monospaced'> + $ bitbake -c rootfs <replaceable>some-image</replaceable> + </literallayout> + Instead, the system just needs to extract the output + package contents, re-create the packages, and construct + the root filesystem. + This change is unlikely to cause any problems unless + you have missing declared dependencies. + </para></listitem> + <listitem><para><emphasis>Scanning Directory Names:</emphasis> + When scanning for files in + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>, + the build system now uses + <link linkend='var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></link> + instead of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> + for the directory names. + In general, the values previously in + <filename>OVERRIDES</filename> are now in + <filename>FILESOVERRIDES</filename> as well. + However, if you relied upon an additional value + you previously added to <filename>OVERRIDES</filename>, + you might now need to add it to + <filename>FILESOVERRIDES</filename> unless you are already + adding it through the + <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link> + or <link linkend='var-DISTROOVERRIDES'><filename>DISTROOVERRIDES</filename></link> + variables, as appropriate. + For more related changes, see the + "<link linkend='migration-1.4-variables'>Variables</link>" + section. + </para></listitem> + </itemizedlist> + </para> + </section> + + + <section id='migration-1.4-proxies-and-fetching-source'> + <title>Proxies and Fetching Source</title> + + <para> + A new <filename>oe-git-proxy</filename> script has been added to + replace previous methods of handling proxies and fetching source + from Git. + See the <filename>meta-yocto/conf/site.conf.sample</filename> file + for information on how to use this script. + </para> + </section> + + <section id='migration-1.4-custom-interfaces-file-netbase-change'> + <title>Custom Interfaces File (netbase change)</title> + + <para> + If you have created your own custom + <filename>etc/network/interfaces</filename> file by creating + an append file for the <filename>netbase</filename> recipe, + you now need to create an append file for the + <filename>init-ifupdown</filename> recipe instead, which you can + find in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + at <filename>meta/recipes-core/init-ifupdown</filename>. + For information on how to use append files, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>" + in the Yocto Project Development Manual. + </para> + </section> + + <section id='migration-1.4-remote-debugging'> + <title>Remote Debugging</title> + + <para> + Support for remote debugging with the Eclipse IDE is now + separated into an image feature + (<filename>eclipse-debug</filename>) that corresponds to the + <filename>packagegroup-core-eclipse-debug</filename> package group. + Previously, the debugging feature was included through the + <filename>tools-debug</filename> image feature, which corresponds + to the <filename>packagegroup-core-tools-debug</filename> + package group. + </para> + </section> + + <section id='migration-1.4-variables'> + <title>Variables</title> + + <para> + The following variables have changed: + <itemizedlist> + <listitem><para><emphasis><filename>SANITY_TESTED_DISTROS</filename>:</emphasis> + This variable now uses a distribution ID, which is composed + of the host distributor ID followed by the release. + Previously, + <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link> + was composed of the description field. + For example, "Ubuntu 12.10" becomes "Ubuntu-12.10". + You do not need to worry about this change if you are not + specifically setting this variable, or if you are + specifically setting it to "". + </para></listitem> + <listitem><para><emphasis><filename>SRC_URI</filename>:</emphasis> + The <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>, + <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>, + <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>, + and <filename>FILE_DIRNAME</filename> directories have been + dropped from the default value of the + <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> + variable, which is used as the search path for finding files + referred to in + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>. + If you have a recipe that relied upon these directories, + which would be unusual, then you will need to add the + appropriate paths within the recipe or, alternatively, + rearrange the files. + The most common locations are still covered by + <filename>${BP}</filename>, <filename>${BPN}</filename>, + and "files", which all remain in the default value of + <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-target-package-management-with-rpm'> + <title>Target Package Management with RPM</title> + + <para> + If runtime package management is enabled and the RPM backend + is selected, Smart is now installed for package download, dependency + resolution, and upgrades instead of Zypper. + For more information on how to use Smart, run the following command + on the target: + <literallayout class='monospaced'> + smart --help + </literallayout> + </para> + </section> + + <section id='migration-1.4-recipes-moved'> + <title>Recipes Moved</title> + + <para> + The following recipes were moved from their previous locations + because they are no longer used by anything in + the OpenEmbedded-Core: + <itemizedlist> + <listitem><para><emphasis><filename>clutter-box2d</filename>:</emphasis> + Now resides in the <filename>meta-oe</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>evolution-data-server</filename>:</emphasis> + Now resides in the <filename>meta-gnome</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>gthumb</filename>:</emphasis> + Now resides in the <filename>meta-gnome</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>gtkhtml2</filename>:</emphasis> + Now resides in the <filename>meta-oe</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>gupnp</filename>:</emphasis> + Now resides in the <filename>meta-multimedia</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>gypsy</filename>:</emphasis> + Now resides in the <filename>meta-oe</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>libcanberra</filename>:</emphasis> + Now resides in the <filename>meta-gnome</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>libgdata</filename>:</emphasis> + Now resides in the <filename>meta-gnome</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>libmusicbrainz</filename>:</emphasis> + Now resides in the <filename>meta-multimedia</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>metacity</filename>:</emphasis> + Now resides in the <filename>meta-gnome</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>polkit</filename>:</emphasis> + Now resides in the <filename>meta-oe</filename> layer. + </para></listitem> + <listitem><para><emphasis><filename>zeroconf</filename>:</emphasis> + Now resides in the <filename>meta-networking</filename> layer. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.4-removals-and-renames'> + <title>Removals and Renames</title> + + <para> + The following list shows what has been removed or renamed: + <itemizedlist> + <listitem><para><emphasis><filename>evieext</filename>:</emphasis> + Removed because it has been removed from + <filename>xserver</filename> since 2008. + </para></listitem> + <listitem><para><emphasis>Gtk+ DirectFB:</emphasis> + Removed support because upstream Gtk+ no longer supports it + as of version 2.18. + </para></listitem> + <listitem><para><emphasis><filename>libxfontcache / xfontcacheproto</filename>:</emphasis> + Removed because they were removed from the Xorg server in 2008. + </para></listitem> + <listitem><para><emphasis><filename>libxp / libxprintapputil / libxprintutil / printproto</filename>:</emphasis> + Removed because the XPrint server was removed from + Xorg in 2008. + </para></listitem> + <listitem><para><emphasis><filename>libxtrap / xtrapproto</filename>:</emphasis> + Removed because their functionality was broken upstream. + </para></listitem> + <listitem><para><emphasis>linux-yocto 3.0 kernel:</emphasis> + Removed with linux-yocto 3.8 kernel being added. + The linux-yocto 3.2 and linux-yocto 3.4 kernels remain + as part of the release. + </para></listitem> + <listitem><para><emphasis><filename>lsbsetup</filename>:</emphasis> + Removed with functionality now provided by + <filename>lsbtest</filename>. + </para></listitem> + <listitem><para><emphasis><filename>matchbox-stroke</filename>:</emphasis> + Removed because it was never more than a proof-of-concept. + </para></listitem> + <listitem><para><emphasis><filename>matchbox-wm-2 / matchbox-theme-sato-2</filename>:</emphasis> + Removed because they are not maintained. + However, <filename>matchbox-wm</filename> and + <filename>matchbox-theme-sato</filename> are still + provided. + </para></listitem> + <listitem><para><emphasis><filename>mesa-dri</filename>:</emphasis> + Renamed to <filename>mesa</filename>. + </para></listitem> + <listitem><para><emphasis><filename>mesa-xlib</filename>:</emphasis> + Removed because it was no longer useful. + </para></listitem> + <listitem><para><emphasis><filename>mutter</filename>:</emphasis> + Removed because nothing ever uses it and the recipe is + very old. + </para></listitem> + <listitem><para><emphasis><filename>orinoco-conf</filename>:</emphasis> + Removed because it has become obsolete. + </para></listitem> + <listitem><para><emphasis><filename>update-modules</filename>:</emphasis> + Removed because it is no longer used. + The kernel module <filename>postinstall</filename> and + <filename>postrm</filename> scripts can now do the same + task without the use of this script. + </para></listitem> + <listitem><para><emphasis><filename>web</filename>:</emphasis> + Removed because it is not maintained. Superseded by + <filename>web-webkit</filename>. + </para></listitem> + <listitem><para><emphasis><filename>xf86bigfontproto</filename>:</emphasis> + Removed because upstream it has been disabled by default + since 2007. + Nothing uses <filename>xf86bigfontproto</filename>. + </para></listitem> + <listitem><para><emphasis><filename>xf86rushproto</filename>:</emphasis> + Removed because its dependency in + <filename>xserver</filename> was spurious and it was + removed in 2005. + </para></listitem> + <listitem><para><emphasis><filename>zypper / libzypp / sat-solver</filename>:</emphasis> + Removed and been functionally replaced with Smart + (<filename>python-smartpm</filename>) when RPM packaging + is used and package management is enabled on the target. + </para></listitem> + </itemizedlist> + </para> + </section> +</section> + +<section id='moving-to-the-yocto-project-1.5-release'> + <title>Moving to the Yocto Project 1.5 Release</title> + + <para> + This section provides migration information for moving to the + Yocto Project 1.5 Release from the prior release. + </para> + + <section id='migration-1.5-host-dependency-changes'> + <title>Host Dependency Changes</title> + + <para> + The OpenEmbedded build system now has some additional requirements + on the host system: + <itemizedlist> + <listitem><para>Python 2.7.3+</para></listitem> + <listitem><para>Tar 1.24+</para></listitem> + <listitem><para>Git 1.7.8+</para></listitem> + <listitem><para>Patched version of Make if you are using + 3.82. + Most distributions that provide Make 3.82 use the patched + version.</para></listitem> + </itemizedlist> + If the Linux distribution you are using on your build host + does not provide packages for these, you can install and use + the Buildtools tarball, which provides an SDK-like environment + containing them. + </para> + + <para> + For more information on this requirement, see the + "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" + section. + </para> + </section> + + <section id='migration-1.5-atom-pc-bsp'> + <title><filename>atom-pc</filename> Board Support Package (BSP)</title> + + <para> + The <filename>atom-pc</filename> hardware reference BSP has been + replaced by a <filename>genericx86</filename> BSP. + This BSP is not necessarily guaranteed to work on all x86 + hardware, but it will run on a wider range of systems than the + <filename>atom-pc</filename> did. + <note> + Additionally, a <filename>genericx86-64</filename> BSP has + been added for 64-bit Atom systems. + </note> + </para> + </section> + + <section id='migration-1.5-bitbake'> + <title>BitBake</title> + + <para> + The following changes have been made that relate to BitBake: + <itemizedlist> + <listitem><para> + BitBake now supports a <filename>_remove</filename> + operator. + The addition of this operator means you will have to + rename any items in recipe space (functions, variables) + whose names currently contain + <filename>_remove_</filename> or end with + <filename>_remove</filename> to avoid unexpected behavior. + </para></listitem> + <listitem><para> + BitBake's global method pool has been removed. + This method is not particularly useful and led to clashes + between recipes containing functions that had the + same name.</para></listitem> + <listitem><para> + The "none" server backend has been removed. + The "process" server backend has been serving well as the + default for a long time now.</para></listitem> + <listitem><para> + The <filename>bitbake-runtask</filename> script has been + removed.</para></listitem> + <listitem><para> + <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename> + and + <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename> + are no longer added to + <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> + by default in <filename>bitbake.conf</filename>. + These version-specific <filename>PROVIDES</filename> + items were seldom used. + Attempting to use them could result in two versions being + built simultaneously rather than just one version due to + the way BitBake resolves dependencies.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.5-qa-warnings'> + <title>QA Warnings</title> + + <para> + The following changes have been made to the package QA checks: + <itemizedlist> + <listitem><para> + If you have customized + <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link> + or <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> + values in your configuration, check that they contain all of + the issues that you wish to be reported. + Previous Yocto Project versions contained a bug that meant + that any item not mentioned in <filename>ERROR_QA</filename> + or <filename>WARN_QA</filename> would be treated as a + warning. + Consequently, several important items were not already in + the default value of <filename>WARN_QA</filename>. + All of the possible QA checks are now documented in the + "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" + section.</para></listitem> + <listitem><para> + An additional QA check has been added to check if + <filename>/usr/share/info/dir</filename> is being installed. + Your recipe should delete this file within + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + if "make install" is installing it. + </para></listitem> + <listitem><para> + If you are using the buildhistory class, the check for the + package version going backwards is now controlled using a + standard QA check. + Thus, if you have customized your + <filename>ERROR_QA</filename> or + <filename>WARN_QA</filename> values and still wish to have + this check performed, you should add + "version-going-backwards" to your value for one or the + other variables depending on how you wish it to be handled. + See the documented QA checks in the + "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" + section. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.5-directory-layout-changes'> + <title>Directory Layout Changes</title> + + <para> + The following directory changes exist: + <itemizedlist> + <listitem><para> + Output SDK installer files are now named to include the + image name and tuning architecture through the + <link linkend='var-SDK_NAME'><filename>SDK_NAME</filename></link> + variable.</para></listitem> + <listitem><para> + Images and related files are now installed into a directory + that is specific to the machine, instead of a parent + directory containing output files for multiple machines. + The + <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> + variable continues to point to the directory containing + images for the current + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + and should be used anywhere there is a need to refer to + this directory. + The <filename>runqemu</filename> script now uses this + variable to find images and kernel binaries and will use + BitBake to determine the directory. + Alternatively, you can set the + <filename>DEPLOY_DIR_IMAGE</filename> variable in the + external environment.</para></listitem> + <listitem><para> + When buildhistory is enabled, its output is now written + under the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + rather than + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>. + Doing so makes it easier to delete + <filename>TMPDIR</filename> and preserve the build history. + Additionally, data for produced SDKs is now split by + <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link>. + </para></listitem> + <listitem><para> + The <filename>pkgdata</filename> directory produced as + part of the packaging process has been collapsed into a + single machine-specific directory. + This directory is located under + <filename>sysroots</filename> and uses a machine-specific + name (i.e. + <filename>tmp/sysroots/<replaceable>machine</replaceable>/pkgdata</filename>). + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.5-shortened-git-srcrev-values'> + <title>Shortened Git <filename>SRCREV</filename> Values</title> + + <para> + BitBake will now shorten revisions from Git repositories from the + normal 40 characters down to 10 characters within + <link linkend='var-SRCPV'><filename>SRCPV</filename></link> + for improved usability in path and file names. + This change should be safe within contexts where these revisions + are used because the chances of spatially close collisions + is very low. + Distant collisions are not a major issue in the way + the values are used. + </para> + </section> + + <section id='migration-1.5-image-features'> + <title><filename>IMAGE_FEATURES</filename></title> + + <para> + The following changes have been made that relate to + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>: + <itemizedlist> + <listitem><para> + The value of + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> + is now validated to ensure invalid feature items are not + added. + Some users mistakenly add package names to this variable + instead of using + <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link> + in order to have the package added to the image, which does + not work. + This change is intended to catch those kinds of situations. + Valid <filename>IMAGE_FEATURES</filename> are drawn from + <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link> + definitions, + <link linkend='var-COMPLEMENTARY_GLOB'><filename>COMPLEMENTARY_GLOB</filename></link> + and a new "validitems" varflag on + <filename>IMAGE_FEATURES</filename>. + The "validitems" varflag change allows additional features + to be added if they are not provided using the previous + two mechanisms. + </para></listitem> + <listitem><para> + The previously deprecated "apps-console-core" + <filename>IMAGE_FEATURES</filename> item is no longer + supported. + Add "splash" to <filename>IMAGE_FEATURES</filename> if you + wish to have the splash screen enabled, since this is + all that apps-console-core was doing.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.5-run'> + <title><filename>/run</filename></title> + + <para> + The <filename>/run</filename> directory from the Filesystem + Hierarchy Standard 3.0 has been introduced. + You can find some of the implications for this change + <ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873'>here</ulink>. + The change also means that recipes that install files to + <filename>/var/run</filename> must be changed. + You can find a guide on how to make these changes + <ulink url='http://permalink.gmane.org/gmane.comp.handhelds.openembedded/58530'>here</ulink>. + </para> + </section> + + <section id='migration-1.5-removal-of-package-manager-database-within-image-recipes'> + <title>Removal of Package Manager Database Within Image Recipes</title> + + <para> + The image <filename>core-image-minimal</filename> no longer adds + <filename>remove_packaging_data_files</filename> to + <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></link>. + This addition is now handled automatically when "package-management" + is not in + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. + If you have custom image recipes that make this addition, + you should remove the lines, as they are not needed and might + interfere with correct operation of postinstall scripts. + </para> + </section> + + <section id='migration-1.5-images-now-rebuild-only-on-changes-instead-of-every-time'> + <title>Images Now Rebuild Only on Changes Instead of Every Time</title> + + <para> + The + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + and other related image + construction tasks are no longer marked as "nostamp". + Consequently, they will only be re-executed when their inputs have + changed. + Previous versions of the OpenEmbedded build system always rebuilt + the image when requested rather when necessary. + </para> + </section> + + <section id='migration-1.5-task-recipes'> + <title>Task Recipes</title> + + <para> + The previously deprecated <filename>task.bbclass</filename> has + now been dropped. + For recipes that previously inherited from this class, you should + rename them from <filename>task-*</filename> to + <filename>packagegroup-*</filename> and inherit packagegroup + instead. + </para> + + <para> + For more information, see the + "<link linkend='ref-classes-packagegroup'><filename>packagegroup.bbclass</filename></link>" + section. + </para> + </section> + + <section id='migration-1.5-busybox'> + <title>BusyBox</title> + + <para> + By default, we now split BusyBox into two binaries: + one that is suid root for those components that need it, and + another for the rest of the components. + Splitting BusyBox allows for optimization that eliminates the + <filename>tinylogin</filename> recipe as recommended by upstream. + You can disable this split by setting + <link linkend='var-BUSYBOX_SPLIT_SUID'><filename>BUSYBOX_SPLIT_SUID</filename></link> + to "0". + </para> + </section> + + <section id='migration-1.5-automated-image-testing'> + <title>Automated Image Testing</title> + + <para> + A new automated image testing framework has been added + through the + <link linkend='ref-classes-testimage*'><filename>testimage.bbclass</filename></link> + class. + This framework replaces the older + <filename>imagetest-qemu</filename> framework. + </para> + + <para> + You can learn more about performing automated image tests in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" + section. + </para> + </section> + + <section id='migration-1.5-build-history'> + <title>Build History</title> + + <para> + Following are changes to Build History: + <itemizedlist> + <listitem><para> + Installed package sizes: + <filename>installed-package-sizes.txt</filename> for an + image now records the size of the files installed by each + package instead of the size of each compressed package + archive file.</para></listitem> + <listitem><para> + The dependency graphs (<filename>depends*.dot</filename>) + now use the actual package names instead of replacing + dashes, dots and plus signs with underscores. + </para></listitem> + <listitem><para> + The <filename>buildhistory-diff</filename> and + <filename>buildhistory-collect-srcrevs</filename> + utilities have improved command-line handling. + Use the <filename>--help</filename> option for + each utility for more information on the new syntax. + </para></listitem> + </itemizedlist> + For more information on Build History, see the + "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>" + section. + </para> + </section> + + <section id='migration-1.5-udev'> + <title><filename>udev</filename></title> + + <para> + Following are changes to <filename>udev</filename>: + <itemizedlist> + <listitem><para> + <filename>udev</filename> no longer brings in + <filename>udev-extraconf</filename> automatically + through + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, + since this was originally intended to be optional. + If you need the extra rules, then add + <filename>udev-extraconf</filename> to your image. + </para></listitem> + <listitem><para> + <filename>udev</filename> no longer brings in + <filename>pciutils-ids</filename> or + <filename>usbutils-ids</filename> through + <filename>RRECOMMENDS</filename>. + These are not needed by <filename>udev</filename> itself + and removing them saves around 350KB. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.5-removed-renamed-recipes'> + <title>Removed and Renamed Recipes</title> + + <itemizedlist> + <listitem><para> + The <filename>linux-yocto</filename> 3.2 kernel has been + removed.</para></listitem> + <listitem><para> + <filename>libtool-nativesdk</filename> has been renamed to + <filename>nativesdk-libtool</filename>.</para></listitem> + <listitem><para> + <filename>tinylogin</filename> has been removed. + It has been replaced by a suid portion of Busybox. + See the + "<link linkend='migration-1.5-busybox'>BusyBox</link>" section + for more information.</para></listitem> + <listitem><para> + <filename>external-python-tarball</filename> has been renamed + to <filename>buildtools-tarball</filename>. + </para></listitem> + <listitem><para> + <filename>web-webkit</filename> has been removed. + It has been functionally replaced by + <filename>midori</filename>.</para></listitem> + <listitem><para> + <filename>imake</filename> has been removed. + It is no longer needed by any other recipe. + </para></listitem> + <listitem><para> + <filename>transfig-native</filename> has been removed. + It is no longer needed by any other recipe. + </para></listitem> + <listitem><para> + <filename>anjuta-remote-run</filename> has been removed. + Anjuta IDE integration has not been officially supported for + several releases.</para></listitem> + </itemizedlist> + </section> + + <section id='migration-1.5-other-changes'> + <title>Other Changes</title> + + <para> + Following is a list of short entries describing other changes: + <itemizedlist> + <listitem><para> + <filename>run-postinsts</filename>: Make this generic. + </para></listitem> + <listitem><para> + <filename>base-files</filename>: Remove the unnecessary + <filename>media/</filename><replaceable>xxx</replaceable> directories. + </para></listitem> + <listitem><para> + <filename>alsa-state</filename>: Provide an empty + <filename>asound.conf</filename> by default. + </para></listitem> + <listitem><para> + <filename>classes/image</filename>: Ensure + <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link> + supports pre-renamed package names.</para></listitem> + <listitem><para> + <filename>classes/rootfs_rpm</filename>: Implement + <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link> + for RPM.</para></listitem> + <listitem><para> + <filename>systemd</filename>: Remove + <filename>systemd_unitdir</filename> if + <filename>systemd</filename> is not in + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. + </para></listitem> + <listitem><para> + <filename>systemd</filename>: Remove + <filename>init.d</filename> dir if + <filename>systemd</filename> unit file is present and + <filename>sysvinit</filename> is not a distro feature. + </para></listitem> + <listitem><para> + <filename>libpam</filename>: Deny all services for the + <filename>OTHER</filename> entries. + </para></listitem> + <listitem><para> + <filename>image.bbclass</filename>: Move + <filename>runtime_mapping_rename</filename> to avoid + conflict with <filename>multilib</filename>. + See + <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993'><filename>YOCTO #4993</filename></ulink> + in Bugzilla for more information. + </para></listitem> + <listitem><para> + <filename>linux-dtb</filename>: Use kernel build system + to generate the <filename>dtb</filename> files. + </para></listitem> + <listitem><para> + <filename>kern-tools</filename>: Switch from guilt to + new <filename>kgit-s2q</filename> tool. + </para></listitem> + </itemizedlist> + </para> + </section> +</section> + +<section id='moving-to-the-yocto-project-1.6-release'> + <title>Moving to the Yocto Project 1.6 Release</title> + + <para> + This section provides migration information for moving to the + Yocto Project 1.6 Release from the prior release. + </para> + + + <section id='migration-1.6-archiver-class'> + <title><filename>archiver</filename> Class</title> + + <para> + The + <link linkend='ref-classes-archiver'><filename>archiver</filename></link> + class has been rewritten and its configuration has been simplified. + For more details on the source archiver, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" + section in the Yocto Project Development Manual. + </para> + </section> + + <section id='migration-1.6-packaging-changes'> + <title>Packaging Changes</title> + + <para> + The following packaging changes have been made: + <itemizedlist> + <listitem><para> + The <filename>binutils</filename> recipe no longer produces + a <filename>binutils-symlinks</filename> package. + <filename>update-alternatives</filename> is now used to + handle the preferred <filename>binutils</filename> + variant on the target instead. + </para></listitem> + <listitem><para> + The tc (traffic control) utilities have been split out of + the main <filename>iproute2</filename> package and put + into the <filename>iproute2-tc</filename> package. + </para></listitem> + <listitem><para> + The <filename>gtk-engines</filename> schemas have been + moved to a dedicated + <filename>gtk-engines-schemas</filename> package. + </para></listitem> + <listitem><para> + The <filename>armv7a</filename> with thumb package + architecture suffix has changed. + The suffix for these packages with the thumb + optimization enabled is "t2" as it should be. + Use of this suffix was not the case in the 1.5 release. + Architecture names will change within package feeds as a + result. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.6-bitbake'> + <title>BitBake</title> + + <para> + The following changes have been made to + <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink>. + </para> + + <section id='migration-1.6-matching-branch-requirement-for-git-fetching'> + <title>Matching Branch Requirement for Git Fetching</title> + + <para> + When fetching source from a Git repository using + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>, + BitBake will now validate the + <link linkend='var-SRCREV'><filename>SRCREV</filename></link> + value against the branch. + You can specify the branch using the following form: + <literallayout class='monospaced'> + SRC_URI = "git://server.name/repository;branch=<replaceable>branchname</replaceable>" + </literallayout> + If you do not specify a branch, BitBake looks + in the default "master" branch. + </para> + + <para> + Alternatively, if you need to bypass this check (e.g. + if you are fetching a revision corresponding to a tag that + is not on any branch), you can add ";nobranch=1" to + the end of the URL within <filename>SRC_URI</filename>. + </para> + </section> + + <section id='migration-1.6-bitbake-deps'> + <title>Python Definition substitutions</title> + + <para> + BitBake had some previously deprecated Python definitions + within its <filename>bb</filename> module removed. + You should use their sub-module counterparts instead: + <itemizedlist> + <listitem><para><filename>bb.MalformedUrl</filename>: + Use <filename>bb.fetch.MalformedUrl</filename>. + </para></listitem> + <listitem><para><filename>bb.encodeurl</filename>: + Use <filename>bb.fetch.encodeurl</filename>. + </para></listitem> + <listitem><para><filename>bb.decodeurl</filename>: + Use <filename>bb.fetch.decodeurl</filename> + </para></listitem> + <listitem><para><filename>bb.mkdirhier</filename>: + Use <filename>bb.utils.mkdirhier</filename>. + </para></listitem> + <listitem><para><filename>bb.movefile</filename>: + Use <filename>bb.utils.movefile</filename>. + </para></listitem> + <listitem><para><filename>bb.copyfile</filename>: + Use <filename>bb.utils.copyfile</filename>. + </para></listitem> + <listitem><para><filename>bb.which</filename>: + Use <filename>bb.utils.which</filename>. + </para></listitem> + <listitem><para><filename>bb.vercmp_string</filename>: + Use <filename>bb.utils.vercmp_string</filename>. + </para></listitem> + <listitem><para><filename>bb.vercmp</filename>: + Use <filename>bb.utils.vercmp</filename>. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.6-bitbake-fetcher'> + <title>SVK Fetcher</title> + + <para> + The SVK fetcher has been removed from BitBake. + </para> + </section> + + <section id='migration-1.6-bitbake-console-output'> + <title>Console Output Error Redirection</title> + + <para> + The BitBake console UI will now output errors to + <filename>stderr</filename> instead of + <filename>stdout</filename>. + Consequently, if you are piping or redirecting the output of + <filename>bitbake</filename> to somewhere else, and you wish + to retain the errors, you will need to add + <filename>2>&1</filename> (or something similar) to the + end of your <filename>bitbake</filename> command line. + </para> + </section> + + <section id='migration-1.6-task-taskname-overrides'> + <title><filename>task-</filename><replaceable>taskname</replaceable> Overrides</title> + + <para> + <filename>task-</filename><replaceable>taskname</replaceable> overrides have been + adjusted so that tasks whose names contain underscores have the + underscores replaced by hyphens for the override so that they + now function properly. + For example, the task override for + <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> + is <filename>task-populate-sdk</filename>. + </para> + </section> + </section> + + <section id='migration-1.6-variable-changes'> + <title>Changes to Variables</title> + + <para> + The following variables have changed. + For information on the OpenEmbedded build system variables, see the + "<link linkend='ref-variables-glos'>Variables Glossary</link>" Chapter. + </para> + + <section id='migration-1.6-variable-changes-TMPDIR'> + <title><filename>TMPDIR</filename></title> + + <para> + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + can no longer be on an NFS mount. + NFS does not offer full POSIX locking and inode consistency + and can cause unexpected issues if used to store + <filename>TMPDIR</filename>. + </para> + + <para> + The check for this occurs on startup. + If <filename>TMPDIR</filename> is detected on an NFS mount, + an error occurs. + </para> + </section> + + <section id='migration-1.6-variable-changes-PRINC'> + <title><filename>PRINC</filename></title> + + <para> + The <filename>PRINC</filename> + variable has been deprecated and triggers a warning if + detected during a build. + For + <link linkend='var-PR'><filename>PR</filename></link> + increments on changes, use the PR service instead. + You can find out more about this service in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>Working With a PR Service</ulink>" + section in the Yocto Project Development Manual. + </para> + </section> + + <section id='migration-1.6-variable-changes-IMAGE_TYPES'> + <title><filename>IMAGE_TYPES</filename></title> + + <para> + The "sum.jffs2" option for + <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link> + has been replaced by the "jffs2.sum" option, which fits the + processing order. + </para> + </section> + + <section id='migration-1.6-variable-changes-COPY_LIC_MANIFEST'> + <title><filename>COPY_LIC_MANIFEST</filename></title> + + <para> + The + <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> + variable must + now be set to "1" rather than any value in order to enable + it. + </para> + </section> + + <section id='migration-1.6-variable-changes-COPY_LIC_DIRS'> + <title><filename>COPY_LIC_DIRS</filename></title> + + <para> + The + <link linkend='var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></link> + variable must + now be set to "1" rather than any value in order to enable + it. + </para> + </section> + + <section id='migration-1.6-variable-changes-PACKAGE_GROUP'> + <title><filename>PACKAGE_GROUP</filename></title> + + <para> + The + <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link> + variable has been renamed to + <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link> + to more accurately reflect its purpose. + You can still use <filename>PACKAGE_GROUP</filename> but + the OpenEmbedded build system produces a warning message when + it encounters the variable. + </para> + </section> + + <section id='migration-1.6-variable-changes-variable-entry-behavior'> + <title>Preprocess and Post Process Command Variable Behavior</title> + + <para> + The following variables now expect a semicolon separated + list of functions to call and not arbitrary shell commands: + <literallayout class='monospaced'> + <link linkend='var-ROOTFS_PREPROCESS_COMMAND'>ROOTFS_PREPROCESS_COMMAND</link> + <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'>ROOTFS_POSTPROCESS_COMMAND</link> + <link linkend='var-SDK_POSTPROCESS_COMMAND'>SDK_POSTPROCESS_COMMAND</link> + <link linkend='var-POPULATE_SDK_POST_TARGET_COMMAND'>POPULATE_SDK_POST_TARGET_COMMAND</link> + <link linkend='var-POPULATE_SDK_POST_HOST_COMMAND'>POPULATE_SDK_POST_HOST_COMMAND</link> + <link linkend='var-IMAGE_POSTPROCESS_COMMAND'>IMAGE_POSTPROCESS_COMMAND</link> + <link linkend='var-IMAGE_PREPROCESS_COMMAND'>IMAGE_PREPROCESS_COMMAND</link> + <link linkend='var-ROOTFS_POSTUNINSTALL_COMMAND'>ROOTFS_POSTUNINSTALL_COMMAND</link> + <link linkend='var-ROOTFS_POSTINSTALL_COMMAND'>ROOTFS_POSTINSTALL_COMMAND</link> + </literallayout> + For migration purposes, you can simply wrap shell commands in + a shell function and then call the function. + Here is an example: + <literallayout class='monospaced'> + my_postprocess_function() { + echo "hello" > ${IMAGE_ROOTFS}/hello.txt + } + ROOTFS_POSTPROCESS_COMMAND += "my_postprocess_function; " + </literallayout> + </para> + </section> + </section> + + <section id='migration-1.6-package-test-ptest'> + <title>Package Test (ptest)</title> + + <para> + Package Tests (ptest) are built but not installed by default. + For information on using Package Tests, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Setting up and running package test (ptest)</ulink>" + section in the Yocto Project Development Manual. + For information on the <filename>ptest</filename> class, see the + "<link linkend='ref-classes-ptest'><filename>ptest.bbclass</filename></link>" + section. + </para> + </section> + + <section id='migration-1.6-build-changes'> + <title>Build Changes</title> + + <para> + Separate build and source directories have been enabled + by default for selected recipes where it is known to work + (a whitelist) and for all recipes that inherit the + <link linkend='ref-classes-cmake'><filename>cmake</filename></link> + class. + In future releases the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class will enable a separate build directory by default as + well. + Recipes building Autotools-based + software that fails to build with a separate build directory + should be changed to inherit from the + <link linkend='ref-classes-autotools'><filename>autotools-brokensep</filename></link> + class instead of the <filename>autotools</filename> or + <filename>autotools_stage</filename>classes. + </para> + </section> + + <section id='migration-1.6-building-qemu-native'> + <title><filename>qemu-native</filename></title> + + <para> + <filename>qemu-native</filename> now builds without + SDL-based graphical output support by default. + The following additional lines are needed in your + <filename>local.conf</filename> to enable it: + <literallayout class='monospaced'> + PACKAGECONFIG_pn-qemu-native = "sdl" + ASSUME_PROVIDED += "libsdl-native" + </literallayout> + <note> + The default <filename>local.conf</filename> + contains these statements. + Consequently, if you are building a headless system and using + a default <filename>local.conf</filename> file, you will need + comment these two lines out. + </note> + </para> + </section> + + <section id='migration-1.6-core-image-basic'> + <title><filename>core-image-basic</filename></title> + + <para> + <filename>core-image-basic</filename> has been renamed to + <filename>core-image-full-cmdline</filename>. + </para> + + <para> + In addition to <filename>core-image-basic</filename> being renamed, + <filename>packagegroup-core-basic</filename> has been renamed to + <filename>packagegroup-core-full-cmdline</filename> to match. + </para> + </section> + + <section id='migration-1.6-licensing'> + <title>Licensing</title> + + <para> + The top-level <filename>LICENSE</filename> file has been changed + to better describe the license of the various components of + OE-Core. + However, the licensing itself remains unchanged. + </para> + + <para> + Normally, this change would not cause any side-effects. + However, some recipes point to this file within + <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link> + (as <filename>${COREBASE}/LICENSE</filename>) and thus the + accompanying checksum must be changed from + 3f40d7994397109285ec7b81fdeb3b58 to + 4d92cd373abda3937c2bc47fbc49d690. + A better alternative is to have + <filename>LIC_FILES_CHKSUM</filename> point to a file + describing the license that is distributed with the source + that the recipe is building, if possible, rather than pointing + to <filename>${COREBASE}/LICENSE</filename>. + </para> + </section> + + <section id='migration-1.6-cflags-options'> + <title><filename>CFLAGS</filename> Options</title> + + <para> + The "-fpermissive" option has been removed from the default + <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> + value. + You need to take action on individual recipes that fail when + building with this option. + You need to either patch the recipes to fix the issues reported by + the compiler, or you need to add "-fpermissive" to + <filename>CFLAGS</filename> in the recipes. + </para> + </section> + + <section id='migration-1.6-custom-images'> + <title>Custom Image Output Types</title> + + <para> + Custom image output types, as selected using + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>, + must declare their dependencies on other image types (if any) using + a new + <link linkend='var-IMAGE_TYPEDEP'><filename>IMAGE_TYPEDEP</filename></link> + variable. + </para> + </section> + + <section id='migration-1.6-do-package-write-task'> + <title>Tasks</title> + + <para> + The <filename>do_package_write</filename> task has been removed. + The task is no longer needed. + </para> + </section> + + <section id='migration-1.6-update-alternatives-provider'> + <title><filename>update-alternative</filename> Provider</title> + + <para> + The default <filename>update-alternatives</filename> provider has + been changed from <filename>opkg</filename> to + <filename>opkg-utils</filename>. + This change resolves some troublesome circular dependencies. + The runtime package has also been renamed from + <filename>update-alternatives-cworth</filename> + to <filename>update-alternatives-opkg</filename>. + </para> + </section> + + <section id='migration-1.6-virtclass-overrides'> + <title><filename>virtclass</filename> Overrides</title> + + <para> + The <filename>virtclass</filename> overrides are now deprecated. + Use the equivalent class overrides instead (e.g. + <filename>virtclass-native</filename> becomes + <filename>class-native</filename>.) + </para> + </section> + + <section id='migration-1.6-removed-renamed-recipes'> + <title>Removed and Renamed Recipes</title> + + <para> + The following recipes have been removed: + <itemizedlist> + <listitem><para><filename>packagegroup-toolset-native</filename> - + This recipe is largely unused. + </para></listitem> + <listitem><para><filename>linux-yocto-3.8</filename> - + Support for the Linux yocto 3.8 kernel has been dropped. + Support for the 3.10 and 3.14 kernels have been added + with the <filename>linux-yocto-3.10</filename> and + <filename>linux-yocto-3.14</filename> recipes. + </para></listitem> + <listitem><para><filename>ocf-linux</filename> - + This recipe has been functionally replaced using + <filename>cryptodev-linux</filename>. + </para></listitem> + <listitem><para><filename>genext2fs</filename> - + <filename>genext2fs</filename> is no longer used by the + build system and is unmaintained upstream. + </para></listitem> + <listitem><para><filename>js</filename> - + This provided an ancient version of Mozilla's javascript + engine that is no longer needed. + </para></listitem> + <listitem><para><filename>zaurusd</filename> - + The recipe has been moved to the + <filename>meta-handheld</filename> layer. + </para></listitem> + <listitem><para><filename>eglibc 2.17</filename> - + Replaced by the <filename>eglibc 2.19</filename> + recipe. + </para></listitem> + <listitem><para><filename>gcc 4.7.2</filename> - + Replaced by the now stable + <filename>gcc 4.8.2</filename>. + </para></listitem> + <listitem><para><filename>external-sourcery-toolchain</filename> - + this recipe is now maintained in the + <filename>meta-sourcery</filename> layer. + </para></listitem> + <listitem><para><filename>linux-libc-headers-yocto 3.4+git</filename> - + Now using version 3.10 of the + <filename>linux-libc-headers</filename> by default. + </para></listitem> + <listitem><para><filename>meta-toolchain-gmae</filename> - + This recipe is obsolete. + </para></listitem> + <listitem><para><filename>packagegroup-core-sdk-gmae</filename> - + This recipe is obsolete. + </para></listitem> + <listitem><para><filename>packagegroup-core-standalone-gmae-sdk-target</filename> - + This recipe is obsolete. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.6-removed-classes'> + <title>Removed Classes</title> + + <para> + The following classes have become obsolete and have been removed: + <itemizedlist> + <listitem><para><filename>module_strip</filename> + </para></listitem> + <listitem><para><filename>pkg_metainfo</filename> + </para></listitem> + <listitem><para><filename>pkg_distribute</filename> + </para></listitem> + <listitem><para><filename>image-empty</filename> + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.6-reference-bsps'> + <title>Reference Board Support Packages (BSPs)</title> + + <para> + The following reference BSPs changes occurred: + <itemizedlist> + <listitem><para>The BeagleBoard + (<filename>beagleboard</filename>) ARM reference hardware + has been replaced by the BeagleBone + (<filename>beaglebone</filename>) hardware. + </para></listitem> + <listitem><para>The RouterStation Pro + (<filename>routerstationpro</filename>) MIPS reference + hardware has been replaced by the EdgeRouter Lite + (<filename>edgerouter</filename>) hardware. + </para></listitem> + </itemizedlist> + The previous reference BSPs for the + <filename>beagleboard</filename> and + <filename>routerstationpro</filename> machines are still available + in a new <filename>meta-yocto-bsp-old</filename> layer in the + <ulink url='&YOCTO_GIT_URL;'>Source Repositories</ulink> + at + <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/'>http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/</ulink>. + </para> + </section> +</section> + +<section id='moving-to-the-yocto-project-1.7-release'> + <title>Moving to the Yocto Project 1.7 Release</title> + + <para> + This section provides migration information for moving to the + Yocto Project 1.7 Release from the prior release. + </para> + + <section id='migration-1.7-changes-to-setting-qemu-packageconfig-options'> + <title>Changes to Setting QEMU <filename>PACKAGECONFIG</filename> Options in <filename>local.conf</filename></title> + + <para> + The QEMU recipe now uses a number of + <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> + options to enable various optional features. + The method used to set defaults for these options means that + existing + <filename>local.conf</filename> files will need to be be + modified to append to <filename>PACKAGECONFIG</filename> for + <filename>qemu-native</filename> and + <filename>nativesdk-qemu</filename> instead of setting it. + In other words, to enable graphical output for QEMU, you should + now have these lines in <filename>local.conf</filename>: + <literallayout class='monospaced'> + PACKAGECONFIG_append_pn-qemu-native = " sdl" + PACKAGECONFIG_append_pn-nativesdk-qemu = " sdl" + </literallayout> + </para> + </section> + + <section id='migration-1.7-minimum-git-version'> + <title>Minimum Git version</title> + + <para> + The minimum + <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> version required + on the build host is now 1.7.8 because the + <filename>--list</filename> option is now required by + BitBake's Git fetcher. + As always, if your host distribution does not provide a version of + Git that meets this requirement, you can use the + <filename>buildtools-tarball</filename> that does. + See the + "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" + section for more information. + </para> + </section> + + <section id='migration-1.7-autotools-class-changes'> + <title>Autotools Class Changes</title> + + <para> + The following + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class changes occurred: + <itemizedlist> + <listitem><para><emphasis> + A separate build directory is now used by default:</emphasis> + The <filename>autotools</filename> class has been changed + to use a directory for building + (<link linkend='var-B'><filename>B</filename></link>), + which is separate from the source directory + (<link linkend='var-S'><filename>S</filename></link>). + This is commonly referred to as + <filename>B != S</filename>, or an out-of-tree build.</para> + <para>If the software being built is already capable of + building in a directory separate from the source, you + do not need to do anything. + However, if the software is not capable of being built + in this manner, you will + need to either patch the software so that it can build + separately, or you will need to change the recipe to + inherit the + <link linkend='ref-classes-autotools'><filename>autotools-brokensep</filename></link> + class instead of the <filename>autotools</filename> or + <filename>autotools_stage</filename> classes. + </para></listitem> + <listitem><para><emphasis> + The <filename>--foreign</filename> option is + no longer passed to <filename>automake</filename> when + running <filename>autoconf</filename>:</emphasis> + This option tells <filename>automake</filename> that a + particular software package does not follow the GNU + standards and therefore should not be expected + to distribute certain files such as + <filename>ChangeLog</filename>, + <filename>AUTHORS</filename>, and so forth. + Because the majority of upstream software packages already + tell <filename>automake</filename> to enable foreign mode + themselves, the option is mostly superfluous. + However, some recipes will need patches for this change. + You can easily make the change by patching + <filename>configure.ac</filename> so that it passes + "foreign" to <filename>AM_INIT_AUTOMAKE()</filename>. + See + <ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=01943188f85ce6411717fb5bf702d609f55813f2'>this commit</ulink> + for an example showing how to make the patch. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.7-binary-configuration-scripts-disabled'> + <title>Binary Configuration Scripts Disabled</title> + + <para> + Some of the core recipes that package binary configuration scripts + now disable the scripts due to the + scripts previously requiring error-prone path substitution. + Software that links against these libraries using these scripts + should use the much more robust <filename>pkg-config</filename> + instead. + The list of recipes changed in this version (and their + configuration scripts) is as follows: + <literallayout class='monospaced'> + directfb (directfb-config) + freetype (freetype-config) + gpgme (gpgme-config) + libassuan (libassuan-config) + libcroco (croco-6.0-config) + libgcrypt (libgcrypt-config) + libgpg-error (gpg-error-config) + libksba (ksba-config) + libpcap (pcap-config) + libpcre (pcre-config) + libpng (libpng-config, libpng16-config) + libsdl (sdl-config) + libusb-compat (libusb-config) + libxml2 (xml2-config) + libxslt (xslt-config) + ncurses (ncurses-config) + neon (neon-config) + npth (npth-config) + pth (pth-config) + taglib (taglib-config) + </literallayout> + Additionally, support for <filename>pkg-config</filename> has been + added to some recipes in the previous list in the rare cases + where the upstream software package does not already provide + it. + </para> + </section> + + <section id='migration-1.7-glibc-replaces-eglibc'> + <title><filename>eglibc 2.19</filename> Replaced with <filename>glibc 2.20</filename></title> + + <para> + Because <filename>eglibc</filename> and + <filename>glibc</filename> were already fairly close, this + replacement should not require any significant changes to other + software that links to <filename>eglibc</filename>. + However, there were a number of minor changes in + <filename>glibc 2.20</filename> upstream that could require + patching some software (e.g. the removal of the + <filename>_BSD_SOURCE</filename> feature test macro). + </para> + + <para> + <filename>glibc 2.20</filename> requires version 2.6.32 or greater + of the Linux kernel. + Thus, older kernels will no longer be usable in conjunction with it. + </para> + + <para> + For full details on the changes in <filename>glibc 2.20</filename>, + see the upstream release notes + <ulink url='https://sourceware.org/ml/libc-alpha/2014-09/msg00088.html'>here</ulink>. + </para> + </section> + + <section id='migration-1.7-kernel-module-autoloading'> + <title>Kernel Module Autoloading</title> + + <para> + The + <link linkend='var-module_autoload'><filename>module_autoload_*</filename></link> + variable is now deprecated and a new + <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> + variable should be used instead. + Also, + <link linkend='var-module_conf'><filename>module_conf_*</filename></link> + must now be used in conjunction with a new + <link linkend='var-KERNEL_MODULE_PROBECONF'><filename>KERNEL_MODULE_PROBECONF</filename></link> + variable. + The new variables no longer require you to specify the module name + as part of the variable name. + This change not only simplifies usage but also allows the values + of these variables to be appropriately incorporated into task + signatures and thus trigger the appropriate tasks to re-execute + when changed. + You should replace any references to + <filename>module_autoload_*</filename> with + <filename>KERNEL_MODULE_AUTOLOAD</filename>, and add any modules + for which <filename>module_conf_*</filename> is specified to + <filename>KERNEL_MODULE_PROBECONF</filename>. + </para> + + <para> + For more information, see the + <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> + and + <link linkend='var-KERNEL_MODULE_PROBECONF'><filename>KERNEL_MODULE_PROBECONF</filename></link> + variables. + </para> + </section> + + <section id='migration-1.7-qa-check-changes'> + <title>QA Check Changes</title> + + <para> + The following changes have occurred to the QA check process: + <itemizedlist> + <listitem><para> + Additional QA checks <filename>file-rdeps</filename> + and <filename>build-deps</filename> have been added in + order to verify that file dependencies are satisfied + (e.g. package contains a script requiring + <filename>/bin/bash</filename>) and build-time dependencies + are declared, respectively. + For more information, please see the + "<link linkend='ref-qa-checks'>QA Error and Warning Messages</link>" + chapter. + </para></listitem> + <listitem><para> + Package QA checks are now performed during a new + <link linkend='ref-tasks-package_qa'><filename>do_package_qa</filename></link> + task rather than being part of the + <link linkend='ref-tasks-package'><filename>do_package</filename></link> + task. + This allows more parallel execution. + This change is unlikely to be an issue except for highly + customized recipes that disable packaging tasks themselves + by marking them as <filename>noexec</filename>. + For those packages, you will need to disable the + <filename>do_package_qa</filename> task as well. + </para></listitem> + <listitem><para> + Files being overwritten during the + <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> + task now trigger an error instead of a warning. + Recipes should not be overwriting files written to the + sysroot by other recipes. + If you have these types of recipes, you need to alter them + so that they do not overwrite these files.</para> + <para>You might now receive this error after changes in + configuration or metadata resulting in orphaned files + being left in the sysroot. + If you do receive this error, the way to resolve the issue + is to delete your + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + or to move it out of the way and then re-start the build. + Anything that has been fully built up to that point and + does not need rebuilding will be restored from the shared + state cache and the rest of the build will be able to + proceed as normal. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.7-removed-recipes'> + <title>Removed Recipes</title> + + <para> + The following recipes have been removed: + <itemizedlist> + <listitem><para> + <filename>x-load</filename>: + This recipe has been superseded by + U-boot SPL for all Cortex-based TI SoCs. + For legacy boards, the <filename>meta-ti</filename> + layer, which contains a maintained recipe, should be used + instead. + </para></listitem> + <listitem><para> + <filename>ubootchart</filename>: + This recipe is obsolete. + A <filename>bootchart2</filename> recipe has been added + to functionally replace it. + </para></listitem> + <listitem><para> + <filename>linux-yocto 3.4</filename>: + Support for the linux-yocto 3.4 kernel has been dropped. + Support for the 3.10 and 3.14 kernels remains, while + support for version 3.17 has been added. + </para></listitem> + <listitem><para> + <filename>eglibc</filename> has been removed in favor of + <filename>glibc</filename>. + See the + "<link linkend='migration-1.7-glibc-replaces-eglibc'><filename>eglibc 2.19</filename> Replaced with <filename>glibc 2.20</filename></link>" + section for more information. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.7-miscellaneous-changes'> + <title>Miscellaneous Changes</title> + + <para> + The following miscellaneous change occurred: + <itemizedlist> + <listitem><para> + The build history feature now writes + <filename>build-id.txt</filename> instead of + <filename>build-id</filename>. + Additionally, <filename>build-id.txt</filename> + now contains the full build header as printed by + BitBake upon starting the build. + You should manually remove old "build-id" files from your + existing build history repositories to avoid confusion. + For information on the build history feature, see the + "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>" + section. + </para></listitem> + </itemizedlist> + </para> + </section> +</section> + +<section id='moving-to-the-yocto-project-1.8-release'> + <title>Moving to the Yocto Project 1.8 Release</title> + + <para> + This section provides migration information for moving to the + Yocto Project 1.8 Release from the prior release. + </para> + + <section id='migration-1.8-removed-recipes'> + <title>Removed Recipes</title> + + <para> + The following recipes have been removed: + <itemizedlist> + <listitem><para><filename>owl-video</filename>: + Functionality replaced by <filename>gst-player</filename>. + </para></listitem> + <listitem><para><filename>gaku</filename>: + Functionality replaced by <filename>gst-player</filename>. + </para></listitem> + <listitem><para><filename>gnome-desktop</filename>: + This recipe is now available in + <filename>meta-gnome</filename> and is no longer needed. + </para></listitem> + <listitem><para><filename>gsettings-desktop-schemas</filename>: + This recipe is now available in + <filename>meta-gnome</filename> and is no longer needed. + </para></listitem> + <listitem><para><filename>python-argparse</filename>: + The <filename>argparse</filename> module is already + provided in the default Python distribution in a + package named <filename>python-argparse</filename>. + Consequently, the separate + <filename>python-argparse</filename> recipe is no + longer needed. + </para></listitem> + <listitem><para><filename>telepathy-python, libtelepathy, telepathy-glib, telepathy-idle, telepathy-mission-control</filename>: + All these recipes have moved to + <filename>meta-oe</filename> and are consequently no + longer needed by any recipes in OpenEmbedded-Core. + </para></listitem> + <listitem><para><filename>linux-yocto_3.10</filename> and <filename>linux-yocto_3.17</filename>: + Support for the linux-yocto 3.10 and 3.17 kernels has been + dropped. + Support for the 3.14 kernel remains, while support for + 3.19 kernel has been added. + </para></listitem> + <listitem><para><filename>poky-feed-config-opkg</filename>: + This recipe has become obsolete and is no longer needed. + Use <filename>distro-feed-config</filename> from + <filename>meta-oe</filename> instead. + </para></listitem> + <listitem><para><filename>libav 0.8.x</filename>: + <filename>libav 9.x</filename> is now used. + </para></listitem> + <listitem><para><filename>sed-native</filename>: + No longer needed. + A working version of <filename>sed</filename> is expected + to be provided by the host distribution. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.8-bluez'> + <title>BlueZ 4.x / 5.x Selection</title> + + <para> + Proper built-in support for selecting BlueZ 5.x in preference + to the default of 4.x now exists. + To use BlueZ 5.x, simply add "bluez5" to your + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> + value. + If you had previously added append files + (<filename>*.bbappend</filename>) to make this selection, you can + now remove them. + </para> + + <para> + Additionally, a + <link linkend='ref-classes-bluetooth'><filename>bluetooth</filename></link> + class has been added to make selection of the appropriate bluetooth + support within a recipe a little easier. + If you wish to make use of this class in a recipe, add something + such as the following: + <literallayout class='monospaced'> + inherit bluetooth + PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)} + PACKAGECONFIG[bluez4] = "--enable-bluetooth,--disable-bluetooth,bluez4" + PACKAGECONFIG[bluez5] = "--enable-bluez5,--disable-bluez5,bluez5" + </literallayout> + </para> + </section> + + <section id='migration-1.8-kernel-build-changes'> + <title>Kernel Build Changes</title> + + <para> + The kernel build process was changed to place the source + in a common shared work area and to place build artifacts + separately in the source code tree. + In theory, migration paths have been provided for most common + usages in kernel recipes but this might not work in all cases. + In particular, users need to ensure that + <filename>${S}</filename> (source files) and + <filename>${B}</filename> (build artifacts) are used + correctly in functions such as + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + and + <link linkend='ref-tasks-install'><filename>do_install</filename></link>. + For kernel recipes that do not inherit from + <filename>kernel-yocto</filename> or include + <filename>linux-yocto.inc</filename>, you might wish to + refer to the <filename>linux.inc</filename> file in the + <filename>meta-oe</filename> layer for the kinds of changes you + need to make. + For reference, here is the + <ulink url='http://cgit.openembedded.org/meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee'>commit</ulink> + where the <filename>linux.inc</filename> file in + <filename>meta-oe</filename> was updated. + </para> + + <para> + Recipes that rely on the kernel source code and do not inherit + the module classes might need to add explicit dependencies on + the <filename>do_shared_workdir</filename> kernel task, for example: + <literallayout class='monospaced'> + do_configure[depends] += "virtual/kernel:do_shared_workdir" + </literallayout> + </para> + </section> + + <section id='migration-1.8-ssl'> + <title>SSL 3.0 is Now Disabled in OpenSSL</title> + + <para> + SSL 3.0 is now disabled when building OpenSSL. + Disabling SSL 3.0 avoids any lingering instances of the POODLE + vulnerability. + If you feel you must re-enable SSL 3.0, then you can add an + append file (<filename>*.bbappend</filename>) for the + <filename>openssl</filename> recipe to remove "-no-ssl3" + from + <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>. + </para> + </section> + + <section id='migration-1.8-default-sysroot-poisoning'> + <title>Default Sysroot Poisoning</title> + + <para> + <filename>gcc's</filename> default sysroot and include directories + are now "poisoned". + In other words, the sysroot and include directories are being + redirected to a non-existent location in order to catch when + host directories are being used due to the correct options not + being passed. + This poisoning applies both to the cross-compiler used within the + build and to the cross-compiler produced in the SDK. + </para> + + <para> + If this change causes something in the build to fail, it almost + certainly means the various compiler flags and commands are not + being passed correctly to the underlying piece of software. + In such cases, you need to take corrective steps. + </para> + </section> + + <section id='migration-1.8-rebuild-improvements'> + <title>Rebuild Improvements</title> + + <para> + Changes have been made to the + <link linkend='ref-classes-base'><filename>base</filename></link>, + <link linkend='ref-classes-autotools'><filename>autotools</filename></link>, + and + <link linkend='ref-classes-cmake'><filename>cmake</filename></link> + classes to clean out generated files when the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task needs to be re-executed. + </para> + + <para> + One of the improvements is to attempt to run "make clean" during + the <filename>do_configure</filename> task if a + <filename>Makefile</filename> exists. + Some software packages do not provide a working clean target + within their make files. + If you have such recipes, you need to set + <link linkend='var-CLEANBROKEN'><filename>CLEANBROKEN</filename></link> + to "1" within the recipe, for example: + <literallayout class='monospaced'> + CLEANBROKEN = "1" + </literallayout> + </para> + </section> + + <section id='migration-1.8-qa-check-and-validation-changes'> + <title>QA Check and Validation Changes</title> + + <para> + The following QA Check and Validation Changes have occurred: + <itemizedlist> + <listitem><para> + Usage of <filename>PRINC</filename> + previously triggered a warning. + It now triggers an error. + You should remove any remaining usage of + <filename>PRINC</filename> in any recipe or append file. + </para></listitem> + <listitem><para> + An additional QA check has been added to detect usage of + <filename>${D}</filename> in + <link linkend='var-FILES'><filename>FILES</filename></link> + values where + <link linkend='var-D'><filename>D</filename></link> values + should not be used at all. + The same check ensures that <filename>$D</filename> is used + in + <filename>pkg_preinst/pkg_postinst/pkg_prerm/pkg_postrm</filename> + functions instead of <filename>${D}</filename>. + </para></listitem> + <listitem><para> + <link linkend='var-S'><filename>S</filename></link> now + needs to be set to a valid value within a recipe. + If <filename>S</filename> is not set in the recipe, the + directory is not automatically created. + If <filename>S</filename> does not point to a directory + that exists at the time the + <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> + task finishes, a warning will be shown. + </para></listitem> + <listitem><para> + <link linkend='var-LICENSE'><filename>LICENSE</filename></link> + is now validated for correct formatting of multiple + licenses. + If the format is invalid (e.g. multiple licenses are + specified with no operators to specify how the multiple + licenses interact), then a warning will be shown. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-1.8-miscellaneous-changes'> + <title>Miscellaneous Changes</title> + + <para> + The following miscellaneous changes have occurred: + <itemizedlist> + <listitem><para> + The <filename>send-error-report</filename> script now + expects a "-s" option to be specified before the server + address. + This assumes a server address is being specified. + </para></listitem> + <listitem><para> + The <filename>oe-pkgdata-util</filename> script now + expects a "-p" option to be specified before the + <filename>pkgdata</filename> directory, which is now + optional. + If the <filename>pkgdata</filename> directory is not + specified, the script will run BitBake to query + <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> + from the build environment. + </para></listitem> + </itemizedlist> + </para> + </section> +</section> + +<section id='moving-to-the-yocto-project-2.0-release'> + <title>Moving to the Yocto Project 2.0 Release</title> + + <para> + This section provides migration information for moving to the + Yocto Project 2.0 Release from the prior release. + </para> + + <section id='migration-2.0-gcc-5'> + <title>GCC 5</title> + + <para> + The default compiler is now GCC 5.2. + This change has required fixes for compilation errors in a number + of other recipes. + </para> + + <para> + One important example is a fix for when the Linux kernel freezes at + boot time on ARM when built with GCC 5. + If you are using your own kernel recipe or source tree and + building for ARM, you will likely need to apply this + <ulink url='https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit?id=a077224fd35b2f7fbc93f14cf67074fc792fbac2'>patch</ulink>. + The standard <filename>linux-yocto</filename> kernel source tree + already has a workaround for the same issue. + </para> + + <para> + For further details, see + <ulink url='https://gcc.gnu.org/gcc-5/changes.html'></ulink> and + the porting guide at + <ulink url='https://gcc.gnu.org/gcc-5/porting_to.html'></ulink>. + </para> + + <para> + Alternatively, you can switch back to GCC 4.9 or 4.8 by + setting <filename>GCCVERSION</filename> in your configuration, + as follows: + <literallayout class='monospaced'> + GCCVERSION = "4.9%" + </literallayout> + </para> + </section> + + <section id='migration-2.0-Gstreamer-0.10-removed'> + <title>Gstreamer 0.10 Removed</title> + + <para> + Gstreamer 0.10 has been removed in favor of Gstreamer 1.x. + As part of the change, recipes for Gstreamer 0.10 and related + software are now located + in <filename>meta-multimedia</filename>. + This change results in Qt4 having Phonon and Gstreamer + support in QtWebkit disabled by default. + </para> + </section> + + <section id='migration-2.0-removed-recipes'> + <title>Removed Recipes</title> + + <para> + The following recipes have been moved or removed: + <itemizedlist> + <listitem><para> + <filename>bluez4</filename>: The recipe is obsolete and + has been moved due to <filename>bluez5</filename> + becoming fully integrated. + The <filename>bluez4</filename> recipe now resides in + <filename>meta-oe</filename>. + </para></listitem> + <listitem><para> + <filename>gamin</filename>: The recipe is obsolete and + has been removed. + </para></listitem> + <listitem><para> + <filename>gnome-icon-theme</filename>: The recipe's + functionally has been replaced by + <filename>adwaita-icon-theme</filename>. + </para></listitem> + <listitem><para> + Gstreamer 0.10 Recipes: Recipes for Gstreamer 0.10 have + been removed in favor of the recipes for Gstreamer 1.x. + </para></listitem> + <listitem><para> + <filename>insserv</filename>: The recipe is obsolete and + has been removed. + </para></listitem> + <listitem><para> + <filename>libunique</filename>: The recipe is no longer + used and has been moved to <filename>meta-oe</filename>. + </para></listitem> + <listitem><para> + <filename>midori</filename>: The recipe's functionally + has been replaced by <filename>epiphany</filename>. + </para></listitem> + <listitem><para> + <filename>python-gst</filename>: The recipe is obsolete + and has been removed since it only contains bindings for + Gstreamer 0.10. + </para></listitem> + <listitem><para> + <filename>qt-mobility</filename>: The recipe is obsolete and + has been removed since it requires + <filename>Gstreamer 0.10</filename>, which has been + replaced. + </para></listitem> + <listitem><para> + <filename>subversion</filename>: All 1.6.x versions of this + recipe have been removed. + </para></listitem> + <listitem><para> + <filename>webkit-gtk</filename>: The older 1.8.3 version + of this recipe has been removed in favor of + <filename>webkitgtk</filename>. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.0-bitbake-datastore-improvements'> + <title>BitBake datastore improvements</title> + + <para> + The method by which BitBake's datastore handles overrides has + changed. + Overrides are now applied dynamically and + <filename>bb.data.update_data()</filename> is now a no-op. + Thus, <filename>bb.data.update_data()</filename> is no longer + required in order to apply the correct overrides. + In practice, this change is unlikely to require any changes to + Metadata. + However, these minor changes in behavior exist: + <itemizedlist> + <listitem><para> + All potential overrides are now visible in the variable + history as seen when you run the following: + <literallayout class='monospaced'> + $ bitbake -e + </literallayout> + </para></listitem> + <listitem><para> + <filename>d.delVar('</filename><replaceable>varname</replaceable><filename>')</filename> and + <filename>d.setVar('</filename><replaceable>varname</replaceable><filename>', None)</filename> + result in the variable and all of its overrides being + cleared out. + Before the change, only the non-overridden values + were cleared. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.0-shell-message-function-changes'> + <title>Shell Message Function Changes</title> + + <para> + The shell versions of the BitBake message functions (i.e. + <filename>bbdebug</filename>, <filename>bbnote</filename>, + <filename>bbwarn</filename>, <filename>bbplain</filename>, + <filename>bberror</filename>, and <filename>bbfatal</filename>) + are now connected through to their BitBake equivalents + <filename>bb.debug()</filename>, <filename>bb.note()</filename>, + <filename>bb.warn()</filename>, <filename>bb.plain()</filename>, + <filename>bb.error()</filename>, and + <filename>bb.fatal()</filename>, respectively. + Thus, those message functions that you would expect to be printed + by the BitBake UI are now actually printed. + In practice, this change means two things: + <itemizedlist> + <listitem><para> + If you now see messages on the console that you did not + previously see as a result of this change, you might + need to clean up the calls to + <filename>bbwarn</filename>, <filename>bberror</filename>, + and so forth. + Or, you might want to simply remove the calls. + </para></listitem> + <listitem><para> + The <filename>bbfatal</filename> message function now + suppresses the full error log in the UI, which means any + calls to <filename>bbfatal</filename> where you still + wish to see the full error log should be replaced by + <filename>die</filename> or + <filename>bbfatal_log</filename>. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.0-extra-development-debug-package-cleanup'> + <title>Extra Development/Debug Package Cleanup</title> + + <para> + The following recipes have had extra + <filename>dev/dbg</filename> packages removed: + <itemizedlist> + <listitem><para> + <filename>acl</filename> + </para></listitem> + <listitem><para> + <filename>apmd</filename> + </para></listitem> + <listitem><para> + <filename>aspell</filename> + </para></listitem> + <listitem><para> + <filename>attr</filename> + </para></listitem> + <listitem><para> + <filename>augeas</filename> + </para></listitem> + <listitem><para> + <filename>bzip2</filename> + </para></listitem> + <listitem><para> + <filename>cogl</filename> + </para></listitem> + <listitem><para> + <filename>curl</filename> + </para></listitem> + <listitem><para> + <filename>elfutils</filename> + </para></listitem> + <listitem><para> + <filename>gcc-target</filename> + </para></listitem> + <listitem><para> + <filename>libgcc</filename> + </para></listitem> + <listitem><para> + <filename>libtool</filename> + </para></listitem> + <listitem><para> + <filename>libxmu</filename> + </para></listitem> + <listitem><para> + <filename>opkg</filename> + </para></listitem> + <listitem><para> + <filename>pciutils</filename> + </para></listitem> + <listitem><para> + <filename>rpm</filename> + </para></listitem> + <listitem><para> + <filename>sysfsutils</filename> + </para></listitem> + <listitem><para> + <filename>tiff</filename> + </para></listitem> + <listitem><para> + <filename>xz</filename> + </para></listitem> + </itemizedlist> + All of the above recipes now conform to the standard packaging + scheme where a single <filename>-dev</filename>, + <filename>-dbg</filename>, and <filename>-staticdev</filename> + package exists per recipe. + </para> + </section> + + <section id='migration-2.0-recipe-maintenance-tracking-data-moved-to-oe-core'> + <title>Recipe Maintenance Tracking Data Moved to OE-Core</title> + + <para> + Maintenance tracking data for recipes that was previously part + of <filename>meta-yocto</filename> has been moved to OE-Core. + The change includes <filename>package_regex.inc</filename> and + <filename>distro_alias.inc</filename>, which are typically enabled + when using the + <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> + class. + Additionally, the contents of + <filename>upstream_tracking.inc</filename> has now been split out + to the relevant recipes. + </para> + </section> + + <section id='migration-2.0-automatic-stale-sysroot-file-cleanup'> + <title>Automatic Stale Sysroot File Cleanup</title> + + <para> + Stale files from recipes that no longer exist in the current + configuration are now automatically removed from + sysroot as well as removed from + any other place managed by shared state. + This automatic cleanup means that the build system now properly + handles situations such as renaming the build system side of + recipes, removal of layers from + <filename>bblayers.conf</filename>, and + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> + changes. + </para> + + <para> + Additionally, work directories for old versions of recipes are + now pruned. + If you wish to disable pruning old work directories, you can set + the following variable in your configuration: + <literallayout class='monospaced'> + SSTATE_PRUNE_OBSOLETEWORKDIR = "0" + </literallayout> + </para> + </section> + + <section id='migration-2.0-linux-yocto-kernel-metadata-repository-now-split-from-source'> + <title><filename>linux-yocto</filename> Kernel Metadata Repository Now Split from Source</title> + + <para> + The <filename>linux-yocto</filename> tree has up to now been a + combined set of kernel changes and configuration (meta) data + carried in a single tree. + While this format is effective at keeping kernel configuration and + source modifications synchronized, it is not always obvious to + developers how to manipulate the Metadata as compared to the + source. + </para> + + <para> + Metadata processing has now been removed from the + <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link> + class and the external Metadata repository + <filename>yocto-kernel-cache</filename>, which has always been used + to seed the <filename>linux-yocto</filename> "meta" branch. + This separate <filename>linux-yocto</filename> cache repository + is now the primary location for this data. + Due to this change, <filename>linux-yocto</filename> is no longer + able to process combined trees. + Thus, if you need to have your own combined kernel repository, + you must do the split there as well and update your recipes + accordingly. + See the <filename>meta/recipes-kernel/linux/linux-yocto_4.1.bb</filename> + recipe for an example. + </para> + </section> + + <section id='migration-2.0-additional-qa-checks'> + <title>Additional QA checks</title> + + <para> + The following QA checks have been added: + <itemizedlist> + <listitem><para> + Added a "host-user-contaminated" check for ownership + issues for packaged files outside of + <filename>/home</filename>. + The check looks for files that are incorrectly owned by the + user that ran BitBake instead of owned by a valid user in + the target system. + </para></listitem> + <listitem><para> + Added an "invalid-chars" check for invalid (non-UTF8) + characters in recipe metadata variable values + (i.e. + <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link>, + <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link>, + <link linkend='var-LICENSE'><filename>LICENSE</filename></link>, + and + <link linkend='var-SECTION'><filename>SECTION</filename></link>). + Some package managers do not support these characters. + </para></listitem> + <listitem><para> + Added an "invalid-packageconfig" check for any options + specified in + <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> + that do not match any <filename>PACKAGECONFIG</filename> + option defined for the recipe. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.0-miscellaneous'> + <title>Miscellaneous Changes</title> + + <para> + These additional changes exist: + <itemizedlist> + <listitem><para> + <filename>gtk-update-icon-cache</filename> has been + renamed to <filename>gtk-icon-utils</filename>. + </para></listitem> + <listitem><para> + The <filename>tools-profile</filename> + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> + item as well as its corresponding packagegroup and + <filename>packagegroup-core-tools-profile</filename> no + longer bring in <filename>oprofile</filename>. + Bringing in <filename>oprofile</filename> was originally + added to aid compilation on resource-constrained + targets. + However, this aid has not been widely used and is not + likely to be used going forward due to the more powerful + target platforms and the existence of better + cross-compilation tools. + </para></listitem> + <listitem><para> + The + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + variable's default value now specifies + <filename>ext4</filename> instead of + <filename>ext3</filename>. + </para></listitem> + <listitem><para> + All support for the <filename>PRINC</filename> + variable has been removed. + </para></listitem> + <listitem><para> + The <filename>packagegroup-core-full-cmdline</filename> + packagegroup no longer brings in + <filename>lighttpd</filename> due to the fact that + bringing in <filename>lighttpd</filename> is not really in + line with the packagegroup's purpose, which is to add full + versions of command-line tools that by default are + provided by <filename>busybox</filename>. + </para></listitem> + </itemizedlist> + </para> + </section> +</section> + +<section id='moving-to-the-yocto-project-2.1-release'> + <title>Moving to the Yocto Project 2.1 Release</title> + + <para> + This section provides migration information for moving to the + Yocto Project 2.1 Release from the prior release. + </para> + + <section id='migration-2.1-variable-expansion-in-python-functions'> + <title>Variable Expansion in Python Functions</title> + + <para> + Variable expressions, such as + <filename>${</filename><replaceable>varname</replaceable><filename>}</filename> + no longer expand automatically within Python functions. + Suppressing expansion was done to allow Python functions to + construct shell scripts or other code for situations in which you + do not want such expressions expanded. + For any existing code that relies on these expansions, you need to + change the expansions to either expand the value of individual + variables through <filename>d.getVar()</filename>. + To alternatively expand more complex expressions, + use <filename>d.expand()</filename>. + </para> + </section> + + <section id='migration-2.1-overrides-must-now-be-lower-case'> + <title>Overrides Must Now be Lower-Case</title> + + <para> + The convention for overrides has always been for them to be + lower-case characters. + This practice is now a requirement as BitBake's datastore now + assumes lower-case characters in order to give a slight performance + boost during parsing. + In practical terms, this requirement means that anything that ends + up in + <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> + must now appear in lower-case characters (e.g. values for + <filename>MACHINE</filename>, <filename>TARGET_ARCH</filename>, + <filename>DISTRO</filename>, and also recipe names if + <filename>_pn-</filename><replaceable>recipename</replaceable> + overrides are to be effective). + </para> + </section> + + <section id='migration-2.1-expand-parameter-to-getvar-and-getvarflag-now-mandatory'> + <title>Expand Parameter to <filename>getVar()</filename> and + <filename>getVarFlag()</filename> is Now Mandatory</title> + + <para> + The expand parameter to <filename>getVar()</filename> and + <filename>getVarFlag()</filename> previously defaulted to + False if not specified. + Now, however, no default exists so one must be specified. + You must change any <filename>getVar()</filename> calls that + do not specify the final expand parameter to calls that do specify + the parameter. + You can run the following <filename>sed</filename> command at the + base of a layer to make this change: + <literallayout class='monospaced'> + sed -e 's:\(\.getVar([^,()]*\)):\1, False):g' -i `grep -ril getVar *` + sed -e 's:\(\.getVarFlag([^,()]*, [^,()]*\)):\1, False):g' -i `grep -ril getVarFlag *` + </literallayout> + <note> + The reason for this change is that it prepares the way for + changing the default to True in a future Yocto Project release. + This future change is a much more sensible default than False. + However, the change needs to be made gradually as a sudden + change of the default would potentially cause side-effects + that would be difficult to detect. + </note> + </para> + </section> + + <section id='migration-2.1-makefile-environment-changes'> + <title>Makefile Environment Changes</title> + + <para> + <link linkend='var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></link> + now defaults to "" instead of "-e MAKEFLAGS=". + Setting <filename>EXTRA_OEMAKE</filename> to "-e MAKEFLAGS=" by + default was a historical accident that has required many classes + (e.g. <filename>autotools</filename>, <filename>module</filename>) + and recipes to override this default in order to work with + sensible build systems. + When upgrading to the release, you must edit any recipe that + relies upon this old default by either setting + <filename>EXTRA_OEMAKE</filename> back to "-e MAKEFLAGS=" or by + explicitly setting any required variable value overrides using + <filename>EXTRA_OEMAKE</filename>, which is typically only needed + when a Makefile sets a default value for a variable that is + inappropriate for cross-compilation using the "=" operator rather + than the "?=" operator. + </para> + </section> + + <section id='migration-2.1-libexecdir-reverted-to-prefix-libexec'> + <title><filename>libexecdir</filename> Reverted to <filename>${prefix}/libexec</filename></title> + + <para> + The use of <filename>${libdir}/${BPN}</filename> as + <filename>libexecdir</filename> is different as compared to all + other mainstream distributions, which either uses + <filename>${prefix}/libexec</filename> or + <filename>${libdir}</filename>. + The use is also contrary to the GNU Coding Standards + (i.e. <ulink url='https://www.gnu.org/prep/standards/html_node/Directory-Variables.html'></ulink>) + that suggest <filename>${prefix}/libexec</filename> and also + notes that any package-specific nesting should be done by the + package itself. + Finally, having <filename>libexecdir</filename> change between + recipes makes it very difficult for different recipes to invoke + binaries that have been installed into + <filename>libexecdir</filename>. + The Filesystem Hierarchy Standard + (i.e. <ulink url='http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html'></ulink>) + now recognizes the use of <filename>${prefix}/libexec/</filename>, + giving distributions the choice between + <filename>${prefix}/lib</filename> or + <filename>${prefix}/libexec</filename> without breaking FHS. + </para> + </section> + + <section id='migration-2.1-ac-cv-sizeof-off-t-no-longer-cached-in-site-files'> + <title><filename>ac_cv_sizeof_off_t</filename> is No Longer Cached in Site Files</title> + + <para> + For recipes inheriting the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class, <filename>ac_cv_sizeof_off_t</filename> is no longer cached + in the site files for <filename>autoconf</filename>. + The reason for this change is because the + <filename>ac_cv_sizeof_off_t</filename> value is not necessarily + static per architecture as was previously assumed. + Rather, the value changes based on whether large file support is + enabled. + For most software that uses <filename>autoconf</filename>, this + change should not be a problem. + However, if you have a recipe that bypasses the standard + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task from the <filename>autotools</filename> class and the software + the recipe is building uses a very old version of + <filename>autoconf</filename>, the recipe might be incapable of + determining the correct size of <filename>off_t</filename> during + <filename>do_configure</filename>. + </para> + + <para> + The best course of action is to patch the software as necessary + to allow the default implementation from the + <filename>autotools</filename> class to work such that + <filename>autoreconf</filename> succeeds and produces a working + configure script), and to remove the + overridden <filename>do_configure</filename> task such that the + default implementation does get used. + </para> + </section> + + <section id='migration-2.1-image-generation-split-out-from-filesystem-generation'> + <title>Image Generation is Now Split Out from Filesystem Generation</title> + + <para> + Previously, for image recipes the + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + task assembled the filesystem and then from that filesystem + generated images. + With this Yocto Project release, image generation is split into + separate + <link linkend='ref-tasks-image'><filename>do_image_*</filename></link> + tasks for clarity both in operation and in the code. + </para> + + <para> + For most cases, this change does not present any problems. + However, if you have made customizations that directly modify the + <filename>do_rootfs</filename> task or that mention + <filename>do_rootfs</filename>, you might need to update those + changes. + In particular, if you had added any tasks after + <filename>do_rootfs</filename>, you should make edits so that + those tasks are after the + <link linkend='ref-tasks-image-complete'><filename>do_image_complete</filename></link> + task rather than before the task so that the your added tasks + run at the correct time. + </para> + + <para> + A minor part of this restructuring is that the post-processing + definitions and functions have been moved from the + <link linkend='ref-classes-image'><filename>image</filename></link> + class to the + <link linkend='ref-classes-rootfs*'><filename>rootfs-postcommands</filename></link> + class. + Functionally, however, they remain unchanged. + </para> + </section> + + <section id='migration-2.1-removed-recipes'> + <title>Removed Recipes</title> + + <para> + The following recipes have been removed in the 2.1 release: + <itemizedlist> + <listitem><para><filename>gcc</filename> version 4.8: + Versions 4.9 and 5.3 remain. + </para></listitem> + <listitem><para><filename>qt4</filename>: + All support for Qt 4.x has been moved out to a separate + <filename>meta-qt4</filename> layer because Qt 4 is no + longer supported upstream. + </para></listitem> + <listitem><para><filename>x11vnc</filename>: + Moved to the <filename>meta-oe</filename> layer. + </para></listitem> + <listitem><para><filename>linux-yocto-3.14</filename>: + No longer supported. + </para></listitem> + <listitem><para><filename>linux-yocto-3.19</filename>: + No longer supported. + </para></listitem> + <listitem><para><filename>libjpeg</filename>: + Replaced by the <filename>libjpeg-turbo</filename> recipe. + </para></listitem> + <listitem><para><filename>pth</filename>: + Became obsolete. + </para></listitem> + <listitem><para><filename>liboil</filename>: + Recipe is no longer needed and has been moved to the + <filename>meta-multimedia</filename> layer. + </para></listitem> + <listitem><para><filename>gtk-theme-torturer</filename>: + Recipe is no longer needed and has been moved to the + <filename>meta-gnome</filename> layer. + </para></listitem> + <listitem><para><filename>gnome-mime-data</filename>: + Recipe is no longer needed and has been moved to the + <filename>meta-gnome</filename> layer. + </para></listitem> + <listitem><para><filename>udev</filename>: + Replaced by the <filename>eudev</filename> recipe for + compatibility when using <filename>sysvinit</filename> + with newer kernels. + </para></listitem> + <listitem><para><filename>python-pygtk</filename>: + Recipe became obsolete. + </para></listitem> + <listitem><para><filename>adt-installer</filename>: + Recipe became obsolete. + See the + "<link linkend='migration-2.1-adt-removed'>ADT Removed</link>" + section for more information. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.1-class-changes'> + <title>Class Changes</title> + + <para> + The following classes have changed: + <itemizedlist> + <listitem><para><filename>autotools_stage</filename>: + Removed because the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class now provides its functionality. + Recipes that inherited from + <filename>autotools_stage</filename> should now inherit + from <filename>autotools</filename> instead. + </para></listitem> + <listitem><para><filename>boot-directdisk</filename>: + Merged into the + <link linkend='ref-classes-image-vm'><filename>image-vm</filename></link> + class. + The <filename>boot-directdisk</filename> class was rarely + directly used. + Consequently, this change should not cause any issues. + </para></listitem> + <listitem><para><filename>bootimg</filename>: + Merged into the + <link linkend='ref-classes-image-live'><filename>image-live</filename></link> + class. + The <filename>bootimg</filename> class was rarely + directly used. + Consequently, this change should not cause any issues. + </para></listitem> + <listitem><para><filename>packageinfo</filename>: + Removed due to its limited use by the Hob UI, which has + itself been removed. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.1-build-system-ui-changes'> + <title>Build System User Interface Changes</title> + + <para> + The following changes have been made to the build system user + interface: + <itemizedlist> + <listitem><para><emphasis>Hob GTK+-based UI</emphasis>: + Removed because it is unmaintained and based on the + outdated GTK+ 2 library. + The Toaster web-based UI is much more capable and is + actively maintained. + See the + "<ulink url='&YOCTO_DOCS_TOAST_URL;#using-the-toaster-web-interface'>Using the Toaster Web Interface</ulink>" + section in the Yocto Project Toaster User Manual for more + information on this interface. + </para></listitem> + <listitem><para><emphasis>"puccho" BitBake UI</emphasis>: + Removed because is unmaintained and no longer useful. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.1-adt-removed'> + <title>ADT Removed</title> + + <para> + The Application Development Toolkit (ADT) has been removed + because its functionality almost completely overlapped with the + <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-using-the-standard-sdk'>standard SDK</ulink> + and the + <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-extensible'>extensible SDK</ulink>. + For information on these SDKs and how to build and use them, see the + <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-intro'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>. + </para> + </section> + + <section id='migration-2.1-poky-reference-distribution-changes'> + <title>Poky Reference Distribution Changes</title> + + <para> + The following changes have been made for the Poky distribution: + <itemizedlist> + <listitem><para> + The <filename>meta-yocto</filename> layer has been renamed + to <filename>meta-poky</filename> to better match its + purpose, which is to provide the Poky reference + distribution. + The <filename>meta-yocto-bsp</filename> layer retains its + original name since it provides reference machines for + the Yocto Project and it is otherwise unrelated to Poky. + References to <filename>meta-yocto</filename> in your + <filename>conf/bblayers.conf</filename> should + automatically be updated, so you should not need to change + anything unless you are relying on this naming elsewhere. + </para></listitem> + <listitem><para> + The + <link linkend='ref-classes-uninative'><filename>uninative</filename></link> + class is now enabled by default in Poky. + This class attempts to isolate the build system from the + host distribution's C library and makes re-use of native + shared state artifacts across different host distributions + practical. + With this class enabled, a tarball containing a pre-built + C library is downloaded at the start of the build.</para> + + <para>The <filename>uninative</filename> class is enabled + through the + <filename>meta/conf/distro/include/yocto-uninative.inc</filename> + file, which for those not using the Poky distribution, can + include to easily enable the same functionality.</para> + + <para>Alternatively, if you wish to build your own + <filename>uninative</filename> tarball, you can do so by + building the <filename>uninative-tarball</filename> recipe, + making it available to your build machines + (e.g. over HTTP/HTTPS) and setting a similar configuration + as the one set by <filename>yocto-uninative.inc</filename>. + </para></listitem> + <listitem><para> + Static library generation, for most cases, is now disabled + by default in the Poky distribution. + Disabling this generation saves some build time as well + as the size used for build output artifacts.</para> + + <para>Disabling this library generation is accomplished + through a + <filename>meta/conf/distro/include/no-static-libs.inc</filename>, + which for those not using the Poky distribution can + easily include to enable the same functionality.</para> + + <para>Any recipe that needs to opt-out of having the + "--disable-static" option specified on the configure + command line either because it is not a supported option + for the configure script or because static libraries are + needed should set the following variable: + <literallayout class='monospaced'> + DISABLE_STATIC = "" + </literallayout> + </para></listitem> + <listitem><para> + The separate <filename>poky-tiny</filename> distribution + now uses the musl C library instead of a heavily pared + down <filename>glibc</filename>. + Using <filename>glibc</filename> results in a smaller + distribution and facilitates much greater maintainability + because musl is designed to have a small footprint.</para> + + <para>If you have used <filename>poky-tiny</filename> and + have customized the <filename>glibc</filename> + configuration you will need to redo those customizations + with musl when upgrading to the new release. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.1-packaging-changes'> + <title>Packaging Changes</title> + + <para> + The following changes have been made to packaging: + <itemizedlist> + <listitem><para> + The <filename>runuser</filename> and + <filename>mountpoint</filename> binaries, which were + previously in the main <filename>util-linux</filename> + package, have been split out into the + <filename>util-linux-runuser</filename> and + <filename>util-linux-mountpoint</filename> packages, + respectively. + </para></listitem> + <listitem><para> + The <filename>python-elementtree</filename> package has + been merged into the <filename>python-xml</filename> + package. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.1-tuning-file-changes'> + <title>Tuning File Changes</title> + + <para> + The following changes have been made to the tuning files: + <itemizedlist> + <listitem><para> + The "no-thumb-interwork" tuning feature has been dropped + from the ARM tune include files. + Because interworking is required for ARM EABI, attempting + to disable it through a tuning feature no longer makes + sense. + <note> + Support for ARM OABI was deprecated in gcc 4.7. + </note> + </para></listitem> + <listitem><para> + The <filename>tune-cortexm*.inc</filename> and + <filename>tune-cortexr4.inc</filename> files have been + removed because they are poorly tested. + Until the OpenEmbedded build system officially gains + support for CPUs without an MMU, these tuning files would + probably be better maintained in a separate layer + if needed. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='migration-2.1-miscellaneous-changes'> + <title>Miscellaneous Changes</title> + + <para> + These additional changes exist: + <itemizedlist> + <listitem><para> + The minimum Git version has been increased to 1.8.3.1. + If your host distribution does not provide a sufficiently + recent version, you can install the buildtools, which + will provide it. + </para></listitem> + <listitem><para> + The buggy and incomplete support for the RPM version 4 + package manager has been removed. + The well-tested and maintained support for RPM version 5 + remains. + </para></listitem> + <listitem><para> + The + <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-devtool-use-devtool-modify-to-modify-the-source-of-an-existing-component'><filename>devtool modify</filename></ulink> + command now defaults to extracting the source since that + is most commonly expected. + The "-x" or "--extract" options are now no-ops. + If you wish to provide your own existing source tree, you + will now need to specify either the "-n" or + "--no-extract" option when running + <filename>devtool modify</filename>. + </para></listitem> + <listitem><para> + If the formfactor for a machine is either not supplied + or does not specify whether a keyboard is attached, then + the default is to assume a keyboard is attached rather + than assume no keyboard. + <note> + This change primarily affects the Sato UI. + </note> + </para></listitem> + <listitem><para> + The <filename>.debug</filename> directory packaging is + now automatic. + If your recipe builds software that installs binaries into + directories other than the standard ones, you no longer + need to take care of setting + <filename>FILES_${PN}-dbg</filename> to pick up the + resulting <filename>.debug</filename> directories as these + directories are automatically found and added. + </para></listitem> + <listitem><para> + Inaccurate disk and CPU percentage data has been dropped + from <filename>buildstats</filename> output. + This data has been replaced with + <filename>getrusage()</filename> data and corrected IO + statistics. + You will probably need to update code that reads the + <filename>buildstats</filename> data. + </para></listitem> + <listitem><para> + The + <filename>meta/conf/distro/include/package_regex.inc</filename> + is now deprecated. + The contents of this file have been moved to individual + recipes. + <note><title>Tip</title> + Because this file will likely be removed in a future + Yocto Project release, it is suggested that you remove + any references to the file that might be in your + configuration. + </note> + </para></listitem> + <listitem><para> + The <filename>v86d/uvesafb</filename> has been removed from + the <filename>genericx86</filename> and + <filename>genericx86-64</filename> reference machines, + which are provided by the + <filename>meta-yocto-bsp</filename> layer. + Most modern x86 boards do not rely on this file and it only + adds kernel error messages during startup. + If you do still need the file, you can simply add + <filename>v86d</filename> to your image. + </para></listitem> + </itemizedlist> + </para> + </section> +</section> + +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-bitbake.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-bitbake.xml new file mode 100644 index 000000000..1de114826 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-bitbake.xml @@ -0,0 +1,472 @@ +<!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='ref-bitbake'> + + <title>BitBake</title> + + <para> + BitBake is a program written in Python that interprets the + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> used by + the OpenEmbedded build system. + At some point, developers wonder what actually happens when you enter: + <literallayout class='monospaced'> + $ bitbake core-image-sato + </literallayout> + </para> + + <para> + This chapter provides an overview of what happens behind the scenes from BitBake's perspective. + </para> + + <note> + BitBake strives to be a generic "task" executor that is capable of handling complex dependency relationships. + As such, it has no real knowledge of what the tasks being executed actually do. + BitBake just considers a list of tasks with dependencies and handles + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> + consisting of variables in a certain format that get passed to the tasks. + </note> + + <section id='ref-bitbake-parsing'> + <title>Parsing</title> + + <para> + BitBake parses configuration files, classes, and <filename>.bb</filename> files. + </para> + + <para> + The first thing BitBake does is look for the <filename>bitbake.conf</filename> file. + This file resides in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + within the <filename>meta/conf/</filename> directory. + BitBake finds it by examining its + <link linkend='var-BBPATH'><filename>BBPATH</filename></link> environment + variable and looking for the <filename>meta/conf/</filename> + directory. + </para> + + <para> + The <filename>bitbake.conf</filename> file lists other configuration + files to include from a <filename>conf/</filename> + directory below the directories listed in <filename>BBPATH</filename>. + In general, the most important configuration file from a user's perspective + is <filename>local.conf</filename>, which contains a user's customized + settings for the OpenEmbedded build environment. + Other notable configuration files are the distribution + configuration file (set by the + <filename><link linkend='var-DISTRO'>DISTRO</link></filename> variable) + and the machine configuration file + (set by the + <filename><link linkend='var-MACHINE'>MACHINE</link></filename> variable). + The <filename>DISTRO</filename> and <filename>MACHINE</filename> BitBake environment + variables are both usually set in + the <filename>local.conf</filename> file. + Valid distribution + configuration files are available in the <filename>meta/conf/distro/</filename> directory + and valid machine configuration + files in the <filename>meta/conf/machine/</filename> directory. + Within the <filename>meta/conf/machine/include/</filename> + directory are various <filename>tune-*.inc</filename> configuration files that provide common + "tuning" settings specific to and shared between particular architectures and machines. + </para> + + <para> + After the parsing of the configuration files, some standard classes are included. + The <filename>base.bbclass</filename> file is always included. + Other classes that are specified in the configuration using the + <filename><link linkend='var-INHERIT'>INHERIT</link></filename> + variable are also included. + Class files are searched for in a <filename>classes</filename> subdirectory + under the paths in <filename>BBPATH</filename> in the same way as + configuration files. + </para> + + <para> + After classes are included, the variable + <filename><link linkend='var-BBFILES'>BBFILES</link></filename> + is set, usually in + <filename>local.conf</filename>, and defines the list of places to search for + <filename>.bb</filename> files. + By default, the <filename>BBFILES</filename> variable specifies the + <filename>meta/recipes-*/</filename> directory within Poky. + Adding extra content to <filename>BBFILES</filename> is best achieved through the use of + BitBake layers as described in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and + Creating Layers</ulink>" section of the Yocto Project Development Manual. + </para> + + <para> + BitBake parses each <filename>.bb</filename> file in <filename>BBFILES</filename> and + stores the values of various variables. + In summary, for each <filename>.bb</filename> + file the configuration plus the base class of variables are set, followed + by the data in the <filename>.bb</filename> file + itself, followed by any inherit commands that + <filename>.bb</filename> file might contain. + </para> + + <para> + Because parsing <filename>.bb</filename> files is a time + consuming process, a cache is kept to speed up subsequent parsing. + This cache is invalid if the timestamp of the <filename>.bb</filename> + file itself changes, or if the timestamps of any of the include, + configuration files or class files on which the + <filename>.bb</filename> file depends change. + </para> + + <note> + <para> + You need to be aware of how BitBake parses curly braces. + If a recipe uses a closing curly brace within the function and + the character has no leading spaces, BitBake produces a parsing + error. + If you use a pair of curly brace in a shell function, the + closing curly brace must not be located at the start of the line + without leading spaces. + </para> + + <para> + Here is an example that causes BitBake to produce a parsing + error: + <literallayout class='monospaced'> + fakeroot create_shar() { + cat << "EOF" > ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh + usage() + { + echo "test" + ###### The following "}" at the start of the line causes a parsing error ###### + } + EOF + } + </literallayout> + Writing the recipe this way avoids the error: + <literallayout class='monospaced'> + fakeroot create_shar() { + cat << "EOF" > ${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.sh + usage() + { + echo "test" + ######The following "}" with a leading space at the start of the line avoids the error ###### + } + EOF + } + </literallayout> + </para> + </note> + </section> + + <section id='ref-bitbake-providers'> + <title>Preferences and Providers</title> + + <para> + Once all the <filename>.bb</filename> files have been + parsed, BitBake starts to build the target (<filename>core-image-sato</filename> + in the previous section's example) and looks for providers of that target. + Once a provider is selected, BitBake resolves all the dependencies for + the target. + In the case of <filename>core-image-sato</filename>, it would lead to + <filename>packagegroup-core-x11-sato</filename>, + which in turn leads to recipes like <filename>matchbox-terminal</filename>, + <filename>pcmanfm</filename> and <filename>gthumb</filename>. + These recipes in turn depend on <filename>glibc</filename> and the toolchain. + </para> + + <para> + Sometimes a target might have multiple providers. + A common example is "virtual/kernel", which is provided by each kernel package. + Each machine often selects the best kernel provider by using a line similar to the + following in the machine configuration file: + </para> + + <literallayout class='monospaced'> + PREFERRED_PROVIDER_virtual/kernel = "linux-yocto" + </literallayout> + + <para> + The default <filename><link linkend='var-PREFERRED_PROVIDER'>PREFERRED_PROVIDER</link></filename> + is the provider with the same name as the target. + </para> + + <para> + Understanding how providers are chosen is made complicated by the fact + that multiple versions might exist. + BitBake defaults to the highest version of a provider. + Version comparisons are made using the same method as Debian. + You can use the + <filename><link linkend='var-PREFERRED_VERSION'>PREFERRED_VERSION</link></filename> + variable to specify a particular version (usually in the distro configuration). + You can influence the order by using the + <filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE</link></filename> + variable. + By default, files have a preference of "0". + Setting the <filename>DEFAULT_PREFERENCE</filename> to "-1" makes the + package unlikely to be used unless it is explicitly referenced. + Setting the <filename>DEFAULT_PREFERENCE</filename> to "1" makes it likely the package is used. + <filename>PREFERRED_VERSION</filename> overrides any <filename>DEFAULT_PREFERENCE</filename> setting. + <filename>DEFAULT_PREFERENCE</filename> is often used to mark newer and more experimental package + versions until they have undergone sufficient testing to be considered stable. + </para> + + <para> + In summary, BitBake has created a list of providers, which is prioritized, for each target. + </para> + </section> + + <section id='ref-bitbake-dependencies'> + <title>Dependencies</title> + + <para> + Each target BitBake builds consists of multiple tasks such as + <filename>fetch</filename>, <filename>unpack</filename>, + <filename>patch</filename>, <filename>configure</filename>, + and <filename>compile</filename>. + For best performance on multi-core systems, BitBake considers each task as an independent + entity with its own set of dependencies. + </para> + + <para> + Dependencies are defined through several variables. + You can find information about variables BitBake uses in the BitBake documentation, + which is found in the <filename>bitbake/doc/manual</filename> directory within the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + At a basic level, it is sufficient to know that BitBake uses the + <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename> and + <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> variables when + calculating dependencies. + </para> + </section> + + <section id='ref-bitbake-tasklist'> + <title>The Task List</title> + + <para> + Based on the generated list of providers and the dependency information, + BitBake can now calculate exactly what tasks it needs to run and in what + order it needs to run them. + The build now starts with BitBake forking off threads up to the limit set in the + <filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link></filename> variable. + BitBake continues to fork threads as long as there are tasks ready to run, + those tasks have all their dependencies met, and the thread threshold has not been + exceeded. + </para> + + <para> + It is worth noting that you can greatly speed up the build time by properly setting + the <filename>BB_NUMBER_THREADS</filename> variable. + See the + "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" + section in the Yocto Project Quick Start for more information. + </para> + + <para> + As each task completes, a timestamp is written to the directory specified by the + <filename><link linkend='var-STAMP'>STAMP</link></filename> variable. + On subsequent runs, BitBake looks within the <filename>build/tmp/stamps</filename> + directory and does not rerun + tasks that are already completed unless a timestamp is found to be invalid. + Currently, invalid timestamps are only considered on a per + <filename>.bb</filename> file basis. + So, for example, if the configure stamp has a timestamp greater than the + compile timestamp for a given target, then the compile task would rerun. + Running the compile task again, however, has no effect on other providers + that depend on that target. + This behavior could change or become configurable in future versions of BitBake. + </para> + + <note> + Some tasks are marked as "nostamp" tasks. + No timestamp file is created when these tasks are run. + Consequently, "nostamp" tasks are always rerun. + </note> + </section> + + <section id='ref-bitbake-runtask'> + <title>Running a Task</title> + + <para> + Tasks can either be a shell task or a Python task. + For shell tasks, BitBake writes a shell script to + <filename>${WORKDIR}/temp/run.do_taskname.pid</filename> and then executes the script. + The generated shell script contains all the exported variables, and the shell functions + with all variables expanded. + Output from the shell script goes to the file <filename>${WORKDIR}/temp/log.do_taskname.pid</filename>. + Looking at the expanded shell functions in the run file and the output in the log files + is a useful debugging technique. + </para> + + <para> + For Python tasks, BitBake executes the task internally and logs information to the + controlling terminal. + Future versions of BitBake will write the functions to files similar to the way + shell tasks are handled. + Logging will be handled in a way similar to shell tasks as well. + </para> + + <para> + Once all the tasks have been completed BitBake exits. + </para> + + <para> + When running a task, BitBake tightly controls the execution environment + of the build tasks to make sure unwanted contamination from the build machine + cannot influence the build. + Consequently, if you do want something to get passed into the build + task's environment, you must take a few steps: + <orderedlist> + <listitem><para>Tell BitBake to load what you want from the environment + into the data store. + You can do so through the <filename>BB_ENV_EXTRAWHITE</filename> + variable. + For example, assume you want to prevent the build system from + accessing your <filename>$HOME/.ccache</filename> directory. + The following command tells BitBake to load + <filename>CCACHE_DIR</filename> from the environment into the data + store: + <literallayout class='monospaced'> + export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE CCACHE_DIR" + </literallayout></para></listitem> + <listitem><para>Tell BitBake to export what you have loaded into the + environment store to the task environment of every running task. + Loading something from the environment into the data store + (previous step) only makes it available in the datastore. + To export it to the task environment of every running task, + use a command similar to the following in your + <filename>local.conf</filename> or distro configuration file: + <literallayout class='monospaced'> + export CCACHE_DIR + </literallayout></para></listitem> + </orderedlist> + </para> + + <note> + A side effect of the previous steps is that BitBake records the variable + as a dependency of the build process in things like the shared state + checksums. + If doing so results in unnecessary rebuilds of tasks, you can whitelist the + variable so that the shared state code ignores the dependency when it creates + checksums. + For information on this process, see the <filename>BB_HASHBASE_WHITELIST</filename> + example in the "<link linkend='checksums'>Checksums (Signatures)</link>" section. + </note> + </section> + + <section id='ref-bitbake-commandline'> + <title>BitBake Command Line</title> + + <para> + Following is the BitBake help output: + </para> + + <screen> +$ bitbake --help +Usage: bitbake [options] [recipename/target ...] + + Executes the specified task (default is 'build') for a given set of target recipes (.bb files). + It is assumed there is a conf/bblayers.conf available in cwd or in BBPATH which + will provide the layer, BBFILES and other configuration information. + +Options: + --version show program's version number and exit + -h, --help show this help message and exit + -b BUILDFILE, --buildfile=BUILDFILE + Execute tasks from a specific .bb recipe directly. + WARNING: Does not handle any dependencies from other + recipes. + -k, --continue Continue as much as possible after an error. While the + target that failed and anything depending on it cannot + be built, as much as possible will be built before + stopping. + -a, --tryaltconfigs Continue with builds by trying to use alternative + providers where possible. + -f, --force Force the specified targets/task to run (invalidating + any existing stamp file). + -c CMD, --cmd=CMD Specify the task to execute. The exact options + available depend on the metadata. Some examples might + be 'compile' or 'populate_sysroot' or 'listtasks' may + give a list of the tasks available. + -C INVALIDATE_STAMP, --clear-stamp=INVALIDATE_STAMP + Invalidate the stamp for the specified task such as + 'compile' and then run the default task for the + specified target(s). + -r PREFILE, --read=PREFILE + Read the specified file before bitbake.conf. + -R POSTFILE, --postread=POSTFILE + Read the specified file after bitbake.conf. + -v, --verbose Output more log message data to the terminal. + -D, --debug Increase the debug level. You can specify this more + than once. + -n, --dry-run Don't execute, just go through the motions. + -S, --dump-signatures + Don't execute, just dump out the signature + construction information. + -p, --parse-only Quit after parsing the BB recipes. + -s, --show-versions Show current and preferred versions of all recipes. + -e, --environment Show the global or per-package environment complete + with information about where variables were + set/changed. + -g, --graphviz Save dependency tree information for the specified + targets in the dot syntax. + -I EXTRA_ASSUME_PROVIDED, --ignore-deps=EXTRA_ASSUME_PROVIDED + Assume these dependencies don't exist and are already + provided (equivalent to ASSUME_PROVIDED). Useful to + make dependency graphs more appealing + -l DEBUG_DOMAINS, --log-domains=DEBUG_DOMAINS + Show debug logging for the specified logging domains + -P, --profile Profile the command and save reports. + -u UI, --ui=UI The user interface to use (e.g. knotty and depexp). + -t SERVERTYPE, --servertype=SERVERTYPE + Choose which server to use, process or xmlrpc. + --revisions-changed Set the exit code depending on whether upstream + floating revisions have changed or not. + --server-only Run bitbake without a UI, only starting a server + (cooker) process. + -B BIND, --bind=BIND The name/address for the bitbake server to bind to. + --no-setscene Do not run any setscene tasks. sstate will be ignored + and everything needed, built. + --remote-server=REMOTE_SERVER + Connect to the specified server. + -m, --kill-server Terminate the remote server. + --observe-only Connect to a server as an observing-only client. + </screen> + </section> + + <section id='ref-bitbake-fetchers'> + <title>Fetchers</title> + + <para> + BitBake also contains a set of "fetcher" modules that allow + retrieval of source code from various types of sources. + For example, BitBake can get source code from a disk with the metadata, from websites, + from remote shell accounts, or from Source Code Management (SCM) systems + like <filename>cvs/subversion/git</filename>. + </para> + + <para> + Fetchers are usually triggered by entries in + <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename>. + You can find information about the options and formats of entries for specific + fetchers in the BitBake manual located in the + <filename>bitbake/doc/manual</filename> directory of the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + + <para> + One useful feature for certain Source Code Manager (SCM) fetchers is the ability to + "auto-update" when the upstream SCM changes version. + Since this ability requires certain functionality from the SCM, not all + systems support it. + Currently Subversion, Bazaar and to a limited extent, Git support the ability to "auto-update". + This feature works using the <filename><link linkend='var-SRCREV'>SRCREV</link></filename> + variable. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-srcrev'>Using an External SCM</ulink>" section + in the Yocto Project Development Manual for more information. + </para> + + </section> + +</chapter> +<!-- +vim: expandtab tw=80 ts=4 spell spelllang=en_gb +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-classes.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-classes.xml new file mode 100644 index 000000000..e919bd7eb --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-classes.xml @@ -0,0 +1,3715 @@ +<!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='ref-classes'> +<title>Classes</title> + +<para> + Class files are used to abstract common functionality and share it amongst + multiple recipe (<filename>.bb</filename>) files. + To use a class file, you simply make sure the recipe inherits the class. + In most cases, when a recipe inherits a class it is enough to enable its + features. + There are cases, however, where in the recipe you might need to set + variables or override some default behavior. +</para> + +<para> + Any <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> usually + found in a recipe can also be placed in a class file. + Class files are identified by the extension <filename>.bbclass</filename> + and are usually placed in a <filename>classes/</filename> directory beneath + the <filename>meta*/</filename> directory found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + Class files can also be pointed to by + <link linkend='var-BUILDDIR'><filename>BUILDDIR</filename></link> + (e.g. <filename>build/</filename>) in the same way as + <filename>.conf</filename> files in the <filename>conf</filename> directory. + Class files are searched for in + <link linkend='var-BBPATH'><filename>BBPATH</filename></link> + using the same method by which <filename>.conf</filename> files are + searched. +</para> + +<para> + This chapter discusses only the most useful and important classes. + Other classes do exist within the <filename>meta/classes</filename> + directory in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + You can reference the <filename>.bbclass</filename> files directly + for more information. +</para> + +<section id='ref-classes-allarch'> + <title><filename>allarch.bbclass</filename></title> + + <para> + The <filename>allarch</filename> class is inherited + by recipes that do not produce architecture-specific output. + The class disables functionality that is normally needed for recipes + that produce executable binaries (such as building the cross-compiler + and a C library as pre-requisites, and splitting out of debug symbols + during packaging). + <note> + <para>Unlike some distro recipes (e.g. Debian), OpenEmbedded recipes + that produce packages that depend on tunings through use of the + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + and + <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link> + variables, should never be configured for all architectures + using <filename>allarch</filename>. + This is the case even if the recipes do not produce + architecture-specific output.</para> + <para>Configuring such recipes for all architectures causes the + <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_*</filename></link> + tasks to have different signatures for the machines with different + tunings. + Additionally, unnecessary rebuilds occur every time an + image for a different <filename>MACHINE</filename> is built + even when the recipe never changes.</para> + </note> + </para> + + <para> + By default, all recipes inherit the + <link linkend='ref-classes-base'><filename>base</filename></link> and + <link linkend='ref-classes-package'><filename>package</filename></link> + classes, which enable functionality + needed for recipes that produce executable output. + If your recipe, for example, only produces packages that contain + configuration files, media files, or scripts (e.g. Python and Perl), + then it should inherit the <filename>allarch</filename> class. + </para> +</section> + +<section id='ref-classes-archiver'> + <title><filename>archiver.bbclass</filename></title> + + <para> + The <filename>archiver</filename> class supports releasing + source code and other materials with the binaries. + </para> + + <para> + For more details on the source archiver, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" + section in the Yocto Project Development Manual. + You can also see the + <link linkend='var-ARCHIVER_MODE'><filename>ARCHIVER_MODE</filename></link> + variable for information about the variable flags (varflags) + that help control archive creation. + </para> +</section> + +<section id='ref-classes-autotools'> + <title><filename>autotools*.bbclass</filename></title> + + <para> + The <filename>autotools*</filename> classes support Autotooled + packages. + </para> + + <para> + The <filename>autoconf</filename>, <filename>automake</filename>, + and <filename>libtool</filename> packages bring standardization. + This class defines a set of tasks (e.g. + <filename>configure</filename>, <filename>compile</filename> and + so forth) that + work for all Autotooled packages. + It should usually be enough to define a few standard variables + and then simply <filename>inherit autotools</filename>. + These classes can also work with software that emulates Autotools. + For more information, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-autotooled-package'>Autotooled Package</ulink>" + section in the Yocto Project Development Manual. + </para> + + <para> + By default, the <filename>autotools*</filename> classes + use out-of-tree builds (i.e. + <filename>autotools.bbclass</filename>). + (<link linkend='var-B'><filename>B</filename></link> <filename>!=</filename> + <link linkend='var-S'><filename>S</filename></link>). + </para> + + <para> + If the software being built by a recipe does not support + using out-of-tree builds, you should have the recipe inherit the + <filename>autotools-brokensep</filename> class. + The <filename>autotools-brokensep</filename> class behaves the same + as the <filename>autotools</filename> class but builds with + <link linkend='var-B'><filename>B</filename></link> == + <link linkend='var-S'><filename>S</filename></link>. + This method is useful when out-of-tree build support is either not + present or is broken. + <note> + It is recommended that out-of-tree support be fixed and used + if at all possible. + </note> + </para> + + <para> + It's useful to have some idea of how the tasks defined by + the <filename>autotools*</filename> classes work and what they do + behind the scenes. + <itemizedlist> + <listitem><para><link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - + Regenerates the + configure script (using <filename>autoreconf</filename>) and + then launches it with a standard set of arguments used during + cross-compilation. + You can pass additional parameters to + <filename>configure</filename> through the + <filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></filename> variable. + </para></listitem> + <listitem><para><link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - + Runs <filename>make</filename> with arguments that specify the + compiler and linker. + You can pass additional arguments through + the <filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></filename> variable. + </para></listitem> + <listitem><para><link linkend='ref-tasks-install'><filename>do_install</filename></link> - + Runs <filename>make install</filename> and passes in + <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> + as <filename>DESTDIR</filename>. + </para></listitem> + </itemizedlist> + </para> +</section> + +<section id='ref-classes-base'> + <title><filename>base.bbclass</filename></title> + + <para> + The <filename>base</filename> class is special in that every + <filename>.bb</filename> file implicitly inherits the class. + This class contains definitions for standard basic + tasks such as fetching, unpacking, configuring (empty by default), + compiling (runs any <filename>Makefile</filename> present), installing + (empty by default) and packaging (empty by default). + These classes are often overridden or extended by other classes + such as the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class or the + <link linkend='ref-classes-package'><filename>package</filename></link> + class. + The class also contains some commonly used functions such as + <filename>oe_runmake</filename>. + </para> +</section> + +<section id='ref-classes-bash-completion'> + <title><filename>bash-completion.bbclass</filename></title> + + <para> + Sets up packaging and dependencies appropriate for recipes that + build software that includes bash-completion data. + </para> +</section> + +<section id='ref-classes-bin-package'> + <title><filename>bin_package.bbclass</filename></title> + + <para> + The <filename>bin_package</filename> class is a + helper class for recipes that extract the contents of a binary package + (e.g. an RPM) and install those contents rather than building the + binary from source. + The binary package is extracted and new packages in the configured + output package format are created. + Extraction and installation of proprietary binaries is a good example + use for this class. + <note> + For RPMs and other packages that do not contain a subdirectory, + you should specify an appropriate fetcher parameter to point to + the subdirectory. + For example, if BitBake is using the Git fetcher + (<filename>git://</filename>), the "subpath" parameter limits + the checkout to a specific subpath of the tree. + Here is an example where <filename>${BP}</filename> is used so that + the files are extracted into the subdirectory expected by the + default value of + <link linkend='var-S'><filename>S</filename></link>: + <literallayout class='monospaced'> + SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}" + </literallayout> + See the + "<ulink url='&YOCTO_DOCS_BB_URL;#bb-fetchers'>Fetchers</ulink>" + section in the BitBake User Manual for more information on + supported BitBake Fetchers. + </note> + </para> +</section> + +<section id='ref-classes-binconfig'> + <title><filename>binconfig.bbclass</filename></title> + + <para> + The <filename>binconfig</filename> class helps to correct paths in + shell scripts. + </para> + + <para> + Before <filename>pkg-config</filename> had become widespread, libraries + shipped shell scripts to give information about the libraries and + include paths needed to build software (usually named + <filename>LIBNAME-config</filename>). + This class assists any recipe using such scripts. + </para> + + <para> + During staging, the OpenEmbedded build system installs such scripts + into the <filename>sysroots/</filename> directory. + Inheriting this class results in all paths in these scripts being + changed to point into the <filename>sysroots/</filename> directory so + that all builds that use the script use the correct directories + for the cross compiling layout. + See the + <link linkend='var-BINCONFIG_GLOB'><filename>BINCONFIG_GLOB</filename></link> + variable for more information. + </para> +</section> + +<section id='ref-classes-binconfig-disabled'> + <title><filename>binconfig-disabled.bbclass</filename></title> + + <para> + An alternative version of the + <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> + class, which disables binary configuration scripts by making them + return an error in favor of using <filename>pkg-config</filename> + to query the information. + The scripts to be disabled should be specified using the + <link linkend='var-BINCONFIG'><filename>BINCONFIG</filename></link> + variable within the recipe inheriting the class. + </para> +</section> + +<section id='ref-classes-blacklist'> + <title><filename>blacklist.bbclass</filename></title> + + <para> + The <filename>blacklist</filename> class prevents + the OpenEmbedded build system from building specific recipes + (blacklists them). + To use this class, inherit the class globally and set + <link linkend='var-PNBLACKLIST'><filename>PNBLACKLIST</filename></link> + for each recipe you wish to blacklist. + Specify the <link linkend='var-PN'><filename>PN</filename></link> + value as a variable flag (varflag) and provide a reason, which is + reported, if the package is requested to be built as the value. + For example, if you want to blacklist a recipe called "exoticware", + you add the following to your <filename>local.conf</filename> + or distribution configuration: + <literallayout class='monospaced'> + INHERIT += "blacklist" + PNBLACKLIST[exoticware] = "Not supported by our organization." + </literallayout> + </para> +</section> + +<section id='ref-classes-bluetooth'> + <title><filename>bluetooth.bbclass</filename></title> + + <para> + The <filename>bluetooth</filename> class defines a variable that + expands to the recipe (package) providing core + bluetooth support on the platform. + </para> + + <para> + For details on how the class works, see the + <filename>meta/classes/bluetooth.bbclass</filename> file in the Yocto + Project + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> +</section> + +<section id='ref-classes-bugzilla'> + <title><filename>bugzilla.bbclass</filename></title> + + <para> + The <filename>bugzilla</filename> class supports setting up an + instance of Bugzilla in which you can automatically files bug reports + in response to build failures. + For this class to work, you need to enable the XML-RPC interface in + the instance of Bugzilla. + </para> +</section> + +<section id='ref-classes-buildhistory'> + <title><filename>buildhistory.bbclass</filename></title> + + <para> + The <filename>buildhistory</filename> class records a + history of build output metadata, which can be used to detect possible + regressions as well as used for analysis of the build output. + For more information on using Build History, see the + "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>" + section. + </para> +</section> + +<section id='ref-classes-buildstats'> + <title><filename>buildstats.bbclass</filename></title> + + <para> + The <filename>buildstats</filename> class records + performance statistics about each task executed during the build + (e.g. elapsed time, CPU usage, and I/O usage). + </para> + + <para> + When you use this class, the output goes into the + <link linkend='var-BUILDSTATS_BASE'><filename>BUILDSTATS_BASE</filename></link> + directory, which defaults to <filename>${TMPDIR}/buildstats/</filename>. + You can analyze the elapsed time using + <filename>scripts/pybootchartgui/pybootchartgui.py</filename>, which + produces a cascading chart of the entire build process and can be + useful for highlighting bottlenecks. + </para> + + <para> + Collecting build statistics is enabled by default through the + <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> + variable from your <filename>local.conf</filename> file. + Consequently, you do not have to do anything to enable the class. + However, if you want to disable the class, simply remove "buildstats" + from the <filename>USER_CLASSES</filename> list. + </para> +</section> + +<section id='ref-classes-buildstats-summary'> + <title><filename>buildstats-summary.bbclass</filename></title> + + <para> + When inherited globally, prints statistics at the end of the build + on sstate re-use. + In order to function, this class requires the + <link linkend='ref-classes-buildstats'><filename>buildstats</filename></link> + class be enabled. + </para> +</section> + +<section id='ref-classes-ccache'> + <title><filename>ccache.bbclass</filename></title> + + <para> + The <filename>ccache</filename> class enables the + <ulink url='http://ccache.samba.org/'>C/C++ Compiler Cache</ulink> + for the build. + This class is used to give a minor performance boost during the build. + However, using the class can lead to unexpected side-effects. + Thus, it is recommended that you do not use this class. + See <ulink url='http://ccache.samba.org/'></ulink> for information on + the C/C++ Compiler Cache. + </para> +</section> + +<section id='ref-classes-chrpath'> + <title><filename>chrpath.bbclass</filename></title> + + <para> + The <filename>chrpath</filename> class + is a wrapper around the "chrpath" utility, which is used during the + build process for <filename>nativesdk</filename>, + <filename>cross</filename>, and + <filename>cross-canadian</filename> recipes to change + <filename>RPATH</filename> records within binaries in order to make + them relocatable. + </para> +</section> + +<section id='ref-classes-clutter'> + <title><filename>clutter.bbclass</filename></title> + + <para> + The <filename>clutter</filename> class consolidates the + major and minor version naming and other common items used by Clutter + and related recipes. + <note> + Unlike some other classes related to specific libraries, recipes + building other software that uses Clutter do not need to + inherit this class unless they use the same recipe versioning + scheme that the Clutter and related recipes do. + </note> + </para> +</section> + +<section id='ref-classes-cmake'> + <title><filename>cmake.bbclass</filename></title> + + <para> + The <filename>cmake</filename> class allows for + recipes that need to build software using the CMake build system. + You can use the + <link linkend='var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></link> + variable to specify additional configuration options to be passed on + the <filename>cmake</filename> command line. + </para> +</section> + +<section id='ref-classes-cml1'> + <title><filename>cml1.bbclass</filename></title> + + <para> + The <filename>cml1</filename> class provides basic support for the + Linux kernel style build configuration system. + </para> +</section> + +<section id='ref-classes-compress_doc'> + <title><filename>compress_doc.bbclass</filename></title> + + <para> + Enables compression for man pages and info pages. + This class is intended to be inherited globally. + The default compression mechanism is gz (gzip) but you can + select an alternative mechanism by setting the + <link linkend='var-DOC_COMPRESS'><filename>DOC_COMPRESS</filename></link> + variable. + </para> +</section> + +<section id='ref-classes-copyleft_compliance'> + <title><filename>copyleft_compliance.bbclass</filename></title> + + <para> + The <filename>copyleft_compliance</filename> class + preserves source code for the purposes of license compliance. + This class is an alternative to the <filename>archiver</filename> + class and is still used by some users even though it has been + deprecated in favor of the + <link linkend='ref-classes-archiver'><filename>archiver</filename></link> + class. + </para> +</section> + +<section id='ref-classes-copyleft_filter'> + <title><filename>copyleft_filter.bbclass</filename></title> + + <para> + A class used by the + <link linkend='ref-classes-archiver'><filename>archiver</filename></link> + and + <link linkend='ref-classes-copyleft_compliance'><filename>copyleft_compliance</filename></link> + classes for filtering licenses. + The <filename>copyleft_filter</filename> class is an internal class + and is not intended to be used directly. + </para> +</section> + +<section id='ref-classes-core-image'> + <title><filename>core-image.bbclass</filename></title> + + <para> + The <filename>core-image</filename> class + provides common definitions for the + <filename>core-image-*</filename> image recipes, such as support for + additional + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. + </para> +</section> + +<section id='ref-classes-cpan'> + <title><filename>cpan*.bbclass</filename></title> + + <para> + The <filename>cpan*</filename> classes support Perl modules. + </para> + + <para> + Recipes for Perl modules are simple. + These recipes usually only need to point to the source's archive and + then inherit the proper class file. + Building is split into two methods depending on which method the module + authors used. + <itemizedlist> + <listitem><para>Modules that use old + <filename>Makefile.PL</filename>-based build system require + <filename>cpan.bbclass</filename> in their recipes. + </para></listitem> + <listitem><para>Modules that use + <filename>Build.PL</filename>-based build system require + using <filename>cpan_build.bbclass</filename> in their recipes. + </para></listitem> + </itemizedlist> + Both build methods inherit the <filename>cpan-base</filename> class + for basic Perl support. + </para> +</section> + +<section id='ref-classes-cross'> + <title><filename>cross.bbclass</filename></title> + + <para> + The <filename>cross</filename> class provides support for the recipes + that build the cross-compilation tools. + </para> +</section> + +<section id='ref-classes-cross-canadian'> + <title><filename>cross-canadian.bbclass</filename></title> + + <para> + The <filename>cross-canadian</filename> class + provides support for the recipes that build the Canadian + Cross-compilation tools for SDKs. + See the + "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" + section for more discussion on these cross-compilation tools. + </para> +</section> + +<section id='ref-classes-crosssdk'> + <title><filename>crosssdk.bbclass</filename></title> + + <para> + The <filename>crosssdk</filename> class + provides support for the recipes that build the cross-compilation + tools used for building SDKs. + See the + "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" + section for more discussion on these cross-compilation tools. + </para> +</section> + +<section id='ref-classes-debian'> + <title><filename>debian.bbclass</filename></title> + + <para> + The <filename>debian</filename> class renames output packages so that + they follow the Debian naming policy (i.e. <filename>glibc</filename> + becomes <filename>libc6</filename> and <filename>glibc-devel</filename> + becomes <filename>libc6-dev</filename>.) + Renaming includes the library name and version as part of the package + name. + </para> + + <para> + If a recipe creates packages for multiple libraries + (shared object files of <filename>.so</filename> type), use the + <link linkend='var-LEAD_SONAME'><filename>LEAD_SONAME</filename></link> + variable in the recipe to specify the library on which to apply the + naming scheme. + </para> +</section> + +<section id='ref-classes-deploy'> + <title><filename>deploy.bbclass</filename></title> + + <para> + The <filename>deploy</filename> class handles deploying files + to the + <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> + directory. + The main function of this class is to allow the deploy step to be + accelerated by shared state. + Recipes that inherit this class should define their own + <link linkend='ref-tasks-deploy'><filename>do_deploy</filename></link> + function to copy the files to be deployed to + <link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link>, + and use <filename>addtask</filename> to add the task at the appropriate + place, which is usually after + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + or + <link linkend='ref-tasks-install'><filename>do_install</filename></link>. + The class then takes care of staging the files from + <filename>DEPLOYDIR</filename> to + <filename>DEPLOY_DIR_IMAGE</filename>. + </para> +</section> + +<section id='ref-classes-devshell'> + <title><filename>devshell.bbclass</filename></title> + + <para> + The <filename>devshell</filename> class adds the + <filename>do_devshell</filename> task. + Distribution policy dictates whether to include this class. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section + in the Yocto Project Development Manual for more information about + using <filename>devshell</filename>. + </para> +</section> + +<section id='ref-classes-distro_features_check'> + <title><filename>distro_features_check.bbclass</filename></title> + + <para> + The <filename>distro_features_check</filename> class + allows individual recipes to check for required and conflicting + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. + </para> + + <para> + This class provides support for the + <link linkend='var-REQUIRED_DISTRO_FEATURES'><filename>REQUIRED_DISTRO_FEATURES</filename></link> + and + <link linkend='var-CONFLICT_DISTRO_FEATURES'><filename>CONFLICT_DISTRO_FEATURES</filename></link> + variables. + If any conditions specified in the recipe using the above variables are + not met, the recipe will be skipped. + </para> +</section> + +<section id='ref-classes-distrodata'> + <title><filename>distrodata.bbclass</filename></title> + + <para> + The <filename>distrodata</filename> class + provides for automatic checking for upstream recipe updates. + The class creates a comma-separated value (CSV) spreadsheet that + contains information about the recipes. + The information provides the + <link linkend='ref-tasks-distrodata'><filename>do_distrodata</filename></link> + and + <filename>do_distro_check</filename> tasks, which do upstream checking + and also verify if a package is used in multiple major distributions. + </para> + + <para> + The class is not included by default. + To use it, you must set the + <link linkend='var-INHERIT'><filename>INHERIT</filename></link> + variable: + <literallayout class='monospaced'> + INHERIT+= "distrodata" + </literallayout> + </para> + + <para> + The <filename>distrodata</filename> class also provides the + <link linkend='ref-tasks-checkpkg'><filename>do_checkpkg</filename></link> + task, which can be used against a simple recipe or against an + image to get all its recipe information. + </para> +</section> + +<section id='ref-classes-distutils'> + <title><filename>distutils*.bbclass</filename></title> + + <para> + The <filename>distutils*</filename> classes support recipes for Python + version 2.x extensions, which are simple. + These recipes usually only need to point to the source's archive and + then inherit the proper class. + Building is split into two methods depending on which method the + module authors used. + <itemizedlist> + <listitem><para>Extensions that use an Autotools-based build system + require Autotools and the classes based on + <filename>distutils</filename> in their recipes. + </para></listitem> + <listitem><para>Extensions that use build systems based on + <filename>distutils</filename> require + the <filename>distutils</filename> class in their recipes. + </para></listitem> + <listitem><para>Extensions that use build systems based on + <filename>setuptools</filename> require the + <link linkend='ref-classes-setuptools'><filename>setuptools</filename></link> + class in their recipes. + </para></listitem> + </itemizedlist> + The <filename>distutils-common-base</filename> class is required by + some of the <filename>distutils*</filename> classes to provide common + Python2 support. + </para> + + <para> + The <filename>distutils-tools</filename> class supports recipes for + additional "distutils" tools. + </para> +</section> + +<section id='ref-classes-distutils3'> + <title><filename>distutils3*.bbclass</filename></title> + + <para> + The <filename>distutils3*</filename> classes support recipes for Python + version 3.x extensions, which are simple. + These recipes usually only need to point to the source's archive and + then inherit the proper class. + Building is split into three methods depending on which method the + module authors used. + <itemizedlist> + <listitem><para>Extensions that use an Autotools-based build system + require Autotools and + <filename>distutils</filename>-based classes in their recipes. + </para></listitem> + <listitem><para>Extensions that use + <filename>distutils</filename>-based build systems require + the <filename>distutils</filename> class in their recipes. + </para></listitem> + <listitem><para>Extensions that use build systems based on + <filename>setuptools3</filename> require the + <link linkend='ref-classes-setuptools'><filename>setuptools3</filename></link> + class in their recipes. + </para></listitem> + </itemizedlist> + The <filename>distutils3*</filename> classes either inherit their + corresponding <filename>distutils*</filename> class or replicate them + using a Python3 version instead (e.g. + <filename>distutils3-base</filename> inherits + <filename>distutils-common-base</filename>, which is the same as + <filename>distutils-base</filename> but inherits + <filename>python3native</filename> instead of + <filename>pythonnative</filename>). + </para> +</section> + +<section id='ref-classes-externalsrc'> + <title><filename>externalsrc.bbclass</filename></title> + + <para> + The <filename>externalsrc</filename> class supports building software + from source code that is external to the OpenEmbedded build system. + Building software from an external source tree means that the build + system's normal fetch, unpack, and patch process is not used. + </para> + + <para> + By default, the OpenEmbedded build system uses the + <link linkend='var-S'><filename>S</filename></link> and + <link linkend='var-B'><filename>B</filename></link> variables to + locate unpacked recipe source code and to build it, respectively. + When your recipe inherits the <filename>externalsrc</filename> class, + you use the + <link linkend='var-EXTERNALSRC'><filename>EXTERNALSRC</filename></link> + and + <link linkend='var-EXTERNALSRC_BUILD'><filename>EXTERNALSRC_BUILD</filename></link> + variables to ultimately define <filename>S</filename> and + <filename>B</filename>. + </para> + + <para> + By default, this class expects the source code to support recipe builds + that use the <link linkend='var-B'><filename>B</filename></link> + variable to point to the directory in which the OpenEmbedded build + system places the generated objects built from the recipes. + By default, the <filename>B</filename> directory is set to the + following, which is separate from the source directory + (<filename>S</filename>): + <literallayout class='monospaced'> + ${WORKDIR}/${BPN}/{PV}/ + </literallayout> + See these variables for more information: + <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>, + <link linkend='var-BPN'><filename>BPN</filename></link>, and + <link linkend='var-PV'><filename>PV</filename></link>, + </para> + + <para> + For more information on the + <filename>externalsrc</filename> class, see the comments in + <filename>meta/classes/externalsrc.bbclass</filename> in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + For information on how to use the <filename>externalsrc</filename> + class, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>" + section in the Yocto Project Development Manual. + </para> +</section> + +<section id='ref-classes-extrausers'> + <title><filename>extrausers.bbclass</filename></title> + + <para> + The <filename>extrausers</filename> class allows + additional user and group configuration to be applied at the image + level. + Inheriting this class either globally or from an image recipe allows + additional user and group operations to be performed using the + <link linkend='var-EXTRA_USERS_PARAMS'><filename>EXTRA_USERS_PARAMS</filename></link> + variable. + <note> + The user and group operations added using the + <filename>extrausers</filename> class are not tied to a specific + recipe outside of the recipe for the image. + Thus, the operations can be performed across the image as a whole. + Use the + <link linkend='ref-classes-useradd'><filename>useradd</filename></link> + class to add user and group configuration to a specific recipe. + </note> + Here is an example that uses this class in an image recipe: + <literallayout class='monospaced'> + inherit extrausers + EXTRA_USERS_PARAMS = "\ + useradd -p '' tester; \ + groupadd developers; \ + userdel nobody; \ + groupdel -g video; \ + groupmod -g 1020 developers; \ + usermod -s /bin/sh tester; \ + " + </literallayout> + Here is an example that adds two users named "tester-jim" and + "tester-sue" and assigns passwords: + <literallayout class='monospaced'> + inherit extrausers + EXTRA_USERS_PARAMS = "\ + useradd -P tester01 tester-jim; \ + useradd -P tester01 tester-sue; \ + " + </literallayout> + Finally, here is an example that sets the root password to + "1876*18": + <literallayout class='monospaced'> + inherit extrausers + EXTRA_USERS_PARAMS = "\ + usermod -P 1876*18 root; \ + " + </literallayout> + </para> +</section> + +<section id='ref-classes-fontcache'> + <title><filename>fontcache.bbclass</filename></title> + + <para> + The <filename>fontcache</filename> class generates the + proper post-install and post-remove (postinst and postrm) + scriptlets for font packages. + These scriptlets call <filename>fc-cache</filename> (part of + <filename>Fontconfig</filename>) to add the fonts to the font + information cache. + Since the cache files are architecture-specific, + <filename>fc-cache</filename> runs using QEMU if the postinst + scriptlets need to be run on the build host during image creation. + </para> + + <para> + If the fonts being installed are in packages other than the main + package, set + <link linkend='var-FONT_PACKAGES'><filename>FONT_PACKAGES</filename></link> + to specify the packages containing the fonts. + </para> +</section> + +<section id='ref-classes-fs-uuid'> + <title><filename>fs-uuid.bbclass</filename></title> + + <para> + The <filename>fs-uuid</filename> class extracts UUID from + <filename>${</filename><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link><filename>}</filename>, + which must have been built by the time that this function gets called. + The <filename>fs-uuid</filename> class only works on + <filename>ext</filename> file systems and depends on + <filename>tune2fs</filename>. + </para> +</section> + +<section id='ref-classes-gconf'> + <title><filename>gconf.bbclass</filename></title> + + <para> + The <filename>gconf</filename> class provides common + functionality for recipes that need to install GConf schemas. + The schemas will be put into a separate package + (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-gconf</filename>) + that is created automatically when this class is inherited. + This package uses the appropriate post-install and post-remove + (postinst/postrm) scriptlets to register and unregister the schemas + in the target image. + </para> +</section> + +<section id='ref-classes-gettext'> + <title><filename>gettext.bbclass</filename></title> + + <para> + The <filename>gettext</filename> class provides support for + building software that uses the GNU <filename>gettext</filename> + internationalization and localization system. + All recipes building software that use + <filename>gettext</filename> should inherit this class. + </para> +</section> + +<section id='ref-classes-gnome'> + <title><filename>gnome.bbclass</filename></title> + + <para> + The <filename>gnome</filename> class supports recipes that + build software from the GNOME stack. + This class inherits the + <link linkend='ref-classes-gnomebase'><filename>gnomebase</filename></link>, + <link linkend='ref-classes-gtk-icon-cache'><filename>gtk-icon-cache</filename></link>, + <link linkend='ref-classes-gconf'><filename>gconf</filename></link> and + <link linkend='ref-classes-mime'><filename>mime</filename></link> classes. + The class also disables GObject introspection where applicable. + </para> +</section> + +<section id='ref-classes-gnomebase'> + <title><filename>gnomebase.bbclass</filename></title> + + <para> + The <filename>gnomebase</filename> class is the base + class for recipes that build software from the GNOME stack. + This class sets + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> to + download the source from the GNOME mirrors as well as extending + <link linkend='var-FILES'><filename>FILES</filename></link> + with the typical GNOME installation paths. + </para> +</section> + +<section id='ref-classes-gobject-introspection'> + <title><filename>gobject-introspection.bbclass</filename></title> + + <para> + Provides support for recipes building software that + supports GObject introspection. + This functionality is only enabled if the + "gobject-introspection-data" feature is in + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> + as well as "qemu-usermode" being in + <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>. + <note> + This functionality is backfilled by default and, + if not applicable, should be disabled through + <link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename></link> + or + <link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename></link>, + respectively. + </note> + </para> +</section> + +<section id='ref-classes-grub-efi'> + <title><filename>grub-efi.bbclass</filename></title> + + <para> + The <filename>grub-efi</filename> + class provides <filename>grub-efi</filename>-specific functions for + building bootable images. + </para> + + <para> + This class supports several variables: + <itemizedlist> + <listitem><para> + <link linkend='var-INITRD'><filename>INITRD</filename></link>: + Indicates list of filesystem images to concatenate and use + as an initial RAM disk (initrd) (optional). + </para></listitem> + <listitem><para> + <link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>: + Indicates a filesystem image to include as the root filesystem + (optional).</para></listitem> + <listitem><para> + <link linkend='var-GRUB_GFXSERIAL'><filename>GRUB_GFXSERIAL</filename></link>: + Set this to "1" to have graphics and serial in the boot menu. + </para></listitem> + <listitem><para> + <link linkend='var-LABELS'><filename>LABELS</filename></link>: + A list of targets for the automatic configuration. + </para></listitem> + <listitem><para> + <link linkend='var-APPEND'><filename>APPEND</filename></link>: + An override list of append strings for each + <filename>LABEL</filename>. + </para></listitem> + <listitem><para> + <link linkend='var-GRUB_OPTS'><filename>GRUB_OPTS</filename></link>: + Additional options to add to the configuration (optional). + Options are delimited using semi-colon characters + (<filename>;</filename>).</para></listitem> + <listitem><para> + <link linkend='var-GRUB_TIMEOUT'><filename>GRUB_TIMEOUT</filename></link>: + Timeout before executing the default <filename>LABEL</filename> + (optional). + </para></listitem> + </itemizedlist> + </para> +</section> + +<section id='ref-classes-gsettings'> + <title><filename>gsettings.bbclass</filename></title> + + <para> + The <filename>gsettings</filename> class + provides common functionality for recipes that need to install + GSettings (glib) schemas. + The schemas are assumed to be part of the main package. + Appropriate post-install and post-remove (postinst/postrm) + scriptlets are added to register and unregister the schemas in the + target image. + </para> +</section> + +<section id='ref-classes-gtk-doc'> + <title><filename>gtk-doc.bbclass</filename></title> + + <para> + The <filename>gtk-doc</filename> class + is a helper class to pull in the appropriate + <filename>gtk-doc</filename> dependencies and disable + <filename>gtk-doc</filename>. + </para> +</section> + +<section id='ref-classes-gtk-icon-cache'> + <title><filename>gtk-icon-cache.bbclass</filename></title> + + <para> + The <filename>gtk-icon-cache</filename> class + generates the proper post-install and post-remove (postinst/postrm) + scriptlets for packages that use GTK+ and install icons. + These scriptlets call <filename>gtk-update-icon-cache</filename> to add + the fonts to GTK+'s icon cache. + Since the cache files are architecture-specific, + <filename>gtk-update-icon-cache</filename> is run using QEMU if the + postinst scriptlets need to be run on the build host during image + creation. + </para> +</section> + +<section id='ref-classes-gtk-immodules-cache'> + <title><filename>gtk-immodules-cache.bbclass</filename></title> + + <para> + The <filename>gtk-immodules-cache</filename> class + generates the proper post-install and post-remove (postinst/postrm) + scriptlets for packages that install GTK+ input method modules for + virtual keyboards. + These scriptlets call <filename>gtk-update-icon-cache</filename> to add + the input method modules to the cache. + Since the cache files are architecture-specific, + <filename>gtk-update-icon-cache</filename> is run using QEMU if the + postinst scriptlets need to be run on the build host during image + creation. + </para> + + <para> + If the input method modules being installed are in packages other than + the main package, set + <link linkend='var-GTKIMMODULES_PACKAGES'><filename>GTKIMMODULES_PACKAGES</filename></link> + to specify the packages containing the modules. + </para> +</section> + +<section id='ref-classes-gummiboot'> + <title><filename>gummiboot.bbclass</filename></title> + + <para> + The <filename>gummiboot</filename> class provides functions specific + to the gummiboot bootloader for building bootable images. + This is an internal class and is not intended to be + used directly. + Set the + <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> + variable to "gummiboot" to use this class. + </para> + + <para> + For information on more variables used and supported in this class, + see the + <link linkend='var-GUMMIBOOT_CFG'><filename>GUMMIBOOT_CFG</filename></link>, + <link linkend='var-GUMMIBOOT_ENTRIES'><filename>GUMMIBOOT_ENTRIES</filename></link>, + and + <link linkend='var-GUMMIBOOT_TIMEOUT'><filename>GUMMIBOOT_TIMEOUT</filename></link> + variables. + </para> + + <para> + You can also see the + <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink> + for more information. + </para> +</section> + +<section id='ref-classes-gzipnative'> + <title><filename>gzipnative.bbclass</filename></title> + + <para> + The <filename>gzipnative</filename> class enables the use of + different native versions of <filename>gzip</filename> + and <filename>pigz</filename> rather than the versions of these tools + from the build host. + </para> +</section> + +<section id='ref-classes-icecc'> + <title><filename>icecc.bbclass</filename></title> + + <para> + The <filename>icecc</filename> class supports + <ulink url='https://github.com/icecc/icecream'>Icecream</ulink>, which + facilitates taking compile jobs and distributing them among remote + machines. + </para> + + <para> + The class stages directories with symlinks from <filename>gcc</filename> + and <filename>g++</filename> to <filename>icecc</filename>, for both + native and cross compilers. + Depending on each configure or compile, the OpenEmbedded build system + adds the directories at the head of the <filename>PATH</filename> list + and then sets the <filename>ICECC_CXX</filename> and + <filename>ICEC_CC</filename> variables, which are the paths to the + <filename>g++</filename> and <filename>gcc</filename> compilers, + respectively. + </para> + + <para> + For the cross compiler, the class creates a <filename>tar.gz</filename> + file that contains the Yocto Project toolchain and sets + <filename>ICECC_VERSION</filename>, which is the version of the + cross-compiler used in the cross-development toolchain, accordingly. + </para> + + <para> + The class handles all three different compile stages + (i.e native ,cross-kernel and target) and creates the necessary + environment <filename>tar.gz</filename> file to be used by the remote + machines. + The class also supports SDK generation. + </para> + + <para> + If <link linkend='var-ICECC_PATH'><filename>ICECC_PATH</filename></link> + is not set in your <filename>local.conf</filename> file, then the + class tries to locate the <filename>icecc</filename> binary + using <filename>which</filename>. + + If + <link linkend='var-ICECC_ENV_EXEC'><filename>ICECC_ENV_EXEC</filename></link> + is set in your <filename>local.conf</filename> file, the variable should + point to the <filename>icecc-create-env</filename> script + provided by the user. + If you do not point to a user-provided script, the build system + uses the default script provided by the recipe + <filename>icecc-create-env-native.bb</filename>. + <note> + This script is a modified version and not the one that comes with + <filename>icecc</filename>. + </note> + </para> + + <para> + If you do not want the Icecream distributed compile support to apply + to specific recipes or classes, you can effectively "blacklist" them + by listing the recipes and classes using the + <link linkend='var-ICECC_USER_PACKAGE_BL'><filename>ICECC_USER_PACKAGE_BL</filename></link> + and + <link linkend='var-ICECC_USER_CLASS_BL'><filename>ICECC_USER_CLASS_BL</filename></link>, + variables, respectively, in your <filename>local.conf</filename> file. + Doing so causes the OpenEmbedded build system to handle these + compilations locally. + </para> + + <para> + Additionally, you can list recipes using the + <link linkend='var-ICECC_USER_PACKAGE_WL'><filename>ICECC_USER_PACKAGE_WL</filename></link> + variable in your <filename>local.conf</filename> file to force + <filename>icecc</filename> to be enabled for recipes using an empty + <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> + variable. + </para> + + <para> + Inheriting the <filename>icecc</filename> class changes all sstate + signatures. + Consequently, if a development team has a dedicated build system + that populates + <link linkend='var-SSTATE_MIRRORS'><filename>STATE_MIRRORS</filename></link> + and they want to reuse sstate from + <filename>STATE_MIRRORS</filename>, then all developers and the + build system need to either inherit the <filename>icecc</filename> + class or nobody should. + </para> + + <para> + At the distribution level, you can inherit the + <filename>icecc</filename> class to be sure that all builders start + with the same sstate signatures. + After inheriting the class, you can then disable the feature by setting + the + <link linkend='var-ICECC_DISABLED'><filename>ICECC_DISABLED</filename></link> + variable to "1" as follows: + <literallayout class='monospaced'> + INHERIT_DISTRO_append = " icecc" + ICECC_DISABLED ??= "1" + </literallayout> + This practice makes sure everyone is using the same signatures but also + requires individuals that do want to use Icecream to enable the feature + individually as follows in your <filename>local.conf</filename> file: + <literallayout class='monospaced'> + ICECC_DISABLED = "" + </literallayout> + </para> +</section> + +<section id='ref-classes-image'> + <title><filename>image.bbclass</filename></title> + + <para> + The <filename>image</filename> class helps support creating images + in different formats. + First, the root filesystem is created from packages using + one of the <filename>rootfs*.bbclass</filename> + files (depending on the package format used) and then one or more image + files are created. + <itemizedlist> + <listitem><para>The + <filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></filename> + variable controls the types of images to generate. + </para></listitem> + <listitem><para>The + <filename><link linkend='var-IMAGE_INSTALL'>IMAGE_INSTALL</link></filename> + variable controls the list of packages to install into the + image.</para></listitem> + </itemizedlist> + For information on customizing images, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>" + section in the Yocto Project Development Manual. + For information on how images are created, see the + "<link linkend='images-dev-environment'>Images</link>" section elsewhere + in this manual. + </para> +</section> + +<section id='ref-classes-image-buildinfo'> + <title><filename>image-buildinfo.bbclass</filename></title> + + <para> + The <filename>image-buildinfo</filename> class writes information + to the target filesystem on <filename>/etc/build</filename>. + </para> +</section> + +<section id='ref-classes-image_types'> + <title><filename>image_types.bbclass</filename></title> + + <para> + The <filename>image_types</filename> class defines all of + the standard image output types that you can enable through the + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + variable. + You can use this class as a reference on how to add support for custom + image output types. + </para> + + <para> + By default, this class is enabled through the + <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link> + variable in + <link linkend='ref-classes-image'><filename>image.bbclass</filename></link>. + If you define your own image types using a custom BitBake class and + then use <filename>IMAGE_CLASSES</filename> to enable it, the custom + class must either inherit <filename>image_types</filename> or + <filename>image_types</filename> must also appear in + <filename>IMAGE_CLASSES</filename>. + </para> +</section> + +<section id='ref-classes-image_types_uboot'> + <title><filename>image_types_uboot.bbclass</filename></title> + + <para> + The <filename>image_types_uboot</filename> class + defines additional image types specifically for the U-Boot bootloader. + </para> +</section> + +<section id='ref-classes-image-live'> + <title><filename>image-live.bbclass</filename></title> + + <para> + The <filename>image-live</filename> class supports building "live" + images. + </para> + + <para> + Normally, you do not use this class directly. + Instead, you add "live" to + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>. + For example, if you were building an ISO image, you would add "live" + to <filename>IMAGE_FSTYPES</filename>, set the + <link linkend='var-NOISO'><filename>NOISO</filename></link> variable to + "0" and the build system would use the <filename>image-live</filename> + class to build the ISO image. + </para> +</section> + +<section id='ref-classes-image-mklibs'> + <title><filename>image-mklibs.bbclass</filename></title> + + <para> + The <filename>image-mklibs</filename> class + enables the use of the <filename>mklibs</filename> utility during the + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + task, which optimizes the size of + libraries contained in the image. + </para> + + <para> + By default, the class is enabled in the + <filename>local.conf.template</filename> using the + <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> + variable as follows: + <literallayout class='monospaced'> + USER_CLASSES ?= "buildstats image-mklibs image-prelink" + </literallayout> + </para> +</section> + +<section id='ref-classes-image-prelink'> + <title><filename>image-prelink.bbclass</filename></title> + + <para> + The <filename>image-prelink</filename> class + enables the use of the <filename>prelink</filename> utility during + the + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + task, which optimizes the dynamic + linking of shared libraries to reduce executable startup time. + </para> + + <para> + By default, the class is enabled in the + <filename>local.conf.template</filename> using the + <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> + variable as follows: + <literallayout class='monospaced'> + USER_CLASSES ?= "buildstats image-mklibs image-prelink" + </literallayout> + </para> +</section> + +<section id='ref-classes-image-swab'> + <title><filename>image-swab.bbclass</filename></title> + + <para> + The <filename>image-swab</filename> class enables the + <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/swabber'>Swabber</ulink> + tool in order to detect and log accesses to the host system during + the OpenEmbedded build process. + <note> + This class is currently unmaintained. + The <filename>strace</filename> package needs to be installed + in the build host as a dependency for this tool. + </note> + </para> +</section> + +<section id='ref-classes-image-vm'> + <title><filename>image-vm.bbclass</filename></title> + + <para> + The <filename>image-vm</filename> class supports building VM + images. + </para> +</section> + +<section id='ref-classes-image-vmdk'> + <title><filename>image-vmdk.bbclass</filename></title> + + <para> + The <filename>image-vmdk</filename> class supports building VMware + VMDK images. + Normally, you do not use this class directly. + Instead, you add "vmdk" to + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>. + </para> +</section> + +<section id='ref-classes-insane'> + <title><filename>insane.bbclass</filename></title> + + <para> + The <filename>insane</filename> class adds a step to the package + generation process so that output quality assurance checks are + generated by the OpenEmbedded build system. + A range of checks are performed that check the build's output + for common problems that show up during runtime. + Distribution policy usually dictates whether to include this class. + </para> + + <para> + You can configure the sanity checks so that specific test failures + either raise a warning or an error message. + Typically, failures for new tests generate a warning. + Subsequent failures for the same test would then generate an error + message once the metadata is in a known and good condition. + See the + "<link linkend='ref-qa-checks'>QA Error and Warning Messages</link>" + Chapter for a list of all the warning and error messages + you might encounter using a default configuration. + </para> + + <para> + Use the + <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and + <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link> + variables to control the behavior of + these checks at the global level (i.e. in your custom distro + configuration). + However, to skip one or more checks in recipes, you should use + <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>. + For example, to skip the check for symbolic link + <filename>.so</filename> files in the main package of a recipe, + add the following to the recipe. + You need to realize that the package name override, in this example + <filename>${PN}</filename>, must be used: + <literallayout class='monospaced'> + INSANE_SKIP_${PN} += "dev-so" + </literallayout> + Please keep in mind that the QA checks exist in order to detect real + or potential problems in the packaged output. + So exercise caution when disabling these checks. + </para> + + <para> + The following list shows the tests you can list with the + <filename>WARN_QA</filename> and <filename>ERROR_QA</filename> + variables: + <itemizedlist> + <listitem><para><emphasis><filename>already-stripped:</filename></emphasis> + Checks that produced binaries have not already been + stripped prior to the build system extracting debug symbols. + It is common for upstream software projects to default to + stripping debug symbols for output binaries. + In order for debugging to work on the target using + <filename>-dbg</filename> packages, this stripping must be + disabled. + </para></listitem> + <listitem><para><emphasis><filename>arch:</filename></emphasis> + Checks the Executable and Linkable Format (ELF) type, bit size, + and endianness of any binaries to ensure they match the target + architecture. + This test fails if any binaries do not match the type since + there would be an incompatibility. + The test could indicate that the + wrong compiler or compiler options have been used. + Sometimes software, like bootloaders, might need to bypass + this check. + </para></listitem> + <listitem><para><emphasis><filename>buildpaths:</filename></emphasis> + Checks for paths to locations on the build host inside the + output files. + Currently, this test triggers too many false positives and + thus is not normally enabled. + </para></listitem> + <listitem><para><emphasis><filename>build-deps:</filename></emphasis> + Determines if a build-time dependency that is specified through + <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>, + explicit + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, + or task-level dependencies exists to match any runtime + dependency. + This determination is particularly useful to discover where + runtime dependencies are detected and added during packaging. + If no explicit dependency has been specified within the + metadata, at the packaging stage it is too late to ensure that + the dependency is built, and thus you can end up with an + error when the package is installed into the image during the + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + task because the auto-detected dependency was not satisfied. + An example of this would be where the + <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> + class automatically adds a dependency on the + <filename>initscripts-functions</filename> package to packages + that install an initscript that refers to + <filename>/etc/init.d/functions</filename>. + The recipe should really have an explicit + <filename>RDEPENDS</filename> for the package in question on + <filename>initscripts-functions</filename> so that the + OpenEmbedded build system is able to ensure that the + <filename>initscripts</filename> recipe is actually built and + thus the <filename>initscripts-functions</filename> package is + made available. + </para></listitem> + <listitem><para><emphasis><filename>compile-host-path:</filename></emphasis> + Checks the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + log for indications + that paths to locations on the build host were used. + Using such paths might result in host contamination of the + build output. + </para></listitem> + <listitem><para><emphasis><filename>debug-deps:</filename></emphasis> + Checks that all packages except <filename>-dbg</filename> + packages do not depend on <filename>-dbg</filename> + packages, which would cause a packaging bug. + </para></listitem> + <listitem><para><emphasis><filename>debug-files:</filename></emphasis> + Checks for <filename>.debug</filename> directories in anything but the + <filename>-dbg</filename> package. + The debug files should all be in the <filename>-dbg</filename> package. + Thus, anything packaged elsewhere is incorrect packaging.</para></listitem> + <listitem><para><emphasis><filename>dep-cmp:</filename></emphasis> + Checks for invalid version comparison statements in runtime + dependency relationships between packages (i.e. in + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, + <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, + <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, + <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, + and + <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link> + variable values). + Any invalid comparisons might trigger failures or undesirable + behavior when passed to the package manager. + </para></listitem> + <listitem><para><emphasis><filename>desktop:</filename></emphasis> + Runs the <filename>desktop-file-validate</filename> program + against any <filename>.desktop</filename> files to validate + their contents against the specification for + <filename>.desktop</filename> files.</para></listitem> + <listitem><para><emphasis><filename>dev-deps:</filename></emphasis> + Checks that all packages except <filename>-dev</filename> + or <filename>-staticdev</filename> packages do not depend on + <filename>-dev</filename> packages, which would be a + packaging bug.</para></listitem> + <listitem><para><emphasis><filename>dev-so:</filename></emphasis> + Checks that the <filename>.so</filename> symbolic links are in the + <filename>-dev</filename> package and not in any of the other packages. + In general, these symlinks are only useful for development purposes. + Thus, the <filename>-dev</filename> package is the correct location for + them. + Some very rare cases do exist for dynamically loaded modules where + these symlinks are needed instead in the main package. + </para></listitem> + <listitem><para><emphasis><filename>file-rdeps:</filename></emphasis> + Checks that file-level dependencies identified by the + OpenEmbedded build system at packaging time are satisfied. + For example, a shell script might start with the line + <filename>#!/bin/bash</filename>. + This line would translate to a file dependency on + <filename>/bin/bash</filename>. + Of the three package managers that the OpenEmbedded build + system supports, only RPM directly handles file-level + dependencies, resolving them automatically to packages + providing the files. + However, the lack of that functionality in the other two + package managers does not mean the dependencies do not still + need resolving. + This QA check attempts to ensure that explicitly declared + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + exist to handle any file-level dependency detected in + packaged files. + </para></listitem> + <listitem><para><emphasis><filename>files-invalid:</filename></emphasis> + Checks for + <link linkend='var-FILES'><filename>FILES</filename></link> + variable values that contain "//", which is invalid. + </para></listitem> + <listitem><para><emphasis><filename>incompatible-license:</filename></emphasis> + Report when packages are excluded from being created due to + being marked with a license that is in + <link linkend='var-INCOMPATIBLE_LICENSE'><filename>INCOMPATIBLE_LICENSE</filename></link>. + </para></listitem> + <listitem><para><emphasis><filename>install-host-path:</filename></emphasis> + Checks the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + log for indications + that paths to locations on the build host were used. + Using such paths might result in host contamination of the + build output. + </para></listitem> + <listitem><para><emphasis><filename>installed-vs-shipped:</filename></emphasis> + Reports when files have been installed within + <filename>do_install</filename> but have not been included in + any package by way of the + <link linkend='var-FILES'><filename>FILES</filename></link> + variable. + Files that do not appear in any package cannot be present in + an image later on in the build process. + Ideally, all installed files should be packaged or not + installed at all. + These files can be deleted at the end of + <filename>do_install</filename> if the files are not + needed in any package. + </para></listitem> + <listitem><para><emphasis><filename>la:</filename></emphasis> + Checks <filename>.la</filename> files for any <filename>TMPDIR</filename> + paths. + Any <filename>.la</filename> file containing these paths is incorrect since + <filename>libtool</filename> adds the correct sysroot prefix when using the + files automatically itself.</para></listitem> + <listitem><para><emphasis><filename>ldflags:</filename></emphasis> + Ensures that the binaries were linked with the + <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> + options provided by the build system. + If this test fails, check that the <filename>LDFLAGS</filename> variable + is being passed to the linker command.</para></listitem> + <listitem><para><emphasis><filename>libdir:</filename></emphasis> + Checks for libraries being installed into incorrect + (possibly hardcoded) installation paths. + For example, this test will catch recipes that install + <filename>/lib/bar.so</filename> when + <filename>${base_libdir}</filename> is "lib32". + Another example is when recipes install + <filename>/usr/lib64/foo.so</filename> when + <filename>${libdir}</filename> is "/usr/lib". + </para></listitem> + <listitem><para><emphasis><filename>libexec:</filename></emphasis> + Checks if a package contains files in + <filename>/usr/libexec</filename>. + This check is not performed if the + <filename>libexecdir</filename> variable has been set + explicitly to <filename>/usr/libexec</filename>. + </para></listitem> + <listitem><para><emphasis><filename>packages-list:</filename></emphasis> + Checks for the same package being listed multiple times through + the <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> + variable value. + Installing the package in this manner can cause errors during + packaging. + </para></listitem> + <listitem><para><emphasis><filename>perm-config:</filename></emphasis> + Reports lines in <filename>fs-perms.txt</filename> that have + an invalid format. + </para></listitem> + <listitem><para><emphasis><filename>perm-line:</filename></emphasis> + Reports lines in <filename>fs-perms.txt</filename> that have + an invalid format. + </para></listitem> + <listitem><para><emphasis><filename>perm-link:</filename></emphasis> + Reports lines in <filename>fs-perms.txt</filename> that + specify 'link' where the specified target already exists. + </para></listitem> + <listitem><para><emphasis><filename>perms:</filename></emphasis> + Currently, this check is unused but reserved. + </para></listitem> + <listitem><para><emphasis><filename>pkgconfig:</filename></emphasis> + Checks <filename>.pc</filename> files for any + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>/<link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> + paths. + Any <filename>.pc</filename> file containing these paths is incorrect + since <filename>pkg-config</filename> itself adds the correct sysroot prefix + when the files are accessed.</para></listitem> + <listitem><para><emphasis><filename>pkgname:</filename></emphasis> + Checks that all packages in + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> + have names that do not contain invalid characters (i.e. + characters other than 0-9, a-z, ., +, and -). + </para></listitem> + <listitem><para><emphasis><filename>pkgv-undefined:</filename></emphasis> + Checks to see if the <filename>PKGV</filename> variable + is undefined during + <link linkend='ref-tasks-package'><filename>do_package</filename></link>. + </para></listitem> + <listitem><para><emphasis><filename>pkgvarcheck:</filename></emphasis> + Checks through the variables + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, + <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, + <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>, + <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, + <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, + <link linkend='var-FILES'><filename>FILES</filename></link>, + <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>, + <filename>pkg_preinst</filename>, + <filename>pkg_postinst</filename>, + <filename>pkg_prerm</filename> + and <filename>pkg_postrm</filename>, and reports if there are + variable sets that are not package-specific. + Using these variables without a package suffix is bad practice, + and might unnecessarily complicate dependencies of other packages + within the same recipe or have other unintended consequences. + </para></listitem> + <listitem><para><emphasis><filename>pn-overrides:</filename></emphasis> + Checks that a recipe does not have a name + (<link linkend='var-PN'><filename>PN</filename></link>) value + that appears in + <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>. + If a recipe is named such that its <filename>PN</filename> + value matches something already in + <filename>OVERRIDES</filename> (e.g. <filename>PN</filename> + happens to be the same as + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + or + <link linkend='var-DISTRO'><filename>DISTRO</filename></link>), + it can have unexpected consequences. + For example, assignments such as + <filename>FILES_${PN} = "xyz"</filename> effectively turn into + <filename>FILES = "xyz"</filename>. + </para></listitem> + <listitem><para><emphasis><filename>rpaths:</filename></emphasis> + Checks for rpaths in the binaries that contain build system paths such + as <filename>TMPDIR</filename>. + If this test fails, bad <filename>-rpath</filename> options are being + passed to the linker commands and your binaries have potential security + issues.</para></listitem> + <listitem><para><emphasis><filename>split-strip:</filename></emphasis> + Reports that splitting or stripping debug symbols from binaries + has failed. + </para></listitem> + <listitem><para><emphasis><filename>staticdev:</filename></emphasis> + Checks for static library files (<filename>*.a</filename>) in + non-<filename>staticdev</filename> packages. + </para></listitem> + <listitem><para><emphasis><filename>symlink-to-sysroot:</filename></emphasis> + Checks for symlinks in packages that point into + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + on the host. + Such symlinks will work on the host, but are clearly invalid + when running on the target. + </para></listitem> + <listitem><para><emphasis><filename>textrel:</filename></emphasis> + Checks for ELF binaries that contain relocations in their + <filename>.text</filename> sections, which can result in a + performance impact at runtime. + See the explanation for the + <link linkend='qa-issue-textrel'><filename>ELF binary</filename></link> + message for more information regarding runtime performance issues. + </para></listitem> + <listitem><para><emphasis><filename>unsafe-references-in-binaries:</filename></emphasis> + Reports when a binary installed in + <filename>${base_libdir}</filename>, + <filename>${base_bindir}</filename>, or + <filename>${base_sbindir}</filename>, depends on another + binary installed under <filename>${exec_prefix}</filename>. + This dependency is a concern if you want the system to remain + basically operable if <filename>/usr</filename> is mounted + separately and is not mounted. + <note> + Defaults for binaries installed in + <filename>${base_libdir}</filename>, + <filename>${base_bindir}</filename>, and + <filename>${base_sbindir}</filename> are + <filename>/lib</filename>, <filename>/bin</filename>, and + <filename>/sbin</filename>, respectively. + The default for a binary installed + under <filename>${exec_prefix}</filename> is + <filename>/usr</filename>. + </note> + </para></listitem> + <listitem><para><emphasis><filename>unsafe-references-in-scripts:</filename></emphasis> + Reports when a script file installed in + <filename>${base_libdir}</filename>, + <filename>${base_bindir}</filename>, or + <filename>${base_sbindir}</filename>, depends on files + installed under <filename>${exec_prefix}</filename>. + This dependency is a concern if you want the system to remain + basically operable if <filename>/usr</filename> is mounted + separately and is not mounted. + <note> + Defaults for binaries installed in + <filename>${base_libdir}</filename>, + <filename>${base_bindir}</filename>, and + <filename>${base_sbindir}</filename> are + <filename>/lib</filename>, <filename>/bin</filename>, and + <filename>/sbin</filename>, respectively. + The default for a binary installed + under <filename>${exec_prefix}</filename> is + <filename>/usr</filename>. + </note> + </para></listitem> + <listitem><para><emphasis><filename>useless-rpaths:</filename></emphasis> + Checks for dynamic library load paths (rpaths) in the binaries that + by default on a standard system are searched by the linker (e.g. + <filename>/lib</filename> and <filename>/usr/lib</filename>). + While these paths will not cause any breakage, they do waste space and + are unnecessary.</para></listitem> + <listitem><para><emphasis><filename>var-undefined:</filename></emphasis> + Reports when variables fundamental to packaging (i.e. + <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>, + <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>, + <link linkend='var-D'><filename>D</filename></link>, + <link linkend='var-PN'><filename>PN</filename></link>, and + <link linkend='var-PKGD'><filename>PKGD</filename></link>) are + undefined during + <link linkend='ref-tasks-package'><filename>do_package</filename></link>. + </para></listitem> + <listitem><para><emphasis><filename>version-going-backwards:</filename></emphasis> + If Build History is enabled, reports when a package + being written out has a lower version than the previously + written package under the same name. + If you are placing output packages into a feed and + upgrading packages on a target system using that feed, the + version of a package going backwards can result in the target + system not correctly upgrading to the "new" version of the + package. + <note> + If you are not using runtime package management on your + target system, then you do not need to worry about + this situation. + </note> + </para></listitem> + <listitem><para><emphasis><filename>xorg-driver-abi:</filename></emphasis> + Checks that all packages containing Xorg drivers have ABI + dependencies. + The <filename>xserver-xorg</filename> recipe provides driver + ABI names. + All drivers should depend on the ABI versions that they have + been built against. + Driver recipes that include + <filename>xorg-driver-input.inc</filename> + or <filename>xorg-driver-video.inc</filename> will + automatically get these versions. + Consequently, you should only need to explicitly add + dependencies to binary driver recipes. + </para></listitem> + </itemizedlist> + </para> +</section> + +<section id='ref-classes-insserv'> + <title><filename>insserv.bbclass</filename></title> + + <para> + The <filename>insserv</filename> class + uses the <filename>insserv</filename> utility to update the order of + symbolic links in <filename>/etc/rc?.d/</filename> within an image + based on dependencies specified by LSB headers in the + <filename>init.d</filename> scripts themselves. + </para> +</section> + +<section id='ref-classes-kernel'> + <title><filename>kernel.bbclass</filename></title> + + <para> + The <filename>kernel</filename> class handles building Linux kernels. + The class contains code to build all kernel trees. + All needed headers are staged into the + <filename><link linkend='var-STAGING_KERNEL_DIR'>STAGING_KERNEL_DIR</link></filename> + directory to allow out-of-tree module builds using + the + <link linkend='ref-classes-module'><filename>module</filename></link> + class. + </para> + + <para> + This means that each built kernel module is packaged separately and inter-module + dependencies are created by parsing the <filename>modinfo</filename> output. + If all modules are required, then installing the <filename>kernel-modules</filename> + package installs all packages with modules and various other kernel packages + such as <filename>kernel-vmlinux</filename>. + </para> + + <para> + Various other classes are used by the <filename>kernel</filename> + and <filename>module</filename> classes internally including the + <link linkend='ref-classes-kernel-arch'><filename>kernel-arch</filename></link>, + <link linkend='ref-classes-module-base'><filename>module-base</filename></link>, + and + <link linkend='ref-classes-linux-kernel-base'><filename>linux-kernel-base</filename></link> + classes. + </para> +</section> + +<section id='ref-classes-kernel-arch'> + <title><filename>kernel-arch.bbclass</filename></title> + + <para> + The <filename>kernel-arch</filename> class + sets the <filename>ARCH</filename> environment variable for Linux + kernel compilation (including modules). + </para> +</section> + +<section id='ref-classes-kernel-fitimage'> + <title><filename>kernel-fitimage.bbclass</filename></title> + + <para> + The <filename>kernel-fitimage</filename> class provides support to + pack zImages. + </para> +</section> + +<section id='ref-classes-kernel-grub'> + <title><filename>kernel-grub.bbclass</filename></title> + + <para> + The <filename>kernel-grub</filename> class updates the boot area and + the boot menu with the kernel as the priority boot mechanism while + installing a RPM to update the kernel on a deployed target. + </para> +</section> + +<section id='ref-classes-kernel-module-split'> + <title><filename>kernel-module-split.bbclass</filename></title> + + <para> + The <filename>kernel-module-split</filename> class + provides common functionality for splitting Linux kernel modules into + separate packages. + </para> +</section> + +<section id='ref-classes-kernel-uboot'> + <title><filename>kernel-uboot.bbclass</filename></title> + + <para> + The <filename>kernel-uboot</filename> class provides support for + building from vmlinux-style kernel sources. + </para> +</section> + +<section id='ref-classes-kernel-uimage'> + <title><filename>kernel-uimage.bbclass</filename></title> + + <para> + The <filename>kernel-uimage</filename> class provides support to + pack uImage. + </para> +</section> + +<section id='ref-classes-kernel-yocto'> + <title><filename>kernel-yocto.bbclass</filename></title> + + <para> + The <filename>kernel-yocto</filename> class + provides common functionality for building from linux-yocto style + kernel source repositories. + </para> +</section> + +<section id='ref-classes-kernelsrc'> + <title><filename>kernelsrc.bbclass</filename></title> + + <para> + The <filename>kernelsrc</filename> class sets the Linux kernel + source and version. + </para> +</section> + +<section id='ref-classes-lib_package'> + <title><filename>lib_package.bbclass</filename></title> + + <para> + The <filename>lib_package</filename> class + supports recipes that build libraries and produce executable + binaries, where those binaries should not be installed by default + along with the library. + Instead, the binaries are added to a separate + <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-bin</filename> + package to make their installation optional. + </para> +</section> + +<section id='ref-classes-libc*'> + <title><filename>libc*.bbclass</filename></title> + + <para> + The <filename>libc*</filename> classes support recipes that build + packages with <filename>libc</filename>: + <itemizedlist> + <listitem><para>The <filename>libc-common</filename> class + provides common support for building with + <filename>libc</filename>. + </para></listitem> + <listitem><para>The <filename>libc-package</filename> class + supports packaging up <filename>glibc</filename> and + <filename>eglibc</filename>. + </para></listitem> + </itemizedlist> + </para> +</section> + +<section id='ref-classes-license'> + <title><filename>license.bbclass</filename></title> + + <para> + The <filename>license</filename> class provides license + manifest creation and license exclusion. + This class is enabled by default using the default value for the + <link linkend='var-INHERIT_DISTRO'><filename>INHERIT_DISTRO</filename></link> + variable. + </para> +</section> + +<section id='ref-classes-linux-kernel-base'> + <title><filename>linux-kernel-base.bbclass</filename></title> + + <para> + The <filename>linux-kernel-base</filename> class + provides common functionality for recipes that build out of the Linux + kernel source tree. + These builds goes beyond the kernel itself. + For example, the Perf recipe also inherits this class. + </para> +</section> + +<section id='ref-classes-linuxloader'> + <title><filename>linuxloader.bbclass</filename></title> + + <para> + Provides the function <filename>linuxloader()</filename>, which gives + the value of the dynamic loader/linker provided on the platform. + This value is used by a number of other classes. + </para> +</section> + +<section id='ref-classes-logging'> + <title><filename>logging.bbclass</filename></title> + + <para> + The <filename>logging</filename> class provides the standard + shell functions used to log messages for various BitBake severity levels + (i.e. <filename>bbplain</filename>, <filename>bbnote</filename>, + <filename>bbwarn</filename>, <filename>bberror</filename>, + <filename>bbfatal</filename>, and <filename>bbdebug</filename>). + </para> + + <para> + This class is enabled by default since it is inherited by + the <filename>base</filename> class. + </para> +</section> + +<section id='ref-classes-meta'> + <title><filename>meta.bbclass</filename></title> + + <para> + The <filename>meta</filename> class is inherited by recipes + that do not build any output packages themselves, but act as a "meta" + target for building other recipes. + </para> +</section> + +<section id='ref-classes-metadata_scm'> + <title><filename>metadata_scm.bbclass</filename></title> + + <para> + The <filename>metadata_scm</filename> class provides functionality for + querying the branch and revision of a Source Code Manager (SCM) + repository. + </para> + + <para> + The <link linkend='ref-classes-base'><filename>base</filename></link> + class uses this class to print the revisions of each layer before + starting every build. + The <filename>metadata_scm</filename> class is enabled by default + because it is inherited by the <filename>base</filename> class. + </para> +</section> + +<section id='ref-classes-migrate_localcount'> + <title><filename>migrate_localcount.bbclass</filename></title> + + <para> + The <filename>migrate_localcount</filename> class verifies a recipe's + localcount data and increments it appropriately. + </para> +</section> + +<section id='ref-classes-mime'> + <title><filename>mime.bbclass</filename></title> + + <para> + The <filename>mime</filename> class generates the proper + post-install and post-remove (postinst/postrm) scriptlets for packages + that install MIME type files. + These scriptlets call <filename>update-mime-database</filename> to add + the MIME types to the shared database. + </para> +</section> + +<section id='ref-classes-mirrors'> + <title><filename>mirrors.bbclass</filename></title> + + <para> + The <filename>mirrors</filename> class sets up some standard + <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> entries + for source code mirrors. + These mirrors provide a fall-back path in case the upstream source + specified in + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + within recipes is unavailable. + </para> + + <para> + This class is enabled by default since it is inherited by the + <link linkend='ref-classes-base'><filename>base</filename></link> class. + </para> +</section> + +<section id='ref-classes-module'> + <title><filename>module.bbclass</filename></title> + + <para> + The <filename>module</filename> class provides support for building + out-of-tree Linux kernel modules. + The class inherits the + <link linkend='ref-classes-module-base'><filename>module-base</filename></link> + and + <link linkend='ref-classes-kernel-module-split'><filename>kernel-module-split</filename></link> + classes, and implements the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + and + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + tasks. + The class provides everything needed to build and package a kernel + module. + </para> + + <para> + For general information on out-of-tree Linux kernel modules, see the + "<ulink url='&YOCTO_DOCS_KERNEL_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>" + section in the Yocto Project Linux Kernel Development Manual. + </para> +</section> + +<section id='ref-classes-module-base'> + <title><filename>module-base.bbclass</filename></title> + + <para> + The <filename>module-base</filename> class provides the base + functionality for building Linux kernel modules. + Typically, a recipe that builds software that includes one or + more kernel modules and has its own means of building + the module inherits this class as opposed to inheriting the + <link linkend='ref-classes-module'><filename>module</filename></link> + class. + </para> +</section> + +<section id='ref-classes-multilib*'> + <title><filename>multilib*.bbclass</filename></title> + + <para> + The <filename>multilib*</filename> classes provide support + for building libraries with different target optimizations or target + architectures and installing them side-by-side in the same image. + </para> + + <para> + For more information on using the Multilib feature, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Combining Multiple Versions of Library Files into One Image</ulink>" + section in the Yocto Project Development Manual. + </para> +</section> + +<section id='ref-classes-native'> + <title><filename>native.bbclass</filename></title> + + <para> + The <filename>native</filename> class provides common + functionality for recipes that wish to build tools to run on the build + host (i.e. tools that use the compiler or other tools from the + build host). + </para> + + <para> + You can create a recipe that builds tools that run natively on the + host a couple different ways: + <itemizedlist> + <listitem><para>Create a <replaceable>myrecipe</replaceable><filename>-native.bb</filename> + that inherits the <filename>native</filename> class. + If you use this method, you must order the inherit statement + in the recipe after all other inherit statements so that the + <filename>native</filename> class is inherited last. + </para></listitem> + <listitem><para>Create or modify a target recipe that contains + the following: + <literallayout class='monospaced'> + <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> = "native" + </literallayout> + Inside the recipe, use <filename>_class-native</filename> and + <filename>_class-target</filename> overrides to specify any + functionality specific to the respective native or target + case.</para></listitem> + </itemizedlist> + </para> + + <para> + Although applied differently, the <filename>native</filename> class is + used with both methods. + The advantage of the second method is that you do not need to have two + separate recipes (assuming you need both) for native and target. + All common parts of the recipe are automatically shared. + </para> +</section> + +<section id='ref-classes-nativesdk'> + <title><filename>nativesdk.bbclass</filename></title> + + <para> + The <filename>nativesdk</filename> class provides common + functionality for recipes that wish to build tools to run as part of + an SDK (i.e. tools that run on + <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>). + </para> + + <para> + You can create a recipe that builds tools that run on the SDK machine + a couple different ways: + <itemizedlist> + <listitem><para>Create a + <filename>nativesdk-</filename><replaceable>myrecipe</replaceable><filename>.bb</filename> + recipe that inherits the <filename>nativesdk</filename> class. + If you use this method, you must order the inherit statement + in the recipe after all other inherit statements so that the + <filename>nativesdk</filename> class is inherited last. + </para></listitem> + <listitem><para>Create a <filename>nativesdk</filename> variant + of any recipe by adding the following: + <literallayout class='monospaced'> + <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> = "nativesdk" + </literallayout> + Inside the recipe, use <filename>_class-nativesdk</filename> and + <filename>_class-target</filename> overrides to specify any + functionality specific to the respective SDK machine or target + case.</para></listitem> + </itemizedlist> + </para> + + <para> + Although applied differently, the <filename>nativesdk</filename> class + is used with both methods. + The advantage of the second method is that you do not need to have two + separate recipes (assuming you need both) for the SDK machine and the + target. + All common parts of the recipe are automatically shared. + </para> +</section> + +<section id='ref-classes-nopackages'> + <title><filename>nopackages.bbclass</filename></title> + + <para> + Disables packaging tasks for those recipes and classes where + packaging is not needed. + </para> +</section> + +<section id='ref-classes-npm'> + <title><filename>npm.bbclass</filename></title> + + <para> + Provides support for building Node.js software fetched using the npm + package manager. + <note> + Currently, recipes inheriting this class must use the + <filename>npm://</filename> fetcher to have dependencies fetched + and packaged automatically. + </note> + </para> +</section> + +<section id='ref-classes-oelint'> + <title><filename>oelint.bbclass</filename></title> + + <para> + The <filename>oelint</filename> class is an + obsolete lint checking tool that exists in + <filename>meta/classes</filename> in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + + <para> + A number of classes exist that could be generally useful in + OE-Core but are never actually used within OE-Core itself. + The <filename>oelint</filename> class is one such example. + However, being aware of this class can reduce the proliferation of + different versions of similar classes across multiple layers. + </para> +</section> + +<section id='ref-classes-own-mirrors'> + <title><filename>own-mirrors.bbclass</filename></title> + + <para> + The <filename>own-mirrors</filename> class makes it + easier to set up your own + <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> + from which to first fetch source before attempting to fetch it from the + upstream specified in + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + within each recipe. + </para> + + <para> + To use this class, inherit it globally and specify + <link linkend='var-SOURCE_MIRROR_URL'><filename>SOURCE_MIRROR_URL</filename></link>. + Here is an example: + <literallayout class='monospaced'> + INHERIT += "own-mirrors" + SOURCE_MIRROR_URL = "http://example.com/my-source-mirror" + </literallayout> + You can specify only a single URL in + <filename>SOURCE_MIRROR_URL</filename>. + </para> +</section> + +<section id='ref-classes-package'> + <title><filename>package.bbclass</filename></title> + + <para> + The <filename>package</filename> class supports generating + packages from a build's output. + The core generic functionality is in + <filename>package.bbclass</filename>. + The code specific to particular package types resides in these + package-specific classes: + <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>, + <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>, + <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>, + and + <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>. + <note><title>Warning</title> + The <filename>package_tar</filename> class is broken and not + supported. + It is recommended that you do not use this class. + </note> + </para> + + <para> + You can control the list of resulting package formats by using the + <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> + variable defined in your <filename>conf/local.conf</filename> + configuration file, which is located in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + When defining the variable, you can specify one or more package types. + Since images are generated from packages, a packaging class is + needed to enable image generation. + The first class listed in this variable is used for image generation. + </para> + + <para> + If you take the optional step to set up a repository (package feed) + on the development host that can be used by Smart, you can + install packages from the feed while you are running the image + on the target (i.e. runtime installation of packages). + For more information, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#using-runtime-package-management'>Using Runtime Package Management</ulink>" + section in the Yocto Project Development Manual. + </para> + + <para> + The package-specific class you choose can affect build-time performance + and has space ramifications. + In general, building a package with IPK takes about thirty percent less + time as compared to using RPM to build the same or similar package. + This comparison takes into account a complete build of the package with + all dependencies previously built. + The reason for this discrepancy is because the RPM package manager + creates and processes more + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> than the + IPK package manager. + Consequently, you might consider setting + <filename>PACKAGE_CLASSES</filename> to "package_ipk" if you are + building smaller systems. + </para> + + <para> + Before making your package manager decision, however, you should + consider some further things about using RPM: + <itemizedlist> + <listitem><para> + RPM starts to provide more abilities than IPK due to + the fact that it processes more Metadata. + For example, this information includes individual file types, + file checksum generation and evaluation on install, sparse file + support, conflict detection and resolution for Multilib systems, + ACID style upgrade, and repackaging abilities for rollbacks. + </para></listitem> + <listitem><para> + For smaller systems, the extra space used for the Berkeley + Database and the amount of metadata when using RPM can affect + your ability to perform on-device upgrades. + </para></listitem> + </itemizedlist> + </para> + + <para> + You can find additional information on the effects of the package + class at these two Yocto Project mailing list links: + <itemizedlist> + <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006362.html'> + https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html</ulink></para></listitem> + <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006363.html'> + https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html</ulink></para></listitem> + </itemizedlist> + </para> +</section> + +<section id='ref-classes-package_deb'> + <title><filename>package_deb.bbclass</filename></title> + + <para> + The <filename>package_deb</filename> class + provides support for creating packages that use the Debian + (i.e. <filename>.deb</filename>) file format. + The class ensures the packages are written out in a + <filename>.deb</filename> file format to the + <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename> + directory. + </para> + + <para> + This class inherits the + <link linkend='ref-classes-package'><filename>package</filename></link> + class and is enabled through the + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + variable in the <filename>local.conf</filename> file. + </para> +</section> + +<section id='ref-classes-package_ipk'> + <title><filename>package_ipk.bbclass</filename></title> + + <para> + The <filename>package_ipk</filename> class + provides support for creating packages that use the IPK + (i.e. <filename>.ipk</filename>) file format. + The class ensures the packages are written out in a + <filename>.ipk</filename> file format to the + <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename> + directory. + </para> + + <para> + This class inherits the + <link linkend='ref-classes-package'><filename>package</filename></link> + class and is enabled through the + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + variable in the <filename>local.conf</filename> file. + </para> +</section> + +<section id='ref-classes-package_rpm'> + <title><filename>package_rpm.bbclass</filename></title> + + <para> + The <filename>package_rpm</filename> class + provides support for creating packages that use the RPM + (i.e. <filename>.rpm</filename>) file format. + The class ensures the packages are written out in a + <filename>.rpm</filename> file format to the + <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename> + directory. + </para> + + <para> + This class inherits the + <link linkend='ref-classes-package'><filename>package</filename></link> + class and is enabled through the + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + variable in the <filename>local.conf</filename> file. + </para> +</section> + +<section id='ref-classes-package_tar'> + <title><filename>package_tar.bbclass</filename></title> + + <para> + The <filename>package_tar</filename> class + provides support for creating tarballs. + The class ensures the packages are written out in a + tarball format to the + <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename> + directory. + </para> + + <para> + This class inherits the + <link linkend='ref-classes-package'><filename>package</filename></link> + class and is enabled through the + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + variable in the <filename>local.conf</filename> file. + <note> + You cannot specify the <filename>package_tar</filename> class + first using the <filename>PACKAGE_CLASSES</filename> variable. + You must use <filename>.deb</filename>, + <filename>.ipk</filename>, or <filename>.rpm</filename> file + formats for your image or SDK. + </note> + </para> +</section> + +<section id='ref-classes-packagedata'> + <title><filename>packagedata.bbclass</filename></title> + + <para> + The <filename>packagedata</filename> class provides + common functionality for reading <filename>pkgdata</filename> files + found in + <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>. + These files contain information about each output package produced by + the OpenEmbedded build system. + </para> + + <para> + This class is enabled by default because it is inherited by the + <link linkend='ref-classes-package'><filename>package</filename></link> + class. + </para> +</section> + +<section id='ref-classes-packagegroup'> + <title><filename>packagegroup.bbclass</filename></title> + + <para> + The <filename>packagegroup</filename> class sets default values + appropriate for package group recipes (e.g. + <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>, + <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>, + <filename><link linkend='var-ALLOW_EMPTY'>ALLOW_EMPTY</link></filename>, + and so forth). + It is highly recommended that all package group recipes inherit this class. + </para> + + <para> + For information on how to use this class, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-customtasks'>Customizing Images Using Custom Package Groups</ulink>" + section in the Yocto Project Development Manual. + </para> + + <para> + Previously, this class was called the <filename>task</filename> class. + </para> +</section> + +<section id='ref-classes-patch'> + <title><filename>patch.bbclass</filename></title> + + <para> + The <filename>patch</filename> class provides all functionality for + applying patches during the + <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> + task. + </para> + + <para> + This class is enabled by default because it is inherited by the + <link linkend='ref-classes-base'><filename>base</filename></link> + class. + </para> +</section> + +<section id='ref-classes-perlnative'> + <title><filename>perlnative.bbclass</filename></title> + + <para> + When inherited by a recipe, the <filename>perlnative</filename> class + supports using the native version of Perl built by the build system + rather than using the version provided by the build host. + </para> +</section> + +<section id='ref-classes-pixbufcache'> + <title><filename>pixbufcache.bbclass</filename></title> + + <para> + The <filename>pixbufcache</filename> class generates the proper + post-install and post-remove (postinst/postrm) scriptlets for packages + that install pixbuf loaders, which are used with + <filename>gdk-pixbuf</filename>. + These scriptlets call <filename>update_pixbuf_cache</filename> + to add the pixbuf loaders to the cache. + Since the cache files are architecture-specific, + <filename>update_pixbuf_cache</filename> is run using QEMU if the + postinst scriptlets need to be run on the build host during image + creation. + </para> + + <para> + If the pixbuf loaders being installed are in packages other + than the recipe's main package, set + <link linkend='var-PIXBUF_PACKAGES'><filename>PIXBUF_PACKAGES</filename></link> + to specify the packages containing the loaders. + </para> +</section> + +<section id='ref-classes-pkgconfig'> + <title><filename>pkgconfig.bbclass</filename></title> + + <para> + The <filename>pkgconfig</filename> class provides a standard way to get + header and library information by using <filename>pkg-config</filename>. + This class aims to smooth integration of + <filename>pkg-config</filename> into libraries that use it. + </para> + + <para> + During staging, BitBake installs <filename>pkg-config</filename> + data into the <filename>sysroots/</filename> directory. + By making use of sysroot functionality within + <filename>pkg-config</filename>, the <filename>pkgconfig</filename> + class no longer has to manipulate the files. + </para> +</section> + +<section id='ref-classes-populate-sdk'> + <title><filename>populate_sdk.bbclass</filename></title> + + <para> + The <filename>populate_sdk</filename> class provides support for + SDK-only recipes. + For information on advantages gained when building a cross-development + toolchain using the + <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> + task, see the + "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" + section in the Yocto Project Software Development Kit (SDK) Developer's Guide. + </para> +</section> + +<section id='ref-classes-populate-sdk-*'> + <title><filename>populate_sdk_*.bbclass</filename></title> + + <para> + The <filename>populate_sdk_*</filename> classes support SDK creation + and consist of the following classes: + <itemizedlist> + <listitem><para><emphasis><filename>populate_sdk_base</filename>:</emphasis> + The base class supporting SDK creation under all package + managers (i.e. DEB, RPM, and opkg).</para></listitem> + <listitem><para><emphasis><filename>populate_sdk_deb</filename>:</emphasis> + Supports creation of the SDK given the Debian package manager. + </para></listitem> + <listitem><para><emphasis><filename>populate_sdk_rpm</filename>:</emphasis> + Supports creation of the SDK given the RPM package manager. + </para></listitem> + <listitem><para><emphasis><filename>populate_sdk_ipk</filename>:</emphasis> + Supports creation of the SDK given the opkg (IPK format) + package manager. + </para></listitem> + <listitem><para><emphasis><filename>populate_sdk_ext</filename>:</emphasis> + Supports extensible SDK creation under all package managers. + </para></listitem> + </itemizedlist> + </para> + + <para> + The <filename>populate_sdk_base</filename> class inherits the + appropriate <filename>populate_sdk_*</filename> (i.e. + <filename>deb</filename>, <filename>rpm</filename>, and + <filename>ipk</filename>) based on + <link linkend='var-IMAGE_PKGTYPE'><filename>IMAGE_PKGTYPE</filename></link>. + </para> + + <para> + The base class ensures all source and destination directories are + established and then populates the SDK. + After populating the SDK, the <filename>populate_sdk_base</filename> + class constructs two sysroots: + <filename>${</filename><link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link><filename>}-nativesdk</filename>, + which contains the cross-compiler and associated tooling, and the + target, which contains a target root filesystem that is configured for + the SDK usage. + These two images reside in + <link linkend='var-SDK_OUTPUT'><filename>SDK_OUTPUT</filename></link>, + which consists of the following: + <literallayout class='monospaced'> + ${SDK_OUTPUT}/${SDK_ARCH}<replaceable>-nativesdk-pkgs</replaceable> + ${SDK_OUTPUT}/${SDKTARGETSYSROOT}/<replaceable>target-pkgs</replaceable> + </literallayout> + </para> + + <para> + Finally, the base populate SDK class creates the toolchain + environment setup script, the tarball of the SDK, and the installer. + </para> + + <para> + The respective <filename>populate_sdk_deb</filename>, + <filename>populate_sdk_rpm</filename>, and + <filename>populate_sdk_ipk</filename> classes each support the + specific type of SDK. + These classes are inherited by and used with the + <filename>populate_sdk_base</filename> class. + </para> + + <para> + For more information on the cross-development toolchain + generation, see the + "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" + section. + For information on advantages gained when building a + cross-development toolchain using the + <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> + task, see the + "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" + section in the Yocto Project Software Development Kit (SDK) Developer's + Guide. + </para> +</section> + +<section id='ref-classes-prexport'> + <title><filename>prexport.bbclass</filename></title> + + <para> + The <filename>prexport</filename> class provides functionality for + exporting + <link linkend='var-PR'><filename>PR</filename></link> values. + <note> + This class is not intended to be used directly. + Rather, it is enabled when using + "<filename>bitbake-prserv-tool export</filename>". + </note> + </para> +</section> + +<section id='ref-classes-primport'> + <title><filename>primport.bbclass</filename></title> + + <para> + The <filename>primport</filename> class provides functionality for + importing + <link linkend='var-PR'><filename>PR</filename></link> values. + <note> + This class is not intended to be used directly. + Rather, it is enabled when using + "<filename>bitbake-prserv-tool import</filename>". + </note> + </para> +</section> + +<section id='ref-classes-prserv'> + <title><filename>prserv.bbclass</filename></title> + + <para> + The <filename>prserv</filename> class provides functionality for + using a + <ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>PR service</ulink> + in order to automatically manage the incrementing of the + <link linkend='var-PR'><filename>PR</filename></link> variable for + each recipe. + </para> + + <para> + This class is enabled by default because it is inherited by the + <link linkend='ref-classes-package'><filename>package</filename></link> + class. + However, the OpenEmbedded build system will not enable the + functionality of this class unless + <link linkend='var-PRSERV_HOST'><filename>PRSERV_HOST</filename></link> + has been set. + </para> +</section> + +<section id='ref-classes-ptest'> + <title><filename>ptest.bbclass</filename></title> + + <para> + The <filename>ptest</filename> class provides functionality for + packaging and installing runtime tests for recipes that build software + that provides these tests. + </para> + + <para> + This class is intended to be inherited by individual recipes. + However, the class' functionality is largely disabled unless "ptest" + appears in + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" + section in the Yocto Project Development Manual for more information + on ptest. + </para> +</section> + +<section id='ref-classes-ptest-gnome'> + <title><filename>ptest-gnome.bbclass</filename></title> + + <para> + Enables package tests (ptests) specifically for GNOME packages, + which have tests intended to be executed with + <filename>gnome-desktop-testing</filename>. + </para> + + <para> + For information on setting up and running ptests, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" + section in the Yocto Project Development Manual. + </para> +</section> + +<section id='ref-classes-python-dir'> + <title><filename>python-dir.bbclass</filename></title> + + <para> + The <filename>python-dir</filename> class provides the base version, + location, and site package location for Python. + </para> +</section> + +<section id='ref-classes-python3native'> + <title><filename>python3native.bbclass</filename></title> + + <para> + The <filename>python3native</filename> class supports using the + native version of Python 3 built by the build system rather than + support of the version provided by the build host. + </para> +</section> + +<section id='ref-classes-pythonnative'> + <title><filename>pythonnative.bbclass</filename></title> + + <para> + When inherited by a recipe, the <filename>pythonnative</filename> class + supports using the native version of Python built by the build system + rather than using the version provided by the build host. + </para> +</section> + +<section id='ref-classes-qemu'> + <title><filename>qemu.bbclass</filename></title> + + <para> + The <filename>qemu</filename> class provides functionality for recipes + that either need QEMU or test for the existence of QEMU. + Typically, this class is used to run programs for a target system on + the build host using QEMU's application emulation mode. + </para> +</section> + +<section id='ref-classes-recipe_sanity'> + <title><filename>recipe_sanity.bbclass</filename></title> + + <para> + The <filename>recipe_sanity</filename> class checks for the presence + of any host system recipe prerequisites that might affect the + build (e.g. variables that are set or software that is present). + </para> +</section> + +<section id='ref-classes-relocatable'> + <title><filename>relocatable.bbclass</filename></title> + + <para> + The <filename>relocatable</filename> class enables relocation of + binaries when they are installed into the sysroot. + </para> + + <para> + This class makes use of the + <link linkend='ref-classes-chrpath'><filename>chrpath</filename></link> + class and is used by both the + <link linkend='ref-classes-cross'><filename>cross</filename></link> + and + <link linkend='ref-classes-native'><filename>native</filename></link> + classes. + </para> +</section> + +<section id='ref-classes-remove-libtool'> + <title><filename>remove-libtool.bbclass</filename></title> + + <para> + The <filename>remove-libtool</filename> class adds a post function + to the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task to remove all <filename>.la</filename> files installed by + <filename>libtool</filename>. + Removing these files results in them being absent from both the + sysroot and target packages. + </para> + + <para> + If a recipe needs the <filename>.la</filename> files to be installed, + then the recipe can override the removal by setting + <filename>REMOVE_LIBTOOL_LA</filename> to "0" as follows: + <literallayout class='monospaced'> + REMOVE_LIBTOOL_LA = "0" + </literallayout> + <note> + The <filename>remove-libtool</filename> class is not enabled by + default. + </note> + </para> +</section> + +<section id='ref-classes-report-error'> + <title><filename>report-error.bbclass</filename></title> + + <para> + The <filename>report-error</filename> class supports enabling the + <ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>error reporting tool</ulink>, + which allows you to submit build error information to a central + database. + </para> + + <para> + The class collects debug information for recipe, recipe version, task, + machine, distro, build system, target system, host distro, branch, + commit, and log. + From the information, report files using a JSON format are created and + stored in + <filename>${</filename><link linkend='var-LOG_DIR'><filename>LOG_DIR</filename></link><filename>}/error-report</filename>. + </para> +</section> + +<section id='ref-classes-rm-work'> + <title><filename>rm_work.bbclass</filename></title> + + <para> + The <filename>rm_work</filename> class supports deletion of temporary + workspace, which can ease your hard drive demands during builds. + </para> + + <para> + The OpenEmbedded build system can use a substantial amount of disk + space during the build process. + A portion of this space is the work files under the + <filename>${TMPDIR}/work</filename> directory for each recipe. + Once the build system generates the packages for a recipe, the work + files for that recipe are no longer needed. + However, by default, the build system preserves these files + for inspection and possible debugging purposes. + If you would rather have these files deleted to save disk space + as the build progresses, you can enable <filename>rm_work</filename> + by adding the following to your <filename>local.conf</filename> file, + which is found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <literallayout class='monospaced'> + INHERIT += "rm_work" + </literallayout> + If you are modifying and building source code out of the work directory + for a recipe, enabling <filename>rm_work</filename> will potentially + result in your changes to the source being lost. + To exclude some recipes from having their work directories deleted by + <filename>rm_work</filename>, you can add the names of the recipe or + recipes you are working on to the <filename>RM_WORK_EXCLUDE</filename> + variable, which can also be set in your <filename>local.conf</filename> + file. + Here is an example: + <literallayout class='monospaced'> + RM_WORK_EXCLUDE += "busybox glibc" + </literallayout> + </para> +</section> + +<section id='ref-classes-rootfs*'> + <title><filename>rootfs*.bbclass</filename></title> + + <para> + The <filename>rootfs*</filename> classes support creating + the root filesystem for an image and consist of the following classes: + <itemizedlist> + <listitem><para> + The <filename>rootfs-postcommands</filename> class, which + defines filesystem post-processing functions for image recipes. + </para></listitem> + <listitem><para> + The <filename>rootfs_deb</filename> class, which supports + creation of root filesystems for images built using + <filename>.deb</filename> packages.</para></listitem> + <listitem><para> + The <filename>rootfs_rpm</filename> class, which supports + creation of root filesystems for images built using + <filename>.rpm</filename> packages.</para></listitem> + <listitem><para> + The <filename>rootfs_ipk</filename> class, which supports + creation of root filesystems for images built using + <filename>.ipk</filename> packages.</para></listitem> + <listitem><para> + The <filename>rootfsdebugfiles</filename> class, which installs + additional files found on the build host directly into the + root filesystem. + </para></listitem> + </itemizedlist> + </para> + + <para> + The root filesystem is created from packages using one of the + <filename>rootfs*.bbclass</filename> files as determined by the + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + variable. + </para> + + <para> + For information on how root filesystem images are created, see the + "<link linkend='image-generation-dev-environment'>Image Generation</link>" + section. + </para> +</section> + +<section id='ref-classes-sanity'> + <title><filename>sanity.bbclass</filename></title> + + <para> + The <filename>sanity</filename> class checks to see if prerequisite + software is present on the host system so that users can be notified + of potential problems that might affect their build. + The class also performs basic user configuration checks from + the <filename>local.conf</filename> configuration file to + prevent common mistakes that cause build failures. + Distribution policy usually determines whether to include this class. + </para> +</section> + +<section id='ref-classes-scons'> + <title><filename>scons.bbclass</filename></title> + + <para> + The <filename>scons</filename> class supports recipes that need to + build software that uses the SCons build system. + You can use the + <link linkend='var-EXTRA_OESCONS'><filename>EXTRA_OESCONS</filename></link> + variable to specify additional configuration options you want to pass + SCons command line. + </para> +</section> + +<section id='ref-classes-sdl'> + <title><filename>sdl.bbclass</filename></title> + + <para> + The <filename>sdl</filename> class supports recipes that need to build + software that uses the Simple DirectMedia Layer (SDL) library. + </para> +</section> + +<section id='ref-classes-setuptools'> + <title><filename>setuptools.bbclass</filename></title> + + <para> + The <filename>setuptools</filename> class supports Python + version 2.x extensions that use build systems based on + <filename>setuptools</filename>. + If your recipe uses these build systems, the recipe needs to + inherit the <filename>setuptools</filename> class. + </para> +</section> + +<section id='ref-classes-setuptools3'> + <title><filename>setuptools3.bbclass</filename></title> + + <para> + The <filename>setuptools3</filename> class supports Python + version 3.x extensions that use build systems based on + <filename>setuptools3</filename>. + If your recipe uses these build systems, the recipe needs to + inherit the <filename>setuptools3</filename> class. + </para> +</section> + +<section id='ref-classes-sign_rpm'> + <title><filename>sign_rpm.bbclass</filename></title> + + <para> + The <filename>sign_rpm</filename> class supports generating signed + RPM packages. + </para> +</section> + +<section id='ref-classes-sip'> + <title><filename>sip.bbclass</filename></title> + + <para> + The <filename>sip</filename> class + supports recipes that build or package SIP-based Python bindings. + </para> +</section> + +<section id='ref-classes-siteconfig'> + <title><filename>siteconfig.bbclass</filename></title> + + <para> + The <filename>siteconfig</filename> class + provides functionality for handling site configuration. + The class is used by the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class to accelerate the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task. + </para> +</section> + +<section id='ref-classes-siteinfo'> + <title><filename>siteinfo.bbclass</filename></title> + + <para> + The <filename>siteinfo</filename> class provides information about + the targets that might be needed by other classes or recipes. + </para> + + <para> + As an example, consider Autotools, which can require tests that must + execute on the target hardware. + Since this is not possible in general when cross compiling, site + information is used to provide cached test results so these tests can + be skipped over but still make the correct values available. + The + <filename><link linkend='structure-meta-site'>meta/site directory</link></filename> + contains test results sorted into different categories such as + architecture, endianness, and the <filename>libc</filename> used. + Site information provides a list of files containing data relevant to + the current build in the + <filename><link linkend='var-CONFIG_SITE'>CONFIG_SITE</link></filename> variable + that Autotools automatically picks up. + </para> + + <para> + The class also provides variables like + <filename><link linkend='var-SITEINFO_ENDIANNESS'>SITEINFO_ENDIANNESS</link></filename> + and <filename><link linkend='var-SITEINFO_BITS'>SITEINFO_BITS</link></filename> + that can be used elsewhere in the metadata. + </para> + + <para> + Because the + <link linkend='ref-classes-base'><filename>base</filename></link> class + includes the <filename>siteinfo</filename> class, it is always active. + </para> +</section> + +<section id='ref-classes-spdx'> + <title><filename>spdx.bbclass</filename></title> + + <para> + The <filename>spdx</filename> class integrates real-time license + scanning, generation of SPDX standard output, and verification + of license information during the build. + <note> + This class is currently at the prototype stage in the 1.6 + release. + </note> + </para> +</section> + +<section id='ref-classes-sstate'> + <title><filename>sstate.bbclass</filename></title> + + <para> + The <filename>sstate</filename> class provides support for Shared + State (sstate). + By default, the class is enabled through the + <link linkend='var-INHERIT_DISTRO'><filename>INHERIT_DISTRO</filename></link> + variable's default value. + </para> + + <para> + For more information on sstate, see the + "<link linkend='shared-state-cache'>Shared State Cache</link>" + section. + </para> +</section> + +<section id='ref-classes-staging'> + <title><filename>staging.bbclass</filename></title> + + <para> + The <filename>staging</filename> class provides the + <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> + task, which stages files into the sysroot to make them available to + other recipes at build time. + The class is enabled by default because it is inherited by the + <link linkend='ref-classes-base'><filename>base</filename></link> + class. + </para> +</section> + +<section id='ref-classes-syslinux'> + <title><filename>syslinux.bbclass</filename></title> + + <para> + The <filename>syslinux</filename> class provides syslinux-specific + functions for building bootable images. + </para> + + <para> + The class supports the following variables: + <itemizedlist> + <listitem><para><link linkend='var-INITRD'><filename>INITRD</filename></link>: + Indicates list of filesystem images to concatenate and use as + an initial RAM disk (initrd). + This variable is optional.</para></listitem> + <listitem><para><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>: + Indicates a filesystem image to include as the root filesystem. + This variable is optional.</para></listitem> + <listitem><para><link linkend='var-AUTO_SYSLINUXMENU'><filename>AUTO_SYSLINUXMENU</filename></link>: + Enables creating an automatic menu when set to "1". + </para></listitem> + <listitem><para><link linkend='var-LABELS'><filename>LABELS</filename></link>: + Lists targets for automatic configuration. + </para></listitem> + <listitem><para><link linkend='var-APPEND'><filename>APPEND</filename></link>: + Lists append string overrides for each label. + </para></listitem> + <listitem><para><link linkend='var-SYSLINUX_OPTS'><filename>SYSLINUX_OPTS</filename></link>: + Lists additional options to add to the syslinux file. + Semicolon characters separate multiple options. + </para></listitem> + <listitem><para><link linkend='var-SYSLINUX_SPLASH'><filename>SYSLINUX_SPLASH</filename></link>: + Lists a background for the VGA boot menu when you are using the + boot menu.</para></listitem> + <listitem><para><link linkend='var-SYSLINUX_DEFAULT_CONSOLE'><filename>SYSLINUX_DEFAULT_CONSOLE</filename></link>: + Set to "console=ttyX" to change kernel boot default console. + </para></listitem> + <listitem><para><link linkend='var-SYSLINUX_SERIAL'><filename>SYSLINUX_SERIAL</filename></link>: + Sets an alternate serial port. + Or, turns off serial when the variable is set with an + empty string.</para></listitem> + <listitem><para><link linkend='var-SYSLINUX_SERIAL_TTY'><filename>SYSLINUX_SERIAL_TTY</filename></link>: + Sets an alternate "console=tty..." kernel boot argument. + </para></listitem> + </itemizedlist> + </para> +</section> + +<section id='ref-classes-systemd'> + <title><filename>systemd.bbclass</filename></title> + + <para> + The <filename>systemd</filename> class provides support for recipes + that install systemd unit files. + </para> + + <para> + The functionality for this class is disabled unless you have "systemd" + in + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. + </para> + + <para> + Under this class, the recipe or Makefile (i.e. whatever the recipe is + calling during the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task) installs unit files into + <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}${systemd_unitdir}/system</filename>. + If the unit files being installed go into packages other than the + main package, you need to set + <link linkend='var-SYSTEMD_PACKAGES'><filename>SYSTEMD_PACKAGES</filename></link> + in your recipe to identify the packages in which the files will be + installed. + </para> + + <para> + You should set + <link linkend='var-SYSTEMD_SERVICE'><filename>SYSTEMD_SERVICE</filename></link> + to the name of the service file. + You should also use a package name override to indicate the package + to which the value applies. + If the value applies to the recipe's main package, use + <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>. + Here is an example from the connman recipe: + <literallayout class='monospaced'> + SYSTEMD_SERVICE_${PN} = "connman.service" + </literallayout> + Services are set up to start on boot automatically unless + you have set + <link linkend='var-SYSTEMD_AUTO_ENABLE'><filename>SYSTEMD_AUTO_ENABLE</filename></link> + to "disable". + </para> + + <para> + For more information on <filename>systemd</filename>, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#selecting-an-initialization-manager'>Selecting an Initialization Manager</ulink>" + section in the Yocto Project Development Manual. + </para> +</section> + +<section id='ref-classes-terminal'> + <title><filename>terminal.bbclass</filename></title> + + <para> + The <filename>terminal</filename> class provides support for starting + a terminal session. + The + <link linkend='var-OE_TERMINAL'><filename>OE_TERMINAL</filename></link> + variable controls which terminal emulator is used for the session. + </para> + + <para> + Other classes use the <filename>terminal</filename> class anywhere a + separate terminal session needs to be started. + For example, the + <link linkend='ref-classes-patch'><filename>patch</filename></link> + class assuming + <link linkend='var-PATCHRESOLVE'><filename>PATCHRESOLVE</filename></link> + is set to "user", the + <link linkend='ref-classes-cml1'><filename>cml1</filename></link> + class, and the + <link linkend='ref-classes-devshell'><filename>devshell</filename></link> + class all use the <filename>terminal</filename> class. + </para> +</section> + +<section id='ref-classes-testimage*'> + <title><filename>testimage*.bbclass</filename></title> + + <para> + The <filename>testimage*</filename> classes support running + automated tests against images using QEMU and on actual hardware. + The classes handle loading the tests and starting the image. + To use the classes, you need to perform steps to set up the + environment. + </para> + + <para> + The tests are commands that run on the target system over + <filename>ssh</filename>. + Each test is written in Python and makes use of the + <filename>unittest</filename> module. + </para> + + <para> + The <filename>testimage.bbclass</filename> runs tests on an image + when called using the following: + <literallayout class='monospaced'> + $ bitbake -c testimage <replaceable>image</replaceable> + </literallayout> + The <filename>testimage-auto</filename> class runs tests on an image + after the image is constructed (i.e. + <link linkend='var-TEST_IMAGE'><filename>TEST_IMAGE</filename></link> + must be set to "1"). + </para> + + <para> + For information on how to enable, run, and create new tests, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" + section in the Yocto Project Development Manual. + </para> +</section> + +<section id='ref-classes-testsdk'> + <title><filename>testsdk.bbclass</filename></title> + + <para> + This class supports running automated tests against + software development kits (SDKs). + The <filename>testsdk</filename> class runs tests on an SDK when + called using the following: + <literallayout class='monospaced'> + $ bitbake -c testsdk image + </literallayout> + </para> +</section> + +<section id='ref-classes-texinfo'> + <title><filename>texinfo.bbclass</filename></title> + + <para> + This class should be inherited by recipes whose upstream packages + invoke the <filename>texinfo</filename> utilities at build-time. + Native and cross recipes are made to use the dummy scripts provided + by <filename>texinfo-dummy-native</filename>, for improved performance. + Target architecture recipes use the genuine + Texinfo utilities. + By default, they use the Texinfo utilities on the host system. + <note> + If you want to use the Texinfo recipe shipped with the build + system, you can remove "texinfo-native" from + <link linkend='var-ASSUME_PROVIDED'><filename>ASSUME_PROVIDED</filename></link> + and makeinfo from + <link linkend='var-SANITY_REQUIRED_UTILITIES'><filename>SANITY_REQUIRED_UTILITIES</filename></link>. + </note> + </para> +</section> + +<section id='ref-classes-tinderclient'> + <title><filename>tinderclient.bbclass</filename></title> + + <para> + The <filename>tinderclient</filename> class submits build results to + an external Tinderbox instance. + <note> + This class is currently unmaintained. + </note> + </para> +</section> + +<section id='ref-classes-toaster'> + <title><filename>toaster.bbclass</filename></title> + + <para> + The <filename>toaster</filename> class collects information about + packages and images and sends them as events that the BitBake + user interface can receive. + The class is enabled when the Toaster user interface is running. + </para> + + <para> + This class is not intended to be used directly. + </para> +</section> + +<section id='ref-classes-toolchain-scripts'> + <title><filename>toolchain-scripts.bbclass</filename></title> + + <para> + The <filename>toolchain-scripts</filename> class provides the scripts + used for setting up the environment for installed SDKs. + </para> +</section> + +<section id='ref-classes-typecheck'> + <title><filename>typecheck.bbclass</filename></title> + + <para> + The <filename>typecheck</filename> class provides support for + validating the values of variables set at the configuration level + against their defined types. + The OpenEmbedded build system allows you to define the type of a + variable using the "type" varflag. + Here is an example: + <literallayout class='monospaced'> + IMAGE_FEATURES[type] = "list" + </literallayout> + </para> +</section> + +<section id='ref-classes-uboot-config'> + <title><filename>uboot-config.bbclass</filename></title> + + <para> + The <filename>uboot-config</filename> class provides support for + U-Boot configuration for a machine. + Specify the machine in your recipe as follows: + <literallayout class='monospaced'> + UBOOT_CONFIG ??= <default> + UBOOT_CONFIG[foo] = "config,images" + </literallayout> + You can also specify the machine using this method: + <literallayout class='monospaced'> + UBOOT_MACHINE = "config" + </literallayout> + See the + <link linkend='var-UBOOT_CONFIG'><filename>UBOOT_CONFIG</filename></link> + and + <link linkend='var-UBOOT_MACHINE'><filename>UBOOT_MACHINE</filename></link> + variables for additional information. + </para> +</section> + +<section id='ref-classes-uninative'> + <title><filename>uninative.bbclass</filename></title> + + <para> + Attempts to isolate the build system from the host + distribution's C library in order to make re-use of native shared state + artifacts across different host distributions practical. + With this class enabled, a tarball containing a pre-built C library + is downloaded at the start of the build. + In the Poky reference distribution this is enabled by default + through + <filename>meta/conf/distro/include/yocto-uninative.inc</filename>. + Other distributions that do not derive from poky can also + "<filename>require conf/distro/include/yocto-uninative.inc</filename>" + to use this. + Alternatively if you prefer, you can build the uninative-tarball recipe + yourself, publish the resulting tarball (e.g. via HTTP) and set + <filename>UNINATIVE_URL</filename> and + <filename>UNINATIVE_CHECKSUM</filename> appropriately. + For an example, see the + <filename>meta/conf/distro/include/yocto-uninative.inc</filename>. + </para> +</section> + +<section id='ref-classes-update-alternatives'> + <title><filename>update-alternatives.bbclass</filename></title> + + <para> + The <filename>update-alternatives</filename> class helps the + alternatives system when multiple sources provide the same command. + This situation occurs when several programs that have the same or + similar function are installed with the same name. + For example, the <filename>ar</filename> command is available from the + <filename>busybox</filename>, <filename>binutils</filename> and + <filename>elfutils</filename> packages. + The <filename>update-alternatives</filename> class handles + renaming the binaries so that multiple packages can be installed + without conflicts. + The <filename>ar</filename> command still works regardless of which + packages are installed or subsequently removed. + The class renames the conflicting binary in each package and symlinks + the highest priority binary during installation or removal of packages. + </para> + + <para> + To use this class, you need to define a number of variables: + <itemizedlist> + <listitem><para><link linkend='var-ALTERNATIVE'><filename>ALTERNATIVE</filename></link> + </para></listitem> + <listitem><para><link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> + </para></listitem> + <listitem><para><link linkend='var-ALTERNATIVE_TARGET'><filename>ALTERNATIVE_TARGET</filename></link> + </para></listitem> + <listitem><para><link linkend='var-ALTERNATIVE_PRIORITY'><filename>ALTERNATIVE_PRIORITY</filename></link> + </para></listitem> + </itemizedlist> + These variables list alternative commands needed by a package, + provide pathnames for links, default links for targets, and + so forth. + For details on how to use this class, see the comments in the + <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink>. + </para> + + <note> + You can use the <filename>update-alternatives</filename> command + directly in your recipes. + However, this class simplifies things in most cases. + </note> +</section> + +<section id='ref-classes-update-rc.d'> + <title><filename>update-rc.d.bbclass</filename></title> + + <para> + The <filename>update-rc.d</filename> class uses + <filename>update-rc.d</filename> to safely install an + initialization script on behalf of the package. + The OpenEmbedded build system takes care of details such as making + sure the script is stopped before a package is removed and started when + the package is installed. + </para> + + <para> + Three variables control this class: + <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, + <filename><link linkend='var-INITSCRIPT_NAME'>INITSCRIPT_NAME</link></filename> and + <filename><link linkend='var-INITSCRIPT_PARAMS'>INITSCRIPT_PARAMS</link></filename>. + See the variable links for details. + </para> +</section> + +<section id='ref-classes-useradd'> + <title><filename>useradd*.bbclass</filename></title> + + <para> + The <filename>useradd*</filename> classes support the addition of users + or groups for usage by the package on the target. + For example, if you have packages that contain system services that + should be run under their own user or group, you can use these classes + to enable creation of the user or group. + The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename> + recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + provides a simple example that shows how to add three + users and groups to two packages. + See the <filename>useradd-example.bb</filename> recipe for more + information on how to use these classes. + </para> + + <para> + The <filename>useradd_base</filename> class provides basic + functionality for user or groups settings. + </para> + + <para> + The <filename>useradd*</filename> classes support the + <link linkend='var-USERADD_PACKAGES'><filename>USERADD_PACKAGES</filename></link>, + <link linkend='var-USERADD_PARAM'><filename>USERADD_PARAM</filename></link>, + <link linkend='var-GROUPADD_PARAM'><filename>GROUPADD_PARAM</filename></link>, + and + <link linkend='var-GROUPMEMS_PARAM'><filename>GROUPMEMS_PARAM</filename></link> + variables. + </para> + + <para> + The <filename>useradd-staticids</filename> class supports the addition + of users or groups that have static user identification + (<filename>uid</filename>) and group identification + (<filename>gid</filename>) values. + </para> + + <para> + The default behavior of the OpenEmbedded build system for assigning + <filename>uid</filename> and <filename>gid</filename> values when + packages add users and groups during package install time is to + add them dynamically. + This works fine for programs that do not care what the values of the + resulting users and groups become. + In these cases, the order of the installation determines the final + <filename>uid</filename> and <filename>gid</filename> values. + However, if non-deterministic + <filename>uid</filename> and <filename>gid</filename> values are a + problem, you can override the default, dynamic application of these + values by setting static values. + When you set static values, the OpenEmbedded build system looks in + <link linkend='var-BBPATH'><filename>BBPATH</filename></link> for + <filename>files/passwd</filename> and <filename>files/group</filename> + files for the values. + </para> + + <para> + To use static <filename>uid</filename> and <filename>gid</filename> + values, you need to set some variables. + See the + <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>, + <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>, + <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>, + and + <link linkend='var-USERADD_ERROR_DYNAMIC'><filename>USERADD_ERROR_DYNAMIC</filename></link> + variables. + You can also see the + <link linkend='ref-classes-useradd'><filename>useradd</filename></link> + class for additional information. + </para> + + <note><title>Notes</title> + You do not use the <filename>useradd-staticids</filename> + class directly. + You either enable or disable the class by setting the + <filename>USERADDEXTENSION</filename> variable. + If you enable or disable the class in a configured system, + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + might contain incorrect <filename>uid</filename> and + <filename>gid</filename> values. + Deleting the <filename>TMPDIR</filename> directory + will correct this condition. + </note> +</section> + +<section id='ref-classes-utility-tasks'> + <title><filename>utility-tasks.bbclass</filename></title> + + <para> + The <filename>utility-tasks</filename> class provides support for + various "utility" type tasks that are applicable to all recipes, + such as + <link linkend='ref-tasks-clean'><filename>do_clean</filename></link> and + <link linkend='ref-tasks-listtasks'><filename>do_listtasks</filename></link>. + </para> + + <para> + This class is enabled by default because it is inherited by + the + <link linkend='ref-classes-base'><filename>base</filename></link> + class. + </para> +</section> + +<section id='ref-classes-utils'> + <title><filename>utils.bbclass</filename></title> + + <para> + The <filename>utils</filename> class provides some useful Python + functions that are typically used in inline Python expressions + (e.g. <filename>${@...}</filename>). + One example use is for <filename>bb.utils.contains()</filename>. + </para> + + <para> + This class is enabled by default because it is inherited by the + <link linkend='ref-classes-base'><filename>base</filename></link> + class. + </para> +</section> + +<section id='ref-classes-vala'> + <title><filename>vala.bbclass</filename></title> + + <para> + The <filename>vala</filename> class supports recipes that need to + build software written using the Vala programming language. + </para> +</section> + +<section id='ref-classes-waf'> + <title><filename>waf.bbclass</filename></title> + + <para> + The <filename>waf</filename> class supports recipes that need to build + software that uses the Waf build system. + You can use the + <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> + variable to specify additional configuration options to be passed on + the Waf command line. + </para> +</section> + +<!-- Undocumented classes are: + image-empty.bbclass (possibly being dropped) + migrate_localcount.bbclass (still need a description) +--> + + +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-features.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-features.xml new file mode 100644 index 000000000..fd7693500 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-features.xml @@ -0,0 +1,438 @@ +<!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='ref-features'> + <title>Features</title> + + <para> + This chapter provides a reference of shipped machine and distro features + you can include as part of your image, a reference on image features you can + select, and a reference on feature backfilling. + </para> + + <para> + Features provide a mechanism for working out which packages + should be included in the generated images. + Distributions can select which features they want to support through the + <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename> + variable, which is set or appended to in a distribution's configuration file such as + <filename>poky.conf</filename>, + <filename>poky-tiny.conf</filename>, + <filename>poky-lsb.conf</filename> and so forth. + Machine features are set in the + <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename> + variable, which is set in the machine configuration file and + specifies the hardware features for a given machine. + </para> + + <para> + These two variables combine to work out which kernel modules, + utilities, and other packages to include. + A given distribution can support a selected subset of features so some machine features might not + be included if the distribution itself does not support them. + </para> + + <para> + One method you can use to determine which recipes are checking to see if a + particular feature is contained or not is to <filename>grep</filename> through + the <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> + for the feature. + Here is an example that discovers the recipes whose build is potentially + changed based on a given feature: + <literallayout class='monospaced'> + $ cd poky + $ git grep 'contains.*MACHINE_FEATURES.*<replaceable>feature</replaceable>' + </literallayout> + </para> + + <section id='ref-features-machine'> + <title>Machine Features</title> + + <para> + The items below are features you can use with + <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>. + Features do not have a one-to-one correspondence to packages, and they can + go beyond simply controlling the installation of a package or packages. + Sometimes a feature can influence how certain recipes are built. + For example, a feature might determine whether a particular configure option + is specified within the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task for a particular recipe. + </para> + + <para> + This feature list only represents features as shipped with the Yocto Project metadata: + <itemizedlist> + <listitem><para><emphasis>acpi:</emphasis> Hardware has ACPI (x86/x86_64 only) + </para></listitem> + <listitem><para><emphasis>alsa:</emphasis> Hardware has ALSA audio drivers + </para></listitem> + <listitem><para><emphasis>apm:</emphasis> Hardware uses APM (or APM emulation) + </para></listitem> + <listitem><para><emphasis>bluetooth:</emphasis> Hardware has integrated BT + </para></listitem> + <listitem><para><emphasis>efi:</emphasis> Support for booting through EFI + </para></listitem> + <listitem><para><emphasis>ext2:</emphasis> Hardware HDD or Microdrive + </para></listitem> + <listitem><para><emphasis>irda:</emphasis> Hardware has IrDA support + </para></listitem> + <listitem><para><emphasis>keyboard:</emphasis> Hardware has a keyboard + </para></listitem> + <listitem><para><emphasis>pcbios:</emphasis> Support for booting through BIOS + </para></listitem> + <listitem><para><emphasis>pci:</emphasis> Hardware has a PCI bus + </para></listitem> + <listitem><para><emphasis>pcmcia:</emphasis> Hardware has PCMCIA or CompactFlash sockets + </para></listitem> + <listitem><para><emphasis>phone:</emphasis> Mobile phone (voice) support + </para></listitem> + <listitem><para><emphasis>qvga:</emphasis> Machine has a QVGA (320x240) display + </para></listitem> + <listitem><para><emphasis>rtc:</emphasis> Machine has a Real-Time Clock + </para></listitem> + <listitem><para><emphasis>screen:</emphasis> Hardware has a screen + </para></listitem> + <listitem><para><emphasis>serial:</emphasis> Hardware has serial support (usually RS232) + </para></listitem> + <listitem><para><emphasis>touchscreen:</emphasis> Hardware has a touchscreen + </para></listitem> + <listitem><para><emphasis>usbgadget:</emphasis> Hardware is USB gadget device capable + </para></listitem> + <listitem><para><emphasis>usbhost:</emphasis> Hardware is USB Host capable + </para></listitem> + <listitem><para><emphasis>vfat:</emphasis> FAT file system support + </para></listitem> + <listitem><para><emphasis>wifi:</emphasis> Hardware has integrated WiFi + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='ref-features-distro'> + <title>Distro Features</title> + + <para> + The items below are features you can use with + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> + to enable features across your distribution. + Features do not have a one-to-one correspondence to packages, + and they can go beyond simply controlling the installation of a + package or packages. + In most cases, the presence or absence of a feature translates to + the appropriate option supplied to the configure script during the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task for the recipes that optionally + support the feature. + </para> + + <para> + Some distro features are also machine features. + These select features make sense to be controlled both at + the machine and distribution configuration level. + See the + <ulink url='&YOCTO_DOCS_REF_URL;#var-COMBINED_FEATURES'><filename>COMBINED_FEATURES</filename></ulink> + variable for more information. + </para> + + <para> + This list only represents features as shipped with the Yocto Project metadata: + <itemizedlist> + <listitem><para><emphasis>alsa:</emphasis> Include ALSA support + (OSS compatibility kernel modules installed if available). + </para></listitem> + <listitem><para><emphasis>bluetooth:</emphasis> Include + bluetooth support (integrated BT only).</para></listitem> + <listitem><para><emphasis>cramfs:</emphasis> Include CramFS + support.</para></listitem> + <listitem><para><emphasis>directfb:</emphasis> + Include DirectFB support. + </para></listitem> + <listitem><para><emphasis>ext2:</emphasis> Include tools for + supporting for devices with internal HDD/Microdrive for + storing files (instead of Flash only devices). + </para></listitem> + <listitem><para><emphasis>ipsec:</emphasis> Include IPSec + support.</para></listitem> + <listitem><para><emphasis>ipv6:</emphasis> Include IPv6 support. + </para></listitem> + <listitem><para><emphasis>irda:</emphasis> Include IrDA support. + </para></listitem> + <listitem><para><emphasis>keyboard:</emphasis> Include keyboard + support (e.g. keymaps will be loaded during boot). + </para></listitem> + <listitem><para><emphasis>nfs:</emphasis> Include NFS client + support (for mounting NFS exports on device). + </para></listitem> + <listitem><para><emphasis>opengl:</emphasis> + Include the Open Graphics Library, which is a + cross-language, multi-platform application programming + interface used for rendering two and three-dimensional + graphics.</para></listitem> + <listitem><para><emphasis>pci:</emphasis> Include PCI bus + support.</para></listitem> + <listitem><para><emphasis>pcmcia:</emphasis> Include + PCMCIA/CompactFlash support.</para></listitem> + <listitem><para><emphasis>ppp:</emphasis> Include PPP dialup + support.</para></listitem> + <listitem><para><emphasis>ptest:</emphasis> Enables building + the package tests where supported by individual recipes. + For more information on package tests, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" + section in the Yocto Project Development Manual. + </para></listitem> + <listitem><para><emphasis>smbfs:</emphasis> Include SMB networks + client support (for mounting Samba/Microsoft Windows shares + on device).</para></listitem> + <listitem><para><emphasis>systemd:</emphasis> Include support + for this <filename>init</filename> manager, which is a full + replacement of for <filename>init</filename> with parallel + starting of services, reduced shell overhead, and other + features. + This <filename>init</filename> manager is used by many + distributions.</para></listitem> + <listitem><para><emphasis>usbgadget:</emphasis> Include USB + Gadget Device support (for USB networking/serial/storage). + </para></listitem> + <listitem><para><emphasis>usbhost:</emphasis> Include USB Host + support (allows to connect external keyboard, mouse, + storage, network etc).</para></listitem> + <listitem><para><emphasis>wayland:</emphasis> Include the + Wayland display server protocol and the library that + supports it.</para></listitem> + <listitem><para><emphasis>wifi:</emphasis> Include WiFi support + (integrated only).</para></listitem> + <listitem><para><emphasis>x11:</emphasis> Include the X server + and libraries.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='ref-features-image'> + <title>Image Features</title> + + <para> + The contents of images generated by the OpenEmbedded build system + can be controlled by the + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> + and + <link linkend='var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></link> + variables that you typically configure in your image recipes. + Through these variables, you can add several different + predefined packages such as development utilities or packages with + debug information needed to investigate application problems or + profile applications. + </para> + + <para> + The following image features are available for all images: + <itemizedlist> + <listitem><para><emphasis>allow-empty-password:</emphasis> + Allows Dropbear and OpenSSH to accept root logins + and logins from accounts having an empty password string. + </para></listitem> + <listitem><para><emphasis>dbg-pkgs:</emphasis> + Installs debug symbol packages for all packages installed + in a given image. + </para></listitem> + <listitem><para><emphasis>debug-tweaks:</emphasis> + Makes an image suitable for development (e.g. + allows root logins without passwords and enables + post-installation logging). + See the 'allow-empty-password', 'empty-root-password', + and 'post-install-logging' features in this list for + additional information. + </para></listitem> + <listitem><para><emphasis>dev-pkgs:</emphasis> + Installs development packages (headers and extra library + links) for all packages installed in a given image. + </para></listitem> + <listitem><para><emphasis>doc-pkgs:</emphasis> Installs + documentation packages for all packages installed in a + given image. + </para></listitem> + <listitem><para><emphasis>empty-root-password:</emphasis> + Sets the root password to an empty string, which allows + logins with a blank password. + </para></listitem> + <listitem><para><emphasis>package-management:</emphasis> + Installs package management tools and preserves the package + manager database. + </para></listitem> + <listitem><para><emphasis>post-install-logging:</emphasis> + Enables logging postinstall script runs to + the <filename>/var/log/postinstall.log</filename> file + on first boot of the image on the target system. + </para></listitem> + <listitem><para><emphasis>ptest-pkgs:</emphasis> + Installs ptest packages for all ptest-enabled recipes. + </para></listitem> + <listitem><para><emphasis>read-only-rootfs:</emphasis> + Creates an image whose root filesystem is read-only. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" + section in the Yocto Project Development Manual for more + information. + </para></listitem> + <listitem><para><emphasis>splash:</emphasis> + Enables showing a splash screen during boot. + By default, this screen is provided by + <filename>psplash</filename>, which does allow + customization. + If you prefer to use an alternative splash screen package, + you can do so by setting the <filename>SPLASH</filename> + variable to a different package name (or names) within the + image recipe or at the distro configuration level. + </para></listitem> + <listitem><para><emphasis>staticdev-pkgs:</emphasis> + Installs static development packages, which are + static libraries (i.e. <filename>*.a</filename> files), for + all packages installed in a given image. + </para></listitem> + </itemizedlist> + </para> + + <para> + Some image features are available only when you inherit the + <link linkend='ref-classes-core-image'><filename>core-image</filename></link> + class. + The current list of these valid features is as follows: + <itemizedlist> + <listitem><para><emphasis>eclipse-debug:</emphasis> Provides + Eclipse remote debugging support. + </para></listitem> + <listitem><para><emphasis>hwcodecs:</emphasis> Installs + hardware acceleration codecs. + </para></listitem> + <listitem><para><emphasis>nfs-server:</emphasis> + Installs an NFS server. + </para></listitem> + <listitem><para><emphasis>perf:</emphasis> + Installs profiling tools such as + <filename>perf</filename>, <filename>systemtap</filename>, + and <filename>LTTng</filename>. + For general information on user-space tools, see the + <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>. + </para></listitem> + <listitem><para><emphasis>ssh-server-dropbear:</emphasis> + Installs the Dropbear minimal SSH server. + </para></listitem> + <listitem><para><emphasis>ssh-server-openssh:</emphasis> + Installs the OpenSSH SSH server, which is more + full-featured than Dropbear. + Note that if both the OpenSSH SSH server and the Dropbear + minimal SSH server are present in + <filename>IMAGE_FEATURES</filename>, then OpenSSH will take + precedence and Dropbear will not be installed. + </para></listitem> + <listitem><para><emphasis>tools-debug:</emphasis> + Installs debugging tools such as + <filename>strace</filename> and <filename>gdb</filename>. + For information on GDB, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" + section in the Yocto Project Development Manual. + For information on tracing and profiling, see the + <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>. + </para></listitem> + <listitem><para><emphasis>tools-sdk:</emphasis> + Installs a full SDK that runs on the device. + </para></listitem> + <listitem><para><emphasis>tools-testapps:</emphasis> + Installs device testing tools (e.g. touchscreen debugging). + </para></listitem> + <listitem><para><emphasis>x11:</emphasis> + Installs the X server. + </para></listitem> + <listitem><para><emphasis>x11-base:</emphasis> + Installs the X server with a minimal environment. + </para></listitem> + <listitem><para><emphasis>x11-sato:</emphasis> + Installs the OpenedHand Sato environment. + </para></listitem> + </itemizedlist> + </para> + + </section> + + <section id='ref-features-backfill'> + <title>Feature Backfilling</title> + + <para> + Sometimes it is necessary in the OpenEmbedded build system to extend + <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> + or <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> + to control functionality that was previously enabled and not able + to be disabled. + For these cases, we need to add an + additional feature item to appear in one of these variables, + but we do not want to force developers who have existing values + of the variables in their configuration to add the new feature + in order to retain the same overall level of functionality. + Thus, the OpenEmbedded build system has a mechanism to + automatically "backfill" these added features into existing + distro or machine configurations. + You can see the list of features for which this is done by + finding the + <link linkend='var-DISTRO_FEATURES_BACKFILL'><filename>DISTRO_FEATURES_BACKFILL</filename></link> + and <link linkend='var-MACHINE_FEATURES_BACKFILL'><filename>MACHINE_FEATURES_BACKFILL</filename></link> + variables in the <filename>meta/conf/bitbake.conf</filename> file. + </para> + + <para> + Because such features are backfilled by default into all + configurations as described in the previous paragraph, developers + who wish to disable the new features need to be able to selectively + prevent the backfilling from occurring. + They can do this by adding the undesired feature or features to the + <link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename></link> + or <link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename></link> + variables for distro features and machine features respectively. + </para> + + <para> + Here are two examples to help illustrate feature backfilling: + <itemizedlist> + <listitem><para><emphasis>The "pulseaudio" distro feature option</emphasis>: + Previously, PulseAudio support was enabled within the Qt and + GStreamer frameworks. + Because of this, the feature is backfilled and thus + enabled for all distros through the + <filename>DISTRO_FEATURES_BACKFILL</filename> + variable in the <filename>meta/conf/bitbake.conf</filename> file. + However, your distro needs to disable the feature. + You can disable the feature without affecting + other existing distro configurations that need PulseAudio support + by adding "pulseaudio" to + <filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename> + in your distro's <filename>.conf</filename> file. + Adding the feature to this variable when it also + exists in the <filename>DISTRO_FEATURES_BACKFILL</filename> + variable prevents the build system from adding the feature to + your configuration's <filename>DISTRO_FEATURES</filename>, effectively disabling + the feature for that particular distro.</para></listitem> + <listitem><para><emphasis>The "rtc" machine feature option</emphasis>: + Previously, real time clock (RTC) support was enabled for all + target devices. + Because of this, the feature is backfilled and thus enabled + for all machines through the <filename>MACHINE_FEATURES_BACKFILL</filename> + variable in the <filename>meta/conf/bitbake.conf</filename> file. + However, your target device does not have this capability. + You can disable RTC support for your device without + affecting other machines that need RTC support + by adding the feature to your machine's + <filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename> + list in the machine's <filename>.conf</filename> file. + Adding the feature to this variable when it also + exists in the <filename>MACHINE_FEATURES_BACKFILL</filename> + variable prevents the build system from adding the feature to + your configuration's <filename>MACHINE_FEATURES</filename>, effectively + disabling RTC support for that particular machine.</para></listitem> + </itemizedlist> + </para> + </section> +</chapter> + +<!-- +vim: expandtab tw=80 ts=4 spell spelllang=en_gb +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-images.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-images.xml new file mode 100644 index 000000000..69b58f6ab --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-images.xml @@ -0,0 +1,167 @@ +<!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='ref-images'> + <title>Images</title> + + <para> + The OpenEmbedded build system provides several example + images to satisfy different needs. + When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe + that essentially begins the build for the type of image you want. + </para> + + <note> + Building an image without GNU General Public License Version 3 (GPLv3), + GNU Lesser General Public License Version 3 (LGPLv3), and the + GNU Affero General Public License Version 3 (AGPL-3.0) components + is only supported for minimal and base images. + Furthermore, if you are going to build an image using non-GPLv3 and + similarly licensed components, you must make the following changes in + the <filename>local.conf</filename> file before using the BitBake + command to build the minimal or base image: + <literallayout class='monospaced'> + 1. Comment out the EXTRA_IMAGE_FEATURES line + 2. Set INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" + </literallayout> + </note> + + <para> + From within the <filename>poky</filename> Git repository, you can use + the following command to display the list of directories within the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + that containe image recipe files: + <literallayout class='monospaced'> + $ ls meta*/recipes*/images/*.bb + </literallayout> + </para> + + <para> + Following is a list of supported recipes: + <itemizedlist> + <listitem><para><filename>build-appliance-image</filename>: + An example virtual machine that contains all the pieces required to + run builds using the build system as well as the build system itself. + You can boot and run the image using either the + <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink> + or <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>. + For more information on this image, see the + <ulink url='&YOCTO_HOME_URL;/documentation/build-appliance'>Build Appliance</ulink> page on + the Yocto Project website.</para></listitem> + <listitem><para><filename>core-image-base</filename>: + A console-only image that fully supports the target device hardware.</para></listitem> + <listitem><para><filename>core-image-clutter</filename>: + An image with support for the Open GL-based toolkit Clutter, which enables development of + rich and animated graphical user interfaces.</para></listitem> + <listitem><para><filename>core-image-directfb</filename>: + An image that uses <filename>directfb</filename> instead of X11. + </para></listitem> + <listitem><para><filename>core-image-full-cmdline</filename>: + A console-only image with more full-featured Linux system + functionality installed.</para></listitem> + <listitem><para><filename>core-image-lsb</filename>: + An image that conforms to the Linux Standard Base (LSB) + specification. + This image requires a distribution configuration that + enables LSB compliance (e.g. <filename>poky-lsb</filename>). + If you build <filename>core-image-lsb</filename> without that + configuration, the image will not be LSB-compliant. + </para></listitem> + <listitem><para><filename>core-image-lsb-dev</filename>: + A <filename>core-image-lsb</filename> image that is suitable for development work + using the host. + The image includes headers and libraries you can use in a host development + environment. + This image requires a distribution configuration that + enables LSB compliance (e.g. <filename>poky-lsb</filename>). + If you build <filename>core-image-lsb-dev</filename> without that + configuration, the image will not be LSB-compliant. + </para></listitem> + <listitem><para><filename>core-image-lsb-sdk</filename>: + A <filename>core-image-lsb</filename> that includes everything in + the cross-toolchain but also includes development headers and libraries + to form a complete standalone SDK. + This image requires a distribution configuration that + enables LSB compliance (e.g. <filename>poky-lsb</filename>). + If you build <filename>core-image-lsb-sdk</filename> without that + configuration, the image will not be LSB-compliant. + This image is suitable for development using the target.</para></listitem> + <listitem><para><filename>core-image-minimal</filename>: + A small image just capable of allowing a device to boot.</para></listitem> + <listitem><para><filename>core-image-minimal-dev</filename>: + A <filename>core-image-minimal</filename> image suitable for development work + using the host. + The image includes headers and libraries you can use in a host development + environment. + </para></listitem> + <listitem><para id='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename>: + A <filename>core-image-minimal</filename> image that has the Minimal RAM-based + Initial Root Filesystem (initramfs) as part of the kernel, + which allows the system to find the first “init” program more efficiently. + See the + <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link> + variable for additional information helpful when working with + initramfs images. + </para></listitem> + <listitem><para><filename>core-image-minimal-mtdutils</filename>: + A <filename>core-image-minimal</filename> image that has support + for the Minimal MTD Utilities, which let the user interact with the + MTD subsystem in the kernel to perform operations on flash devices. + </para></listitem> + <listitem><para><filename>core-image-rt</filename>: + A <filename>core-image-minimal</filename> image plus a real-time test suite and + tools appropriate for real-time use.</para></listitem> + <listitem><para><filename>core-image-rt-sdk</filename>: + A <filename>core-image-rt</filename> image that includes everything in + the cross-toolchain. + The image also includes development headers and libraries to form a complete + stand-alone SDK and is suitable for development using the target. + </para></listitem> + <listitem><para><filename>core-image-sato</filename>: + An image with Sato support, a mobile environment and visual style that works well + with mobile devices. + The image supports X11 with a Sato theme and applications such as + a terminal, editor, file manager, media player, and so forth. + </para></listitem> + <listitem><para><filename>core-image-sato-dev</filename>: + A <filename>core-image-sato</filename> image suitable for development + using the host. + The image includes libraries needed to build applications on the device itself, + testing and profiling tools, and debug symbols. + This image was formerly <filename>core-image-sdk</filename>. + </para></listitem> + <listitem><para><filename>core-image-sato-sdk</filename>: + A <filename>core-image-sato</filename> image that includes everything in + the cross-toolchain. + The image also includes development headers and libraries to form a complete standalone SDK + and is suitable for development using the target.</para></listitem> + <listitem><para><filename>core-image-testmaster</filename>: + A "master" image designed to be used for automated runtime testing. + Provides a "known good" image that is deployed to a separate + partition so that you can boot into it and use it to deploy a + second image to be tested. + You can find more information about runtime testing in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" + section in the Yocto Project Development Manual. + </para></listitem> + <listitem><para><filename>core-image-testmaster-initramfs</filename>: + A RAM-based Initial Root Filesystem (initramfs) image tailored for + use with the <filename>core-image-testmaster</filename> image. + </para></listitem> + <listitem><para><filename>core-image-weston</filename>: + A very basic Wayland image with a terminal. + This image provides the Wayland protocol libraries and the + reference Weston compositor. + For more information, see the + "<link linkend='wayland'>Wayland</link>" section. + </para></listitem> + <listitem><para><filename>core-image-x11</filename>: + A very basic X11 image with a terminal. + </para></listitem> + </itemizedlist> + </para> +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-manual-customization.xsl b/import-layers/yocto-poky/documentation/ref-manual/ref-manual-customization.xsl new file mode 100644 index 000000000..c58dd905b --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-manual-customization.xsl @@ -0,0 +1,29 @@ +<?xml version='1.0'?> +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> + + <xsl:import href="http://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-xsl-1.76.1/xhtml/docbook.xsl" /> + +<!-- + + <xsl:import href="../template/1.76.1/docbook-xsl-1.76.1/xhtml/docbook.xsl" /> + + <xsl:import href="http://docbook.sourceforge.net/release/xsl/1.76.1/xhtml/docbook.xsl" /> + +--> + + <xsl:include href="../template/permalinks.xsl"/> + <xsl:include href="../template/section.title.xsl"/> + <xsl:include href="../template/component.title.xsl"/> + <xsl:include href="../template/division.title.xsl"/> + <xsl:include href="../template/formal.object.heading.xsl"/> + <xsl:include href="../template/gloss-permalinks.xsl"/> + <xsl:include href="../template/qa-code-permalinks.xsl"/> + + <xsl:param name="html.stylesheet" select="'ref-style.css'" /> + <xsl:param name="chapter.autolabel" select="1" /> + <xsl:param name="appendix.autolabel" select="A" /> + <xsl:param name="section.autolabel" select="1" /> + <xsl:param name="section.label.includes.component.label" select="1" /> + <xsl:param name="generate.id.attributes" select="1" /> + +</xsl:stylesheet> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-manual-eclipse-customization.xsl b/import-layers/yocto-poky/documentation/ref-manual/ref-manual-eclipse-customization.xsl new file mode 100644 index 000000000..f3b752155 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-manual-eclipse-customization.xsl @@ -0,0 +1,35 @@ +<?xml version='1.0'?> +<xsl:stylesheet + xmlns:xsl="http://www.w3.org/1999/XSL/Transform" + xmlns="http://www.w3.org/1999/xhtml" + xmlns:fo="http://www.w3.org/1999/XSL/Format" + version="1.0"> + + <xsl:import href="http://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" /> + +<!-- + + <xsl:import href="../template/1.76.1/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" /> + + <xsl:import + href="http://docbook.sourceforge.net/release/xsl/1.76.1/eclipse/eclipse3.xsl" /> + +--> + + <xsl:param name="chunker.output.indent" select="'yes'"/> + <xsl:param name="chunk.quietly" select="1"/> + <xsl:param name="chunk.first.sections" select="1"/> + <xsl:param name="chunk.section.depth" select="10"/> + <xsl:param name="use.id.as.filename" select="1"/> + <xsl:param name="ulink.target" select="'_self'" /> + <xsl:param name="base.dir" select="'html/ref-manual/'"/> + <xsl:param name="html.stylesheet" select="'../book.css'"/> + <xsl:param name="eclipse.manifest" select="0"/> + <xsl:param name="create.plugin.xml" select="0"/> + <xsl:param name="suppress.navigation" select="1"/> + <xsl:param name="generate.index" select="0"/> + <xsl:param name="chapter.autolabel" select="1" /> + <xsl:param name="appendix.autolabel">A</xsl:param> + <xsl:param name="section.autolabel" select="1" /> + <xsl:param name="section.label.includes.component.label" select="1" /> +</xsl:stylesheet> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-manual.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-manual.xml new file mode 100644 index 000000000..6834d5f0a --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-manual.xml @@ -0,0 +1,165 @@ +<!DOCTYPE book 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; ] > + +<book id='ref-manual' lang='en' + xmlns:xi="http://www.w3.org/2003/XInclude" + xmlns="http://docbook.org/ns/docbook" + > + <bookinfo> + + <mediaobject> + <imageobject> + <imagedata fileref='figures/poky-title.png' + format='SVG' + align='left' scalefit='1' width='100%'/> + </imageobject> + </mediaobject> + + <title> + Yocto Project Reference Manual + </title> + + <authorgroup> + <author> + <firstname>Richard</firstname> <surname>Purdie</surname> + <affiliation> + <orgname>Linux Foundation</orgname> + </affiliation> + <email>richard.purdie@linuxfoundation.org</email> + </author> + + </authorgroup> + + <revhistory> + <revision> + <revnumber>4.0+git</revnumber> + <date>24 November 2010</date> + <revremark>Released with the Yocto Project 0.9 Release</revremark> + </revision> + <revision> + <revnumber>1.0</revnumber> + <date>6 April 2011</date> + <revremark>Released with the Yocto Project 1.0 Release.</revremark> + </revision> + <revision> + <revnumber>1.0.1</revnumber> + <date>23 May 2011</date> + <revremark>Released with the Yocto Project 1.0.1 Release.</revremark> + </revision> + <revision> + <revnumber>1.1</revnumber> + <date>6 October 2011</date> + <revremark>Released with the Yocto Project 1.1 Release.</revremark> + </revision> + <revision> + <revnumber>1.2</revnumber> + <date>April 2012</date> + <revremark>Released with the Yocto Project 1.2 Release.</revremark> + </revision> + <revision> + <revnumber>1.3</revnumber> + <date>October 2012</date> + <revremark>Released with the Yocto Project 1.3 Release.</revremark> + </revision> + <revision> + <revnumber>1.4</revnumber> + <date>April 2013</date> + <revremark>Released with the Yocto Project 1.4 Release.</revremark> + </revision> + <revision> + <revnumber>1.5</revnumber> + <date>October 2013</date> + <revremark>Released with the Yocto Project 1.5 Release.</revremark> + </revision> + <revision> + <revnumber>1.5.1</revnumber> + <date>January 2014</date> + <revremark>Released with the Yocto Project 1.5.1 Release.</revremark> + </revision> + <revision> + <revnumber>1.6</revnumber> + <date>April 2014</date> + <revremark>Released with the Yocto Project 1.6 Release.</revremark> + </revision> + <revision> + <revnumber>1.7</revnumber> + <date>October 2014</date> + <revremark>Released with the Yocto Project 1.7 Release.</revremark> + </revision> + <revision> + <revnumber>1.8</revnumber> + <date>April 2015</date> + <revremark>Released with the Yocto Project 1.8 Release.</revremark> + </revision> + <revision> + <revnumber>2.0</revnumber> + <date>October 2015</date> + <revremark>Released with the Yocto Project 2.0 Release.</revremark> + </revision> + <revision> + <revnumber>2.1</revnumber> + <date>April 2016</date> + <revremark>Released with the Yocto Project 2.1 Release.</revremark> + </revision> + </revhistory> + + <copyright> + <year>©RIGHT_YEAR;</year> + <holder>Linux Foundation</holder> + </copyright> + + <legalnotice> + <para> + Permission is granted to copy, distribute and/or modify this document under + the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</ulink> as published by Creative Commons. + </para> + <note> + For the latest version of this manual associated with this + Yocto Project release, see the + <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink> + from the Yocto Project website. + </note> + </legalnotice> + + </bookinfo> + + <xi:include href="introduction.xml"/> + + <xi:include href="usingpoky.xml"/> + + <xi:include href="closer-look.xml"/> + + <xi:include href="technical-details.xml"/> + + <xi:include href="migration.xml"/> + + <xi:include href="ref-structure.xml"/> + + <xi:include href="ref-classes.xml"/> + + <xi:include href="ref-tasks.xml"/> + + <xi:include href="ref-qa-checks.xml"/> + + <xi:include href="ref-images.xml"/> + + <xi:include href="ref-features.xml"/> + + <xi:include href="ref-variables.xml"/> + + <xi:include href="ref-varlocality.xml"/> + + <xi:include href="faq.xml"/> + + <xi:include href="resources.xml"/> + +<!-- <index id='index'> + <title>Index</title> + </index> +--> + +</book> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-qa-checks.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-qa-checks.xml new file mode 100644 index 000000000..4fcf1db61 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-qa-checks.xml @@ -0,0 +1,1237 @@ +<!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='ref-qa-checks'> +<title>QA Error and Warning Messages</title> + +<section id='qa-introduction'> + <title>Introduction</title> + + <para> + When building a recipe, the OpenEmbedded build system performs + various QA checks on the output to ensure that common issues are + detected and reported. + Sometimes when you create a new recipe to build new software, + it will build with no problems. + When this is not the case, or when you have QA issues building any + software, it could take a little time to resolve them. + </para> + + <para> + While it is tempting to ignore a QA message or even to + disable QA checks, it is best to try and resolve any + reported QA issues. + This chapter provides a list of the QA messages and brief explanations + of the issues you could encounter so that you can properly resolve + problems. + </para> + + <para> + The next section provides a list of all QA error and warning + messages based on a default configuration. + Each entry provides the message or error form along with an + explanation. + <note> + <title>Notes</title> + <itemizedlist> + <listitem><para> + At the end of each message, the name of the associated + QA test (as listed in the + "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" + section) appears within square brackets. + </para></listitem> + <listitem><para> + As mentioned, this list of error and warning messages is for + QA checks only. + The list does not cover all possible build errors or + warnings you could encounter. + </para></listitem> + <listitem><para> + Because some QA checks are disabled by default, this list + does not include all possible QA check errors and warnings. + </para></listitem> + </itemizedlist> + </note> + </para> +</section> + +<section id='qa-errors-and-warnings'> + <title>Errors and Warnings</title> + +<!-- +This section uses the <para><code> construct to enable permalinks for the +various QA issue and warning messages. The file templates/qa-code-permalinks.xsl +is used to locate the construct and generate the permalink. This solution +leverages the fact that right now this section in the ref-manual is the only +place is all the YP docs that uses the <para><code> construct. If, in the +future, that construct were to appear in the ref-manual, a generic permalink +would be generated for the text between <code></code>. If a better solution +can be found then it should be implemented. I can't find one at the moment. +--> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-libexec'> + <code> + <packagename>: <path> is using libexec please relocate to <libexecdir> [libexec] + </code> + </para> + + <para> + The specified package contains files in + <filename>/usr/libexec</filename> when the distro + configuration uses a different path for + <filename><libexecdir></filename> + By default, <filename><libexecdir></filename> is + <filename>$prefix/libexec</filename>. + However, this default can be changed (e.g. + <filename>${libdir}</filename>). + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-rpaths'> + <code> + package <packagename> contains bad RPATH <rpath> in file <file> [rpaths] + </code> + </para> + + <para> + The specified binary produced by the recipe contains dynamic + library load paths (rpaths) that contain build system paths + such as + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>, + which are incorrect for the target and could potentially + be a security issue. + Check for bad <filename>-rpath</filename> options being + passed to the linker in your + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + log. + Depending on the build system used by the software being + built, there might be a configure option to disable rpath + usage completely within the build of the software. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-useless-rpaths'> + <code> + <packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths] + </code> + </para> + + <para> + The specified binary produced by the recipe contains dynamic + library load paths (rpaths) that on a standard system are + searched by default by the linker (e.g. + <filename>/lib</filename> and <filename>/usr/lib</filename>). + While these paths will not cause any breakage, they do waste + space and are unnecessary. + Depending on the build system used by the software being + built, there might be a configure option to disable rpath + usage completely within the build of the software. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-file-rdeps'> + <code> + <packagename> requires <files>, but no providers in its RDEPENDS [file-rdeps] + </code> + </para> + + <para> + A file-level dependency has been identified from the + specified package on the specified files, but there is + no explicit corresponding entry in + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>. + If particular files are required at runtime then + <filename>RDEPENDS</filename> should be declared in the + recipe to ensure the packages providing them are built. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-build-deps'> + <code> + <packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps] + </code> + </para> + + <para> + A runtime dependency exists between the two specified + packages, but there is nothing explicit within the recipe + to enable the OpenEmbedded build system to ensure that + dependency is satisfied. + This condition is usually triggered by an + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + value being added at the packaging stage rather than up + front, which is usually automatic based on the contents of + the package. + In most cases, you should change the recipe to add an + explicit <filename>RDEPENDS</filename> for the dependency. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-dev-so'> + <code> + non -dev/-dbg/nativesdk- package contains symlink .so: <packagename> path '<path>' [dev-so] + </code> + </para> + + <para> + Symlink <filename>.so</filename> files are for development + only, and should therefore go into the + <filename>-dev</filename> package. + This situation might occur if you add + <filename>*.so*</filename> rather than + <filename>*.so.*</filename> to a non-dev package. + Change + <link linkend='var-FILES'><filename>FILES</filename></link> + (and possibly + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>) + such that the specified <filename>.so</filename> file goes + into an appropriate <filename>-dev</filename> package. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-staticdev'> + <code> + non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev] + </code> + </para> + + <para> + Static <filename>.a</filename> library files should go into + a <filename>-staticdev</filename> package. + Change + <link linkend='var-FILES'><filename>FILES</filename></link> + (and possibly + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>) + such that the specified <filename>.a</filename> file goes + into an appropriate <filename>-staticdev</filename> package. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-libdir'> + <code> + <packagename>: found library in wrong location [libdir] + </code> + </para> + + <para> + The specified file may have been installed into an incorrect + (possibly hardcoded) installation path. + For example, this test will catch recipes that install + <filename>/lib/bar.so</filename> when + <filename>${base_libdir}</filename> is "lib32". + Another example is when recipes install + <filename>/usr/lib64/foo.so</filename> when + <filename>${libdir}</filename> is "/usr/lib". + False positives occasionally exist. + For these cases add "libdir" to + <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link> + for the package. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-debug-files'> + <code> + non debug package contains .debug directory: <packagename> path <path> [debug-files] + </code> + </para> + + <para> + The specified package contains a + <filename>.debug</filename> directory, which should not + appear in anything but the <filename>-dbg</filename> + package. + This situation might occur if you add a path which contains + a <filename>.debug</filename> directory and do not + explicitly add the <filename>.debug</filename> directory + to the <filename>-dbg</filename> package. + If this is the case, add the <filename>.debug</filename> + directory explicitly to + <filename>FILES_${PN}-dbg</filename>. + See + <link linkend='var-FILES'><filename>FILES</filename></link> + for additional information on <filename>FILES</filename>. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-arch'> + <code> + Architecture did not match (<machine_arch> to <file_arch>) on <file> [arch] + </code> + </para> + + <para> + By default, the OpenEmbedded build system checks the + Executable and Linkable Format (ELF) type, bit size, and + endianness of any binaries to ensure they match the + target architecture. + This test fails if any binaries do not match the type since + there would be an incompatibility. + The test could indicate that the wrong compiler or compiler + options have been used. + Sometimes software, like bootloaders, might need to + bypass this check. + If the file you receive the error for is firmware + that is not intended to be executed within the target + operating system or is intended to run on a separate + processor within the device, you can add "arch" to + <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link> + for the package. + Another option is to check the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + log and verify that the compiler options being used + are correct. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-arch-bit-size-no-match'> + <code> + Bit size did not match (<machine_bits> to <file_bits>) <recipe> on <file> [arch] + </code> + </para> + + <para> + By default, the OpenEmbedded build system checks + the Executable and Linkable Format (ELF) type, + bit size, and endianness of any binaries to ensure + they match the target architecture. + This test fails if any binaries do not match the type since + there would be an incompatibility. + The test could indicate that the wrong compiler or compiler + options have been used. + Sometimes software, like bootloaders, might need to + bypass this check. + If the file you receive the error for is firmware that + is not intended to be executed within the target + operating system or is intended to run on a separate + processor within the device, you can add "arch" to + <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link> + for the package. + Another option is to check the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + log and verify that the compiler options being used are + correct. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-arch-endianness-no-match'> + <code> + Endianness did not match (<machine_endianness> to <file_endianness>) on <file> [arch] + </code> + </para> + + <para> + By default, the OpenEmbedded build system checks + the Executable and Linkable Format (ELF) type, bit + size, and endianness of any binaries to ensure they + match the target architecture. + This test fails if any binaries do not match the type since + there would be an incompatibility. + The test could indicate that the wrong compiler or compiler + options have been used. + Sometimes software, like bootloaders, might need to + bypass this check. + If the file you receive the error for is firmware + that is not intended to be executed within the target + operating system or is intended to run on a separate + processor within the device, you can add "arch" to + <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link> + for the package. + Another option is to check the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + log and verify that the compiler options being used + are correct. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-textrel'> + <code> + ELF binary '<file>' has relocations in .text [textrel] + </code> + </para> + + <para> + The specified ELF binary contains relocations in its + <filename>.text</filename> sections. + This situation can result in a performance impact + at runtime. + </para> + + <para> + Typically, the way to solve this performance issue is to + add "-fPIC" or "-fpic" to the compiler command-line + options. + For example, given software that reads + <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> + when you build it, you could add the following to your + recipe: + <literallayout class='monospaced'> + CFLAGS_append = " -fPIC " + </literallayout> + </para> + + <para> + For more information on text relocations at runtime, see + <ulink url='http://www.akkadia.org/drepper/textrelocs.html'></ulink>. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-ldflags'> + <code> + No GNU_HASH in the elf binary: '<file>' [ldflags] + </code> + </para> + + <para> + This indicates that binaries produced when building the + recipe have not been linked with the + <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> + options provided by the build system. + Check to be sure that the <filename>LDFLAGS</filename> + variable is being passed to the linker command. + A common workaround for this situation is to pass in + <filename>LDFLAGS</filename> using + <link linkend='var-TARGET_CC_ARCH'><filename>TARGET_CC_ARCH</filename></link> + within the recipe as follows: + <literallayout class='monospaced'> + TARGET_CC_ARCH += "${LDFLAGS}" + </literallayout> + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-xorg-driver-abi'> + <code> + Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi] + </code> + </para> + + <para> + The specified package contains an Xorg driver, but does not + have a corresponding ABI package dependency. + The xserver-xorg recipe provides driver ABI names. + All drivers should depend on the ABI versions that they have + been built against. + Driver recipes that include + <filename>xorg-driver-input.inc</filename> or + <filename>xorg-driver-video.inc</filename> will + automatically get these versions. + Consequently, you should only need to explicitly add + dependencies to binary driver recipes. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-infodir'> + <code> + The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir] + </code> + </para> + + <para> + The <filename>/usr/share/info/dir</filename> should not be + packaged. + Add the following line to your + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task or to your <filename>do_install_append</filename> + within the recipe as follows: + <literallayout class='monospaced'> + rm ${D}${infodir}/dir + </literallayout> + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-symlink-to-sysroot'> + <code> + Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot] + </code> + </para> + + <para> + The specified symlink points into + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + on the host. + Such symlinks will work on the host. + However, they are clearly invalid when running on + the target. + You should either correct the symlink to use a relative + path or remove the symlink. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-la'> + <code> + <file> failed sanity test (workdir) in path <path> [la] + </code> + </para> + + <para> + The specified <filename>.la</filename> file contains + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + paths. + Any <filename>.la</filename> file containing these paths + is incorrect since <filename>libtool</filename> adds the + correct sysroot prefix when using the files automatically + itself. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-pkgconfig'> + <code> + <file> failed sanity test (tmpdir) in path <path> [pkgconfig] + </code> + </para> + + <para> + The specified <filename>.pc</filename> file contains + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>/</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> + paths. + Any <filename>.pc</filename> file containing these paths is + incorrect since <filename>pkg-config</filename> itself adds + the correct sysroot prefix when the files are accessed. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-debug-deps'> + <code> + <packagename> rdepends on <debug_packagename> [debug-deps] + </code> + </para> + + <para> + A dependency exists between the specified non-dbg package + (i.e. a package whose name does not end in + <filename>-dbg</filename>) and a package that is a + <filename>dbg</filename> package. + The <filename>dbg</filename> packages contain + debug symbols and are brought in using several + different methods: + <itemizedlist> + <listitem><para> + Using the <filename>dbg-pkgs</filename> + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> + value. + </para></listitem> + <listitem><para> + Using + <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>. + </para></listitem> + <listitem><para> + As a dependency of another + <filename>dbg</filename> package that was brought + in using one of the above methods. + </para></listitem> + </itemizedlist> + The dependency might have been automatically added + because the <filename>dbg</filename> package erroneously + contains files that it should not contain (e.g. a + non-symlink <filename>.so</filename> file) or it might + have been added manually (e.g. by adding to + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>). + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-dev-deps'> + <code> + <packagename> rdepends on <dev_packagename> [dev-deps] + </code> + </para> + + <para> + A dependency exists between the specified non-dev package + (a package whose name does not end in + <filename>-dev</filename>) and a package that is a + <filename>dev</filename> package. + The <filename>dev</filename> packages contain development + headers and are usually brought in using several different + methods: + <itemizedlist> + <listitem><para> + Using the <filename>dev-pkgs</filename> + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> + value. + </para></listitem> + <listitem><para> + Using + <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>. + </para></listitem> + <listitem><para> + As a dependency of another + <filename>dev</filename> package that was brought + in using one of the above methods. + </para></listitem> + </itemizedlist> + The dependency might have been automatically added (because + the <filename>dev</filename> package erroneously contains + files that it should not have (e.g. a non-symlink + <filename>.so</filename> file) or it might have been added + manually (e.g. by adding to + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>). + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-dep-cmp'> + <code> + <var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp] + </code> + </para> + + <para> + If you are adding a versioned dependency relationship to one + of the dependency variables + (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, + <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, + <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, + <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, + or + <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>), + you must only use the named comparison operators. + Change the versioned dependency values you are adding + to match those listed in the message. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-compile-host-path'> + <code> + <recipename>: The compile log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [compile-host-path] + </code> + </para> + + <para> + The log for the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + task indicates that paths on the host were searched + for files, which is not appropriate when cross-compiling. + Look for "is unsafe for cross-compilation" or "CROSS COMPILE + Badness" in the specified log file. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-install-host-path'> + <code> + <recipename>: The install log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [install-host-path] + </code> + </para> + + <para> + The log for the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task indicates that paths on the host were searched + for files, which is not appropriate when cross-compiling. + Look for "is unsafe for cross-compilation" + or "CROSS COMPILE Badness" in the specified log file. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-autoconf-log'> + <code> + This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. The path was '<path>' + </code> + </para> + + <para> + The log for the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task indicates that paths on the host were searched + for files, which is not appropriate when cross-compiling. + Look for "is unsafe for cross-compilation" or + "CROSS COMPILE Badness" in the specified log file. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-pkgname'> + <code> + <packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname] + </code> + </para> + + <para> + The convention within the OpenEmbedded build system + (sometimes enforced by the package manager itself) is to + require that package names are all lower case + and to allow a restricted set of characters. + If your recipe name does not match this, or you add + packages to + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> + that do not conform to the convention, then you + will receive this error. + Rename your recipe. + Or, if you have added a non-conforming package name to + <filename>PACKAGES</filename>, change the package name + appropriately. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-unknown-configure-option'> + <code> + <recipe>: configure was passed unrecognized options: <options> [unknown-configure-option] + </code> + </para> + + <para> + The configure script is reporting that the specified + options are unrecognized. + This situation could be because the options + were previously valid but have been removed from the + configure script. + Or, there was a mistake when the options were added + and there is another option that should be used instead. + If you are unsure, consult the upstream build + documentation, the + <filename>./configure --help</filename> output, + and the upstream change log or release notes. + Once you have worked out what the appropriate + change is, you can update + <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> + or the individual + <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> + option values accordingly. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-pn-overrides'> + <code> + Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides] + </code> + </para> + + <para> + The specified recipe has a name + (<link linkend='var-PN'><filename>PN</filename></link>) + value that appears in + <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>. + If a recipe is named such that its <filename>PN</filename> + value matches something already in + <filename>OVERRIDES</filename> (e.g. <filename>PN</filename> + happens to be the same as + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + or + <link linkend='var-DISTRO'><filename>DISTRO</filename></link>), + it can have unexpected consequences. + For example, assignments such as + <filename>FILES_${PN} = "xyz"</filename> effectively + turn into <filename>FILES = "xyz"</filename>. + Rename your recipe (or if <filename>PN</filename> is being + set explicitly, change the <filename>PN</filename> value) so + that the conflict does not occur. + See + <link linkend='var-FILES'><filename>FILES</filename></link> + for additional information. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-pkgvarcheck'> + <code> + <recipefile>: Variable <variable> is set as not being package specific, please fix this. [pkgvarcheck] + </code> + </para> + + <para> + Certain variables + (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, + <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, + <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>, + <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, + <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, + <link linkend='var-FILES'><filename>FILES</filename></link>, + <filename>pkg_preinst</filename>, + <filename>pkg_postinst</filename>, + <filename>pkg_prerm</filename>, + <filename>pkg_postrm</filename>, and + <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>) + should always be set specific to a package (i.e. they + should be set with a package name override such as + <filename>RDEPENDS_${PN} = "value"</filename> rather than + <filename>RDEPENDS = "value"</filename>). + If you receive this error, correct any assignments to these + variables within your recipe. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-already-stripped'> + <code> + File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped] + </code> + </para> + + <para> + Produced binaries have already been stripped prior to the + build system extracting debug symbols. + It is common for upstream software projects to default to + stripping debug symbols for output binaries. + In order for debugging to work on the target using + <filename>-dbg</filename> packages, this stripping must be + disabled. + </para> + + <para> + Depending on the build system used by the software being + built, disabling this stripping could be as easy as + specifying an additional configure option. + If not, disabling stripping might involve patching + the build scripts. + In the latter case, look for references to "strip" or + "STRIP", or the "-s" or "-S" command-line options being + specified on the linker command line (possibly + through the compiler command line if preceded with "-Wl,"). + <note> + Disabling stripping here does not mean that the final + packaged binaries will be unstripped. + Once the OpenEmbedded build system splits out debug + symbols to the <filename>-dbg</filename> package, + it will then strip the symbols from the binaries. + </note> + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-packages-list'> + <code> + <packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list] + </code> + </para> + + <para> + Package names must appear only once in the + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> + variable. + You might receive this error if you are attempting to add a + package to <filename>PACKAGES</filename> that is + already in the variable's value. + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-files-invalid'> + <code> + FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid] + </code> + </para> + + <para> + The string "//" is invalid in a Unix path. + Correct all occurrences where this string appears in a + <link linkend='var-FILES'><filename>FILES</filename></link> + variable so that there is only a single "/". + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-installed-vs-shipped'> + <code> + <recipename>: Files/directories were installed but not shipped [installed-vs-shipped] + </code> + </para> + + <para> + Files have been installed within the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task but have not been included in any package by way of the + <link linkend='var-FILES'><filename>FILES</filename></link> + variable. + Files that do not appear in any package cannot be present in + an image later on in the build process. + You need to do one of the following: + <itemizedlist> + <listitem><para> + Add the files to <filename>FILES</filename> for the + package you want them to appear in (e.g. + <filename>FILES_${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename> for the main + package). + </para></listitem> + <listitem><para> + Delete the files at the end of the + <filename>do_install</filename> task if the files + are not needed in any package. + </para></listitem> + </itemizedlist> + </para> + + <para> + + </para> + </listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem> + <para id='qa-issue-old-and-new-package-and-version-names'> + <code> + <oldpackage>-<oldpkgversion> was registered as shlib provider for <library>, changing it to <newpackage>-<newpkgversion> because it was built later + </code> + </para> + + <para> + This message means that both + <filename><oldpackage></filename> and + <filename><newpackage></filename> provide the specified + shared library. + You can expect this message when a recipe has been renamed. + However, if that is not the case, the message might indicate + that a private version of a library is being erroneously + picked up as the provider for a common library. + If that is the case, you should add the library's + <filename>.so</filename> file name to + <link linkend='var-PRIVATE_LIBS'><filename>PRIVATE_LIBS</filename></link> + in the recipe that provides + the private version of the library. + </para> + </listitem> + </itemizedlist> + </para> + +<!-- +Here are some messages that might be documented in the future. +Right now we are not documenting them because the QA checks are not +enabled by default: + + <para> + <itemizedlist> + <listitem><para> + <literallayout class='monospaced'> + Desktop file issue: <error> [desktop] + </literallayout> + NEED A DESCRIPTION AND SOLUTION + </para></listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem><para> + <literallayout class='monospaced'> + <packagename>: <file>, installed in the base_prefix, requires a shared library under exec_prefix (<exec_prefix&t;g) [unsafe-references-in-binaries] + </literallayout> + NEED A DESCRIPTION AND SOLUTION + </para></listitem> + </itemizedlist> + </para> + + <para> + <itemizedlist> + <listitem><para> + <literallayout class='monospaced'> + <packagename>: Found a reference to <exec_prefix>/ in <path> - Shell scripts in base_bindir and base_sbindir should not reference anything in exec_prefix [unsafe-references-in-scripts] + </literallayout> + NEED A DESCRIPTION AND SOLUTION + </para></listitem> + </itemizedlist> + </para> +--> +</section> + +<section id='configuring-and-disabling-qa-checks'> + <title>Configuring and Disabling QA Checks</title> + + <para> + You can configure the QA checks globally so that specific check + failures either raise a warning or an error message, using the + <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and + <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link> + variables, respectively. + You can also disable checks within a particular recipe using + <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>. + For information on how to work with the QA checks, see the + "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" + section. + <note><title>Tip</title> + Please keep in mind that the QA checks exist in order to + detect real or potential problems in the packaged output. + So exercise caution when disabling these checks. + </note> + </para> +</section> +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-structure.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-structure.xml new file mode 100644 index 000000000..e51ceb1bf --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-structure.xml @@ -0,0 +1,1142 @@ +<!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='ref-structure'> + +<title>Source Directory Structure</title> + +<para> + The <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> consists of several components. + Understanding them and knowing where they are located is key to using the Yocto Project well. + This chapter describes the Source Directory and gives information about the various + files and directories. +</para> + +<para> + For information on how to establish a local Source Directory on your development system, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>" + section in the Yocto Project Development Manual. +</para> + +<note> + The OpenEmbedded build system does not support file or directory names that + contain spaces. + Be sure that the Source Directory you use does not contain these types + of names. +</note> + +<section id='structure-core'> + <title>Top-Level Core Components</title> + + <para> + This section describes the top-level components of the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + + <section id='structure-core-bitbake'> + <title><filename>bitbake/</filename></title> + + <para> + This directory includes a copy of BitBake for ease of use. + The copy usually matches the current stable BitBake release from + the BitBake project. + BitBake, a + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> + interpreter, reads the Yocto Project Metadata and runs the tasks + defined by that data. + Failures are usually from the Metadata and not from BitBake itself. + Consequently, most users do not need to worry about BitBake. + </para> + + <para> + When you run the <filename>bitbake</filename> command, the + main BitBake executable, which resides in the + <filename>bitbake/bin/</filename> directory, starts. + Sourcing an environment setup script (e.g. + <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend="structure-memres-core-script"><filename>oe-init-build-env-memres</filename></link>) + places the <filename>scripts</filename> and + <filename>bitbake/bin</filename> directories (in that order) into + the shell's <filename>PATH</filename> environment variable. + </para> + + <para> + For more information on BitBake, see the + <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>. + </para> + </section> + + <section id='structure-core-build'> + <title><filename>build/</filename></title> + + <para> + This directory contains user configuration files and the output + generated by the OpenEmbedded build system in its standard configuration where + the source tree is combined with the output. + The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + is created initially when you <filename>source</filename> + the OpenEmbedded build environment setup script + (i.e. + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). + </para> + + <para> + It is also possible to place output and configuration + files in a directory separate from the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + by providing a directory name when you <filename>source</filename> + the setup script. + For information on separating output from your local + Source Directory files, see the + "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + and + "<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>" + sections. + </para> + </section> + + <section id='handbook'> + <title><filename>documentation/</filename></title> + + <para> + This directory holds the source for the Yocto Project documentation + as well as templates and tools that allow you to generate PDF and HTML + versions of the manuals. + Each manual is contained in a sub-folder. + For example, the files for this manual reside in + the <filename>ref-manual/</filename> directory. + </para> + </section> + + <section id='structure-core-meta'> + <title><filename>meta/</filename></title> + + <para> + This directory contains the OpenEmbedded Core metadata. + The directory holds recipes, common classes, and machine + configuration for emulated targets (<filename>qemux86</filename>, + <filename>qemuarm</filename>, and so forth.) + </para> + </section> + + <section id='structure-core-meta-poky'> + <title><filename>meta-poky/</filename></title> + + <para> + This directory contains the configuration for the Poky + reference distribution. + </para> + </section> + + <section id='structure-core-meta-yocto-bsp'> + <title><filename>meta-yocto-bsp/</filename></title> + + <para> + This directory contains the Yocto Project reference + hardware Board Support Packages (BSPs). + For more information on BSPs, see the + <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support + Package (BSP) Developer's Guide</ulink>. + </para> + </section> + + <section id='structure-meta-selftest'> + <title><filename>meta-selftest/</filename></title> + + <para> + This directory adds additional recipes and append files + used by the OpenEmbedded selftests to verify the behavior + of the build system. + </para> + + <para> + You do not have to add this layer to your + <filename>bblayers.conf</filename> file unless you want to run the + selftests. + </para> + </section> + + <section id='structure-meta-skeleton'> + <title><filename>meta-skeleton/</filename></title> + + <para> + This directory contains template recipes for BSP and kernel development. + </para> + </section> + + <section id='structure-core-scripts'> + <title><filename>scripts/</filename></title> + + <para> + This directory contains various integration scripts that implement + extra functionality in the Yocto Project environment (e.g. QEMU scripts). + The <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link> + and + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> + scripts append this directory to the shell's + <filename>PATH</filename> environment variable. + </para> + + <para> + The <filename>scripts</filename> directory has useful scripts that assist in contributing + back to the Yocto Project, such as <filename>create-pull-request</filename> and + <filename>send-pull-request</filename>. + </para> + </section> + + <section id='structure-core-script'> + <title><filename>&OE_INIT_FILE;</filename></title> + + <para> + This script is one of two scripts that set up the OpenEmbedded build + environment. + For information on the other script, see the + "<link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>" + section. + </para> + + <para> + Running this script with the <filename>source</filename> command in + a shell makes changes to <filename>PATH</filename> and sets other + core BitBake variables based on the current working directory. + You need to run an environment setup script before running BitBake + commands. + The script uses other scripts within the + <filename>scripts</filename> directory to do the bulk of the work. + </para> + + <para> + When you run this script, your Yocto Project environment is set + up, a + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + is created, your working directory becomes the Build Directory, + and you are presented with a list of common BitBake targets. + Here is an example: + <literallayout class='monospaced'> + $ source oe-init-build-env + + ### Shell environment set up for builds. ### + + You can now run 'bitbake <target>' + + Common targets are: + core-image-minimal + core-image-sato + meta-toolchain + meta-ide-support + + You can also run generated qemu images with a command like 'runqemu qemux86' + </literallayout> + The script gets its default list of common targets from the + <filename>conf-notes.txt</filename> file, which is found in the + <filename>meta-poky</filename> directory within the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + Should you have custom distributions, it is very easy to modify + this configuration file to include your targets for your + distribution. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" + section in the Yocto Project Development Manual for more + information. + </para> + + <para> + By default, running this script without a + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + argument creates the <filename>build</filename> directory + in your current working directory. + If you provide a Build Directory argument when you + <filename>source</filename> the script, you direct the OpenEmbedded + build system to create a Build Directory of your choice. + For example, the following command creates a Build Directory named + <filename>mybuilds</filename> that is outside of the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: + <literallayout class='monospaced'> + $ source &OE_INIT_FILE; ~/mybuilds + </literallayout> + The OpenEmbedded build system uses the template configuration + files, which are found by default in the + <filename>meta-poky/conf</filename> directory in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" + section in the Yocto Project Development Manual for more + information. + <note> + The OpenEmbedded build system does not support file or directory names that + contain spaces. + If you attempt to run the <filename>&OE_INIT_FILE;</filename> script + from a Source Directory that contains spaces in either the filenames + or directory names, the script returns an error indicating no such + file or directory. + Be sure to use a Source Directory free of names containing spaces. + </note> + </para> + </section> + + <section id='structure-memres-core-script'> + <title><filename>oe-init-build-env-memres</filename></title> + + <para> + This script is one of two scripts that set up the OpenEmbedded + build environment. + Aside from setting up the environment, this script starts a + memory-resident BitBake server. + For information on the other setup script, see the + "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>" + section. + </para> + + <para> + Memory-resident BitBake resides in memory until you specifically + remove it using the following BitBake command: + <literallayout class='monospaced'> + $ bitbake -m + </literallayout> + </para> + + <para> + Running this script with the <filename>source</filename> command in + a shell makes changes to <filename>PATH</filename> and sets other + core BitBake variables based on the current working directory. + One of these variables is the + <link linkend='var-BBSERVER'><filename>BBSERVER</filename></link> + variable, which allows the OpenEmbedded build system to locate + the server that is running BitBake. + </para> + + <para> + You need to run an environment setup script before using BitBake + commands. + Following is the script syntax: + <literallayout class='monospaced'> + $ source oe-init-build-env-memres <replaceable>port_number</replaceable> <replaceable>build_dir</replaceable> + </literallayout> + Following are some considerations when sourcing this script: + <itemizedlist> + <listitem><para> + The script uses other scripts within the + <filename>scripts</filename> directory to do the bulk of + the work. + </para></listitem> + <listitem><para> + If you do not provide a port number with the script, the + BitBake server starts at a randomly selected port. + </para></listitem> + <listitem><para> + The script's parameters are positionally dependent. + Consequently, you cannot run the script and provide a + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + name without also providing a port number. + In other words, the following syntax is illegal: + <literallayout class='monospaced'> + $ source oe-initbuild-env-memres <replaceable>build_dir</replaceable> + </literallayout> + <note> + The previous restriction might be resolved in the + future. + See + <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=7555'>Bug 7555</ulink> + for more information. + </note> + </para></listitem> + </itemizedlist> + </para> + + <para> + When you run this script, your Yocto Project environment is set + up, a Build Directory is created, your working directory becomes + the Build Directory, and you are presented with a list of common + BitBake targets. + Here is an example: + <literallayout class='monospaced'> + $ source oe-init-build-env-memres + No port specified, using dynamically selected port + + ### Shell environment set up for builds. ### + + You can now run 'bitbake <target>' + + Common targets are: + core-image-minimal + core-image-sato + meta-toolchain + meta-ide-support + + You can also run generated qemu images with a command like 'runqemu qemux86' + Bitbake server address: 127.0.0.1, server port: 53995 + Bitbake server started on demand as needed, use bitbake -m to shut it down + </literallayout> + The script gets its default list of common targets from the + <filename>conf-notes.txt</filename> file, which is found in the + <filename>meta-poky</filename> directory within the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + Should you have custom distributions, it is very easy to modify + this configuration file to include your targets for your + distribution. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" + section in the Yocto Project Development Manual for more + information. + </para> + + <para> + By default, running this script without a + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + argument creates a build directory named + <filename>build</filename>. + If you provide a Build Directory argument and port number when you + <filename>source</filename> the script, the Build Directory is + created using that name. + For example, the following command starts the BitBake server using + port 53995 and creates a Build Directory named + <filename>mybuilds</filename> that is outside of the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: + <literallayout class='monospaced'> + $ source oe-init-build-env-memres 53995 ~/mybuilds + </literallayout> + The <filename>oe-init-build-env-memres</filename> script starts a + memory resident BitBake server. + This BitBake instance uses the + <filename>bitbake-cookerdaemon.log</filename> file, which is + located in the Build Directory. + </para> + + <para> + The OpenEmbedded build system uses the template configuration + files, which are found by default in the + <filename>meta-poky/conf</filename> directory in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" + section in the Yocto Project Development Manual for more + information. + <note> + The OpenEmbedded build system does not support file or + directory names that contain spaces. + If you attempt to run the + <filename>oe-init-build-env-memres</filename> script + from a Source Directory that contains spaces in either the + filenames or directory names, the script returns an error + indicating no such file or directory. + Be sure to use a Source Directory free of names containing + spaces. + </note> + </para> + </section> + + <section id='structure-basic-top-level'> + <title><filename>LICENSE, README, and README.hardware</filename></title> + + <para> + These files are standard top-level files. + </para> + </section> +</section> + +<section id='structure-build'> + <title>The Build Directory - <filename>build/</filename></title> + + <para> + The OpenEmbedded build system creates the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + when you run one of the build environment setup scripts (i.e. + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). + </para> + + <para> + If you do not give the Build Directory a specific name when you run + a setup script, the name defaults to <filename>build</filename>. + </para> + + <para> + The + <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link> variable + points to the Build Directory. + </para> + + <section id='structure-build-buildhistory'> + <title><filename>build/buildhistory</filename></title> + + <para> + The OpenEmbedded build system creates this directory when you + enable the build history feature. + The directory tracks build information into image, packages, and + SDK subdirectories. + For information on the build history feature, see the + "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>" + section. + </para> + </section> + + <section id='structure-build-conf-local.conf'> + <title><filename>build/conf/local.conf</filename></title> + + <para> + This configuration file contains all the local user configurations + for your build environment. + The <filename>local.conf</filename> file contains documentation on + the various configuration options. + Any variable set here overrides any variable set elsewhere within + the environment unless that variable is hard-coded within a file + (e.g. by using '=' instead of '?='). + Some variables are hard-coded for various reasons but these + variables are relatively rare. + </para> + + <para> + Edit this file to set the + <filename><link linkend='var-MACHINE'>MACHINE</link></filename> + for which you want to build, which package types you wish to use + (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), + and the location from which you want to access downloaded files + (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>). + </para> + + <para> + If <filename>local.conf</filename> is not present when you + start the build, the OpenEmbedded build system creates it from + <filename>local.conf.sample</filename> when + you <filename>source</filename> the top-level build environment + setup script (i.e. + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). + </para> + + <para> + The source <filename>local.conf.sample</filename> file used + depends on the <filename>$TEMPLATECONF</filename> script variable, + which defaults to <filename>meta-poky/conf</filename> + when you are building from the Yocto Project development + environment and defaults to <filename>meta/conf</filename> when + you are building from the OpenEmbedded Core environment. + Because the script variable points to the source of the + <filename>local.conf.sample</filename> file, this implies that + you can configure your build environment from any layer by setting + the variable in the top-level build environment setup script as + follows: + <literallayout class='monospaced'> + TEMPLATECONF=<replaceable>your_layer</replaceable>/conf + </literallayout> + Once the build process gets the sample file, it uses + <filename>sed</filename> to substitute final + <filename>${</filename><link linkend='var-OEROOT'><filename>OEROOT</filename></link><filename>}</filename> + values for all <filename>##OEROOT##</filename> values. + <note> + You can see how the <filename>TEMPLATECONF</filename> variable + is used by looking at the + <filename>scripts/oe-setup-builddir</filename> script in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + You can find the Yocto Project version of the + <filename>local.conf.sample</filename> file in the + <filename>meta-poky/conf</filename> directory. + </note> + </para> + </section> + + <section id='structure-build-conf-bblayers.conf'> + <title><filename>build/conf/bblayers.conf</filename></title> + + <para> + This configuration file defines + <ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>layers</ulink>, + which are directory trees, traversed (or walked) by BitBake. + The <filename>bblayers.conf</filename> file uses the + <link linkend='var-BBLAYERS'><filename>BBLAYERS</filename></link> + variable to list the layers BitBake tries to find. + </para> + + <para> + If <filename>bblayers.conf</filename> is not present when you + start the build, the OpenEmbedded build system creates it from + <filename>bblayers.conf.sample</filename> when + you <filename>source</filename> the top-level build environment + setup script (i.e. + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). + </para> + + <para> + The source <filename>bblayers.conf.sample</filename> file used + depends on the <filename>$TEMPLATECONF</filename> script variable, + which defaults to <filename>meta-poky/conf</filename> + when you are building from the Yocto Project development + environment and defaults to <filename>meta/conf</filename> when + you are building from the OpenEmbedded Core environment. + Because the script variable points to the source of the + <filename>bblayers.conf.sample</filename> file, this implies that + you can base your build from any layer by setting the variable in + the top-level build environment setup script as follows: + <literallayout class='monospaced'> + TEMPLATECONF=<replaceable>your_layer</replaceable>/conf + </literallayout> + Once the build process gets the sample file, it uses + <filename>sed</filename> to substitute final + <filename>${</filename><link linkend='var-OEROOT'><filename>OEROOT</filename></link><filename>}</filename> + values for all <filename>##OEROOT##</filename> values. + <note> + You can see how the <filename>TEMPLATECONF</filename> variable + <filename>scripts/oe-setup-builddir</filename> script in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + You can find the Yocto Project version of the + <filename>bblayers.conf.sample</filename> file in the + <filename>meta-poky/conf</filename> directory. + </note> + </para> + </section> + + <section id='structure-build-conf-sanity_info'> + <title><filename>build/conf/sanity_info</filename></title> + + <para> + This file indicates the state of the sanity checks and is created + during the build. + </para> + </section> + + <section id='structure-build-downloads'> + <title><filename>build/downloads/</filename></title> + + <para> + This directory contains downloaded upstream source tarballs. + You can reuse the directory for multiple builds or move + the directory to another location. + You can control the location of this directory through the + <filename><link linkend='var-DL_DIR'>DL_DIR</link></filename> variable. + </para> + </section> + + <section id='structure-build-sstate-cache'> + <title><filename>build/sstate-cache/</filename></title> + + <para> + This directory contains the shared state cache. + You can reuse the directory for multiple builds or move + the directory to another location. + You can control the location of this directory through the + <filename><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></filename> variable. + </para> + </section> + + <section id='structure-build-tmp'> + <title><filename>build/tmp/</filename></title> + + <para> + The OpenEmbedded build system creates and uses this directory + for all the build system's output. + The + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + variable points to this directory. + </para> + + <para> + BitBake creates this directory if it does not exist. + As a last resort, to clean up a build and start it from scratch + (other than the downloads), you can remove everything in the + <filename>tmp</filename> directory or get rid of the + directory completely. + If you do, you should also completely remove the + <filename>build/sstate-cache</filename> directory. + </para> + </section> + + <section id='structure-build-tmp-buildstats'> + <title><filename>build/tmp/buildstats/</filename></title> + + <para> + This directory stores the build statistics. + </para> + </section> + + <section id='structure-build-tmp-cache'> + <title><filename>build/tmp/cache/</filename></title> + + <para> + When BitBake parses the metadata, it creates a cache file of the result that can + be used when subsequently running commands. + BitBake stores these results here on a per-machine basis. + </para> + </section> + + <section id='structure-build-tmp-deploy'> + <title><filename>build/tmp/deploy/</filename></title> + + <para> + This directory contains any "end result" output from the + OpenEmbedded build process. + The <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link> + variable points to this directory. + For more detail on the contents of the <filename>deploy</filename> + directory, see the + "<link linkend='images-dev-environment'>Images</link>" and + "<link linkend='sdk-dev-environment'>Application Development SDK</link>" + sections. + </para> + </section> + + <section id='structure-build-tmp-deploy-deb'> + <title><filename>build/tmp/deploy/deb/</filename></title> + + <para> + This directory receives any <filename>.deb</filename> packages produced by + the build process. + The packages are sorted into feeds for different architecture types. + </para> + </section> + + <section id='structure-build-tmp-deploy-rpm'> + <title><filename>build/tmp/deploy/rpm/</filename></title> + + <para> + This directory receives any <filename>.rpm</filename> packages produced by + the build process. + The packages are sorted into feeds for different architecture types. + </para> + </section> + + <section id='structure-build-tmp-deploy-ipk'> + <title><filename>build/tmp/deploy/ipk/</filename></title> + + <para> + This directory receives <filename>.ipk</filename> packages produced by + the build process. + </para> + </section> + + <section id='structure-build-tmp-deploy-licenses'> + <title><filename>build/tmp/deploy/licenses/</filename></title> + + <para> + This directory receives package licensing information. + For example, the directory contains sub-directories for <filename>bash</filename>, + <filename>busybox</filename>, and <filename>glibc</filename> (among others) that in turn + contain appropriate <filename>COPYING</filename> license files with other licensing information. + For information on licensing, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" + section. + </para> + </section> + + <section id='structure-build-tmp-deploy-images'> + <title><filename>build/tmp/deploy/images/</filename></title> + + <para> + This directory receives complete filesystem images. + If you want to flash the resulting image from a build onto a device, look here for the image. + </para> + + <para> + Be careful when deleting files in this directory. + You can safely delete old images from this directory (e.g. + <filename>core-image-*</filename>). + However, the kernel (<filename>*zImage*</filename>, <filename>*uImage*</filename>, etc.), + bootloader and other supplementary files might be deployed here prior to building an + image. + Because these files are not directly produced from the image, if you + delete them they will not be automatically re-created when you build the image again. + </para> + + <para> + If you do accidentally delete files here, you will need to force them to be + re-created. + In order to do that, you will need to know the target that produced them. + For example, these commands rebuild and re-create the kernel files: + <literallayout class='monospaced'> + $ bitbake -c clean virtual/kernel + $ bitbake virtual/kernel + </literallayout> + </para> + </section> + + <section id='structure-build-tmp-deploy-sdk'> + <title><filename>build/tmp/deploy/sdk/</filename></title> + + <para> + The OpenEmbedded build system creates this directory to hold + toolchain installer scripts, which when executed, install the + sysroot that matches your target hardware. + You can find out more about these installers in the + "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" + section in the Yocto Project Software Development Kit (SDK) Developer's Guide. + </para> + </section> + + <section id='structure-build-tmp-sstate-control'> + <title><filename>build/tmp/sstate-control/</filename></title> + + <para> + The OpenEmbedded build system uses this directory for the + shared state manifest files. + The shared state code uses these files to record the files + installed by each sstate task so that the files can be removed + when cleaning the recipe or when a newer version is about to + be installed. + The build system also uses the manifests to detect and produce + a warning when files from one task are overwriting those from + another. + </para> + </section> + + <section id='structure-build-tmp-sysroots'> + <title><filename>build/tmp/sysroots/</filename></title> + + <para> + This directory contains shared header files and libraries as well as other shared + data. + Packages that need to share output with other packages do so within this directory. + The directory is subdivided by architecture so multiple builds can run within + the one Build Directory. + </para> + </section> + + <section id='structure-build-tmp-stamps'> + <title><filename>build/tmp/stamps/</filename></title> + + <para> + This directory holds information that BitBake uses for accounting purposes + to track what tasks have run and when they have run. + The directory is sub-divided by architecture, package name, and + version. + Following is an example: + <literallayout class='monospaced'> + stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do + </literallayout> + Although the files in the directory are empty of data, + BitBake uses the filenames and timestamps for tracking purposes. + </para> + </section> + + <section id='structure-build-tmp-log'> + <title><filename>build/tmp/log/</filename></title> + + <para> + This directory contains general logs that are not otherwise placed using the + package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>. + Examples of logs are the output from the + <filename>do_check_pkg</filename> or + <filename>do_distro_check</filename> tasks. + Running a build does not necessarily mean this directory is created. + </para> + </section> + + <section id='structure-build-tmp-work'> + <title><filename>build/tmp/work/</filename></title> + + <para> + This directory contains architecture-specific work sub-directories + for packages built by BitBake. + All tasks execute from the appropriate work directory. + For example, the source for a particular package is unpacked, + patched, configured and compiled all within its own work directory. + Within the work directory, organization is based on the package group + and version for which the source is being compiled + as defined by the + <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. + </para> + + <para> + It is worth considering the structure of a typical work directory. + As an example, consider <filename>linux-yocto-kernel-3.0</filename> + on the machine <filename>qemux86</filename> + built within the Yocto Project. + For this package, a work directory of + <filename>tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....></filename>, + referred to as the + <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>, is created. + Within this directory, the source is unpacked to + <filename>linux-qemux86-standard-build</filename> and then patched by Quilt. + (See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Using Quilt in Your Workflow</ulink>" + section in the Yocto Project Development Manual for more information.) + Within the <filename>linux-qemux86-standard-build</filename> directory, + standard Quilt directories <filename>linux-3.0/patches</filename> + and <filename>linux-3.0/.pc</filename> are created, + and standard Quilt commands can be used. + </para> + + <para> + There are other directories generated within <filename>WORKDIR</filename>. + The most important directory is <filename>WORKDIR/temp/</filename>, + which has log files for each task (<filename>log.do_*.pid</filename>) + and contains the scripts BitBake runs for each task + (<filename>run.do_*.pid</filename>). + The <filename>WORKDIR/image/</filename> directory is where "make + install" places its output that is then split into sub-packages + within <filename>WORKDIR/packages-split/</filename>. + </para> + </section> + + <section id='structure-build-work-shared'> + <title><filename>build/tmp/work-shared/</filename></title> + + <para> + For efficiency, the OpenEmbedded build system creates and uses + this directory to hold recipes that share a work directory with + other recipes. + In practice, this is only used for <filename>gcc</filename> + and its variants (e.g. <filename>gcc-cross</filename>, + <filename>libgcc</filename>, <filename>gcc-runtime</filename>, + and so forth). + </para> + </section> +</section> + +<section id='structure-meta'> + <title>The Metadata - <filename>meta/</filename></title> + + <para> + As mentioned previously, + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> is the core + of the Yocto Project. + Metadata has several important subdivisions: + </para> + + <section id='structure-meta-classes'> + <title><filename>meta/classes/</filename></title> + + <para> + This directory contains the <filename>*.bbclass</filename> files. + Class files are used to abstract common code so it can be reused by multiple + packages. + Every package inherits the <filename>base.bbclass</filename> file. + Examples of other important classes are <filename>autotools.bbclass</filename>, which + in theory allows any Autotool-enabled package to work with the Yocto Project with minimal effort. + Another example is <filename>kernel.bbclass</filename> that contains common code and functions + for working with the Linux kernel. + Functions like image generation or packaging also have their specific class files + such as <filename>image.bbclass</filename>, <filename>rootfs_*.bbclass</filename> and + <filename>package*.bbclass</filename>. + </para> + + <para> + For reference information on classes, see the + "<link linkend='ref-classes'>Classes</link>" chapter. + </para> + </section> + + <section id='structure-meta-conf'> + <title><filename>meta/conf/</filename></title> + + <para> + This directory contains the core set of configuration files that start from + <filename>bitbake.conf</filename> and from which all other configuration + files are included. + See the include statements at the end of the + <filename>bitbake.conf</filename> file and you will note that even + <filename>local.conf</filename> is loaded from there. + While <filename>bitbake.conf</filename> sets up the defaults, you can often override + these by using the (<filename>local.conf</filename>) file, machine file or + the distribution configuration file. + </para> + </section> + + <section id='structure-meta-conf-machine'> + <title><filename>meta/conf/machine/</filename></title> + + <para> + This directory contains all the machine configuration files. + If you set <filename>MACHINE = "qemux86"</filename>, + the OpenEmbedded build system looks for a <filename>qemux86.conf</filename> file in this + directory. + The <filename>include</filename> directory contains various data common to multiple machines. + If you want to add support for a new machine to the Yocto Project, look in this directory. + </para> + </section> + + <section id='structure-meta-conf-distro'> + <title><filename>meta/conf/distro/</filename></title> + + <para> + The contents of this directory controls any distribution-specific + configurations. + For the Yocto Project, the <filename>defaultsetup.conf</filename> is the main file here. + This directory includes the versions and the + <filename>SRCDATE</filename> definitions for applications that are configured here. + An example of an alternative configuration might be <filename>poky-bleeding.conf</filename>. + Although this file mainly inherits its configuration from Poky. + </para> + </section> + + <section id='structure-meta-conf-machine-sdk'> + <title><filename>meta/conf/machine-sdk/</filename></title> + + <para> + The OpenEmbedded build system searches this directory for + configuration files that correspond to the value of + <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>. + By default, 32-bit and 64-bit x86 files ship with the Yocto + Project that support some SDK hosts. + However, it is possible to extend that support to other SDK hosts + by adding additional configuration files in this subdirectory + within another layer. + </para> + </section> + + <section id='structure-meta-files'> + <title><filename>meta/files/</filename></title> + + <para> + This directory contains common license files and several text files + used by the build system. + The text files contain minimal device information and + lists of files and directories with known permissions. + </para> + </section> + + <section id='structure-meta-lib'> + <title><filename>meta/lib/</filename></title> + + <para> + This directory contains OpenEmbedded Python library code + used during the build process. + </para> + </section> + + <section id='structure-meta-recipes-bsp'> + <title><filename>meta/recipes-bsp/</filename></title> + + <para> + This directory contains anything linking to specific hardware or hardware + configuration information such as "u-boot" and "grub". + </para> + </section> + + <section id='structure-meta-recipes-connectivity'> + <title><filename>meta/recipes-connectivity/</filename></title> + + <para> + This directory contains libraries and applications related to communication with other devices. + </para> + </section> + + <section id='structure-meta-recipes-core'> + <title><filename>meta/recipes-core/</filename></title> + + <para> + This directory contains what is needed to build a basic working Linux image + including commonly used dependencies. + </para> + </section> + + <section id='structure-meta-recipes-devtools'> + <title><filename>meta/recipes-devtools/</filename></title> + + <para> + This directory contains tools that are primarily used by the build system. + The tools, however, can also be used on targets. + </para> + </section> + + <section id='structure-meta-recipes-extended'> + <title><filename>meta/recipes-extended/</filename></title> + + <para> + This directory contains non-essential applications that add features compared to the + alternatives in core. + You might need this directory for full tool functionality or for Linux Standard Base (LSB) + compliance. + </para> + </section> + + <section id='structure-meta-recipes-gnome'> + <title><filename>meta/recipes-gnome/</filename></title> + + <para> + This directory contains all things related to the GTK+ application framework. + </para> + </section> + + <section id='structure-meta-recipes-graphics'> + <title><filename>meta/recipes-graphics/</filename></title> + + <para> + This directory contains X and other graphically related system libraries + </para> + </section> + + <section id='structure-meta-recipes-kernel'> + <title><filename>meta/recipes-kernel/</filename></title> + + <para> + This directory contains the kernel and generic applications and libraries that + have strong kernel dependencies. + </para> + </section> + + <section id='structure-meta-recipes-lsb4'> + <title><filename>meta/recipes-lsb4/</filename></title> + + <para> + This directory contains recipes specifically added to support + the Linux Standard Base (LSB) version 4.x. + </para> + </section> + + <section id='structure-meta-recipes-multimedia'> + <title><filename>meta/recipes-multimedia/</filename></title> + + <para> + This directory contains codecs and support utilities for audio, images and video. + </para> + </section> + + <section id='structure-meta-recipes-rt'> + <title><filename>meta/recipes-rt/</filename></title> + + <para> + This directory contains package and image recipes for using and testing + the <filename>PREEMPT_RT</filename> kernel. + </para> + </section> + + <section id='structure-meta-recipes-sato'> + <title><filename>meta/recipes-sato/</filename></title> + + <para> + This directory contains the Sato demo/reference UI/UX and its associated applications + and configuration data. + </para> + </section> + + <section id='structure-meta-recipes-support'> + <title><filename>meta/recipes-support/</filename></title> + + <para> + This directory contains recipes used by other recipes, but that are + not directly included in images (i.e. dependencies of other + recipes). + </para> + </section> + + <section id='structure-meta-site'> + <title><filename>meta/site/</filename></title> + + <para> + This directory contains a list of cached results for various architectures. + Because certain "autoconf" test results cannot be determined when cross-compiling due to + the tests not able to run on a live system, the information in this directory is + passed to "autoconf" for the various architectures. + </para> + </section> + + <section id='structure-meta-recipes-txt'> + <title><filename>meta/recipes.txt</filename></title> + + <para> + This file is a description of the contents of <filename>recipes-*</filename>. + </para> + </section> +</section> + +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-style.css b/import-layers/yocto-poky/documentation/ref-manual/ref-style.css new file mode 100644 index 000000000..8ea8dac73 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-style.css @@ -0,0 +1,1028 @@ +/* + Generic XHTML / DocBook XHTML CSS Stylesheet. + + Browser wrangling and typographic design by + Oyvind Kolas / pippin@gimp.org + + Customised for Poky by + Matthew Allum / mallum@o-hand.com + + Thanks to: + Liam R. E. Quin + William Skaggs + Jakub Steiner + + Structure + --------- + + The stylesheet is divided into the following sections: + + Positioning + Margins, paddings, width, font-size, clearing. + Decorations + Borders, style + Colors + Colors + Graphics + Graphical backgrounds + Nasty IE tweaks + Workarounds needed to make it work in internet explorer, + currently makes the stylesheet non validating, but up until + this point it is validating. + Mozilla extensions + Transparency for footer + Rounded corners on boxes + +*/ + + + /*************** / + / Positioning / +/ ***************/ + +body { + font-family: Verdana, Sans, sans-serif; + + min-width: 640px; + width: 80%; + margin: 0em auto; + padding: 2em 5em 5em 5em; + color: #333; +} + +h1,h2,h3,h4,h5,h6,h7 { + font-family: Arial, Sans; + color: #00557D; + clear: both; +} + +h1 { + font-size: 2em; + text-align: left; + padding: 0em 0em 0em 0em; + margin: 2em 0em 0em 0em; +} + +h2.subtitle { + margin: 0.10em 0em 3.0em 0em; + padding: 0em 0em 0em 0em; + font-size: 1.8em; + padding-left: 20%; + font-weight: normal; + font-style: italic; +} + +h2 { + margin: 2em 0em 0.66em 0em; + padding: 0.5em 0em 0em 0em; + font-size: 1.5em; + font-weight: bold; +} + +h3.subtitle { + margin: 0em 0em 1em 0em; + padding: 0em 0em 0em 0em; + font-size: 142.14%; + text-align: right; +} + +h3 { + margin: 1em 0em 0.5em 0em; + padding: 1em 0em 0em 0em; + font-size: 140%; + font-weight: bold; +} + +h4 { + margin: 1em 0em 0.5em 0em; + padding: 1em 0em 0em 0em; + font-size: 120%; + font-weight: bold; +} + +h5 { + margin: 1em 0em 0.5em 0em; + padding: 1em 0em 0em 0em; + font-size: 110%; + font-weight: bold; +} + +h6 { + margin: 1em 0em 0em 0em; + padding: 1em 0em 0em 0em; + font-size: 110%; + font-weight: bold; +} + +.authorgroup { + background-color: transparent; + background-repeat: no-repeat; + padding-top: 256px; + background-image: url("figures/poky-title.png"); + background-position: left top; + margin-top: -256px; + padding-right: 50px; + margin-left: 0px; + text-align: right; + width: 740px; +} + +h3.author { + margin: 0em 0me 0em 0em; + padding: 0em 0em 0em 0em; + font-weight: normal; + font-size: 100%; + color: #333; + clear: both; +} + +.author tt.email { + font-size: 66%; +} + +.titlepage hr { + width: 0em; + clear: both; +} + +.revhistory { + padding-top: 2em; + clear: both; +} + +.toc, +.list-of-tables, +.list-of-examples, +.list-of-figures { + padding: 1.33em 0em 2.5em 0em; + color: #00557D; +} + +.toc p, +.list-of-tables p, +.list-of-figures p, +.list-of-examples p { + padding: 0em 0em 0em 0em; + padding: 0em 0em 0.3em; + margin: 1.5em 0em 0em 0em; +} + +.toc p b, +.list-of-tables p b, +.list-of-figures p b, +.list-of-examples p b{ + font-size: 100.0%; + font-weight: bold; +} + +.toc dl, +.list-of-tables dl, +.list-of-figures dl, +.list-of-examples dl { + margin: 0em 0em 0.5em 0em; + padding: 0em 0em 0em 0em; +} + +.toc dt { + margin: 0em 0em 0em 0em; + padding: 0em 0em 0em 0em; +} + +.toc dd { + margin: 0em 0em 0em 2.6em; + padding: 0em 0em 0em 0em; +} + +/* Use this set when you decide to get the images in for variables. + +div.glossary dl, +div.variablelist dl { +} + +.glossary dl dt, +.variablelist dl dt, +.variablelist dl dt span.term { + font-weight: normal; + width: 0em; + text-align: right; +} + +.variablelist dl dt { + margin-top: 0.5em; +} + +.glossary dl dd, +.variablelist dl dd { + margin-top: 0em; + margin-left: 15.5em; + margin-bottom: 2em; +} + +.glossary dd p, +.variablelist dd p { + margin-top: 0em; + margin-bottom: 1em; +} + +.glossdeffirst { + text-indent: -70px; +} +*/ + +/* Start of non-image set */ + +div.glossary dl, +div.variablelist dl { +} + +.glossary dl dt, +.variablelist dl dt, +.variablelist dl dt span.term { + font-weight: normal; + width: 20em; + text-align: right; +} + +.variablelist dl dt { + margin-top: 0.5em; +} + +.glossary dl dd, +.variablelist dl dd { + margin-top: 0em; + margin-left: 25.5em; +} + +.glossary dd p, +.variablelist dd p { + margin-top: 0em; + margin-bottom: 1em; +} + +.glossdeffirst { + text-indent: 0px; +} + +/* End of non-image set */ + +div.calloutlist table td { + padding: 0em 0em 0em 0em; + margin: 0em 0em 0em 0em; +} + +div.calloutlist table td p { + margin-top: 0em; + margin-bottom: 1em; +} + +div p.copyright { + text-align: left; +} + +div.legalnotice p.legalnotice-title { + margin-bottom: 0em; +} + +p { + line-height: 1.5em; + margin-top: 0em; + +} + +dl { + padding-top: 0em; +} + +hr { + border: solid 1px; +} + + +.mediaobject, +.mediaobjectco { + text-align: center; +} + +img { + border: none; +} + +ul { + padding: 0em 0em 0em 1.5em; +} + +ul li { + padding: 0em 0em 0em 0em; +} + +ul li p { + text-align: left; +} + +table { + width :100%; +} + +th { + padding: 0.25em; + text-align: left; + font-weight: normal; + vertical-align: top; +} + +td { + padding: 0.25em; + vertical-align: top; +} + +p a[id] { + margin: 0px; + padding: 0px; + display: inline; + background-image: none; +} + +a { + text-decoration: underline; + color: #444; +} + +pre { + overflow: auto; +} + +a:hover { + text-decoration: underline; + /*font-weight: bold;*/ +} + +/* This style defines how the permalink character + appears by itself and when hovered over with + the mouse. */ + +[alt='Permalink'] { color: #eee; } +[alt='Permalink']:hover { color: black; } + + +div.informalfigure, +div.informalexample, +div.informaltable, +div.figure, +div.table, +div.example { + margin: 1em 0em; + padding: 1em; + page-break-inside: avoid; +} + + +div.informalfigure p.title b, +div.informalexample p.title b, +div.informaltable p.title b, +div.figure p.title b, +div.example p.title b, +div.table p.title b{ + padding-top: 0em; + margin-top: 0em; + font-size: 100%; + font-weight: normal; +} + +.mediaobject .caption, +.mediaobject .caption p { + text-align: center; + font-size: 80%; + padding-top: 0.5em; + padding-bottom: 0.5em; +} + +.epigraph { + padding-left: 55%; + margin-bottom: 1em; +} + +.epigraph p { + text-align: left; +} + +.epigraph .quote { + font-style: italic; +} +.epigraph .attribution { + font-style: normal; + text-align: right; +} + +span.application { + font-style: italic; +} + +.programlisting { + font-family: monospace; + font-size: 80%; + white-space: pre; + margin: 1.33em 0em; + padding: 1.33em; +} + +.tip, +.warning, +.caution, +.note { + margin-top: 1em; + margin-bottom: 1em; + +} + +/* force full width of table within div */ +.tip table, +.warning table, +.caution table, +.note table { + border: none; + width: 100%; +} + + +.tip table th, +.warning table th, +.caution table th, +.note table th { + padding: 0.8em 0.0em 0.0em 0.0em; + margin : 0em 0em 0em 0em; +} + +.tip p, +.warning p, +.caution p, +.note p { + margin-top: 0.5em; + margin-bottom: 0.5em; + padding-right: 1em; + text-align: left; +} + +.acronym { + text-transform: uppercase; +} + +b.keycap, +.keycap { + padding: 0.09em 0.3em; + margin: 0em; +} + +.itemizedlist li { + clear: none; +} + +.filename { + font-size: medium; + font-family: Courier, monospace; +} + + +div.navheader, div.heading{ + position: absolute; + left: 0em; + top: 0em; + width: 100%; + background-color: #cdf; + width: 100%; +} + +div.navfooter, div.footing{ + position: fixed; + left: 0em; + bottom: 0em; + background-color: #eee; + width: 100%; +} + + +div.navheader td, +div.navfooter td { + font-size: 66%; +} + +div.navheader table th { + /*font-family: Georgia, Times, serif;*/ + /*font-size: x-large;*/ + font-size: 80%; +} + +div.navheader table { + border-left: 0em; + border-right: 0em; + border-top: 0em; + width: 100%; +} + +div.navfooter table { + border-left: 0em; + border-right: 0em; + border-bottom: 0em; + width: 100%; +} + +div.navheader table td a, +div.navfooter table td a { + color: #777; + text-decoration: none; +} + +/* normal text in the footer */ +div.navfooter table td { + color: black; +} + +div.navheader table td a:visited, +div.navfooter table td a:visited { + color: #444; +} + + +/* links in header and footer */ +div.navheader table td a:hover, +div.navfooter table td a:hover { + text-decoration: underline; + background-color: transparent; + color: #33a; +} + +div.navheader hr, +div.navfooter hr { + display: none; +} + + +.qandaset tr.question td p { + margin: 0em 0em 1em 0em; + padding: 0em 0em 0em 0em; +} + +.qandaset tr.answer td p { + margin: 0em 0em 1em 0em; + padding: 0em 0em 0em 0em; +} +.answer td { + padding-bottom: 1.5em; +} + +.emphasis { + font-weight: bold; +} + + + /************* / + / decorations / +/ *************/ + +.titlepage { +} + +.part .title { +} + +.subtitle { + border: none; +} + +/* +h1 { + border: none; +} + +h2 { + border-top: solid 0.2em; + border-bottom: solid 0.06em; +} + +h3 { + border-top: 0em; + border-bottom: solid 0.06em; +} + +h4 { + border: 0em; + border-bottom: solid 0.06em; +} + +h5 { + border: 0em; +} +*/ + +.programlisting { + border: solid 1px; +} + +div.figure, +div.table, +div.informalfigure, +div.informaltable, +div.informalexample, +div.example { + border: 1px solid; +} + + + +.tip, +.warning, +.caution, +.note { + border: 1px solid; +} + +.tip table th, +.warning table th, +.caution table th, +.note table th { + border-bottom: 1px solid; +} + +.question td { + border-top: 1px solid black; +} + +.answer { +} + + +b.keycap, +.keycap { + border: 1px solid; +} + + +div.navheader, div.heading{ + border-bottom: 1px solid; +} + + +div.navfooter, div.footing{ + border-top: 1px solid; +} + + /********* / + / colors / +/ *********/ + +body { + color: #333; + background: white; +} + +a { + background: transparent; +} + +a:hover { + background-color: #dedede; +} + + +h1, +h2, +h3, +h4, +h5, +h6, +h7, +h8 { + background-color: transparent; +} + +hr { + border-color: #aaa; +} + + +.tip, .warning, .caution, .note { + border-color: #fff; +} + + +.tip table th, +.warning table th, +.caution table th, +.note table th { + border-bottom-color: #fff; +} + + +.warning { + background-color: #f0f0f2; +} + +.caution { + background-color: #f0f0f2; +} + +.tip { + background-color: #f0f0f2; +} + +.note { + background-color: #f0f0f2; +} + +.glossary dl dt, +.variablelist dl dt, +.variablelist dl dt span.term { + color: #044; +} + +div.figure, +div.table, +div.example, +div.informalfigure, +div.informaltable, +div.informalexample { + border-color: #aaa; +} + +pre.programlisting { + color: black; + background-color: #fff; + border-color: #aaa; + border-width: 2px; +} + +.guimenu, +.guilabel, +.guimenuitem { + background-color: #eee; +} + + +b.keycap, +.keycap { + background-color: #eee; + border-color: #999; +} + + +div.navheader { + border-color: black; +} + + +div.navfooter { + border-color: black; +} + + + /*********** / + / graphics / +/ ***********/ + +/* +body { + background-image: url("images/body_bg.jpg"); + background-attachment: fixed; +} + +.navheader, +.note, +.tip { + background-image: url("images/note_bg.jpg"); + background-attachment: fixed; +} + +.warning, +.caution { + background-image: url("images/warning_bg.jpg"); + background-attachment: fixed; +} + +.figure, +.informalfigure, +.example, +.informalexample, +.table, +.informaltable { + background-image: url("images/figure_bg.jpg"); + background-attachment: fixed; +} + +*/ +h1, +h2, +h3, +h4, +h5, +h6, +h7{ +} + +/* +Example of how to stick an image as part of the title. + +div.article .titlepage .title +{ + background-image: url("figures/white-on-black.png"); + background-position: center; + background-repeat: repeat-x; +} +*/ + +div.preface .titlepage .title, +div.colophon .title, +div.chapter .titlepage .title, +div.article .titlepage .title +{ +} + +div.section div.section .titlepage .title, +div.sect2 .titlepage .title { + background: none; +} + + +h1.title { + background-color: transparent; + background-image: url("figures/poky-title.png"); + background-repeat: no-repeat; + height: 256px; + text-indent: -9000px; + overflow:hidden; +} + +h2.subtitle { + background-color: transparent; + text-indent: -9000px; + overflow:hidden; + width: 0px; + display: none; +} + + /*************************************** / + / pippin.gimp.org specific alterations / +/ ***************************************/ + +/* +div.heading, div.navheader { + color: #777; + font-size: 80%; + padding: 0; + margin: 0; + text-align: left; + position: absolute; + top: 0px; + left: 0px; + width: 100%; + height: 50px; + background: url('/gfx/heading_bg.png') transparent; + background-repeat: repeat-x; + background-attachment: fixed; + border: none; +} + +div.heading a { + color: #444; +} + +div.footing, div.navfooter { + border: none; + color: #ddd; + font-size: 80%; + text-align:right; + + width: 100%; + padding-top: 10px; + position: absolute; + bottom: 0px; + left: 0px; + + background: url('/gfx/footing_bg.png') transparent; +} +*/ + + + + /****************** / + / nasty ie tweaks / +/ ******************/ + +/* +div.heading, div.navheader { + width:expression(document.body.clientWidth + "px"); +} + +div.footing, div.navfooter { + width:expression(document.body.clientWidth + "px"); + margin-left:expression("-5em"); +} +body { + padding:expression("4em 5em 0em 5em"); +} +*/ + + /**************************************** / + / mozilla vendor specific css extensions / +/ ****************************************/ +/* +div.navfooter, div.footing{ + -moz-opacity: 0.8em; +} + +div.figure, +div.table, +div.informalfigure, +div.informaltable, +div.informalexample, +div.example, +.tip, +.warning, +.caution, +.note { + -moz-border-radius: 0.5em; +} + +b.keycap, +.keycap { + -moz-border-radius: 0.3em; +} +*/ + +table tr td table tr td { + display: none; +} + + +hr { + display: none; +} + +table { + border: 0em; +} + + .photo { + float: right; + margin-left: 1.5em; + margin-bottom: 1.5em; + margin-top: 0em; + max-width: 17em; + border: 1px solid gray; + padding: 3px; + background: white; +} + .seperator { + padding-top: 2em; + clear: both; + } + + #validators { + margin-top: 5em; + text-align: right; + color: #777; + } + @media print { + body { + font-size: 8pt; + } + .noprint { + display: none; + } + } + + +.tip, +.note { + background: #f0f0f2; + color: #333; + padding: 20px; + margin: 20px; +} + +.tip h3, +.note h3 { + padding: 0em; + margin: 0em; + font-size: 2em; + font-weight: bold; + color: #333; +} + +.tip a, +.note a { + color: #333; + text-decoration: underline; +} + +.footnote { + font-size: small; + color: #333; +} + +/* Changes the announcement text */ +.tip h3, +.warning h3, +.caution h3, +.note h3 { + font-size:large; + color: #00557D; +} diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-tasks.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-tasks.xml new file mode 100644 index 000000000..c46debb55 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-tasks.xml @@ -0,0 +1,835 @@ +<!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='ref-tasks'> +<title>Tasks</title> + +<para> + Tasks are units of execution for BitBake. + Recipes (<filename>.bb</filename> files) use tasks to complete + configuring, compiling, and packaging software. + This chapter provides a reference of the tasks defined in the + OpenEmbedded build system. +</para> + +<section id='normal-recipe-build-tasks'> + <title>Normal Recipe Build Tasks</title> + + <para> + The following sections describe normal tasks associated with building + a recipe. + </para> + + <section id='ref-tasks-build'> + <title><filename>do_build</filename></title> + + <para> + The default task for all recipes. + This task depends on all other normal tasks + required to build a recipe. + </para> + </section> + + <section id='ref-tasks-checkpkg'> + <title><filename>do_checkpkg</filename></title> + + <para> + Provides information about the recipe including its upstream + version and status. + The upstream version and status reveals whether or not a version + of the recipe exists upstream and a status of not updated, updated, + or unknown. + </para> + + <para> + The <filename>checkpkg</filename> task is included as part of the + <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> + class. + </para> + + <para> + To build the <filename>checkpkg</filename> task, use the + <filename>bitbake</filename> command with the "-c" option and + task name: + <literallayout class='monospaced'> + $ bitbake core-image-minimal -c checkpkg + </literallayout> + By default, the results are stored in + <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link> + (e.g. <filename>$BUILD_DIR/tmp/log</filename>). + </para> + </section> + + <section id='ref-tasks-compile'> + <title><filename>do_compile</filename></title> + + <para> + Compiles the source in the compilation directory, which is pointed + to by the + <link linkend='var-B'><filename>B</filename></link> variable. + </para> + </section> + + <section id='ref-tasks-compile_ptest_base'> + <title><filename>do_compile_ptest_base</filename></title> + + <para> + Compiles the runtime test suite included in the software being + built. + </para> + </section> + + <section id='ref-tasks-configure'> + <title><filename>do_configure</filename></title> + + <para> + Configures the source by enabling and disabling any build-time and + configuration options for the software being built. + </para> + </section> + + <section id='ref-tasks-configure_ptest_base'> + <title><filename>do_configure_ptest_base</filename></title> + + <para> + Configures the runtime test suite included in the software being + built. + </para> + </section> + + <section id='ref-tasks-deploy'> + <title><filename>do_deploy</filename></title> + + <para> + Writes output files that are to be deployed to the deploy + directory, which is defined by the + <link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link> + variable. + </para> + + <para> + The <filename>do_deploy</filename> task is a + shared state (sstate) task, which means that the task can + be accelerated through sstate use. + Realize also that if the task is re-executed, any previous output + is removed (i.e. "cleaned"). + </para> + </section> + + <section id='ref-tasks-distrodata'> + <title><filename>do_distrodata</filename></title> + + <para> + Provides information about the recipe. + </para> + + <para> + The <filename>distrodata</filename> task is included as part of the + <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> + class. + </para> + + <para> + To build the <filename>distrodata</filename> task, use the + <filename>bitbake</filename> command with the "-c" option and + task name: + <literallayout class='monospaced'> + $ bitbake core-image-minimal -c distrodata + </literallayout> + By default, the results are stored in + <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link> + (e.g. <filename>$BUILD_DIR/tmp/log</filename>). + </para> + </section> + + <section id='ref-tasks-fetch'> + <title><filename>do_fetch</filename></title> + + <para> + Fetches the source code. + This task uses the + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + variable and the argument's prefix to determine the correct + fetcher module. + </para> + </section> + + <section id='ref-tasks-image'> + <title><filename>do_image</filename></title> + + <para> + Starts the image generation process. + The <filename>do_image</filename> task runs after the + OpenEmbedded build system has run the + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + task during which packages are identified for installation into + the image and the root filesystem is created, complete with + post-processing. + </para> + + <para> + The <filename>do_image</filename> task performs pre-processing + on the image through the + <link linkend='var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></link> + and dynamically generates supporting + <filename>do_image_*</filename> tasks as needed. + </para> + + <para> + For more information on image creation, see the + "<link linkend='image-generation-dev-environment'>Image Generation</link>" + section. + </para> + </section> + + <section id='ref-tasks-image-complete'> + <title><filename>do_image_complete</filename></title> + + <para> + Completes the image generation process. + The <filename>do_image_complete</filename> task runs after the + OpenEmbedded build system has run the + <link linkend='ref-tasks-rootfs'><filename>do_image</filename></link> + task during which image pre-processing occurs and through + dynamically generated <filename>do_image_*</filename> tasks the + image is constructed. + </para> + + <para> + The <filename>do_image_complete</filename> task performs + post-processing on the image through the + <link linkend='var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></link>. + </para> + + <para> + For more information on image creation, see the + "<link linkend='image-generation-dev-environment'>Image Generation</link>" + section. + </para> + </section> + + <section id='ref-tasks-install'> + <title><filename>do_install</filename></title> + + <para> + Copies files from the compilation directory, which is defined by + the + <link linkend='var-B'><filename>B</filename></link> variable, + to a holding area defined by the + <link linkend='var-D'><filename>D</filename></link> variable. + </para> + </section> + + <section id='ref-tasks-install_ptest_base'> + <title><filename>do_install_ptest_base</filename></title> + + <para> + Copies the runtime test suite files from the compilation directory + to a holding area. + </para> + </section> + + <section id='ref-tasks-package'> + <title><filename>do_package</filename></title> + + <para> + Analyzes the content of the holding area and splits it into subsets + based on available packages and files. + </para> + </section> + + <section id='ref-tasks-package_qa'> + <title><filename>do_package_qa</filename></title> + + <para> + Runs QA checks on packaged files. + For more information on these checks, see the + <link linkend='ref-classes-insane'><filename>insane</filename></link> + class. + </para> + </section> + + <section id='ref-tasks-package_write_deb'> + <title><filename>do_package_write_deb</filename></title> + + <para> + Creates Debian packages (i.e. <filename>*.deb</filename> files) and + places them in the + <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename> + directory in the package feeds area. + For more information, see the + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + section. + </para> + </section> + + <section id='ref-tasks-package_write_ipk'> + <title><filename>do_package_write_ipk</filename></title> + + <para> + Creates IPK packages (i.e. <filename>*.ipk</filename> files) and + places them in the + <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename> + directory in the package feeds area. + For more information, see the + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + section. + </para> + </section> + + <section id='ref-tasks-package_write_rpm'> + <title><filename>do_package_write_rpm</filename></title> + + <para> + Creates RPM packages (i.e. <filename>*.rpm</filename> files) and + places them in the + <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename> + directory in the package feeds area. + For more information, see the + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + section. + </para> + </section> + + <section id='ref-tasks-package_write_tar'> + <title><filename>do_package_write_tar</filename></title> + + <para> + Creates tarballs and places them in the + <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename> + directory in the package feeds area. + For more information, see the + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + section. + </para> + </section> + + <section id='ref-tasks-packagedata'> + <title><filename>do_packagedata</filename></title> + + <para> + Creates package metadata used by the build system to generate the + final packages. + </para> + </section> + + <section id='ref-tasks-patch'> + <title><filename>do_patch</filename></title> + + <para> + Locates patch files and applies them to the source code. + See the + "<link linkend='patching-dev-environment'>Patching</link>" + section for more information. + </para> + </section> + + <section id='ref-tasks-populate_lic'> + <title><filename>do_populate_lic</filename></title> + + <para> + Writes license information for the recipe that is collected later + when the image is constructed. + </para> + </section> + + <section id='ref-tasks-populate_sdk'> + <title><filename>do_populate_sdk</filename></title> + + <para> + Creates the file and directory structure for an installable SDK. + See the + "<link linkend='sdk-generation-dev-environment'>SDK Generation</link>" + section for more information. + </para> + </section> + + <section id='ref-tasks-populate_sysroot'> + <title><filename>do_populate_sysroot</filename></title> + + <para> + Copies a subset of the files installed by the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task into the sysroot to make them available to other recipes. + Files that would typically not be needed by other recipes at build + time are skipped. + Skipped files include files installed into + <filename>/etc.</filename> + For information on what files are copied, see the + <link linkend='ref-classes-staging'><filename>staging</filename></link> + class. + </para> + + <para> + The <filename>do_populate_sysroot</filename> task is a + shared state (sstate) task, which means that the task can + be accelerated through sstate use. + Realize also that if the task is re-executed, any previous output + is removed (i.e. "cleaned"). + </para> + </section> + + <section id='ref-tasks-rm_work'> + <title><filename>do_rm_work</filename></title> + + <para> + Removes work files after the OpenEmbedded build system has + finished with them. + You can learn more by looking at the + "<link linkend='ref-classes-rm-work'><filename>rm_work.bbclass</filename></link>" + section. + </para> + </section> + + <section id='ref-tasks-rm_work_all'> + <title><filename>do_rm_work_all</filename></title> + + <para> + Top-level task for removing work files after the build system has + finished with them. + </para> + </section> + + <section id='ref-tasks-unpack'> + <title><filename>do_unpack</filename></title> + + <para> + Unpacks the source code into a working directory pointed to + by + <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}</filename>. + The + <link linkend='var-S'><filename>S</filename></link> variable also + plays a role in where unpacked source files ultimately reside. + For more information on how source files are unpacked, see the + "<link linkend='source-fetching-dev-environment'>Source Fetching</link>" + section and the <filename>WORKDIR</filename> and + <filename>S</filename> variable descriptions. + </para> + </section> +</section> + +<section id='manually-called-tasks'> + <title>Manually Called Tasks</title> + + <para> + These tasks are typically manually triggered (e.g. by using the + <filename>bitbake -c</filename> command-line option): + </para> + + <section id='ref-tasks-checkuri'> + <title><filename>do_checkuri</filename></title> + + <para> + Validates the + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + value. + </para> + </section> + + <section id='ref-tasks-checkuriall'> + <title><filename>do_checkuriall</filename></title> + + <para> + Validates the + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + value for all recipes required to build a target. + </para> + </section> + + <section id='ref-tasks-clean'> + <title><filename>do_clean</filename></title> + + <para> + Removes all output files for a target from the + <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> + task forward (i.e. + <link linkend='ref-tasks-patch'><filename>do_unpack</filename></link>, + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>, + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>, + <link linkend='ref-tasks-install'><filename>do_install</filename></link>, + and + <link linkend='ref-tasks-package'><filename>do_package</filename></link>). + </para> + + <para> + You can run this task using BitBake as follows: + <literallayout class='monospaced'> + $ bitbake -c clean <replaceable>recipe</replaceable> + </literallayout> + </para> + + <para> + Running this task does not remove the + <link linkend='shared-state-cache'>sstate</link>) cache + files. + Consequently, if no changes have been made and the recipe is + rebuilt after cleaning, output files are simply restored from the + sstate cache. + If you want to remove the sstate cache files for the recipe, + you need to use the + <link linkend='ref-tasks-cleansstate'><filename>do_cleansstate</filename></link> + task instead (i.e. <filename>bitbake -c cleansstate</filename> <replaceable>recipe</replaceable>). + </para> + </section> + + <section id='ref-tasks-cleanall'> + <title><filename>do_cleanall</filename></title> + + <para> + Removes all output files, shared state + (<link linkend='shared-state-cache'>sstate</link>) cache, and + downloaded source files for a target (i.e. the contents of + <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>). + Essentially, the <filename>do_cleanall</filename> task is + identical to the + <link linkend='ref-tasks-cleansstate'><filename>do_cleansstate</filename></link> + task with the added removal of downloaded source files. + </para> + + <para> + You can run this task using BitBake as follows: + <literallayout class='monospaced'> + $ bitbake -c cleanall <replaceable>recipe</replaceable> + </literallayout> + </para> + + <para> + Typically, you would not normally use the + <filename>cleanall</filename> task. + Do so only if you want to start fresh with the + <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> + task. + </para> + </section> + + <section id='ref-tasks-cleansstate'> + <title><filename>do_cleansstate</filename></title> + + <para> + Removes all output files and shared state + (<link linkend='shared-state-cache'>sstate</link>) + cache for a target. + Essentially, the <filename>do_cleansstate</filename> task is + identical to the + <link linkend='ref-tasks-clean'><filename>do_clean</filename></link> + task with the added removal of shared state + (<link linkend='shared-state-cache'>sstate</link>) cache. + </para> + + <para> + You can run this task using BitBake as follows: + <literallayout class='monospaced'> + $ bitbake -c cleansstate <replaceable>recipe</replaceable> + </literallayout> + </para> + + <para> + When you run the <filename>do_cleansstate</filename> task, + the OpenEmbedded build system no longer uses any + sstate. + Consequently, building the recipe from scratch is guaranteed. + <note> + The <filename>do_cleansstate</filename> task cannot remove + sstate from a remote sstate mirror. + If you need to build a target from scratch using remote + mirrors, use the "-f" option as follows: + <literallayout class='monospaced'> + $ bitbake -f -c do_cleansstate <replaceable>target</replaceable> + </literallayout> + </note> + </para> + </section> + + <section id='ref-tasks-devshell'> + <title><filename>do_devshell</filename></title> + + <para> + Starts a shell whose environment is set up for + development, debugging, or both. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" + section in the Yocto Project Development Manual for more + information about using <filename>devshell</filename>. + </para> + </section> + + <section id='ref-tasks-fetchall'> + <title><filename>do_fetchall</filename></title> + + <para> + Fetches all remote sources required to build a target. + </para> + </section> + + <section id='ref-tasks-listtasks'> + <title><filename>do_listtasks</filename></title> + + <para> + Lists all defined tasks for a target. + </para> + </section> + + <section id='ref-tasks-package_index'> + <title><filename>do_package_index</filename></title> + + <para> + Creates or updates the index in the + <link linkend='package-feeds-dev-environment'>Package Feeds</link> + area. + <note> + This task is not triggered with the + <filename>bitbake -c</filename> command-line option as + are the other tasks in this section. + Because this task is specifically for the + <filename>package-index</filename> recipe, + you run it using + <filename>bitbake package-index</filename>. + </note> + </para> + </section> +</section> + +<section id='image-related-tasks'> + <title>Image-Related Tasks</title> + + <para> + The following tasks are applicable to image recipes. + </para> + + <section id='ref-tasks-bootimg'> + <title><filename>do_bootimg</filename></title> + + <para> + Creates a bootable live image. + See the + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + variable for additional information on live image types. + </para> + </section> + + <section id='ref-tasks-bundle_initramfs'> + <title><filename>do_bundle_initramfs</filename></title> + + <para> + Combines an initial RAM disk (initramfs) image and kernel + together to form a single image. + The + <link linkend='var-CONFIG_INITRAMFS_SOURCE'><filename>CONFIG_INITRAMFS_SOURCE</filename></link> + variable has some more information about these types of images. + </para> + </section> + + <section id='ref-tasks-rootfs'> + <title><filename>do_rootfs</filename></title> + + <para> + Creates the root filesystem (file and directory structure) for an + image. + See the + "<link linkend='image-generation-dev-environment'>Image Generation</link>" + section for more information on how the root filesystem is created. + </para> + </section> + + <section id='ref-tasks-testimage'> + <title><filename>do_testimage</filename></title> + + <para> + Boots an image and performs runtime tests within the image. + For information on automatically testing images, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" + section in the Yocto Project Development Manual. + </para> + </section> + + <section id='ref-tasks-testimage_auto'> + <title><filename>do_testimage_auto</filename></title> + + <para> + Boots an image and performs runtime tests within the image + immediately after it has been built. + This task is enabled when you set + <link linkend='var-TEST_IMAGE'><filename>TEST_IMAGE</filename></link> + equal to "1". + </para> + + <para> + For information on automatically testing images, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" + section in the Yocto Project Development Manual. + </para> + </section> + + <section id='ref-tasks-vmdkimg'> + <title><filename>do_vmdkimg</filename></title> + + <para> + Creates a <filename>.vmdk</filename> image for use with + <ulink url='http://www.vmware.com/'>VMware</ulink> + and compatible virtual machine hosts. + </para> + </section> +</section> + +<section id='kernel-related-tasks'> + <title>Kernel-Related Tasks</title> + + <para> + The following tasks are applicable to kernel recipes. + Some of these tasks (e.g. the + <link linkend='ref-tasks-menuconfig'><filename>do_menuconfig</filename></link> + task) are also applicable to recipes that use + Linux kernel style configuration such as the BusyBox recipe. + </para> + + <section id='ref-tasks-compile_kernelmodules'> + <title><filename>do_compile_kernelmodules</filename></title> + + <para> + Compiles loadable modules for the Linux kernel. + </para> + </section> + + <section id='ref-tasks-diffconfig'> + <title><filename>do_diffconfig</filename></title> + + <para> + Compares the old and new config files after running the + <link linkend='ref-tasks-menuconfig'><filename>do_menuconfig</filename></link> + task for the kernel. + </para> + </section> + + <section id='ref-tasks-kernel_checkout'> + <title><filename>do_kernel_checkout</filename></title> + + <para> + Checks out source/meta branches for a linux-yocto style kernel. + </para> + </section> + + <section id='ref-tasks-kernel_configcheck'> + <title><filename>do_kernel_configcheck</filename></title> + + <para> + Validates the kernel configuration for a linux-yocto style kernel. + </para> + </section> + + <section id='ref-tasks-kernel_configme'> + <title><filename>do_kernel_configme</filename></title> + + <para> + Assembles the kernel configuration for a linux-yocto style kernel. + </para> + </section> + + <section id='ref-tasks-kernel_link_vmlinux'> + <title><filename>do_kernel_link_vmlinux</filename></title> + + <para> + Creates a symbolic link in + <filename>arch/$arch/boot</filename> for vmlinux kernel + images. + </para> + </section> + + <section id='ref-tasks-kernel_metadata'> + <title><filename>do_kernel_metadata</filename></title> + + <para> + Collects kernel metadata for a + <filename>linux-yocto</filename> style kernel. + </para> + </section> + + <section id='ref-tasks-menuconfig'> + <title><filename>do_menuconfig</filename></title> + + <para> + Runs <filename>make menuconfig</filename> for the kernel. + For information on <filename>menuconfig</filename>, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#using-menuconfig'>Using <filename>menuconfig</filename></ulink>" + section in the Yocto Project Development Manual. + </para> + </section> + + <section id='ref-tasks-savedefconfig'> + <title><filename>do_savedefconfig</filename></title> + + <para> + Creates a minimal Linux kernel configuration file. + </para> + </section> + + <section id='ref-tasks-shared_workdir'> + <title><filename>do_shared_workdir</filename></title> + + <para> + Creates the shared working directory for the kernel. + </para> + </section> + + <section id='ref-tasks-sizecheck'> + <title><filename>do_sizecheck</filename></title> + + <para> + Checks the size of the kernel image against + <link linkend='var-KERNEL_IMAGE_MAXSIZE'><filename>KERNEL_IMAGE_MAXSIZE</filename></link> + when set. + </para> + </section> + + <section id='ref-tasks-strip'> + <title><filename>do_strip</filename></title> + + <para> + Strips unneeded sections out of the Linux kernel image. + </para> + </section> + + <section id='ref-tasks-uboot_mkimage'> + <title><filename>do_uboot_mkimage</filename></title> + + <para> + Creates a uImage file from the kernel for the U-Boot bootloader. + </para> + </section> + + <section id='ref-tasks-validate_branches'> + <title><filename>do_validate_branches</filename></title> + + <para> + Ensures that the source, metadata (or both) branches are on the + locations specified by their + <link linkend='var-SRCREV'><filename>SRCREV</filename></link> + values for a linux-yocto style kernel. + </para> + </section> +</section> + +<section id='miscellaneous-tasks'> + <title>Miscellaneous Tasks</title> + + <para> + The following sections describe miscellaneous tasks. + </para> + + <section id='ref-tasks-spdx'> + <title><filename>do_spdx</filename></title> + + <para> + A build stage that takes the source code and scans it on a remote + FOSSOLOGY server in order to produce an SPDX document. + This task applies only to the + <link linkend='ref-classes-spdx'><filename>spdx</filename></link> + class. + </para> + </section> +</section> + +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-variables.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-variables.xml new file mode 100644 index 000000000..d55bccdc6 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-variables.xml @@ -0,0 +1,14736 @@ +<!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; ] > + +<!-- Dummy chapter --> +<chapter id='ref-variables-glos'> + +<title>Variables Glossary</title> + +<para> + This chapter lists common variables used in the OpenEmbedded build system and gives an overview + of their function and contents. +</para> + +<glossary id='ref-variables-glossary'> + + + <para> + <link linkend='var-ABIEXTENSION'>A</link> + <link linkend='var-B'>B</link> + <link linkend='var-CACHE'>C</link> + <link linkend='var-D'>D</link> + <link linkend='var-EFI_PROVIDER'>E</link> + <link linkend='var-FEATURE_PACKAGES'>F</link> + <link linkend='var-GDB'>G</link> + <link linkend='var-HOMEPAGE'>H</link> + <link linkend='var-ICECC_DISABLED'>I</link> +<!-- <link linkend='var-glossary-j'>J</link> --> + <link linkend='var-KARCH'>K</link> + <link linkend='var-LABELS'>L</link> + <link linkend='var-MACHINE'>M</link> +<!-- <link linkend='var-glossary-n'>N</link> --> + <link linkend='var-OBJCOPY'>O</link> + <link linkend='var-P'>P</link> +<!-- <link linkend='var-glossary-q'>Q</link> --> + <link linkend='var-RANLIB'>R</link> + <link linkend='var-S'>S</link> + <link linkend='var-T'>T</link> + <link linkend='var-UBOOT_CONFIG'>U</link> +<!-- <link linkend='var-glossary-v'>V</link> --> + <link linkend='var-WARN_QA'>W</link> + <link linkend='var-XSERVER'>X</link> +<!-- <link linkend='var-glossary-y'>Y</link> --> +<!-- <link linkend='var-glossary-z'>Z</link>--> + </para> + + <glossdiv id='var-glossary-a'><title>A</title> + + <glossentry id='var-ABIEXTENSION'><glossterm>ABIEXTENSION</glossterm> + <info> + ABIEXTENSION[doc] = "Extension to the Application Binary Interface (ABI) field of the GNU canonical architecture name (e.g. "eabi")." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Extension to the Application Binary Interface (ABI) + field of the GNU canonical architecture name + (e.g. "eabi"). + </para> + + <para> + ABI extensions are set in the machine include files. + For example, the + <filename>meta/conf/machine/include/arm/arch-arm.inc</filename> + file sets the following extension: + <literallayout class='monospaced'> + ABIEXTENSION = "eabi" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm> + <info> + ALLOW_EMPTY[doc] = "Specifies if an output package should still be produced if it is empty." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies if an output package should still be produced if it is empty. + By default, BitBake does not produce empty packages. + This default behavior can cause issues when there is an + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> or + some other hard runtime requirement on the existence of the package. + </para> + + <para> + Like all package-controlling variables, you must always use them in + conjunction with a package name override, as in: + <literallayout class='monospaced'> + ALLOW_EMPTY_${PN} = "1" + ALLOW_EMPTY_${PN}-dev = "1" + ALLOW_EMPTY_${PN}-staticdev = "1" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ALTERNATIVE'><glossterm>ALTERNATIVE</glossterm> + <info> + ALTERNATIVE[doc] = "Lists commands in a package that need an alternative binary naming scheme." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists commands in a package that need an alternative + binary naming scheme. + Sometimes the same command is provided in multiple packages. + When this occurs, the OpenEmbedded build system needs to + use the alternatives system to create a different binary + naming scheme so the commands can co-exist. + </para> + + <para> + To use the variable, list out the package's commands + that also exist as part of another package. + For example, if the <filename>busybox</filename> package + has four commands that also exist as part of another + package, you identify them as follows: + <literallayout class='monospaced'> + ALTERNATIVE_busybox = "sh sed test bracket" + </literallayout> + For more information on the alternatives system, see the + "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ALTERNATIVE_LINK_NAME'><glossterm>ALTERNATIVE_LINK_NAME</glossterm> + <info> + ALTERNATIVE_LINK_NAME[doc] = "Used by the alternatives system to map duplicated commands to actual locations." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Used by the alternatives system to map duplicated commands + to actual locations. + For example, if the <filename>bracket</filename> command + provided by the <filename>busybox</filename> package is + duplicated through another package, you must use the + <filename>ALTERNATIVE_LINK_NAME</filename> variable to + specify the actual location: + <literallayout class='monospaced'> + ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/[" + </literallayout> + </para> + + <para> + In this example, the binary for the + <filename>bracket</filename> command (i.e. + <filename>[</filename>) from the + <filename>busybox</filename> package resides in + <filename>/usr/bin/</filename>. + <note> + If <filename>ALTERNATIVE_LINK_NAME</filename> is not + defined, it defaults to + <filename>${bindir}/<replaceable>name</replaceable></filename>. + </note> + </para> + + <para> + For more information on the alternatives system, see the + "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ALTERNATIVE_PRIORITY'><glossterm>ALTERNATIVE_PRIORITY</glossterm> + <info> + ALTERNATIVE_PRIORITY[doc] = "Used by the alternatives system to create default priorities for duplicated commands." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Used by the alternatives system to create default + priorities for duplicated commands. + You can use the variable to create a single default + regardless of the command name or package, a default for + specific duplicated commands regardless of the package, or + a default for specific commands tied to particular packages. + Here are the available syntax forms: + <literallayout class='monospaced'> + ALTERNATIVE_PRIORITY = "<replaceable>priority</replaceable>" + ALTERNATIVE_PRIORITY[<replaceable>name</replaceable>] = "<replaceable>priority</replaceable>" + ALTERNATIVE_PRIORITY_<replaceable>pkg</replaceable>[<replaceable>name</replaceable>] = "<replaceable>priority</replaceable>" + </literallayout> + </para> + + <para> + For more information on the alternatives system, see the + "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ALTERNATIVE_TARGET'><glossterm>ALTERNATIVE_TARGET</glossterm> + <info> + ALTERNATIVE_TARGET[doc] = "Used by the alternatives system to create default link locations for duplicated commands." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Used by the alternatives system to create default link + locations for duplicated commands. + You can use the variable to create a single default + location for all duplicated commands regardless of the + command name or package, a default for + specific duplicated commands regardless of the package, or + a default for specific commands tied to particular packages. + Here are the available syntax forms: + <literallayout class='monospaced'> + ALTERNATIVE_TARGET = "<replaceable>target</replaceable>" + ALTERNATIVE_TARGET[<replaceable>name</replaceable>] = "<replaceable>target</replaceable>" + ALTERNATIVE_TARGET_<replaceable>pkg</replaceable>[<replaceable>name</replaceable>] = "<replaceable>target</replaceable>" + </literallayout> + <note> + <para> + If <filename>ALTERNATIVE_TARGET</filename> is not + defined, it inherits the value from the + <link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> + variable. + </para> + + <para> + If <filename>ALTERNATIVE_LINK_NAME</filename> and + <filename>ALTERNATIVE_TARGET</filename> are the + same, the target for + <filename>ALTERNATIVE_TARGET</filename> + has "<filename>.{BPN}</filename>" appended to it. + </para> + + <para> + Finally, if the file referenced has not been + renamed, the alternatives system will rename it to + avoid the need to rename alternative files in the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task while + retaining support for the command if necessary. + </para> + </note> + </para> + + <para> + For more information on the alternatives system, see the + "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-APPEND'><glossterm>APPEND</glossterm> + <info> + APPEND[doc] = "An override list of append strings for each LABEL." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + An override list of append strings for each + <link linkend='var-LABELS'><filename>LABEL</filename></link>. + </para> + + <para> + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AR'><glossterm>AR</glossterm> + <info> + AR[doc] = "Minimal command and arguments to run 'ar'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments used to run + <filename>ar</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ARCHIVER_MODE'><glossterm>ARCHIVER_MODE</glossterm> + <info> + ARCHIVER_MODE[doc] = "Controls archive creation used when releasing source files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When used with the + <link linkend='ref-classes-archiver'><filename>archiver</filename></link> + class, determines the type of information used to create + a released archive. + You can use this variable to create archives of patched + source, original source, configured source, and so forth + by employing the following variable flags (varflags): + <literallayout class='monospaced'> + ARCHIVER_MODE[src] = "original" # Uses original (unpacked) source + # files. + + ARCHIVER_MODE[src] = "patched" # Uses patched source files. This is + # the default. + + ARCHIVER_MODE[src] = "configured" # Uses configured source files. + + ARCHIVER_MODE[diff] = "1" # Uses patches between do_unpack and + # do_patch. + + ARCHIVER_MODE[diff-exclude] ?= "<replaceable>file</replaceable> <replaceable>file</replaceable> ..." # Lists files and directories to + # exclude from diff. + + ARCHIVER_MODE[dumpdata] = "1" # Uses environment data. + + ARCHIVER_MODE[recipe] = "1" # Uses recipe and include files. + + ARCHIVER_MODE[srpm] = "1" # Uses RPM package files. + </literallayout> + For information on how the variable works, see the + <filename>meta/classes/archiver.bbclass</filename> file + in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AS'><glossterm>AS</glossterm> + <info> + AS[doc] = "Minimal command and arguments to run the assembler." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments used to run the + assembler. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm> + <info> + ASSUME_PROVIDED[doc] = "Lists recipe names (PN values) BitBake does not attempt to build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists recipe names + (<link linkend='var-PN'><filename>PN</filename></link> + values) BitBake does not attempt to build. + Instead, BitBake assumes these recipes have already been + built. + </para> + + <para> + In OpenEmbedded Core, <filename>ASSUME_PROVIDED</filename> + mostly specifies native tools that should not be built. + An example is <filename>git-native</filename>, which when + specified, allows for the Git binary from the host to be + used rather than building <filename>git-native</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ASSUME_SHLIBS'><glossterm>ASSUME_SHLIBS</glossterm> + <info> + ASSUME_SHLIBS[doc] = Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Provides additional <filename>shlibs</filename> provider + mapping information, which adds to or overwrites the + information provided automatically by the system. + Separate multiple entries using spaces. + </para> + + <para> + As an example, use the following form to add an + <filename>shlib</filename> provider of + <replaceable>shlibname</replaceable> in + <replaceable>packagename</replaceable> with the optional + <replaceable>version</replaceable>: + <literallayout class='monospaced'> + <replaceable>shlibname:packagename</replaceable>[_<replaceable>version</replaceable>] + </literallayout> + </para> + + <para> + Here is an example that adds a shared library named + <filename>libEGL.so.1</filename> as being provided by + the <filename>libegl-implementation</filename> package: + <literallayout class='monospaced'> + ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> + <info> + AUTHOR[doc] = "Email address used to contact the original author or authors in order to send patches and forward bugs." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The email address used to contact the original author + or authors in order to send patches and forward bugs. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AUTO_LIBNAME_PKGS'><glossterm>AUTO_LIBNAME_PKGS</glossterm> + <info> + AUTO_LIBNAME_PKGS[doc] = "Specifies which packages should be checked for libraries and renamed according to Debian library package naming." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When the + <link linkend='ref-classes-debian'><filename>debian</filename></link> + class is inherited, which is the default behavior, + <filename>AUTO_LIBNAME_PKGS</filename> specifies which + packages should be checked for libraries and renamed + according to Debian library package naming. + </para> + + <para> + The default value is "${PACKAGES}", which causes the + debian class to act on all packages that are + explicitly generated by the recipe. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AUTO_SYSLINUXMENU'><glossterm>AUTO_SYSLINUXMENU</glossterm> + <info> + AUTO_SYSLINUXMENU[doc] = "Enables creating an automatic menu for the syslinux bootloader." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Enables creating an automatic menu for the syslinux + bootloader. + You must set this variable in your recipe. + The + <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> + class checks this variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm> + <info> + AUTOREV[doc] = "When SRCREV is set to the value of this variable, it specifies to use the latest source revision in the repository." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When + <filename><link linkend='var-SRCREV'>SRCREV</link></filename> + is set to the value of this variable, it specifies to use + the latest source revision in the repository. + Here is an example: + <literallayout class='monospaced'> + SRCREV = "${AUTOREV}" + </literallayout> + </para> + + <para> + If you use the previous statement to retrieve the latest + version of software, you need to be sure + <link linkend='var-PV'><filename>PV</filename></link> + contains + <filename>${</filename><link linkend='var-SRCPV'><filename>SRCPV</filename></link><filename>}</filename>. + For example, suppose you have a kernel recipe that + inherits the + <link linkend='ref-classes-kernel'>kernel</link> class + and you use the previous statement. + In this example, <filename>${SRCPV}</filename> does not + automatically get into <filename>PV</filename>. + Consequently, you need to change <filename>PV</filename> + in your recipe so that it does contain + <filename>${SRCPV}</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-AVAILTUNES'><glossterm>AVAILTUNES</glossterm> + <info> + AVAILTUNES[doc] = "The list of defined CPU and Application Binary Interface (ABI) tunings (i.e. "tunes") available for use by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The list of defined CPU and Application Binary Interface + (ABI) tunings (i.e. "tunes") available for use by the + OpenEmbedded build system. + </para> + + <para> + The list simply presents the tunes that are available. + Not all tunes may be compatible with a particular + machine configuration, or with each other in a + <ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Multilib</ulink> + configuration. + </para> + + <para> + To add a tune to the list, be sure to append it with + spaces using the "+=" BitBake operator. + Do not simply replace the list by using the "=" operator. + See the + "<ulink url='&YOCTO_DOCS_BB_URL;#basic-syntax'>Basic Syntax</ulink>" + section in the BitBake User Manual for more information. + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-b'><title>B</title> + + <glossentry id='var-B'><glossterm>B</glossterm> + <info> + B[doc] = "The Build Directory. The OpenEmbedded build system places generated objects into the Build Directory during a recipe's build process." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The directory within the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + in which the OpenEmbedded build system places generated + objects during a recipe's build process. + By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> + directory, which is defined as: + <literallayout class='monospaced'> + S = "${WORKDIR}/${BP}/" + </literallayout> + </para> + + <para> + You can separate the (<filename>S</filename>) directory + and the directory pointed to by the <filename>B</filename> + variable. + Most Autotools-based recipes support separating these + directories. + The build system defaults to using separate directories for + <filename>gcc</filename> and some kernel recipes. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BAD_RECOMMENDATIONS'><glossterm>BAD_RECOMMENDATIONS</glossterm> + <info> + BAD_RECOMMENDATIONS[doc] = "A list of packages not to install despite being recommended by a recipe. Support for this variable exists only when using the IPK packaging backend." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists "recommended-only" packages to not install. + Recommended-only packages are packages installed only + through the + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> + variable. + You can prevent any of these "recommended" packages from + being installed by listing them with the + <filename>BAD_RECOMMENDATIONS</filename> variable: + <literallayout class='monospaced'> + BAD_RECOMMENDATIONS = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..." + </literallayout> + </para> + + <para> + You can set this variable globally in your + <filename>local.conf</filename> file or you can attach it to + a specific image recipe by using the recipe name override: + <literallayout class='monospaced'> + BAD_RECOMMENDATIONS_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>" + </literallayout> + </para> + + <para> + It is important to realize that if you choose to not install + packages using this variable and some other packages are + dependent on them (i.e. listed in a recipe's + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + variable), the OpenEmbedded build system ignores your + request and will install the packages to avoid dependency + errors. + </para> + + <para> + Support for this variable exists only when using the + IPK and RPM packaging backend. + Support does not exist for DEB. + </para> + + <para> + See the + <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link> + and the + <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link> + variables for related information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BASE_LIB'><glossterm>BASE_LIB</glossterm> + <info> + BASE_LIB[doc] = "The library directory name for the CPU or Application Binary Interface (ABI) tune." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The library directory name for the CPU or Application + Binary Interface (ABI) tune. + The <filename>BASE_LIB</filename> applies only in the + Multilib context. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Combining Multiple Versions of Library Files into One Image</ulink>" + section in the Yocto Project Development Manual for + information on Multilib. + </para> + + <para> + The <filename>BASE_LIB</filename> variable is defined in + the machine include files in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + If Multilib is not being used, the value defaults to "lib". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BASE_WORKDIR'><glossterm>BASE_WORKDIR</glossterm> + <info> + BASE_WORKDIR[doc] = "Points to the base of the work directory for all recipes." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the base of the work directory for all recipes. + The default value is "${TMPDIR}/work". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_ALLOWED_NETWORKS'><glossterm>BB_ALLOWED_NETWORKS</glossterm> + <info> + BB_ALLOWED_NETWORKS[doc] = "A list of hosts that the fetcher is allowed to use to obtain the required source code." + </info> + <glossdef> + <para> + Specifies a space-delimited list of hosts that the fetcher + is allowed to use to obtain the required source code. + Following are considerations surrounding this variable: + <itemizedlist> + <listitem><para> + This host list is only used if + <filename>BB_NO_NETWORK</filename> is either not + set or set to "0". + </para></listitem> + <listitem><para> + Limited support for wildcard matching against the + beginning of host names exists. + For example, the following setting matches + <filename>git.gnu.org</filename>, + <filename>ftp.gnu.org</filename>, and + <filename>foo.git.gnu.org</filename>. + <literallayout class='monospaced'> + BB_ALLOWED_NETWORKS = "*.gnu.org" + </literallayout> + </para></listitem> + <listitem><para> + Mirrors not in the host list are skipped and + logged in debug. + </para></listitem> + <listitem><para> + Attempts to access networks not in the host list + cause a failure. + </para></listitem> + </itemizedlist> + Using <filename>BB_ALLOWED_NETWORKS</filename> in + conjunction with + <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> + is very useful. + Adding the host you want to use to + <filename>PREMIRRORS</filename> results in the source code + being fetched from an allowed location and avoids raising + an error when a host that is not allowed is in a + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> + statement. + This is because the fetcher does not attempt to use the + host listed in <filename>SRC_URI</filename> after a + successful fetch from the + <filename>PREMIRRORS</filename> occurs. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_DANGLINGAPPENDS_WARNONLY'><glossterm>BB_DANGLINGAPPENDS_WARNONLY</glossterm> + <info> + BB_DANGLINGAPPENDS_WARNONLY[doc] = "Defines how BitBake handles situations where an append file (.bbappend) has no corresponding recipe file (.bb)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines how BitBake handles situations where an append + file (<filename>.bbappend</filename>) has no + corresponding recipe file (<filename>.bb</filename>). + This condition often occurs when layers get out of sync + (e.g. <filename>oe-core</filename> bumps a + recipe version and the old recipe no longer exists and the + other layer has not been updated to the new version + of the recipe yet). + </para> + + <para> + The default fatal behavior is safest because it is + the sane reaction given something is out of sync. + It is important to realize when your changes are no longer + being applied. + </para> + + <para> + You can change the default behavior by setting this + variable to "1", "yes", or "true" + in your <filename>local.conf</filename> file, which is + located in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + Here is an example: + <literallayout class='monospaced'> + BB_DANGLINGAPPENDS_WARNONLY = "1" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_DISKMON_DIRS'><glossterm>BB_DISKMON_DIRS</glossterm> + <info> + BB_DISKMON_DIRS[doc] = "Monitors disk space and available inodes during the build and allows you to control the build based on these parameters." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Monitors disk space and available inodes during the build + and allows you to control the build based on these + parameters. + </para> + + <para> + Disk space monitoring is disabled by default. + To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename> + variable to your <filename>conf/local.conf</filename> file found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + Use the following form: + <literallayout class='monospaced'> + BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]" + + where: + + <replaceable>action</replaceable> is: + ABORT: Immediately abort the build when + a threshold is broken. + STOPTASKS: Stop the build after the currently + executing tasks have finished when + a threshold is broken. + WARN: Issue a warning but continue the + build when a threshold is broken. + Subsequent warnings are issued as + defined by the + <link linkend='var-BB_DISKMON_WARNINTERVAL'>BB_DISKMON_WARNINTERVAL</link> variable, + which must be defined in the + conf/local.conf file. + + <replaceable>dir</replaceable> is: + Any directory you choose. You can specify one or + more directories to monitor by separating the + groupings with a space. If two directories are + on the same device, only the first directory + is monitored. + + <replaceable>threshold</replaceable> is: + Either the minimum available disk space, + the minimum number of free inodes, or + both. You must specify at least one. To + omit one or the other, simply omit the value. + Specify the threshold using G, M, K for Gbytes, + Mbytes, and Kbytes, respectively. If you do + not specify G, M, or K, Kbytes is assumed by + default. Do not use GB, MB, or KB. + </literallayout> + </para> + + <para> + Here are some examples: + <literallayout class='monospaced'> + BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" + BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" + BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" + </literallayout> + The first example works only if you also provide + the <link linkend='var-BB_DISKMON_WARNINTERVAL'><filename>BB_DISKMON_WARNINTERVAL</filename></link> variable + in the <filename>conf/local.conf</filename>. + This example causes the build system to immediately + abort when either the disk space in <filename>${TMPDIR}</filename> drops + below 1 Gbyte or the available free inodes drops below + 100 Kbytes. + Because two directories are provided with the variable, the + build system also issue a + warning when the disk space in the + <filename>${SSTATE_DIR}</filename> directory drops + below 1 Gbyte or the number of free inodes drops + below 100 Kbytes. + Subsequent warnings are issued during intervals as + defined by the <filename>BB_DISKMON_WARNINTERVAL</filename> + variable. + </para> + + <para> + The second example stops the build after all currently + executing tasks complete when the minimum disk space + in the <filename>${<link linkend='var-TMPDIR'>TMPDIR</link>}</filename> + directory drops below 1 Gbyte. + No disk monitoring occurs for the free inodes in this case. + </para> + + <para> + The final example immediately aborts the build when the + number of free inodes in the <filename>${TMPDIR}</filename> directory + drops below 100 Kbytes. + No disk space monitoring for the directory itself occurs + in this case. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_DISKMON_WARNINTERVAL'><glossterm>BB_DISKMON_WARNINTERVAL</glossterm> + <info> + BB_DISKMON_WARNINTERVAL[doc] = "Defines the disk space and free inode warning intervals. To set these intervals, define the variable in the conf/local.conf file in the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the disk space and free inode warning intervals. + To set these intervals, define the variable in your + <filename>conf/local.conf</filename> file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + </para> + + <para> + If you are going to use the + <filename>BB_DISKMON_WARNINTERVAL</filename> variable, you must + also use the + <link linkend='var-BB_DISKMON_DIRS'><filename>BB_DISKMON_DIRS</filename></link> variable + and define its action as "WARN". + During the build, subsequent warnings are issued each time + disk space or number of free inodes further reduces by + the respective interval. + </para> + + <para> + If you do not provide a <filename>BB_DISKMON_WARNINTERVAL</filename> + variable and you do use <filename>BB_DISKMON_DIRS</filename> with + the "WARN" action, the disk monitoring interval defaults to + the following: + <literallayout class='monospaced'> + BB_DISKMON_WARNINTERVAL = "50M,5K" + </literallayout> + </para> + + <para> + When specifying the variable in your configuration file, + use the following form: + <literallayout class='monospaced'> + BB_DISKMON_WARNINTERVAL = "<replaceable>disk_space_interval</replaceable>,<replaceable>disk_inode_interval</replaceable>" + + where: + + <replaceable>disk_space_interval</replaceable> is: + An interval of memory expressed in either + G, M, or K for Gbytes, Mbytes, or Kbytes, + respectively. You cannot use GB, MB, or KB. + + <replaceable>disk_inode_interval</replaceable> is: + An interval of free inodes expressed in either + G, M, or K for Gbytes, Mbytes, or Kbytes, + respectively. You cannot use GB, MB, or KB. + </literallayout> + </para> + + <para> + Here is an example: + <literallayout class='monospaced'> + BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K" + BB_DISKMON_WARNINTERVAL = "50M,5K" + </literallayout> + These variables cause the OpenEmbedded build system to + issue subsequent warnings each time the available + disk space further reduces by 50 Mbytes or the number + of free inodes further reduces by 5 Kbytes in the + <filename>${SSTATE_DIR}</filename> directory. + Subsequent warnings based on the interval occur each time + a respective interval is reached beyond the initial warning + (i.e. 1 Gbytes and 100 Kbytes). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_GENERATE_MIRROR_TARBALLS'><glossterm>BB_GENERATE_MIRROR_TARBALLS</glossterm> + <info> + BB_GENERATE_MIRROR_TARBALLS[doc] = "Causes tarballs of the Git repositories to be placed in the DL_DIR directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Causes tarballs of the Git repositories, including the + Git metadata, to be placed in the + <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> + directory. + </para> + + <para> + For performance reasons, creating and placing tarballs of + the Git repositories is not the default action by the + OpenEmbedded build system. + <literallayout class='monospaced'> + BB_GENERATE_MIRROR_TARBALLS = "1" + </literallayout> + Set this variable in your <filename>local.conf</filename> + file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> + <info> + BB_NUMBER_THREADS[doc] = "The maximum number of tasks BitBake should run in parallel at any one time. This variable is automatically configured to be equal to the number of build system cores." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The maximum number of tasks BitBake should run in parallel + at any one time. + The OpenEmbedded build system automatically configures + this variable to be equal to the number of cores on the + build system. + For example, a system with a dual core processor that + also uses hyper-threading causes the + <filename>BB_NUMBER_THREADS</filename> variable to default + to "4". + </para> + + <para> + For single socket systems (i.e. one CPU), you should not + have to override this variable to gain optimal parallelism + during builds. + However, if you have very large systems that employ + multiple physical CPUs, you might want to make sure the + <filename>BB_NUMBER_THREADS</filename> variable is not + set higher than "20". + </para> + + <para> + For more information on speeding up builds, see the + "<link linkend='speeding-up-the-build'>Speeding Up the Build</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> + <info> + BBCLASSEXTEND[doc] = "Allows you to extend a recipe so that it builds variants of the software. Common variants for recipes are 'native', 'cross', 'nativesdk' and multilibs." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Allows you to extend a recipe so that it builds variants of the software. + Common variants for recipes exist such as "natives" like <filename>quilt-native</filename>, + which is a copy of Quilt built to run on the build system; + "crosses" such as <filename>gcc-cross</filename>, + which is a compiler built to run on the build machine but produces binaries + that run on the target <link linkend='var-MACHINE'><filename>MACHINE</filename></link>; + "nativesdk", which targets the SDK machine instead of <filename>MACHINE</filename>; + and "mulitlibs" in the form "<filename>multilib:</filename><replaceable>multilib_name</replaceable>". + </para> + + <para> + To build a different variant of the recipe with a minimal amount of code, it usually + is as simple as adding the following to your recipe: + <literallayout class='monospaced'> + BBCLASSEXTEND =+ "native nativesdk" + BBCLASSEXTEND =+ "multilib:<replaceable>multilib_name</replaceable>" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> + <info> + BBFILE_COLLECTIONS[doc] = "Lists the names of configured layers. These names are used to find the other BBFILE_* variables." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists the names of configured layers. + These names are used to find the other <filename>BBFILE_*</filename> + variables. + Typically, each layer will append its name to this variable in its + <filename>conf/layer.conf</filename> file. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm> + <info> + BBFILE_PATTERN[doc] = "Variable that expands to match files from BBFILES in a particular layer. This variable is used in the layer.conf file and must be suffixed with the name of a layer." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Variable that expands to match files from + <link linkend='var-BBFILES'><filename>BBFILES</filename></link> + in a particular layer. + This variable is used in the <filename>conf/layer.conf</filename> file and must + be suffixed with the name of the specific layer (e.g. + <filename>BBFILE_PATTERN_emenlow</filename>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm> + <info> + BBFILE_PRIORITY[doc] = "Assigns the priority for recipe files in each layer. Setting this variable allows you to prioritize a layer against other layers that contain the same recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Assigns the priority for recipe files in each layer. + </para> + + <para> + This variable is useful in situations where the same recipe appears in + more than one layer. + Setting this variable allows you to prioritize a + layer against other layers that contain the same recipe - effectively + letting you control the precedence for the multiple layers. + The precedence established through this variable stands regardless of a + recipe's version + (<link linkend='var-PV'><filename>PV</filename></link> variable). + For example, a layer that has a recipe with a higher <filename>PV</filename> value but for + which the <filename>BBFILE_PRIORITY</filename> is set to have a lower precedence still has a + lower precedence. + </para> + + <para> + A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher + precedence. + For example, the value 6 has a higher precedence than the value 5. + If not specified, the <filename>BBFILE_PRIORITY</filename> variable is set based on layer + dependencies (see the + <filename><link linkend='var-LAYERDEPENDS'>LAYERDEPENDS</link></filename> variable for + more information. + The default priority, if unspecified + for a layer with no dependencies, is the lowest defined priority + 1 + (or 1 if no priorities are defined). + </para> + <tip> + You can use the command <filename>bitbake-layers show-layers</filename> to list + all configured layers along with their priorities. + </tip> + </glossdef> + </glossentry> + + <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm> + <info> + BBFILES[doc] = "List of recipe files used by BitBake to build software." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + List of recipe files used by BitBake to build software. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm> + <info> + BBINCLUDELOGS[doc] = "Variable that controls how BitBake displays logs on build failure." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Variable that controls how BitBake displays logs on build failure. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBINCLUDELOGS_LINES'><glossterm>BBINCLUDELOGS_LINES</glossterm> + <info> + BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + If + <link linkend='var-BBINCLUDELOGS'><filename>BBINCLUDELOGS</filename></link> + is set, specifies the maximum number of lines from the + task log file to print when reporting a failed task. + If you do not set <filename>BBINCLUDELOGS_LINES</filename>, + the entire log is printed. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm> + <info> + BBLAYERS[doc] = "Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists the layers to enable during the build. + This variable is defined in the <filename>bblayers.conf</filename> configuration + file in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + Here is an example: + <literallayout class='monospaced'> + BBLAYERS = " \ + /home/scottrif/poky/meta \ + /home/scottrif/poky/meta-poky \ + /home/scottrif/poky/meta-yocto-bsp \ + /home/scottrif/poky/meta-mykernel \ + " + </literallayout> + </para> + + <para> + This example enables four layers, one of which is a custom, user-defined layer + named <filename>meta-mykernel</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm> + <info> + BBMASK[doc] = "Prevents BitBake from processing specific recipes or recipe append files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Prevents BitBake from processing recipes and recipe + append files. + </para> + + <para> + You can use the <filename>BBMASK</filename> variable + to "hide" these <filename>.bb</filename> and + <filename>.bbappend</filename> files. + BitBake ignores any recipe or recipe append files that + match any of the expressions. + It is as if BitBake does not see them at all. + Consequently, matching files are not parsed or otherwise + used by BitBake.</para> + <para> + The values you provide are passed to Python's regular + expression compiler. + The expressions are compared against the full paths to + the files. + For complete syntax information, see Python's + documentation at + <ulink url='http://docs.python.org/release/2.3/lib/re-syntax.html'></ulink>. + </para> + + <para> + The following example uses a complete regular expression + to tell BitBake to ignore all recipe and recipe append + files in the <filename>meta-ti/recipes-misc/</filename> + directory: + <literallayout class='monospaced'> + BBMASK = "meta-ti/recipes-misc/" + </literallayout> + If you want to mask out multiple directories or recipes, + you can specify multiple regular expression fragments. + This next example masks out multiple directories and + individual recipes: + <literallayout class='monospaced'> + BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/" + BBMASK += "/meta-oe/recipes-support/" + BBMASK += "/meta-foo/.*/openldap" + BBMASK += "opencv.*\.bbappend" + BBMASK += "lzma" + </literallayout> + <note> + When specifying a directory name, use the trailing + slash character to ensure you match just that directory + name. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> + <info> + BBPATH[doc] = "Used by BitBake to locate .bbclass and configuration files. This variable is analogous to the PATH variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Used by BitBake to locate + <filename>.bbclass</filename> and configuration files. + This variable is analogous to the + <filename>PATH</filename> variable. + <note> + If you run BitBake from a directory outside of the + <ulink url='&YOCTO_DOCS_DEV_URL;build-directory'>Build Directory</ulink>, + you must be sure to set + <filename>BBPATH</filename> to point to the + Build Directory. + Set the variable as you would any environment variable + and then run BitBake: + <literallayout class='monospaced'> + $ BBPATH = "<replaceable>build_directory</replaceable>" + $ export BBPATH + $ bitbake <replaceable>target</replaceable> + </literallayout> + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BBSERVER'><glossterm>BBSERVER</glossterm> + <info> + BBSERVER[doc] = "Points to the server that runs memory-resident BitBake." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the server that runs memory-resident BitBake. + This variable is set by the + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> + setup script and should not be hand-edited. + The variable is only used when you employ memory-resident + BitBake. + The setup script exports the value as follows: + <literallayout class='monospaced'> + export BBSERVER=localhost:$port + </literallayout> + </para> + + <para> + For more information on how the + <filename>BBSERVER</filename> is used, see the + <filename>oe-init-build-env-memres</filename> script, which + is located in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BINCONFIG'><glossterm>BINCONFIG</glossterm> + <info> + BINCONFIG[doc] = "When inheriting the binconfig-disabled class, this variable specifies binary configuration scripts to disable in favor of using pkg-config to query the information." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-binconfig-disabled'><filename>binconfig-disabled</filename></link> + class, this variable specifies binary configuration + scripts to disable in favor of using + <filename>pkg-config</filename> to query the information. + The <filename>binconfig-disabled</filename> class will + modify the specified scripts to return an error so that + calls to them can be easily found and replaced. + </para> + + <para> + To add multiple scripts, separate them by spaces. + Here is an example from the <filename>libpng</filename> + recipe: + <literallayout class='monospaced'> + BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm> + <info> + BINCONFIG_GLOB[doc] = "When inheriting binconfig.bbclass from a recipe, this variable specifies a wildcard for configuration scripts that need editing." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> + class, this variable specifies a wildcard for + configuration scripts that need editing. + The scripts are edited to correct any paths that have been + set up during compilation so that they are correct for + use when installed into the sysroot and called by the + build processes of other recipes. + </para> + + <para> + For more information on how this variable works, see + <filename>meta/classes/binconfig.bbclass</filename> in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + You can also find general information on the class in the + "<link linkend='ref-classes-binconfig'><filename>binconfig.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BP'><glossterm>BP</glossterm> + <info> + BP[doc] = "The base recipe name and version but without any special recipe name suffix (i.e. -native, lib64-, and so forth). BP is comprised of ${BPN}-${PV}" + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The base recipe name and version but without any special + recipe name suffix (i.e. <filename>-native</filename>, <filename>lib64-</filename>, + and so forth). + <filename>BP</filename> is comprised of the following: + <literallayout class="monospaced"> + ${BPN}-${PV} + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BPN'><glossterm>BPN</glossterm> + <info> + BPN[doc] = "The bare name of the recipe. This variable is a version of the PN variable but removes common suffixes and prefixes." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The bare name of the recipe. + This variable is a version of the + <link linkend='var-PN'><filename>PN</filename></link> + variable but removes common suffixes such as + <filename>-native</filename> and + <filename>-cross</filename> as well + as removes common prefixes such as multilib's + <filename>lib64-</filename> and + <filename>lib32-</filename>. + The exact list of suffixes removed is specified by the + <link linkend='var-SPECIAL_PKGSUFFIX'><filename>SPECIAL_PKGSUFFIX</filename></link> + variable. + The exact list of prefixes removed is specified by the + <link linkend='var-MLPREFIX'><filename>MLPREFIX</filename></link> + variable. + Prefixes are removed for <filename>multilib</filename> + and <filename>nativesdk-</filename> cases. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUGTRACKER'><glossterm>BUGTRACKER</glossterm> + <info> + BUGTRACKER[doc] = "Specifies a URL for an upstream bug tracking website for a recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a URL for an upstream bug tracking website for + a recipe. + The OpenEmbedded build system does not use this variable. + Rather, the variable is a useful pointer in case a bug + in the software being built needs to be manually reported. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_ARCH'><glossterm>BUILD_ARCH</glossterm> + <info> + BUILD_ARCH[doc] = "The name of the building architecture (e.g. i686)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the architecture of the build host + (e.g. <filename>i686</filename>). + The OpenEmbedded build system sets the value of + <filename>BUILD_ARCH</filename> from the machine name + reported by the <filename>uname</filename> command. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_CFLAGS'><glossterm>BUILD_CFLAGS</glossterm> + <info> + BUILD_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C compiler when building + for the build host. + When building in the <filename>-native</filename> context, + <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> + is set to the value of this variable by default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_CPPFLAGS'><glossterm>BUILD_CPPFLAGS</glossterm> + <info> + BUILD_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C pre-processor + (i.e. to both the C and the C++ compilers) when building + for the build host. + When building in the <filename>-native</filename> context, + <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link> + is set to the value of this variable by default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_CXXFLAGS'><glossterm>BUILD_CXXFLAGS</glossterm> + <info> + BUILD_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C++ compiler when + building for the build host. + When building in the <filename>-native</filename> context, + <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link> + is set to the value of this variable by default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_LDFLAGS'><glossterm>BUILD_LDFLAGS</glossterm> + <info> + BUILD_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the linker when building + for the build host. + When building in the <filename>-native</filename> context, + <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> + is set to the value of this variable by default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_OPTIMIZATION'><glossterm>BUILD_OPTIMIZATION</glossterm> + <info> + BUILD_OPTIMIZATION[doc] = "Specifies the optimization flags passed to the C compiler when building for the build host or the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the optimization flags passed to the C compiler + when building for the build host or the SDK. + The flags are passed through the + <link linkend='var-BUILD_CFLAGS'><filename>BUILD_CFLAGS</filename></link> + and + <link linkend='var-BUILDSDK_CFLAGS'><filename>BUILDSDK_CFLAGS</filename></link> + default values. + </para> + + <para> + The default value of the + <filename>BUILD_OPTIMIZATION</filename> variable is + "-O2 -pipe". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_OS'><glossterm>BUILD_OS</glossterm> + <info> + BUILD_OS[doc] = "The operating system (in lower case) of the building architecture (e.g. Linux)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the operating system in use on the build + host (e.g. "linux"). + The OpenEmbedded build system sets the value of + <filename>BUILD_OS</filename> from the OS reported by + the <filename>uname</filename> command - the first word, + converted to lower-case characters. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_PREFIX'><glossterm>BUILD_PREFIX</glossterm> + <info> + BUILD_PREFIX[doc] = "The toolchain binary prefix used for native recipes." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The toolchain binary prefix used for native recipes. + The OpenEmbedded build system uses the + <filename>BUILD_PREFIX</filename> value to set the + <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> + when building for <filename>native</filename> recipes. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_SYS'><glossterm>BUILD_SYS</glossterm> + <info> + BUILD_SYS[doc] = "The toolchain binary prefix used for native recipes." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the system, including the architecture and + the operating system, to use when building for the build + host (i.e. when building <filename>native</filename> + recipes). + </para> + + <para> + The OpenEmbedded build system automatically sets this + variable based on + <link linkend='var-BUILD_ARCH'><filename>BUILD_ARCH</filename></link>, + <link linkend='var-BUILD_VENDOR'><filename>BUILD_VENDOR</filename></link>, + and + <link linkend='var-BUILD_OS'><filename>BUILD_OS</filename></link>. + You do not need to set the <filename>BUILD_SYS</filename> + variable yourself. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILD_VENDOR'><glossterm>BUILD_VENDOR</glossterm> + <info> + BUILD_VENDOR[doc] = "The vendor name to use when building for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the vendor name to use when building for the + build host. + The default value is an empty string (""). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDDIR'><glossterm>BUILDDIR</glossterm> + <info> + BUILDDIR[doc] = "Points to the location of the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the location of the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + You can define this directory indirectly through the + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + and + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link> + scripts by passing in a Build Directory path when you run + the scripts. + If you run the scripts and do not provide a Build Directory + path, the <filename>BUILDDIR</filename> defaults to + <filename>build</filename> in the current directory. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDHISTORY_COMMIT'><glossterm>BUILDHISTORY_COMMIT</glossterm> + <info> + BUILDHISTORY_COMMIT[doc] = "When inheriting the buildhistory class, this variable specifies whether or not to commit the build history output in a local Git repository." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> + class, this variable specifies whether or not to commit the + build history output in a local Git repository. + If set to "1", this local repository will be maintained + automatically by the + <filename>buildhistory</filename> + class and a commit will be created on every + build for changes to each top-level subdirectory of the + build history output (images, packages, and sdk). + If you want to track changes to build history over + time, you should set this value to "1". + </para> + + <para> + By default, the <filename>buildhistory</filename> class + does not commit the build history output in a local + Git repository: + <literallayout class='monospaced'> + BUILDHISTORY_COMMIT ?= "0" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDHISTORY_COMMIT_AUTHOR'><glossterm>BUILDHISTORY_COMMIT_AUTHOR</glossterm> + <info> + BUILDHISTORY_COMMIT_AUTHOR[doc] = "When inheriting the buildhistory class, this variable specifies the author to use for each Git commit." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> + class, this variable specifies the author to use for each + Git commit. + In order for the <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> + variable to work, the + <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> + variable must be set to "1". + </para> + + <para> + Git requires that the value you provide for the + <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> variable + takes the form of "name <email@host>". + Providing an email address or host that is not valid does + not produce an error. + </para> + + <para> + By default, the <filename>buildhistory</filename> class + sets the variable as follows: + <literallayout class='monospaced'> + BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDHISTORY_DIR'><glossterm>BUILDHISTORY_DIR</glossterm> + <info> + BUILDHISTORY_DIR[doc] = "When inheriting the buildhistory class, this variable specifies the directory in which build history information is kept." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> + class, this variable specifies the directory in which + build history information is kept. + For more information on how the variable works, see the + <filename>buildhistory.class</filename>. + </para> + + <para> + By default, the <filename>buildhistory</filename> class + sets the directory as follows: + <literallayout class='monospaced'> + BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDHISTORY_FEATURES'><glossterm>BUILDHISTORY_FEATURES</glossterm> + <info> + BUILDHISTORY_FEATURES[doc] = "When inheriting the buildhistory class, this variable specifies the build history features to be enabled." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> + class, this variable specifies the build history features + to be enabled. + For more information on how build history works, see the + "<link linkend='maintaining-build-output-quality'>Maintaining Build Output Quality</link>" + section. + </para> + + <para> + You can specify three features in the form of a + space-separated list: + <itemizedlist> + <listitem><para><emphasis>image:</emphasis> + Analysis of the contents of images, which + includes the list of installed packages among other + things. + </para></listitem> + <listitem><para><emphasis>package:</emphasis> + Analysis of the contents of individual packages. + </para></listitem> + <listitem><para><emphasis>sdk:</emphasis> + Analysis of the contents of the software + development kit (SDK). + </para></listitem> + </itemizedlist> + </para> + + <para> + By default, the <filename>buildhistory</filename> class + enables all three features: + <literallayout class='monospaced'> + BUILDHISTORY_FEATURES ?= "image package sdk" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDHISTORY_IMAGE_FILES'><glossterm>BUILDHISTORY_IMAGE_FILES</glossterm> + <info> + BUILDHISTORY_IMAGE_FILES[doc] = "When inheriting the buildhistory class, this variable specifies a list of paths to files copied from the image contents into the build history directory under an "image-files" directory in the directory for the image, so that you can track the contents of each file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> + class, this variable specifies a list of paths to files + copied from the + image contents into the build history directory under + an "image-files" directory in the directory for + the image, so that you can track the contents of each file. + The default is to copy <filename>/etc/passwd</filename> + and <filename>/etc/group</filename>, which allows you to + monitor for changes in user and group entries. + You can modify the list to include any file. + Specifying an invalid path does not produce an error. + Consequently, you can include files that might + not always be present. + </para> + + <para> + By default, the <filename>buildhistory</filename> class + provides paths to the following files: + <literallayout class='monospaced'> + BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDHISTORY_PUSH_REPO'><glossterm>BUILDHISTORY_PUSH_REPO</glossterm> + <info> + BUILDHISTORY_PUSH_REPO[doc] = "When inheriting the buildhistory class, this variable optionally specifies a remote repository to which build history pushes Git changes." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> + class, this variable optionally specifies a remote + repository to which build history pushes Git changes. + In order for <filename>BUILDHISTORY_PUSH_REPO</filename> + to work, + <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> + must be set to "1". + </para> + + <para> + The repository should correspond to a remote + address that specifies a repository as understood by + Git, or alternatively to a remote name that you have + set up manually using <filename>git remote</filename> + within the local repository. + </para> + + <para> + By default, the <filename>buildhistory</filename> class + sets the variable as follows: + <literallayout class='monospaced'> + BUILDHISTORY_PUSH_REPO ?= "" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDSDK_CFLAGS'><glossterm>BUILDSDK_CFLAGS</glossterm> + <info> + BUILDSDK_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C compiler when building + for the SDK. + When building in the <filename>nativesdk-</filename> + context, + <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> + is set to the value of this variable by default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDSDK_CPPFLAGS'><glossterm>BUILDSDK_CPPFLAGS</glossterm> + <info> + BUILDSDK_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C pre-processor + (i.e. to both the C and the C++ compilers) when building + for the SDK. + When building in the <filename>nativesdk-</filename> + context, + <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link> + is set to the value of this variable by default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDSDK_CXXFLAGS'><glossterm>BUILDSDK_CXXFLAGS</glossterm> + <info> + BUILDSDK_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C++ compiler when + building for the SDK. + When building in the <filename>nativesdk-</filename> + context, + <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link> + is set to the value of this variable by default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDSDK_LDFLAGS'><glossterm>BUILDSDK_LDFLAGS</glossterm> + <info> + BUILDSDK_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the linker when building + for the SDK. + When building in the <filename>nativesdk-</filename> + context, + <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> + is set to the value of this variable by default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUILDSTATS_BASE'><glossterm>BUILDSTATS_BASE</glossterm> + <info> + BUILDSTATS_BASE[doc] = "Points to the location of the directory that holds build statistics when you use and enable the buildstats class." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the location of the directory that holds build + statistics when you use and enable the + <link linkend='ref-classes-buildstats'><filename>buildstats</filename></link> + class. + The <filename>BUILDSTATS_BASE</filename> directory defaults + to + <filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/buildstats/</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm> + <info> + BUSYBOX_SPLIT_SUID[doc] = "For the BusyBox recipe, specifies whether to split the output executable file into two parts: one for features that require setuid root, and one for the remaining features." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + For the BusyBox recipe, specifies whether to split the + output executable file into two parts: one for features + that require <filename>setuid root</filename>, and one for + the remaining features (i.e. those that do not require + <filename>setuid root</filename>). + </para> + + <para> + The <filename>BUSYBOX_SPLIT_SUID</filename> variable + defaults to "1", which results in a single output + executable file. + Set the variable to "0" to split the output file. + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-c'><title>C</title> + + <glossentry id='var-CACHE'><glossterm>CACHE</glossterm> + <info> + CACHE[doc] = "The directory BitBake uses to store a cache of the metadata." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the directory BitBake uses to store a cache + of the + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> + so it does not need to be parsed every time BitBake is + started. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CC'><glossterm>CC</glossterm> + <info> + CC[doc] = "Minimum command and arguments to run the C compiler." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments used to run the C + compiler. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm> + <info> + CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as TARGET_CFLAGS." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C compiler. + This variable is exported to an environment + variable and thus made visible to the software being + built during the compilation step. + </para> + + <para> + Default initialization for <filename>CFLAGS</filename> + varies depending on what is being built: + <itemizedlist> + <listitem><para> + <link linkend='var-TARGET_CFLAGS'><filename>TARGET_CFLAGS</filename></link> + when building for the target + </para></listitem> + <listitem><para> + <link linkend='var-BUILD_CFLAGS'><filename>BUILD_CFLAGS</filename></link> + when building for the build host (i.e. + <filename>-native</filename>) + </para></listitem> + <listitem><para> + <link linkend='var-BUILDSDK_CFLAGS'><filename>BUILDSDK_CFLAGS</filename></link> + when building for an SDK (i.e. + <filename>nativesdk-</filename>) + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CLASSOVERRIDE'><glossterm>CLASSOVERRIDE</glossterm> + <info> + CLASSOVERRIDE[doc] = "An internal variable specifying the special class override that should currently apply (e.g. "class-target", "class-native", and so forth)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + An internal variable specifying the special class override + that should currently apply (e.g. "class-target", + "class-native", and so forth). + The classes that use this variable set it to + appropriate values. + </para> + + <para> + You do not normally directly interact with this variable. + The value for the <filename>CLASSOVERRIDE</filename> + variable goes into + <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> + and then can be used as an override. + Here is an example where "python-native" is added to + <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> + only when building for the <filename>-native</filename> case: + <literallayout class='monospaced'> + DEPENDS_append_class-native = " python-native" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CLEANBROKEN'><glossterm>CLEANBROKEN</glossterm> + <info> + CLEANBROKEN[doc] = "Prevents the build system from running 'make clean' during the do_configure task." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + If set to "1" within a recipe, + <filename>CLEANBROKEN</filename> specifies that + the <filename>make clean</filename> command does + not work for the software being built. + Consequently, the OpenEmbedded build system will not try + to run <filename>make clean</filename> during the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task, which is the default behavior. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm> + <info> + COMBINED_FEATURES[doc] = "A set of features common between MACHINE_FEATURES and DISTRO_FEATURES." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Provides a list of hardware features that are enabled in + both + <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> + and + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. + This select list of features contains features that make + sense to be controlled both at the machine and distribution + configuration level. + For example, the "bluetooth" feature requires hardware + support but should also be optional at the distribution + level, in case the hardware supports Bluetooth but you + do not ever intend to use it. + </para> + + <para> + For more information, see the + <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> + and <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> + variables. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-COMMON_LICENSE_DIR'><glossterm>COMMON_LICENSE_DIR</glossterm> + <info> + COMMON_LICENSE_DIR[doc] = "Points to meta/files/common-licenses in the Source Directory, which is where generic license files reside." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to <filename>meta/files/common-licenses</filename> + in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>, + which is where generic license files reside. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm> + <info> + COMPATIBLE_HOST[doc] = "A regular expression that resolves to one or more hosts (when the recipe is native) or one or more targets (when the recipe is non-native) with which a recipe is compatible." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A regular expression that resolves to one or more hosts + (when the recipe is native) or one or more targets (when + the recipe is non-native) with which a recipe is compatible. + The regular expression is matched against + <link linkend="var-HOST_SYS"><filename>HOST_SYS</filename></link>. + You can use the variable to stop recipes from being built + for classes of systems with which the recipes are not + compatible. + Stopping these builds is particularly useful with kernels. + The variable also helps to increase parsing speed + since the build system skips parsing recipes not + compatible with the current system. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> + <info> + COMPATIBLE_MACHINE[doc] = "A regular expression that resolves to one or more target machines with which a recipe is compatible." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A regular expression that resolves to one or more + target machines with which a recipe is compatible. + The regular expression is matched against + <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link>. + You can use the variable to stop recipes from being built + for machines with which the recipes are not compatible. + Stopping these builds is particularly useful with kernels. + The variable also helps to increase parsing speed + since the build system skips parsing recipes not + compatible with the current machine. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm> + <info> + COMPLEMENTARY_GLOB[doc] = "Defines wildcards to match when installing a list of complementary packages for all the packages installed in an image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines wildcards to match when installing a list of + complementary packages for all the packages explicitly + (or implicitly) installed in an image. + The resulting list of complementary packages is associated + with an item that can be added to + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. + An example usage of this is the "dev-pkgs" item that when + added to <filename>IMAGE_FEATURES</filename> will + install -dev packages (containing headers and other + development files) for every package in the image. + </para> + + <para> + To add a new feature item pointing to a wildcard, use a + variable flag to specify the feature item name and + use the value to specify the wildcard. + Here is an example: + <literallayout class='monospaced'> + COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev' + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CONF_VERSION'><glossterm>CONF_VERSION</glossterm> + <info> + CONF_VERSION[doc] = "Tracks the version of local.conf. Increased each time build/conf/ changes incompatibly." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Tracks the version of the local configuration file + (i.e. <filename>local.conf</filename>). + The value for <filename>CONF_VERSION</filename> + increments each time <filename>build/conf/</filename> + compatibility changes. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CONFFILES'><glossterm>CONFFILES</glossterm> + <info> + CONFFILES[doc] = "Identifies editable or configurable files that are part of a package." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Identifies editable or configurable files that are part of a package. + If the Package Management System (PMS) is being used to update + packages on the target system, it is possible that + configuration files you have changed after the original installation + and that you now want to remain unchanged are overwritten. + In other words, editable files might exist in the package that you do not + want reset as part of the package update process. + You can use the <filename>CONFFILES</filename> variable to list the files in the + package that you wish to prevent the PMS from overwriting during this update process. + </para> + + <para> + To use the <filename>CONFFILES</filename> variable, provide a package name + override that identifies the resulting package. + Then, provide a space-separated list of files. + Here is an example: + <literallayout class='monospaced'> + CONFFILES_${PN} += "${sysconfdir}/file1 \ + ${sysconfdir}/file2 ${sysconfdir}/file3" + </literallayout> + </para> + + <para> + A relationship exists between the <filename>CONFFILES</filename> and + <filename><link linkend='var-FILES'>FILES</link></filename> variables. + The files listed within <filename>CONFFILES</filename> must be a subset of + the files listed within <filename>FILES</filename>. + Because the configuration files you provide with <filename>CONFFILES</filename> + are simply being identified so that the PMS will not overwrite them, + it makes sense that + the files must already be included as part of the package through the + <filename>FILES</filename> variable. + </para> + + <note> + When specifying paths as part of the <filename>CONFFILES</filename> variable, + it is good practice to use appropriate path variables. + For example, <filename>${sysconfdir}</filename> rather than + <filename>/etc</filename> or <filename>${bindir}</filename> rather + than <filename>/usr/bin</filename>. + You can find a list of these variables at the top of the + <filename>meta/conf/bitbake.conf</filename> file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-CONFIG_INITRAMFS_SOURCE'><glossterm>CONFIG_INITRAMFS_SOURCE</glossterm> + <info> + CONFIG_INITRAMFS_SOURCE[doc] = "Identifies the initial RAM disk (initramfs) source files. The OpenEmbedded build system receives and uses this kernel Kconfig variable as an environment variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Identifies the initial RAM disk (initramfs) source files. + The OpenEmbedded build system receives and uses + this kernel Kconfig variable as an environment variable. + By default, the variable is set to null (""). + </para> + + <para> + The <filename>CONFIG_INITRAMFS_SOURCE</filename> can be + either a single cpio archive with a + <filename>.cpio</filename> suffix or a + space-separated list of directories and files for building + the initramfs image. + A cpio archive should contain a filesystem archive + to be used as an initramfs image. + Directories should contain a filesystem layout to be + included in the initramfs image. + Files should contain entries according to the format + described by the + <filename>usr/gen_init_cpio</filename> program in the + kernel tree. + </para> + + <para> + If you specify multiple directories and files, the + initramfs image will be the aggregate of all of them. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> + <info> + CONFIG_SITE[doc] = "A list of files that contains autoconf test results relevant to the current build. This variable is used by the Autotools utilities when running configure." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of files that contains <filename>autoconf</filename> test results relevant + to the current build. + This variable is used by the Autotools utilities when running + <filename>configure</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CONFIGURE_FLAGS'><glossterm>CONFIGURE_FLAGS</glossterm> + <info> + CONFIGURE_FLAGS[doc] = "The minimal arguments for GNU configure." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal arguments for GNU configure. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm>CONFLICT_DISTRO_FEATURES</glossterm> + <info> + CONFLICT_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that would be in conflict should the recipe be built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link> + class, this + variable identifies distribution features that would + be in conflict should the recipe + be built. + In other words, if the + <filename>CONFLICT_DISTRO_FEATURES</filename> variable + lists a feature that also appears in + <filename>DISTRO_FEATURES</filename> within the + current configuration, an error occurs and the + build stops. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-COPY_LIC_DIRS'><glossterm>COPY_LIC_DIRS</glossterm> + <info> + COPY_LIC_DIRS[doc] = "If set to "1" along with the COPY_LIC_MANIFEST variable, the OpenEmbedded build system copies into the image the license files, which are located in /usr/share/common-licenses, for each package." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + If set to "1" along with the + <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> + variable, the OpenEmbedded build system copies + into the image the license files, which are located in + <filename>/usr/share/common-licenses</filename>, + for each package. + The license files are placed + in directories within the image itself during build time. + <note> + The <filename>COPY_LIC_DIRS</filename> does not + offer a path for adding licenses for newly installed + packages to an image, which might be most suitable + for read-only filesystems that cannot be upgraded. + See the + <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link> + variable for additional information. + You can also reference the + "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" + section in the Yocto Project Development Manual for + information on providing license text. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-COPY_LIC_MANIFEST'><glossterm>COPY_LIC_MANIFEST</glossterm> + <info> + COPY_LIC_MANIFEST[doc] = "If set to "1", the OpenEmbedded build system copies the license manifest for the image to /usr/share/common-licenses/license.manifest within the image itself." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + If set to "1", the OpenEmbedded build system copies + the license manifest for the image to + <filename>/usr/share/common-licenses/license.manifest</filename> + within the image itself during build time. + <note> + The <filename>COPY_LIC_MANIFEST</filename> does not + offer a path for adding licenses for newly installed + packages to an image, which might be most suitable + for read-only filesystems that cannot be upgraded. + See the + <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link> + variable for additional information. + You can also reference the + "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" + section in the Yocto Project Development Manual for + information on providing license text. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CORE_IMAGE_EXTRA_INSTALL'><glossterm>CORE_IMAGE_EXTRA_INSTALL</glossterm> + <info> + CORE_IMAGE_EXTRA_INSTALL[doc] = "Specifies the list of packages to be added to the image. You should only set this variable in the conf/local.conf file in the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the list of packages to be added to the image. + You should only set this variable in the + <filename>local.conf</filename> configuration file found + in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + </para> + + <para> + This variable replaces <filename>POKY_EXTRA_INSTALL</filename>, which is no longer supported. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-COREBASE'><glossterm>COREBASE</glossterm> + <info> + COREBASE[doc] = "Specifies the parent directory of the OpenEmbedded Core Metadata layer (i.e. meta)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the parent directory of the OpenEmbedded + Core Metadata layer (i.e. <filename>meta</filename>). + </para> + + <para> + It is an important distinction that + <filename>COREBASE</filename> points to the parent of this + layer and not the layer itself. + Consider an example where you have cloned the Poky Git + repository and retained the <filename>poky</filename> + name for your local copy of the repository. + In this case, <filename>COREBASE</filename> points to + the <filename>poky</filename> folder because it is the + parent directory of the <filename>poky/meta</filename> + layer. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-COREBASE_FILES'><glossterm>COREBASE_FILES</glossterm> + <info> + COREBASE_FILES[doc] = "Lists files from the COREBASE directory that should be copied other than the layers listed in the bblayers.conf file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists files from the + <link linkend='var-COREBASE'><filename>COREBASE</filename></link> + directory that should be copied other than the layers + listed in the <filename>bblayers.conf</filename> file. + The <filename>COREBASE_FILES</filename> variable exists + for the purpose of copying metadata from the + OpenEmbedded build system into the extensible + SDK. + </para> + + <para> + Explicitly listing files in <filename>COREBASE</filename> + is needed because it typically contains build + directories and other files that should not normally + be copied into the extensible SDK. + Consequently, the value of + <filename>COREBASE_FILES</filename> is used in order to + only copy the files that are actually needed. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CPP'><glossterm>CPP</glossterm> + <info> + CPP[doc] = "Minimum command and arguments to run the C preprocessor." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments used to run the C + preprocessor. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CPPFLAGS'><glossterm>CPPFLAGS</glossterm> + <info> + CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C pre-processor + (i.e. to both the C and the C++ compilers). + This variable is exported to an environment + variable and thus made visible to the software being + built during the compilation step. + </para> + + <para> + Default initialization for <filename>CPPFLAGS</filename> + varies depending on what is being built: + <itemizedlist> + <listitem><para> + <link linkend='var-TARGET_CPPFLAGS'><filename>TARGET_CPPFLAGS</filename></link> + when building for the target + </para></listitem> + <listitem><para> + <link linkend='var-BUILD_CPPFLAGS'><filename>BUILD_CPPFLAGS</filename></link> + when building for the build host (i.e. + <filename>-native</filename>) + </para></listitem> + <listitem><para> + <link linkend='var-BUILDSDK_CPPFLAGS'><filename>BUILDSDK_CPPFLAGS</filename></link> + when building for an SDK (i.e. + <filename>nativesdk-</filename>) + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CROSS_COMPILE'><glossterm>CROSS_COMPILE</glossterm> + <info> + CROSS_COMPILE[doc] = "The toolchain binary prefix for the target tools." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The toolchain binary prefix for the target tools. + The <filename>CROSS_COMPILE</filename> variable is the + same as the + <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> + variable. + <note> + The OpenEmbedded build system sets the + <filename>CROSS_COMPILE</filename> variable only in + certain contexts (e.g. when building for kernel + and kernel module recipes). + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CVSDIR'><glossterm>CVSDIR</glossterm> + <info> + CVSDIR[doc] = "The directory where cvs checkouts will be stored in." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The directory in which files checked out under the + CVS system are stored. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CXX'><glossterm>CXX</glossterm> + <info> + CXX[doc] = "Minimum command and arguments to run the C++ compiler." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments used to run the C++ + compiler. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-CXXFLAGS'><glossterm>CXXFLAGS</glossterm> + <info> + CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C++ compiler. + This variable is exported to an environment + variable and thus made visible to the software being + built during the compilation step. + </para> + + <para> + Default initialization for <filename>CXXFLAGS</filename> + varies depending on what is being built: + <itemizedlist> + <listitem><para> + <link linkend='var-TARGET_CXXFLAGS'><filename>TARGET_CXXFLAGS</filename></link> + when building for the target + </para></listitem> + <listitem><para> + <link linkend='var-BUILD_CXXFLAGS'><filename>BUILD_CXXFLAGS</filename></link> + when building for the build host (i.e. + <filename>-native</filename>) + </para></listitem> + <listitem><para> + <link linkend='var-BUILDSDK_CXXFLAGS'><filename>BUILDSDK_CXXFLAGS</filename></link> + when building for an SDK (i.e. + <filename>nativesdk-</filename>) + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-d'><title>D</title> + + <glossentry id='var-D'><glossterm>D</glossterm> + <info> + D[doc] = "The destination directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The destination directory. + The location in the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + where components are installed by the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task. + This location defaults to: + <literallayout class='monospaced'> + ${WORKDIR}/image + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DATE'><glossterm>DATE</glossterm> + <info> + DATE[doc] = "The date the build was started using YMD format." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The date the build was started. + Dates appear using the year, month, and day (YMD) format + (e.g. "20150209" for February 9th, 2015). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm> + <info> + DATETIME[doc] = "The date and time the build was started." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The date and time on which the current build started. + The format is suitable for timestamps. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEBIAN_NOAUTONAME'><glossterm>DEBIAN_NOAUTONAME</glossterm> + <info> + DEBIAN_NOAUTONAME[doc] = "Prevents a particular package from being renamed according to Debian package naming." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When the + <link linkend='ref-classes-debian'><filename>debian</filename></link> + class is inherited, which is the default behavior, + <filename>DEBIAN_NOAUTONAME</filename> specifies a + particular package should not be renamed according to + Debian library package naming. + You must use the package name as an override when you + set this variable. + Here is an example from the <filename>fontconfig</filename> + recipe: + <literallayout class='monospaced'> + DEBIAN_NOAUTONAME_fontconfig-utils = "1" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEBIANNAME'><glossterm>DEBIANNAME</glossterm> + <info> + DEBIANNAME[doc] = "Allows you to override the library name for an individual package for Debian library package renaming." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When the + <link linkend='ref-classes-debian'><filename>debian</filename></link> + class is inherited, which is the default behavior, + <filename>DEBIANNAME</filename> allows you to override the + library name for an individual package. + Overriding the library name in these cases is rare. + You must use the package name as an override when you + set this variable. + Here is an example from the <filename>dbus</filename> + recipe: + <literallayout class='monospaced'> + DEBIANNAME_${PN} = "dbus-1" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm> + <info> + DEBUG_BUILD[doc] = "Specifies to build packages with debugging information. This influences the value of the SELECTED_OPTIMIZATION variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies to build packages with debugging information. + This influences the value of the + <filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm> + <info> + DEBUG_OPTIMIZATION[doc] = "The options to pass in TARGET_CFLAGS and CFLAGS when compiling a system for debugging. This variable defaults to '-O -fno-omit-frame-pointer -g'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The options to pass in + <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> + and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling + a system for debugging. + This variable defaults to "-O -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm> + <info> + DEFAULT_PREFERENCE[doc] = "Specifies a weak bias for recipe selection priority." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a weak bias for recipe selection priority. + </para> + + <para> + The most common usage of this is variable is to set + it to "-1" within a recipe for a development version of a + piece of software. + Using the variable in this way causes the stable version + of the recipe to build by default in the absence of + <filename><link linkend='var-PREFERRED_VERSION'>PREFERRED_VERSION</link></filename> + being used to build the development version. + </para> + + <note> + The bias provided by <filename>DEFAULT_PREFERENCE</filename> + is weak and is overridden by + <filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename> + if that variable is different between two layers + that contain different versions of the same recipe. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-DEFAULTTUNE'><glossterm>DEFAULTTUNE</glossterm> + <info> + DEFAULTTUNE[doc] = "The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The default CPU and Application Binary Interface (ABI) + tunings (i.e. the "tune") used by the OpenEmbedded build + system. + The <filename>DEFAULTTUNE</filename> helps define + <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. + </para> + + <para> + The default tune is either implicitly or explicitly set + by the machine + (<link linkend='var-MACHINE'><filename>MACHINE</filename></link>). + However, you can override the setting using available tunes + as defined with + <link linkend='var-AVAILTUNES'><filename>AVAILTUNES</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm> + <info> + DEPENDS[doc] = "Lists a recipe's build-time dependencies (i.e. other recipe files)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists a recipe's build-time dependencies + (i.e. other recipe files). + The system ensures that all the dependencies listed + have been built and have their contents in the appropriate + sysroots before the recipe's configure task is executed. + </para> + + <para> + Consider this simple example for two recipes named "a" and + "b" that produce similarly named packages. + In this example, the <filename>DEPENDS</filename> + statement appears in the "a" recipe: + <literallayout class='monospaced'> + DEPENDS = "b" + </literallayout> + Here, the dependency is such that the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task for recipe "a" depends on the + <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> + task of recipe "b". + This means anything that recipe "b" puts into sysroot + is available when recipe "a" is configuring itself. + </para> + + <para> + For information on runtime dependencies, see the + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEPLOY_DIR'><glossterm>DEPLOY_DIR</glossterm> + <info> + DEPLOY_DIR[doc] = "Points to the general area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the general area that the OpenEmbedded build + system uses to place images, packages, SDKs and other output + files that are ready to be used outside of the build system. + By default, this directory resides within the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + as <filename>${TMPDIR}/deploy</filename>. + </para> + + <para> + For more information on the structure of the Build + Directory, see + "<link linkend='structure-build'>The Build Directory - <filename>build/</filename></link>" + section. + For more detail on the contents of the + <filename>deploy</filename> directory, see the + "<link linkend='images-dev-environment'>Images</link>", + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>", + and + "<link linkend='sdk-dev-environment'>Application Development SDK</link>" + sections. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEPLOY_DIR_DEB'><glossterm>DEPLOY_DIR_DEB</glossterm> + <info> + DEPLOY_DIR_DEB[doc] = "Points to a Debian-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the area that the OpenEmbedded build system uses + to place Debian packages that are ready to be used outside + of the build system. + This variable applies only when + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + contains "package_deb". + </para> + + <para> + The BitBake configuration file initially defines the + <filename>DEPLOY_DIR_DEB</filename> variable as a + sub-folder of + <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + <literallayout class='monospaced'> + DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" + </literallayout> + </para> + + <para> + The + <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link> + class uses the + <filename>DEPLOY_DIR_DEB</filename> variable to make sure + the + <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link> + task writes Debian packages into the appropriate folder. + For more information on how packaging works, see the + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEPLOY_DIR_IMAGE'><glossterm>DEPLOY_DIR_IMAGE</glossterm> + <info> + DEPLOY_DIR_IMAGE[doc] = "Points to the area that the OpenEmbedded build system uses to place images and other associated output files that are ready to be deployed onto the target machine." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the area that the OpenEmbedded build system uses + to place images and other associated output files that are + ready to be deployed onto the target machine. + The directory is machine-specific as it contains the + <filename>${MACHINE}</filename> name. + By default, this directory resides within the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + as <filename>${DEPLOY_DIR}/images/${MACHINE}/</filename>. + </para> + + <para> + For more information on the structure of the Build + Directory, see + "<link linkend='structure-build'>The Build Directory - <filename>build/</filename></link>" + section. + For more detail on the contents of the + <filename>deploy</filename> directory, see the + "<link linkend='images-dev-environment'>Images</link>" and + "<link linkend='sdk-dev-environment'>Application Development SDK</link>" + sections. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEPLOY_DIR_IPK'><glossterm>DEPLOY_DIR_IPK</glossterm> + <info> + DEPLOY_DIR_IPK[doc] = "Points to a IPK-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the area that the OpenEmbedded build system uses + to place IPK packages that are ready to be used outside of + the build system. + This variable applies only when + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + contains "package_ipk". + </para> + + <para> + The BitBake configuration file initially defines this + variable as a sub-folder of + <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + <literallayout class='monospaced'> + DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk" + </literallayout> + </para> + + <para> + The + <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link> + class uses the + <filename>DEPLOY_DIR_IPK</filename> variable to make sure + the + <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> + task writes IPK packages into the appropriate folder. + For more information on how packaging works, see the + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEPLOY_DIR_RPM'><glossterm>DEPLOY_DIR_RPM</glossterm> + <info> + DEPLOY_DIR_RPM[doc] = "Points to a RPM-specific area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the area that the OpenEmbedded build system uses + to place RPM packages that are ready to be used outside + of the build system. + This variable applies only when + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + contains "package_rpm". + </para> + + <para> + The BitBake configuration file initially defines this + variable as a sub-folder of + <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + <literallayout class='monospaced'> + DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm" + </literallayout> + </para> + + <para> + The + <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link> + class uses the + <filename>DEPLOY_DIR_RPM</filename> variable to make sure + the + <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link> + task writes RPM packages into the appropriate folder. + For more information on how packaging works, see the + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEPLOY_DIR_TAR'><glossterm>DEPLOY_DIR_TAR</glossterm> + <info> + DEPLOY_DIR_TAR[doc] = "Points to a tarball area that the OpenEmbedded build system uses to place images, packages, SDKs and other output files that are ready to be used outside of the build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the area that the OpenEmbedded build system uses + to place tarballs that are ready to be used outside of + the build system. + This variable applies only when + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + contains "package_tar". + </para> + + <para> + The BitBake configuration file initially defines this + variable as a sub-folder of + <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: + <literallayout class='monospaced'> + DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar" + </literallayout> + </para> + + <para> + The + <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link> + class uses the + <filename>DEPLOY_DIR_TAR</filename> variable to make sure + the + <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link> + task writes TAR packages into the appropriate folder. + For more information on how packaging works, see the + "<link linkend='package-feeds-dev-environment'>Package Feeds</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm> + <info> + DEPLOYDIR[doc] = "For recipes that inherit the deploy class, the DEPLOYDIR points to a temporary work area for deployed files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-deploy'><filename>deploy</filename></link> + class, the <filename>DEPLOYDIR</filename> points to a + temporary work area for deployed files that is set in the + <filename>deploy</filename> class as follows: + <literallayout class='monospaced'> + DEPLOYDIR = "${WORKDIR}/deploy-${<link linkend='var-PN'><filename>PN</filename></link>}" + </literallayout> + </para> + + <para> + Recipes inheriting the <filename>deploy</filename> class + should copy files to be deployed into + <filename>DEPLOYDIR</filename>, and the class will take + care of copying them into + <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> + afterwards. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> + <info> + DESCRIPTION[doc] = "The package description used by package managers. If not set, DESCRIPTION takes the value of the SUMMARY variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The package description used by package managers. + If not set, <filename>DESCRIPTION</filename> takes + the value of the + <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISK_SIGNATURE'><glossterm>DISK_SIGNATURE</glossterm> + <info> + DISK_SIGNATURE[doc] = "A 32-bit MBR disk signature used by directdisk images." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A 32-bit MBR disk signature used by + <filename>directdisk</filename> images. + </para> + + <para> + By default, the signature is set to an automatically + generated random value that allows the OpenEmbedded + build system to create a boot loader. + You can override the signature in the image recipe + by setting <filename>DISK_SIGNATURE</filename> to an + 8-digit hex string. + You might want to override + <filename>DISK_SIGNATURE</filename> if you want the disk + signature to remain constant between image builds. + </para> + + <para> + When using Linux 3.8 or later, you can use + <filename>DISK_SIGNATURE</filename> to specify the root + by UUID to allow the kernel to locate the root device + even if the device name changes due to differences in + hardware configuration. + By default, <filename>SYSLINUX_ROOT</filename> is set + as follows: + <literallayout class='monospaced'> + SYSLINUX_ROOT = "root=/dev/sda2" + </literallayout> + However, you can change this to locate the root device + using the disk signature instead: + <literallayout class='monospaced'> + SYSLINUX_ROOT = "root=PARTUUID=${DISK_SIGNATURE}-02" + </literallayout> + </para> + + <para> + As previously mentioned, it is possible to set the + <filename>DISK_SIGNATURE</filename> variable in your + <filename>local.conf</filename> file to a fixed + value if you do not want <filename>syslinux.cfg</filename> + changing for each build. + You might find this useful when you want to upgrade the + root filesystem on a device without having to recreate or + modify the master boot record. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm> + <info> + DISTRO[doc] = "The short name of the distribution. If the variable is blank, meta/conf/distro/defaultsetup.conf will be used." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The short name of the distribution. + This variable corresponds to a distribution + configuration file whose root name is the same as the + variable's argument and whose filename extension is + <filename>.conf</filename>. + For example, the distribution configuration file for the + Poky distribution is named <filename>poky.conf</filename> + and resides in the + <filename>meta-poky/conf/distro</filename> directory of + the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + + <para> + Within that <filename>poky.conf</filename> file, the + <filename>DISTRO</filename> variable is set as follows: + <literallayout class='monospaced'> + DISTRO = "poky" + </literallayout> + </para> + + <para> + Distribution configuration files are located in a + <filename>conf/distro</filename> directory within the + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> + that contains the distribution configuration. + The value for <filename>DISTRO</filename> must not contain + spaces, and is typically all lower-case. + <note> + If the <filename>DISTRO</filename> variable is blank, a set + of default configurations are used, which are specified + within + <filename>meta/conf/distro/defaultsetup.conf</filename> + also in the Source Directory. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_CODENAME'><glossterm>DISTRO_CODENAME</glossterm> + <info> + DISTRO_CODENAME[doc] = "Specifies a codename for the distribution being built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a codename for the distribution being built. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm> + <info> + DISTRO_EXTRA_RDEPENDS[doc] = "Specifies a list of distro-specific packages to add to all images. The variable only applies to the images that include packagegroup-base." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of distro-specific packages to add to all images. + This variable takes affect through + <filename>packagegroup-base</filename> so the + variable only really applies to the more full-featured + images that include <filename>packagegroup-base</filename>. + You can use this variable to keep distro policy out of + generic images. + As with all other distro variables, you set this variable + in the distro <filename>.conf</filename> file. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm> + <info> + DISTRO_EXTRA_RRECOMMENDS[doc] = "Specifies a list of distro-specific packages to add to all images if the packages exist. The list of packages are automatically installed but you can remove them." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of distro-specific packages to add to all images + if the packages exist. + The packages might not exist or be empty (e.g. kernel modules). + The list of packages are automatically installed but you can + remove them. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm> + <info> + DISTRO_FEATURES[doc] = "The features enabled for the distribution." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The software support you want in your distribution for + various features. + You define your distribution features in the distribution + configuration file. + </para> + + <para> + In most cases, the presence or absence of a feature in + <filename>DISTRO_FEATURES</filename> is translated to the + appropriate option supplied to the configure script + during the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task for recipes that optionally support the feature. + For example, specifying "x11" in + <filename>DISTRO_FEATURES</filename>, causes + every piece of software built for the target that can + optionally support X11 to have its X11 support enabled. + </para> + + <para> + Two more examples are Bluetooth and NFS support. + For a more complete list of features that ships with the + Yocto Project and that you can provide with this variable, + see the + "<link linkend='ref-features-distro'>Distro Features</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_FEATURES_BACKFILL'><glossterm>DISTRO_FEATURES_BACKFILL</glossterm> + <info> + DISTRO_FEATURES_BACKFILL[doc] = "Features to be added to DISTRO_FEATURES if not also present in DISTRO_FEATURES_BACKFILL_CONSIDERED. This variable is set in the meta/conf/bitbake.conf file and it is not intended to be user-configurable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Features to be added to + <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename> + if not also present in + <filename><link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'>DISTRO_FEATURES_BACKFILL_CONSIDERED</link></filename>. + </para> + + <para> + This variable is set in the <filename>meta/conf/bitbake.conf</filename> file. + It is not intended to be user-configurable. + It is best to just reference the variable to see which distro features are + being backfilled for all distro configurations. + See the <link linkend='ref-features-backfill'>Feature backfilling</link> section for + more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><glossterm>DISTRO_FEATURES_BACKFILL_CONSIDERED</glossterm> + <info> + DISTRO_FEATURES_BACKFILL_CONSIDERED[doc] = "Features from DISTRO_FEATURES_BACKFILL that should not be backfilled (i.e. added to DISTRO_FEATURES) during the build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Features from + <filename><link linkend='var-DISTRO_FEATURES_BACKFILL'>DISTRO_FEATURES_BACKFILL</link></filename> + that should not be backfilled (i.e. added to + <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>) + during the build. + See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for + more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_FEATURES_DEFAULT'><glossterm>DISTRO_FEATURES_DEFAULT</glossterm> + <info> + DISTRO_FEATURES_DEFAULT[doc] = "Provides the default list of distro features with the exception of any libc-specific features." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A convenience variable that gives you the default + list of distro features with the exception of any + features specific to the C library + (<filename>libc</filename>). + </para> + + <para> + When creating a custom distribution, you might find it + useful to be able to reuse the default + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> + options without the need to write out the full set. + Here is an example that uses + <filename>DISTRO_FEATURES_DEFAULT</filename> from a + custom distro configuration file: + <literallayout class='monospaced'> + DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} ${DISTRO_FEATURES_LIBC} myfeature" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_FEATURES_LIBC'><glossterm>DISTRO_FEATURES_LIBC</glossterm> + <info> + DISTRO_FEATURES_LIBC[doc] = "Specifies the list of distro features that are specific to the C library (libc)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A convenience variable that specifies the list of distro + features that are specific to the C library + (<filename>libc</filename>). + Typically, these features are prefixed with "libc-" and + control which features are enabled at during the build + within the C library itself. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm> + <info> + DISTRO_NAME[doc] = "The long name of the distribution." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The long name of the distribution. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm> + <info> + DISTRO_VERSION[doc] = "The version of the distribution." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The version of the distribution. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DISTROOVERRIDES'><glossterm>DISTROOVERRIDES</glossterm> + <info> + DISTROOVERRIDES[doc] = "Lists overrides specific to the current distribution. By default, the variable list includes the value of the DISTRO variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable lists overrides specific to the current + distribution. + By default, the variable list includes the value of the + <filename><link linkend='var-DISTRO'>DISTRO</link></filename> + variable. + You can extend the variable to apply any variable overrides + you want as part of the distribution and are not + already in <filename>OVERRIDES</filename> through + some other means. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> + <info> + DL_DIR[doc] = "The central download directory used by the build process to store downloads. By default, the directory is 'downloads' in the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The central download directory used by the build process to + store downloads. + By default, <filename>DL_DIR</filename> gets files + suitable for mirroring for everything except Git + repositories. + If you want tarballs of Git repositories, use the + <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> + variable. + </para> + + <para> + You can set this directory by defining the + <filename>DL_DIR</filename> variable in the + <filename>conf/local.conf</filename> file. + This directory is self-maintaining and you should not have + to touch it. + By default, the directory is <filename>downloads</filename> + in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <literallayout class='monospaced'> + #DL_DIR ?= "${TOPDIR}/downloads" + </literallayout> + To specify a different download directory, simply remove + the comment from the line and provide your directory. + </para> + + <para> + During a first build, the system downloads many different + source code tarballs from various upstream projects. + Downloading can take a while, particularly if your network + connection is slow. + Tarballs are all stored in the directory defined by + <filename>DL_DIR</filename> and the build system looks there + first to find source tarballs. + <note> + When wiping and rebuilding, you can preserve this + directory to speed up this part of subsequent + builds. + </note> + </para> + + <para> + You can safely share this directory between multiple builds + on the same development machine. + For additional information on how the build process gets + source files when working behind a firewall or proxy server, + see this specific question in the + "<link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>FAQ</link>" + chapter. + You can also refer to the + "<ulink url='&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>" + Wiki page. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm> + <info> + DOC_COMPRESS[doc] = "When inheriting the compress_doc class, this variable sets the compression policy used when the OpenEmbedded build system compresses man pages and info pages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-compress_doc'><filename>compress_doc</filename></link> + class, this variable sets the compression policy used when + the OpenEmbedded build system compresses man pages and info + pages. + By default, the compression method used is gz (gzip). + Other policies available are xz and bz2. + </para> + + <para> + For information on policies and on how to use this + variable, see the comments in the + <filename>meta/classes/compress_doc.bbclass</filename> file. + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-e'><title>E</title> + + <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm> + <info> + EFI_PROVIDER[doc] = "When building bootable images (i.e. where hddimg or vmdk is in IMAGE_FSTYPES), the EFI_PROVIDER variable specifies the EFI bootloader to use." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When building bootable images (i.e. where + <filename>hddimg</filename> or <filename>vmdk</filename> + is in + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>), + the <filename>EFI_PROVIDER</filename> variable specifies + the EFI bootloader to use. + The default is "grub-efi", but "gummiboot" can be used + instead. + </para> + + <para> + See the + <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link> + class for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm> + <info> + ENABLE_BINARY_LOCALE_GENERATION[doc] = "Controls which locales for glibc are generated during the build. The variable is useful if the target device has 64Mbytes of RAM or less." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Variable that controls which locales for + <filename>glibc</filename> are generated during the + build (useful if the target device has 64Mbytes + of RAM or less). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ERR_REPORT_DIR'><glossterm>ERR_REPORT_DIR</glossterm> + <info> + ERR_REPORT_DIR[doc] = "When used with the report-error class, specifies the path used for storing the debug files created by the error reporting tool, which allows you to submit build errors you encounter to a central database." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When used with the + <link linkend='ref-classes-report-error'><filename>report-error</filename></link> + class, specifies the path used for storing the debug files + created by the + <ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>error reporting tool</ulink>, + which allows you to submit build errors you encounter to a + central database. + By default, the value of this variable is + <filename>${</filename><link linkend='var-LOG_DIR'><filename>LOG_DIR</filename></link><filename>}/error-report</filename>. + </para> + + <para> + You can set <filename>ERR_REPORT_DIR</filename> to the path + you want the error reporting tool to store the debug files + as follows in your <filename>local.conf</filename> file: + <literallayout class='monospaced'> + ERR_REPORT_DIR = "<replaceable>path</replaceable>" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ERROR_QA'><glossterm>ERROR_QA</glossterm> + <info> + ERROR_QA[doc] = "Specifies the quality assurance checks whose failures are reported as errors by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the quality assurance checks whose failures are + reported as errors by the OpenEmbedded build system. + You set this variable in your distribution configuration + file. + For a list of the checks you can control with this variable, + see the + "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXCLUDE_FROM_SHLIBS'><glossterm>EXCLUDE_FROM_SHLIBS</glossterm> + <info> + EXCLUDE_FROM_SHLIBS[doc] = "Causes the OpenEmbedded build system's shared libraries resolver to exclude an entire package when scanning for shared libraries." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Triggers the OpenEmbedded build system's shared libraries + resolver to exclude an entire package when scanning for + shared libraries. + <note> + The shared libraries resolver's functionality results + in part from the internal function + <filename>package_do_shlibs</filename>, which is part of + the + <link linkend='ref-tasks-package'><filename>do_package</filename></link> + task. + You should be aware that the shared libraries resolver + might implicitly define some dependencies between + packages. + </note> + The <filename>EXCLUDE_FROM_SHLIBS</filename> variable is + similar to the + <link linkend='var-PRIVATE_LIBS'><filename>PRIVATE_LIBS</filename></link> + variable, which excludes a package's particular libraries + only and not the whole package. + </para> + + <para> + Use the + <filename>EXCLUDE_FROM_SHLIBS</filename> variable by + setting it to "1" for a particular package: + <literallayout class='monospaced'> + EXCLUDE_FROM_SHLIBS = "1" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm> + <info> + EXCLUDE_FROM_WORLD[doc] = "Directs BitBake to exclude a recipe from world builds (i.e. bitbake world)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Directs BitBake to exclude a recipe from world builds (i.e. + <filename>bitbake world</filename>). + During world builds, BitBake locates, parses and builds all + recipes found in every layer exposed in the + <filename>bblayers.conf</filename> configuration file. + </para> + + <para> + To exclude a recipe from a world build using this variable, + set the variable to "1" in the recipe. + </para> + + <note> + Recipes added to <filename>EXCLUDE_FROM_WORLD</filename> + may still be built during a world build in order to satisfy + dependencies of other recipes. + Adding a recipe to <filename>EXCLUDE_FROM_WORLD</filename> + only ensures that the recipe is not explicitly added + to the list of build targets in a world build. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-EXTENDPE'><glossterm>EXTENDPE</glossterm> + <info> + EXTENDPE[doc] = "Used with file and pathnames to create a prefix for a recipe's version based on the recipe's PE value. If PE is set and greater than zero for a recipe, EXTENDPE becomes that value." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Used with file and pathnames to create a prefix for a recipe's + version based on the recipe's + <link linkend='var-PE'><filename>PE</filename></link> value. + If <filename>PE</filename> is set and greater than zero for a recipe, + <filename>EXTENDPE</filename> becomes that value (e.g if + <filename>PE</filename> is equal to "1" then <filename>EXTENDPE</filename> + becomes "1_"). + If a recipe's <filename>PE</filename> is not set (the default) or is equal to + zero, <filename>EXTENDPE</filename> becomes "".</para> + <para>See the <link linkend='var-STAMP'><filename>STAMP</filename></link> + variable for an example. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTENDPKGV'><glossterm>EXTENDPKGV</glossterm> + <info> + EXTENDPKGV[doc] = "The full package version specification as it appears on the final packages produced by a recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The full package version specification as it appears on the + final packages produced by a recipe. + The variable's value is normally used to fix a runtime + dependency to the exact same version of another package + in the same recipe: + <literallayout class='monospaced'> + RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})" + </literallayout> + </para> + + <para> + The dependency relationships are intended to force the + package manager to upgrade these types of packages in + lock-step. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTERNAL_KERNEL_TOOLS'><glossterm>EXTERNAL_KERNEL_TOOLS</glossterm> + <info> + EXTERNAL_KERNEL_TOOLS[doc] = "Indicates kernel tools are external to the source tree." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When set, the <filename>EXTERNAL_KERNEL_TOOLS</filename> + variable indicates that these tools are not in the + source tree. + </para> + + <para> + When kernel tools are available in the tree, they are + preferred over any externally installed tools. + Setting the <filename>EXTERNAL_KERNEL_TOOLS</filename> + variable tells the OpenEmbedded build system to prefer + the installed external tools. + See the + <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link> + class in <filename>meta/classes</filename> to see how + the variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm> + <info> + EXTERNALSRC[doc] = "If externalsrc.bbclass is inherited, this variable points to the source tree, which is outside of the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> + class, this variable points to the source tree, which is + outside of the OpenEmbedded build system. + When set, this variable sets the + <link linkend='var-S'><filename>S</filename></link> + variable, which is what the OpenEmbedded build system uses + to locate unpacked recipe source code. + </para> + + <para> + For more information on + <filename>externalsrc.bbclass</filename>, see the + "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>" + section. + You can also find information on how to use this variable + in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>" + section in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm> + <info> + EXTERNALSRC_BUILD[doc] = "If externalsrc.bbclass is inherited, this variable points to the directory in which the recipe's source code is built, which is outside of the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> + class, this variable points to the directory in which the + recipe's source code is built, which is outside of the + OpenEmbedded build system. + When set, this variable sets the + <link linkend='var-B'><filename>B</filename></link> + variable, which is what the OpenEmbedded build system uses + to locate the Build Directory. + </para> + + <para> + For more information on + <filename>externalsrc.bbclass</filename>, see the + "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>" + section. + You can also find information on how to use this variable + in the + "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>" + section in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_AUTORECONF'><glossterm>EXTRA_AUTORECONF</glossterm> + <info> + EXTRA_AUTORECONF[doc] = "Extra options passed to the autoreconf command, which is executed during do_configure." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + For recipes inheriting the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class, you can use <filename>EXTRA_AUTORECONF</filename> to + specify extra options to pass to the + <filename>autoreconf</filename> command that is + executed during the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task. + </para> + + <para> + The default value is "--exclude=autopoint". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_IMAGE_FEATURES'><glossterm>EXTRA_IMAGE_FEATURES</glossterm> + <info> + EXTRA_IMAGE_FEATURES[doc] = "The list of additional features to include in an image. Configure this variable in the conf/local.conf file in the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of additional features to include in an image. + When listing more than one feature, separate them with + a space. + </para> + + <para> + Typically, you configure this variable in your + <filename>local.conf</filename> file, which is found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + Although you can use this variable from within a recipe, + best practices dictate that you do not. + <note> + To enable primary features from within the image + recipe, use the + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> + variable. + </note> + </para> + + <para> + Here are some examples of features you can add: + <literallayout class='monospaced'> +"dbg-pkgs" - Adds -dbg packages for all installed packages + including symbol information for debugging and + profiling. + +"debug-tweaks" - Makes an image suitable for debugging. + For example, allows root logins without + passwords and enables post-installation + logging. See the 'allow-empty-password' + and 'post-install-logging' features in + the "<link linkend='ref-features-image'>Image Features</link>" section for + more information. + +"dev-pkgs" - Adds -dev packages for all installed packages. + This is useful if you want to develop against + the libraries in the image. + +"read-only-rootfs" - Creates an image whose root + filesystem is read-only. See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" + section in the Yocto Project + Development Manual for more + information + +"tools-debug" - Adds debugging tools such as gdb and + strace. + +"tools-sdk" - Adds development tools such as gcc, make, + pkgconfig and so forth. + +"tools-testapps" - Adds useful testing tools such as + ts_print, aplay, arecord and so + forth. + + </literallayout> + </para> + + <para> + For a complete list of image features that ships with the + Yocto Project, see the + "<link linkend="ref-features-image">Image Features</link>" + section. + </para> + + <para> + For an example that shows how to customize your image by + using this variable, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>" + section in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_IMAGECMD'><glossterm>EXTRA_IMAGECMD</glossterm> + <info> + EXTRA_IMAGECMD[doc] = "Specifies additional options for the image creation command that has been specified in IMAGE_CMD. When setting this variable, you should use an override for the associated type." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies additional options for the image + creation command that has been specified in + <link linkend='var-IMAGE_CMD'><filename>IMAGE_CMD</filename></link>. + When setting this variable, you should + use an override for the associated type. + Here is an example: + <literallayout class='monospaced'> + EXTRA_IMAGECMD_ext3 ?= "-i 4096" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_IMAGEDEPENDS'><glossterm>EXTRA_IMAGEDEPENDS</glossterm> + <info> + EXTRA_IMAGEDEPENDS[doc] = "A list of recipes to build that do not provide packages for installing into the root filesystem. Use this variable to list recipes that are required to build the final image, but not needed in the root filesystem." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of recipes to build that do not provide packages + for installing into the root filesystem. + </para> + + <para> + Sometimes a recipe is required to build the final image but is not + needed in the root filesystem. + You can use the <filename>EXTRA_IMAGEDEPENDS</filename> variable to + list these recipes and thus specify the dependencies. + A typical example is a required bootloader in a machine configuration. + </para> + + <note> + To add packages to the root filesystem, see the various + <filename>*<link linkend='var-RDEPENDS'>RDEPENDS</link></filename> + and <filename>*<link linkend='var-RRECOMMENDS'>RRECOMMENDS</link></filename> + variables. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm> + <info> + EXTRA_OECMAKE[doc] = "Additional cmake options." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Additional <filename>cmake</filename> options. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm> + <info> + EXTRA_OECONF[doc] = "Additional configure script options." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Additional <filename>configure</filename> script options. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm> + <info> + EXTRA_OEMAKE[doc] = "Additional GNU make options." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Additional GNU <filename>make</filename> options. + </para> + + <para> + Because the <filename>EXTRA_OEMAKE</filename> defaults to + "", you need to set the variable to specify any required + GNU options. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_OESCONS'><glossterm>EXTRA_OESCONS</glossterm> + <info> + EXTRA_OESCONS[doc] = "When a recipe inherits the scons class, this variable specifies additional configuration options you want to pass to the scons command line." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-scons'><filename>scons</filename></link> + class, this variable specifies additional configuration + options you want to pass to the + <filename>scons</filename> command line. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-EXTRA_USERS_PARAMS'><glossterm>EXTRA_USERS_PARAMS</glossterm> + <info> + EXTRA_USERS_PARAMS[doc] = "When a recipe inherits the extrausers class, this variable provides image level user and group operations." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-extrausers'><filename>extrausers</filename></link> + class, this variable provides image level user and group + operations. + This is a more global method of providing user and group + configuration as compared to using the + <link linkend='ref-classes-useradd'><filename>useradd</filename></link> + class, which ties user and group configurations to a + specific recipe. + </para> + + <para> + The set list of commands you can configure using the + <filename>EXTRA_USERS_PARAMS</filename> is shown in the + <filename>extrausers</filename> class. + These commands map to the normal Unix commands of the same + names: + <literallayout class='monospaced'> + # EXTRA_USERS_PARAMS = "\ + # useradd -p '' tester; \ + # groupadd developers; \ + # userdel nobody; \ + # groupdel -g video; \ + # groupmod -g 1020 developers; \ + # usermod -s /bin/sh tester; \ + # " + </literallayout> + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-f'><title>F</title> + + <glossentry id='var-FEATURE_PACKAGES'><glossterm>FEATURE_PACKAGES</glossterm> + <info> + FEATURE_PACKAGES[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES. When setting the value, FEATURE_PACKAGES should have the name of the feature item as an override." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines one or more packages to include in an image when + a specific item is included in + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. + When setting the value, <filename>FEATURE_PACKAGES</filename> + should have the name of the feature item as an override. + Here is an example: + <literallayout class='monospaced'> + FEATURE_PACKAGES_widget = "<replaceable>package1</replaceable> <replaceable>package2</replaceable>" + </literallayout> + </para> + + <para> + In this example, if "widget" were added to + <filename>IMAGE_FEATURES</filename>, <replaceable>package1</replaceable> and + <replaceable>package2</replaceable> would be included in the image. + <note> + Packages installed by features defined through + <filename>FEATURE_PACKAGES</filename> are often package + groups. + While similarly named, you should not confuse the + <filename>FEATURE_PACKAGES</filename> variable with + package groups, which are discussed elsewhere in the + documentation. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FEED_DEPLOYDIR_BASE_URI'><glossterm>FEED_DEPLOYDIR_BASE_URI</glossterm> + <info> + FEED_DEPLOYDIR_BASE_URI[doc] = "Allow to serve ipk deploy directory as an ad hoc feed (bogofeed). Set to base URL of the directory as exported by HTTP. Set of ad hoc feed configs will be generated in the image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the base URL of the server and location within + the document-root that provides the metadata and + packages required by OPKG to support runtime package + management of IPK packages. + You set this variable in your + <filename>local.conf</filename> file. + </para> + + <para> + Consider the following example: + <literallayout class='monospaced'> + FEED_DEPLOYDIR_BASE_URI = "http://192.168.7.1/BOARD-dir" + </literallayout> + This example assumes you are serving your packages over + HTTP and your databases are located in a directory + named <filename>BOARD-dir</filename>, which is underneath + your HTTP server's document-root. + In this case, the OpenEmbedded build system generates a set + of configuration files for you in your target that work + with the feed. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FILES'><glossterm>FILES</glossterm> + <info> + FILES[doc] = "The list of directories or files that are placed in packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The list of directories or files that are placed in packages. + </para> + + <para> + To use the <filename>FILES</filename> variable, provide a + package name override that identifies the resulting package. + Then, provide a space-separated list of files or paths + that identify the files you want included as part of the + resulting package. + Here is an example: + <literallayout class='monospaced'> + FILES_${PN} += "${bindir}/mydir1/ ${bindir}/mydir2/myfile" + </literallayout> + </para> + + <note> + When specifying paths as part of the + <filename>FILES</filename> variable, it is good practice + to use appropriate path variables. + For example, use <filename>${sysconfdir}</filename> rather + than <filename>/etc</filename>, or + <filename>${bindir}</filename> rather than + <filename>/usr/bin</filename>. + You can find a list of these variables at the top of the + <filename>meta/conf/bitbake.conf</filename> file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </note> + + <para> + If some of the files you provide with the + <filename>FILES</filename> variable are editable and you + know they should not be overwritten during the package + update process by the Package Management System (PMS), you + can identify these files so that the PMS will not + overwrite them. + See the + <link linkend='var-CONFFILES'><filename>CONFFILES</filename></link> + variable for information on how to identify these files to + the PMS. + </para> + + </glossdef> + </glossentry> + + <glossentry id='var-FILES_SOLIBSDEV'><glossterm>FILES_SOLIBSDEV</glossterm> + <info> + FILES_SOLIBSDEV[doc] = "Defines the full path name of the development symbolic link (symlink) for shared libraries on the target platform." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the file specification to match + <link linkend='var-SOLIBSDEV'><filename>SOLIBSDEV</filename></link>. + In other words, <filename>FILES_SOLIBSDEV</filename> + defines the full path name of the development symbolic link + (symlink) for shared libraries on the target platform. + </para> + + <para> + The following statement from the + <filename>bitbake.conf</filename> shows how it is set: + <literallayout class='monospaced'> + FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm> + <info> + FILESEXTRAPATHS[doc] = "Extends the search path the OpenEmbedded build system uses when looking for files and patches as it processes recipes and append files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Extends the search path the OpenEmbedded build system uses + when looking for files and patches as it processes recipes + and append files. + The default directories BitBake uses when it processes + recipes are initially defined by the + <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> + variable. + You can extend <filename>FILESPATH</filename> variable + by using <filename>FILESEXTRAPATHS</filename>. + </para> + + <para> + Best practices dictate that you accomplish this by using + <filename>FILESEXTRAPATHS</filename> from within a + <filename>.bbappend</filename> file and that you prepend + paths as follows: + <literallayout class='monospaced'> + FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" + </literallayout> + In the above example, the build system first looks for files + in a directory that has the same name as the corresponding + append file. + <note> + <para>When extending <filename>FILESEXTRAPATHS</filename>, + be sure to use the immediate expansion + (<filename>:=</filename>) operator. + Immediate expansion makes sure that BitBake evaluates + <link linkend='var-THISDIR'><filename>THISDIR</filename></link> + at the time the directive is encountered rather than at + some later time when expansion might result in a + directory that does not contain the files you need. + </para> + <para>Also, include the trailing separating colon + character if you are prepending. + The trailing colon character is necessary because you + are directing BitBake to extend the path by prepending + directories to the search path.</para> + </note> + Here is another common use: + <literallayout class='monospaced'> + FILESEXTRAPATHS_prepend := "${THISDIR}/files:" + </literallayout> + In this example, the build system extends the + <filename>FILESPATH</filename> variable to include a + directory named <filename>files</filename> that is in the + same directory as the corresponding append file. + </para> + + <para> + Here is a final example that specifically adds three paths: + <literallayout class='monospaced'> + FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" + </literallayout> + </para> + + <para> + By prepending paths in <filename>.bbappend</filename> + files, you allow multiple append files that reside in + different layers but are used for the same recipe to + correctly extend the path. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FILESOVERRIDES'><glossterm>FILESOVERRIDES</glossterm> + <info> + FILESOVERRIDES[doc] = "A subset of OVERRIDES used by the OpenEmbedded build system for creating FILESPATH." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> + used by the OpenEmbedded build system for creating + <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>. + You can find more information on how overrides are handled + in the + <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake Manual</ulink>. + </para> + + <para> + By default, the <filename>FILESOVERRIDES</filename> + variable is defined as: + <literallayout class='monospaced'> + FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}" + </literallayout> + + <note> + Do not hand-edit the <filename>FILESOVERRIDES</filename> + variable. + The values match up with expected overrides and are + used in an expected manner by the build system. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm> + <info> + FILESPATH[doc] = "The default set of directories the OpenEmbedded build system uses when searching for patches and files. It is defined in the base.bbclass class found in meta/classes in the Source Directory. Do not hand-edit the FILESPATH variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The default set of directories the OpenEmbedded build system + uses when searching for patches and files. + During the build process, BitBake searches each directory in + <filename>FILESPATH</filename> in the specified order when + looking for files and patches specified by each + <filename>file://</filename> URI in a recipe. + </para> + + <para> + The default value for the <filename>FILESPATH</filename> + variable is defined in the <filename>base.bbclass</filename> + class found in <filename>meta/classes</filename> in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: + <literallayout class='monospaced'> + FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ + "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" + </literallayout> + <note> + Do not hand-edit the <filename>FILESPATH</filename> + variable. + If you want the build system to look in directories + other than the defaults, extend the + <filename>FILESPATH</filename> variable by using the + <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> + variable. + </note> + Be aware that the default <filename>FILESPATH</filename> + directories do not map to directories in custom layers + where append files (<filename>.bbappend</filename>) + are used. + If you want the build system to find patches or files + that reside with your append files, you need to extend + the <filename>FILESPATH</filename> variable by using + the + <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FILESYSTEM_PERMS_TABLES'><glossterm>FILESYSTEM_PERMS_TABLES</glossterm> + <info> + FILESYSTEM_PERMS_TABLES[doc] = "Allows you to define your own file permissions settings table as part of your configuration for the packaging process." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Allows you to define your own file permissions settings table as part of + your configuration for the packaging process. + For example, suppose you need a consistent set of custom permissions for + a set of groups and users across an entire work project. + It is best to do this in the packages themselves but this is not always + possible. + </para> + + <para> + By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which + is located in the <filename>meta/files</filename> folder in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + If you create your own file permissions setting table, you should place it in your + layer or the distro's layer. + </para> + + <para> + You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the + <filename>conf/local.conf</filename> file, which is found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, to + point to your custom <filename>fs-perms.txt</filename>. + You can specify more than a single file permissions setting table. + The paths you specify to these files must be defined within the + <link linkend='var-BBPATH'><filename>BBPATH</filename></link> variable. + </para> + + <para> + For guidance on how to create your own file permissions settings table file, + examine the existing <filename>fs-perms.txt</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FONT_EXTRA_RDEPENDS'><glossterm>FONT_EXTRA_RDEPENDS</glossterm> + <info> + FONT_EXTRA_RDEPENDS[doc] = "When a recipe inherits the fontcache class, this variable specifies runtime dependencies for font packages. This variable defaults to 'fontconfig-utils'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link> + class, this variable specifies the runtime dependencies + for font packages. + By default, the <filename>FONT_EXTRA_RDEPENDS</filename> + is set to "fontconfig-utils". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FONT_PACKAGES'><glossterm>FONT_PACKAGES</glossterm> + <info> + FONT_PACKAGES[doc] = "When a recipe inherits the fontcache class, this variable identifies packages containing font files that need to be cached by Fontconfig." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link> + class, this variable identifies packages containing font + files that need to be cached by Fontconfig. + By default, the <filename>fontcache</filename> class assumes + that fonts are in the recipe's main package + (i.e. <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>). + Use this variable if fonts you need are in a package + other than that main package. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm> + <info> + FULL_OPTIMIZATION[doc]= "The options to pass in TARGET_CFLAGS and CFLAGS when compiling an optimized system. This variable defaults to '-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The options to pass in + <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> + and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> + when compiling an optimized system. + This variable defaults to + "-O2 -pipe ${DEBUG_FLAGS}". + </para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id='var-glossary-g'><title>G</title> + + <glossentry id='var-GDB'><glossterm>GDB</glossterm> + <info> + GDB[doc] = "The minimal command and arguments to run the GNU Debugger." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments to run the GNU Debugger. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GITDIR'><glossterm>GITDIR</glossterm> + <info> + GITDIR[doc] = "The directory where Git clones will be stored." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The directory in which a local copy of a Git repository + is stored when it is cloned. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GLIBC_GENERATE_LOCALES'><glossterm>GLIBC_GENERATE_LOCALES</glossterm> + <info> + GLIBC_GENERATE_LOCALES[doc]= "Specifies the list of GLIBC locales to generate should you not wish generate all LIBC locals, which can be time consuming." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the list of GLIBC locales to generate should you + not wish generate all LIBC locals, which can be time + consuming. + <note> + If you specifically remove the locale + <filename>en_US.UTF-8</filename>, you must set + <link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link> + appropriately. + </note> + </para> + + <para> + You can set <filename>GLIBC_GENERATE_LOCALES</filename> + in your <filename>local.conf</filename> file. + By default, all locales are generated. + <literallayout class='monospaced'> + GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GROUPADD_PARAM'><glossterm>GROUPADD_PARAM</glossterm> + <info> + GROUPADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the groupadd command if you wish to add a group to the system when the package is installed." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-useradd'><filename>useradd</filename></link> + class, this variable + specifies for a package what parameters should be passed + to the <filename>groupadd</filename> command + if you wish to add a group to the system when the package + is installed. + </para> + + <para> + Here is an example from the <filename>dbus</filename> + recipe: + <literallayout class='monospaced'> + GROUPADD_PARAM_${PN} = "-r netdev" + </literallayout> + For information on the standard Linux shell command + <filename>groupadd</filename>, see + <ulink url='http://linux.die.net/man/8/groupadd'></ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GROUPMEMS_PARAM'><glossterm>GROUPMEMS_PARAM</glossterm> + <info> + GROUPMEMS_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the groupmems command if you wish to modify the members of a group when the package is installed." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-useradd'><filename>useradd</filename></link> + class, this variable + specifies for a package what parameters should be passed + to the <filename>groupmems</filename> command + if you wish to modify the members of a group when the + package is installed. + </para> + + <para> + For information on the standard Linux shell command + <filename>groupmems</filename>, see + <ulink url='http://linux.die.net/man/8/groupmems'></ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GRUB_GFXSERIAL'><glossterm>GRUB_GFXSERIAL</glossterm> + <info> + GRUB_GFXSERIAL[doc] = "Configures the GNU GRand Unified Bootloader (GRUB) to have graphics and serial in the boot menu." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Configures the GNU GRand Unified Bootloader (GRUB) to have + graphics and serial in the boot menu. + Set this variable to "1" in your + <filename>local.conf</filename> or distribution + configuration file to enable graphics and serial + in the menu. + </para> + + <para> + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GRUB_OPTS'><glossterm>GRUB_OPTS</glossterm> + <info> + GRUB_OPTS[doc] = "Additional options to add to the GNU GRand Unified Bootloader (GRUB) configuration." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Additional options to add to the GNU GRand Unified + Bootloader (GRUB) configuration. + Use a semi-colon character (<filename>;</filename>) to + separate multiple options. + </para> + + <para> + The <filename>GRUB_OPTS</filename> variable is optional. + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GRUB_TIMEOUT'><glossterm>GRUB_TIMEOUT</glossterm> + <info> + GRUB_TIMEOUT[doc] = "Specifies the timeout before executing the default LABEL in the GNU GRand Unified Bootloader (GRUB)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the timeout before executing the default + <filename>LABEL</filename> in the GNU GRand Unified + Bootloader (GRUB). + </para> + + <para> + The <filename>GRUB_TIMEOUT</filename> variable is optional. + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GTKIMMODULES_PACKAGES'><glossterm>GTKIMMODULES_PACKAGES</glossterm> + <info> + GTKIMMODULES_PACKAGES[doc] = "For recipes that inherit the gtk-immodules-cache class, this variable specifies the packages that contain the GTK+ input method modules being installed when the modules are in packages other than the main package." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-gtk-immodules-cache'><filename>gtk-immodules-cache</filename></link> + class, this variable specifies the packages that contain the + GTK+ input method modules being installed when the modules + are in packages other than the main package. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GUMMIBOOT_CFG'><glossterm>GUMMIBOOT_CFG</glossterm> + <info> + GUMMIBOOT_CFG[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_CFG variable specifies the configuration file that should be used." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When + <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> + is set to "gummiboot", the + <filename>GUMMIBOOT_CFG</filename> variable specifies the + configuration file that should be used. + By default, the + <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link> + class sets the <filename>GUMMIBOOT_CFG</filename> as + follows: + <literallayout class='monospaced'> + GUMMIBOOT_CFG ?= "${<link linkend='var-S'>S</link>}/loader.conf" + </literallayout> + </para> + + <para> + For information on Gummiboot, see the + <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GUMMIBOOT_ENTRIES'><glossterm>GUMMIBOOT_ENTRIES</glossterm> + <info> + GUMMIBOOT_ENTRIES[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_ENTRIES variable specifies a list of entry files (*.conf) to be installed containing one boot entry per file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When + <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> + is set to "gummiboot", the + <filename>GUMMIBOOT_ENTRIES</filename> variable specifies + a list of entry files + (<filename>*.conf</filename>) to be installed + containing one boot entry per file. + By default, the + <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link> + class sets the <filename>GUMMIBOOT_ENTRIES</filename> as + follows: + <literallayout class='monospaced'> + GUMMIBOOT_ENTRIES ?= "" + </literallayout> + </para> + + <para> + For information on Gummiboot, see the + <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-GUMMIBOOT_TIMEOUT'><glossterm>GUMMIBOOT_TIMEOUT</glossterm> + <info> + GUMMIBOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "gummiboot", the GUMMIBOOT_TIMEOUT variable specifies the boot menu timeout in seconds." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When + <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> + is set to "gummiboot", the + <filename>GUMMIBOOT_TIMEOUT</filename> variable specifies + the boot menu timeout in seconds. + By default, the + <link linkend='ref-classes-gummiboot'><filename>gummiboot</filename></link> + class sets the <filename>GUMMIBOOT_TIMEOUT</filename> as + follows: + <literallayout class='monospaced'> + GUMMIBOOT_TIMEOUT ?= "10" + </literallayout> + </para> + + <para> + For information on Gummiboot, see the + <ulink url='http://freedesktop.org/wiki/Software/gummiboot/'>Gummiboot documentation</ulink>. + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-h'><title>H</title> + + <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm> + <info> + HOMEPAGE[doc] = "Website where more information about the software the recipe is building can be found." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Website where more information about the software the recipe is building + can be found. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-HOST_ARCH'><glossterm>HOST_ARCH</glossterm> + <info> + HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH." + + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The name of the target architecture, which is normally + the same as + <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>. + The OpenEmbedded build system supports many + architectures. + Here is an example list of architectures supported. + This list is by no means complete as the architecture + is configurable: + <literallayout class='monospaced'> + arm + i586 + x86_64 + powerpc + powerpc64 + mips + mipsel + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-HOST_CC_ARCH'><glossterm>HOST_CC_ARCH</glossterm> + <info> + HOST_CC_ARCH[doc] = "The name of the host architecture. Normally same as the TARGET_CC_ARCH." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies architecture-specific compiler flags that are + passed to the C compiler. + </para> + + <para> + Default initialization for <filename>HOST_CC_ARCH</filename> + varies depending on what is being built: + <itemizedlist> + <listitem><para> + <link linkend='var-TARGET_CC_ARCH'><filename>TARGET_CC_ARCH</filename></link> + when building for the target + </para></listitem> + <listitem><para> + <filename>BUILD_CC_ARCH</filename> + when building for the build host (i.e. + <filename>-native</filename>) + </para></listitem> + <listitem><para> + <filename>BUILDSDK_CC_ARCH</filename> + when building for an SDK (i.e. + <filename>nativesdk-</filename>) + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-HOST_OS'><glossterm>HOST_OS</glossterm> + <info> + HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the name of the target operating system, which + is normally the same as the + <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>. + The variable can be set to "linux" for <filename>glibc</filename>-based systems and + to "linux-uclibc" for <filename>uclibc</filename>. + For ARM/EABI targets, there are also "linux-gnueabi" and + "linux-uclibc-gnueabi" values possible. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-HOST_PREFIX'><glossterm>HOST_PREFIX</glossterm> + <info> + HOST_PREFIX[doc] = "The prefix for the cross compile toolchain. Normally same as the TARGET_PREFIX." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the prefix for the cross-compile toolchain. + <filename>HOST_PREFIX</filename> is normally the same as + <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm> + <info> + HOST_SYS[doc] = "Specifies the system, including the architecture and the operating system, for with the build is occurring in the context of the current recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the system, including the architecture and the + operating system, for which the build is occurring + in the context of the current recipe. + </para> + + <para> + The OpenEmbedded build system automatically sets this + variable based on + <link linkend='var-HOST_ARCH'><filename>HOST_ARCH</filename></link>, + <link linkend='var-HOST_VENDOR'><filename>HOST_VENDOR</filename></link>, + and + <link linkend='var-HOST_OS'><filename>HOST_OS</filename></link> + variables. + <note> + You do not need to set the variable yourself. + </note> + </para> + + <para> + Consider these two examples: + <itemizedlist> + <listitem><para>Given a native recipe on a 32-bit + x86 machine running Linux, the value is + "i686-linux". + </para></listitem> + <listitem><para>Given a recipe being built for a + little-endian MIPS target running Linux, + the value might be "mipsel-linux". + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-HOST_VENDOR'><glossterm>HOST_VENDOR</glossterm> + <info> + HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the name of the vendor. + <filename>HOST_VENDOR</filename> is normally the same as + <link linkend='var-TARGET_PREFIX'><filename>TARGET_VENDOR</filename></link>. + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-i'><title>I</title> + + <glossentry id='var-ICECC_DISABLED'><glossterm>ICECC_DISABLED</glossterm> + <info> + ICECC_DISABLED[doc] = "Disables or enables the icecc (Icecream) function." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Disables or enables the <filename>icecc</filename> + (Icecream) function. + For more information on this function and best practices + for using this variable, see the + "<link linkend='ref-classes-icecc'><filename>icecc.bbclass</filename></link>" + section. + </para> + + <para> + Setting this variable to "1" in your + <filename>local.conf</filename> disables the function: + <literallayout class='monospaced'> + ICECC_DISABLED ??= "1" + </literallayout> + To enable the function, set the variable as follows: + <literallayout class='monospaced'> + ICECC_DISABLED = "" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ICECC_ENV_EXEC'><glossterm>ICECC_ENV_EXEC</glossterm> + <info> + ICECC_ENV_EXEC[doc] = "Points to the icecc-create-env script that you provide." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the <filename>icecc-create-env</filename> script + that you provide. + This variable is used by the + <link linkend='ref-classes-icecc'><filename>icecc</filename></link> + class. + You set this variable in your + <filename>local.conf</filename> file. + </para> + + <para> + If you do not point to a script that you provide, the + OpenEmbedded build system uses the default script provided + by the <filename>icecc-create-env.bb</filename> recipe, + which is a modified version and not the one that comes with + <filename>icecc</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ICECC_PARALLEL_MAKE'><glossterm>ICECC_PARALLEL_MAKE</glossterm> + <info> + ICECC_PARALLEL_MAKE[doc] = "Extra options passed to the make command during the do_compile task that specify parallel compilation." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Extra options passed to the <filename>make</filename> + command during the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + task that specify parallel compilation. + This variable usually takes the form of + "-j <replaceable>x</replaceable>", where + <replaceable>x</replaceable> represents the maximum + number of parallel threads <filename>make</filename> can + run. + <note> + The options passed affect builds on all enabled + machines on the network, which are machines running the + <filename>iceccd</filename> daemon. + </note> + </para> + + <para> + If your enabled machines support multiple cores, + coming up with the maximum number of parallel threads + that gives you the best performance could take some + experimentation since machine speed, network lag, + available memory, and existing machine loads can all + affect build time. + Consequently, unlike the + <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> + variable, there is no rule-of-thumb for setting + <filename>ICECC_PARALLEL_MAKE</filename> to achieve + optimal performance. + </para> + + <para> + If you do not set <filename>ICECC_PARALLEL_MAKE</filename>, + the build system does not use it (i.e. the system does + not detect and assign the number of cores as is done with + <filename>PARALLEL_MAKE</filename>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ICECC_PATH'><glossterm>ICECC_PATH</glossterm> + <info> + ICECC_PATH[doc] = "The location of the icecc binary." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The location of the <filename>icecc</filename> binary. + You can set this variable in your + <filename>local.conf</filename> file. + If your <filename>local.conf</filename> file does not define + this variable, the + <link linkend='ref-classes-icecc'><filename>icecc</filename></link> + class attempts to define it by locating + <filename>icecc</filename> using <filename>which</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ICECC_USER_CLASS_BL'><glossterm>ICECC_USER_CLASS_BL</glossterm> + <info> + ICECC_USER_CLASS_BL[doc] = "Identifies user classes that you do not want the Icecream distributed compile support to consider." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Identifies user classes that you do not want the + Icecream distributed compile support to consider. + This variable is used by the + <link linkend='ref-classes-icecc'><filename>icecc</filename></link> + class. + You set this variable in your + <filename>local.conf</filename> file. + </para> + + <para> + When you list classes using this variable, you are + "blacklisting" them from distributed compilation across + remote hosts. + Any classes you list will be distributed and compiled + locally. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ICECC_USER_PACKAGE_BL'><glossterm>ICECC_USER_PACKAGE_BL</glossterm> + <info> + ICECC_USER_PACKAGE_BL[doc] = "Identifies user recipes that you do not want the Icecream distributed compile support to consider." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Identifies user recipes that you do not want the + Icecream distributed compile support to consider. + This variable is used by the + <link linkend='ref-classes-icecc'><filename>icecc</filename></link> + class. + You set this variable in your + <filename>local.conf</filename> file. + </para> + + <para> + When you list packages using this variable, you are + "blacklisting" them from distributed compilation across + remote hosts. + Any packages you list will be distributed and compiled + locally. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ICECC_USER_PACKAGE_WL'><glossterm>ICECC_USER_PACKAGE_WL</glossterm> + <info> + ICECC_USER_PACKAGE_WL[doc] = "Identifies user recipes that use an empty PARALLEL_MAKE variable that you want to force remote distributed compilation on using the Icecream distributed compile support." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Identifies user recipes that use an empty + <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> + variable that you want to force remote distributed + compilation on using the Icecream distributed compile + support. + This variable is used by the + <link linkend='ref-classes-icecc'><filename>icecc</filename></link> + class. + You set this variable in your + <filename>local.conf</filename> file. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm> + <info> + IMAGE_BASENAME[doc] = "The base name of image output files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The base name of image output files. + This variable defaults to the recipe name + (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_BOOT_FILES'><glossterm>IMAGE_BOOT_FILES</glossterm> + <info> + IMAGE_BOOT_FILES[doc] = "Whitespace separated list of files from ${DEPLOY_DIR_IMAGE} to place in boot partition. Entries will be installed under a same name as the source file. To change the destination file name, pass a desired name after a semicolon (eg. u-boot.img;uboot)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A space-separated list of files installed into the + boot partition when preparing an image using the + <filename>wic</filename> tool with the + <filename>bootimg-partition</filename> source + plugin. + By default, the files are installed under + the same name as the source files. + To change the installed name, separate it from the + original name with a semi-colon (;). + Source files need to be located in + <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>. + Here are two examples: + + <literallayout class="monospaced"> + IMAGE_BOOT_FILES = "u-boot.img uImage;kernel" + IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}" + </literallayout> + </para> + + <para> + Alternatively, source files can be picked up using + a glob pattern. + In this case, the destination file + will have the same name as the base name of the source file + path. + To install files into a directory within the + target location, pass its name after a semi-colon + (;). + Here are two examples: + <literallayout class="monospaced"> + IMAGE_BOOT_FILES = "bcm2835-bootfiles/*" + IMAGE_BOOT_FILES = "bcm2835-bootfiles/*;boot/" + </literallayout> + The first example installs all files from + <filename>${DEPLOY_DIR_IMAGE}/bcm2835-bootfiles</filename> + into the root of the target partition. + The second example installs the same files into a + <filename>boot</filename> directory within the + target partition. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm> + <info> + IMAGE_CLASSES[doc] = "A list of classes that all images should inherit." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of classes that all images should inherit. + You typically use this variable to specify the list of + classes that register the different types of images + the OpenEmbedded build system creates. + </para> + + <para> + The default value for <filename>IMAGE_CLASSES</filename> is + <filename>image_types</filename>. + You can set this variable in your + <filename>local.conf</filename> or in a distribution + configuration file. + </para> + + <para> + For more information, see + <filename>meta/classes/image_types.bbclass</filename> in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_CMD'><glossterm>IMAGE_CMD</glossterm> + <info> + IMAGE_CMD[doc] = "Specifies the command to create the image file for a specific image type, which corresponds to the value set set in IMAGE_FSTYPES, (e.g. ext3, btrfs, and so forth)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the command to create the image file for a + specific image type, which corresponds to the value set + set in + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>, + (e.g. <filename>ext3</filename>, + <filename>btrfs</filename>, and so forth). + When setting this variable, you should use + an override for the associated type. + Here is an example: + <literallayout class='monospaced'> + IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \ + --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \ + ${EXTRA_IMAGECMD}" + </literallayout> + </para> + + <para> + You typically do not need to set this variable unless + you are adding support for a new image type. + For more examples on how to set this variable, see the + <link linkend='ref-classes-image_types'><filename>image_types</filename></link> + class file, which is + <filename>meta/classes/image_types.bbclass</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_DEVICE_TABLES'><glossterm>IMAGE_DEVICE_TABLES</glossterm> + <info> + IMAGE_DEVICE_TABLES[doc] = "Specifies one or more files that contain custom device tables that are passed to the makedevs command as part of creating an image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies one or more files that contain custom device + tables that are passed to the + <filename>makedevs</filename> command as part of creating + an image. + These files list basic device nodes that should be + created under <filename>/dev</filename> within the image. + If <filename>IMAGE_DEVICE_TABLES</filename> is not set, + <filename>files/device_table-minimal.txt</filename> is + used, which is located by + <link linkend='var-BBPATH'><filename>BBPATH</filename></link>. + For details on how you should write device table files, + see <filename>meta/files/device_table-minimal.txt</filename> + as an example. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm> + <info> + IMAGE_FEATURES[doc] = "The primary list of features to include in an image. Configure this variable in an image recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The primary list of features to include in an image. + Typically, you configure this variable in an image recipe. + Although you can use this variable from your + <filename>local.conf</filename> file, which is found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + best practices dictate that you do not. + <note> + To enable extra features from outside the image recipe, + use the + <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. + </note> + </para> + + <para> + For a list of image features that ships with the Yocto + Project, see the + "<link linkend="ref-features-image">Image Features</link>" + section. + </para> + + <para> + For an example that shows how to customize your image by + using this variable, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>" + section in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm> + <info> + IMAGE_FSTYPES[doc] = "Formats of root filesystem images that you want to have created." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the formats the OpenEmbedded build system uses + during the build when creating the root filesystem. + For example, setting <filename>IMAGE_FSTYPES</filename> + as follows causes the build system to create root + filesystems using two formats: <filename>.ext3</filename> + and <filename>.tar.bz2</filename>: + <literallayout class='monospaced'> + IMAGE_FSTYPES = "ext3 tar.bz2" + </literallayout> + </para> + + <para> + For the complete list of supported image formats from which + you can choose, see + <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link>. + </para> + + <note> + If you add "live" to <filename>IMAGE_FSTYPES</filename> + inside an image recipe, be sure that you do so prior to the + "inherit image" line of the recipe or the live image will + not build. + </note> + + <note> + Due to the way this variable is processed, it is not + possible to update its contents using + <filename>_append</filename> or + <filename>_prepend</filename>. To add one or more + additional options to this variable the + <filename>+=</filename> operator must be used. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm> + <info> + IMAGE_INSTALL[doc] = "Specifies the packages to install into an image. Image recipes set IMAGE_INSTALL to specify the packages to install into an image through image.bbclass." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the packages to install into an image. + The <filename>IMAGE_INSTALL</filename> variable is a + mechanism for an image recipe and you should use it + with care to avoid ordering issues. + <note> + When working with an + <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link> + image, do not use the <filename>IMAGE_INSTALL</filename> + variable to specify packages for installation. + Instead, use the + <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link> + variable, which allows the initial RAM disk (initramfs) + recipe to use a fixed set of packages and not be + affected by <filename>IMAGE_INSTALL</filename>. + </note> + </para> + + <para> + Image recipes set <filename>IMAGE_INSTALL</filename> + to specify the packages to install into an image through + <filename>image.bbclass</filename>. + Additionally, "helper" classes exist, such as + <filename>core-image.bbclass</filename>, that can take + <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> + lists and turn these into auto-generated entries in + <filename>IMAGE_INSTALL</filename> in addition to its + default contents. + </para> + + <para> + Using <filename>IMAGE_INSTALL</filename> with the + <filename>+=</filename> operator from the + <filename>/conf/local.conf</filename> file or from within + an image recipe is not recommended as it can cause ordering + issues. + Since <filename>core-image.bbclass</filename> sets + <filename>IMAGE_INSTALL</filename> to a default value using + the <filename>?=</filename> operator, using a + <filename>+=</filename> operation against + <filename>IMAGE_INSTALL</filename> will result in + unexpected behavior when used in + <filename>conf/local.conf</filename>. + Furthermore, the same operation from within an image + recipe may or may not succeed depending on the specific + situation. + In both these cases, the behavior is contrary to how most + users expect the <filename>+=</filename> operator to work. + </para> + + <para> + When you use this variable, it is best to use it as follows: + <literallayout class='monospaced'> + IMAGE_INSTALL_append = " <replaceable>package-name</replaceable>" + </literallayout> + Be sure to include the space between the quotation character + and the start of the package name or names. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_LINGUAS'><glossterm>IMAGE_LINGUAS</glossterm> + <info> + IMAGE_LINGUAS[doc] = "Specifies the list of locales to install into the image during the root filesystem construction process." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the list of locales to install into the image + during the root filesystem construction process. + The OpenEmbedded build system automatically splits locale + files, which are used for localization, into separate + packages. + Setting the <filename>IMAGE_LINGUAS</filename> variable + ensures that any locale packages that correspond to packages + already selected for installation into the image are also + installed. + Here is an example: + <literallayout class='monospaced'> + IMAGE_LINGUAS = "pt-br de-de" + </literallayout> + </para> + + <para> + In this example, the build system ensures any Brazilian + Portuguese and German locale files that correspond to + packages in the image are installed (i.e. + <filename>*-locale-pt-br</filename> + and <filename>*-locale-de-de</filename> as well as + <filename>*-locale-pt</filename> + and <filename>*-locale-de</filename>, since some software + packages only provide locale files by language and not by + country-specific language). + </para> + + <para> + See the + <link linkend='var-GLIBC_GENERATE_LOCALES'><filename>GLIBC_GENERATE_LOCALES</filename></link> + variable for information on generating GLIBC locales. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_MANIFEST'><glossterm>IMAGE_MANIFEST</glossterm> + <info> + IMAGE_MANIFEST[doc] = "The manifest file for the image. This file lists all the installed packages that make up the image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The manifest file for the image. + This file lists all the installed packages that make up + the image. + The file contains package information on a line-per-package + basis as follows: + <literallayout class='monospaced'> + <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable> + </literallayout> + </para> + + <para> + The + <link linkend='ref-classes-image'><filename>image</filename></link> + class defines the manifest file as follows: + <literallayout class='monospaced'> + IMAGE_MANIFEST = "${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest" + </literallayout> + The location is derived using the + <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> + and + <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link> + variables. + You can find information on how the image + is created in the + "<link linkend='image-generation-dev-environment'>Image Generation</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_NAME'><glossterm>IMAGE_NAME</glossterm> + <info> + IMAGE_NAME[doc] = "The name of the output image files minus the extension." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The name of the output image files minus the extension. + This variable is derived using the + <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>, + <link linkend='var-MACHINE'><filename>MACHINE</filename></link>, + and + <link linkend='var-DATETIME'><filename>DATETIME</filename></link> + variables: + <literallayout class='monospaced'> + IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_OVERHEAD_FACTOR'><glossterm>IMAGE_OVERHEAD_FACTOR</glossterm> + <info> + IMAGE_OVERHEAD_FACTOR[doc] = "Defines a multiplier that the build system applies to the initial image size for cases when the multiplier times the returned disk usage value for the image is greater than the sum of IMAGE_ROOTFS_SIZE and IMAGE_ROOTFS_EXTRA_SPACE." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines a multiplier that the build system applies to the initial image + size for cases when the multiplier times the returned disk usage value + for the image is greater than the sum of + <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename> + and + <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>. + The result of the multiplier applied to the initial image size creates + free disk space in the image as overhead. + By default, the build process uses a multiplier of 1.3 for this variable. + This default value results in 30% free disk space added to the image when this + method is used to determine the final generated image size. + You should be aware that post install scripts and the package management + system uses disk space inside this overhead area. + Consequently, the multiplier does not produce an image with + all the theoretical free disk space. + See <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename> + for information on how the build system determines the overall image size. + </para> + + <para> + The default 30% free disk space typically gives the image enough room to boot + and allows for basic post installs while still leaving a small amount of + free disk space. + If 30% free space is inadequate, you can increase the default value. + For example, the following setting gives you 50% free space added to the image: + <literallayout class='monospaced'> + IMAGE_OVERHEAD_FACTOR = "1.5" + </literallayout> + </para> + + <para> + Alternatively, you can ensure a specific amount of free disk space is added + to the image by using the + <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_PKGTYPE'><glossterm>IMAGE_PKGTYPE</glossterm> + <info> + IMAGE_PKGTYPE[doc] = "Defines the package type (DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the package type (DEB, RPM, IPK, or TAR) used + by the OpenEmbedded build system. + The variable is defined appropriately by the + <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>, + <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>, + <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>, + or + <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link> + class. + <note><title>Warning</title> + The <filename>package_tar</filename> class is broken + and is not supported. + It is recommended that you do not use it. + </note> + </para> + + <para> + The + <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_*</filename></link> + and + <link linkend='ref-classes-image'><filename>image</filename></link> + classes use the <filename>IMAGE_PKGTYPE</filename> for + packaging up images and SDKs. + </para> + + <para> + You should not set the <filename>IMAGE_PKGTYPE</filename> + manually. + Rather, the variable is set indirectly through the + appropriate + <link linkend='ref-classes-package'><filename>package_*</filename></link> + class using the + <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> + variable. + The OpenEmbedded build system uses the first package type + (e.g. DEB, RPM, or IPK) that appears with the variable + <note> + Files using the <filename>.tar</filename> format are + never used as a substitute packaging format for DEB, + RPM, and IPK formatted files for your image or SDK. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm> + <info> + IMAGE_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the final image output files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions to call once the + OpenEmbedded build system has created the final image + output files. + You can specify functions separated by semicolons: + <literallayout class='monospaced'> + IMAGE_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " + </literallayout> + </para> + + <para> + If you need to pass the root filesystem path to a command + within the function, you can use + <filename>${IMAGE_ROOTFS}</filename>, which points to + the directory that becomes the root filesystem image. + See the + <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_PREPROCESS_COMMAND'><glossterm>IMAGE_PREPROCESS_COMMAND</glossterm> + <info> + IMAGE_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system has created the final image output files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions to call before the + OpenEmbedded build system has created the final image + output files. + You can specify functions separated by semicolons: + <literallayout class='monospaced'> + IMAGE_PREPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " + </literallayout> + </para> + + <para> + If you need to pass the root filesystem path to a command + within the function, you can use + <filename>${IMAGE_ROOTFS}</filename>, which points to + the directory that becomes the root filesystem image. + See the + <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_ROOTFS'><glossterm>IMAGE_ROOTFS</glossterm> + <info> + IMAGE_ROOTFS[doc] = "The location of the root filesystem while it is under construction (i.e. during do_rootfs)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The location of the root filesystem while it is under + construction (i.e. during the + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + task). + This variable is not configurable. + Do not change it. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_ROOTFS_ALIGNMENT'><glossterm>IMAGE_ROOTFS_ALIGNMENT</glossterm> + <info> + IMAGE_ROOTFS_ALIGNMENT[doc] = "Specifies the alignment for the output image file in Kbytes." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the alignment for the output image file in + Kbytes. + If the size of the image is not a multiple of + this value, then the size is rounded up to the nearest + multiple of the value. + The default value is "1". + See + <link linkend='var-IMAGE_ROOTFS_SIZE'><filename>IMAGE_ROOTFS_SIZE</filename></link> + for additional information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_ROOTFS_EXTRA_SPACE'><glossterm>IMAGE_ROOTFS_EXTRA_SPACE</glossterm> + <info> + IMAGE_ROOTFS_EXTRA_SPACE[doc] = "Defines additional free disk space created in the image in Kbytes. By default, this variable is set to '0'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines additional free disk space created in the image in Kbytes. + By default, this variable is set to "0". + This free disk space is added to the image after the build system determines + the image size as described in + <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>. + </para> + + <para> + This variable is particularly useful when you want to ensure that a + specific amount of free disk space is available on a device after an image + is installed and running. + For example, to be sure 5 Gbytes of free disk space is available, set the + variable as follows: + <literallayout class='monospaced'> + IMAGE_ROOTFS_EXTRA_SPACE = "5242880" + </literallayout> + </para> + + <para> + For example, the Yocto Project Build Appliance specifically requests 40 Gbytes + of extra space with the line: + <literallayout class='monospaced'> + IMAGE_ROOTFS_EXTRA_SPACE = "41943040" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_ROOTFS_SIZE'><glossterm>IMAGE_ROOTFS_SIZE</glossterm> + <info> + IMAGE_ROOTFS_SIZE[doc] = "Defines the size in Kbytes for the generated image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the size in Kbytes for the generated image. + The OpenEmbedded build system determines the final size for the generated + image using an algorithm that takes into account the initial disk space used + for the generated image, a requested size for the image, and requested + additional free disk space to be added to the image. + Programatically, the build system determines the final size of the + generated image as follows: + <literallayout class='monospaced'> + if (image-du * overhead) < rootfs-size: + internal-rootfs-size = rootfs-size + xspace + else: + internal-rootfs-size = (image-du * overhead) + xspace + + where: + + image-du = Returned value of the du command on + the image. + + overhead = IMAGE_OVERHEAD_FACTOR + + rootfs-size = IMAGE_ROOTFS_SIZE + + internal-rootfs-size = Initial root filesystem + size before any modifications. + + xspace = IMAGE_ROOTFS_EXTRA_SPACE + </literallayout> + </para> + + <para> + See the <link linkend='var-IMAGE_OVERHEAD_FACTOR'><filename>IMAGE_OVERHEAD_FACTOR</filename></link> + and <link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'><filename>IMAGE_ROOTFS_EXTRA_SPACE</filename></link> + variables for related information. +<!-- In the above example, <filename>overhead</filename> is defined by the + <filename><link linkend='var-IMAGE_OVERHEAD_FACTOR'>IMAGE_OVERHEAD_FACTOR</link></filename> + variable, <filename>xspace</filename> is defined by the + <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename> + variable, and <filename>du</filename> is the results of the disk usage command + on the initially generated image. --> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_TYPEDEP'><glossterm>IMAGE_TYPEDEP</glossterm> + <info> + IMAGE_TYPEDEP[doc] = "Specifies a dependency from one image type on another." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a dependency from one image type on another. + Here is an example from the + <link linkend='ref-classes-image-live'><filename>image-live</filename></link> + class: + <literallayout class='monospaced'> + IMAGE_TYPEDEP_live = "ext3" + </literallayout> + </para> + + <para> + In the previous example, the variable ensures that when + "live" is listed with the + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + variable, the OpenEmbedded build system produces an + <filename>ext3</filename> image first since one of the + components of the live + image is an <filename>ext3</filename> + formatted partition containing the root + filesystem. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IMAGE_TYPES'><glossterm>IMAGE_TYPES</glossterm> + <info> + IMAGE_TYPES[doc] = "Specifies the complete list of supported image types by default." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the complete list of supported image types + by default: + <literallayout class='monospaced'> + btrfs + cpio + cpio.gz + cpio.lz4 + cpio.lzma + cpio.xz + cramfs + elf + ext2 + ext2.bz2 + ext2.gz + ext2.lzma + ext3 + ext3.gz + ext4 + ext4.gz + hdddirect + hddimg + iso + jffs2 + jffs2.sum + multiubi + qcow2 + squashfs + squashfs-lzo + squashfs-xz + tar + tar.bz2 + tar.gz + tar.lz4 + tar.xz + ubi + ubifs + vdi + vmdk + wic + wic.bz2 + wic.gz + wic.lzma + </literallayout> + </para> + + <para> + For more information about these types of images, see + <filename>meta/classes/image_types*.bbclass</filename> + in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INC_PR'><glossterm>INC_PR</glossterm> + <info> + INC_PR[doc] = "Helps define the recipe revision for recipes that share a common include file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Helps define the recipe revision for recipes that share + a common <filename>include</filename> file. + You can think of this variable as part of the recipe revision + as set from within an include file. + </para> + + <para> + Suppose, for example, you have a set of recipes that + are used across several projects. + And, within each of those recipes the revision + (its <link linkend='var-PR'><filename>PR</filename></link> + value) is set accordingly. + In this case, when the revision of those recipes changes, + the burden is on you to find all those recipes and + be sure that they get changed to reflect the updated + version of the recipe. + In this scenario, it can get complicated when recipes + that are used in many places and provide common functionality + are upgraded to a new revision. + </para> + + <para> + A more efficient way of dealing with this situation is + to set the <filename>INC_PR</filename> variable inside + the <filename>include</filename> files that the recipes + share and then expand the <filename>INC_PR</filename> + variable within the recipes to help + define the recipe revision. + </para> + + <para> + The following provides an example that shows how to use + the <filename>INC_PR</filename> variable + given a common <filename>include</filename> file that + defines the variable. + Once the variable is defined in the + <filename>include</filename> file, you can use the + variable to set the <filename>PR</filename> values in + each recipe. + You will notice that when you set a recipe's + <filename>PR</filename> you can provide more granular + revisioning by appending values to the + <filename>INC_PR</filename> variable: + <literallayout class='monospaced'> +recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" +recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1" +recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0" +recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + </literallayout> + The first line of the example establishes the baseline + revision to be used for all recipes that use the + <filename>include</filename> file. + The remaining lines in the example are from individual + recipes and show how the <filename>PR</filename> value + is set. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INCOMPATIBLE_LICENSE'><glossterm>INCOMPATIBLE_LICENSE</glossterm> + <info> + INCOMPATIBLE_LICENSE[doc] = "Specifies a space-separated list of license names (as they would appear in LICENSE) that should be excluded from the build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a space-separated list of license names + (as they would appear in + <link linkend='var-LICENSE'><filename>LICENSE</filename></link>) + that should be excluded from the build. + Recipes that provide no alternatives to listed incompatible + licenses are not built. + Packages that are individually licensed with the specified + incompatible licenses will be deleted. + </para> + + <note> + This functionality is only regularly tested using + the following setting: + <literallayout class='monospaced'> + INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" + </literallayout> + Although you can use other settings, you might be required + to remove dependencies on or provide alternatives to + components that are required to produce a functional system + image. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> + <info> + INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable is only valid in configuration files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Causes the named class to be inherited at + this point during parsing. + The variable is only valid in configuration files. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INHERIT_DISTRO'><glossterm>INHERIT_DISTRO</glossterm> + <info> + INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists classes that will be inherited at the + distribution level. + It is unlikely that you want to edit this variable. + </para> + + <para> + The default value of the variable is set as follows in the + <filename>meta/conf/distro/defaultsetup.conf</filename> + file: + <literallayout class='monospaced'> + INHERIT_DISTRO ?= "debian devshell sstate license" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm> + <info> + INHIBIT_DEFAULT_DEPS[doc] = "Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to DEPENDS." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Prevents the default dependencies, namely the C compiler + and standard C library (libc), from being added to + <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>. + This variable is usually used within recipes that do not + require any compilation using the C compiler. + </para> + + <para> + Set the variable to "1" to prevent the default dependencies + from being added. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INHIBIT_PACKAGE_DEBUG_SPLIT'><glossterm>INHIBIT_PACKAGE_DEBUG_SPLIT</glossterm> + <info> + INHIBIT_PACKAGE_STRIP[doc] = "If set to "1", causes the build to not strip binaries in resulting packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Prevents the OpenEmbedded build system from splitting + out debug information during packaging. + By default, the build system splits out debugging + information during the + <link linkend='ref-tasks-package'><filename>do_package</filename></link> + task. + For more information on how debug information is split out, + see the + <link linkend='var-PACKAGE_DEBUG_SPLIT_STYLE'><filename>PACKAGE_DEBUG_SPLIT_STYLE</filename></link> + variable. + </para> + + <para> + To prevent the build system from splitting out + debug information during packaging, set the + <filename>INHIBIT_PACKAGE_DEBUG_SPLIT</filename> variable + as follows: + <literallayout class='monospaced'> + INHIBIT_PACKAGE_DEBUG_SPLIT = "1" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm> + <info> + INHIBIT_PACKAGE_STRIP[doc] = "If set to "1", causes the build to not strip binaries in resulting packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + If set to "1", causes the build to not strip binaries in resulting packages. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm> + <info> + INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM disk (initramfs), which is used during boot." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the format for the output image of an initial + RAM disk (initramfs), which is used during boot. + Supported formats are the same as those supported by the + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INITRAMFS_IMAGE'><glossterm>INITRAMFS_IMAGE</glossterm> + <info> + INITRAMFS_IMAGE[doc] = "Causes the OpenEmbedded build system to build an additional recipe as a dependency to your root filesystem recipe (e.g. core-image-sato)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Causes the OpenEmbedded build system to build an additional + recipe as a dependency to your root filesystem recipe + (e.g. <filename>core-image-sato</filename>). + The additional recipe is used to create an initial RAM disk + (initramfs) that might be needed during the initial boot of + the target system to accomplish such things as loading + kernel modules prior to mounting the root file system. + </para> + + <para> + When you set the variable, specify the name of the + initramfs you want created. + The following example, which is set in the + <filename>local.conf</filename> configuration file, causes + a separate recipe to be created that results in an + initramfs image named + <filename>core-image-sato-initramfs.bb</filename> to be + created: + <literallayout class='monospaced'> + INITRAMFS_IMAGE = "core-image-minimal-initramfs" + </literallayout> + By default, the + <link linkend='ref-classes-kernel'><filename>kernel</filename></link> + class sets this variable to a null string as follows: + <literallayout class='monospaced'> + INITRAMFS_IMAGE = "" + </literallayout> + </para> + + <para> + See the + <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended'><filename>local.conf.sample.extended</filename></ulink> + file for additional information. + You can also reference the + <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/kernel.bbclass'><filename>kernel.bbclass</filename></ulink> + file to see how the variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INITRAMFS_IMAGE_BUNDLE'><glossterm>INITRAMFS_IMAGE_BUNDLE</glossterm> + <info> + INITRAMFS_IMAGE_BUNDLE[doc] = "Controls whether or not the image recipe specified by INITRAMFS_IMAGE is run through an extra pass during kernel compilation in order to build a single binary that contains both the kernel image and the initial RAM disk (initramfs)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Controls whether or not the image recipe specified by + <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link> + is run through an extra pass during kernel compilation + in order to build a single binary that contains both the + kernel image and the initial RAM disk (initramfs). + Using an extra compilation pass ensures that when a kernel + attempts to use an initramfs, it does not encounter + circular dependencies should the initramfs include kernel + modules. + </para> + + <para> + The combined binary is deposited into the + <filename>tmp/deploy</filename> directory, which is part + of the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + </para> + + <para> + Setting the variable to "1" in a configuration file causes + the OpenEmbedded build system to make the extra pass during + kernel compilation: + <literallayout class='monospaced'> + INITRAMFS_IMAGE_BUNDLE = "1" + </literallayout> + By default, the + <link linkend='ref-classes-kernel'><filename>kernel</filename></link> + class sets this variable to a null string as follows: + <literallayout class='monospaced'> + INITRAMFS_IMAGE_BUNDLE = "" + </literallayout> + <note> + You must set the + <filename>INITRAMFS_IMAGE_BUNDLE</filename> variable in + a configuration file. + You cannot set the variable in a recipe file. + </note> + See the + <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended'><filename>local.conf.sample.extended</filename></ulink> + file for additional information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INITRD'><glossterm>INITRD</glossterm> + <info> + INITRD[doc] = "Indicates a list of filesystem images to concatenate and use as an initial RAM disk (initrd)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Indicates list of filesystem images to concatenate and use + as an initial RAM disk (<filename>initrd</filename>). + </para> + + <para> + The <filename>INITRD</filename> variable is an optional + variable used with the + <link linkend='ref-classes-image-live'><filename>image-live</filename></link> + class. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INITRD_IMAGE'><glossterm>INITRD_IMAGE</glossterm> + <info> + INITRD_IMAGE[doc] = "When building a "live" bootable image (i.e. when IMAGE_FSTYPES contains "live"), INITRD_IMAGE specifies the image recipe that should be built to provide the initial RAM disk image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When building a "live" bootable image (i.e. when + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + contains "live"), <filename>INITRD_IMAGE</filename> + specifies the image recipe that should be built + to provide the initial RAM disk image. + The default value is "core-image-minimal-initramfs". + </para> + + <para> + See the + <link linkend='ref-classes-image-live'><filename>image-live</filename></link> + class for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm> + <info> + INITSCRIPT_NAME[doc] = "The filename of the initialization script as installed to ${sysconfdir}/init.d." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The filename of the initialization script as installed to + <filename>${sysconfdir}/init.d</filename>. + </para> + + <para> + This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. + The variable is mandatory. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm> + <info> + INITSCRIPT_PACKAGES[doc] = "A list of the packages that contain initscripts. This variable is used in recipes when using update-rc.d.bbclass. The variable is optional and defaults to the PN variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of the packages that contain initscripts. + If multiple packages are specified, you need to append the package name + to the other <filename>INITSCRIPT_*</filename> as an override. + </para> + + <para> + This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. + The variable is optional and defaults to the + <link linkend='var-PN'><filename>PN</filename></link> variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm> + <info> + INITSCRIPT_PARAMS[doc] = "Specifies the options to pass to update-rc.d. The variable is mandatory and is used in recipes when using update-rc.d.bbclass." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the options to pass to <filename>update-rc.d</filename>. + Here is an example: + <literallayout class='monospaced'> + INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ." + </literallayout> + </para> + + <para> + In this example, the script has a runlevel of 99, + starts the script in initlevels 2 and 5, and + stops the script in levels 0, 1 and 6. + </para> + + <para> + The variable's default value is "defaults", which is + set in the + <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> + class. + </para> + + <para> + The value in + <filename>INITSCRIPT_PARAMS</filename> is passed through + to the <filename>update-rc.d</filename> command. + For more information on valid parameters, please see the + <filename>update-rc.d</filename> manual page at + <ulink url='http://www.tin.org/bin/man.cgi?section=8&topic=update-rc.d'></ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INSANE_SKIP'><glossterm>INSANE_SKIP</glossterm> + <info> + INSANE_SKIP[doc] = "Specifies the QA checks to skip for a specific package within a recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the QA checks to skip for a specific package + within a recipe. + For example, to skip the check for symbolic link + <filename>.so</filename> files in the main package of a + recipe, add the following to the recipe. + The package name override must be used, which in this + example is <filename>${PN}</filename>: + <literallayout class='monospaced'> + INSANE_SKIP_${PN} += "dev-so" + </literallayout> + </para> + + <para> + See the "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" + section for a list of the valid QA checks you can + specify using this variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-INSTALL_TIMEZONE_FILE'><glossterm>INSTALL_TIMEZONE_FILE</glossterm> + <info> + INSTALL_TIMEZONE_FILE[doc] = "Enables installation of the /etc/timezone file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + By default, the <filename>tzdata</filename> recipe packages + an <filename>/etc/timezone</filename> file. + Set the <filename>INSTALL_TIMEZONE_FILE</filename> + variable to "0" at the configuration level to disable this + behavior. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-IPK_FEED_URIS'><glossterm>IPK_FEED_URIS</glossterm> + <info> + IPK_FEED_URIS[doc] = "List of ipkg feed records to put into generated image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When the IPK backend is in use and package management + is enabled on the target, you can use this variable to + set up <filename>opkg</filename> in the target image + to point to package feeds on a nominated server. + Once the feed is established, you can perform + installations or upgrades using the package manager + at runtime. + </para> + </glossdef> + </glossentry> + +<!-- + <glossentry id='var-INTERCEPT_DIR'><glossterm>INTERCEPT_DIR</glossterm> + <glossdef> + <para> + An environment variable that defines the directory where + post installation hooks are installed for the + post install environment. + This variable is fixed as follows: + <literallayout class='monospaced'> + ${WORKDIR}/intercept_scripts + </literallayout> + </para> + + <para> + After installation of a target's root filesystem, + post installation scripts, which are essentially bash scripts, + are all executed just a single time. + Limiting execution of these scripts minimizes installation + time that would be lengthened due to certain packages + triggering redundant operations. + For example, consider the installation of font packages + as a common example. + Without limiting the execution of post installation scripts, + all font directories would be rescanned to create the + cache after each individual font package was installed. + </para> + + <para> + Do not edit the <filename>INTERCEPT_DIR</filename> + variable. + </para> + </glossdef> + </glossentry> +--> + + </glossdiv> + +<!-- <glossdiv id='var-glossary-j'><title>J</title>--> +<!-- </glossdiv>--> + + <glossdiv id='var-glossary-k'><title>K</title> + + <glossentry id='var-KARCH'><glossterm>KARCH</glossterm> + <info> + KARCH[doc] = "Defines the kernel architecture used when assembling the configuration. You define the KARCH variable in the BSP Descriptions." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the kernel architecture used when assembling + the configuration. + Architectures supported for this release are: + <literallayout class='monospaced'> + powerpc + i386 + x86_64 + arm + qemu + mips + </literallayout> + </para> + + <para> + You define the <filename>KARCH</filename> variable in the + <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions'>BSP Descriptions</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm> + <info> + KBRANCH[doc] = "A regular expression used by the build process to explicitly identify the kernel branch that is validated, patched and configured during a build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A regular expression used by the build process to explicitly + identify the kernel branch that is validated, patched, + and configured during a build. + You must set this variable to ensure the exact kernel + branch you want is being used by the build process. + </para> + + <para> + Values for this variable are set in the kernel's recipe + file and the kernel's append file. + For example, if you are using the Yocto Project kernel that + is based on the Linux 3.14 kernel, the kernel recipe file + is the + <filename>meta/recipes-kernel/linux/linux-yocto_3.14.bb</filename> + file. + Following is an example for a kernel recipe file: + <literallayout class='monospaced'> + KBRANCH ?= "standard/base" + </literallayout> + </para> + + <para> + This variable is also used from the kernel's append file + to identify the kernel branch specific to a particular + machine or target hardware. + The kernel's append file is located in the BSP layer for + a given machine. + For example, the kernel append file for the Emenlow BSP is in the + <filename>meta-intel</filename> Git repository and is named + <filename>meta-emenlow/recipes-kernel/linux/linux-yocto_3.14.bbappend</filename>. + Here are the related statements from the append file: + <literallayout class='monospaced'> + COMPATIBLE_MACHINE_emenlow-noemgd = "emenlow-noemgd" + KMACHINE_emenlow-noemgd = "emenlow" + KBRANCH_emenlow-noemgd = "standard/base" + KERNEL_FEATURES_append_emenlow-noemgd = " features/drm-gma500/drm-gma500.scc" + </literallayout> + The <filename>KBRANCH</filename> statement identifies + the kernel branch to use when building for the Emenlow + BSP. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KBUILD_DEFCONFIG'><glossterm>KBUILD_DEFCONFIG</glossterm> + <info> + KBUILD_DEFCONFIG[doc] = "Specifies an "in-tree" kernel configuration file for use during a kernel build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When used with the + <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link> + class, specifies an "in-tree" kernel configuration file + for use during a kernel build. + </para> + + <para> + Typically, when using a <filename>defconfig</filename> to + configure a kernel during a build, you place the + file in your layer in the same manner as you would + patch files and configuration fragment files (i.e. + "out-of-tree"). + However, if you want to use a <filename>defconfig</filename> + file that is part of the kernel tree (i.e. "in-tree"), + you can use the + <filename>KBUILD_DEFCONFIG</filename> variable to point + to the <filename>defconfig</filename> file. + </para> + + <para> + To use the variable, set it in the append file for your + kernel recipe using the following form: + <literallayout class='monospaced'> + KBUILD_DEFCONFIG_<link linkend='var-KMACHINE'>KMACHINE</link> ?= <replaceable>defconfig_file</replaceable> + </literallayout> + Here is an example from a "raspberrypi2" + <filename>KMACHINE</filename> build that uses a + <filename>defconfig</filename> file named + "bcm2709_defconfig": + <literallayout class='monospaced'> + KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig" + </literallayout> + As an alternative, you can use the following within your + append file: + <literallayout class='monospaced'> + KBUILD_DEFCONFIG_pn-linux-yocto ?= <replaceable>defconfig_file</replaceable> + </literallayout> + For more information on how to use the + <filename>KBUILD_DEFCONFIG</filename> variable, see the + "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#using-an-in-tree-defconfig-file'>Using an "In-Tree" <filename>defconfig</filename> File</ulink>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_ALT_IMAGETYPE'><glossterm>KERNEL_ALT_IMAGETYPE</glossterm> + <info> + KERNEL_ALT_IMAGETYPE[doc] = "Specifies an alternate kernel image type for creation." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies an alternate kernel image type for creation in + addition to the kernel image type specified using the + <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_CLASSES'><glossterm>KERNEL_CLASSES</glossterm> + <info> + KERNEL_CLASSES[doc] = "A list of classes defining kernel image types that kernel class should inherit." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of classes defining kernel image types that the + <link linkend='ref-classes-kernel'><filename>kernel</filename></link> + class should inherit. + You typically append this variable to enable extended image + types. + An example is the "kernel-fitimage", which enables + fitImage support and resides in + <filename>meta/classes/kernel-fitimage.bbclass</filename>. + You can register custom kernel image types with the + <filename>kernel</filename> class using this variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_DEVICETREE'><glossterm>KERNEL_DEVICETREE</glossterm> + <info> + KERNEL_DEVICETREE[doc] = "Specifies the name of the generated Linux kernel device tree (i.e. the <filename>.dtb</filename>) file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the name of the generated Linux kernel device tree + (i.e. the <filename>.dtb</filename>) file. + <note> + Legacy support exists for specifying the full path + to the device tree. + However, providing just the <filename>.dtb</filename> + file is preferred. + </note> + In order to use this variable, you must have the include + files in your kernel recipe: + <literallayout class='monospaced'> + require recipes-kernel/linux/linux-dtb.inc + </literallayout> + or + <literallayout class='monospaced'> + require recipes-kernel/linux/linux-yocto.inc + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm> + <info> + KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build system passes on when compiling the kernel." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies additional <filename>make</filename> + command-line arguments the OpenEmbedded build system + passes on when compiling the kernel. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm> + <info> + KERNEL_FEATURES[doc] = "Includes additional metadata from the Yocto Project kernel Git repository. The metadata you add through this variable includes config fragments and features descriptions." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Includes additional metadata from the Yocto Project kernel Git repository. + In the OpenEmbedded build system, the default Board Support Packages (BSPs) + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> + is provided through + the <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link> + and <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link> variables. + You can use the <filename>KERNEL_FEATURES</filename> variable to further + add metadata for all BSPs. + </para> + + <para> + The metadata you add through this variable includes config fragments and + features descriptions, + which usually includes patches as well as config fragments. + You typically override the <filename>KERNEL_FEATURES</filename> variable + for a specific machine. + In this way, you can provide validated, but optional, sets of kernel + configurations and features. + </para> + + <para> + For example, the following adds <filename>netfilter</filename> to all + the Yocto Project kernels and adds sound support to the <filename>qemux86</filename> + machine: + <literallayout class='monospaced'> + # Add netfilter to all linux-yocto kernels + KERNEL_FEATURES="features/netfilter/netfilter.scc" + + # Add sound support to the qemux86 machine + KERNEL_FEATURES_append_qemux86=" cfg/sound.scc" + </literallayout></para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_IMAGE_BASE_NAME'><glossterm>KERNEL_IMAGE_BASE_NAME</glossterm> + <info> + KERNEL_IMAGE_BASE_NAME[doc] = "The base name of the kernel image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The base name of the kernel image. + This variable is set in the + <link linkend='ref-classes-kernel'>kernel</link> class + as follows: + <literallayout class='monospaced'> + KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" + </literallayout> + </para> + + <para> + See the + <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link>, + <link linkend='var-PKGE'><filename>PKGE</filename></link>, + <link linkend='var-PKGV'><filename>PKGV</filename></link>, + <link linkend='var-PKGR'><filename>PKGR</filename></link>, + <link linkend='var-MACHINE'><filename>MACHINE</filename></link>, + and + <link linkend='var-DATETIME'><filename>DATETIME</filename></link> + variables for additional information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_IMAGE_MAXSIZE'><glossterm>KERNEL_IMAGE_MAXSIZE</glossterm> + <info> + KERNEL_IMAGE_MAXSIZE[doc] = "The maximum allowable size in kilobytes of the kernel image file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the maximum size of the kernel image file in + kilobytes. + If <filename>KERNEL_IMAGE_MAXSIZE</filename> is set, + the size of the kernel image file is checked against + the set value during the + <link linkend='ref-tasks-sizecheck'><filename>do_sizecheck</filename></link> + task. + The task fails if the kernel image file is larger than + the setting. + </para> + + <para> + <filename>KERNEL_IMAGE_MAXSIZE</filename> is useful for + target devices that have a limited amount of space in + which the kernel image must be stored. + </para> + + <para> + By default, this variable is not set, which means the + size of the kernel image is not checked. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> + <info> + KERNEL_IMAGETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration files and defaults to 'zImage'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The type of kernel to build for a device, usually set by the + machine configuration files and defaults to "zImage". + This variable is used + when building the kernel and is passed to <filename>make</filename> as the target to + build. + </para> + + <para> + If you want to build an alternate kernel image type, use the + <link linkend='var-KERNEL_ALT_IMAGETYPE'><filename>KERNEL_ALT_IMAGETYPE</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_MODULE_AUTOLOAD'><glossterm>KERNEL_MODULE_AUTOLOAD</glossterm> + <info> + KERNEL_MODULE_AUTOLOAD[doc] = "Lists kernel modules that need to be auto-loaded during boot" + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists kernel modules that need to be auto-loaded during + boot. + <note> + This variable replaces the deprecated + <link linkend='var-module_autoload'><filename>module_autoload</filename></link> + variable. + </note> + </para> + + <para> + You can use the <filename>KERNEL_MODULE_AUTOLOAD</filename> + variable anywhere that it can be + recognized by the kernel recipe or by an out-of-tree kernel + module recipe (e.g. a machine configuration file, a + distribution configuration file, an append file for the + recipe, or the recipe itself). + </para> + + <para> + Specify it as follows: + <literallayout class='monospaced'> + KERNEL_MODULE_AUTOLOAD += "<replaceable>module_name1</replaceable> <replaceable>module_name2</replaceable> <replaceable>module_name3</replaceable>" + </literallayout> + </para> + + <para> + Including <filename>KERNEL_MODULE_AUTOLOAD</filename> causes + the OpenEmbedded build system to populate the + <filename>/etc/modules-load.d/modname.conf</filename> + file with the list of modules to be auto-loaded on boot. + The modules appear one-per-line in the file. + Here is an example of the most common use case: + <literallayout class='monospaced'> + KERNEL_MODULE_AUTOLOAD += "<replaceable>module_name</replaceable>" + </literallayout> + </para> + + <para> + For information on how to populate the + <filename>modname.conf</filename> file with + <filename>modprobe.d</filename> syntax lines, see the + <link linkend='var-KERNEL_MODULE_PROBECONF'><filename>KERNEL_MODULE_PROBECONF</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_MODULE_PROBECONF'><glossterm>KERNEL_MODULE_PROBECONF</glossterm> + <info> + KERNEL_MODULE_PROBECONF[doc] = "Lists kernel modules for which the build system expects to find module_conf_* values that specify configuration for each of the modules." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Provides a list of modules for which the OpenEmbedded + build system expects to find + <filename>module_conf_</filename><replaceable>modname</replaceable> + values that specify configuration for each of the modules. + For information on how to provide those module + configurations, see the + <link linkend='var-module_conf'><filename>module_conf_*</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_PATH'><glossterm>KERNEL_PATH</glossterm> + <info> + KERNEL_PATH[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The location of the kernel sources. + This variable is set to the value of the + <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> + within the + <link linkend='ref-classes-module'><filename>module</filename></link> + class. + For information on how this variable is used, see the + "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>" + section. + </para> + + <para> + To help maximize compatibility with out-of-tree drivers + used to build modules, the OpenEmbedded build system also + recognizes and uses the + <link linkend='var-KERNEL_SRC'><filename>KERNEL_SRC</filename></link> + variable, which is identical to the + <filename>KERNEL_PATH</filename> variable. + Both variables are common variables used by external + Makefiles to point to the kernel source directory. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_SRC'><glossterm>KERNEL_SRC</glossterm> + <info> + KERNEL_SRC[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The location of the kernel sources. + This variable is set to the value of the + <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> + within the + <link linkend='ref-classes-module'><filename>module</filename></link> + class. + For information on how this variable is used, see the + "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>" + section. + </para> + + <para> + To help maximize compatibility with out-of-tree drivers + used to build modules, the OpenEmbedded build system also + recognizes and uses the + <link linkend='var-KERNEL_PATH'><filename>KERNEL_PATH</filename></link> + variable, which is identical to the + <filename>KERNEL_SRC</filename> variable. + Both variables are common variables used by external + Makefiles to point to the kernel source directory. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNEL_VERSION'><glossterm>KERNEL_VERSION</glossterm> + <info> + KERNEL_VERSION[doc] = "Specifies the version of the kernel as extracted from version.h or utsrelease.h within the kernel sources." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the version of the kernel as extracted from + <filename>version.h</filename> or + <filename>utsrelease.h</filename> within the kernel sources. + Effects of setting this variable do not take affect until + the kernel has been configured. + Consequently, attempting to refer to this variable in + contexts prior to configuration will not work. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KERNELDEPMODDEPEND'><glossterm>KERNELDEPMODDEPEND</glossterm> + <info> + KERNELDEPMODDEPEND[doc] = "Specifies whether or not to use the data referenced through the PKGDATA_DIR directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies whether the data referenced through + <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> + is needed or not. + The <filename>KERNELDEPMODDEPEND</filename> does not + control whether or not that data exists, + but simply whether or not it is used. + If you do not need to use the data, set the + <filename>KERNELDEPMODDEPEND</filename> variable in your + <filename>initramfs</filename> recipe. + Setting the variable there when the data is not needed + avoids a potential dependency loop. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KFEATURE_DESCRIPTION'><glossterm>KFEATURE_DESCRIPTION</glossterm> + <info> + KFEATURE_DESCRIPTION[doc] = "Provides a short description of a configuration fragment. You use this variable in the .scc file that describes a configuration fragment file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Provides a short description of a configuration fragment. + You use this variable in the <filename>.scc</filename> + file that describes a configuration fragment file. + Here is the variable used in a file named + <filename>smp.scc</filename> to describe SMP being + enabled: + <literallayout class='monospaced'> + define KFEATURE_DESCRIPTION "Enable SMP" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-KMACHINE'><glossterm>KMACHINE</glossterm> + <info> + KMACHINE[doc] = "The machine as known by the kernel." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The machine as known by the kernel. + Sometimes the machine name used by the kernel does not + match the machine name used by the OpenEmbedded build + system. + For example, the machine name that the OpenEmbedded build + system understands as + <filename>core2-32-intel-common</filename> goes by a + different name in the Linux Yocto kernel. + The kernel understands that machine as + <filename>intel-core2-32</filename>. + For cases like these, the <filename>KMACHINE</filename> + variable maps the kernel machine name to the OpenEmbedded + build system machine name. + </para> + + <para> + These mappings between different names occur in the + Yocto Linux Kernel's <filename>meta</filename> branch. + As an example take a look in the + <filename>common/recipes-kernel/linux/linux-yocto_3.19.bbappend</filename> + file: + <literallayout class='monospaced'> + LINUX_VERSION_core2-32-intel-common = "3.19.0" + COMPATIBLE_MACHINE_core2-32-intel-common = "${MACHINE}" + SRCREV_meta_core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974" + SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711" + KMACHINE_core2-32-intel-common = "intel-core2-32" + KBRANCH_core2-32-intel-common = "standard/base" + KERNEL_FEATURES_append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}" + </literallayout> + The <filename>KMACHINE</filename> statement says that + the kernel understands the machine name as + "intel-core2-32". + However, the OpenEmbedded build system understands the + machine as "core2-32-intel-common". + </para> + + </glossdef> + </glossentry> + + <glossentry id='var-KTYPE'><glossterm>KTYPE</glossterm> + <info> + KTYPE[doc] = "Defines the kernel type to be used in assembling the configuration." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the kernel type to be used in assembling the + configuration. + The linux-yocto recipes define "standard", "tiny", + and "preempt-rt" kernel types. + See the + "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#kernel-types'>Kernel Types</ulink>" + section in the Yocto Project Linux Kernel Development + Manual for more information on kernel types. + </para> + + <para> + You define the <filename>KTYPE</filename> variable in the + <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions'>BSP Descriptions</ulink>. + The value you use must match the value used for the + <link linkend='var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></link> + value used by the kernel recipe. + </para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id='var-glossary-l'><title>L</title> + + <glossentry id='var-LABELS'><glossterm>LABELS</glossterm> + <info> + LABELS[doc] = "Provides a list of targets for automatic configuration." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Provides a list of targets for automatic configuration. + </para> + + <para> + See the + <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> + class for more information on how this variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> + <info> + LAYERDEPENDS[doc] = "Lists the layers, separated by spaces, upon which this recipe depends. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists the layers that this recipe depends upon, separated by spaces. + Optionally, you can specify a specific layer version for a dependency + by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3" + to be compared against + <link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_anotherlayer</filename> + in this case). + An error will be produced if any dependency is missing or + the version numbers do not match exactly (if specified). + This variable is used in the <filename>conf/layer.conf</filename> file + and must be suffixed with the name of the specific layer (e.g. + <filename>LAYERDEPENDS_mylayer</filename>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm> + <info> + LAYERDIR[doc] = "When used inside the layer.conf configuration file, this variable provides the path of the current layer." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When used inside the <filename>layer.conf</filename> configuration + file, this variable provides the path of the current layer. + This variable is not available outside of <filename>layer.conf</filename> + and references are expanded immediately when parsing of the file completes. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm> + <info> + LAYERVERSION[doc] = "Optionally specifies the version of a layer as a single number. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Optionally specifies the version of a layer as a single number. + You can use this within + <link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link> + for another layer in order to depend on a specific version + of the layer. + This variable is used in the <filename>conf/layer.conf</filename> file + and must be suffixed with the name of the specific layer (e.g. + <filename>LAYERVERSION_mylayer</filename>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LD'><glossterm>LD</glossterm> + <info> + LD[doc] = "Minimal command and arguments to run the linker." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments used to run the + linker. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LDFLAGS'><glossterm>LDFLAGS</glossterm> + <info> + LDFLAGS[doc] = "Specifies the flags to pass to the linker." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the linker. + This variable is exported to an environment + variable and thus made visible to the software being + built during the compilation step. + </para> + + <para> + Default initialization for <filename>LDFLAGS</filename> + varies depending on what is being built: + <itemizedlist> + <listitem><para> + <link linkend='var-TARGET_LDFLAGS'><filename>TARGET_LDFLAGS</filename></link> + when building for the target + </para></listitem> + <listitem><para> + <link linkend='var-BUILD_LDFLAGS'><filename>BUILD_LDFLAGS</filename></link> + when building for the build host (i.e. + <filename>-native</filename>) + </para></listitem> + <listitem><para> + <link linkend='var-BUILDSDK_LDFLAGS'><filename>BUILDSDK_LDFLAGS</filename></link> + when building for an SDK (i.e. + <filename>nativesdk-</filename>) + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LEAD_SONAME'><glossterm>LEAD_SONAME</glossterm> + <info> + LEAD_SONAME[doc] = "Specifies the lead (or primary) compiled library file (.so) that the debian class applies its naming policy to given a recipe that packages multiple libraries." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the lead (or primary) compiled library file + (<filename>.so</filename>) that the + <link linkend='ref-classes-debian'><filename>debian</filename></link> + class applies its naming policy to given a recipe that + packages multiple libraries. + </para> + + <para> + This variable works in conjunction with the + <filename>debian</filename> class. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm> + <info> + LIC_FILES_CHKSUM[doc] = "Checksums of the license text in the recipe source code." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Checksums of the license text in the recipe source code. + </para> + + <para> + This variable tracks changes in license text of the source + code files. + If the license text is changed, it will trigger a build + failure, which gives the developer an opportunity to review any + license change. + </para> + + <para> + This variable must be defined for all recipes (unless + <link linkend='var-LICENSE'><filename>LICENSE</filename></link> + is set to "CLOSED").</para> + <para>For more information, see the + "<link linkend='usingpoky-configuring-LIC_FILES_CHKSUM'> + Tracking License Changes</link>" section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm> + <info> + LICENSE[doc] = "The list of source licenses for the recipe. The logical operators &, '|', and parentheses can be used." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The list of source licenses for the recipe. + Follow these rules: + <itemizedlist> + <listitem><para>Do not use spaces within individual + license names.</para></listitem> + <listitem><para>Separate license names using + | (pipe) when there is a choice between licenses. + </para></listitem> + <listitem><para>Separate license names using + & (ampersand) when multiple licenses exist + that cover different parts of the source. + </para></listitem> + <listitem><para>You can use spaces between license + names.</para></listitem> + <listitem><para>For standard licenses, use the names + of the files in + <filename>meta/files/common-licenses/</filename> + or the + <link linkend='var-SPDXLICENSEMAP'><filename>SPDXLICENSEMAP</filename></link> + flag names defined in + <filename>meta/conf/licenses.conf</filename>. + </para></listitem> + </itemizedlist> + </para> + + <para> + Here are some examples: + <literallayout class='monospaced'> + LICENSE = "LGPLv2.1 | GPLv3" + LICENSE = "MPL-1 & LGPLv2.1" + LICENSE = "GPLv2+" + </literallayout> + The first example is from the recipes for Qt, which the user + may choose to distribute under either the LGPL version + 2.1 or GPL version 3. + The second example is from Cairo where two licenses cover + different parts of the source code. + The final example is from <filename>sysstat</filename>, + which presents a single license. + </para> + + <para> + You can also specify licenses on a per-package basis to + handle situations where components of the output have + different licenses. + For example, a piece of software whose code is + licensed under GPLv2 but has accompanying documentation + licensed under the GNU Free Documentation License 1.2 could + be specified as follows: + <literallayout class='monospaced'> + LICENSE = "GFDL-1.2 & GPLv2" + LICENSE_${PN} = "GPLv2" + LICENSE_${PN}-doc = "GFDL-1.2" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LICENSE_CREATE_PACKAGE'><glossterm>LICENSE_CREATE_PACKAGE</glossterm> + <info> + LICENSE_CREATE_PACKAGE[doc] = "Creates an extra package (i.e. ${PN}-lic) for each recipe and adds that package to the RRECOMMENDS+${PN}." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Setting <filename>LICENSE_CREATE_PACKAGE</filename> + to "1" causes the OpenEmbedded build system to create + an extra package (i.e. + <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-lic</filename>) + for each recipe and to add those packages to the + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link><filename>_${PN}</filename>. + </para> + + <para> + The <filename>${PN}-lic</filename> package installs a + directory in <filename>/usr/share/licenses</filename> + named <filename>${PN}</filename>, which is the recipe's + base name, and installs files in that directory that + contain license and copyright information (i.e. copies of + the appropriate license files from + <filename>meta/common-licenses</filename> that match the + licenses specified in the + <link linkend='var-LICENSE'><filename>LICENSE</filename></link> + variable of the recipe metadata and copies of files marked + in + <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link> + as containing license text). + </para> + + <para> + For related information on providing license text, see the + <link linkend='var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></link> + variable, the + <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> + variable, and the + "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" + section in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LICENSE_FLAGS'><glossterm>LICENSE_FLAGS</glossterm> + <info> + LICENSE_FLAGS[doc] = "Specifies additional flags for a recipe you must whitelist through LICENSE_FLAGS_WHITELIST in order to allow the recipe to be built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies additional flags for a recipe you must + whitelist through + <link linkend='var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></link> + in order to allow the recipe to be built. + When providing multiple flags, separate them with + spaces. + </para> + + <para> + This value is independent of + <link linkend='var-LICENSE'><filename>LICENSE</filename></link> + and is typically used to mark recipes that might + require additional licenses in order to be used in a + commercial product. + For more information, see the + "<link linkend='enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LICENSE_FLAGS_WHITELIST'><glossterm>LICENSE_FLAGS_WHITELIST</glossterm> + <info> + LICENSE_FLAGS_WHITELIST[doc] = "Lists license flags that when specified in LICENSE_FLAGS within a recipe should not prevent that recipe from being built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists license flags that when specified in + <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link> + within a recipe should not prevent that recipe from being + built. + This practice is otherwise known as "whitelisting" + license flags. + For more information, see the + <link linkend='enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LICENSE_PATH'><glossterm>LICENSE_PATH</glossterm> + <info> + LICENSE_PATH[doc] = "Path to additional licenses used during the build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Path to additional licenses used during the build. + By default, the OpenEmbedded build system uses <filename>COMMON_LICENSE_DIR</filename> + to define the directory that holds common license text used during the build. + The <filename>LICENSE_PATH</filename> variable allows you to extend that + location to other areas that have additional licenses: + <literallayout class='monospaced'> + LICENSE_PATH += "<replaceable>path-to-additional-common-licenses</replaceable>" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LINUX_KERNEL_TYPE'><glossterm>LINUX_KERNEL_TYPE</glossterm> + <info> + LINUX_KERNEL_TYPE[doc] = "Defines the kernel type to be used in assembling the configuration." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the kernel type to be used in assembling the + configuration. + The linux-yocto recipes define "standard", "tiny", and + "preempt-rt" kernel types. + See the + "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#kernel-types'>Kernel Types</ulink>" + section in the Yocto Project Linux Kernel Development + Manual for more information on kernel types. + </para> + + <para> + If you do not specify a + <filename>LINUX_KERNEL_TYPE</filename>, it defaults to + "standard". + Together with + <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link>, + the <filename>LINUX_KERNEL_TYPE</filename> variable + defines the search + arguments used by the kernel tools to find the appropriate + description within the kernel + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> + with which to build out the sources and configuration. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LINUX_VERSION'><glossterm>LINUX_VERSION</glossterm> + <info> + LINUX_VERSION[doc] = "The Linux version from kernel.org on which the Linux kernel image being built using the OpenEmbedded build system is based. You define this variable in the kernel recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The Linux version from <filename>kernel.org</filename> + on which the Linux kernel image being built using the + OpenEmbedded build system is based. + You define this variable in the kernel recipe. + For example, the <filename>linux-yocto-3.4.bb</filename> + kernel recipe found in + <filename>meta/recipes-kernel/linux</filename> + defines the variables as follows: + <literallayout class='monospaced'> + LINUX_VERSION ?= "3.4.24" + </literallayout> + </para> + + <para> + The <filename>LINUX_VERSION</filename> variable is used to + define <link linkend='var-PV'><filename>PV</filename></link> + for the recipe: + <literallayout class='monospaced'> + PV = "${LINUX_VERSION}+git${SRCPV}" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LINUX_VERSION_EXTENSION'><glossterm>LINUX_VERSION_EXTENSION</glossterm> + <info> + LINUX_VERSION_EXTENSION[doc] = "A string extension compiled into the version string of the Linux kernel built with the OpenEmbedded build system. You define this variable in the kernel recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A string extension compiled into the version + string of the Linux kernel built with the OpenEmbedded + build system. + You define this variable in the kernel recipe. + For example, the linux-yocto kernel recipes all define + the variable as follows: + <literallayout class='monospaced'> + LINUX_VERSION_EXTENSION ?= "-yocto-${<link linkend='var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</link>}" + </literallayout> + </para> + + <para> + Defining this variable essentially sets the + Linux kernel configuration item + <filename>CONFIG_LOCALVERSION</filename>, which is visible + through the <filename>uname</filename> command. + Here is an example that shows the extension assuming it + was set as previously shown: + <literallayout class='monospaced'> + $ uname -r + 3.7.0-rc8-custom + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-LOG_DIR'><glossterm>LOG_DIR</glossterm> + <info> + LOG_DIR[doc] = "Specifies the directory to which the OpenEmbedded build system writes overall log files. The default directory is ${TMPDIR}/log" + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the directory to which the OpenEmbedded build + system writes overall log files. + The default directory is <filename>${TMPDIR}/log</filename>. + </para> + + <para> + For the directory containing logs specific to each task, + see the <link linkend='var-T'><filename>T</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-m'><title>M</title> + + <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm> + <info> + MACHINE[doc] = "Specifies the target device for which the image is built. You define MACHINE in the conf/local.conf file in the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the target device for which the image is built. + You define <filename>MACHINE</filename> in the + <filename>local.conf</filename> file found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + By default, <filename>MACHINE</filename> is set to + "qemux86", which is an x86-based architecture machine to + be emulated using QEMU: + <literallayout class='monospaced'> + MACHINE ?= "qemux86" + </literallayout> + </para> + + <para> + The variable corresponds to a machine configuration file of the + same name, through which machine-specific configurations are set. + Thus, when <filename>MACHINE</filename> is set to "qemux86" there + exists the corresponding <filename>qemux86.conf</filename> machine + configuration file, which can be found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + in <filename>meta/conf/machine</filename>. + </para> + + <para> + The list of machines supported by the Yocto Project as + shipped include the following: + <literallayout class='monospaced'> + MACHINE ?= "qemuarm" + MACHINE ?= "qemuarm64" + MACHINE ?= "qemumips" + MACHINE ?= "qemumips64" + MACHINE ?= "qemuppc" + MACHINE ?= "qemux86" + MACHINE ?= "qemux86-64" + MACHINE ?= "genericx86" + MACHINE ?= "genericx86-64" + MACHINE ?= "beaglebone" + MACHINE ?= "mpc8315e-rdb" + MACHINE ?= "edgerouter" + </literallayout> + The last five are Yocto Project reference hardware boards, which + are provided in the <filename>meta-yocto-bsp</filename> layer. + <note>Adding additional Board Support Package (BSP) layers + to your configuration adds new possible settings for + <filename>MACHINE</filename>. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MACHINE_ARCH'><glossterm>MACHINE_ARCH</glossterm> + <info> + MACHINE_ARCH[doc] = "Specifies the name of the machine-specific architecture. This variable is set automatically from MACHINE or TUNE_PKGARCH." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the name of the machine-specific architecture. + This variable is set automatically from + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> + or + <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>. + You should not hand-edit the + <filename>MACHINE_ARCH</filename> variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm> + <info> + MACHINE_ESSENTIAL_EXTRA_RDEPENDS[doc] = "A list of required machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of required machine-specific packages to install as part of + the image being built. + The build process depends on these packages being present. + Furthermore, because this is a "machine essential" variable, the list of + packages are essential for the machine to boot. + The impact of this variable affects images based on + <filename>packagegroup-core-boot</filename>, + including the <filename>core-image-minimal</filename> image. + </para> + + <para> + This variable is similar to the + <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename> + variable with the exception that the image being built has a build + dependency on the variable's list of packages. + In other words, the image will not build if a file in this list is not found. + </para> + + <para> + As an example, suppose the machine for which you are building requires + <filename>example-init</filename> to be run during boot to initialize the hardware. + In this case, you would use the following in the machine's + <filename>.conf</filename> configuration file: + <literallayout class='monospaced'> + MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm> + <info> + MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS[doc] = "A list of recommended machine-specific packages to install as part of the image being built. Because this is a 'machine essential' variable, the list of packages are essential for the machine to boot." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of recommended machine-specific packages to install as part of + the image being built. + The build process does not depend on these packages being present. + However, because this is a "machine essential" variable, the list of + packages are essential for the machine to boot. + The impact of this variable affects images based on + <filename>packagegroup-core-boot</filename>, + including the <filename>core-image-minimal</filename> image. + </para> + + <para> + This variable is similar to the + <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename> + variable with the exception that the image being built does not have a build + dependency on the variable's list of packages. + In other words, the image will still build if a package in this list is not found. + Typically, this variable is used to handle essential kernel modules, whose + functionality may be selected to be built into the kernel rather than as a module, + in which case a package will not be produced. + </para> + + <para> + Consider an example where you have a custom kernel where a specific touchscreen + driver is required for the machine to be usable. + However, the driver can be built as a module or + into the kernel depending on the kernel configuration. + If the driver is built as a module, you want it to be installed. + But, when the driver is built into the kernel, you still want the + build to succeed. + This variable sets up a "recommends" relationship so that in the latter case, + the build will not fail due to the missing package. + To accomplish this, assuming the package for the module was called + <filename>kernel-module-ab123</filename>, you would use the + following in the machine's <filename>.conf</filename> configuration + file: + <literallayout class='monospaced'> + MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123" + </literallayout> + <note> + In this example, the + <filename>kernel-module-ab123</filename> recipe + needs to explicitly set its + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> + variable to ensure that BitBake does not use the + kernel recipe's + <link linkend='var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></link> + variable to satisfy the dependency. + </note> + </para> + + <para> + Some examples of these machine essentials are flash, screen, keyboard, mouse, + or touchscreen drivers (depending on the machine). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm> + <info> + MACHINE_EXTRA_RDEPENDS[doc] = "A list of machine-specific packages to install as part of the image being built that are not essential for the machine to boot. However, the build process for more fully-featured images depends on the packages being present." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of machine-specific packages to install as part of the + image being built that are not essential for the machine to boot. + However, the build process for more fully-featured images + depends on the packages being present. + </para> + + <para> + This variable affects all images based on + <filename>packagegroup-base</filename>, which does not include the + <filename>core-image-minimal</filename> or <filename>core-image-full-cmdline</filename> + images. + </para> + + <para> + The variable is similar to the + <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename> + variable with the exception that the image being built has a build + dependency on the variable's list of packages. + In other words, the image will not build if a file in this list is not found. + </para> + + <para> + An example is a machine that has WiFi capability but is not + essential for the machine to boot the image. + However, if you are building a more fully-featured image, you want to enable + the WiFi. + The package containing the firmware for the WiFi hardware is always + expected to exist, so it is acceptable for the build process to depend upon + finding the package. + In this case, assuming the package for the firmware was called + <filename>wifidriver-firmware</filename>, you would use the following in the + <filename>.conf</filename> file for the machine: + <literallayout class='monospaced'> + MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm> + <info> + MACHINE_EXTRA_RRECOMMENDS[doc] = "A list of machine-specific packages to install as part of the image being built that are not essential for booting the machine. The image being built has no build dependencies on the packages in this list." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of machine-specific packages to install as part of the + image being built that are not essential for booting the machine. + The image being built has no build dependency on this list of packages. + </para> + + <para> + This variable affects only images based on + <filename>packagegroup-base</filename>, which does not include the + <filename>core-image-minimal</filename> or <filename>core-image-full-cmdline</filename> + images. + </para> + + <para> + This variable is similar to the + <filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename> + variable with the exception that the image being built does not have a build + dependency on the variable's list of packages. + In other words, the image will build if a file in this list is not found. + </para> + + <para> + An example is a machine that has WiFi capability but is not essential + For the machine to boot the image. + However, if you are building a more fully-featured image, you want to enable + WiFi. + In this case, the package containing the WiFi kernel module will not be produced + if the WiFi driver is built into the kernel, in which case you still want the + build to succeed instead of failing as a result of the package not being found. + To accomplish this, assuming the package for the module was called + <filename>kernel-module-examplewifi</filename>, you would use the + following in the <filename>.conf</filename> file for the machine: + <literallayout class='monospaced'> + MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> + <info> + MACHINE_FEATURES[doc] = "Specifies the list of hardware features the MACHINE supports." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the list of hardware features the + <link linkend='var-MACHINE'><filename>MACHINE</filename></link> is capable + of supporting. + For related information on enabling features, see the + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>, + <link linkend='var-COMBINED_FEATURES'><filename>COMBINED_FEATURES</filename></link>, + and + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> + variables. + </para> + + <para> + For a list of hardware features supported by the Yocto + Project as shipped, see the + "<link linkend='ref-features-machine'>Machine Features</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MACHINE_FEATURES_BACKFILL'><glossterm>MACHINE_FEATURES_BACKFILL</glossterm> + <info> + MACHINE_FEATURES_BACKFILL[doc] = "Features to be added to MACHINE_FEATURES if not also present in MACHINE_FEATURES_BACKFILL_CONSIDERED. This variable is set in the meta/conf/bitbake.conf file and is not intended to be user-configurable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Features to be added to + <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename> + if not also present in + <filename><link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'>MACHINE_FEATURES_BACKFILL_CONSIDERED</link></filename>. + </para> + + <para> + This variable is set in the <filename>meta/conf/bitbake.conf</filename> file. + It is not intended to be user-configurable. + It is best to just reference the variable to see which machine features are + being backfilled for all machine configurations. + See the "<link linkend='ref-features-backfill'>Feature backfilling</link>" section for + more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><glossterm>MACHINE_FEATURES_BACKFILL_CONSIDERED</glossterm> + <info> + MACHINE_FEATURES_BACKFILL_CONSIDERED[doc] = "Features from MACHINE_FEATURES_BACKFILL that should not be backfilled (i.e. added to MACHINE_FEATURES) during the build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Features from + <filename><link linkend='var-MACHINE_FEATURES_BACKFILL'>MACHINE_FEATURES_BACKFILL</link></filename> + that should not be backfilled (i.e. added to + <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>) + during the build. + See the "<link linkend='ref-features-backfill'>Feature backfilling</link>" section for + more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm> + <info> + MACHINEOVERRIDES[doc] = "Lists overrides specific to the current machine. By default, this list includes the value of MACHINE." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists overrides specific to the current machine. + By default, this list includes the value + of <filename><link linkend='var-MACHINE'>MACHINE</link></filename>. + You can extend the list to apply variable overrides for + classes of machines. + For example, all QEMU emulated machines (e.g. qemuarm, + qemux86, and so forth) include a common file named + <filename>meta/conf/machine/include/qemu.inc</filename> + that prepends <filename>MACHINEOVERRIDES</filename> with + the following variable override: + <literallayout class='monospaced'> + MACHINEOVERRIDES =. "qemuall:" + </literallayout> + </para> + + <para> + Applying an override like <filename>qemuall</filename> + affects all QEMU emulated machines elsewhere. + Here is an example from the + <filename>connman-conf</filename> recipe: + <literallayout class='monospaced'> + SRC_URI_append_qemuall = "file://wired.config \ + file://wired-setup \ + " + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm> + <info> + MAINTAINER[doc] = "The email address of the distribution maintainer." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The email address of the distribution maintainer. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MIRRORS'><glossterm>MIRRORS</glossterm> + <info> + MIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies additional paths from which the OpenEmbedded + build system gets source code. + When the build system searches for source code, it first + tries the local download directory. + If that location fails, the build system tries locations + defined by + <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>, + the upstream source, and then locations specified by + <filename>MIRRORS</filename> in that order. + </para> + + <para> + Assuming your distribution + (<link linkend='var-DISTRO'><filename>DISTRO</filename></link>) + is "poky", the default value for + <filename>MIRRORS</filename> is defined in the + <filename>conf/distro/poky.conf</filename> file in the + <filename>meta-poky</filename> Git repository. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MLPREFIX'><glossterm>MLPREFIX</glossterm> + <info> + MLPREFIX[doc] = "Specifies a prefix has been added to PN to create a special version of a recipe or package, such as a Multilib version." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a prefix has been added to + <link linkend='var-PN'><filename>PN</filename></link> to create a special version + of a recipe or package, such as a Multilib version. + The variable is used in places where the prefix needs to be + added to or removed from a the name (e.g. the + <link linkend='var-BPN'><filename>BPN</filename></link> variable). + <filename>MLPREFIX</filename> gets set when a prefix has been + added to <filename>PN</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-module_autoload'><glossterm>module_autoload</glossterm> + <info> + module_autoload[doc] = "This variable has been replaced by the KERNEL_MODULE_AUTOLOAD variable. You should replace all occurrences of module_autoload with additions to KERNEL_MODULE_AUTOLOAD." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable has been replaced by the + <filename>KERNEL_MODULE_AUTOLOAD</filename> variable. + You should replace all occurrences of + <filename>module_autoload</filename> with additions to + <filename>KERNEL_MODULE_AUTOLOAD</filename>, for example: + <literallayout class='monospaced'> + module_autoload_rfcomm = "rfcomm" + </literallayout> + </para> + + <para> + should now be replaced with: + <literallayout class='monospaced'> + KERNEL_MODULE_AUTOLOAD += "rfcomm" + </literallayout> + See the + <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-module_conf'><glossterm>module_conf</glossterm> + <info> + module_conf[doc] = "Specifies modprobe.d syntax lines for inclusion in the /etc/modprobe.d/modname.conf file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies + <ulink url='http://linux.die.net/man/5/modprobe.d'><filename>modprobe.d</filename></ulink> + syntax lines for inclusion in the + <filename>/etc/modprobe.d/modname.conf</filename> file. + </para> + + <para> + You can use this variable anywhere that it can be + recognized by the kernel recipe or out-of-tree kernel + module recipe (e.g. a machine configuration file, a + distribution configuration file, an append file for the + recipe, or the recipe itself). + If you use this variable, you must also be sure to list + the module name in the + <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> + variable. + </para> + + <para> + Here is the general syntax: + <literallayout class='monospaced'> + module_conf_<replaceable>module_name</replaceable> = "<replaceable>modprobe.d-syntax</replaceable>" + </literallayout> + You must use the kernel module name override. + </para> + + <para> + Run <filename>man modprobe.d</filename> in the shell to + find out more information on the exact syntax + you want to provide with <filename>module_conf</filename>. + </para> + + <para> + Including <filename>module_conf</filename> causes the + OpenEmbedded build system to populate the + <filename>/etc/modprobe.d/modname.conf</filename> + file with <filename>modprobe.d</filename> syntax lines. + Here is an example that adds the options + <filename>arg1</filename> and <filename>arg2</filename> + to a module named <filename>mymodule</filename>: + <literallayout class='monospaced'> + module_conf_mymodule = "options mymodule arg1=val1 arg2=val2" + </literallayout> + </para> + + <para> + For information on how to specify kernel modules to + auto-load on boot, see the + <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MODULE_IMAGE_BASE_NAME'><glossterm>MODULE_IMAGE_BASE_NAME</glossterm> + <info> + MODULE_IMAGE_BASE_NAME[doc] = "The base name of the kernel modules tarball." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The base name of the kernel modules tarball. + This variable is set in the + <link linkend='ref-classes-kernel'>kernel</link> class + as follows: + <literallayout class='monospaced'> + MODULE_IMAGE_BASE_NAME ?= "modules-${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" + </literallayout> + </para> + + <para> + See the + <link linkend='var-PKGE'><filename>PKGE</filename></link>, + <link linkend='var-PKGV'><filename>PKGV</filename></link>, + <link linkend='var-PKGR'><filename>PKGR</filename></link>, + <link linkend='var-MACHINE'><filename>MACHINE</filename></link>, + and + <link linkend='var-DATETIME'><filename>DATETIME</filename></link> + variables for additional information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm> + <info> + MODULE_TARBALL_DEPLOY[doc] = "Controls creation of the modules-*.tgz file. Set this variable to "0" to disable creation of this file, which contains all of the kernel modules resulting from a kernel build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Controls creation of the <filename>modules-*.tgz</filename> + file. + Set this variable to "0" to disable creation of this + file, which contains all of the kernel modules resulting + from a kernel build. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-MULTIMACH_TARGET_SYS'><glossterm>MULTIMACH_TARGET_SYS</glossterm> + <info> + MULTIMACH_TARGET_SYS[doc] = "Separates files for different machines such that you can build for multiple target machines using the same output directories." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Separates files for different machines such that you can build + for multiple target machines using the same output directories. + See the <link linkend='var-STAMP'><filename>STAMP</filename></link> variable + for an example. + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-n'><title>N</title> + + <glossentry id='var-NATIVELSBSTRING'><glossterm>NATIVELSBSTRING</glossterm> + <info> + NATIVELSBSTRING[doc] = "A string identifying the host distribution." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A string identifying the host distribution. + Strings consist of the host distributor ID + followed by the release, as reported by the + <filename>lsb_release</filename> tool + or as read from <filename>/etc/lsb-release</filename>. + For example, when running a build on Ubuntu 12.10, the value + is "Ubuntu-12.10". + If this information is unable to be determined, the value + resolves to "Unknown". + </para> + + <para> + This variable is used by default to isolate native shared + state packages for different distributions (e.g. to avoid + problems with <filename>glibc</filename> version + incompatibilities). + Additionally, the variable is checked against + <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link> + if that variable is set. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-NM'><glossterm>NM</glossterm> + <info> + NM[doc] = "Minimal command and arguments to run 'nm'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments to run + <filename>nm</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-NO_RECOMMENDATIONS'><glossterm>NO_RECOMMENDATIONS</glossterm> + <info> + NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Realize that some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Prevents installation of all "recommended-only" packages. + Recommended-only packages are packages installed only + through the + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> + variable). + Setting the <filename>NO_RECOMMENDATIONS</filename> variable + to "1" turns this feature on: + <literallayout class='monospaced'> + NO_RECOMMENDATIONS = "1" + </literallayout> + </para> + + <para> + You can set this variable globally in your + <filename>local.conf</filename> file or you can attach it to + a specific image recipe by using the recipe name override: + <literallayout class='monospaced'> + NO_RECOMMENDATIONS_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>" + </literallayout> + </para> + + <para> + It is important to realize that if you choose to not install + packages using this variable and some other packages are + dependent on them (i.e. listed in a recipe's + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + variable), the OpenEmbedded build system ignores your + request and will install the packages to avoid dependency + errors. + <note> + Some recommended packages might be required for certain + system functionality, such as kernel modules. + It is up to you to add packages with the + <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link> + variable. + </note> + </para> + + <para> + Support for this variable exists only when using the + IPK and RPM packaging backend. + Support does not exist for DEB. + </para> + + <para> + See the + <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link> + and the + <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link> + variables for related information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-NOHDD'><glossterm>NOHDD</glossterm> + <info> + NOHDD[doc] = "Causes the OpenEmbedded build system to skip building the .hddimg image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Causes the OpenEmbedded build system to skip building the + <filename>.hddimg</filename> image. + The <filename>NOHDD</filename> variable is used with the + <link linkend='ref-classes-image-live'><filename>image-live</filename></link> + class. + Set the variable to "1" to prevent the + <filename>.hddimg</filename> image from being built. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-NOISO'><glossterm>NOISO</glossterm> + <info> + NOISO[doc] = "Causes the OpenEmbedded build system to skip building the ISO image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Causes the OpenEmbedded build system to skip building the + ISO image. + The <filename>NOISO</filename> variable is used with the + <link linkend='ref-classes-image-live'><filename>image-live</filename></link> + class. + Set the variable to "1" to prevent the ISO image from + being built. + To enable building an ISO image, set the variable to "0". + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-o'><title>O</title> + + <glossentry id='var-OBJCOPY'><glossterm>OBJCOPY</glossterm> + <info> + OBJCOPY[doc] = "Minimal command and arguments to run 'objcopy'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments to run + <filename>objcopy</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-OBJDUMP'><glossterm>OBJDUMP</glossterm> + <info> + OBJDUMP[doc] = "Minimal command and arguments to run 'objdump'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments to run + <filename>objdump</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm>OE_BINCONFIG_EXTRA_MANGLE</glossterm> + <info> + OE_BINCONFIG_EXTRA_MANGLE[doc] = "When a recipe inherits the binconfig.bbclass class, this variable specifies additional arguments passed to the "sed" command." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> + class, this variable + specifies additional arguments passed to the "sed" command. + The sed command alters any paths in configuration scripts + that have been set up during compilation. + Inheriting this class results in all paths in these scripts + being changed to point into the + <filename>sysroots/</filename> directory so that all builds + that use the script will use the correct directories + for the cross compiling layout. + </para> + + <para> + See the <filename>meta/classes/binconfig.bbclass</filename> + in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + for details on how this class applies these additional + sed command arguments. + For general information on the + <filename>binconfig.bbclass</filename> class, see the + "<link linkend='ref-classes-binconfig'>Binary Configuration Scripts - <filename>binconfig.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-OE_IMPORTS'><glossterm>OE_IMPORTS</glossterm> + <info> + OE_IMPORTS[doc] = "An internal variable used to tell the OpenEmbedded build system what Python modules to import for every Python function run by the system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + An internal variable used to tell the OpenEmbedded build + system what Python modules to import for every Python + function run by the system. + </para> + + <note> + Do not set this variable. + It is for internal use only. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-OE_INIT_ENV_SCRIPT'><glossterm>OE_INIT_ENV_SCRIPT</glossterm> + <info> + OE_INIT_ENV_SCRIPT[doc] = "The name of the build environment setup script for the purposes of setting up the environment within the extensible SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The name of the build environment setup script for the + purposes of setting up the environment within the + extensible SDK. + The default value is "oe-init-build-env". + </para> + + <para> + If you use a custom script to set up your build + environment, set the + <filename>OE_INIT_ENV_SCRIPT</filename> variable to its + name. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm> + <info> + OE_TERMINAL[doc] = "Controls how the OpenEmbedded build system spawns interactive terminals on the host development system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Controls how the OpenEmbedded build system spawns + interactive terminals on the host development system + (e.g. using the BitBake command with the + <filename>-c devshell</filename> command-line option). + For more information, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section + in the Yocto Project Development Manual. + </para> + + <para> + You can use the following values for the + <filename>OE_TERMINAL</filename> variable: + <literallayout class='monospaced'> + auto + gnome + xfce + rxvt + screen + konsole + none + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-OEROOT'><glossterm>OEROOT</glossterm> + <info> + OEROOT[doc] = "The directory from which the top-level build environment setup script is sourced." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The directory from which the top-level build environment + setup script is sourced. + The Yocto Project makes two top-level build environment + setup scripts available: + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + and + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>. + When you run one of these scripts, the + <filename>OEROOT</filename> variable resolves to the + directory that contains the script. + </para> + + <para> + For additional information on how this variable is used, + see the initialization scripts. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-OLDEST_KERNEL'><glossterm>OLDEST_KERNEL</glossterm> + <info> + OLDEST_KERNEL[doc] = "Declares the oldest version of the Linux kernel that the produced binaries must support." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Declares the oldest version of the Linux kernel that the + produced binaries must support. + This variable is passed into the build of the Embedded + GNU C Library (<filename>glibc</filename>). + </para> + + <para> + The default for this variable comes from the + <filename>meta/conf/bitbake.conf</filename> configuration + file. + You can override this default by setting the variable + in a custom distribution configuration file. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-OVERRIDES'><glossterm>OVERRIDES</glossterm> + <info> + OVERRIDES[doc] = "BitBake uses OVERRIDES to control what variables are overridden after BitBake parses recipes and configuration files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + BitBake uses <filename>OVERRIDES</filename> to control + what variables are overridden after BitBake parses + recipes and configuration files. + You can find more information on how overrides are handled + in the + "<ulink url='&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides'>Conditional Syntax (Overrides)</ulink>" + section of the BitBake User Manual. + </para> + </glossdef> + </glossentry> + </glossdiv> + + <glossdiv id='var-glossary-p'><title>P</title> + + <glossentry id='var-P'><glossterm>P</glossterm> + <info> + P[doc] = "The recipe name and version. P is comprised of ${PN}-${PV}." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The recipe name and version. + <filename>P</filename> is comprised of the following: + <literallayout class='monospaced'> + ${PN}-${PV} + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm> + <info> + PACKAGE_ARCH[doc] = "The architecture of the resulting package or packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The architecture of the resulting package or packages. + </para> + + <para> + By default, the value of this variable is set to + <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link> + when building for the target, + <filename>BUILD_ARCH</filename> when building for the + build host and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building + for the SDK. + However, if your recipe's output packages are built + specific to the target machine rather than general for + the architecture of the machine, you should set + <filename>PACKAGE_ARCH</filename> to the value of + <link linkend='var-MACHINE_ARCH'><filename>MACHINE_ARCH</filename></link> + in the recipe as follows: + <literallayout class='monospaced'> + PACKAGE_ARCH = "${MACHINE_ARCH}" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_ARCHS'><glossterm>PACKAGE_ARCHS</glossterm> + <info> + PACKAGE_ARCHS[doc] = "A list of architectures compatible with the given target in order of priority." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of architectures compatible with + the target machine. + This variable is set automatically and should not + normally be hand-edited. + Entries are separated using spaces and listed in order + of priority. + The default value for + <filename>PACKAGE_ARCHS</filename> is "all any noarch + ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_BEFORE_PN'><glossterm>PACKAGE_BEFORE_PN</glossterm> + <info> + PACKAGE_BEFORE_PN[doc] = "Enables easily adding packages to PACKAGES before ${PN} so that the packages can pick up files that would normally be included in the default package." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Enables easily adding packages to + <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> + before <filename>${<link linkend='var-PN'>PN</link>}</filename> + so that those added packages can pick up files that would normally be + included in the default package. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm> + <info> + PACKAGE_CLASSES[doc] = "This variable specifies the package manager to use when packaging data. It is set in the conf/local.conf file in the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable, which is set in the + <filename>local.conf</filename> configuration file found in + the <filename>conf</filename> folder of the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + specifies the package manager the OpenEmbedded build system + uses when packaging data. + </para> + + <para> + You can provide one or more of the following arguments for + the variable: + <literallayout class='monospaced'> + PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar" + </literallayout> + <note><title>Warning</title> + While it is a legal option, the + <filename>package_tar</filename> class is broken + and is not supported. + It is recommended that you do not use it. + </note> + The build system uses only the first argument in the list + as the package manager when creating your image or SDK. + However, packages will be created using any additional + packaging classes you specify. + For example, if you use the following in your + <filename>local.conf</filename> file: + <literallayout class='monospaced'> + PACKAGE_CLASSES ?= "package_ipk" + </literallayout> + The OpenEmbedded build system uses the IPK package manager + to create your image or SDK. + </para> + + <para> + For information on packaging and build performance effects + as a result of the package manager in use, see the + "<link linkend='ref-classes-package'><filename>package.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_DEBUG_SPLIT_STYLE'><glossterm>PACKAGE_DEBUG_SPLIT_STYLE</glossterm> + <info> + PACKAGE_DEBUG_SPLIT_STYLE[doc] = "Determines how to split up the binary and debug information when creating *-dbg packages to be used with the GNU Project Debugger (GDB)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Determines how to split up the binary and debug information + when creating <filename>*-dbg</filename> packages to be + used with the GNU Project Debugger (GDB). + </para> + + <para> + With the + <filename>PACKAGE_DEBUG_SPLIT_STYLE</filename> variable, + you can control where debug information, which can include + or exclude source files, is stored: + <itemizedlist> + <listitem><para> + ".debug": Debug symbol files are placed next + to the binary in a <filename>.debug</filename> + directory on the target. + For example, if a binary is installed into + <filename>/bin</filename>, the corresponding debug + symbol files are installed in + <filename>/bin/.debug</filename>. + Source files are placed in + <filename>/usr/src/debug</filename>. + This is the default behavior. + </para></listitem> + <listitem><para> + "debug-file-directory": Debug symbol files are + placed under <filename>/usr/lib/debug</filename> + on the target, and separated by the path from where + the binary is installed. + For example, if a binary is installed in + <filename>/bin</filename>, the corresponding debug + symbols are installed in + <filename>/usr/lib/debug/bin</filename>. + Source files are placed in + <filename>/usr/src/debug</filename>. + </para></listitem> + <listitem><para> + "debug-without-src": The same behavior as + ".debug" previously described with the exception + that no source files are installed. + </para></listitem>. + </itemizedlist> + </para> + + <para> + You can find out more about debugging using GDB by reading + the + "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" + section in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_EXCLUDE_COMPLEMENTARY'><glossterm>PACKAGE_EXCLUDE_COMPLEMENTARY</glossterm> + <info> + PACKAGE_EXCLUDE_COMPLEMENTARY[doc] = "Prevents specific packages from being installed when you are installing complementary packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Prevents specific packages from being installed when + you are installing complementary packages. + </para> + + <para> + You might find that you want to prevent installing certain + packages when you are installing complementary packages. + For example, if you are using + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> + to install <filename>dev-pkgs</filename>, you might not want + to install all packages from a particular multilib. + If you find yourself in this situation, you can use the + <filename>PACKAGE_EXCLUDE_COMPLEMENTARY</filename> variable + to specify regular expressions to match the packages you + want to exclude. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_EXCLUDE'><glossterm>PACKAGE_EXCLUDE</glossterm> + <info> + PACKAGE_EXCLUDE[doc] = "Packages to exclude from the installation. If a listed package is required, an error is generated." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists packages that should not be installed into an image. + For example: + <literallayout class='monospaced'> + PACKAGE_EXCLUDE = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..." + </literallayout> + </para> + + <para> + You can set this variable globally in your + <filename>local.conf</filename> file or you can attach it to + a specific image recipe by using the recipe name override: + <literallayout class='monospaced'> + PACKAGE_EXCLUDE_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>" + </literallayout> + </para> + + <para> + If you choose to not install + a package using this variable and some other package is + dependent on it (i.e. listed in a recipe's + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + variable), the OpenEmbedded build system generates a fatal + installation error. + Because the build system halts the process with a fatal + error, you can use the variable with an iterative + development process to remove specific components from a + system. + </para> + + <para> + Support for this variable exists only when using the + IPK and RPM packaging backend. + Support does not exist for DEB. + </para> + + <para> + See the + <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link> + and the + <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link> + variables for related information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm> + <info> + PACKAGE_EXTRA_ARCHS[doc] = "Specifies the list of architectures compatible with the device CPU. This variable is useful when you build for several different devices that use miscellaneous processors." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the list of architectures compatible with the device CPU. + This variable is useful when you build for several different devices that use + miscellaneous processors such as XScale and ARM926-EJS. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_FEED_ARCHS'><glossterm>PACKAGE_FEED_ARCHS</glossterm> + <info> + PACKAGE_FEED_ARCHS[doc] = "Specifies user-defined package architectures when constructing package feed URIs." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the package architectures used as part of the + package feed URIs during the build. + The <filename>PACKAGE_FEED_ARCHS</filename> variable is + appended to the final package feed URI, which is constructed + using the + <link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link> + and + <link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link> + variables. + </para> + + <para> + Consider the following example where the + <filename>PACKAGE_FEED_URIS</filename>, + <filename>PACKAGE_FEED_BASE_PATHS</filename>, and + <filename>PACKAGE_FEED_ARCHS</filename> variables are + defined in your <filename>local.conf</filename> file: + <literallayout class='monospaced'> + PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \ + https://example.com/packagerepos/updates" + PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev" + PACKAGE_FEED_ARCHS = "all core2-64" + </literallayout> + Given these settings, the resulting package feeds are + as follows: + <literallayout class='monospaced'> + https://example.com/packagerepos/release/rpm/all + https://example.com/packagerepos/release/rpm/core2-64 + https://example.com/packagerepos/release/rpm-dev/all + https://example.com/packagerepos/release/rpm-dev/core2-64 + https://example.com/packagerepos/updates/rpm/all + https://example.com/packagerepos/updates/rpm/core2-64 + https://example.com/packagerepos/updates/rpm-dev/all + https://example.com/packagerepos/updates/rpm-dev/core2-64 + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_FEED_BASE_PATHS'><glossterm>PACKAGE_FEED_BASE_PATHS</glossterm> + <info> + PACKAGE_FEED_BASE_PATHS[doc] = "Specifies base path used when constructing package feed URIs." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the base path used when constructing package feed + URIs. + The <filename>PACKAGE_FEED_BASE_PATHS</filename> variable + makes up the middle portion of a package feed URI used + by the OpenEmbedded build system. + The base path lies between the + <link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link> + and + <link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link> + variables. + </para> + + <para> + Consider the following example where the + <filename>PACKAGE_FEED_URIS</filename>, + <filename>PACKAGE_FEED_BASE_PATHS</filename>, and + <filename>PACKAGE_FEED_ARCHS</filename> variables are + defined in your <filename>local.conf</filename> file: + <literallayout class='monospaced'> + PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \ + https://example.com/packagerepos/updates" + PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev" + PACKAGE_FEED_ARCHS = "all core2-64" + </literallayout> + Given these settings, the resulting package feeds are + as follows: + <literallayout class='monospaced'> + https://example.com/packagerepos/release/rpm/all + https://example.com/packagerepos/release/rpm/core2-64 + https://example.com/packagerepos/release/rpm-dev/all + https://example.com/packagerepos/release/rpm-dev/core2-64 + https://example.com/packagerepos/updates/rpm/all + https://example.com/packagerepos/updates/rpm/core2-64 + https://example.com/packagerepos/updates/rpm-dev/all + https://example.com/packagerepos/updates/rpm-dev/core2-64 + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_FEED_URIS'><glossterm>PACKAGE_FEED_URIS</glossterm> + <info> + PACKAGE_FEED_URIS[doc] = "Specifies the front portion of the package feed URI used by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the front portion of the package feed URI + used by the OpenEmbedded build system. + Each final package feed URI is comprised of + <filename>PACKAGE_FEED_URIS</filename>, + <link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link>, + and + <link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link> + variables. + </para> + + <para> + Consider the following example where the + <filename>PACKAGE_FEED_URIS</filename>, + <filename>PACKAGE_FEED_BASE_PATHS</filename>, and + <filename>PACKAGE_FEED_ARCHS</filename> variables are + defined in your <filename>local.conf</filename> file: + <literallayout class='monospaced'> + PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \ + https://example.com/packagerepos/updates" + PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev" + PACKAGE_FEED_ARCHS = "all core2-64" + </literallayout> + Given these settings, the resulting package feeds are + as follows: + <literallayout class='monospaced'> + https://example.com/packagerepos/release/rpm/all + https://example.com/packagerepos/release/rpm/core2-64 + https://example.com/packagerepos/release/rpm-dev/all + https://example.com/packagerepos/release/rpm-dev/core2-64 + https://example.com/packagerepos/updates/rpm/all + https://example.com/packagerepos/updates/rpm/core2-64 + https://example.com/packagerepos/updates/rpm-dev/all + https://example.com/packagerepos/updates/rpm-dev/core2-64 + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm> + <info> + PACKAGE_GROUP[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The <filename>PACKAGE_GROUP</filename> variable has been + renamed to + <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link>. + See the variable description for + <filename>FEATURE_PACKAGES</filename> for information. + </para> + + <para> + If if you use the <filename>PACKAGE_GROUP</filename> + variable, the OpenEmbedded build system issues a warning + message. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_INSTALL'><glossterm>PACKAGE_INSTALL</glossterm> + <info> + PACKAGE_INSTALL[doc] = "List of the packages to be installed into the image. The variable is generally not user-defined and uses IMAGE_INSTALL as part of the list." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The final list of packages passed to the package manager + for installation into the image. + </para> + + <para> + Because the package manager controls actual installation + of all packages, the list of packages passed using + <filename>PACKAGE_INSTALL</filename> is not the final list + of packages that are actually installed. + This variable is internal to the image construction + code. + Consequently, in general, you should use the + <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link> + variable to specify packages for installation. + The exception to this is when working with + the + <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link> + image. + When working with an initial RAM disk (initramfs) + image, use the <filename>PACKAGE_INSTALL</filename> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_INSTALL_ATTEMPTONLY'><glossterm>PACKAGE_INSTALL_ATTEMPTONLY</glossterm> + <info> + PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed when creating an image. If a listed package fails to install, the build system does not generate an error. This variable is generally not user-defined." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of packages the OpenEmbedded build + system attempts to install when creating an image. + If a listed package fails to install, the build system + does not generate an error. + This variable is generally not user-defined. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGE_PREPROCESS_FUNCS'><glossterm>PACKAGE_PREPROCESS_FUNCS</glossterm> + <info> + PACKAGE_PREPROCESS_FUNCS[doc] = "Specifies a list of functions run to pre-process the PKGD directory prior to splitting the files out to individual packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions run to pre-process the + <link linkend='var-PKGD'><filename>PKGD</filename></link> + directory prior to splitting the files out to individual + packages. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGECONFIG'><glossterm>PACKAGECONFIG</glossterm> + <info> + PACKAGECONFIG[doc] = "This variable provides a means of enabling or disabling features of a recipe on a per-recipe basis." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable provides a means of enabling or disabling + features of a recipe on a per-recipe basis. + <filename>PACKAGECONFIG</filename> blocks are defined + in recipes when you specify features and then arguments + that define feature behaviors. + Here is the basic block structure: + <literallayout class='monospaced'> + PACKAGECONFIG ??= "f1 f2 f3 ..." + PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1" + PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2" + PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3" + </literallayout> + </para> + + <para> + The <filename>PACKAGECONFIG</filename> + variable itself specifies a space-separated list of the + features to enable. + Following the features, you can determine the behavior of + each feature by providing up to four order-dependent + arguments, which are separated by commas. + You can omit any argument you like but must retain the + separating commas. + The order is important and specifies the following: + <orderedlist> + <listitem><para>Extra arguments + that should be added to the configure script + argument list + (<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>) + if the feature is enabled.</para></listitem> + <listitem><para>Extra arguments + that should be added to <filename>EXTRA_OECONF</filename> + if the feature is disabled. + </para></listitem> + <listitem><para>Additional build dependencies + (<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>) + that should be added if the feature is enabled. + </para></listitem> + <listitem><para>Additional runtime dependencies + (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) + that should be added if the feature is enabled. + </para></listitem> + </orderedlist> + </para> + + <para> + Consider the following + <filename>PACKAGECONFIG</filename> block taken from the + <filename>librsvg</filename> recipe. + In this example the feature is <filename>croco</filename>, + which has three arguments that determine the feature's + behavior. + <literallayout class='monospaced'> + PACKAGECONFIG ??= "croco" + PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco" + </literallayout> + The <filename>--with-croco</filename> and + <filename>libcroco</filename> arguments apply only if + the feature is enabled. + In this case, <filename>--with-croco</filename> is + added to the configure script argument list and + <filename>libcroco</filename> is added to + <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>. + On the other hand, if the feature is disabled say through + a <filename>.bbappend</filename> file in another layer, then + the second argument <filename>--without-croco</filename> is + added to the configure script rather than + <filename>--with-croco</filename>. + </para> + + <para> + The basic <filename>PACKAGECONFIG</filename> structure + previously described holds true regardless of whether you + are creating a block or changing a block. + When creating a block, use the structure inside your + recipe. + </para> + + <para> + If you want to change an existing + <filename>PACKAGECONFIG</filename> block, you can do so + one of two ways: + <itemizedlist> + <listitem><para><emphasis>Append file:</emphasis> + Create an append file named + <replaceable>recipename</replaceable><filename>.bbappend</filename> + in your layer and override the value of + <filename>PACKAGECONFIG</filename>. + You can either completely override the variable: + <literallayout class='monospaced'> + PACKAGECONFIG="f4 f5" + </literallayout> + Or, you can just append the variable: + <literallayout class='monospaced'> + PACKAGECONFIG_append = " f4" + </literallayout></para></listitem> + <listitem><para><emphasis>Configuration file:</emphasis> + This method is identical to changing the block + through an append file except you edit your + <filename>local.conf</filename> or + <filename><replaceable>mydistro</replaceable>.conf</filename> file. + As with append files previously described, + you can either completely override the variable: + <literallayout class='monospaced'> + PACKAGECONFIG_pn-<replaceable>recipename</replaceable>="f4 f5" + </literallayout> + Or, you can just amend the variable: + <literallayout class='monospaced'> + PACKAGECONFIG_append_pn-<replaceable>recipename</replaceable> = " f4" + </literallayout></para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGEGROUP_DISABLE_COMPLEMENTARY'><glossterm>PACKAGEGROUP_DISABLE_COMPLEMENTARY</glossterm> + <info> + PACKAGEGROUP_DISABLE_COMPLEMENTARY[doc] = "Prevents automatic creation of the normal complementary packages such as -dev and -dbg in a packagegroup recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + For recipes inheriting the + <link linkend='ref-classes-packagegroup'><filename>packagegroup</filename></link> + class, setting + <filename>PACKAGEGROUP_DISABLE_COMPLEMENTARY</filename> to + "1" specifies that the normal complementary packages + (i.e. <filename>-dev</filename>, + <filename>-dbg</filename>, and so forth) should not be + automatically created by the + <filename>packagegroup</filename> recipe, which is the + default behavior. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> + <info> + PACKAGES[doc] = "The list of packages to be created from the recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The list of packages to be created from the recipe. + The default value is the following: + <literallayout class='monospaced'> + ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGES_DYNAMIC'><glossterm>PACKAGES_DYNAMIC</glossterm> + <info> + PACKAGES_DYNAMIC[doc] = "A promise that your recipe satisfies runtime dependencies for optional modules that are found in other recipes." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A promise that your recipe satisfies runtime dependencies + for optional modules that are found in other recipes. + <filename>PACKAGES_DYNAMIC</filename> + does not actually satisfy the dependencies, it only states that + they should be satisfied. + For example, if a hard, runtime dependency + (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) + of another package is satisfied + at build time through the <filename>PACKAGES_DYNAMIC</filename> + variable, but a package with the module name is never actually + produced, then the other package will be broken. + Thus, if you attempt to include that package in an image, + you will get a dependency failure from the packaging system + during the + <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> + task. + </para> + + <para> + Typically, if there is a chance that such a situation can + occur and the package that is not created is valid + without the dependency being satisfied, then you should use + <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> + (a soft runtime dependency) instead of + <filename>RDEPENDS</filename>. + </para> + + <para> + For an example of how to use the <filename>PACKAGES_DYNAMIC</filename> + variable when you are splitting packages, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#handling-optional-module-packaging'>Handling Optional Module Packaging</ulink>" section + in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PACKAGESPLITFUNCS'><glossterm>PACKAGESPLITFUNCS</glossterm> + <info> + PACKAGESPLITFUNCS[doc] = "Specifies a list of functions run to perform additional splitting of files into individual packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions run to perform additional + splitting of files into individual packages. + Recipes can either prepend to this variable or prepend + to the <filename>populate_packages</filename> function + in order to perform additional package splitting. + In either case, the function should set + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>, + <link linkend='var-FILES'><filename>FILES</filename></link>, + <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> + and other packaging variables appropriately in order to + perform the desired splitting. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm> + <info> + PARALLEL_MAKE[doc] = "Specifies extra options that are passed to the make command during the compile tasks. This variable is usually in the form -j x, where x represents the maximum number of parallel threads make can run." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Extra options passed to the <filename>make</filename> + command during the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + task in order to specify parallel compilation on the local + build host. + This variable is usually in the form "-j <replaceable>x</replaceable>", + where <replaceable>x</replaceable> represents the maximum + number of parallel threads <filename>make</filename> can + run. + </para> + + <para> + By default, the OpenEmbedded build system automatically + sets this variable to be equal to the number of cores the + build system uses. + <note> + If the software being built experiences dependency + issues during the <filename>do_compile</filename> + task that result in race conditions, you can clear + the <filename>PARALLEL_MAKE</filename> variable within + the recipe as a workaround. + For information on addressing race conditions, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#debugging-parallel-make-races'>Debugging Parallel Make Races</ulink>" + section in the Yocto Project Development Manual. + </note> + For single socket systems (i.e. one CPU), you should not + have to override this variable to gain optimal parallelism + during builds. + However, if you have very large systems that employ + multiple physical CPUs, you might want to make sure the + <filename>PARALLEL_MAKE</filename> variable is not + set higher than "-j 20". + </para> + + <para> + For more information on speeding up builds, see the + "<link linkend='speeding-up-the-build'>Speeding Up the Build</link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PARALLEL_MAKEINST'><glossterm>PARALLEL_MAKEINST</glossterm> + <info> + PARALLEL_MAKEINST[doc] = "Extra options passed to the make install command during the do_install task in order to specify parallel installation." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Extra options passed to the + <filename>make install</filename> command during the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task in order to specify parallel installation. + This variable defaults to the value of + <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>. + <note> + If the software being built experiences dependency + issues during the + <filename>do_install</filename> task that result in + race conditions, you can clear the + <filename>PARALLEL_MAKEINST</filename> variable within + the recipe as a workaround. + For information on addressing race conditions, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#debugging-parallel-make-races'>Debugging Parallel Make Races</ulink>" + section in the Yocto Project Development Manual. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PATCHRESOLVE'><glossterm>PATCHRESOLVE</glossterm> + <info> + PATCHRESOLVE[doc] = "Enable or disable interactive patch resolution." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Determines the action to take when a patch fails. + You can set this variable to one of two values: "noop" and + "user". + </para> + + <para> + The default value of "noop" causes the build to simply fail + when the OpenEmbedded build system cannot successfully + apply a patch. + Setting the value to "user" causes the build system to + launch a shell and places you in the right location so that + you can manually resolve the conflicts. + </para> + + <para> + Set this variable in your + <filename>local.conf</filename> file. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PATCHTOOL'><glossterm>PATCHTOOL</glossterm> + <info> + PATCHTOOL[doc] = "Specifies the utility used to apply patches for a recipe during do_patch." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the utility used to apply patches for a recipe + during the + <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> + task. + You can specify one of three utilities: "patch", "quilt", or + "git". + The default utility used is "quilt" except for the + quilt-native recipe itself. + Because the quilt tool is not available at the + time quilt-native is being patched, it uses "patch". + </para> + + <para> + If you wish to use an alternative patching tool, set the + variable in the recipe using one of the following: + <literallayout class='monospaced'> + PATCHTOOL = "patch" + PATCHTOOL = "quilt" + PATCHTOOL = "git" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PE'><glossterm>PE</glossterm> + <info> + PE[doc] = "The epoch of the recipe. The default value is '0'. The field is used to make upgrades possible when the versioning scheme changes in some backwards incompatible way." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The epoch of the recipe. + By default, this variable is unset. + The variable is used to make upgrades possible when the + versioning scheme changes in some backwards incompatible + way. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PF'><glossterm>PF</glossterm> + <info> + PF[doc] = "Specifies the recipe or package name and includes all version and revision numbers. This variable is comprised of ${PN}-${EXTENDPE}${PV}-${PR}." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the recipe or package name and includes all version and revision + numbers (i.e. <filename>glibc-2.13-r20+svnr15508/</filename> and + <filename>bash-4.2-r1/</filename>). + This variable is comprised of the following: + <literallayout class='monospaced'> + ${<link linkend='var-PN'>PN</link>}-${<link linkend='var-EXTENDPE'>EXTENDPE</link>}${<link linkend='var-PV'>PV</link>}-${<link linkend='var-PR'>PR</link>} + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PIXBUF_PACKAGES'><glossterm>PIXBUF_PACKAGES</glossterm> + <info> + PIXBUF_PACKAGES[doc] = "When a recipe inherits the pixbufcache class, this variable identifies packages that contain the pixbuf loaders used with gdk-pixbuf." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-pixbufcache'><filename>pixbufcache</filename></link> + class, this variable identifies packages that contain + the pixbuf loaders used with + <filename>gdk-pixbuf</filename>. + By default, the <filename>pixbufcache</filename> class + assumes that the loaders are in the recipe's main package + (i.e. <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>). + Use this variable if the loaders you need are in a package + other than that main package. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PKG'><glossterm>PKG</glossterm> + <info> + PKG[doc] = "The name of the resulting package created by the OpenEmbedded build system. When you use this variable, you must use a package name override." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The name of the resulting package created by the + OpenEmbedded build system. + <note> + When using the <filename>PKG</filename> variable, you + must use a package name override. + </note> + </para> + + <para> + For example, when the + <link linkend='ref-classes-debian'><filename>debian</filename></link> + class renames the output package, it does so by setting + <filename>PKG_<replaceable>packagename</replaceable></filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PKG_CONFIG_PATH'><glossterm>PKG_CONFIG_PATH</glossterm> + <info> + PKG_CONFIG_PATH[doc] = "Path to pkg-config files for the current build context." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The path to <filename>pkg-config</filename> files for the + current build context. + <filename>pkg-config</filename> reads this variable + from the environment. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PKGD'><glossterm>PKGD</glossterm> + <info> + PKGD[doc] = "Points to the destination directory for files to be packaged before they are split into individual packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the destination directory for files to be + packaged before they are split into individual packages. + This directory defaults to the following: + <literallayout class='monospaced'> + ${WORKDIR}/package + </literallayout> + </para> + + <para> + Do not change this default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PKGDATA_DIR'><glossterm>PKGDATA_DIR</glossterm> + <info> + PKGDATA_DIR[doc] = "Points to a shared, global-state directory that holds data generated during the packaging process." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to a shared, global-state directory that holds data + generated during the packaging process. + During the packaging process, the + <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link> + task packages data for each recipe and installs it into + this temporary, shared area. + This directory defaults to the following: + <literallayout class='monospaced'> + ${STAGING_DIR_HOST}/pkgdata + </literallayout> + </para> + + <para> + Do not change this default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PKGDEST'><glossterm>PKGDEST</glossterm> + <info> + PKGDEST[doc] = "Points to the parent directory for files to be packaged after they have been split into individual packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the parent directory for files to be packaged + after they have been split into individual packages. + This directory defaults to the following: + <literallayout class='monospaced'> + ${WORKDIR}/packages-split + </literallayout> + </para> + + <para> + Under this directory, the build system creates + directories for each package specified in + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>. + Do not change this default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PKGDESTWORK'><glossterm>PKGDESTWORK</glossterm> + <info> + PKGDESTWORK[doc] = "Points to a temporary work area used by the do_package task to write output from the do_packagedata task." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to a temporary work area used by the + <link linkend='ref-tasks-package'><filename>do_package</filename></link> + task to write output from the + <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link> + task. + The <filename>PKGDESTWORK</filename> location defaults to + the following: + <literallayout class='monospaced'> + ${WORKDIR}/pkgdata + </literallayout> + </para> + + <para> + The <filename>do_packagedata</filename> task then packages + the data in the temporary work area and installs it into a + shared directory pointed to by + <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>. + </para> + + <para> + Do not change this default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PKGE'><glossterm>PKGE</glossterm> + <info> + PKGE[doc] = "The epoch of the output package built by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The epoch of the output package built by the + OpenEmbedded build system. + By default, <filename>PKGE</filename> is set to + <link linkend='var-PE'><filename>PE</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PKGR'><glossterm>PKGR</glossterm> + <info> + PKGR[doc] = "The revision of the output package built by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The revision of the output package built by the + OpenEmbedded build system. + By default, <filename>PKGR</filename> is set to + <link linkend='var-PR'><filename>PR</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PKGV'><glossterm>PKGV</glossterm> + <info> + PKGV[doc] = "The version of the output package built by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The version of the output package built by the + OpenEmbedded build system. + By default, <filename>PKGV</filename> is set to + <link linkend='var-PV'><filename>PV</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PN'><glossterm>PN</glossterm> + <info> + PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. It refers to a package name in the context of a file created or produced by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable can have two separate functions depending on the context: a recipe + name or a resulting package name. + </para> + + <para> + <filename>PN</filename> refers to a recipe name in the context of a file used + by the OpenEmbedded build system as input to create a package. + The name is normally extracted from the recipe file name. + For example, if the recipe is named + <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename> + will be "expat". + </para> + + <para> + The variable refers to a package name in the context of a file created or produced by the + OpenEmbedded build system. + </para> + + <para> + If applicable, the <filename>PN</filename> variable also contains any special + suffix or prefix. + For example, using <filename>bash</filename> to build packages for the native + machine, <filename>PN</filename> is <filename>bash-native</filename>. + Using <filename>bash</filename> to build packages for the target and for Multilib, + <filename>PN</filename> would be <filename>bash</filename> and + <filename>lib64-bash</filename>, respectively. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PNBLACKLIST'><glossterm>PNBLACKLIST</glossterm> + <info> + PNBLACKLIST[doc] = "Lists recipes you do not want the OpenEmbedded build system to build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists recipes you do not want the OpenEmbedded build system + to build. + This variable works in conjunction with the + <link linkend='ref-classes-blacklist'><filename>blacklist</filename></link> + class, which the recipe must inherit globally. + </para> + + <para> + To prevent a recipe from being built, inherit the class + globally and use the variable in your + <filename>local.conf</filename> file. + Here is an example that prevents + <filename>myrecipe</filename> from being built: + <literallayout class='monospaced'> + INHERIT += "blacklist" + PNBLACKLIST[myrecipe] = "Not supported by our organization." + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-POPULATE_SDK_POST_HOST_COMMAND'><glossterm>POPULATE_SDK_POST_HOST_COMMAND</glossterm> + <info> + POPULATE_SDK_POST_HOST_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created host part of the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions to call once the + OpenEmbedded build system has created the host part of + the SDK. + You can specify functions separated by semicolons: + <literallayout class='monospaced'> + POPULATE_SDK_POST_HOST_COMMAND += "<replaceable>function</replaceable>; ... " + </literallayout> + </para> + + <para> + If you need to pass the SDK path to a command + within a function, you can use + <filename>${SDK_DIR}</filename>, which points to + the parent directory used by the OpenEmbedded build + system when creating SDK output. + See the + <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-POPULATE_SDK_POST_TARGET_COMMAND'><glossterm>POPULATE_SDK_POST_TARGET_COMMAND</glossterm> + <info> + POPULATE_SDK_POST_TARGET_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created target part of the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions to call once the + OpenEmbedded build system has created the target part of + the SDK. + You can specify functions separated by semicolons: + <literallayout class='monospaced'> + POPULATE_SDK_POST_TARGET_COMMAND += "<replaceable>function</replaceable>; ... " + </literallayout> + </para> + + <para> + If you need to pass the SDK path to a command + within a function, you can use + <filename>${SDK_DIR}</filename>, which points to + the parent directory used by the OpenEmbedded build + system when creating SDK output. + See the + <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PR'><glossterm>PR</glossterm> + <info> + PR[doc] = "The revision of the recipe. The default value for this variable is 'r0'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The revision of the recipe. + The default value for this variable is "r0". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm> + <info> + PREFERRED_PROVIDER[doc] = "If multiple recipes provide an item, this variable determines which recipe should be given preference." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + If multiple recipes provide an item, this variable + determines which recipe should be given preference. + You should always suffix the variable with the name of the + provided item, and you should set it to the + <link linkend='var-PN'><filename>PN</filename></link> + of the recipe to which you want to give precedence. + Some examples: + <literallayout class='monospaced'> + PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" + PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" + PREFERRED_PROVIDER_virtual/libgl ?= "mesa" + </literallayout> + <note> + If you set <filename>PREFERRED_PROVIDER</filename> + for a <filename>virtual/*</filename> item, then any + recipe that + <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> + that item that is not selected by + <filename>PREFERRED_PROVIDER</filename> is prevented + from building, which is usually desirable since this + mechanism is designed to select between mutually + exclusive alternative providers. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm> + <info> + PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + If there are multiple versions of recipes available, this + variable determines which recipe should be given preference. + You must always suffix the variable with the + <link linkend='var-PN'><filename>PN</filename></link> + you want to select, and you should set the + <link linkend='var-PV'><filename>PV</filename></link> + accordingly for precedence. + You can use the "<filename>%</filename>" character as a + wildcard to match any number of characters, which can be + useful when specifying versions that contain long revision + numbers that could potentially change. + Here are two examples: + <literallayout class='monospaced'> + PREFERRED_VERSION_python = "2.7.3" + PREFERRED_VERSION_linux-yocto = "3.19%" + </literallayout> + Sometimes the <filename>PREFERRED_VERSION</filename> + variable can be set by configuration files in a way that + is hard to change. + You can use + <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> + to set a machine-specific override. + Here is an example: + <literallayout class='monospaced'> + PREFERRED_VERSION_linux-yocto_qemux86 = "3.4%" + </literallayout> + Although not recommended, worst case, you can also use the + "forcevariable" override, which is the strongest override + possible. + Here is an example: + <literallayout class='monospaced'> + PREFERRED_VERSION_linux-yocto_forcevariable = "3.4%" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PREMIRRORS'><glossterm>PREMIRRORS</glossterm> + <info> + PREMIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies additional paths from which the OpenEmbedded + build system gets source code. + When the build system searches for source code, it first + tries the local download directory. + If that location fails, the build system tries locations + defined by <filename>PREMIRRORS</filename>, the upstream + source, and then locations specified by + <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> + in that order. + </para> + + <para> + Assuming your distribution + (<link linkend='var-DISTRO'><filename>DISTRO</filename></link>) + is "poky", the default value for + <filename>PREMIRRORS</filename> is defined in the + <filename>conf/distro/poky.conf</filename> file in the + <filename>meta-poky</filename> Git repository. + </para> + + <para> + Typically, you could add a specific server for the + build system to attempt before any others by adding + something like the following to the + <filename>local.conf</filename> configuration file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + <literallayout class='monospaced'> + PREMIRRORS_prepend = "\ + git://.*/.* http://www.yoctoproject.org/sources/ \n \ + ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ + http://.*/.* http://www.yoctoproject.org/sources/ \n \ + https://.*/.* http://www.yoctoproject.org/sources/ \n" + </literallayout> + These changes cause the build system to intercept + Git, FTP, HTTP, and HTTPS requests and direct them to + the <filename>http://</filename> sources mirror. + You can use <filename>file://</filename> URLs to point + to local directories or network shares as well. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PRIORITY'><glossterm>PRIORITY</glossterm> + <info> + PRIORITY[doc] = "Indicates the importance of a package. The default value is 'optional'. Other standard values are 'required', 'standard' and 'extra'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Indicates the importance of a package. + </para> + + <para> + <filename>PRIORITY</filename> is considered to be part of + the distribution policy because the importance of any given + recipe depends on the purpose for which the distribution + is being produced. + Thus, <filename>PRIORITY</filename> is not normally set + within recipes. + </para> + + <para> + You can set <filename>PRIORITY</filename> to "required", + "standard", "extra", and "optional", which is the default. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PRIVATE_LIBS'><glossterm>PRIVATE_LIBS</glossterm> + <info> + PRIVATE_LIBS[doc] = "Specifies libraries installed within a recipe that should be ignored by the OpenEmbedded build system's shared library resolver." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies libraries installed within a recipe that + should be ignored by the OpenEmbedded build system's + shared library resolver. + This variable is typically used when software being + built by a recipe has its own private versions of a + library normally provided by another recipe. + In this case, you would not want the package containing + the private libraries to be set as a dependency on other + unrelated packages that should instead depend on the + package providing the standard version of the library. + </para> + + <para> + Libraries specified in this variable should be specified + by their file name. + For example, from the Firefox recipe in meta-browser: + <literallayout class='monospaced'> + PRIVATE_LIBS = "libmozjs.so \ + libxpcom.so \ + libnspr4.so \ + libxul.so \ + libmozalloc.so \ + libplc4.so \ + libplds4.so" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm> + <info> + PROVIDES[doc] = "A list of aliases that a recipe also provides. These aliases are useful for satisfying dependencies of other recipes during the build as specified by DEPENDS." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of aliases by which a particular recipe can be + known. + By default, a recipe's own + <filename><link linkend='var-PN'>PN</link></filename> + is implicitly already in its <filename>PROVIDES</filename> + list. + If a recipe uses <filename>PROVIDES</filename>, the + additional aliases are synonyms for the recipe and can + be useful satisfying dependencies of other recipes during + the build as specified by + <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>. + </para> + + <para> + Consider the following example + <filename>PROVIDES</filename> statement from a recipe + file <filename>libav_0.8.11.bb</filename>: + <literallayout class='monospaced'> + PROVIDES += "libpostproc" + </literallayout> + The <filename>PROVIDES</filename> statement results in + the "libav" recipe also being known as "libpostproc". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PRSERV_HOST'><glossterm>PRSERV_HOST</glossterm> + <info> + PRSERV_HOST[doc] = "The network based PR service host and port." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The network based + <link linkend='var-PR'><filename>PR</filename></link> + service host and port. + </para> + + <para> + The <filename>conf/local.conf.sample.extended</filename> + configuration file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + shows how the <filename>PRSERV_HOST</filename> variable is + set: + <literallayout class='monospaced'> + PRSERV_HOST = "localhost:0" + </literallayout> + You must set the variable if you want to automatically + start a local + <ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>PR service</ulink>. + You can set <filename>PRSERV_HOST</filename> to other + values to use a remote PR service. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PTEST_ENABLED'><glossterm>PTEST_ENABLED</glossterm> + <info> + PRSERV_HOST[doc] = "Specifies whether or not Package Test (ptest) functionality is enabled when building a recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies whether or not + <ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Package Test</ulink> + (ptest) functionality is enabled when building a recipe. + You should not set this variable directly. + Enabling and disabling building Package Tests + at build time should be done by adding "ptest" to (or + removing it from) + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PV'><glossterm>PV</glossterm> + <info> + PV[doc] = "The version of the recipe. The version is normally extracted from the recipe filename." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The version of the recipe. + The version is normally extracted from the recipe filename. + For example, if the recipe is named + <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PV</filename> + will be "2.0.1". + <filename>PV</filename> is generally not overridden within + a recipe unless it is building an unstable (i.e. development) version from a source code repository + (e.g. Git or Subversion). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PYTHON_ABI'><glossterm>PYTHON_ABI</glossterm> + <info> + PYTHON_ABI[doc] = "When used by recipes that inherit the distutils3, setuptools3, distutils, or setuptools classes, denotes the Application Binary Interface (ABI) currently in use for Python." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When used by recipes that inherit the + <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>, + <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>, + <link linkend='ref-classes-distutils'><filename>distutils</filename></link>, + or + <link linkend='ref-classes-setuptools'><filename>setuptools</filename></link> + classes, denotes the Application Binary Interface (ABI) + currently in use for Python. + By default, the ABI is "m". + You do not have to set this variable as the OpenEmbedded + build system sets it for you. + </para> + + <para> + The OpenEmbedded build system uses the ABI to construct + directory names used when installing the Python headers + and libraries in sysroot + (e.g. <filename>.../python3.3m/...</filename>). + </para> + + <para> + Recipes that inherit the + <link linkend='ref-classes-distutils'><filename>distutils</filename></link> + class during cross-builds also use this variable to + locate the headers and libraries of the appropriate Python + that the extension is targeting. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-PYTHON_PN'><glossterm>PYTHON_PN</glossterm> + <info> + PYTHON_PN[doc] = "When used by recipes that inherit the distutils3, setuptools3, distutils, or setuptools classes, specifies the major Python version being built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When used by recipes that inherit the + <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>, + <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>, + <link linkend='ref-classes-distutils'><filename>distutils</filename></link>, + or + <link linkend='ref-classes-setuptools'><filename>setuptools</filename></link> + classes, specifies the major Python version being built. + For Python 2.x, <filename>PYTHON_PN</filename> would + be "python2". For Python 3.x, the variable would be + "python3". + You do not have to set this variable as the + OpenEmbedded build system automatically sets it for you. + </para> + + <para> + The variable allows recipes to use common infrastructure + such as the following: + <literallayout class='monospaced'> + DEPENDS += "${PYTHON_PN}-native" + </literallayout> + In the previous example, the version of the dependency + is <filename>PYTHON_PN</filename>. + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-r'><title>R</title> + + <glossentry id='var-RANLIB'><glossterm>RANLIB</glossterm> + <info> + RANLIB[doc] = "Minimal command and arguments to run 'ranlib'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments to run + <filename>ranlib</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm> + <info> + RCONFLICTS[doc] = "The list of packages that conflict with another package. Note that the package will not be installed if the conflicting packages are not first removed." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The list of packages that conflict with packages. + Note that packages will not be installed if conflicting + packages are not first removed. + </para> + + <para> + Like all package-controlling variables, you must always use + them in conjunction with a package name override. + Here is an example: + <literallayout class='monospaced'> + RCONFLICTS_${PN} = "<replaceable>another_conflicting_package_name</replaceable>" + </literallayout> + </para> + + <para> + BitBake, which the OpenEmbedded build system uses, supports + specifying versioned dependencies. + Although the syntax varies depending on the packaging + format, BitBake hides these differences from you. + Here is the general syntax to specify versions with + the <filename>RCONFLICTS</filename> variable: + <literallayout class='monospaced'> + RCONFLICTS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" + </literallayout> + For <filename>operator</filename>, you can specify the + following: + <literallayout class='monospaced'> + = + < + > + <= + >= + </literallayout> + For example, the following sets up a dependency on version + 1.2 or greater of the package <filename>foo</filename>: + <literallayout class='monospaced'> + RCONFLICTS_${PN} = "foo (>= 1.2)" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm> + <info> + RDEPENDS[doc] = "Lists a package's runtime dependencies (i.e. other packages) that must be installed for the package to be built. They must be the names of other packages as listed in the PACKAGES variable, not recipe names (PN)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists a package's runtime dependencies (i.e. other packages) + that must be installed in order for the built package to run + correctly. + If a package in this list cannot be found during the build, + you will get a build error. + </para> + + <para> + When you use the <filename>RDEPENDS</filename> variable + in a recipe, you are essentially stating that the recipe's + <link linkend='ref-tasks-build'><filename>do_build</filename></link> + task depends on the existence of a specific package. + Consider this simple example for two recipes named "a" and + "b" that produce similarly named IPK packages. + In this example, the <filename>RDEPENDS</filename> + statement appears in the "a" recipe: + <literallayout class='monospaced'> + RDEPENDS_${PN} = "b" + </literallayout> + Here, the dependency is such that the + <filename>do_build</filename> task for recipe "a" depends + on the + <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> + task of recipe "b". + This means the package file for "b" must be available when + the output for recipe "a" has been completely built. + More importantly, package "a" will be marked as depending + on package "b" in a manner that is understood by the + package manager. + </para> + + <para> + The names of the packages you list within + <filename>RDEPENDS</filename> must be the names of other + packages - they cannot be recipe names. + Although package names and recipe names usually match, + the important point here is that you are + providing package names within the + <filename>RDEPENDS</filename> variable. + For an example of the default list of packages created from + a recipe, see the + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> + variable. + </para> + + <para> + Because the <filename>RDEPENDS</filename> variable applies + to packages being built, you should always use the variable + in a form with an attached package name. + For example, suppose you are building a development package + that depends on the <filename>perl</filename> package. + In this case, you would use the following + <filename>RDEPENDS</filename> statement: + <literallayout class='monospaced'> + RDEPENDS_${PN}-dev += "perl" + </literallayout> + In the example, the development package depends on + the <filename>perl</filename> package. + Thus, the <filename>RDEPENDS</filename> variable has the + <filename>${PN}-dev</filename> package name as part of the + variable. + </para> + + <para> + The package name you attach to the + <filename>RDEPENDS</filename> variable must appear + as it would in the <filename>PACKAGES</filename> + namespace before any renaming of the output package by + classes like + <link linkend='ref-classes-debian'><filename>debian</filename></link>. + </para> + + <para> + In many cases you do not need to explicitly add + runtime dependencies using + <filename>RDEPENDS</filename> since some automatic + handling occurs: + <itemizedlist> + <listitem><para><emphasis><filename>shlibdeps</filename></emphasis>: If + a runtime package contains a shared library + (<filename>.so</filename>), the build + processes the library in order to determine other + libraries to which it is dynamically linked. + The build process adds these libraries to + <filename>RDEPENDS</filename> when creating the runtime + package.</para></listitem> + <listitem><para><emphasis><filename>pcdeps</filename></emphasis>: If + the package ships a <filename>pkg-config</filename> + information file, the build process uses this file + to add items to the <filename>RDEPENDS</filename> + variable to create the runtime packages. + </para></listitem> + </itemizedlist> + </para> + + <para> + BitBake, which the OpenEmbedded build system uses, supports + specifying versioned dependencies. + Although the syntax varies depending on the packaging + format, BitBake hides these differences from you. + Here is the general syntax to specify versions with + the <filename>RDEPENDS</filename> variable: + <literallayout class='monospaced'> + RDEPENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" + </literallayout> + For <filename>operator</filename>, you can specify the + following: + <literallayout class='monospaced'> + = + < + > + <= + >= + </literallayout> + For example, the following sets up a dependency on version + 1.2 or greater of the package <filename>foo</filename>: + <literallayout class='monospaced'> + RDEPENDS_${PN} = "foo (>= 1.2)" + </literallayout> + </para> + + <para> + For information on build-time dependencies, see the + <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-REQUIRED_DISTRO_FEATURES'><glossterm>REQUIRED_DISTRO_FEATURES</glossterm> + <info> + REQUIRED_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link> + class, this + variable identifies distribution features that must + exist in the current configuration in order for the + OpenEmbedded build system to build the recipe. + In other words, if the + <filename>REQUIRED_DISTRO_FEATURES</filename> variable + lists a feature that does not appear in + <filename>DISTRO_FEATURES</filename> within the + current configuration, an error occurs and the + build stops. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-RM_OLD_IMAGE'><glossterm>RM_OLD_IMAGE</glossterm> + <info> + RM_OLD_IMAGE[doc] = "Reclaims disk space by removing previously built versions of the same image from the images directory pointed to by the DEPLOY_DIR variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Reclaims disk space by removing previously built + versions of the same image from the + <filename>images</filename> directory pointed to by the + <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link> + variable. + </para> + + <para> + Set this variable to "1" in your + <filename>local.conf</filename> file to remove these + images. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-RM_WORK_EXCLUDE'><glossterm>RM_WORK_EXCLUDE</glossterm> + <info> + RM_WORK_EXCLUDE[doc] = "With rm_work enabled, this variable specifies a list of packages whose work directories should not be removed." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + With <filename>rm_work</filename> enabled, this + variable specifies a list of recipes whose work directories + should not be removed. + See the "<link linkend='ref-classes-rm-work'><filename>rm_work.bbclass</filename></link>" + section for more details. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ROOT_HOME'><glossterm>ROOT_HOME</glossterm> + <info> + ROOT_HOME[doc] = "Defines the root home directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the root home directory. + By default, this directory is set as follows in the + BitBake configuration file: + <literallayout class='monospaced'> + ROOT_HOME ??= "/home/root" + </literallayout> + <note> + This default value is likely used because some + embedded solutions prefer to have a read-only root + filesystem and prefer to keep writeable data in one + place. + </note> + </para> + + <para> + You can override the default by setting the variable + in any layer or in the <filename>local.conf</filename> file. + Because the default is set using a "weak" assignment + (i.e. "??="), you can use either of the following forms + to define your override: + <literallayout class='monospaced'> + ROOT_HOME = "/root" + ROOT_HOME ?= "/root" + </literallayout> + These override examples use <filename>/root</filename>, + which is probably the most commonly used override. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ROOTFS'><glossterm>ROOTFS</glossterm> + <info> + ROOTFS[doc] = "Indicates a filesystem image to include as the root filesystem." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Indicates a filesystem image to include as the root + filesystem. + </para> + + <para> + The <filename>ROOTFS</filename> variable is an optional + variable used with the + <link linkend='ref-classes-image-live'><filename>image-live</filename></link> + class. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ROOTFS_POSTINSTALL_COMMAND'><glossterm>ROOTFS_POSTINSTALL_COMMAND</glossterm> + <info> + ROOTFS_POSTINSTALL_COMMAND[doc] = "Specifies a list of functions to call after installing packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions to call after the + OpenEmbedded build system has installed packages. + You can specify functions separated by semicolons: + <literallayout class='monospaced'> + ROOTFS_POSTINSTALL_COMMAND += "<replaceable>function</replaceable>; ... " + </literallayout> + </para> + + <para> + If you need to pass the root filesystem path to a command + within a function, you can use + <filename>${IMAGE_ROOTFS}</filename>, which points to + the directory that becomes the root filesystem image. + See the + <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ROOTFS_POSTPROCESS_COMMAND'><glossterm>ROOTFS_POSTPROCESS_COMMAND</glossterm> + <info> + ROOTFS_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the root filesystem." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions to call once the + OpenEmbedded build system has created the root filesystem. + You can specify functions separated by semicolons: + <literallayout class='monospaced'> + ROOTFS_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " + </literallayout> + </para> + + <para> + If you need to pass the root filesystem path to a command + within a function, you can use + <filename>${IMAGE_ROOTFS}</filename>, which points to + the directory that becomes the root filesystem image. + See the + <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ROOTFS_POSTUNINSTALL_COMMAND'><glossterm>ROOTFS_POSTUNINSTALL_COMMAND</glossterm> + <info> + ROOTFS_POSTUNINSTALL_COMMAND[doc] = "Specifies a list of functions to call after removal of unneeded packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions to call after the + OpenEmbedded build system has removed unnecessary + packages. + When runtime package management is disabled in the + image, several packages are removed including + <filename>base-passwd</filename>, + <filename>shadow</filename>, and + <filename>update-alternatives</filename>. + You can specify functions separated by semicolons: + <literallayout class='monospaced'> + ROOTFS_POSTUNINSTALL_COMMAND += "<replaceable>function</replaceable>; ... " + </literallayout> + </para> + + <para> + If you need to pass the root filesystem path to a command + within a function, you can use + <filename>${IMAGE_ROOTFS}</filename>, which points to + the directory that becomes the root filesystem image. + See the + <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-ROOTFS_PREPROCESS_COMMAND'><glossterm>ROOTFS_PREPROCESS_COMMAND</glossterm> + <info> + ROOTFS_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system has created the root filesystem." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions to call before the + OpenEmbedded build system has created the root filesystem. + You can specify functions separated by semicolons: + <literallayout class='monospaced'> + ROOTFS_PREPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " + </literallayout> + </para> + + <para> + If you need to pass the root filesystem path to a command + within a function, you can use + <filename>${IMAGE_ROOTFS}</filename>, which points to + the directory that becomes the root filesystem image. + See the + <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm> + <info> + RPROVIDES[doc] = "A list of package name aliases that a package also provides. These aliases are useful for satisfying runtime dependencies of other packages both during the build and on the target." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of package name aliases that a package also provides. + These aliases are useful for satisfying runtime dependencies + of other packages both during the build and on the target + (as specified by + <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>). + <note> + A package's own name is implicitly already in its + <filename>RPROVIDES</filename> list. + </note> + </para> + + <para> + As with all package-controlling variables, you must always + use the variable in conjunction with a package name override. + Here is an example: + <literallayout class='monospaced'> + RPROVIDES_${PN} = "widget-abi-2" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm> + <info> + RRECOMMENDS[doc] = "A list of packages that extends the usability of a package being built. The package being built does not depend on this list of packages in order to successfully build, but needs them for the extended usability." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of packages that extends the usability of a package + being built. + The package being built does not depend on this list of + packages in order to successfully build, but rather + uses them for extended usability. + To specify runtime dependencies for packages, see the + <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> + variable. + </para> + + <para> + The package manager will automatically install the + <filename>RRECOMMENDS</filename> list of packages when + installing the built package. + However, you can prevent listed packages from being + installed by using the + <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>, + <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>, + and + <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link> + variables. + </para> + + <para> + Packages specified in + <filename>RRECOMMENDS</filename> need not actually be + produced. + However, a recipe must exist that provides each package, + either through the + <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> + or + <link linkend='var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></link> + variables or the + <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link> + variable, or an error will occur during the build. + If such a recipe does exist and the package is not produced, + the build continues without error. + </para> + + <para> + Because the <filename>RRECOMMENDS</filename> variable + applies to packages being built, you should always attach + an override to the variable to specify the particular + package whose usability is being extended. + For example, suppose you are building a development package + that is extended to support wireless functionality. + In this case, you would use the following: + <literallayout class='monospaced'> + RRECOMMENDS_${PN}-dev += "<replaceable>wireless_package_name</replaceable>" + </literallayout> + In the example, the package name + (<filename>${<link linkend='var-PN'>PN</link>}-dev</filename>) + must appear as it would in the + <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> + namespace before any renaming of the output package by + classes such as <filename>debian.bbclass</filename>. + </para> + + <para> + BitBake, which the OpenEmbedded build system uses, supports + specifying versioned recommends. + Although the syntax varies depending on the packaging + format, BitBake hides these differences from you. + Here is the general syntax to specify versions with + the <filename>RRECOMMENDS</filename> variable: + <literallayout class='monospaced'> + RRECOMMENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" + </literallayout> + For <filename>operator</filename>, you can specify the + following: + <literallayout class='monospaced'> + = + < + > + <= + >= + </literallayout> + For example, the following sets up a recommend on version + 1.2 or greater of the package <filename>foo</filename>: + <literallayout class='monospaced'> + RRECOMMENDS_${PN} = "foo (>= 1.2)" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm> + <info> + RREPLACES[doc] = "A list of packages replaced by a package. The package manager uses this variable to determine which package should be installed to replace other package(s) during an upgrade." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of packages replaced by a package. + The package manager uses this variable to determine which + package should be installed to replace other package(s) + during an upgrade. + In order to also have the other package(s) removed at the + same time, you must add the name of the other + package to the + <filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable. + </para> + + <para> + As with all package-controlling variables, you must use + this variable in conjunction with a package name + override. + Here is an example: + <literallayout class='monospaced'> + RREPLACES_${PN} = "<replaceable>other_package_being_replaced</replaceable>" + </literallayout> + </para> + + <para> + BitBake, which the OpenEmbedded build system uses, supports + specifying versioned replacements. + Although the syntax varies depending on the packaging + format, BitBake hides these differences from you. + Here is the general syntax to specify versions with + the <filename>RREPLACES</filename> variable: + <literallayout class='monospaced'> + RREPLACES_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" + </literallayout> + For <filename>operator</filename>, you can specify the + following: + <literallayout class='monospaced'> + = + < + > + <= + >= + </literallayout> + For example, the following sets up a replacement using + version 1.2 or greater of the package + <filename>foo</filename>: + <literallayout class='monospaced'> + RREPLACES_${PN} = "foo (>= 1.2)" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm> + <info> + RSUGGESTS[doc] = "A list of additional packages that you can suggest for installation by the package manager at the time a package is installed. Not all package managers support this functionality." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of additional packages that you can suggest for + installation by the package manager at the time a package + is installed. + Not all package managers support this functionality. + </para> + + <para> + As with all package-controlling variables, you must always + use this variable in conjunction with a package name + override. + Here is an example: + <literallayout class='monospaced'> + RSUGGESTS_${PN} = "<replaceable>useful_package</replaceable> <replaceable>another_package</replaceable>" + </literallayout> + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-s'><title>S</title> + + <glossentry id='var-S'><glossterm>S</glossterm> + <info> + S[doc] = "The location in the Build Directory where unpacked package source code resides." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The location in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + where unpacked recipe source code resides. + By default, this directory is + <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/${</filename><link linkend='var-BPN'><filename>BPN</filename></link><filename>}-${</filename><link linkend='var-PV'><filename>PV</filename></link><filename>}</filename>, + where <filename>${BPN}</filename> is the base recipe name + and <filename>${PV}</filename> is the recipe version. + If the source tarball extracts the code to a directory + named anything other than <filename>${BPN}-${PV}</filename>, + or if the source code if fetched from an SCM such as + Git or Subversion, then you must set <filename>S</filename> + in the recipe so that the OpenEmbedded build system + knows where to find the unpacked source. + </para> + + <para> + As an example, assume a + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + top-level folder named <filename>poky</filename> and a + default Build Directory at <filename>poky/build</filename>. + In this case, the work directory the build system uses + to keep the unpacked recipe for <filename>db</filename> + is the following: + <literallayout class='monospaced'> + poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19 + </literallayout> + The unpacked source code resides in the + <filename>db-5.1.19</filename> folder. + </para> + + <para> + This next example assumes a Git repository. + By default, Git repositories are cloned to + <filename>${WORKDIR}/git</filename> during + <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link>. + Since this path is different from the default value of + <filename>S</filename>, you must set it specifically + so the source can be located: + <literallayout class='monospaced'> + SRC_URI = "git://path/to/repo.git" + S = "${WORKDIR}/git" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SANITY_REQUIRED_UTILITIES'><glossterm>SANITY_REQUIRED_UTILITIES</glossterm> + <info> + SANITY_REQUIRED_UTILITIES[doc] = "Specifies a list of command-line utilities that should be checked for during the initial sanity checking process when running BitBake." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of command-line utilities that should be + checked for during the initial sanity checking process when + running BitBake. + If any of the utilities are not installed on the build host, + then BitBake immediately exits with an error. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SANITY_TESTED_DISTROS'><glossterm>SANITY_TESTED_DISTROS</glossterm> + <info> + SANITY_TESTED_DISTROS[doc] = "A list of the host distribution identifiers that the build system has been tested against." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of the host distribution identifiers that the + build system has been tested against. + Identifiers consist of the host distributor ID + followed by the release, + as reported by the <filename>lsb_release</filename> tool + or as read from <filename>/etc/lsb-release</filename>. + Separate the list items with explicit newline + characters (<filename>\n</filename>). + If <filename>SANITY_TESTED_DISTROS</filename> is not empty + and the current value of + <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link> + does not appear in the list, then the build system reports + a warning that indicates the current host distribution has + not been tested as a build host. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm> + <info> + SDK_ARCH[doc] = "The target architecture for the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The target architecture for the SDK. + Typically, you do not directly set this variable. + Instead, use + <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_DEPLOY'><glossterm>SDK_DEPLOY</glossterm> + <info> + SDK_DEPLOY[doc] = "The directory set up and used by the populate_sdk_base to which the SDK is deployed." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The directory set up and used by the + <link linkend='ref-classes-populate-sdk'><filename>populate_sdk_base</filename></link> + to which the SDK is deployed. + The <filename>populate_sdk_base</filename> class defines + <filename>SDK_DEPLOY</filename> as follows: + <literallayout class='monospaced'> + SDK_DEPLOY = "${<link linkend='var-TMPDIR'>TMPDIR</link>}/deploy/sdk" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_DIR'><glossterm>SDK_DIR</glossterm> + <info> + SDK_DIR[doc] = "The parent directory used by the OpenEmbedded build system when creating SDK output." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The parent directory used by the OpenEmbedded build system + when creating SDK output. + The + <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> + class defines the variable as follows: + <literallayout class='monospaced'> + SDK_DIR = "${<link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>}/sdk" + </literallayout> + <note> + The <filename>SDK_DIR</filename> directory is a + temporary directory as it is part of + <filename>WORKDIR</filename>. + The final output directory is + <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_EXT_TYPE'><glossterm>SDK_EXT_TYPE</glossterm> + <info> + SDK_EXT_TYPE[doc] = "Controls whether or not shared state artifacts are copied into the extensible SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Controls whether or not shared state artifacts are copied + into the extensible SDK. + The default value of "full" copies all of the required + shared state artifacts into the extensible SDK. + The value "minimal" leaves these artifacts out of the + SDK. + <note> + If you set the variable to "minimal", you need to + ensure + <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> + is set in the SDK's configuration to enable the + artifacts to be fetched as needed. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_HOST_MANIFEST'><glossterm>SDK_HOST_MANIFEST</glossterm> + <info> + SDK_HOST_MANIFEST[doc] = "The manifest file for the host part of the SDK. This file lists all the installed packages that make up the host part of the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The manifest file for the host part of the SDK. + This file lists all the installed packages that make up + the host part of SDK. + The file contains package information on a line-per-package + basis as follows: + <literallayout class='monospaced'> + <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable> + </literallayout> + </para> + + <para> + The + <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> + class defines the manifest file as follows: + <literallayout class='monospaced'> + SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" + </literallayout> + The location is derived using the + <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link> + and + <link linkend='var-TOOLCHAIN_OUTPUTNAME'><filename>TOOLCHAIN_OUTPUTNAME</filename></link> + variables. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_INCLUDE_PKGDATA'><glossterm>SDK_INCLUDE_PKGDATA</glossterm> + <info> + SDK_INCLUDE_PKGDATA[doc] = "When set to "1", specifies to include the packagedata for all recipes in the "world" target in the extensible SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When set to "1", specifies to include the packagedata for + all recipes in the "world" target in the extensible SDK. + Including this data allows the + <filename>devtool search</filename> command to find these + recipes in search results, as well as allows the + <filename>devtool add</filename> command to map + dependencies more effectively. + <note> + Enabling the <filename>SDK_INCLUDE_PKGDATA</filename> + variable significantly increases build time because + all of world needs to be built. + Enabling the variable also slightly increases the size + of the extensible SDK. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_INHERIT_BLACKLIST'><glossterm>SDK_INHERIT_BLACKLIST</glossterm> + <info> + SDK_INHERIT_BLACKLIST[doc] = "A list of classes to remove from the INHERIT value globally within the extensible SDK configuration." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of classes to remove from the + <link linkend='var-INHERIT'><filename>INHERIT</filename></link> + value globally within the extensible SDK configuration. + The default value is "buildhistory icecc". + </para> + + <para> + Some classes are not generally applicable within + the extensible SDK context and you can use this variable + to disable them. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_LOCAL_CONF_BLACKLIST'><glossterm>SDK_LOCAL_CONF_BLACKLIST</glossterm> + <info> + SDK_LOCAL_CONF_BLACKLIST[doc] = "A list of variables not allowed through from the build system configuration into the extensible SDK configuration." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of variables not allowed through from the build + system configuration into the extensible SDK configuration. + Usually, these are variables that are specific to the + machine on which the build system is running and thus + would be potentially problematic within the extensible SDK. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_LOCAL_CONF_WHITELIST'><glossterm>SDK_LOCAL_CONF_WHITELIST</glossterm> + <info> + SDK_LOCAL_CONF_WHITELIST[doc] = "A list of variables allowed through from the build system configuration into the extensible SDK configuration." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of variables allowed through from the build system + configuration into the extensible SDK configuration. + This list overrides the variables specified using the + <link linkend='var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></link> + variable as well as any variables identified by automatic + blacklisting due to the "/" character being found at the + start of the value, which is usually indicative of being a + path and thus might not be valid on the system where the + SDK is installed. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm> + <info> + SDK_NAME[doc] = "The base name for SDK output files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The base name for SDK output files. + The name is derived from the + <link linkend='var-DISTRO'><filename>DISTRO</filename></link>, + <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, + <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>, + <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>, + and + <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link> + variables: + <literallayout class='monospaced'> + SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_OS'><glossterm>SDK_OS</glossterm> + <info> + SDK_OS[doc] = "The operating system for which the SDK will be built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the operating system for which the SDK + will be built. + The default value is the value of + <link linkend='var-BUILD_OS'><filename>BUILD_OS</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_OUTPUT'><glossterm>SDK_OUTPUT</glossterm> + <info> + SDK_OUTPUT[doc] = "The location used by the OpenEmbedded build system when creating SDK output." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The location used by the OpenEmbedded build system when + creating SDK output. + The + <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> + class defines the variable as follows: + <literallayout class='monospaced'> + SDK_OUTPUT = "${<link linkend='var-SDK_DIR'>SDK_DIR</link>}/image" + </literallayout> + <note> + The <filename>SDK_OUTPUT</filename> directory is a + temporary directory as it is part of + <filename>WORKDIR</filename> by way of + <filename>SDK_DIR</filename>. + The final output directory is + <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_PACKAGE_ARCHS'><glossterm>SDK_PACKAGE_ARCHS</glossterm> + <info> + SDK_PACKAGE_ARCHS[doc] = "Specifies a list of architectures compatible with the SDK machine. This variable is set automatically and should not normally be hand-edited." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of architectures compatible with + the SDK machine. + This variable is set automatically and should not + normally be hand-edited. + Entries are separated using spaces and listed in order + of priority. + The default value for + <filename>SDK_PACKAGE_ARCHS</filename> is "all any noarch + ${SDK_ARCH}-${SDKPKGSUFFIX}". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_POSTPROCESS_COMMAND'><glossterm>SDK_POSTPROCESS_COMMAND</glossterm> + <info> + SDK_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of functions to call once the + OpenEmbedded build system has created the SDK. + You can specify functions separated by semicolons: + <literallayout class='monospaced'> + SDK_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " + </literallayout> + </para> + + <para> + If you need to pass an SDK path to a command within a + function, you can use + <filename>${SDK_DIR}</filename>, which points to + the parent directory used by the OpenEmbedded build system + when creating SDK output. + See the + <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_PREFIX'><glossterm>SDK_PREFIX</glossterm> + <info> + SDK_PREFIX[doc] = "The toolchain binary prefix used for nativesdk recipes." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The toolchain binary prefix used for + <filename>nativesdk</filename> recipes. + The OpenEmbedded build system uses the + <filename>SDK_PREFIX</filename> value to set the + <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> + when building <filename>nativesdk</filename> recipes. + The default value is "${SDK_SYS}-". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_RECRDEP_TASKS'><glossterm>SDK_RECRDEP_TASKS</glossterm> + <info> + SDK_RECRDEP_TASKS[doc] = "A list of shared state tasks added to the extensible SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of shared state tasks added to the extensible SDK. + By default, the following tasks are added: + <literallayout class='monospaced'> + do_populate_lic + do_package_qa + do_populate_sysroot + do_deploy + </literallayout> + Despite the default value of "" for the + <filename>SDK_RECRDEP_TASKS</filename> variable, the + above four tasks are always added to the SDK. + To specify tasks beyond these four, you need to use + the <filename>SDK_RECRDEP_TASKS</filename> variable (e.g. + you are defining additional tasks that are needed in + order to build + <link linkend='var-SDK_TARGETS'><filename>SDK_TARGETS</filename></link>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_SYS'><glossterm>SDK_SYS</glossterm> + <info> + SDK_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the SDK will be built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the system, including the architecture and the + operating system, for which the SDK will be built. + </para> + + <para> + The OpenEmbedded build system automatically sets this + variable based on + <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>, + <link linkend='var-SDK_VENDOR'><filename>SDK_VENDOR</filename></link>, + and + <link linkend='var-SDK_OS'><filename>SDK_OS</filename></link>. + You do not need to set the <filename>SDK_SYS</filename> + variable yourself. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_TARGET_MANIFEST'><glossterm>SDK_TARGET_MANIFEST</glossterm> + <info> + SDK_TARGET_MANIFEST[doc] = "The manifest file for the target part of the SDK. This file lists all the installed packages that make up the target part of the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The manifest file for the target part of the SDK. + This file lists all the installed packages that make up + the target part of the SDK. + The file contains package information on a line-per-package + basis as follows: + <literallayout class='monospaced'> + <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable> + </literallayout> + </para> + + <para> + The + <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> + class defines the manifest file as follows: + <literallayout class='monospaced'> + SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" + </literallayout> + The location is derived using the + <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link> + and + <link linkend='var-TOOLCHAIN_OUTPUTNAME'><filename>TOOLCHAIN_OUTPUTNAME</filename></link> + variables. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_TARGETS'><glossterm>SDK_TARGETS</glossterm> + <info> + SDK_TARGETS[doc] = "A list of targets to install from shared state as part of the standard or extensible SDK installation." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of targets to install from shared state as part of + the standard or extensible SDK installation. + The default value is "${PN}" (i.e. the image from which + the SDK is built). + </para> + + <para> + The <filename>SDK_TARGETS</filename> variable is an + internal variable and typically would not be changed. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_TITLE'><glossterm>SDK_TITLE</glossterm> + <info> + SDK_TITLE[doc] = "Specifies a title to be printed when running the SDK installer." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a title to be printed when running the SDK + installer. + The <filename>SDK_TITLE</filename> variable defaults to + "<replaceable>distro</replaceable> SDK" for the standard + SDK and "<replaceable>distro</replaceable> Extensible SDK" + for the extensible SDK, where + <replaceable>distro</replaceable> is the first one of + <link linkend='var-DISTRO_NAME'><filename>DISTRO_NAME</filename></link> + or + <link linkend='var-DISTRO'><filename>DISTRO</filename></link> + that is set in your configuration. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_UPDATE_URL'><glossterm>SDK_UPDATE_URL</glossterm> + <info> + SDK_UPDATE_URL[doc] = "An optional URL for an update server for the extensible SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + An optional URL for an update server for the extensible + SDK. + If set, the value is used as the default update server when + running <filename>devtool sdk-update</filename> within the + extensible SDK. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm> + <info> + SDK_VENDOR[doc] = "Specifies the name of the SDK vendor." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the name of the SDK vendor. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDK_VERSION'><glossterm>SDK_VERSION</glossterm> + <info> + SDK_VERSION[doc] = "Specifies the version for the SDK." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the version of the SDK. + The distribution configuration file (e.g. + <filename>/meta-poky/conf/distro/poky.conf</filename>) + defines the <filename>SDK_VERSION</filename> as follows: + <literallayout class='monospaced'> + SDK_VERSION := "${@'${DISTRO_VERSION}'.replace('snapshot-${DATE}','snapshot')}" + </literallayout> + </para> + + <para> + For additional information, see the + <link linkend='var-DISTRO_VERSION'><filename>DISTRO_VERSION</filename></link> + and + <link linkend='var-DATE'><filename>DATE</filename></link> + variables. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm> + <info> + SDKIMAGE_FEATURES[doc] = "Equivalent to IMAGE_FEATURES. However, this variable applies to the SDK generated from an image using the command 'bitbake -c populate_sdk imagename'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Equivalent to + <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>. + However, this variable applies to the SDK generated from an + image using the following command: + <literallayout class='monospaced'> + $ bitbake -c populate_sdk <replaceable>imagename</replaceable> + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDKMACHINE'><glossterm>SDKMACHINE</glossterm> + <info> + SDKMACHINE[doc] = "Specifies the architecture (i.e. i686 or x86_64) for which to build SDK items." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The machine for which the SDK is built. + In other words, the SDK is built such that it + runs on the target you specify with the + <filename>SDKMACHINE</filename> value. + The value points to a corresponding + <filename>.conf</filename> file under + <filename>conf/machine-sdk/</filename>. + </para> + + <para> + You can use "i686" and "x86_64" as possible values + for this variable. The variable defaults to "i686" + and is set in the local.conf file in the Build Directory. + <literallayout class='monospaced'> + SDKMACHINE ?= "i686" + </literallayout> + <note> + You cannot set the <filename>SDKMACHINE</filename> + variable in your distribution configuration file. + If you do, the configuration will not take affect. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDKPATH'><glossterm>SDKPATH</glossterm> + <info> + SDKPATH[doc] = "Defines the path offered to the user for installation of the SDK that is generated by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the path offered to the user for installation + of the SDK that is generated by the OpenEmbedded build + system. + The path appears as the default location for installing + the SDK when you run the SDK's installation script. + You can override the offered path when you run the + script. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SDKTARGETSYSROOT'><glossterm>SDKTARGETSYSROOT</glossterm> + <info> + SDKTARGETSYSROOT[doc] = "Full path to the sysroot used for cross-compilation within an SDK as it will be when installed into the default SDKPATH." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The full path to the sysroot used for cross-compilation + within an SDK as it will be when installed into the + default + <link linkend='var-SDKPATH'><filename>SDKPATH</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SECTION'><glossterm>SECTION</glossterm> + <info> + SECTION[doc] = "The section in which packages should be categorized. Package management utilities can make use of this variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The section in which packages should be categorized. + Package management utilities can make use of this variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm> + <info> + SELECTED_OPTIMIZATION[doc] = "The variable takes the value of FULL_OPTIMIZATION unless DEBUG_BUILD = '1'. In this case, the value of DEBUG_OPTIMIZATION is used." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the optimization flags passed to the C compiler + when building for the target. + The flags are passed through the default value of the + <link linkend='var-TARGET_CFLAGS'><filename>TARGET_CFLAGS</filename></link> + variable. + </para> + + <para> + The <filename>SELECTED_OPTIMIZATION</filename> variable + takes the value of + <filename><link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link></filename> + unless <filename><link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link></filename> = "1". + If that is the case, the value of + <filename><link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link></filename> is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm> + <info> + SERIAL_CONSOLE[doc] = "The speed and device for the serial port used to attach the serial console. This variable is given to the kernel as the 'console' parameter. After booting occurs, getty is started on that port so remote login is possible." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines a serial console (TTY) to enable using getty. + Provide a value that specifies the baud rate followed by + the TTY device name separated by a space. + You cannot specify more than one TTY device: + <literallayout class='monospaced'> + SERIAL_CONSOLE = "115200 ttyS0" + </literallayout> + <note> + The <filename>SERIAL_CONSOLE</filename> variable + is deprecated. + Please use the + <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link> + variable. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SERIAL_CONSOLES'><glossterm>SERIAL_CONSOLES</glossterm> + <info> + SERIAL_CONSOLES[doc] = "Defines the serial consoles (TTYs) to enable using getty." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the serial consoles (TTYs) to enable using getty. + Provide a value that specifies the baud rate followed by + the TTY device name separated by a semicolon. + Use spaces to separate multiple devices: + <literallayout class='monospaced'> + SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SERIAL_CONSOLES_CHECK'><glossterm>SERIAL_CONSOLES_CHECK</glossterm> + <info> + SERIAL_CONSOLES_CHECK[doc] = "Similar to SERIAL_CONSOLES except the device is checked for existence before attempting to enable it. Supported only by SysVinit." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Similar to + <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link> + except the device is checked for existence before attempting + to enable it. + This variable is currently only supported with SysVinit + (i.e. not with systemd). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS'><glossterm>SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS</glossterm> + <info> + SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS[doc] = "A list of recipe dependencies that should not be used to determine signatures of tasks from one recipe when they depend on tasks from another recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of recipe dependencies that should not be used to + determine signatures of tasks from one recipe when they + depend on tasks from another recipe. + For example: + <literallayout class='monospaced'> + SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2" + </literallayout> + </para> + + <para> + In this example, <filename>intone</filename> depends on + <filename>mplayer2</filename>. + </para> + + <para> + Use of this variable is one mechanism to remove dependencies + that affect task signatures and thus force rebuilds when a + recipe changes. + <note><title>Caution</title> + If you add an inappropriate dependency for a recipe + relationship, the software might break during + runtime if the interface of the second recipe was + changed after the first recipe had been built. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SIGGEN_EXCLUDERECIPES_ABISAFE'><glossterm>SIGGEN_EXCLUDERECIPES_ABISAFE</glossterm> + <info> + SIGGEN_EXCLUDERECIPES_ABISAFE[doc] = "A list of recipes that are completely stable and will never change." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of recipes that are completely stable and will + never change. + The ABI for the recipes in the list are presented by + output from the tasks run to build the recipe. + Use of this variable is one way to remove dependencies from + one recipe on another that affect task signatures and + thus force rebuilds when the recipe changes. + <note><title>Caution</title> + If you add an inappropriate variable to this list, + the software might break at runtime if the + interface of the recipe was changed after the other + had been built. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm> + <info> + SITEINFO_BITS[doc] = "Specifies the number of bits for the target system CPU." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the number of bits for the target system CPU. + The value should be either "32" or "64". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SITEINFO_ENDIANNESS'><glossterm>SITEINFO_ENDIANNESS</glossterm> + <info> + SITEINFO_ENDIANNESS[doc] = "Specifies the endian byte order of the target system. The value should be either 'le' for 'little-endian' or 'be' for 'big-endian'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the endian byte order of the target system. + The value should be either "le" for little-endian or "be" for big-endian. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SKIP_FILEDEPS'><glossterm>SKIP_FILEDEPS</glossterm> + <info> + SKIP_FILEDEPS[doc] = "Enables you to remove all files from + the "Provides" section of an RPM package." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Enables removal of all files from the "Provides" section of + an RPM package. + Removal of these files is required for packages containing + prebuilt binaries and libraries such as + <filename>libstdc++</filename> and + <filename>glibc</filename>. + </para> + + <para> + To enable file removal, set the variable to "1" in your + <filename>conf/local.conf</filename> configuration file + in your: + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + <literallayout class='monospaced'> + SKIP_FILEDEPS = "1" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SOC_FAMILY'><glossterm>SOC_FAMILY</glossterm> + <info> + SOC_FAMILY[doc] = "Groups together machines based upon the same family of SOC (System On Chip). You typically set this variable in a common .inc file that you include in the configuration files of all the machines." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Groups together machines based upon the same family + of SOC (System On Chip). + You typically set this variable in a common + <filename>.inc</filename> file that you include in the + configuration files of all the machines. + <note> + You must include + <filename>conf/machine/include/soc-family.inc</filename> + for this variable to appear in + <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SOLIBS'><glossterm>SOLIBS</glossterm> + <info> + SOLIBS[doc] = "Defines the suffix for shared libraries used on the target platform." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the suffix for shared libraries used on the + target platform. + By default, this suffix is ".so.*" for all Linux-based + systems and is defined in the + <filename>meta/conf/bitbake.conf</filename> configuration + file. + </para> + + <para> + You will see this variable referenced in the default values + of <filename>FILES_${PN}</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SOLIBSDEV'><glossterm>SOLIBSDEV</glossterm> + <info> + SOLIBSDEV[doc] = "Defines the suffix for the development symbolic link (symlink) for shared libraries on the target platform." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines the suffix for the development symbolic link + (symlink) for shared libraries on the target platform. + By default, this suffix is ".so" for Linux-based + systems and is defined in the + <filename>meta/conf/bitbake.conf</filename> configuration + file. + </para> + + <para> + You will see this variable referenced in the default values + of <filename>FILES_${PN}-dev</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SOURCE_MIRROR_FETCH'><glossterm>SOURCE_MIRROR_FETCH</glossterm> + <info> + SOURCE_MIRROR_FETCH[doc] = "Set as part of a source mirror generation script to skip COMPATIBLE_MACHINE and COMPATIBLE_HOST checks." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When you are fetching files to create a mirror of sources + (i.e. creating a source mirror), setting + <filename>SOURCE_MIRROR_FETCH</filename> to "1" in your + <filename>local.conf</filename> configuration file ensures + the source for all recipes are fetched regardless of + whether or not a recipe is compatible with the + configuration. + A recipe is considered incompatible with the currently + configured machine when either or both the + <link linkend='var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></link> + variable and + <link linkend='var-COMPATIBLE_HOST'><filename>COMPATIBLE_HOST</filename></link> + variables specify compatibility with a machine other + than that of the current machine or host. + <note><title>Warning</title> + Do not set the + <filename>SOURCE_MIRROR_FETCH</filename> variable + unless you are creating a source mirror. + In other words, do not set the variable during a + normal build. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SOURCE_MIRROR_URL'><glossterm>SOURCE_MIRROR_URL</glossterm> + <info> + SOURCE_MIRROR_URL[doc] = "URL to source mirror that will be used before fetching from original SRC_URI." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Defines your own + <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> + from which to first fetch source before attempting to fetch + from the upstream specified in + <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>. + </para> + + <para> + To use this variable, you must globally inherit the + <link linkend='ref-classes-own-mirrors'><filename>own-mirrors</filename></link> + class and then provide the URL to your mirrors. + Here is the general syntax: + <literallayout class='monospaced'> + INHERIT += "own-mirrors" + SOURCE_MIRROR_URL = "http://<replaceable>example</replaceable>.com/<replaceable>my_source_mirror</replaceable>" + </literallayout> + <note> + You can specify only a single URL in + <filename>SOURCE_MIRROR_URL</filename>. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SPDXLICENSEMAP'><glossterm>SPDXLICENSEMAP</glossterm> + <info> + SPDXLICENSEMAP[doc] = "Maps commonly used license names to their SPDX counterparts found in meta/files/common-licenses/." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Maps commonly used license names to their SPDX counterparts + found in <filename>meta/files/common-licenses/</filename>. + For the default <filename>SPDXLICENSEMAP</filename> + mappings, see the + <filename>meta/conf/licenses.conf</filename> file. + </para> + + <para> + For additional information, see the + <link linkend='var-LICENSE'><filename>LICENSE</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm> + <info> + SPECIAL_PKGSUFFIX[doc] = "A list of prefixes for PN used by the OpenEmbedded build system to create variants of recipes or packages. The list specifies the prefixes to strip off during certain circumstances such as the generation of the BPN variable." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of prefixes for <link linkend='var-PN'><filename>PN</filename></link> used by the + OpenEmbedded build system to create variants of recipes or packages. + The list specifies the prefixes to strip off during certain circumstances + such as the generation of the <link linkend='var-BPN'><filename>BPN</filename></link> variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> + <info> + SRC_URI[doc] = "The list of source files - local or remote. This variable tells the OpenEmbedded build system what bits to pull in for the build and how to pull them in." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The list of source files - local or remote. + This variable tells the OpenEmbedded build system which bits + to pull in for the build and how to pull them in. + For example, if the recipe or append file only needs to + fetch a tarball from the Internet, the recipe or + append file uses a single <filename>SRC_URI</filename> + entry. + On the other hand, if the recipe or append file needs to + fetch a tarball, apply two patches, and include a custom + file, the recipe or append file would include four + instances of the variable. + </para> + + <para> + The following list explains the available URI protocols. + URI protocols are highly dependent on particular BitBake + Fetcher submodules. + Depending on the fetcher BitBake uses, various URL + parameters are employed. + For specifics on the supported Fetchers, see the + "<ulink url='&YOCTO_DOCS_BB_URL;#bb-fetchers'>Fetchers</ulink>" + section in the BitBake User Manual. + <itemizedlist> + <listitem><para><emphasis><filename>file://</filename> -</emphasis> + Fetches files, which are usually files shipped with + the + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>, + from the local machine. + The path is relative to the + <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> + variable. + Thus, the build system searches, in order, from the + following directories, which are assumed to be a + subdirectories of the directory in which the + recipe file (<filename>.bb</filename>) or + append file (<filename>.bbappend</filename>) + resides: + <itemizedlist> + <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> + The base recipe name without any special + suffix or version numbers. + </para></listitem> + <listitem><para><emphasis><filename>${BP}</filename> -</emphasis> + <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>. + The base recipe name and version but without + any special package name suffix. + </para></listitem> + <listitem><para><emphasis>files -</emphasis> + Files within a directory, which is named + <filename>files</filename> and is also + alongside the recipe or append file. + </para></listitem> + </itemizedlist> + <note> + If you want the build system to pick up files + specified through a + <filename>SRC_URI</filename> + statement from your append file, you need to be + sure to extend the + <filename>FILESPATH</filename> + variable by also using the + <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> + variable from within your append file. + </note> + </para></listitem> + <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a + Bazaar revision control repository.</para></listitem> + <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a + Git revision control repository.</para></listitem> + <listitem><para><emphasis><filename>osc://</filename> -</emphasis> Fetches files from + an OSC (OpenSUSE Build service) revision control repository.</para></listitem> + <listitem><para><emphasis><filename>repo://</filename> -</emphasis> Fetches files from + a repo (Git) repository.</para></listitem> + <listitem><para><emphasis><filename>ccrc://</filename> -</emphasis> + Fetches files from a ClearCase repository. + </para></listitem> + <listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from + the Internet using <filename>http</filename>.</para></listitem> + <listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files + from the Internet using <filename>https</filename>.</para></listitem> + <listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files + from the Internet using <filename>ftp</filename>.</para></listitem> + <listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from + a CVS revision control repository.</para></listitem> + <listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from + a Mercurial (<filename>hg</filename>) revision control repository.</para></listitem> + <listitem><para><emphasis><filename>p4://</filename> -</emphasis> Fetches files from + a Perforce (<filename>p4</filename>) revision control repository.</para></listitem> + <listitem><para><emphasis><filename>ssh://</filename> -</emphasis> Fetches files from + a secure shell.</para></listitem> + <listitem><para><emphasis><filename>svn://</filename> -</emphasis> Fetches files from + a Subversion (<filename>svn</filename>) revision control repository.</para></listitem> + </itemizedlist> + </para> + + <para> + Standard and recipe-specific options for <filename>SRC_URI</filename> exist. + Here are standard options: + <itemizedlist> + <listitem><para><emphasis><filename>apply</filename> -</emphasis> Whether to apply + the patch or not. + The default action is to apply the patch.</para></listitem> + <listitem><para><emphasis><filename>striplevel</filename> -</emphasis> Which + striplevel to use when applying the patch. + The default level is 1.</para></listitem> + <listitem><para><emphasis><filename>patchdir</filename> -</emphasis> Specifies + the directory in which the patch should be applied. + The default is <filename>${</filename><link linkend='var-S'><filename>S</filename></link><filename>}</filename>. + </para></listitem> + </itemizedlist> + </para> + + <para> + Here are options specific to recipes building code from a revision control system: + <itemizedlist> + <listitem><para><emphasis><filename>mindate</filename> -</emphasis> + Apply the patch only if + <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link> + is equal to or greater than <filename>mindate</filename>. + </para></listitem> + <listitem><para><emphasis><filename>maxdate</filename> -</emphasis> + Apply the patch only if <filename>SRCDATE</filename> + is not later than <filename>mindate</filename>. + </para></listitem> + <listitem><para><emphasis><filename>minrev</filename> -</emphasis> + Apply the patch only if <filename>SRCREV</filename> + is equal to or greater than <filename>minrev</filename>. + </para></listitem> + <listitem><para><emphasis><filename>maxrev</filename> -</emphasis> + Apply the patch only if <filename>SRCREV</filename> + is not later than <filename>maxrev</filename>. + </para></listitem> + <listitem><para><emphasis><filename>rev</filename> -</emphasis> + Apply the patch only if <filename>SRCREV</filename> + is equal to <filename>rev</filename>. + </para></listitem> + <listitem><para><emphasis><filename>notrev</filename> -</emphasis> + Apply the patch only if <filename>SRCREV</filename> + is not equal to <filename>rev</filename>. + </para></listitem> + </itemizedlist> + </para> + + <para> + Here are some additional options worth mentioning: + <itemizedlist> + <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls + whether or not to unpack the file if it is an archive. + The default action is to unpack the file.</para></listitem> + <listitem><para><emphasis><filename>destsuffix</filename> -</emphasis> Places the file + (or extracts its contents) into the specified + subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> + when the Git fetcher is used. + </para></listitem> + <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file + (or extracts its contents) into the specified + subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> + when the local (<filename>file://</filename>) + fetcher is used. + </para></listitem> + <listitem><para><emphasis><filename>localdir</filename> -</emphasis> Places the file + (or extracts its contents) into the specified + subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> + when the CVS fetcher is used. + </para></listitem> + <listitem><para><emphasis><filename>subpath</filename> -</emphasis> + Limits the checkout to a specific subpath of the + tree when using the Git fetcher is used. + </para></listitem> + <listitem><para><emphasis><filename>name</filename> -</emphasis> Specifies a + name to be used for association with <filename>SRC_URI</filename> checksums + when you have more than one file specified in <filename>SRC_URI</filename>. + </para></listitem> + <listitem><para><emphasis><filename>downloadfilename</filename> -</emphasis> Specifies + the filename used when storing the downloaded file.</para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm> + <info> + SRC_URI_OVERRIDES_PACKAGE_ARCH[doc] = "By default, the OpenEmbedded build system automatically detects whether SRC_URI contains files that are machine-specific. If so, the build system automatically changes PACKAGE_ARCH. Setting this variable to '0' disables this behavior." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + By default, the OpenEmbedded build system automatically detects whether + <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> + contains files that are machine-specific. + If so, the build system automatically changes + <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>. + Setting this variable to "0" disables this behavior. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm> + <info> + SRCDATE[doc] = "The date of the source code used to build the package. This variable applies only if the source was fetched from a Source Code Manager (SCM)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The date of the source code used to build the package. + This variable applies only if the source was fetched from a Source Code Manager (SCM). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SRCPV'><glossterm>SRCPV</glossterm> + <info> + SRCPV[doc] = "Returns the version string of the current package. This string is used to help define the value of PV." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Returns the version string of the current package. + This string is used to help define the value of + <link linkend='var-PV'><filename>PV</filename></link>. + </para> + + <para> + The <filename>SRCPV</filename> variable is defined in the + <filename>meta/conf/bitbake.conf</filename> configuration + file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + as follows: + <literallayout class='monospaced'> + SRCPV = "${@bb.fetch2.get_srcrev(d)}" + </literallayout> + </para> + + <para> + Recipes that need to define <filename>PV</filename> do so + with the help of the <filename>SRCPV</filename>. + For example, the <filename>ofono</filename> recipe + (<filename>ofono_git.bb</filename>) located in + <filename>meta/recipes-connectivity</filename> in the + Source Directory defines <filename>PV</filename> as + follows: + <literallayout class='monospaced'> + PV = "0.12-git${SRCPV}" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm> + <info> + SRCREV[doc] = "The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial and Bazaar only." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The revision of the source code used to build the package. + This variable applies to Subversion, Git, Mercurial and + Bazaar only. + Note that if you want to build a fixed revision and you + want to avoid performing a query on the remote repository + every time BitBake parses your recipe, you should specify + a <filename>SRCREV</filename> that is a + full revision identifier and not just a tag. + </para> + + <note> + For information on limitations when inheriting the latest + revision of software using <filename>SRCREV</filename>, + see the + <link linkend='var-AUTOREV'><filename>AUTOREV</filename></link> + variable description. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-SSTATE_DIR'><glossterm>SSTATE_DIR</glossterm> + <info> + SSTATE_DIR[doc] = "The directory for the shared state cache." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The directory for the shared state cache. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SSTATE_MIRROR_ALLOW_NETWORK'><glossterm>SSTATE_MIRROR_ALLOW_NETWORK</glossterm> + <info> + SSTATE_MIRROR_ALLOW_NETWORK[doc] = "If set to "1", allows fetches from mirrors that are specified in SSTATE_MIRRORS to work even when fetching from the network has been disabled by setting BB_NO_NETWORK to "1"." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + If set to "1", allows fetches from + mirrors that are specified in + <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> + to work even when fetching from the network has been + disabled by setting <filename>BB_NO_NETWORK</filename> + to "1". + Using the + <filename>SSTATE_MIRROR_ALLOW_NETWORK</filename> + variable is useful if you have set + <filename>SSTATE_MIRRORS</filename> to point to an + internal server for your shared state cache, but + you want to disable any other fetching from the network. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SSTATE_MIRRORS'><glossterm>SSTATE_MIRRORS</glossterm> + <info> + SSTATE_MIRRORS[doc] = "Configures the OpenEmbedded build system to search other mirror locations for prebuilt cache data objects before building out the data. You can specify a filesystem directory or a remote URL such as HTTP or FTP." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Configures the OpenEmbedded build system to search other + mirror locations for prebuilt cache data objects before + building out the data. + This variable works like fetcher + <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> + and <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> + and points to the cache locations to check for the shared + objects. + </para> + + <para> + You can specify a filesystem directory or a remote URL such + as HTTP or FTP. + The locations you specify need to contain the shared state + cache (sstate-cache) results from previous builds. + The sstate-cache you point to can also be from builds on + other machines. + </para> + + <para> + If a mirror uses the same structure as + <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>, + you need to add + "PATH" at the end as shown in the examples below. + The build system substitutes the correct path within the + directory structure. + <literallayout class='monospaced'> + SSTATE_MIRRORS ?= "\ + file://.* http://<replaceable>someserver</replaceable>.tld/share/sstate/PATH \n \ + file://.* file:///<replaceable>some-local-dir</replaceable>/sstate/PATH" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_BASE_LIBDIR_NATIVE'><glossterm>STAGING_BASE_LIBDIR_NATIVE</glossterm> + <info> + STAGING_BASE_LIBDIR_NATIVE[doc] = "Specifies the path to the /lib subdirectory of the sysroot directory for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the <filename>/lib</filename> + subdirectory of the sysroot directory for the + build host. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_BASELIBDIR'><glossterm>STAGING_BASELIBDIR</glossterm> + <info> + STAGING_BASELIBDIR[doc] = "Specifies the path to the /lib subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the <filename>/lib</filename> + subdirectory of the sysroot directory for the target + for which the current recipe is being built + (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_BINDIR'><glossterm>STAGING_BINDIR</glossterm> + <info> + STAGING_BINDIR[doc] = "Specifies the path to the /usr/bin subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the + <filename>/usr/bin</filename> subdirectory of the + sysroot directory for the target for which the current + recipe is being built + (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_BINDIR_CROSS'><glossterm>STAGING_BINDIR_CROSS</glossterm> + <info> + STAGING_BINDIR_CROSS[doc] = "Specifies the path to the directory containing binary configuration scripts. These scripts provide configuration information for other software that wants to make use of libraries or include files provided by the software associated with the script." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the directory containing binary + configuration scripts. + These scripts provide configuration information for + other software that wants to make use of libraries or + include files provided by the software associated with + the script. + <note> + This style of build configuration has been largely + replaced by <filename>pkg-config</filename>. + Consequently, if <filename>pkg-config</filename> + is supported by the library to which you are linking, + it is recommended you use + <filename>pkg-config</filename> instead of a + provided configuration script. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_BINDIR_NATIVE'><glossterm>STAGING_BINDIR_NATIVE</glossterm> + <info> + STAGING_BINDIR_NATIVE[doc] = "Specifies the path to the /usr/bin subdirectory of the sysroot directory for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the + <filename>/usr/bin</filename> subdirectory of the + sysroot directory for the build host. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_DATADIR'><glossterm>STAGING_DATADIR</glossterm> + <info> + STAGING_DATADIR[doc] = "Specifies the path to the /usr/share subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the <filename>/usr/share</filename> + subdirectory of the sysroot directory for the target + for which the current recipe is being built + (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_DATADIR_NATIVE'><glossterm>STAGING_DATADIR_NATIVE</glossterm> + <info> + STAGING_DATADIR_NATIVE[doc] = "Specifies the path to the /usr/share subdirectory of the sysroot directory for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the <filename>/usr/share</filename> + subdirectory of the sysroot directory for the build host. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_DIR'><glossterm>STAGING_DIR</glossterm> + <info> + STAGING_DIR[doc] = "Specifies the path to the top-level sysroots directory (i.e. ${TMPDIR}/sysroots)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the top-level sysroots directory + (i.e. + <filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/sysroots</filename>). + <note> + Recipes should never write files directly under + this directory because the OpenEmbedded build system + manages the directory automatically. + Instead, files should be installed to + <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> + within your recipe's + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task and then the OpenEmbedded build system will + stage a subset of those files into the sysroot. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_DIR_HOST'><glossterm>STAGING_DIR_HOST</glossterm> + <info> + STAGING_DIR_HOST[doc] = "Specifies the path to the primary sysroot directory for which the target is being built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the primary sysroot directory for + which the target is being built. + Depending on the type of recipe and the build target, the + recipe's value is as follows: + <itemizedlist> + <listitem><para>For recipes building for the target + machine, the value is "${STAGING_DIR}/${MACHINE}". + </para></listitem> + <listitem><para>For native recipes building + for the build host, the value is empty given the + assumption that when building for the build host, + the build host's own directories should be used. + </para></listitem> + <listitem><para>For native SDK + recipes that build for the SDK + (<filename>nativesdk</filename>), the value is + "${STAGING_DIR}/${MULTIMACH_HOST_SYS}". + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_DIR_NATIVE'><glossterm>STAGING_DIR_NATIVE</glossterm> + <info> + STAGING_DIR_NATIVE[doc] = "Specifies the path to the sysroot directory for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the sysroot directory for the + build host. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_DIR_TARGET'><glossterm>STAGING_DIR_TARGET</glossterm> + <info> + STAGING_DIR_TARGET[doc] = "Specifies the path to the sysroot directory for the target for which the current recipe is being built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the sysroot directory for the + target for which the current recipe is being built. + In most cases, this path is the + <link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>. + </para> + + <para> + Some recipes build binaries that can run on the target + system but those binaries in turn generate code for + another different system (e.g. cross-canadian recipes). + Using terminology from GNU, the primary system is referred + to as the "HOST" and the secondary, or different, system is + referred to as the "TARGET". + Thus, the binaries run on the "HOST" system and + and generate binaries for the "TARGET" system. + <filename>STAGING_DIR_TARGET</filename> points to the + sysroot used for the "TARGET" system. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_ETCDIR_NATIVE'><glossterm>STAGING_ETCDIR_NATIVE</glossterm> + <info> + STAGING_ETCDIR_NATIVE[doc] = "Specifies the path to the /etc subdirectory of the sysroot directory for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the <filename>/etc</filename> + subdirectory of the sysroot directory for the + build host. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_EXECPREFIXDIR'><glossterm>STAGING_EXECPREFIXDIR</glossterm> + <info> + STAGING_EXECPREFIXDIR[doc] = "Specifies the path to the /usr subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the <filename>/usr</filename> + subdirectory of the sysroot directory for the target + for which the current recipe is being built + (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_INCDIR'><glossterm>STAGING_INCDIR</glossterm> + <info> + STAGING_INCDIR[doc] = "Specifies the path to the /usr/include subdirectory of the sysroot directory for the target for which the current recipe being built (STAGING_DIR_HOST)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the + <filename>/usr/include</filename> subdirectory of the + sysroot directory for the target for which the current + recipe being built + (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_INCDIR_NATIVE'><glossterm>STAGING_INCDIR_NATIVE</glossterm> + <info> + STAGING_INCDIR_NATIVE[doc] = "Specifies the path to the /usr/include subdirectory of the sysroot directory for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the <filename>/usr/include</filename> + subdirectory of the sysroot directory for the build host. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_KERNEL_BUILDDIR'><glossterm>STAGING_KERNEL_BUILDDIR</glossterm> + <info> + STAGING_KERNEL_BUILDDIR[doc] = "Points to the directory containing the kernel build artifacts." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the directory containing the kernel build + artifacts. + Recipes building software that needs to access kernel + build artifacts + (e.g. <filename>systemtap-uprobes</filename>) can look in + the directory specified with the + <filename>STAGING_KERNEL_BUILDDIR</filename> variable to + find these artifacts after the kernel has been built. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> + <info> + STAGING_KERNEL_DIR[doc] = "The directory with kernel headers that are required to build out-of-tree modules." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The directory with kernel headers that are required to build out-of-tree + modules. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_LIBDIR'><glossterm>STAGING_LIBDIR</glossterm> + <info> + STAGING_LIBDIR[doc] = "Specifies the path to the /usr/lib subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the <filename>/usr/lib</filename> + subdirectory of the sysroot directory for the target for + which the current recipe is being built + (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAGING_LIBDIR_NATIVE'><glossterm>STAGING_LIBDIR_NATIVE</glossterm> + <info> + STAGING_LIBDIR_NATIVE[doc] = "Specifies the path to the /usr/lib subdirectory of the sysroot directory for the build host." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the path to the <filename>/usr/lib</filename> + subdirectory of the sysroot directory for the build host. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAMP'><glossterm>STAMP</glossterm> + <info> + STAMP[doc] = "Specifies the base path used to create recipe stamp files. The path to an actual stamp file is constructed by evaluating this string and then appending additional information." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the base path used to create recipe stamp files. + The path to an actual stamp file is constructed by evaluating this + string and then appending additional information. + Currently, the default assignment for <filename>STAMP</filename> + as set in the <filename>meta/conf/bitbake.conf</filename> file + is: + <literallayout class='monospaced'> + STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}" + </literallayout> + </para> + + <para> + See <link linkend='var-STAMPS_DIR'><filename>STAMPS_DIR</filename></link>, + <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>, + <link linkend='var-PN'><filename>PN</filename></link>, + <link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>, + <link linkend='var-PV'><filename>PV</filename></link>, and + <link linkend='var-PR'><filename>PR</filename></link> for related variable + information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STAMPS_DIR'><glossterm>STAMPS_DIR</glossterm> + <info> + STAMPS_DIR[doc] = "Specifies the base directory in which the OpenEmbedded build system places stamps." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the base directory in which the OpenEmbedded + build system places stamps. + The default directory is + <filename>${TMPDIR}/stamps</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-STRIP'><glossterm>STRIP</glossterm> + <info> + STRIP[doc] = "Minimal command and arguments to run 'strip' (strip symbols)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The minimal command and arguments to run + <filename>strip</filename>, which is used to strip + symbols. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> + <info> + SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The short (72 characters or less) summary of the binary package for packaging + systems such as <filename>opkg</filename>, <filename>rpm</filename> or + <filename>dpkg</filename>. + By default, <filename>SUMMARY</filename> is used to define + the <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link> + variable if <filename>DESCRIPTION</filename> is not set + in the recipe. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SVNDIR'><glossterm>SVNDIR</glossterm> + <info> + SVNDIR[doc] = "The directory where Subversion checkouts will be stored." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The directory in which files checked out of a Subversion + system are stored. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSLINUX_DEFAULT_CONSOLE'><glossterm>SYSLINUX_DEFAULT_CONSOLE</glossterm> + <info> + SYSLINUX_DEFAULT_CONSOLE[doc] = "Specifies the kernel boot default console." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the kernel boot default console. + If you want to use a console other than the default, + set this variable in your recipe as follows where "X" is + the console number you want to use: + <literallayout class='monospaced'> + SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" + </literallayout> + </para> + + <para> + The + <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> + class initially sets this variable to null but then checks + for a value later. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSLINUX_OPTS'><glossterm>SYSLINUX_OPTS</glossterm> + <info> + SYSLINUX_OPTS[doc] = "Lists additional options to add to the syslinux file." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Lists additional options to add to the syslinux file. + You need to set this variable in your recipe. + If you want to list multiple options, separate the options + with a semicolon character (<filename>;</filename>). + </para> + + <para> + The + <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> + class uses this variable to create a set of options. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSLINUX_SERIAL'><glossterm>SYSLINUX_SERIAL</glossterm> + <info> + SYSLINUX_SERIAL[doc] = "Specifies the alternate serial port or turns it off." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the alternate serial port or turns it off. + To turn off serial, set this variable to an empty string + in your recipe. + The variable's default value is set in the + <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> + as follows: + <literallayout class='monospaced'> + SYSLINUX_SERIAL ?= "0 115200" + </literallayout> + </para> + + <para> + The class checks for and uses the variable as needed. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSLINUX_SPLASH'><glossterm>SYSLINUX_SPLASH</glossterm> + <info> + SYSLINUX_SPLASH[doc] = "An .LSS file used as the background for the VGA boot menu when you are using the boot menu." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + An <filename>.LSS</filename> file used as the background + for the VGA boot menu when you are using the boot menu. + You need to set this variable in your recipe. + </para> + + <para> + The + <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> + class checks for this variable and if found, the + OpenEmbedded build system installs the splash screen. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSLINUX_SERIAL_TTY'><glossterm>SYSLINUX_SERIAL_TTY</glossterm> + <info> + SYSLINUX_SERIAL_TTY[doc] = "Specifies the alternate console=tty... kernel boot argument." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the alternate console=tty... kernel boot argument. + The variable's default value is set in the + <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> + as follows: + <literallayout class='monospaced'> + SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" + </literallayout> + </para> + + <para> + The class checks for and uses the variable as needed. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm> + <info> + SYSROOT_PREPROCESS_FUNCS[doc] = "A list of functions to execute after files are staged into the sysroot. These functions are usually used to apply additional processing on the staged files, or to stage additional files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of functions to execute after files are staged into + the sysroot. + These functions are usually used to apply additional + processing on the staged files, or to stage additional + files. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm> + <info> + SYSTEMD_AUTO_ENABLE[doc] = "For recipes that inherit the systemd class, this variable specifies whether the service you have specified in SYSTEMD_SERVICE should be started automatically or not." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-systemd'><filename>systemd</filename></link> + class, this variable specifies whether the service you have + specified in + <link linkend='var-SYSTEMD_SERVICE'><filename>SYSTEMD_SERVICE</filename></link> + should be started automatically or not. + By default, the service is enabled to automatically start + at boot time. + The default setting is in the + <link linkend='ref-classes-systemd'><filename>systemd</filename></link> + class as follows: + <literallayout class='monospaced'> + SYSTEMD_AUTO_ENABLE ??= "enable" + </literallayout> + </para> + + <para> + You can disable the service by setting the variable to + "disable". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm> + <info> + SYSTEMD_PACKAGES[doc] = "For recipes that inherit the systemd class, this variable locates the systemd unit files when they are not found in the main recipe's package." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-systemd'><filename>systemd</filename></link> + class, this variable locates the systemd unit files when + they are not found in the main recipe's package. + By default, the + <filename>SYSTEMD_PACKAGES</filename> variable is set + such that the systemd unit files are assumed to reside in + the recipes main package: + <literallayout class='monospaced'> + SYSTEMD_PACKAGES ?= "${PN}" + </literallayout> + </para> + + <para> + If these unit files are not in this recipe's main + package, you need to use + <filename>SYSTEMD_PACKAGES</filename> to list the package + or packages in which the build system can find the systemd + unit files. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSTEMD_SERVICE'><glossterm>SYSTEMD_SERVICE</glossterm> + <info> + SYSTEMD_SERVICE[doc] = "For recipes that inherit the systemd class, this variable specifies the systemd service name for a package." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-systemd'><filename>systemd</filename></link> + class, this variable specifies the systemd service name for + a package. + </para> + + <para> + When you specify this file in your recipe, use a package + name override to indicate the package to which the value + applies. + Here is an example from the connman recipe: + <literallayout class='monospaced'> + SYSTEMD_SERVICE_${PN} = "connman.service" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-SYSVINIT_ENABLED_GETTYS'><glossterm>SYSVINIT_ENABLED_GETTYS</glossterm> + <info> + SYSVINIT_ENABLED_GETTYS[doc] = "Specifies which virtual terminals should be running a getty, the default is '1'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When using + <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>, + specifies a space-separated list of the virtual terminals + that should be running a + <ulink url='http://en.wikipedia.org/wiki/Getty_%28Unix%29'>getty</ulink> + (allowing login), assuming + <link linkend='var-USE_VT'><filename>USE_VT</filename></link> + is not set to "0". + </para> + + <para> + The default value for + <filename>SYSVINIT_ENABLED_GETTYS</filename> is "1" + (i.e. only run a getty on the first virtual terminal). + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-t'><title>T</title> + + <glossentry id='var-T'><glossterm>T</glossterm> + <info> + T[doc] = "This variable points to a directory were BitBake places temporary files, which consist mostly of task logs and scripts, when building a particular recipe." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable points to a directory were BitBake places + temporary files, which consist mostly of task logs and + scripts, when building a particular recipe. + The variable is typically set as follows: + <literallayout class='monospaced'> + T = "${WORKDIR}/temp" + </literallayout> + </para> + + <para> + The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> + is the directory into which BitBake unpacks and builds the + recipe. + The default <filename>bitbake.conf</filename> file sets this variable.</para> + <para>The <filename>T</filename> variable is not to be confused with + the <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> variable, + which points to the root of the directory tree where BitBake + places the output of an entire build. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm> + <info> + TARGET_ARCH[doc] = "The architecture of the device being built. The OpenEmbedded build system supports the following architectures: arm, mips, ppc, x86, x86-64." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The target machine's architecture. + The OpenEmbedded build system supports many + architectures. + Here is an example list of architectures supported. + This list is by no means complete as the architecture + is configurable: + <literallayout class='monospaced'> + arm + i586 + x86_64 + powerpc + powerpc64 + mips + mipsel + </literallayout> + </para> + + <para> + For additional information on machine architectures, see + the + <link linkend='var-TUNE_ARCH'><filename>TUNE_ARCH</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_AS_ARCH'><glossterm>TARGET_AS_ARCH</glossterm> + <info> + TARGET_AS_ARCH[doc] = "Specifies architecture-specific assembler flags for the target system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies architecture-specific assembler flags for the + target system. + <filename>TARGET_AS_ARCH</filename> is initialized from + <link linkend='var-TUNE_ASARGS'><filename>TUNE_ASARGS</filename></link> + by default in the BitBake configuration file + (<filename>meta/conf/bitbake.conf</filename>): + <literallayout class='monospaced'> + TARGET_AS_ARCH = "${TUNE_ASARGS}" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_CC_ARCH'><glossterm>TARGET_CC_ARCH</glossterm> + <info> + TARGET_CC_ARCH[doc] = "Specifies architecture-specific C compiler flags for the target system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies architecture-specific C compiler flags for the + target system. + <filename>TARGET_CC_ARCH</filename> is initialized from + <link linkend='var-TUNE_CCARGS'><filename>TUNE_CCARGS</filename></link> + by default. + <note> + It is a common workaround to append + <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> + to <filename>TARGET_CC_ARCH</filename> + in recipes that build software for the target that + would not otherwise respect the exported + <filename>LDFLAGS</filename> variable. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_CC_KERNEL_ARCH'><glossterm>TARGET_CC_KERNEL_ARCH</glossterm> + <info> + TARGET_CC_KERNEL_ARCH[doc] = "This is a specific kernel compiler flag for a CPU or Application Binary Interface (ABI) tune." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This is a specific kernel compiler flag for a CPU or + Application Binary Interface (ABI) tune. + The flag is used rarely and only for cases where a + userspace + <link linkend='var-TUNE_CCARGS'><filename>TUNE_CCARGS</filename></link> + is not compatible with the kernel compilation. + The <filename>TARGET_CC_KERNEL_ARCH</filename> variable + allows the kernel (and associated modules) to use a + different configuration. + See the + <filename>meta/conf/machine/include/arm/feature-arm-thumb.inc</filename> + file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + for an example. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm> + <info> + TARGET_CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as CFLAGS." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C compiler when building + for the target. + When building in the target context, + <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> + is set to the value of this variable by default. + </para> + + <para> + Additionally, the SDK's environment setup script sets + the + <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> + variable in the environment to the + <filename>TARGET_CFLAGS</filename> value so that + executables built using the SDK also have the flags + applied. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_CPPFLAGS'><glossterm>TARGET_CPPFLAGS</glossterm> + <info> + TARGET_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the target." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C pre-processor + (i.e. to both the C and the C++ compilers) when building + for the target. + When building in the target context, + <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link> + is set to the value of this variable by default. + </para> + + <para> + Additionally, the SDK's environment setup script sets + the + <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link> + variable in the environment to the + <filename>TARGET_CPPFLAGS</filename> value so that + executables built using the SDK also have the flags + applied. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_CXXFLAGS'><glossterm>TARGET_CXXFLAGS</glossterm> + <info> + TARGET_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the target." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the C++ compiler when + building for the target. + When building in the target context, + <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link> + is set to the value of this variable by default. + </para> + + <para> + Additionally, the SDK's environment setup script sets + the + <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link> + variable in the environment to the + <filename>TARGET_CXXFLAGS</filename> value so that + executables built using the SDK also have the flags + applied. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm> + <info> + TARGET_FPU[doc] = "Specifies the method for handling FPU code. For FPU-less targets, which include most ARM CPUs, the variable must be set to 'soft'. If not, the kernel emulation gets used, which results in a performance penalty." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the method for handling FPU code. + For FPU-less targets, which include most ARM CPUs, the variable must be + set to "soft". + If not, the kernel emulation gets used, which results in a performance penalty. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_LD_ARCH'><glossterm>TARGET_LD_ARCH</glossterm> + <info> + TARGET_LD_ARCH[doc] = "Specifies architecture-specific linker flags for the target system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies architecture-specific linker flags for the + target system. + <filename>TARGET_LD_ARCH</filename> is initialized from + <link linkend='var-TUNE_LDARGS'><filename>TUNE_LDARGS</filename></link> + by default in the BitBake configuration file + (<filename>meta/conf/bitbake.conf</filename>): + <literallayout class='monospaced'> + TARGET_LD_ARCH = "${TUNE_LDARGS}" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_LDFLAGS'><glossterm>TARGET_LDFLAGS</glossterm> + <info> + TARGET_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the target." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the flags to pass to the linker when building + for the target. + When building in the target context, + <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> + is set to the value of this variable by default. + </para> + + <para> + Additionally, the SDK's environment setup script sets + the + <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> + variable in the environment to the + <filename>TARGET_LDFLAGS</filename> value so that + executables built using the SDK also have the flags + applied. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm> + <info> + TARGET_OS[doc] = "Specifies the target's operating system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the target's operating system. + The variable can be set to "linux" for <filename>glibc</filename>-based systems and + to "linux-uclibc" for <filename>uclibc</filename>. + For ARM/EABI targets, there are also "linux-gnueabi" and + "linux-uclibc-gnueabi" values possible. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_PREFIX'><glossterm>TARGET_PREFIX</glossterm> + <info> + TARGET_PREFIX[doc] = "The prefix used for the toolchain binary target tools." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the prefix used for the toolchain binary target + tools. + </para> + + <para> + Depending on the type of recipe and the build target, + <filename>TARGET_PREFIX</filename> is set as follows: + <itemizedlist> + <listitem><para> + For recipes building for the target machine, + the value is + "${<link linkend='var-TARGET_SYS'>TARGET_SYS</link>}-". + </para></listitem> + <listitem><para> + For native recipes, the build system sets the + variable to the value of + <filename>BUILD_PREFIX</filename>. + </para></listitem> + <listitem><para> + For native SDK recipes + (<filename>nativesdk</filename>), the + build system sets the variable to the value of + <filename>SDK_PREFIX</filename>. + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_SYS'><glossterm>TARGET_SYS</glossterm> + <info> + TARGET_SYS[doc] = "The target system is comprised of TARGET_ARCH,TARGET_VENDOR and TARGET_OS." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the system, including the architecture and the + operating system, for which the build is occurring in + the context of the current recipe. + </para> + + <para> + The OpenEmbedded build system automatically sets this + variable based on + <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>, + <link linkend='var-TARGET_VENDOR'><filename>TARGET_VENDOR</filename></link>, + and + <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link> + variables. + <note> + You do not need to set the + <filename>TARGET_SYS</filename> variable yourself. + </note> + </para> + + <para> + Consider these two examples: + <itemizedlist> + <listitem><para> + Given a native recipe on a 32-bit, x86 machine + running Linux, the value is "i686-linux". + </para></listitem> + <listitem><para> + Given a recipe being built for a little-endian, + MIPS target running Linux, the value might be + "mipsel-linux". + </para></listitem> + </itemizedlist> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TARGET_VENDOR'><glossterm>TARGET_VENDOR</glossterm> + <info> + TARGET_VENDOR[doc] = "The name of the target vendor." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the name of the target vendor. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TCLIBCAPPEND'><glossterm>TCLIBCAPPEND</glossterm> + <info> + TCLIBCAPPEND[doc] = "Specifies a suffix appended to TMPDIR that identifies the libc variant for the build." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a suffix to be appended onto the + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + value. + The suffix identifies the <filename>libc</filename> variant + for building. + When you are building for multiple variants with the same + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>, + this mechanism ensures that output for different + <filename>libc</filename> variants is kept separate to + avoid potential conflicts. + </para> + + <para> + In the <filename>defaultsetup.conf</filename> file, the + default value of <filename>TCLIBCAPPEND</filename> is + "-${TCLIBC}". + However, distros such as poky, which normally only support + one <filename>libc</filename> variant, set + <filename>TCLIBCAPPEND</filename> to "" in their distro + configuration file resulting in no suffix being applied. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm> + <info> + TCLIBC[doc] = "Specifies GNU standard C library (libc) variant to use during the build process. You can select 'glibc' or 'uclibc'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the GNU standard C library (<filename>libc</filename>) + variant to use during the build process. + This variable replaces <filename>POKYLIBC</filename>, which is no longer + supported. + </para> + + <para> + You can select "glibc" or "uclibc". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm> + <info> + TCMODE[doc] = "Enables an external toolchain (where provided by an additional layer) if set to a value other than 'default'." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the toolchain selector. + <filename>TCMODE</filename> controls the characteristics + of the generated packages and images by telling the + OpenEmbedded build system which toolchain profile to use. + By default, the OpenEmbedded build system builds its own + internal toolchain. + The variable's default value is "default", which uses + that internal toolchain. + <note> + If <filename>TCMODE</filename> is set to a value + other than "default", then it is your responsibility + to ensure that the toolchain is compatible with the + default toolchain. + Using older or newer versions of these components + might cause build problems. + See the + <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink> + for the specific components with which the toolchain + must be compatible. + </note> + </para> + + <para> + The <filename>TCMODE</filename> variable is similar to + <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, + which controls the variant of the GNU standard C library + (<filename>libc</filename>) used during the build process: + <filename>glibc</filename> or <filename>uclibc</filename>. + </para> + + <para> + With additional layers, it is possible to use a pre-compiled + external toolchain. + One example is the Sourcery G++ Toolchain. + The support for this toolchain resides in the separate + <trademark class='registered'>Mentor Graphics</trademark> + <filename>meta-sourcery</filename> layer at + <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>. + </para> + + <para> + The layer's <filename>README</filename> file contains + information on how to use the Sourcery G++ Toolchain as + an external toolchain. + In summary, you must be sure to add the layer to your + <filename>bblayers.conf</filename> file in front of the + <filename>meta</filename> layer and then set the + <filename>EXTERNAL_TOOLCHAIN</filename> + variable in your <filename>local.conf</filename> file + to the location in which you installed the toolchain. + </para> + + <para> + The fundamentals used for this example apply to any + external toolchain. + You can use <filename>meta-sourcery</filename> as a + template for adding support for other external toolchains. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_EXPORT_DIR'><glossterm>TEST_EXPORT_DIR</glossterm> + <info> + TEST_EXPORT_DIR[doc] = "The location the OpenEmbedded build system uses to export tests when the TEST_EXPORT_ONLY variable is set to "1"." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The location the OpenEmbedded build system uses to export + tests when the + <link linkend='var-TEST_EXPORT_ONLY'><filename>TEST_EXPORT_ONLY</filename></link> + variable is set to "1". + </para> + + <para> + The <filename>TEST_EXPORT_DIR</filename> variable defaults + to <filename>"${TMPDIR}/testimage/${PN}"</filename>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_EXPORT_ONLY'><glossterm>TEST_EXPORT_ONLY</glossterm> + <info> + TEST_EXPORT_ONLY[doc] = "Specifies to export the tests only. Set this variable to "1" if you do not want to run the tests but you want them to be exported in a manner that you to run them outside of the build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies to export the tests only. + Set this variable to "1" if you do not want to run the + tests but you want them to be exported in a manner that + you to run them outside of the build system. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_IMAGE'><glossterm>TEST_IMAGE</glossterm> + <info> + TEST_IMAGE[doc] = "Enables test booting of virtual machine images under the QEMU emulator after any root filesystems are created and runs tests against those images." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Automatically runs the series of automated tests for + images when an image is successfully built. + </para> + + <para> + These tests are written in Python making use of the + <filename>unittest</filename> module, and the majority of + them run commands on the target system over + <filename>ssh</filename>. + You can set this variable to "1" in your + <filename>local.conf</filename> file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + to have the OpenEmbedded build system automatically run + these tests after an image successfully builds: + <literallayout class='monospaced'> + TEST_IMAGE = "1" + </literallayout> + For more information on enabling, running, and writing + these tests, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" + section in the Yocto Project Development Manual and the + "<link linkend='ref-classes-testimage*'><filename>testimage*.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm> + <info> + TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The <filename>TEST_LOG_DIR</filename> variable defaults to "${WORKDIR}/testimage"." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Holds the SSH log and the boot log for QEMU machines. + The <filename>TEST_LOG_DIR</filename> variable defaults + to <filename>"${WORKDIR}/testimage"</filename>. + <note> + Actual test results reside in the task log + (<filename>log.do_testimage</filename>), which is in + the <filename>${WORKDIR}/temp/</filename> directory. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_POWERCONTROL_CMD'><glossterm>TEST_POWERCONTROL_CMD</glossterm> + <info> + TEST_POWERCONTROL_CMD[doc] = "For automated hardware testing, specifies the command to use to control the power of the target machine under test" + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + For automated hardware testing, specifies the command to + use to control the power of the target machine under test. + Typically, this command would point to a script that + performs the appropriate action (e.g. interacting + with a web-enabled power strip). + The specified command should expect to receive as the last + argument "off", "on" or "cycle" specifying to power off, + on, or cycle (power off and then power on) the device, + respectively. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_POWERCONTROL_EXTRA_ARGS'><glossterm>TEST_POWERCONTROL_EXTRA_ARGS</glossterm> + <info> + TEST_POWERCONTROL_EXTRA_ARGS[doc] = "For automated hardware testing, specifies additional arguments to pass through to the command specified in TEST_POWERCONTROL_CMD" + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + For automated hardware testing, specifies additional + arguments to pass through to the command specified in + <link linkend='var-TEST_POWERCONTROL_CMD'><filename>TEST_POWERCONTROL_CMD</filename></link>. + Setting <filename>TEST_POWERCONTROL_EXTRA_ARGS</filename> + is optional. + You can use it if you wish, for example, to separate the + machine-specific and non-machine-specific parts of the + arguments. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_QEMUBOOT_TIMEOUT'><glossterm>TEST_QEMUBOOT_TIMEOUT</glossterm> + <info> + TEST_QEMUBOOT_TIMEOUT[doc] = "The time in seconds allowed for an image to boot before automated runtime tests begin to run against an image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The time in seconds allowed for an image to boot before + automated runtime tests begin to run against an + image. + The default timeout period to allow the boot process to + reach the login prompt is 500 seconds. + You can specify a different value in the + <filename>local.conf</filename> file. + </para> + + <para> + For more information on testing images, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" + section in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_SERIALCONTROL_CMD'><glossterm>TEST_SERIALCONTROL_CMD</glossterm> + <info> + TEST_SERIALCONTROL_CMD[doc] = "For automated hardware testing, specifies the command to use to connect to the serial console of the target machine under test." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + For automated hardware testing, specifies the command + to use to connect to the serial console of the target + machine under test. + This command simply needs to connect to the serial console + and forward that connection to standard input and output + as any normal terminal program does. + </para> + + <para> + For example, to use the Picocom terminal program on + serial device <filename>/dev/ttyUSB0</filename> at + 115200bps, you would set the variable as follows: + <literallayout class='monospaced'> + TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_SERIALCONTROL_EXTRA_ARGS'><glossterm>TEST_SERIALCONTROL_EXTRA_ARGS</glossterm> + <info> + TEST_SERIALCONTROL_EXTRA_ARGS[doc] = "For automated hardware testing, specifies additional arguments to pass through to the command specified in TEST_SERIALCONTROL_CMD." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + For automated hardware testing, specifies additional + arguments to pass through to the command specified in + <link linkend='var-TEST_SERIALCONTROL_CMD'><filename>TEST_SERIALCONTROL_CMD</filename></link>. + Setting <filename>TEST_SERIALCONTROL_EXTRA_ARGS</filename> + is optional. + You can use it if you wish, for example, to separate the + machine-specific and non-machine-specific parts of the + command. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_SERVER_IP'><glossterm>TEST_SERVER_IP</glossterm> + <info> + TEST_SERVER_IP[doc] = "The IP address of the build machine (host machine). This IP address is usually automatically detected." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The IP address of the build machine (host machine). + This IP address is usually automatically detected. + However, if detection fails, this variable needs to be set + to the IP address of the build machine (i.e. where + the build is taking place). + <note> + The <filename>TEST_SERVER_IP</filename> variable + is only used for a small number of tests such as + the "smart" test suite, which needs to download + packages from <filename>DEPLOY_DIR/rpm</filename>. + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_TARGET'><glossterm>TEST_TARGET</glossterm> + <info> + TEST_TARGET[doc] = "For automated runtime testing, specifies the method of deploying the image and running tests on the target machine." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the target controller to use when running tests + against a test image. + The default controller to use is "qemu": + <literallayout class='monospaced'> + TEST_TARGET = "qemu" + </literallayout> + </para> + + <para> + A target controller is a class that defines how an + image gets deployed on a target and how a target is started. + A layer can extend the controllers by adding a module + in the layer's <filename>/lib/oeqa/controllers</filename> + directory and by inheriting the + <filename>BaseTarget</filename> class, which is an abstract + class that cannot be used as a value of + <filename>TEST_TARGET</filename>. + </para> + + <para> + You can provide the following arguments with + <filename>TEST_TARGET</filename>: + <itemizedlist> + <listitem><para><emphasis>"qemu" and "QemuTarget":</emphasis> + Boots a QEMU image and runs the tests. + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-image-enabling-tests'>Enabling Runtime Tests on QEMU</ulink>" + section in the Yocto Project Development Manual for + more information. + </para></listitem> + <listitem><para><emphasis>"simpleremote" and "SimpleRemoteTarget":</emphasis> + Runs the tests on target hardware that is already + up and running. + The hardware can be on the network or it can be + a device running an image on QEMU. + You must also set + <link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link> + when you use "simpleremote" or "SimpleRemoteTarget". + <note> + This argument is defined in + <filename>meta/lib/oeqa/targetcontrol.py</filename>. + The small caps names are kept for compatibility + reasons. + </note> + </para></listitem> + <listitem><para><emphasis>"GummibootTarget":</emphasis> + Automatically deploys and runs tests on an + EFI-enabled machine that has a master image + installed. + <note> + This argument is defined in + <filename>meta/lib/oeqa/controllers/masterimage.py</filename>. + </note> + </para></listitem> + </itemizedlist> + </para> + + <para> + For information on running tests on hardware, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#hardware-image-enabling-tests'>Enabling Runtime Tests on Hardware</ulink>" + section in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_TARGET_IP'><glossterm>TEST_TARGET_IP</glossterm> + <info> + TEST_TARGET_IP[doc] = "The IP address of your hardware under test." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The IP address of your hardware under test. + The <filename>TEST_TARGET_IP</filename> variable has no + effect when + <link linkend='var-TEST_TARGET'><filename>TEST_TARGET</filename></link> + is set to "qemu". + </para> + + <para> + When you specify the IP address, you can also include a + port. + Here is an example: + <literallayout class='monospaced'> + TEST_TARGET_IP = "192.168.1.4:2201" + </literallayout> + Specifying a port is useful when SSH is started on a + non-standard port or in cases when your hardware under test + is behind a firewall or network that is not directly + accessible from your host and you need to do port address + translation. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TEST_SUITES'><glossterm>TEST_SUITES</glossterm> + <info> + TEST_SUITES[doc] = "An ordered list of tests (modules) to run against an image when performing automated runtime testing." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + An ordered list of tests (modules) to run against + an image when performing automated runtime testing. + </para> + + <para> + The OpenEmbedded build system provides a core set of tests + that can be used against images. + <note> + Currently, there is only support for running these tests + under QEMU. + </note> + Tests include <filename>ping</filename>, + <filename>ssh</filename>, <filename>df</filename> among + others. + You can add your own tests to the list of tests by + appending <filename>TEST_SUITES</filename> as follows: + <literallayout class='monospaced'> + TEST_SUITES_append = " <replaceable>mytest</replaceable>" + </literallayout> + Alternatively, you can provide the "auto" option to + have all applicable tests run against the image. + <literallayout class='monospaced'> + TEST_SUITES_append = " auto" + </literallayout> + Using this option causes the build system to automatically + run tests that are applicable to the image. + Tests that are not applicable are skipped. + </para> + + <para> + The order in which tests are run is important. + Tests that depend on another test must appear later in the + list than the test on which they depend. + For example, if you append the list of tests with two + tests (<filename>test_A</filename> and + <filename>test_B</filename>) where + <filename>test_B</filename> is dependent on + <filename>test_A</filename>, then you must order the tests + as follows: + <literallayout class='monospaced'> + TEST_SUITES = " test_A test_B" + </literallayout> + </para> + + <para> + For more information on testing images, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" + section in the Yocto Project Development Manual. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-THISDIR'><glossterm>THISDIR</glossterm> + <info> + THISDIR[doc] = "The directory in which the file BitBake is currently parsing is located." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The directory in which the file BitBake is currently + parsing is located. + Do not manually set this variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TIME'><glossterm>TIME</glossterm> + <info> + TIME[doc] = "The time the build was started using HMS format." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The time the build was started. + Times appear using the hour, minute, and second (HMS) + format (e.g. "140159" for one minute and fifty-nine + seconds past 1400 hours). + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TMPDIR'><glossterm>TMPDIR</glossterm> + <info> + TMPDIR[doc] = "The temporary directory the OpenEmbedded build system uses when it does its work building images. By default, the TMPDIR variable is named tmp within the Build Directory." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable is the base directory the OpenEmbedded + build system uses for all build output and intermediate + files (other than the shared state cache). + By default, the <filename>TMPDIR</filename> variable points + to <filename>tmp</filename> within the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + </para> + + <para> + If you want to establish this directory in a location other + than the default, you can uncomment and edit the following + statement in the + <filename>conf/local.conf</filename> file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>: + <literallayout class='monospaced'> + #TMPDIR = "${TOPDIR}/tmp" + </literallayout> + An example use for this scenario is to set + <filename>TMPDIR</filename> to a local disk, which does + not use NFS, while having the Build Directory use NFS. + </para> + + <para> + The filesystem used by <filename>TMPDIR</filename> must + have standard filesystem semantics (i.e. mixed-case files + are unique, POSIX file locking, and persistent inodes). + Due to various issues with NFS and bugs in some + implementations, NFS does not meet this minimum + requirement. + Consequently, <filename>TMPDIR</filename> cannot be on + NFS. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TOOLCHAIN_HOST_TASK'><glossterm>TOOLCHAIN_HOST_TASK</glossterm> + <info> + TOOLCHAIN_HOST_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when building an SDK, which contains a cross-development environment." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable lists packages the OpenEmbedded build system + uses when building an SDK, which contains a + cross-development environment. + The packages specified by this variable are part of the + toolchain set that runs on the + <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>, + and each package should usually have the prefix + <filename>nativesdk-</filename>. + For example, consider the following command when + building an SDK: + <literallayout class='monospaced'> + $ bitbake -c populate_sdk <replaceable>imagename</replaceable> + </literallayout> + In this case, a default list of packages is set in this + variable, but you can add additional packages to the list. + </para> + + <para> + For background information on cross-development toolchains + in the Yocto Project development environment, see the + "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" + section. + For information on setting up a cross-development + environment, see the + <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TOOLCHAIN_OUTPUTNAME'><glossterm>TOOLCHAIN_OUTPUTNAME</glossterm> + <info> + TOOLCHAIN_OUTPUTNAME[doc] = "Defines the name used for the toolchain output." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable defines the name used for the toolchain + output. + The + <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> + class sets the + <filename>TOOLCHAIN_OUTPUTNAME</filename> variable as + follows: + <literallayout class='monospaced'> + TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" + </literallayout> + See the + <link linkend='var-SDK_NAME'><filename>SDK_NAME</filename></link> + and + <link linkend='var-SDK_VERSION'><filename>SDK_VERSION</filename></link> + variables for additional information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TOOLCHAIN_TARGET_TASK'><glossterm>TOOLCHAIN_TARGET_TASK</glossterm> + <info> + TOOLCHAIN_TARGET_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when it creates the target part of an SDK, which includes libraries and headers." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + This variable lists packages the OpenEmbedded build system + uses when it creates the target part of an SDK + (i.e. the part built for the target hardware), which + includes libraries and headers. + </para> + + <para> + For background information on cross-development toolchains + in the Yocto Project development environment, see the + "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" + section. + For information on setting up a cross-development + environment, see the + <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm> + <info> + TOPDIR[doc] = "The Build Directory. BitBake automatically sets this variable. The OpenEmbedded build system uses the Build Directory when building images." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The top-level + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + BitBake automatically sets this variable when you + initialize your build environment using either + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TRANSLATED_TARGET_ARCH'><glossterm>TRANSLATED_TARGET_ARCH</glossterm> + <info> + TRANSLATED_TARGET_ARCH[doc] = "A sanitized version of TARGET_ARCH. This variable is used where the architecture is needed in a value where underscores are not allowed." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A sanitized version of + <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>. + This variable is used where the architecture is needed in + a value where underscores are not allowed, for example + within package filenames. + In this case, dash characters replace any underscore + characters used in TARGET_ARCH. + </para> + + <para> + Do not edit this variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNE_ARCH'><glossterm>TUNE_ARCH</glossterm> + <info> + TUNE_ARCH[doc] = "The GNU canonical architecture for a specific architecture (i.e. arm, armeb, mips, mips64, and so forth)." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The GNU canonical architecture for a specific architecture + (i.e. <filename>arm</filename>, + <filename>armeb</filename>, + <filename>mips</filename>, + <filename>mips64</filename>, and so forth). + BitBake uses this value to setup configuration. + </para> + + <para> + <filename>TUNE_ARCH</filename> definitions are specific to + a given architecture. + The definitions can be a single static definition, or + can be dynamically adjusted. + You can see details for a given CPU family by looking at + the architecture's <filename>README</filename> file. + For example, the + <filename>meta/conf/machine/include/mips/README</filename> + file in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + provides information for <filename>TUNE_ARCH</filename> + specific to the <filename>mips</filename> architecture. + </para> + + <para> + <filename>TUNE_ARCH</filename> is tied closely to + <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>, + which defines the target machine's architecture. + The BitBake configuration file + (<filename>meta/conf/bitbake.conf</filename>) sets + <filename>TARGET_ARCH</filename> as follows: + <literallayout class='monospaced'> + TARGET_ARCH = "${TUNE_ARCH}" + </literallayout> + </para> + + <para> + The following list, which is by no means complete since + architectures are configurable, shows supported machine + architectures: + <literallayout class='monospaced'> + arm + i586 + x86_64 + powerpc + powerpc64 + mips + mipsel + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNE_ASARGS'><glossterm>TUNE_ASARGS</glossterm> + <info> + TUNE_ASARGS[doc] = "Specifies architecture-specific assembler flags for the target system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies architecture-specific assembler flags for + the target system. + The set of flags is based on the selected tune features. + <filename>TUNE_ASARGS</filename> is set using + the tune include files, which are typically under + <filename>meta/conf/machine/include/</filename> and are + influenced through + <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. + For example, the + <filename>meta/conf/machine/include/x86/arch-x86.inc</filename> + file defines the flags for the x86 architecture as follows: + <literallayout class='monospaced'> + TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}" + </literallayout> + <note> + Board Support Packages (BSPs) select the tune. + The selected tune, in turn, affects the tune variables + themselves (i.e. the tune can supply its own + set of flags). + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNE_CCARGS'><glossterm>TUNE_CCARGS</glossterm> + <info> + TUNE_CCARGS[doc] = "Specifies architecture-specific C compiler flags for the target system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies architecture-specific C compiler flags for + the target system. + The set of flags is based on the selected tune features. + <filename>TUNE_CCARGS</filename> is set using + the tune include files, which are typically under + <filename>meta/conf/machine/include/</filename> and are + influenced through + <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. + <note> + Board Support Packages (BSPs) select the tune. + The selected tune, in turn, affects the tune variables + themselves (i.e. the tune can supply its own + set of flags). + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNE_LDARGS'><glossterm>TUNE_LDARGS</glossterm> + <info> + TUNE_LDARGS[doc] = "Specifies architecture-specific linker flags for the target system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies architecture-specific linker flags for + the target system. + The set of flags is based on the selected tune features. + <filename>TUNE_LDARGS</filename> is set using + the tune include files, which are typically under + <filename>meta/conf/machine/include/</filename> and are + influenced through + <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. + For example, the + <filename>meta/conf/machine/include/x86/arch-x86.inc</filename> + file defines the flags for the x86 architecture as follows: + <literallayout class='monospaced'> + TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}" + </literallayout> + <note> + Board Support Packages (BSPs) select the tune. + The selected tune, in turn, affects the tune variables + themselves (i.e. the tune can supply its own + set of flags). + </note> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNE_FEATURES'><glossterm>TUNE_FEATURES</glossterm> + <info> + TUNE_FEATURES[doc] = "Features used to "tune" a compiler for optimal use given a specific processor." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Features used to "tune" a compiler for optimal use + given a specific processor. + The features are defined within the tune files and allow + arguments (i.e. <filename>TUNE_*ARGS</filename>) to be + dynamically generated based on the features. + </para> + + <para> + The OpenEmbedded build system verifies the features + to be sure they are not conflicting and that they are + supported. + </para> + + <para> + The BitBake configuration file + (<filename>meta/conf/bitbake.conf</filename>) defines + <filename>TUNE_FEATURES</filename> as follows: + <literallayout class='monospaced'> + TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" + </literallayout> + See the + <link linkend='var-DEFAULTTUNE'><filename>DEFAULTTUNE</filename></link> + variable for more information. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm> + <info> + TUNE_PKGARCH[doc] = "The package architecture understood by the packaging system to define the architecture, ABI, and tuning of output packages." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The package architecture understood by the packaging + system to define the architecture, ABI, and tuning of + output packages. + The specific tune is defined using the "_tune" override + as follows: + <literallayout class='monospaced'> + TUNE_PKGARCH_tune-<replaceable>tune</replaceable> = "<replaceable>tune</replaceable>" + </literallayout> + </para> + + <para> + These tune-specific package architectures are defined in + the machine include files. + Here is an example of the "core2-32" tuning as used + in the + <filename>meta/conf/machine/include/tune-core2.inc</filename> + file: + <literallayout class='monospaced'> + TUNE_PKGARCH_tune-core2-32 = "core2-32" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNEABI'><glossterm>TUNEABI</glossterm> + <info> + TUNEABI[doc] = "An underlying ABI used by a particular tuning in a given toolchain layer. This feature allows providers using prebuilt libraries to check compatibility of a tuning against their selection of libraries." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + An underlying Application Binary Interface (ABI) used by + a particular tuning in a given toolchain layer. + Providers that use prebuilt libraries can use the + <filename>TUNEABI</filename>, + <link linkend='var-TUNEABI_OVERRIDE'><filename>TUNEABI_OVERRIDE</filename></link>, + and + <link linkend='var-TUNEABI_WHITELIST'><filename>TUNEABI_WHITELIST</filename></link> + variables to check compatibility of tunings against their + selection of libraries. + </para> + + <para> + If <filename>TUNEABI</filename> is undefined, then every + tuning is allowed. + See the + <link linkend='ref-classes-sanity'><filename>sanity</filename></link> + class to see how the variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNEABI_OVERRIDE'><glossterm>TUNEABI_OVERRIDE</glossterm> + <info> + TUNEABI_OVERRIDE[doc] = "If set, ignores TUNEABI_WHITELIST." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + If set, the OpenEmbedded system ignores the + <link linkend='var-TUNEABI_WHITELIST'><filename>TUNEABI_WHITELIST</filename></link> + variable. + Providers that use prebuilt libraries can use the + <filename>TUNEABI_OVERRIDE</filename>, + <filename>TUNEABI_WHITELIST</filename>, + and + <link linkend='var-TUNEABI'><filename>TUNEABI</filename></link> + variables to check compatibility of a tuning against their + selection of libraries. + </para> + + <para> + See the + <link linkend='ref-classes-sanity'><filename>sanity</filename></link> + class to see how the variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNEABI_WHITELIST'><glossterm>TUNEABI_WHITELIST</glossterm> + <info> + TUNEABI_WHITELIST[doc] = "A whitelist of permissible TUNEABI values. If the variable is not set, all values are allowed." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A whitelist of permissible + <link linkend='var-TUNEABI'><filename>TUNEABI</filename></link> + values. + If <filename>TUNEABI_WHITELIST</filename> is not set, + all tunes are allowed. + Providers that use prebuilt libraries can use the + <filename>TUNEABI_WHITELIST</filename>, + <link linkend='var-TUNEABI_OVERRIDE'><filename>TUNEABI_OVERRIDE</filename></link>, + and <filename>TUNEABI</filename> variables to check + compatibility of a tuning against their selection of + libraries. + </para> + + <para> + See the + <link linkend='ref-classes-sanity'><filename>sanity</filename></link> + class to see how the variable is used. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNECONFLICTS'><glossterm>TUNECONFLICTS[<replaceable>feature</replaceable>]</glossterm> + <info> + TUNECONFLICTS[doc] = "Specifies CPU or Application Binary Interface (ABI) tuning features that conflict with specified feature." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies CPU or Application Binary Interface (ABI) + tuning features that conflict with <replaceable>feature</replaceable>. + </para> + + <para> + Known tuning conflicts are specified in the machine include + files in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + Here is an example from the + <filename>meta/conf/machine/include/mips/arch-mips.inc</filename> + include file that lists the "o32" and "n64" features as + conflicting with the "n32" feature: + <literallayout class='monospaced'> + TUNECONFLICTS[n32] = "o32 n64" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-TUNEVALID'><glossterm>TUNEVALID[<replaceable>feature</replaceable>]</glossterm> + <info> + TUNEVALID[doc] = "Descriptions, stored as flags, of valid tuning features." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a valid CPU or Application Binary Interface (ABI) + tuning feature. + The specified feature is stored as a flag. + Valid features are specified in the machine include files + (e.g. <filename>meta/conf/machine/include/arm/arch-arm.inc</filename>). + Here is an example from that file: + <literallayout class='monospaced'> + TUNEVALID[bigendian] = "Enable big-endian mode." + </literallayout> + </para> + + <para> + See the machine include files in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> + for these features. + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-u'><title>U</title> + + <glossentry id='var-UBOOT_CONFIG'><glossterm>UBOOT_CONFIG</glossterm> + <info> + UBOOT_CONFIG[doc] = "Configures the UBOOT_MACHINE and can also define IMAGE_FSTYPES for individual cases." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Configures the + <link linkend='var-UBOOT_MACHINE'><filename>UBOOT_MACHINE</filename></link> + and can also define + <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> + for individual cases. + </para> + + <para> + Following is an example from the + <filename>meta-fsl-arm</filename> layer. + <literallayout class='monospaced'> + UBOOT_CONFIG ??= "sd" + UBOOT_CONFIG[sd] = "mx6qsabreauto_config,sdcard" + UBOOT_CONFIG[eimnor] = "mx6qsabreauto_eimnor_config" + UBOOT_CONFIG[nand] = "mx6qsabreauto_nand_config,ubifs" + UBOOT_CONFIG[spinor] = "mx6qsabreauto_spinor_config" + </literallayout> + In this example, "sd" is selected as the configuration + of the possible four for the + <filename>UBOOT_MACHINE</filename>. + The "sd" configuration defines "mx6qsabreauto_config" + as the value for <filename>UBOOT_MACHINE</filename>, while + the "sdcard" specifies the + <filename>IMAGE_FSTYPES</filename> to use for the U-boot + image. + </para> + + <para> + For more information on how the + <filename>UBOOT_CONFIG</filename> is handled, see the + <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/uboot-config.bbclass'><filename>uboot-config</filename></ulink> + class. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-UBOOT_ENTRYPOINT'><glossterm>UBOOT_ENTRYPOINT</glossterm> + <info> + UBOOT_ENTRYPOINT[doc] = "Specifies the entry point for the U-Boot image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the entry point for the U-Boot image. + During U-Boot image creation, the + <filename>UBOOT_ENTRYPOINT</filename> variable is passed + as a command-line parameter to the + <filename>uboot-mkimage</filename> utility. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-UBOOT_LOADADDRESS'><glossterm>UBOOT_LOADADDRESS</glossterm> + <info> + UBOOT_LOADADDRESS[doc] = "Specifies the load address for the U-Boot image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the load address for the U-Boot image. + During U-Boot image creation, the + <filename>UBOOT_LOADADDRESS</filename> variable is passed + as a command-line parameter to the + <filename>uboot-mkimage</filename> utility. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-UBOOT_LOCALVERSION'><glossterm>UBOOT_LOCALVERSION</glossterm> + <info> + UBOOT_LOCALVERSION[doc] = "Appends a string to the name of the local version of the U-Boot image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Appends a string to the name of the local version of the + U-Boot image. + For example, assuming the version of the U-Boot image + built was "2013.10, the full version string reported by + U-Boot would be "2013.10-yocto" given the following + statement: + <literallayout class='monospaced'> + UBOOT_LOCALVERSION = "-yocto" + </literallayout> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-UBOOT_MACHINE'><glossterm>UBOOT_MACHINE</glossterm> + <info> + UBOOT_MACHINE[doc] = "Specifies the value passed on the make command line when building a U-Boot image." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the value passed on the + <filename>make</filename> command line when building + a U-Boot image. + The value indicates the target platform configuration. + You typically set this variable from the machine + configuration file (i.e. + <filename>conf/machine/<replaceable>machine_name</replaceable>.conf</filename>). + </para> + + <para> + Please see the "Selection of Processor Architecture and + Board Type" section in the U-Boot README for valid values + for this variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-UBOOT_MAKE_TARGET'><glossterm>UBOOT_MAKE_TARGET</glossterm> + <info> + UBOOT_MAKE_TARGET[doc] = "Specifies the target called in the Makefile." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the target called in the + <filename>Makefile</filename>. + The default target is "all". + </para> + </glossdef> + </glossentry> + + <glossentry id='var-UBOOT_SUFFIX'><glossterm>UBOOT_SUFFIX</glossterm> + <info> + UBOOT_SUFFIX[doc] = "Points to the generated U-Boot extension." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Points to the generated U-Boot extension. + For example, <filename>u-boot.sb</filename> has a + <filename>.sb</filename> extension. + </para> + + <para> + The default U-Boot extension is + <filename>.bin</filename> + </para> + </glossdef> + </glossentry> + + <glossentry id='var-UBOOT_TARGET'><glossterm>UBOOT_TARGET</glossterm> + <info> + UBOOT_TARGET[doc] = "Specifies the target used for building U-Boot." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the target used for building U-Boot. + The target is passed directly as part of the "make" command + (e.g. SPL and AIS). + If you do not specifically set this variable, the + OpenEmbedded build process passes and uses "all" for the + target during the U-Boot building process. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-UNKNOWN_CONFIGURE_WHITELIST'><glossterm>UNKNOWN_CONFIGURE_WHITELIST</glossterm> + <info> + UNKNOWN_CONFIGURE_WHITELIST[doc] = "Specifies a list of options that, if reported by the configure script as being invalid, should not generate a warning during the do_configure task." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a list of options that, if reported by the + configure script as being invalid, should not generate a + warning during the + <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> + task. + Normally, invalid configure options are simply not passed + to the configure script (e.g. should be removed from + <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>). + However, common options, for example, exist that are passed + to all configure scripts at a class level that might not + be valid for some configure scripts. + It follows that no benefit exists in seeing a warning about + these options. + For these cases, the options are added to + <filename>UNKNOWN_CONFIGURE_WHITELIST</filename>. + </para> + + <para> + The configure arguments check that uses + <filename>UNKNOWN_CONFIGURE_WHITELIST</filename> is part + of the + <link linkend='ref-classes-insane'><filename>insane</filename></link> + class and is only enabled if the recipe inherits the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-UPDATERCPN'><glossterm>UPDATERCPN</glossterm> + <info> + UPDATERCPN[doc] = "Specifies the package that contains the initscript that is to be enabled." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + For recipes inheriting the + <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> + class, <filename>UPDATERCPN</filename> specifies + the package that contains the initscript that is to be + enabled. + </para> + + <para> + The default value is "${PN}". + Given that almost all recipes that install initscripts + package them in the main package for the recipe, you + rarely need to set this variable in individual recipes. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-USE_DEVFS'><glossterm>USE_DEVFS</glossterm> + <info> + USE_DEVFS[doc] = "Determines if devtmpfs is used for /dev population." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Determines if <filename>devtmpfs</filename> is used for + <filename>/dev</filename> population. + The default value used for <filename>USE_DEVFS</filename> + is "1" when no value is specifically set. + Typically, you would set <filename>USE_DEVFS</filename> + to "0" for a statically populated <filename>/dev</filename> + directory. + </para> + + <para> + See the + "<ulink url='&YOCTO_DOCS_DEV_URL;#selecting-dev-manager'>Selecting a Device Manager</ulink>" + section in the Yocto Project Development Manual for + information on how to use this variable. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-USE_VT'><glossterm>USE_VT</glossterm> + <info> + USE_VT[doc] = "When using SysVinit, determines whether or not to run a getty on any virtual terminals in order to enable logging in through those terminals." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When using + <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>, + determines whether or not to run a + <ulink url='http://en.wikipedia.org/wiki/Getty_%28Unix%29'>getty</ulink> + on any virtual terminals in order to enable logging in + through those terminals. + </para> + + <para> + The default value used for <filename>USE_VT</filename> + is "1" when no default value is specifically set. + Typically, you would set <filename>USE_VT</filename> + to "0" in the machine configuration file for machines + that do not have a graphical display attached and + therefore do not need virtual terminal functionality. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm> + <info> + USER_CLASSES[doc] = "List of additional classes to use when building images that enable extra features." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + A list of classes to globally inherit. + These classes are used by the OpenEmbedded build system + to enable extra features (e.g. + <filename>buildstats</filename>, + <filename>image-mklibs</filename>, and so forth). + </para> + + <para> + The default list is set in your + <filename>local.conf</filename> file: + <literallayout class='monospaced'> + USER_CLASSES ?= "buildstats image-mklibs image-prelink" + </literallayout> + For more information, see + <filename>meta-poky/conf/local.conf.sample</filename> in + the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-USERADD_ERROR_DYNAMIC'><glossterm>USERADD_ERROR_DYNAMIC</glossterm> + <info> + USERADD_ERROR_DYNAMIC[doc] = "Forces the OpenEmbedded build system to produce an error if the user identification (uid) and group identification (gid) values are not defined in files/passwd and files/group files." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Forces the OpenEmbedded build system to produce an error + if the user identification (<filename>uid</filename>) and + group identification (<filename>gid</filename>) values + are not defined in <filename>files/passwd</filename> + and <filename>files/group</filename> files. + </para> + + <para> + The default behavior for the build system is to dynamically + apply <filename>uid</filename> and + <filename>gid</filename> values. + Consequently, the <filename>USERADD_ERROR_DYNAMIC</filename> + variable is by default not set. + If you plan on using statically assigned + <filename>gid</filename> and <filename>uid</filename> + values, you should set + the <filename>USERADD_ERROR_DYNAMIC</filename> variable in + your <filename>local.conf</filename> file as + follows: + <literallayout class='monospaced'> + USERADD_ERROR_DYNAMIC = "1" + </literallayout> + Overriding the default behavior implies you are going to + also take steps to set static <filename>uid</filename> and + <filename>gid</filename> values through use of the + <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>, + <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>, + and + <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link> + variables. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-USERADD_GID_TABLES'><glossterm>USERADD_GID_TABLES</glossterm> + <info> + USERADD_GID_TABLES[doc] = "Specifies a password file to use for obtaining static group identification (gid) values when the OpenEmbedded build system adds a group to the system during package installation." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a password file to use for obtaining static + group identification (<filename>gid</filename>) values + when the OpenEmbedded build system adds a group to the + system during package installation. + </para> + + <para> + When applying static group identification + (<filename>gid</filename>) values, the OpenEmbedded build + system looks in + <link linkend='var-BBPATH'><filename>BBPATH</filename></link> + for a <filename>files/group</filename> file and then applies + those <filename>uid</filename> values. + Set the variable as follows in your + <filename>local.conf</filename> file: + <literallayout class='monospaced'> + USERADD_GID_TABLES = "files/group" + </literallayout> + </para> + + <note> + Setting the + <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link> + variable to "useradd-staticids" causes the build system + to use static <filename>gid</filename> values. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm> + <info> + USERADD_PACKAGES[doc] = "When a recipe inherits the useradd class, this variable specifies the individual packages within the recipe that require users and/or groups to be added." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-useradd'><filename>useradd</filename></link> + class, this variable + specifies the individual packages within the recipe that + require users and/or groups to be added. + </para> + + <para> + You must set this variable if the recipe inherits the + class. + For example, the following enables adding a user for the + main package in a recipe: + <literallayout class='monospaced'> + USERADD_PACKAGES = "${PN}" + </literallayout> + <note> + If follows that if you are going to use the + <filename>USERADD_PACKAGES</filename> variable, + you need to set one or more of the + <link linkend='var-USERADD_PARAM'><filename>USERADD_PARAM</filename></link>, + <link linkend='var-GROUPADD_PARAM'><filename>GROUPADD_PARAM</filename></link>, + or + <link linkend='var-GROUPMEMS_PARAM'><filename>GROUPMEMS_PARAM</filename></link> + variables. + </note> + </para> + + </glossdef> + </glossentry> + + <glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm> + <info> + USERADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the useradd command if you wish to add a user to the system when the package is installed." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When inheriting the + <link linkend='ref-classes-useradd'><filename>useradd</filename></link> + class, this variable + specifies for a package what parameters should be passed + to the <filename>useradd</filename> command + if you wish to add a user to the system when the package + is installed. + </para> + + <para> + Here is an example from the <filename>dbus</filename> + recipe: + <literallayout class='monospaced'> + USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \ + --no-create-home --shell /bin/false \ + --user-group messagebus" + </literallayout> + For information on the standard Linux shell command + <filename>useradd</filename>, see + <ulink url='http://linux.die.net/man/8/useradd'></ulink>. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-USERADD_UID_TABLES'><glossterm>USERADD_UID_TABLES</glossterm> + <info> + USERADD_UID_TABLES[doc] = "Specifies a password file to use for obtaining static user identification (uid) values when the OpenEmbedded build system adds a user to the system during package installation." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies a password file to use for obtaining static + user identification (<filename>uid</filename>) values + when the OpenEmbedded build system adds a user to the + system during package installation. + </para> + + <para> + When applying static user identification + (<filename>uid</filename>) values, the OpenEmbedded build + system looks in + <link linkend='var-BBPATH'><filename>BBPATH</filename></link> + for a <filename>files/passwd</filename> file and then applies + those <filename>uid</filename> values. + Set the variable as follows in your + <filename>local.conf</filename> file: + <literallayout class='monospaced'> + USERADD_UID_TABLES = "files/passwd" + </literallayout> + </para> + + <note> + Setting the + <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link> + variable to "useradd-staticids" causes the build system + to use static <filename>uid</filename> values. + </note> + </glossdef> + </glossentry> + + <glossentry id='var-USERADDEXTENSION'><glossterm>USERADDEXTENSION</glossterm> + <info> + USERADDEXTENSION[doc] = "When set to "useradd-staticids", causes the OpenEmbedded build system to base all user and group additions on a static passwd and group files found in BBPATH." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + When set to "useradd-staticids", causes the + OpenEmbedded build system to base all user and group + additions on a static + <filename>passwd</filename> and + <filename>group</filename> files found in + <link linkend='var-BBPATH'><filename>BBPATH</filename></link>. + </para> + + <para> + To use static user identification (<filename>uid</filename>) + and group identification (<filename>gid</filename>) + values, set the variable + as follows in your <filename>local.conf</filename> file: + <literallayout class='monospaced'> + USERADDEXTENSION = "useradd-staticids" + </literallayout> + <note> + Setting this variable to use static + <filename>uid</filename> and <filename>gid</filename> + values causes the OpenEmbedded build system to employ + the + <link linkend='ref-classes-useradd'><filename>useradd-staticids</filename></link> + class. + </note> + </para> + + <para> + If you use static <filename>uid</filename> and + <filename>gid</filename> information, you must also + specify the <filename>files/passwd</filename> and + <filename>files/group</filename> files by setting the + <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link> + and + <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link> + variables. + Additionally, you should also set the + <link linkend='var-USERADD_ERROR_DYNAMIC'><filename>USERADD_ERROR_DYNAMIC</filename></link> + variable. + </para> + </glossdef> + </glossentry> + + </glossdiv> + +<!-- <glossdiv id='var-glossary-v'><title>V</title>--> +<!-- </glossdiv>--> + + <glossdiv id='var-glossary-w'><title>W</title> + + <glossentry id='var-WARN_QA'><glossterm>WARN_QA</glossterm> + <info> + WARN_QA[doc] = "Specifies the quality assurance checks whose failures are reported as warnings by the OpenEmbedded build system." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the quality assurance checks whose failures are + reported as warnings by the OpenEmbedded build system. + You set this variable in your distribution configuration + file. + For a list of the checks you can control with this variable, + see the + "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + + <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> + <info> + WORKDIR[doc] = "The pathname of the working directory in which the OpenEmbedded build system builds a recipe. This directory is located within the TMPDIR directory structure and changes as different packages are built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + The pathname of the work directory in which the OpenEmbedded + build system builds a recipe. + This directory is located within the + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + directory structure and is specific to the recipe being + built and the system for which it is being built. + </para> + + <para> + The <filename>WORKDIR</filename> directory is defined as + follows: + <literallayout class='monospaced'> + ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} + </literallayout> + The actual directory depends on several things: + <itemizedlist> + <listitem><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>: + The top-level build output directory</listitem> + <listitem><link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>: + The target system identifier</listitem> + <listitem><link linkend='var-PN'><filename>PN</filename></link>: + The recipe name</listitem> + <listitem><link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>: + The epoch - (if + <link linkend='var-PE'><filename>PE</filename></link> + is not specified, which is usually the case for most + recipes, then <filename>EXTENDPE</filename> is blank)</listitem> + <listitem><link linkend='var-PV'><filename>PV</filename></link>: + The recipe version</listitem> + <listitem><link linkend='var-PR'><filename>PR</filename></link>: + The recipe revision</listitem> + </itemizedlist> + </para> + + <para> + As an example, assume a Source Directory top-level folder + name <filename>poky</filename>, a default Build Directory at + <filename>poky/build</filename>, and a + <filename>qemux86-poky-linux</filename> machine target + system. + Furthermore, suppose your recipe is named + <filename>foo_1.3.0-r0.bb</filename>. + In this case, the work directory the build system uses to + build the package would be as follows: + <literallayout class='monospaced'> + poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 + </literallayout> + </para> + </glossdef> + </glossentry> + + </glossdiv> + + <glossdiv id='var-glossary-x'><title>X</title> + + <glossentry id='var-XSERVER'><glossterm>XSERVER</glossterm> + <info> + XSERVER[doc] = "Specifies the packages that should be installed + to provide an X server and drivers for the current machine." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Specifies the packages that should be installed to + provide an X server and drivers for the current machine, + assuming your image directly includes + <filename>packagegroup-core-x11-xserver</filename> or, + perhaps indirectly, includes "x11-base" in + <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. + </para> + + <para> + The default value of <filename>XSERVER</filename>, if not + specified in the machine configuration, is + "xserver-xorg xf86-video-fbdev xf86-input-evdev". + </para> + </glossdef> + </glossentry> + + </glossdiv> + +<!-- <glossdiv id='var-glossary-y'><title>Y</title>--> +<!-- </glossdiv>--> + +<!-- <glossdiv id='var-glossary-z'><title>Z</title>--> +<!-- </glossdiv>--> + +</glossary> +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/ref-varlocality.xml b/import-layers/yocto-poky/documentation/ref-manual/ref-varlocality.xml new file mode 100644 index 000000000..d3f873298 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/ref-varlocality.xml @@ -0,0 +1,196 @@ +<!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='ref-varlocality'> + <title>Variable Context</title> + + <para> + While you can use most variables in almost any context such as + <filename>.conf</filename>, <filename>.bbclass</filename>, + <filename>.inc</filename>, and <filename>.bb</filename> files, + some variables are often associated with a particular locality or context. + This chapter describes some common associations. + </para> + + <section id='ref-varlocality-configuration'> + <title>Configuration</title> + + <para> + The following subsections provide lists of variables whose context is + configuration: distribution, machine, and local. + </para> + + <section id='ref-varlocality-config-distro'> + <title>Distribution (Distro)</title> + + <para> + This section lists variables whose configuration context is the + distribution, or distro. + <itemizedlist> + <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename></para></listitem> + <listitem><para><filename><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-MAINTAINER'>MAINTAINER</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-TARGET_OS'>TARGET_OS</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-TARGET_FPU'>TARGET_FPU</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-TCMODE'>TCMODE</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-TCLIBC'>TCLIBC</link></filename> + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='ref-varlocality-config-machine'> + <title>Machine</title> + + <para> + This section lists variables whose configuration context is the + machine. + <itemizedlist> + <listitem><para><filename><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-SERIAL_CONSOLES'>SERIAL_CONSOLES</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS + </link></filename></para></listitem> + <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS + </link></filename></para></listitem> + <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS + </link></filename></para></listitem> + <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'> + MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename></para></listitem> + </itemizedlist> + </para> + </section> + + <section id='ref-varlocality-config-local'> + <title>Local</title> + + <para> + This section lists variables whose configuration context is the + local configuration through the <filename>local.conf</filename> + file. + <itemizedlist> + <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-MACHINE'>MACHINE</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-DL_DIR'>DL_DIR</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-BBFILES'>BBFILES</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES + </link></filename></para></listitem> + <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'> + ENABLE_BINARY_LOCALE_GENERATION</link></filename></para></listitem> + </itemizedlist> + </para> + </section> + </section> + + <section id='ref-varlocality-recipes'> + <title>Recipes</title> + + <para> + The following subsections provide lists of variables whose context is + recipes: required, dependencies, path, and extra build information. + </para> + + <section id='ref-varlocality-recipe-required'> + <title>Required</title> + + <para> + This section lists variables that are required for recipes. + <itemizedlist> + <listitem><para><filename><link linkend='var-LICENSE'>LICENSE</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> - used + in recipes that fetch local or remote files. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='ref-varlocality-recipe-dependencies'> + <title>Dependencies</title> + + <para> + This section lists variables that define recipe dependencies. + <itemizedlist> + <listitem><para><filename><link linkend='var-DEPENDS'>DEPENDS</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-RDEPENDS'>RDEPENDS</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-RREPLACES'>RREPLACES</link> + </filename></para></listitem> + </itemizedlist> + </para> + </section> + + <section id='ref-varlocality-recipe-paths'> + <title>Paths</title> + + <para> + This section lists variables that define recipe paths. + <itemizedlist> + <listitem><para><filename><link linkend='var-WORKDIR'>WORKDIR</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-S'>S</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-FILES'>FILES</link> + </filename></para></listitem> + </itemizedlist> + </para> + </section> + + <section id='ref-varlocality-recipe-build'> + <title>Extra Build Information</title> + + <para> + This section lists variables that define extra build information for recipes. + <itemizedlist> + <listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link> + </filename></para></listitem> + <listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> + </para></listitem> + <listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE + </link></filename></para></listitem> + </itemizedlist> + </para> + </section> + </section> +</chapter> +<!-- +vim: expandtab tw=80 ts=4 spell spelllang=en_gb +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/resources.xml b/import-layers/yocto-poky/documentation/ref-manual/resources.xml new file mode 100644 index 000000000..8299f9f3c --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/resources.xml @@ -0,0 +1,123 @@ +<!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='resources'> +<title>Contributing to the Yocto Project</title> + +<section id='resources-intro'> + <title>Introduction</title> + <para> + The Yocto Project team is happy for people to experiment with the Yocto Project. + A number of places exist to find help if you run into difficulties or find bugs. + To find out how to download source code, + see the "<ulink url='&YOCTO_DOCS_DEV_URL;#local-yp-release'>Yocto Project Release</ulink>" + section in the Yocto Project Development Manual. + </para> +</section> + +<section id='resources-bugtracker'> + <title>Tracking Bugs</title> + + <para> + If you find problems with the Yocto Project, you should report them using the + Bugzilla application at <ulink url='&YOCTO_BUGZILLA_URL;'></ulink>. + </para> +</section> + +<section id='resources-mailinglist'> + <title>Mailing lists</title> + + <para> + A number of mailing lists maintained by the Yocto Project exist + as well as related OpenEmbedded mailing lists for discussion, + patch submission and announcements. + To subscribe to one of the following mailing lists, click on the + appropriate URL in the following list and follow the instructions: + <itemizedlist> + <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> - + General Yocto Project discussion mailing list. </para></listitem> + <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/openembedded-core'></ulink> - + Discussion mailing list about OpenEmbedded-Core (the core metadata).</para></listitem> + <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/openembedded-devel'></ulink> - + Discussion mailing list about OpenEmbedded.</para></listitem> + <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/bitbake-devel'></ulink> - + Discussion mailing list about the + <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink> + build tool.</para></listitem> + <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> - + Discussion mailing list about + <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink>. + </para></listitem> + <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> - + Mailing list to receive official Yocto Project release and milestone + announcements.</para></listitem> + </itemizedlist> + </para> + For more Yocto Project-related mailing lists, see the Yocto Project community mailing lists page + <ulink url='&YOCTO_HOME_URL;/tools-resources/community/mailing-lists'>here</ulink>. +</section> + +<section id='resources-irc'> + <title>Internet Relay Chat (IRC)</title> + + <para> + Two IRC channels on freenode are available for the Yocto Project and Poky discussions: + <itemizedlist> + <listitem><para><filename>#yocto</filename></para></listitem> + <listitem><para><filename>#poky</filename></para></listitem> + </itemizedlist> + </para> +</section> + +<section id='resources-links'> + <title>Links</title> + + <para> + Here is a list of resources you will find helpful: + <itemizedlist> + <listitem><para><emphasis> + <ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>: + </emphasis> The home site for the Yocto + Project.</para></listitem> +<!-- + <listitem><para><emphasis> + <ulink url='http://www.intel.com/'>Intel Corporation</ulink>:</emphasis> + The company that acquired OpenedHand in 2008 and began + development on the Yocto Project.</para></listitem> +--> + <listitem><para><emphasis> + <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>:</emphasis> + The upstream, generic, embedded distribution used as the basis + for the build system in the Yocto Project. + Poky derives from and contributes back to the OpenEmbedded + project.</para></listitem> + <listitem><para><emphasis> + <ulink url='http://www.openembedded.org/wiki/BitBake'> + BitBake</ulink>:</emphasis> The tool used to process metadata.</para></listitem> + </itemizedlist> + For more links, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#other-information'>Other Information</ulink>" + section in the Yocto Project Development Manual. + </para> +</section> + +<section id='resources-contributions'> + <title>Contributions</title> + + <para> + The Yocto Project gladly accepts contributions. + You can submit changes to the project either by creating and sending + pull requests, + or by submitting patches through email. + For information on how to do both as well as information on how + to identify the maintainer for each area of code, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>How to Submit a Change</ulink>" + section in the Yocto Project Development Manual. + </para> +</section> + +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/technical-details.xml b/import-layers/yocto-poky/documentation/ref-manual/technical-details.xml new file mode 100644 index 000000000..f06382ab5 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/technical-details.xml @@ -0,0 +1,1460 @@ +<!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='technical-details'> +<title>Technical Details</title> + + <para> + This chapter provides technical details for various parts of the + Yocto Project. + Currently, topics include Yocto Project components, + cross-toolchain generation, shared state (sstate) cache, + x32, Wayland support, and Licenses. + </para> + +<section id='usingpoky-components'> + <title>Yocto Project Components</title> + + <para> + The + <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink> + task executor together with various types of configuration files form + the OpenEmbedded Core. + This section overviews these components by describing their use and + how they interact. + </para> + + <para> + BitBake handles the parsing and execution of the data files. + The data itself is of various types: + <itemizedlist> + <listitem><para><emphasis>Recipes:</emphasis> Provides details + about particular pieces of software. + </para></listitem> + <listitem><para><emphasis>Class Data:</emphasis> Abstracts + common build information (e.g. how to build a Linux kernel). + </para></listitem> + <listitem><para><emphasis>Configuration Data:</emphasis> Defines + machine-specific settings, policy decisions, and so forth. + Configuration data acts as the glue to bind everything + together. + </para></listitem> + </itemizedlist> + </para> + + <para> + BitBake knows how to combine multiple data sources together and refers + to each data source as a layer. + For information on layers, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and + Creating Layers</ulink>" section of the Yocto Project Development Manual. + </para> + + <para> + Following are some brief details on these core components. + For additional information on how these components interact during + a build, see the + "<link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>" + Chapter. + </para> + + <section id='usingpoky-components-bitbake'> + <title>BitBake</title> + + <para> + BitBake is the tool at the heart of the OpenEmbedded build system + and is responsible for parsing the + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>, + generating a list of tasks from it, and then executing those tasks. + </para> + + <para> + This section briefly introduces BitBake. + If you want more information on BitBake, see the + <ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual'>BitBake User Manual</ulink>. + </para> + + <para> + To see a list of the options BitBake supports, use either of + the following commands: + <literallayout class='monospaced'> + $ bitbake -h + $ bitbake --help + </literallayout> + </para> + + <para> + The most common usage for BitBake is <filename>bitbake <replaceable>packagename</replaceable></filename>, where + <filename>packagename</filename> is the name of the package you want to build + (referred to as the "target" in this manual). + The target often equates to the first part of a recipe's filename + (e.g. "foo" for a recipe named + <filename>foo_1.3.0-r0.bb</filename>). + So, to process the <filename>matchbox-desktop_1.2.3.bb</filename> recipe file, you + might type the following: + <literallayout class='monospaced'> + $ bitbake matchbox-desktop + </literallayout> + Several different versions of <filename>matchbox-desktop</filename> might exist. + BitBake chooses the one selected by the distribution configuration. + You can get more details about how BitBake chooses between different + target versions and providers in the + "<ulink url='&YOCTO_DOCS_BB_URL;#bb-bitbake-preferences'>Preferences</ulink>" + section of the BitBake User Manual. + </para> + + <para> + BitBake also tries to execute any dependent tasks first. + So for example, before building <filename>matchbox-desktop</filename>, BitBake + would build a cross compiler and <filename>glibc</filename> if they had not already + been built. + </para> + + <para> + A useful BitBake option to consider is the <filename>-k</filename> or + <filename>--continue</filename> option. + This option instructs BitBake to try and continue processing the job + as long as possible even after encountering an error. + When an error occurs, the target that + failed and those that depend on it cannot be remade. + However, when you use this option other dependencies can still be + processed. + </para> + </section> + + <section id='usingpoky-components-metadata'> + <title>Metadata (Recipes)</title> + + <para> + Files that have the <filename>.bb</filename> suffix are "recipes" + files. + In general, a recipe contains information about a single piece of + software. + This information includes the location from which to download the + unaltered source, any source patches to be applied to that source + (if needed), which special configuration options to apply, + how to compile the source files, and how to package the compiled + output. + </para> + + <para> + The term "package" is sometimes used to refer to recipes. However, + since the word "package" is used for the packaged output from the OpenEmbedded + build system (i.e. <filename>.ipk</filename> or <filename>.deb</filename> files), + this document avoids using the term "package" when referring to recipes. + </para> + </section> + + <section id='usingpoky-components-classes'> + <title>Classes</title> + + <para> + Class files (<filename>.bbclass</filename>) contain information that + is useful to share between + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> files. + An example is the + <link linkend='ref-classes-autotools'><filename>autotools</filename></link> + class, which contains common settings for any application that + Autotools uses. + The "<link linkend='ref-classes'>Classes</link>" chapter provides + details about classes and how to use them. + </para> + </section> + + <section id='usingpoky-components-configuration'> + <title>Configuration</title> + + <para> + The configuration files (<filename>.conf</filename>) define various configuration variables + that govern the OpenEmbedded build process. + These files fall into several areas that define machine configuration options, + distribution configuration options, compiler tuning options, general common configuration + options, and user configuration options in <filename>local.conf</filename>, which is found + in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + </para> + </section> +</section> + +<section id="cross-development-toolchain-generation"> + <title>Cross-Development Toolchain Generation</title> + + <para> + The Yocto Project does most of the work for you when it comes to + creating + <ulink url='&YOCTO_DOCS_DEV_URL;#cross-development-toolchain'>cross-development toolchains</ulink>. + This section provides some technical background on how + cross-development toolchains are created and used. + For more information on toolchains, you can also see the + <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>. + </para> + + <para> + In the Yocto Project development environment, cross-development + toolchains are used to build the image and applications that run on the + target hardware. + With just a few commands, the OpenEmbedded build system creates + these necessary toolchains for you. + </para> + + <para> + The following figure shows a high-level build environment regarding + toolchain construction and use. + </para> + + <para> + <imagedata fileref="figures/cross-development-toolchains.png" width="8in" depth="6in" align="center" /> + </para> + + <para> + Most of the work occurs on the Build Host. + This is the machine used to build images and generally work within the + the Yocto Project environment. + When you run BitBake to create an image, the OpenEmbedded build system + uses the host <filename>gcc</filename> compiler to bootstrap a + cross-compiler named <filename>gcc-cross</filename>. + The <filename>gcc-cross</filename> compiler is what BitBake uses to + compile source files when creating the target image. + You can think of <filename>gcc-cross</filename> simply as an + automatically generated cross-compiler that is used internally within + BitBake only. + <note> + The extensible SDK does not use + <filename>gcc-cross-canadian</filename> since this SDK + ships a copy of the OpenEmbedded build system and the sysroot + within it contains <filename>gcc-cross</filename>. + </note> + </para> + + <para> + The chain of events that occurs when <filename>gcc-cross</filename> is + bootstrapped is as follows: + <literallayout class='monospaced'> + gcc -> binutils-cross -> gcc-cross-initial -> linux-libc-headers -> glibc-initial -> glibc -> gcc-cross -> gcc-runtime + </literallayout> + <itemizedlist> + <listitem><para><filename>gcc</filename>: + The build host's GNU Compiler Collection (GCC). + </para></listitem> + <listitem><para><filename>binutils-cross</filename>: + The bare minimum binary utilities needed in order to run + the <filename>gcc-cross-initial</filename> phase of the + bootstrap operation. + </para></listitem> + <listitem><para><filename>gcc-cross-initial</filename>: + An early stage of the bootstrap process for creating + the cross-compiler. + This stage builds enough of the <filename>gcc-cross</filename>, + the C library, and other pieces needed to finish building the + final cross-compiler in later stages. + This tool is a "native" package (i.e. it is designed to run on + the build host). + </para></listitem> + <listitem><para><filename>linux-libc-headers</filename>: + Headers needed for the cross-compiler. + </para></listitem> + <listitem><para><filename>glibc-initial</filename>: + An initial version of the Embedded GLIBC needed to bootstrap + <filename>glibc</filename>. + </para></listitem> + <listitem><para><filename>gcc-cross</filename>: + The final stage of the bootstrap process for the + cross-compiler. + This stage results in the actual cross-compiler that + BitBake uses when it builds an image for a targeted + device. + <note> + If you are replacing this cross compiler toolchain + with a custom version, you must replace + <filename>gcc-cross</filename>. + </note> + This tool is also a "native" package (i.e. it is + designed to run on the build host). + </para></listitem> + <listitem><para><filename>gcc-runtime</filename>: + Runtime libraries resulting from the toolchain bootstrapping + process. + This tool produces a binary that consists of the + runtime libraries need for the targeted device. + </para></listitem> + </itemizedlist> + </para> + + <para> + You can use the OpenEmbedded build system to build an installer for + the relocatable SDK used to develop applications. + When you run the installer, it installs the toolchain, which contains + the development tools (e.g., the + <filename>gcc-cross-canadian</filename>), + <filename>binutils-cross-canadian</filename>, and other + <filename>nativesdk-*</filename> tools, + which are tools native to the SDK (i.e. native to + <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>), + you need to cross-compile and test your software. + The figure shows the commands you use to easily build out this + toolchain. + This cross-development toolchain is built to execute on the + <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>, + which might or might not be the same + machine as the Build Host. + <note> + If your target architecture is supported by the Yocto Project, + you can take advantage of pre-built images that ship with the + Yocto Project and already contain cross-development toolchain + installers. + </note> + </para> + + <para> + Here is the bootstrap process for the relocatable toolchain: + <literallayout class='monospaced'> + gcc -> binutils-crosssdk -> gcc-crosssdk-initial -> linux-libc-headers -> + glibc-initial -> nativesdk-glibc -> gcc-crosssdk -> gcc-cross-canadian + </literallayout> + <itemizedlist> + <listitem><para><filename>gcc</filename>: + The build host's GNU Compiler Collection (GCC). + </para></listitem> + <listitem><para><filename>binutils-crosssdk</filename>: + The bare minimum binary utilities needed in order to run + the <filename>gcc-crosssdk-initial</filename> phase of the + bootstrap operation. + </para></listitem> + <listitem><para><filename>gcc-crosssdk-initial</filename>: + An early stage of the bootstrap process for creating + the cross-compiler. + This stage builds enough of the + <filename>gcc-crosssdk</filename> and supporting pieces so that + the final stage of the bootstrap process can produce the + finished cross-compiler. + This tool is a "native" binary that runs on the build host. + </para></listitem> + <listitem><para><filename>linux-libc-headers</filename>: + Headers needed for the cross-compiler. + </para></listitem> + <listitem><para><filename>glibc-initial</filename>: + An initial version of the Embedded GLIBC needed to bootstrap + <filename>nativesdk-glibc</filename>. + </para></listitem> + <listitem><para><filename>nativesdk-glibc</filename>: + The Embedded GLIBC needed to bootstrap the + <filename>gcc-crosssdk</filename>. + </para></listitem> + <listitem><para><filename>gcc-crosssdk</filename>: + The final stage of the bootstrap process for the + relocatable cross-compiler. + The <filename>gcc-crosssdk</filename> is a transitory compiler + and never leaves the build host. + Its purpose is to help in the bootstrap process to create the + eventual relocatable <filename>gcc-cross-canadian</filename> + compiler, which is relocatable. + This tool is also a "native" package (i.e. it is + designed to run on the build host). + </para></listitem> + <listitem><para><filename>gcc-cross-canadian</filename>: + The final relocatable cross-compiler. + When run on the + <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>, + this tool + produces executable code that runs on the target device. + Only one cross-canadian compiler is produced per architecture + since they can be targeted at different processor optimizations + using configurations passed to the compiler through the + compile commands. + This circumvents the need for multiple compilers and thus + reduces the size of the toolchains. + </para></listitem> + </itemizedlist> + </para> + + <note> + For information on advantages gained when building a + cross-development toolchain installer, see the + "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" + section in the Yocto Project Software Development Kit (SDK) Developer's + Guide. + </note> +</section> + +<section id="shared-state-cache"> + <title>Shared State Cache</title> + + <para> + By design, the OpenEmbedded build system builds everything from scratch unless + BitBake can determine that parts do not need to be rebuilt. + Fundamentally, building from scratch is attractive as it means all parts are + built fresh and there is no possibility of stale data causing problems. + When developers hit problems, they typically default back to building from scratch + so they know the state of things from the start. + </para> + + <para> + Building an image from scratch is both an advantage and a disadvantage to the process. + As mentioned in the previous paragraph, building from scratch ensures that + everything is current and starts from a known state. + However, building from scratch also takes much longer as it generally means + rebuilding things that do not necessarily need to be rebuilt. + </para> + + <para> + The Yocto Project implements shared state code that supports incremental builds. + The implementation of the shared state code answers the following questions that + were fundamental roadblocks within the OpenEmbedded incremental build support system: + <itemizedlist> + <listitem><para>What pieces of the system have changed and what pieces have + not changed?</para></listitem> + <listitem><para>How are changed pieces of software removed and replaced?</para></listitem> + <listitem><para>How are pre-built components that do not need to be rebuilt from scratch + used when they are available?</para></listitem> + </itemizedlist> + </para> + + <para> + For the first question, the build system detects changes in the "inputs" to a given task by + creating a checksum (or signature) of the task's inputs. + If the checksum changes, the system assumes the inputs have changed and the task needs to be + rerun. + For the second question, the shared state (sstate) code tracks which tasks add which output + to the build process. + This means the output from a given task can be removed, upgraded or otherwise manipulated. + The third question is partly addressed by the solution for the second question + assuming the build system can fetch the sstate objects from remote locations and + install them if they are deemed to be valid. + </para> + + <note> + The OpenEmbedded build system does not maintain + <link linkend='var-PR'><filename>PR</filename></link> information + as part of the shared state packages. + Consequently, considerations exist that affect maintaining shared + state feeds. + For information on how the OpenEmbedded build system + works with packages and can + track incrementing <filename>PR</filename> information, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#incrementing-a-package-revision-number'>Incrementing a Package Revision Number</ulink>" + section. + </note> + + <para> + The rest of this section goes into detail about the overall incremental build + architecture, the checksums (signatures), shared state, and some tips and tricks. + </para> + + <section id='overall-architecture'> + <title>Overall Architecture</title> + + <para> + When determining what parts of the system need to be built, BitBake + works on a per-task basis rather than a per-recipe basis. + You might wonder why using a per-task basis is preferred over a per-recipe basis. + To help explain, consider having the IPK packaging backend enabled and then switching to DEB. + In this case, the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + and + <link linkend='ref-tasks-package'><filename>do_package</filename></link> + task outputs are still valid. + However, with a per-recipe approach, the build would not include the + <filename>.deb</filename> files. + Consequently, you would have to invalidate the whole build and rerun it. + Rerunning everything is not the best solution. + Also, in this case, the core must be "taught" much about specific tasks. + This methodology does not scale well and does not allow users to easily add new tasks + in layers or as external recipes without touching the packaged-staging core. + </para> + </section> + + <section id='checksums'> + <title>Checksums (Signatures)</title> + + <para> + The shared state code uses a checksum, which is a unique signature of a task's + inputs, to determine if a task needs to be run again. + Because it is a change in a task's inputs that triggers a rerun, the process + needs to detect all the inputs to a given task. + For shell tasks, this turns out to be fairly easy because + the build process generates a "run" shell script for each task and + it is possible to create a checksum that gives you a good idea of when + the task's data changes. + </para> + + <para> + To complicate the problem, there are things that should not be + included in the checksum. + First, there is the actual specific build path of a given task - + the <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. + It does not matter if the work directory changes because it should + not affect the output for target packages. + Also, the build process has the objective of making native + or cross packages relocatable. + <note> + Both native and cross packages run on the build host. + However, cross packages generate output for the target + architecture. + </note> + The checksum therefore needs to exclude + <filename>WORKDIR</filename>. + The simplistic approach for excluding the work directory is to set + <filename>WORKDIR</filename> to some fixed value and create the + checksum for the "run" script. + </para> + + <para> + Another problem results from the "run" scripts containing functions that + might or might not get called. + The incremental build solution contains code that figures out dependencies + between shell functions. + This code is used to prune the "run" scripts down to the minimum set, + thereby alleviating this problem and making the "run" scripts much more + readable as a bonus. + </para> + + <para> + So far we have solutions for shell scripts. + What about Python tasks? + The same approach applies even though these tasks are more difficult. + The process needs to figure out what variables a Python function accesses + and what functions it calls. + Again, the incremental build solution contains code that first figures out + the variable and function dependencies, and then creates a checksum for the data + used as the input to the task. + </para> + + <para> + Like the <filename>WORKDIR</filename> case, situations exist where dependencies + should be ignored. + For these cases, you can instruct the build process to ignore a dependency + by using a line like the following: + <literallayout class='monospaced'> + PACKAGE_ARCHS[vardepsexclude] = "MACHINE" + </literallayout> + This example ensures that the + <link linkend='var-PACKAGE_ARCHS'><filename>PACKAGE_ARCHS</filename></link> + variable does not + depend on the value of + <link linkend='var-MACHINE'><filename>MACHINE</filename></link>, + even if it does reference it. + </para> + + <para> + Equally, there are cases where we need to add dependencies BitBake is not able to find. + You can accomplish this by using a line like the following: + <literallayout class='monospaced'> + PACKAGE_ARCHS[vardeps] = "MACHINE" + </literallayout> + This example explicitly adds the <filename>MACHINE</filename> variable as a + dependency for <filename>PACKAGE_ARCHS</filename>. + </para> + + <para> + Consider a case with in-line Python, for example, where BitBake is not + able to figure out dependencies. + When running in debug mode (i.e. using <filename>-DDD</filename>), BitBake + produces output when it discovers something for which it cannot figure out + dependencies. + The Yocto Project team has currently not managed to cover those dependencies + in detail and is aware of the need to fix this situation. + </para> + + <para> + Thus far, this section has limited discussion to the direct inputs into a task. + Information based on direct inputs is referred to as the "basehash" in the + code. + However, there is still the question of a task's indirect inputs - the + things that were already built and present in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + The checksum (or signature) for a particular task needs to add the hashes + of all the tasks on which the particular task depends. + Choosing which dependencies to add is a policy decision. + However, the effect is to generate a master checksum that combines the basehash + and the hashes of the task's dependencies. + </para> + + <para> + At the code level, there are a variety of ways both the basehash and the + dependent task hashes can be influenced. + Within the BitBake configuration file, we can give BitBake some extra information + to help it construct the basehash. + The following statement effectively results in a list of global variable + dependency excludes - variables never included in any checksum: + <literallayout class='monospaced'> + BB_HASHBASE_WHITELIST ?= "TMPDIR FILE PATH PWD BB_TASKHASH BBPATH DL_DIR \ + SSTATE_DIR THISDIR FILESEXTRAPATHS FILE_DIRNAME HOME LOGNAME SHELL TERM \ + USER FILESPATH STAGING_DIR_HOST STAGING_DIR_TARGET COREBASE PRSERV_HOST \ + PRSERV_DUMPDIR PRSERV_DUMPFILE PRSERV_LOCKDOWN PARALLEL_MAKE \ + CCACHE_DIR EXTERNAL_TOOLCHAIN CCACHE CCACHE_DISABLE LICENSE_PATH SDKPKGSUFFIX" + </literallayout> + The previous example excludes + <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> + since that variable is actually constructed as a path within + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>, which is on + the whitelist. + </para> + + <para> + The rules for deciding which hashes of dependent tasks to include through + dependency chains are more complex and are generally accomplished with a + Python function. + The code in <filename>meta/lib/oe/sstatesig.py</filename> shows two examples + of this and also illustrates how you can insert your own policy into the system + if so desired. + This file defines the two basic signature generators <filename>OE-Core</filename> + uses: "OEBasic" and "OEBasicHash". + By default, there is a dummy "noop" signature handler enabled in BitBake. + This means that behavior is unchanged from previous versions. + <filename>OE-Core</filename> uses the "OEBasicHash" signature handler by default + through this setting in the <filename>bitbake.conf</filename> file: + <literallayout class='monospaced'> + BB_SIGNATURE_HANDLER ?= "OEBasicHash" + </literallayout> + The "OEBasicHash" <filename>BB_SIGNATURE_HANDLER</filename> is the same as the + "OEBasic" version but adds the task hash to the stamp files. + This results in any + <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> + change that changes the task hash, automatically + causing the task to be run again. + This removes the need to bump <link linkend='var-PR'><filename>PR</filename></link> + values, and changes to Metadata automatically ripple across the build. + </para> + + <para> + It is also worth noting that the end result of these signature generators is to + make some dependency and hash information available to the build. + This information includes: + <itemizedlist> + <listitem><para><filename>BB_BASEHASH_task-</filename><replaceable>taskname</replaceable>: + The base hashes for each task in the recipe. + </para></listitem> + <listitem><para><filename>BB_BASEHASH_</filename><replaceable>filename</replaceable><filename>:</filename><replaceable>taskname</replaceable>: + The base hashes for each dependent task. + </para></listitem> + <listitem><para><filename>BBHASHDEPS_</filename><replaceable>filename</replaceable><filename>:</filename><replaceable>taskname</replaceable>: + The task dependencies for each task. + </para></listitem> + <listitem><para><filename>BB_TASKHASH</filename>: + The hash of the currently running task. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='shared-state'> + <title>Shared State</title> + + <para> + Checksums and dependencies, as discussed in the previous section, solve half the + problem of supporting a shared state. + The other part of the problem is being able to use checksum information during the build + and being able to reuse or rebuild specific components. + </para> + + <para> + The + <link linkend='ref-classes-sstate'><filename>sstate</filename></link> + class is a relatively generic implementation of how to "capture" + a snapshot of a given task. + The idea is that the build process does not care about the source of a task's output. + Output could be freshly built or it could be downloaded and unpacked from + somewhere - the build process does not need to worry about its origin. + </para> + + <para> + There are two types of output, one is just about creating a directory + in <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. + A good example is the output of either + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + or + <link linkend='ref-tasks-package'><filename>do_package</filename></link>. + The other type of output occurs when a set of data is merged into a shared directory + tree such as the sysroot. + </para> + + <para> + The Yocto Project team has tried to keep the details of the + implementation hidden in <filename>sstate</filename> class. + From a user's perspective, adding shared state wrapping to a task + is as simple as this + <link linkend='ref-tasks-deploy'><filename>do_deploy</filename></link> + example taken from the + <link linkend='ref-classes-deploy'><filename>deploy</filename></link> + class: + <literallayout class='monospaced'> + DEPLOYDIR = "${WORKDIR}/deploy-${PN}" + SSTATETASKS += "do_deploy" + do_deploy[sstate-inputdirs] = "${DEPLOYDIR}" + do_deploy[sstate-outputdirs] = "${DEPLOY_DIR_IMAGE}" + + python do_deploy_setscene () { + sstate_setscene(d) + } + addtask do_deploy_setscene + do_deploy[dirs] = "${DEPLOYDIR} ${B}" + </literallayout> + In this example, we add some extra flags to the task, a name field ("deploy"), an + input directory where the task sends data, and the output + directory where the data from the task should eventually be copied. + We also add a <filename>_setscene</filename> variant of the task and add the task + name to the <filename>SSTATETASKS</filename> list. + </para> + + <para> + If you have a directory whose contents you need to preserve, you can do this with + a line like the following: + <literallayout class='monospaced'> + do_package[sstate-plaindirs] = "${PKGD} ${PKGDEST}" + </literallayout> + This method, as well as the following example, also works for multiple directories. + <literallayout class='monospaced'> + do_package[sstate-inputdirs] = "${PKGDESTWORK} ${SHLIBSWORKDIR}" + do_package[sstate-outputdirs] = "${PKGDATA_DIR} ${SHLIBSDIR}" + do_package[sstate-lockfile] = "${PACKAGELOCK}" + </literallayout> + These methods also include the ability to take a lockfile when manipulating + shared state directory structures since some cases are sensitive to file + additions or removals. + </para> + + <para> + Behind the scenes, the shared state code works by looking in + <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link> and + <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> + for shared state files. + Here is an example: + <literallayout class='monospaced'> + SSTATE_MIRRORS ?= "\ + file://.* http://someserver.tld/share/sstate/PATH \n \ + file://.* file:///some/local/dir/sstate/PATH" + </literallayout> + <note> + The shared state directory (<filename>SSTATE_DIR</filename>) is + organized into two-character subdirectories, where the subdirectory + names are based on the first two characters of the hash. + If the shared state directory structure for a mirror has the + same structure as <filename>SSTATE_DIR</filename>, you must + specify "PATH" as part of the URI to enable the build system + to map to the appropriate subdirectory. + </note> + </para> + + <para> + The shared state package validity can be detected just by looking at the + filename since the filename contains the task checksum (or signature) as + described earlier in this section. + If a valid shared state package is found, the build process downloads it + and uses it to accelerate the task. + </para> + + <para> + The build processes use the <filename>*_setscene</filename> tasks + for the task acceleration phase. + BitBake goes through this phase before the main execution code and tries + to accelerate any tasks for which it can find shared state packages. + If a shared state package for a task is available, the shared state + package is used. + This means the task and any tasks on which it is dependent are not + executed. + </para> + + <para> + As a real world example, the aim is when building an IPK-based image, + only the + <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> + tasks would have their + shared state packages fetched and extracted. + Since the sysroot is not used, it would never get extracted. + This is another reason why a task-based approach is preferred over a + recipe-based approach, which would have to install the output from every task. + </para> + </section> + + <section id='tips-and-tricks'> + <title>Tips and Tricks</title> + + <para> + The code in the build system that supports incremental builds is not + simple code. + This section presents some tips and tricks that help you work around + issues related to shared state code. + </para> + + <section id='debugging'> + <title>Debugging</title> + + <para> + When things go wrong, debugging needs to be straightforward. + Because of this, the Yocto Project includes strong debugging + tools: + <itemizedlist> + <listitem><para>Whenever a shared state package is written + out into the + <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>, + a corresponding <filename>.siginfo</filename> file is + also written. + This file contains a pickled Python database of all + the Metadata that went into creating the hash for a + given shared state package. + Whenever a stamp is written into the stamp directory + <link linkend='var-STAMP'><filename>STAMP</filename></link>, + a corresponding <filename>.sigdata</filename> file + is created that contains the same hash data that + represented the executed task. + </para></listitem> + <listitem><para>You can use BitBake to dump out the + signature construction information without executing + tasks by using either of the following BitBake + command-line options: + <literallayout class='monospaced'> + ‐‐dump-signatures=<replaceable>SIGNATURE_HANDLER</replaceable> + -S <replaceable>SIGNATURE_HANDLER</replaceable> + </literallayout> + <note> + Two common values for + <replaceable>SIGNATURE_HANDLER</replaceable> are + "none" and "printdiff" to only dump the signature + or to compare the dumped signature with the + cached one, respectively. + </note> + Using BitBake with either of these options causes + BitBake to dump out <filename>.sigdata</filename> files + in the stamp directory for every task it would have + executed instead of building the specified target + package. + </para></listitem> + <listitem><para>There is a + <filename>bitbake-diffsigs</filename> command that + can process <filename>.sigdata</filename> and + <filename>.siginfo</filename> files. + If you specify one of these files, BitBake dumps out + the dependency information in the file. + If you specify two files, BitBake compares the two + files and dumps out the differences between the two. + This more easily helps answer the question of "What + changed between X and Y?"</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='invalidating-shared-state'> + <title>Invalidating Shared State</title> + + <para> + The OpenEmbedded build system uses checksums and shared state + cache to avoid unnecessarily rebuilding tasks. + Collectively, this scheme is known as "shared state code." + </para> + + <para> + As with all schemes, this one has some drawbacks. + It is possible that you could make implicit changes to your + code that the checksum calculations do not take into + account. + These implicit changes affect a task's output but do not trigger + the shared state code into rebuilding a recipe. + Consider an example during which a tool changes its output. + Assume that the output of <filename>rpmdeps</filename> changes. + The result of the change should be that all the + <filename>package</filename> and + <filename>package_write_rpm</filename> shared state cache + items become invalid. + However, because the change to the output is + external to the code and therefore implicit, + the associated shared state cache items do not become + invalidated. + In this case, the build process uses the cached items rather + than running the task again. + Obviously, these types of implicit changes can cause problems. + </para> + + <para> + To avoid these problems during the build, you need to + understand the effects of any changes you make. + Realize that changes you make directly to a function + are automatically factored into the checksum calculation. + Thus, these explicit changes invalidate the associated area of + shared state cache. + However, you need to be aware of any implicit changes that + are not obvious changes to the code and could affect the output + of a given task. + </para> + + <para> + When you identify an implicit change, you can easily take steps + to invalidate the cache and force the tasks to run. + The steps you can take are as simple as changing a function's + comments in the source code. + For example, to invalidate package shared state files, change + the comment statements of + <link linkend='ref-tasks-package'><filename>do_package</filename></link> + or the comments of one of the functions it calls. + Even though the change is purely cosmetic, it causes the + checksum to be recalculated and forces the OpenEmbedded build + system to run the task again. + </para> + + <note> + For an example of a commit that makes a cosmetic change to + invalidate shared state, see this + <ulink url='&YOCTO_GIT_URL;/cgit.cgi/poky/commit/meta/classes/package.bbclass?id=737f8bbb4f27b4837047cb9b4fbfe01dfde36d54'>commit</ulink>. + </note> + </section> + </section> +</section> + +<section id='x32'> + <title>x32</title> + + <para> + x32 is a processor-specific Application Binary Interface (psABI) for x86_64. + An ABI defines the calling conventions between functions in a processing environment. + The interface determines what registers are used and what the sizes are for various C data types. + </para> + + <para> + Some processing environments prefer using 32-bit applications even when running + on Intel 64-bit platforms. + Consider the i386 psABI, which is a very old 32-bit ABI for Intel 64-bit platforms. + The i386 psABI does not provide efficient use and access of the Intel 64-bit processor resources, + leaving the system underutilized. + Now consider the x86_64 psABI. + This ABI is newer and uses 64-bits for data sizes and program pointers. + The extra bits increase the footprint size of the programs, libraries, + and also increases the memory and file system size requirements. + Executing under the x32 psABI enables user programs to utilize CPU and system resources + more efficiently while keeping the memory footprint of the applications low. + Extra bits are used for registers but not for addressing mechanisms. + </para> + + <section id='support'> + <title>Support</title> + + <para> + This Yocto Project release supports the final specifications of x32 + psABI. + Support for x32 psABI exists as follows: + <itemizedlist> + <listitem><para>You can create packages and images in x32 psABI format on x86_64 architecture targets. + </para></listitem> + <listitem><para>You can successfully build many recipes with the x32 toolchain.</para></listitem> + <listitem><para>You can create and boot <filename>core-image-minimal</filename> and + <filename>core-image-sato</filename> images.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='completing-x32'> + <title>Completing x32</title> + + <para> + Future Plans for the x32 psABI in the Yocto Project include the following: + <itemizedlist> + <listitem><para>Enhance and fix the few remaining recipes so they + work with and support x32 toolchains.</para></listitem> + <listitem><para>Enhance RPM Package Manager (RPM) support for x32 binaries.</para></listitem> + <listitem><para>Support larger images.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id='using-x32-right-now'> + <title>Using x32 Right Now</title> + + <para> + Follow these steps to use the x32 spABI: + <itemizedlist> + <listitem><para>Enable the x32 psABI tuning file for <filename>x86_64</filename> + machines by editing the <filename>conf/local.conf</filename> like this: + <literallayout class='monospaced'> + MACHINE = "qemux86-64" + DEFAULTTUNE = "x86-64-x32" + baselib = "${@d.getVar('BASE_LIB_tune-' + (d.getVar('DEFAULTTUNE', True) \ + or 'INVALID'), True) or 'lib'}" + #MACHINE = "genericx86" + #DEFAULTTUNE = "core2-64-x32" + </literallayout></para></listitem> + <listitem><para>As usual, use BitBake to build an image that supports the x32 psABI. + Here is an example: + <literallayout class='monospaced'> + $ bitbake core-image-sato + </literallayout></para></listitem> + <listitem><para>As usual, run your image using QEMU: + <literallayout class='monospaced'> + $ runqemu qemux86-64 core-image-sato + </literallayout></para></listitem> + </itemizedlist> + </para> + </section> +</section> + +<section id="wayland"> + <title>Wayland</title> + + <para> + <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)'>Wayland</ulink> + is a computer display server protocol that + provides a method for compositing window managers to communicate + directly with applications and video hardware and expects them to + communicate with input hardware using other libraries. + Using Wayland with supporting targets can result in better control + over graphics frame rendering than an application might otherwise + achieve. + </para> + + <para> + The Yocto Project provides the Wayland protocol libraries and the + reference + <ulink url='http://en.wikipedia.org/wiki/Wayland_(display_server_protocol)#Weston'>Weston</ulink> + compositor as part of its release. + This section describes what you need to do to implement Wayland and + use the compositor when building an image for a supporting target. + </para> + + <section id="wayland-support"> + <title>Support</title> + + <para> + The Wayland protocol libraries and the reference Weston compositor + ship as integrated packages in the <filename>meta</filename> layer + of the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + Specifically, you can find the recipes that build both Wayland + and Weston at <filename>meta/recipes-graphics/wayland</filename>. + </para> + + <para> + You can build both the Wayland and Weston packages for use only + with targets that accept the + <ulink url='http://dri.freedesktop.org/wiki/'>Mesa 3D and Direct Rendering Infrastructure</ulink>, + which is also known as Mesa DRI. + This implies that you cannot build and use the packages if your + target uses, for example, the + <trademark class='registered'>Intel</trademark> Embedded Media and + Graphics Driver (<trademark class='registered'>Intel</trademark> + EMGD) that overrides Mesa DRI. + </para> + + <note> + Due to lack of EGL support, Weston 1.0.3 will not run directly on + the emulated QEMU hardware. + However, this version of Weston will run under X emulation without + issues. + </note> + </section> + + <section id="enabling-wayland-in-an-image"> + <title>Enabling Wayland in an Image</title> + + <para> + To enable Wayland, you need to enable it to be built and enable + it to be included in the image. + </para> + + <section id="enable-building"> + <title>Building</title> + + <para> + To cause Mesa to build the <filename>wayland-egl</filename> + platform and Weston to build Wayland with Kernel Mode + Setting + (<ulink url='https://wiki.archlinux.org/index.php/Kernel_Mode_Setting'>KMS</ulink>) + support, include the "wayland" flag in the + <link linkend="var-DISTRO_FEATURES"><filename>DISTRO_FEATURES</filename></link> + statement in your <filename>local.conf</filename> file: + <literallayout class='monospaced'> + DISTRO_FEATURES_append = " wayland" + </literallayout> + </para> + + <note> + If X11 has been enabled elsewhere, Weston will build Wayland + with X11 support + </note> + </section> + + <section id="enable-installation-in-an-image"> + <title>Installing</title> + + <para> + To install the Wayland feature into an image, you must + include the following + <link linkend='var-CORE_IMAGE_EXTRA_INSTALL'><filename>CORE_IMAGE_EXTRA_INSTALL</filename></link> + statement in your <filename>local.conf</filename> file: + <literallayout class='monospaced'> + CORE_IMAGE_EXTRA_INSTALL += "wayland weston" + </literallayout> + </para> + </section> + </section> + + <section id="running-weston"> + <title>Running Weston</title> + + <para> + To run Weston inside X11, enabling it as described earlier and + building a Sato image is sufficient. + If you are running your image under Sato, a Weston Launcher appears + in the "Utility" category. + </para> + + <para> + Alternatively, you can run Weston through the command-line + interpretor (CLI), which is better suited for development work. + To run Weston under the CLI, you need to do the following after + your image is built: + <orderedlist> + <listitem><para>Run these commands to export + <filename>XDG_RUNTIME_DIR</filename>: + <literallayout class='monospaced'> + mkdir -p /tmp/$USER-weston + chmod 0700 /tmp/$USER-weston + export XDG_RUNTIME_DIR=/tmp/$USER-weston + </literallayout></para></listitem> + <listitem><para>Launch Weston in the shell: + <literallayout class='monospaced'> + weston + </literallayout></para></listitem> + </orderedlist> + </para> + </section> +</section> + +<section id="licenses"> + <title>Licenses</title> + + <para> + This section describes the mechanism by which the OpenEmbedded build system + tracks changes to licensing text. + The section also describes how to enable commercially licensed recipes, + which by default are disabled. + </para> + + <para> + For information that can help you maintain compliance with various open + source licensing during the lifecycle of the product, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Project's Lifecycle</ulink>" section + in the Yocto Project Development Manual. + </para> + + <section id="usingpoky-configuring-LIC_FILES_CHKSUM"> + <title>Tracking License Changes</title> + + <para> + The license of an upstream project might change in the future. + In order to prevent these changes going unnoticed, the + <filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link></filename> + variable tracks changes to the license text. The checksums are validated at the end of the + configure step, and if the checksums do not match, the build will fail. + </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 source code for the recipe. + Following is an example of how to specify <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 build system uses the + <filename><link linkend='var-S'>S</link></filename> variable as + the default directory when searching files listed in + <filename>LIC_FILES_CHKSUM</filename>. + The previous example employs the default directory. + </para> + + <para> + Consider this next example: + <literallayout class='monospaced'> + LIC_FILES_CHKSUM = "file://src/ls.c;beginline=5;endline=16;\ + md5=bb14ed3c4cda583abc85401304b5cd4e" + LIC_FILES_CHKSUM = "file://${WORKDIR}/license.html;md5=5c94767cedb5d6987c902ac850ded2c6" + </literallayout> + </para> + + <para> + The first line locates a file in + <filename>${S}/src/ls.c</filename>. + The second line refers to a file in + <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>. + </para> + <para> + Note that <filename>LIC_FILES_CHKSUM</filename> variable is + mandatory for all recipes, unless the + <filename>LICENSE</filename> variable is set to "CLOSED". + </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. + It is possible to specify a checksum for an entire file, or a specific section of a + file (specified by beginning and ending line numbers with the "beginline" and "endline" + parameters, respectively). + The latter is useful for source files with a license notice header, + README documents, and so forth. + 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 with 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 mismatch 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 mismatch occurs during the build, the correct md5 + checksum is placed in the build log and can be easily copied to the recipe. + </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 allows 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="enabling-commercially-licensed-recipes"> + <title>Enabling Commercially Licensed Recipes</title> + + <para> + By default, the OpenEmbedded build system disables + components that have commercial or other special licensing + requirements. + Such requirements are defined on a + recipe-by-recipe basis through the + <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link> + variable definition in the affected recipe. + For instance, the + <filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename> + recipe contains the following statement: + <literallayout class='monospaced'> + LICENSE_FLAGS = "commercial" + </literallayout> + Here is a slightly more complicated example that contains both an + explicit recipe name and version (after variable expansion): + <literallayout class='monospaced'> + LICENSE_FLAGS = "license_${PN}_${PV}" + </literallayout> + In order for a component restricted by a <filename>LICENSE_FLAGS</filename> + definition to be enabled and included in an image, it + needs to have a matching entry in the global + <link linkend='var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></link> + variable, which is a variable + typically defined in your <filename>local.conf</filename> file. + For example, to enable + the <filename>poky/meta/recipes-multimedia/gstreamer/gst-plugins-ugly</filename> + package, you could add either the string + "commercial_gst-plugins-ugly" or the more general string + "commercial" to <filename>LICENSE_FLAGS_WHITELIST</filename>. + See the + "<link linkend='license-flag-matching'>License Flag Matching</link>" section + for a full explanation of how <filename>LICENSE_FLAGS</filename> matching works. + Here is the example: + <literallayout class='monospaced'> + LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly" + </literallayout> + Likewise, to additionally enable the package built from the recipe containing + <filename>LICENSE_FLAGS = "license_${PN}_${PV}"</filename>, and assuming + that the actual recipe name was <filename>emgd_1.10.bb</filename>, + the following string would enable that package as well as + the original <filename>gst-plugins-ugly</filename> package: + <literallayout class='monospaced'> + LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly license_emgd_1.10" + </literallayout> + As a convenience, you do not need to specify the complete license string + in the whitelist for every package. + You can use an abbreviated form, which consists + of just the first portion or portions of the license string before + the initial underscore character or characters. + A partial string will match + any license that contains the given string as the first + portion of its license. + For example, the following + whitelist string will also match both of the packages + previously mentioned as well as any other packages that have + licenses starting with "commercial" or "license". + <literallayout class='monospaced'> + LICENSE_FLAGS_WHITELIST = "commercial license" + </literallayout> + </para> + + <section id="license-flag-matching"> + <title>License Flag Matching</title> + + <para> + License flag matching allows you to control what recipes the + OpenEmbedded build system includes in the build. + Fundamentally, the build system attempts to match + <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link> + strings found in recipes against + <link linkend='var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></link> + strings found in the whitelist. + A match causes the build system to include a recipe in the + build, while failure to find a match causes the build system to + exclude a recipe. + </para> + + <para> + In general, license flag matching is simple. + However, understanding some concepts will help you + correctly and effectively use matching. + </para> + + <para> + Before a flag + defined by a particular recipe is tested against the + contents of the whitelist, the expanded string + <filename>_${PN}</filename> is appended to the flag. + This expansion makes each <filename>LICENSE_FLAGS</filename> + value recipe-specific. + After expansion, the string is then matched against the + whitelist. + Thus, specifying + <filename>LICENSE_FLAGS = "commercial"</filename> + in recipe "foo", for example, results in the string + <filename>"commercial_foo"</filename>. + And, to create a match, that string must appear in the + whitelist. + </para> + + <para> + Judicious use of the <filename>LICENSE_FLAGS</filename> + strings and the contents of the + <filename>LICENSE_FLAGS_WHITELIST</filename> variable + allows you a lot of flexibility for including or excluding + recipes based on licensing. + For example, you can broaden the matching capabilities by + using license flags string subsets in the whitelist. + <note>When using a string subset, be sure to use the part of + the expanded string that precedes the appended underscore + character (e.g. <filename>usethispart_1.3</filename>, + <filename>usethispart_1.4</filename>, and so forth). + </note> + For example, simply specifying the string "commercial" in + the whitelist matches any expanded + <filename>LICENSE_FLAGS</filename> definition that starts with + the string "commercial" such as "commercial_foo" and + "commercial_bar", which are the strings the build system + automatically generates for hypothetical recipes named + "foo" and "bar" assuming those recipes simply specify the + following: + <literallayout class='monospaced'> + LICENSE_FLAGS = "commercial" + </literallayout> + Thus, you can choose to exhaustively + enumerate each license flag in the whitelist and + allow only specific recipes into the image, or + you can use a string subset that causes a broader range of + matches to allow a range of recipes into the image. + </para> + + <para> + This scheme works even if the + <filename>LICENSE_FLAGS</filename> string already + has <filename>_${PN}</filename> appended. + For example, the build system turns the license flag + "commercial_1.2_foo" into "commercial_1.2_foo_foo" and would + match both the general "commercial" and the specific + "commercial_1.2_foo" strings found in the whitelist, as + expected. + </para> + + <para> + Here are some other scenarios: + <itemizedlist> + <listitem><para>You can specify a versioned string in the + recipe such as "commercial_foo_1.2" in a "foo" recipe. + The build system expands this string to + "commercial_foo_1.2_foo". + Combine this license flag with a whitelist that has + the string "commercial" and you match the flag along + with any other flag that starts with the string + "commercial".</para></listitem> + <listitem><para>Under the same circumstances, you can + use "commercial_foo" in the whitelist and the + build system not only matches "commercial_foo_1.2" but + also matches any license flag with the string + "commercial_foo", regardless of the version. + </para></listitem> + <listitem><para>You can be very specific and use both the + package and version parts in the whitelist (e.g. + "commercial_foo_1.2") to specifically match a + versioned recipe.</para></listitem> + </itemizedlist> + </para> + </section> + + <section id="other-variables-related-to-commercial-licenses"> + <title>Other Variables Related to Commercial Licenses</title> + + <para> + Other helpful variables related to commercial + license handling exist and are defined in the + <filename>poky/meta/conf/distro/include/default-distrovars.inc</filename> file: + <literallayout class='monospaced'> + COMMERCIAL_AUDIO_PLUGINS ?= "" + COMMERCIAL_VIDEO_PLUGINS ?= "" + </literallayout> + If you want to enable these components, you can do so by making sure you have + statements similar to the following + in your <filename>local.conf</filename> configuration file: + <literallayout class='monospaced'> + COMMERCIAL_AUDIO_PLUGINS = "gst-plugins-ugly-mad \ + gst-plugins-ugly-mpegaudioparse" + COMMERCIAL_VIDEO_PLUGINS = "gst-plugins-ugly-mpeg2dec \ + gst-plugins-ugly-mpegstream gst-plugins-bad-mpegvideoparse" + LICENSE_FLAGS_WHITELIST = "commercial_gst-plugins-ugly commercial_gst-plugins-bad commercial_qmmp" + </literallayout> + Of course, you could also create a matching whitelist + for those components using the more general "commercial" + in the whitelist, but that would also enable all the + other packages with + <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link> + containing "commercial", which you may or may not want: + <literallayout class='monospaced'> + LICENSE_FLAGS_WHITELIST = "commercial" + </literallayout> + </para> + + <para> + Specifying audio and video plug-ins as part of the + <filename>COMMERCIAL_AUDIO_PLUGINS</filename> and + <filename>COMMERCIAL_VIDEO_PLUGINS</filename> statements + (along with the enabling + <filename>LICENSE_FLAGS_WHITELIST</filename>) includes the + plug-ins or components into built images, thus adding + support for media formats or components. + </para> + </section> + </section> +</section> +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> diff --git a/import-layers/yocto-poky/documentation/ref-manual/usingpoky.xml b/import-layers/yocto-poky/documentation/ref-manual/usingpoky.xml new file mode 100644 index 000000000..a7bf32d45 --- /dev/null +++ b/import-layers/yocto-poky/documentation/ref-manual/usingpoky.xml @@ -0,0 +1,1132 @@ +<!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='usingpoky'> +<title>Using the Yocto Project</title> + + <para> + This chapter describes common usage for the Yocto Project. + The information is introductory in nature as other manuals in the Yocto Project + documentation set provide more details on how to use the Yocto Project. + </para> + +<section id='usingpoky-build'> + <title>Running a Build</title> + + <para> + This section provides a summary of the build process and provides information + for less obvious aspects of the build process. + For general information on how to build an image using the OpenEmbedded build + system, see the + "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" + section of the Yocto Project Quick Start. + </para> + + <section id='build-overview'> + <title>Build Overview</title> + + <para> + In the development environment you will need to build an image whenever you change hardware + support, add or change system libraries, or add or change services that have dependencies. + </para> + + <mediaobject> + <imageobject> + <imagedata fileref="figures/building-an-image.png" format="PNG" align='center' scalefit='1'/> + </imageobject> + <caption> + <para>Building an Image</para> + </caption> + </mediaobject> + + <para> + The first thing you need to do is set up the OpenEmbedded build + environment by sourcing an environment setup script + (i.e. + <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> + or + <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). + Here is an example: + <literallayout class='monospaced'> + $ source &OE_INIT_FILE; [<replaceable>build_dir</replaceable>] + </literallayout> + </para> + + <para> + The <replaceable>build_dir</replaceable> argument is optional and specifies the directory the + OpenEmbedded build system uses for the build - + the <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. + If you do not specify a Build Directory, it defaults to a directory + named <filename>build</filename> in your current working directory. + A common practice is to use a different Build Directory for different targets. + For example, <filename>~/build/x86</filename> for a <filename>qemux86</filename> + target, and <filename>~/build/arm</filename> for a <filename>qemuarm</filename> target. + </para> + + <para> + Once the build environment is set up, you can build a target using: + <literallayout class='monospaced'> + $ bitbake <replaceable>target</replaceable> + </literallayout> + </para> + + <para> + The <replaceable>target</replaceable> is the name of the recipe you want to build. + Common targets are the images in <filename>meta/recipes-core/images</filename>, + <filename>meta/recipes-sato/images</filename>, etc. all found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + Or, the target can be the name of a recipe for a specific piece of software such as + BusyBox. + For more details about the images the OpenEmbedded build system supports, see the + "<link linkend="ref-images">Images</link>" chapter. + </para> + + <note> + Building an image without GNU General Public License Version + 3 (GPLv3), or similarly licensed, components is supported for + only minimal and base images. + See the "<link linkend='ref-images'>Images</link>" chapter for more information. + </note> + </section> + + <section id='building-an-image-using-gpl-components'> + <title>Building an Image Using GPL Components</title> + + <para> + When building an image using GPL components, you need to maintain your original + settings and not switch back and forth applying different versions of the GNU + General Public License. + If you rebuild using different versions of GPL, dependency errors might occur + due to some components not being rebuilt. + </para> + </section> +</section> + +<section id='usingpoky-install'> + <title>Installing and Using the Result</title> + + <para> + Once an image has been built, it often needs to be installed. + The images and kernels built by the OpenEmbedded build system are placed in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> in + <filename class="directory">tmp/deploy/images</filename>. + For information on how to run pre-built images such as <filename>qemux86</filename> + and <filename>qemuarm</filename>, see the + <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-manual'>Yocto Project Software Development Kit (SDK) Developer's Guide</ulink>. + For information about how to install these images, see the documentation for your + particular board or machine. + </para> +</section> + +<section id='usingpoky-debugging'> + <title>Debugging Build Failures</title> + + <para> + The exact method for debugging build failures depends on the nature of + the problem and on the system's area from which the bug originates. + Standard debugging practices such as comparison against the last + known working version with examination of the changes and the + re-application of steps to identify the one causing the problem are + valid for the Yocto Project just as they are for any other system. + Even though it is impossible to detail every possible potential failure, + this section provides some general tips to aid in debugging. + </para> + + <para> + A useful feature for debugging is the error reporting tool. + Configuring the Yocto Project to use this tool causes the + OpenEmbedded build system to produce error reporting commands as + part of the console output. + You can enter the commands after the build completes + to log error information + into a common database, that can help you figure out what might be + going wrong. + For information on how to enable and use this feature, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>Using the Error Reporting Tool</ulink>" + section in the Yocto Project Development Manual. + </para> + + <para> + For discussions on debugging, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" section + in the Yocto Project Developer's Manual + and the + "<ulink url='&YOCTO_DOCS_SDK_URL;#adt-eclipse'>Working within Eclipse</ulink>" + section in the Yocto Project Software Development Kit (SDK) Developer's Guide. + </para> + + <note> + The remainder of this section presents many examples of the + <filename>bitbake</filename> command. + You can learn about BitBake by reading the + <ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual'>BitBake User Manual</ulink>. + </note> + + + <section id='usingpoky-debugging-taskfailures'> + <title>Task Failures</title> + + <para>The log file for shell tasks is available in + <filename>${WORKDIR}/temp/log.do_<replaceable>taskname</replaceable>.pid</filename>. + For example, the <filename>do_compile</filename> task for the QEMU minimal image for the x86 + machine (<filename>qemux86</filename>) might be + <filename>tmp/work/qemux86-poky-linux/core-image-minimal/1.0-r0/temp/log.do_compile.20830</filename>. + To see what + <ulink url='&YOCTO_DOCS_DEV_URL;#bitbake-term'>BitBake</ulink> + runs to generate that log, look at the corresponding + <filename>run.do_<replaceable>taskname</replaceable>.pid</filename> file located in the same directory. + </para> + + <para> + Presently, the output from Python tasks is sent directly to the console. + </para> + </section> + + <section id='usingpoky-debugging-taskrunning'> + <title>Running Specific Tasks</title> + + <para> + Any given package consists of a set of tasks. + The standard BitBake behavior in most cases is: + <filename>do_fetch</filename>, + <filename>do_unpack</filename>, + <filename>do_patch</filename>, <filename>do_configure</filename>, + <filename>do_compile</filename>, <filename>do_install</filename>, + <filename>do_package</filename>, + <filename>do_package_write_*</filename>, and + <filename>do_build</filename>. + The default task is <filename>do_build</filename> and any tasks + on which it depends build first. + Some tasks, such as <filename>do_devshell</filename>, are not part + of the default build chain. + If you wish to run a task that is not part of the default build + chain, you can use the <filename>-c</filename> option in BitBake. + Here is an example: + <literallayout class='monospaced'> + $ bitbake matchbox-desktop -c devshell + </literallayout> + </para> + + <para> + If you wish to rerun a task, use the <filename>-f</filename> force + option. + For example, the following sequence forces recompilation after + changing files in the work directory. + <literallayout class='monospaced'> + $ bitbake matchbox-desktop + . + . + <replaceable>make some changes to the source code in the work directory</replaceable> + . + . + $ bitbake matchbox-desktop -c compile -f + $ bitbake matchbox-desktop + </literallayout> + </para> + + <para> + This sequence first builds and then recompiles + <filename>matchbox-desktop</filename>. + The last command reruns all tasks (basically the packaging tasks) + after the compile. + BitBake recognizes that the <filename>do_compile</filename> + task was rerun and therefore understands that the other tasks + also need to be run again. + </para> + + <para> + You can view a list of tasks in a given package by running the + <filename>do_listtasks</filename> task as follows: + <literallayout class='monospaced'> + $ bitbake matchbox-desktop -c listtasks + </literallayout> + The results appear as output to the console and are also in the + file <filename>${WORKDIR}/temp/log.do_listtasks</filename>. + </para> + </section> + + <section id='usingpoky-debugging-dependencies'> + <title>Dependency Graphs</title> + + <para> + Sometimes it can be hard to see why BitBake wants to build + other packages before building a given package you have specified. + The <filename>bitbake -g <replaceable>targetname</replaceable></filename> command + creates the <filename>pn-buildlist</filename>, + <filename>pn-depends.dot</filename>, + <filename>package-depends.dot</filename>, and + <filename>task-depends.dot</filename> files in the current + directory. + These files show what will be built and the package and task + dependencies, which are useful for debugging problems. + You can use the + <filename>bitbake -g -u depexp <replaceable>targetname</replaceable></filename> + command to display the results in a more human-readable form. + </para> + </section> + + <section id='usingpoky-debugging-bitbake'> + <title>General BitBake Problems</title> + + <para> + You can see debug output from BitBake by using the <filename>-D</filename> option. + The debug output gives more information about what BitBake + is doing and the reason behind it. + Each <filename>-D</filename> option you use increases the logging level. + The most common usage is <filename>-DDD</filename>. + </para> + + <para> + The output from <filename>bitbake -DDD -v</filename> <replaceable>targetname</replaceable> can reveal why + BitBake chose a certain version of a package or why BitBake + picked a certain provider. + This command could also help you in a situation where you think BitBake did something + unexpected. + </para> + </section> + + <section id='development-host-system-issues'> + <title>Development Host System Issues</title> + + <para> + Sometimes issues on the host development system can cause your + build to fail. + Following are known, host-specific problems. + Be sure to always consult the + <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink> + for a look at all release-related issues. + <itemizedlist> + <listitem><para><emphasis><filename>glibc-initial</filename> fails to build</emphasis>: + If your development host system has the unpatched + <filename>GNU Make 3.82</filename>, + the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task fails for <filename>glibc-initial</filename> during + the build.</para> + <para>Typically, every distribution that ships + <filename>GNU Make 3.82</filename> as + the default already has the patched version. + However, some distributions, such as Debian, have + <filename>GNU Make 3.82</filename> as an option, which + is unpatched. + You will see this error on these types of distributions. + Switch to <filename>GNU Make 3.81</filename> or patch + your <filename>make</filename> to solve the problem. + </para></listitem> + </itemizedlist> + </para> + </section> + + <section id='usingpoky-debugging-buildfile'> + <title>Building with No Dependencies</title> + <para> + To build a specific recipe (<filename>.bb</filename> file), + you can use the following command form: + <literallayout class='monospaced'> + $ bitbake -b <replaceable>somepath</replaceable>/<replaceable>somerecipe</replaceable>.bb + </literallayout> + This command form does not check for dependencies. + Consequently, you should use it + only when you know existing dependencies have been met. + <note> + You can also specify fragments of the filename. + In this case, BitBake checks for a unique match. + </note> + </para> + </section> + + <section id='usingpoky-debugging-variables'> + <title>Variables</title> + <para> + You can use the <filename>-e</filename> BitBake option to + display the parsing environment for a configuration. + The following displays the general parsing environment: + <literallayout class='monospaced'> + $ bitbake -e + </literallayout> + This next example shows the parsing environment for a specific + recipe: + <literallayout class='monospaced'> + $ bitbake -e <replaceable>recipename</replaceable> + </literallayout> + </para> + </section> + + <section id='recipe-logging-mechanisms'> + <title>Recipe Logging Mechanisms</title> + <para> + Best practices exist while writing recipes that both log build progress and + act on build conditions such as warnings and errors. + Both Python and Bash language bindings exist for the logging mechanism: + <itemizedlist> + <listitem><para><emphasis>Python:</emphasis> For Python functions, BitBake + supports several loglevels: <filename>bb.fatal</filename>, + <filename>bb.error</filename>, <filename>bb.warn</filename>, + <filename>bb.note</filename>, <filename>bb.plain</filename>, + and <filename>bb.debug</filename>.</para></listitem> + <listitem><para><emphasis>Bash:</emphasis> For Bash functions, the same set + of loglevels exist and are accessed with a similar syntax: + <filename>bbfatal</filename>, <filename>bberror</filename>, + <filename>bbwarn</filename>, <filename>bbnote</filename>, + <filename>bbplain</filename>, and <filename>bbdebug</filename>.</para></listitem> + </itemizedlist> + </para> + + <para> + For guidance on how logging is handled in both Python and Bash recipes, see the + <filename>logging.bbclass</filename> file in the + <filename>meta/classes</filename> folder of the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. + </para> + + <section id='logging-with-python'> + <title>Logging With Python</title> + <para> + When creating recipes using Python and inserting code that handles build logs, + keep in mind the goal is to have informative logs while keeping the console as + "silent" as possible. + Also, if you want status messages in the log, use the "debug" loglevel. + </para> + + <para> + Following is an example written in Python. + The code handles logging for a function that determines the + number of tasks needed to be run. + See the + "<link linkend='ref-tasks-listtasks'><filename>do_listtasks</filename></link>" + section for additional information: + <literallayout class='monospaced'> + python do_listtasks() { + bb.debug(2, "Starting to figure out the task list") + if noteworthy_condition: + bb.note("There are 47 tasks to run") + bb.debug(2, "Got to point xyz") + if warning_trigger: + bb.warn("Detected warning_trigger, this might be a problem later.") + if recoverable_error: + bb.error("Hit recoverable_error, you really need to fix this!") + if fatal_error: + bb.fatal("fatal_error detected, unable to print the task list") + bb.plain("The tasks present are abc") + bb.debug(2, "Finished figuring out the tasklist") + } + </literallayout> + </para> + </section> + + <section id='logging-with-bash'> + <title>Logging With Bash</title> + <para> + When creating recipes using Bash and inserting code that handles build + logs, you have the same goals - informative with minimal console output. + The syntax you use for recipes written in Bash is similar to that of + recipes written in Python described in the previous section. + </para> + + <para> + Following is an example written in Bash. + The code logs the progress of the <filename>do_my_function</filename> function. + <literallayout class='monospaced'> + do_my_function() { + bbdebug 2 "Running do_my_function" + if [ exceptional_condition ]; then + bbnote "Hit exceptional_condition" + fi + bbdebug 2 "Got to point xyz" + if [ warning_trigger ]; then + bbwarn "Detected warning_trigger, this might cause a problem later." + fi + if [ recoverable_error ]; then + bberror "Hit recoverable_error, correcting" + fi + if [ fatal_error ]; then + bbfatal "fatal_error detected" + fi + bbdebug 2 "Completed do_my_function" + } + </literallayout> + </para> + </section> + </section> + + <section id='usingpoky-debugging-others'> + <title>Other Tips</title> + + <para> + Here are some other tips that you might find useful: + <itemizedlist> + <listitem><para>When adding new packages, it is worth watching for + undesirable items making their way into compiler command lines. + For example, you do not want references to local system files like + <filename>/usr/lib/</filename> or <filename>/usr/include/</filename>. + </para></listitem> + <listitem><para>If you want to remove the <filename>psplash</filename> + boot splashscreen, + add <filename>psplash=false</filename> to the kernel command line. + Doing so prevents <filename>psplash</filename> from loading + and thus allows you to see the console. + It is also possible to switch out of the splashscreen by + switching the virtual console (e.g. Fn+Left or Fn+Right on a Zaurus). + </para></listitem> + </itemizedlist> + </para> + </section> +</section> + +<section id='maintaining-build-output-quality'> + <title>Maintaining Build Output Quality</title> + + <para> + Many factors can influence the quality of a build. + For example, if you upgrade a recipe to use a new version of an upstream software + package or you experiment with some new configuration options, subtle changes + can occur that you might not detect until later. + Consider the case where your recipe is using a newer version of an upstream package. + In this case, a new version of a piece of software might introduce an optional + dependency on another library, which is auto-detected. + If that library has already been built when the software is building, + the software will link to the built library and that library will be pulled + into your image along with the new software even if you did not want the + library. + </para> + + <para> + The + <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> + class exists to help you maintain + the quality of your build output. + You can use the class to highlight unexpected and possibly unwanted + changes in the build output. + When you enable build history, it records information about the contents of + each package and image and then commits that information to a local Git + repository where you can examine the information. + </para> + + <para> + The remainder of this section describes the following: + <itemizedlist> + <listitem><para>How you can enable and disable + build history</para></listitem> + <listitem><para>How to understand what the build history contains + </para></listitem> + <listitem><para>How to limit the information used for build history + </para></listitem> + <listitem><para>How to examine the build history from both a + command-line and web interface</para></listitem> + </itemizedlist> + </para> + + <section id='enabling-and-disabling-build-history'> + <title>Enabling and Disabling Build History</title> + + <para> + Build history is disabled by default. + To enable it, add the following <filename>INHERIT</filename> + statement and set the + <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> + variable to "1" at the end of your + <filename>conf/local.conf</filename> file found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + <literallayout class='monospaced'> + INHERIT += "buildhistory" + BUILDHISTORY_COMMIT = "1" + </literallayout> + Enabling build history as previously described + causes the build process to collect build + output information and commit it to a local + <ulink url='&YOCTO_DOCS_DEV_URL;#git'>Git</ulink> repository. + <note> + Enabling build history increases your build times slightly, + particularly for images, and increases the amount of disk + space used during the build. + </note> + </para> + + <para> + You can disable build history by removing the previous statements + from your <filename>conf/local.conf</filename> file. + </para> + </section> + + <section id='understanding-what-the-build-history-contains'> + <title>Understanding What the Build History Contains</title> + + <para> + Build history information is kept in + <filename>${</filename><link linkend='var-TOPDIR'><filename>TOPDIR</filename></link><filename>}/buildhistory</filename> + in the Build Directory as defined by the + <link linkend='var-BUILDHISTORY_DIR'><filename>BUILDHISTORY_DIR</filename></link> + variable. + The following is an example abbreviated listing: + <imagedata fileref="figures/buildhistory.png" align="center" width="6in" depth="4in" /> + </para> + + <para> + At the top level, there is a <filename>metadata-revs</filename> file + that lists the revisions of the repositories for the layers enabled + when the build was produced. + The rest of the data splits into separate + <filename>packages</filename>, <filename>images</filename> and + <filename>sdk</filename> directories, the contents of which are + described below. + </para> + + <section id='build-history-package-information'> + <title>Build History Package Information</title> + + <para> + The history for each package contains a text file that has + name-value pairs with information about the package. + For example, <filename>buildhistory/packages/i586-poky-linux/busybox/busybox/latest</filename> + contains the following: + <literallayout class='monospaced'> + PV = 1.22.1 + PR = r32 + RPROVIDES = + RDEPENDS = glibc (>= 2.20) update-alternatives-opkg + RRECOMMENDS = busybox-syslog busybox-udhcpc update-rc.d + PKGSIZE = 540168 + FILES = /usr/bin/* /usr/sbin/* /usr/lib/busybox/* /usr/lib/lib*.so.* \ + /etc /com /var /bin/* /sbin/* /lib/*.so.* /lib/udev/rules.d \ + /usr/lib/udev/rules.d /usr/share/busybox /usr/lib/busybox/* \ + /usr/share/pixmaps /usr/share/applications /usr/share/idl \ + /usr/share/omf /usr/share/sounds /usr/lib/bonobo/servers + FILELIST = /bin/busybox /bin/busybox.nosuid /bin/busybox.suid /bin/sh \ + /etc/busybox.links.nosuid /etc/busybox.links.suid + </literallayout> + Most of these name-value pairs correspond to variables used + to produce the package. + The exceptions are <filename>FILELIST</filename>, which is the + actual list of files in the package, and + <filename>PKGSIZE</filename>, which is the total size of files + in the package in bytes. + </para> + + <para> + There is also a file corresponding to the recipe from which the + package came (e.g. + <filename>buildhistory/packages/i586-poky-linux/busybox/latest</filename>): + <literallayout class='monospaced'> + PV = 1.22.1 + PR = r32 + DEPENDS = initscripts kern-tools-native update-rc.d-native \ + virtual/i586-poky-linux-compilerlibs virtual/i586-poky-linux-gcc \ + virtual/libc virtual/update-alternatives + PACKAGES = busybox-ptest busybox-httpd busybox-udhcpd busybox-udhcpc \ + busybox-syslog busybox-mdev busybox-hwclock busybox-dbg \ + busybox-staticdev busybox-dev busybox-doc busybox-locale busybox + </literallayout> + </para> + + <para> + Finally, for those recipes fetched from a version control + system (e.g., Git), a file exists that lists source revisions + that are specified in the recipe and lists the actual revisions + used during the build. + Listed and actual revisions might differ when + <link linkend='var-SRCREV'><filename>SRCREV</filename></link> + is set to + <filename>${<link linkend='var-AUTOREV'>AUTOREV</link>}</filename>. + Here is an example assuming + <filename>buildhistory/packages/qemux86-poky-linux/linux-yocto/latest_srcrev</filename>): + <literallayout class='monospaced'> + # SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" + SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" + # SRCREV_meta = "a227f20eff056e511d504b2e490f3774ab260d6f" + SRCREV_meta = "a227f20eff056e511d504b2e490f3774ab260d6f" + </literallayout> + You can use the <filename>buildhistory-collect-srcrevs</filename> + command with the <filename>-a</filename> option to + collect the stored <filename>SRCREV</filename> values + from build history and report them in a format suitable for + use in global configuration (e.g., + <filename>local.conf</filename> or a distro include file) to + override floating <filename>AUTOREV</filename> values to a + fixed set of revisions. + Here is some example output from this command: + <literallayout class='monospaced'> + $ buildhistory-collect-srcrevs -a + # i586-poky-linux + SRCREV_pn-glibc = "b8079dd0d360648e4e8de48656c5c38972621072" + SRCREV_pn-glibc-initial = "b8079dd0d360648e4e8de48656c5c38972621072" + SRCREV_pn-opkg-utils = "53274f087565fd45d8452c5367997ba6a682a37a" + SRCREV_pn-kmod = "fd56638aed3fe147015bfa10ed4a5f7491303cb4" + # x86_64-linux + SRCREV_pn-gtk-doc-stub-native = "1dea266593edb766d6d898c79451ef193eb17cfa" + SRCREV_pn-dtc-native = "65cc4d2748a2c2e6f27f1cf39e07a5dbabd80ebf" + SRCREV_pn-update-rc.d-native = "eca680ddf28d024954895f59a241a622dd575c11" + SRCREV_glibc_pn-cross-localedef-native = "b8079dd0d360648e4e8de48656c5c38972621072" + SRCREV_localedef_pn-cross-localedef-native = "c833367348d39dad7ba018990bfdaffaec8e9ed3" + SRCREV_pn-prelink-native = "faa069deec99bf61418d0bab831c83d7c1b797ca" + SRCREV_pn-opkg-utils-native = "53274f087565fd45d8452c5367997ba6a682a37a" + SRCREV_pn-kern-tools-native = "23345b8846fe4bd167efdf1bd8a1224b2ba9a5ff" + SRCREV_pn-kmod-native = "fd56638aed3fe147015bfa10ed4a5f7491303cb4" + # qemux86-poky-linux + SRCREV_machine_pn-linux-yocto = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" + SRCREV_meta_pn-linux-yocto = "a227f20eff056e511d504b2e490f3774ab260d6f" + # all-poky-linux + SRCREV_pn-update-rc.d = "eca680ddf28d024954895f59a241a622dd575c11" + </literallayout> + <note> + Here are some notes on using the + <filename>buildhistory-collect-srcrevs</filename> command: + <itemizedlist> + <listitem><para>By default, only values where the + <filename>SRCREV</filename> was + not hardcoded (usually when <filename>AUTOREV</filename> + was used) are reported. + Use the <filename>-a</filename> option to see all + <filename>SRCREV</filename> values. + </para></listitem> + <listitem><para>The output statements might not have any effect + if overrides are applied elsewhere in the build system + configuration. + Use the <filename>-f</filename> option to add the + <filename>forcevariable</filename> override to each output line + if you need to work around this restriction. + </para></listitem> + <listitem><para>The script does apply special handling when + building for multiple machines. + However, the script does place a + comment before each set of values that specifies + which triplet to which they belong as shown above + (e.g., <filename>i586-poky-linux</filename>). + </para></listitem> + </itemizedlist> + </note> + </para> + </section> + + <section id='build-history-image-information'> + <title>Build History Image Information</title> + + <para> + The files produced for each image are as follows: + <itemizedlist> + <listitem><para><filename>image-files:</filename> + A directory containing selected files from the root + filesystem. + The files are defined by + <link linkend='var-BUILDHISTORY_IMAGE_FILES'><filename>BUILDHISTORY_IMAGE_FILES</filename></link>. + </para></listitem> + <listitem><para><filename>build-id.txt:</filename> + Human-readable information about the build configuration + and metadata source revisions. + This file contains the full build header as printed + by BitBake.</para></listitem> + <listitem><para><filename>*.dot:</filename> + Dependency graphs for the image that are + compatible with <filename>graphviz</filename>. + </para></listitem> + <listitem><para><filename>files-in-image.txt:</filename> + A list of files in the image with permissions, + owner, group, size, and symlink information. + </para></listitem> + <listitem><para><filename>image-info.txt:</filename> + A text file containing name-value pairs with information + about the image. + See the following listing example for more information. + </para></listitem> + <listitem><para><filename>installed-package-names.txt:</filename> + A list of installed packages by name only.</para></listitem> + <listitem><para><filename>installed-package-sizes.txt:</filename> + A list of installed packages ordered by size. + </para></listitem> + <listitem><para><filename>installed-packages.txt:</filename> + A list of installed packages with full package + filenames.</para></listitem> + </itemizedlist> + <note> + Installed package information is able to be gathered and + produced even if package management is disabled for the final + image. + </note> + </para> + + <para> + Here is an example of <filename>image-info.txt</filename>: + <literallayout class='monospaced'> + DISTRO = poky + DISTRO_VERSION = 1.7 + USER_CLASSES = buildstats image-mklibs image-prelink + IMAGE_CLASSES = image_types + IMAGE_FEATURES = debug-tweaks + IMAGE_LINGUAS = + IMAGE_INSTALL = packagegroup-core-boot run-postinsts + BAD_RECOMMENDATIONS = + NO_RECOMMENDATIONS = + PACKAGE_EXCLUDE = + ROOTFS_POSTPROCESS_COMMAND = write_package_manifest; license_create_manifest; \ + write_image_manifest ; buildhistory_list_installed_image ; \ + buildhistory_get_image_installed ; ssh_allow_empty_password; \ + postinst_enable_logging; rootfs_update_timestamp ; ssh_disable_dns_lookup ; + IMAGE_POSTPROCESS_COMMAND = buildhistory_get_imageinfo ; + IMAGESIZE = 6900 + </literallayout> + Other than <filename>IMAGESIZE</filename>, which is the + total size of the files in the image in Kbytes, the + name-value pairs are variables that may have influenced the + content of the image. + This information is often useful when you are trying to determine + why a change in the package or file listings has occurred. + </para> + </section> + + <section id='using-build-history-to-gather-image-information-only'> + <title>Using Build History to Gather Image Information Only</title> + + <para> + As you can see, build history produces image information, + including dependency graphs, so you can see why something + was pulled into the image. + If you are just interested in this information and not + interested in collecting specific package or SDK information, + you can enable writing only image information without + any history by adding the following to your + <filename>conf/local.conf</filename> file found in the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>: + <literallayout class='monospaced'> + INHERIT += "buildhistory" + BUILDHISTORY_COMMIT = "0" + BUILDHISTORY_FEATURES = "image" + </literallayout> + Here, you set the + <link linkend='var-BUILDHISTORY_FEATURES'><filename>BUILDHISTORY_FEATURES</filename></link> + variable to use the image feature only. + </para> + </section> + + <section id='build-history-sdk-information'> + <title>Build History SDK Information</title> + + <para> + Build history collects similar information on the contents + of SDKs + (e.g. <filename>bitbake -c populate_sdk imagename</filename>) + as compared to information it collects for images. + Furthermore, this information differs depending on whether an + extensible or standard SDK is being produced. + </para> + + <para> + The following list shows the files produced for SDKs: + <itemizedlist> + <listitem><para><filename>files-in-sdk.txt:</filename> + A list of files in the SDK with permissions, + owner, group, size, and symlink information. + This list includes both the host and target parts + of the SDK. + </para></listitem> + <listitem><para><filename>sdk-info.txt:</filename> + A text file containing name-value pairs with information + about the SDK. + See the following listing example for more information. + </para></listitem> + <listitem><para><filename>sstate-task-sizes.txt:</filename> + A text file containing name-value pairs with information + about task group sizes + (e.g. <filename>do_populate_sysroot</filename> tasks + have a total size). + The <filename>sstate-task-sizes.txt</filename> file + exists only when an extensible SDK is created. + </para></listitem> + <listitem><para><filename>sstate-package-sizes.txt:</filename> + A text file containing name-value pairs with information + for the shared-state packages and sizes in the SDK. + The <filename>sstate-package-sizes.txt</filename> file + exists only when an extensible SDK is created. + </para></listitem> + <listitem><para><filename>sdk-files:</filename> + A folder that contains copies of the files mentioned in + <filename>BUILDHISTORY_SDK_FILES</filename> if the + files are present in the output. + Additionally, the default value of + <filename>BUILDHISTORY_SDK_FILES</filename> is specific + to the extensible SDK although you can set it + differently if you would like to pull in specific files + from the standard SDK.</para> + <para>The default files are + <filename>conf/local.conf</filename>, + <filename>conf/bblayers.conf</filename>, + <filename>conf/auto.conf</filename>, + <filename>conf/locked-sigs.inc</filename>, and + <filename>conf/devtool.conf</filename>. + Thus, for an extensible SDK, these files get copied + into the <filename>sdk-files</filename> directory. + </para></listitem> + <listitem><para>The following information appears under + each of the <filename>host</filename> + and <filename>target</filename> directories + for the portions of the SDK that run on the host and + on the target, respectively: + <note> + The following files for the most part are empty + when producing an extensible SDK because this + type of SDK is not constructed from packages as is + the standard SDK. + </note> + <itemizedlist> + <listitem><para><filename>depends.dot:</filename> + Dependency graph for the SDK that is + compatible with <filename>graphviz</filename>. + </para></listitem> + <listitem><para><filename>installed-package-names.txt:</filename> + A list of installed packages by name only. + </para></listitem> + <listitem><para><filename>installed-package-sizes.txt:</filename> + A list of installed packages ordered by size. + </para></listitem> + <listitem><para><filename>installed-packages.txt:</filename> + A list of installed packages with full package + filenames.</para></listitem> + </itemizedlist> + </para></listitem> + </itemizedlist> + </para> + + <para> + Here is an example of <filename>sdk-info.txt</filename>: + <literallayout class='monospaced'> + DISTRO = poky + DISTRO_VERSION = 1.3+snapshot-20130327 + SDK_NAME = poky-glibc-i686-arm + SDK_VERSION = 1.3+snapshot + SDKMACHINE = + SDKIMAGE_FEATURES = dev-pkgs dbg-pkgs + BAD_RECOMMENDATIONS = + SDKSIZE = 352712 + </literallayout> + Other than <filename>SDKSIZE</filename>, which is the + total size of the files in the SDK in Kbytes, the + name-value pairs are variables that might have influenced the + content of the SDK. + This information is often useful when you are trying to + determine why a change in the package or file listings + has occurred. + </para> + </section> + + <section id='examining-build-history-information'> + <title>Examining Build History Information</title> + + <para> + You can examine build history output from the command line or + from a web interface. + </para> + + <para> + To see any changes that have occurred (assuming you have + <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT = "1"</filename></link>), + you can simply + use any Git command that allows you to view the history of + a repository. + Here is one method: + <literallayout class='monospaced'> + $ git log -p + </literallayout> + You need to realize, however, that this method does show + changes that are not significant (e.g. a package's size + changing by a few bytes). + </para> + + <para> + A command-line tool called <filename>buildhistory-diff</filename> + does exist, though, that queries the Git repository and prints just + the differences that might be significant in human-readable form. + Here is an example: + <literallayout class='monospaced'> + $ ~/poky/poky/scripts/buildhistory-diff . HEAD^ + Changes to images/qemux86_64/glibc/core-image-minimal (files-in-image.txt): + /etc/anotherpkg.conf was added + /sbin/anotherpkg was added + * (installed-package-names.txt): + * anotherpkg was added + Changes to images/qemux86_64/glibc/core-image-minimal (installed-package-names.txt): + anotherpkg was added + packages/qemux86_64-poky-linux/v86d: PACKAGES: added "v86d-extras" + * PR changed from "r0" to "r1" + * PV changed from "0.1.10" to "0.1.12" + packages/qemux86_64-poky-linux/v86d/v86d: PKGSIZE changed from 110579 to 144381 (+30%) + * PR changed from "r0" to "r1" + * PV changed from "0.1.10" to "0.1.12" + </literallayout> + </para> + + <para> + To see changes to the build history using a web interface, follow + the instruction in the <filename>README</filename> file here. + <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/buildhistory-web/'></ulink>. + </para> + + <para> + Here is a sample screenshot of the interface: + <imagedata fileref="figures/buildhistory-web.png" align="center" scalefit="1" width="130%" contentdepth="130%" /> + </para> + </section> + </section> +</section> + +<section id='speeding-up-the-build'> + <title>Speeding Up the Build</title> + + <para> + Build time can be an issue. + By default, the build system uses simple controls to try and maximize + build efficiency. + In general, the default settings for all the following variables + result in the most efficient build times when dealing with single + socket systems (i.e. a single CPU). + If you have multiple CPUs, you might try increasing the default + values to gain more speed. + See the descriptions in the glossary for each variable for more + information: + <itemizedlist> + <listitem><para> + <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename>:</link> + The maximum number of threads BitBake simultaneously executes. + </para></listitem> + <listitem><para> + <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'><filename>BB_NUMBER_PARSE_THREADS</filename>:</ulink> + The number of threads BitBake uses during parsing. + </para></listitem> + <listitem><para> + <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename>:</link> + Extra options passed to the <filename>make</filename> command + during the + <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> + task in order to specify parallel compilation on the + local build host. + </para></listitem> + <listitem><para> + <link linkend='var-PARALLEL_MAKEINST'><filename>PARALLEL_MAKEINST</filename>:</link> + Extra options passed to the <filename>make</filename> command + during the + <link linkend='ref-tasks-install'><filename>do_install</filename></link> + task in order to specify parallel installation on the + local build host. + </para></listitem> + </itemizedlist> + As mentioned, these variables all scale to the number of processor + cores available on the build system. + For single socket systems, this auto-scaling ensures that the build + system fundamentally takes advantage of potential parallel operations + during the build based on the build machine's capabilities. + </para> + + <para> + Following are additional factors that can affect build speed: + <itemizedlist> + <listitem><para> + File system type: + The file system type that the build is being performed on can + also influence performance. + Using <filename>ext4</filename> is recommended as compared + to <filename>ext2</filename> and <filename>ext3</filename> + due to <filename>ext4</filename> improved features + such as extents. + </para></listitem> + <listitem><para> + Disabling the updating of access time using + <filename>noatime</filename>: + The <filename>noatime</filename> mount option prevents the + build system from updating file and directory access times. + </para></listitem> + <listitem><para> + Setting a longer commit: + Using the "commit=" mount option increases the interval + in seconds between disk cache writes. + Changing this interval from the five second default to + something longer increases the risk of data loss but decreases + the need to write to the disk, thus increasing the build + performance. + </para></listitem> + <listitem><para> + Choosing the packaging backend: + Of the available packaging backends, IPK is the fastest. + Additionally, selecting a singular packaging backend also + helps. + </para></listitem> + <listitem><para> + Using <filename>tmpfs</filename> for + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + as a temporary file system: + While this can help speed up the build, the benefits are + limited due to the compiler using + <filename>-pipe</filename>. + The build system goes to some lengths to avoid + <filename>sync()</filename> calls into the + file system on the principle that if there was a significant + failure, the + <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink> + contents could easily be rebuilt. + </para></listitem> + <listitem><para> + Inheriting the + <link linkend='ref-classes-rm-work'><filename>rm_work</filename></link> + class: + Inheriting this class has shown to speed up builds due to + significantly lower amounts of data stored in the data + cache as well as on disk. + Inheriting this class also makes cleanup of + <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> + faster, at the expense of being easily able to dive into the + source code. + File system maintainers have recommended that the fastest way + to clean up large numbers of files is to reformat partitions + rather than delete files due to the linear nature of partitions. + This, of course, assumes you structure the disk partitions and + file systems in a way that this is practical. + </para></listitem> + </itemizedlist> + Aside from the previous list, you should keep some trade offs in + mind that can help you speed up the build: + <itemizedlist> + <listitem><para> + Remove items from + <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> + that you might not need. + </para></listitem> + <listitem><para> + Exclude debug symbols and other debug information: + If you do not need these symbols and other debug information, + disabling the <filename>*-dbg</filename> package generation + can speed up the build. + You can disable this generation by setting the + <link linkend='var-INHIBIT_PACKAGE_DEBUG_SPLIT'><filename>INHIBIT_PACKAGE_DEBUG_SPLIT</filename></link> + variable to "1". + </para></listitem> + <listitem><para> + Disable static library generation for recipes derived from + <filename>autoconf</filename> or <filename>libtool</filename>: + Following is an example showing how to disable static + libraries and still provide an override to handle exceptions: + <literallayout class='monospaced'> + STATICLIBCONF = "--disable-static" + STATICLIBCONF_sqlite3-native = "" + EXTRA_OECONF += "${STATICLIBCONF}" + </literallayout> + <note><title>Notes</title> + <itemizedlist> + <listitem><para> + Some recipes need static libraries in order to work + correctly (e.g. <filename>pseudo-native</filename> + needs <filename>sqlite3-native</filename>). + Overrides, as in the previous example, account for + these kinds of exceptions. + </para></listitem> + <listitem><para> + Some packages have packaging code that assumes the + presence of the static libraries. + If so, you might need to exclude them as well. + </para></listitem> + </itemizedlist> + </note> + </para></listitem> + </itemizedlist> + </para> +</section> +</chapter> +<!-- +vim: expandtab tw=80 ts=4 +--> |
