From b70318797c598db4cfda28226ac4c535235c9d1b Mon Sep 17 00:00:00 2001 From: Nicolas Dechesne Date: Thu, 3 Dec 2020 22:38:43 +0100 Subject: ref-manual: remove 'ref' from filenames All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: bb7e4783f45a5f67e6e4b39968f3512f43738833) Signed-off-by: Nicolas Dechesne Signed-off-by: Richard Purdie --- documentation/ref-manual/classes.rst | 2898 +++++++ documentation/ref-manual/devtool-reference.rst | 631 ++ documentation/ref-manual/faq.rst | 2 +- documentation/ref-manual/features.rst | 350 + documentation/ref-manual/images.rst | 138 + documentation/ref-manual/index.rst | 26 +- documentation/ref-manual/kickstart.rst | 216 + documentation/ref-manual/migration-1.5.rst | 2 +- documentation/ref-manual/migration-1.6.rst | 2 +- documentation/ref-manual/migration-1.7.rst | 4 +- documentation/ref-manual/migration-2.1.rst | 2 +- documentation/ref-manual/migration-2.3.rst | 2 +- documentation/ref-manual/qa-checks.rst | 761 ++ documentation/ref-manual/ref-classes.rst | 2898 ------- documentation/ref-manual/ref-devtool-reference.rst | 631 -- documentation/ref-manual/ref-features.rst | 350 - documentation/ref-manual/ref-images.rst | 138 - documentation/ref-manual/ref-kickstart.rst | 216 - documentation/ref-manual/ref-qa-checks.rst | 761 -- documentation/ref-manual/ref-release-process.rst | 191 - documentation/ref-manual/ref-structure.rst | 874 -- .../ref-manual/ref-system-requirements.rst | 442 - documentation/ref-manual/ref-tasks.rst | 844 -- documentation/ref-manual/ref-terms.rst | 390 - documentation/ref-manual/ref-variables.rst | 8807 -------------------- documentation/ref-manual/ref-varlocality.rst | 166 - documentation/ref-manual/release-process.rst | 191 + documentation/ref-manual/structure.rst | 874 ++ documentation/ref-manual/system-requirements.rst | 442 + documentation/ref-manual/tasks.rst | 844 ++ documentation/ref-manual/terms.rst | 390 + documentation/ref-manual/variables.rst | 8807 ++++++++++++++++++++ documentation/ref-manual/varlocality.rst | 166 + 33 files changed, 16728 insertions(+), 16728 deletions(-) create mode 100644 documentation/ref-manual/classes.rst create mode 100644 documentation/ref-manual/devtool-reference.rst create mode 100644 documentation/ref-manual/features.rst create mode 100644 documentation/ref-manual/images.rst create mode 100644 documentation/ref-manual/kickstart.rst create mode 100644 documentation/ref-manual/qa-checks.rst delete mode 100644 documentation/ref-manual/ref-classes.rst delete mode 100644 documentation/ref-manual/ref-devtool-reference.rst delete mode 100644 documentation/ref-manual/ref-features.rst delete mode 100644 documentation/ref-manual/ref-images.rst delete mode 100644 documentation/ref-manual/ref-kickstart.rst delete mode 100644 documentation/ref-manual/ref-qa-checks.rst delete mode 100644 documentation/ref-manual/ref-release-process.rst delete mode 100644 documentation/ref-manual/ref-structure.rst delete mode 100644 documentation/ref-manual/ref-system-requirements.rst delete mode 100644 documentation/ref-manual/ref-tasks.rst delete mode 100644 documentation/ref-manual/ref-terms.rst delete mode 100644 documentation/ref-manual/ref-variables.rst delete mode 100644 documentation/ref-manual/ref-varlocality.rst create mode 100644 documentation/ref-manual/release-process.rst create mode 100644 documentation/ref-manual/structure.rst create mode 100644 documentation/ref-manual/system-requirements.rst create mode 100644 documentation/ref-manual/tasks.rst create mode 100644 documentation/ref-manual/terms.rst create mode 100644 documentation/ref-manual/variables.rst create mode 100644 documentation/ref-manual/varlocality.rst (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst new file mode 100644 index 0000000000..5a30ce379b --- /dev/null +++ b/documentation/ref-manual/classes.rst @@ -0,0 +1,2898 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +******* +Classes +******* + +Class files are used to abstract common functionality and share it +amongst multiple recipe (``.bb``) 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. + +Any :term:`Metadata` usually found in a recipe can also be +placed in a class file. Class files are identified by the extension +``.bbclass`` and are usually placed in a ``classes/`` directory beneath +the ``meta*/`` directory found in the :term:`Source Directory`. +Class files can also be pointed to by +:term:`BUILDDIR` (e.g. ``build/``) in the same way as +``.conf`` files in the ``conf`` directory. Class files are searched for +in :term:`BBPATH` using the same method by which ``.conf`` +files are searched. + +This chapter discusses only the most useful and important classes. Other +classes do exist within the ``meta/classes`` directory in the Source +Directory. You can reference the ``.bbclass`` files directly for more +information. + +.. _ref-classes-allarch: + +``allarch.bbclass`` +=================== + +The ``allarch`` 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:: + + Unlike some distro recipes (e.g. Debian), OpenEmbedded recipes that + produce packages that depend on tunings through use of the + :term:`RDEPENDS` and + :term:`TUNE_PKGARCH` variables, should never be + configured for all architectures using ``allarch``. This is the case + even if the recipes do not produce architecture-specific output. + + Configuring such recipes for all architectures causes the + ``do_package_write_*`` tasks to + have different signatures for the machines with different tunings. + Additionally, unnecessary rebuilds occur every time an image for a + different ``MACHINE`` is built even when the recipe never changes. + +By default, all recipes inherit the :ref:`base ` and +:ref:`package ` 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 ``allarch`` class. + +.. _ref-classes-archiver: + +``archiver.bbclass`` +==================== + +The ``archiver`` class supports releasing source code and other +materials with the binaries. + +For more details on the source archiver, see the +":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" +section in the Yocto Project Development Tasks Manual. You can also see +the :term:`ARCHIVER_MODE` variable for information +about the variable flags (varflags) that help control archive creation. + +.. _ref-classes-autotools: + +``autotools*.bbclass`` +====================== + +The ``autotools*`` classes support Autotooled packages. + +The ``autoconf``, ``automake``, and ``libtool`` packages bring +standardization. This class defines a set of tasks (e.g. ``configure``, +``compile`` and so forth) that work for all Autotooled packages. It +should usually be enough to define a few standard variables and then +simply ``inherit autotools``. These classes can also work with software +that emulates Autotools. For more information, see the +":ref:`dev-manual/common-tasks:autotooled package`" section +in the Yocto Project Development Tasks Manual. + +By default, the ``autotools*`` classes use out-of-tree builds (i.e. +``autotools.bbclass`` building with ``B != S``). + +If the software being built by a recipe does not support using +out-of-tree builds, you should have the recipe inherit the +``autotools-brokensep`` class. The ``autotools-brokensep`` class behaves +the same as the ``autotools`` class but builds with :term:`B` +== :term:`S`. 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. + +It's useful to have some idea of how the tasks defined by the +``autotools*`` classes work and what they do behind the scenes. + +- :ref:`ref-tasks-configure` - Regenerates the + configure script (using ``autoreconf``) and then launches it with a + standard set of arguments used during cross-compilation. You can pass + additional parameters to ``configure`` through the ``EXTRA_OECONF`` + or :term:`PACKAGECONFIG_CONFARGS` + variables. + +- :ref:`ref-tasks-compile` - Runs ``make`` with + arguments that specify the compiler and linker. You can pass + additional arguments through the ``EXTRA_OEMAKE`` variable. + +- :ref:`ref-tasks-install` - Runs ``make install`` and + passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``. + +.. _ref-classes-base: + +``base.bbclass`` +================ + +The ``base`` class is special in that every ``.bb`` file implicitly +inherits the class. This class contains definitions for standard basic +tasks such as fetching, unpacking, configuring (empty by default), +compiling (runs any ``Makefile`` present), installing (empty by default) +and packaging (empty by default). These classes are often overridden or +extended by other classes such as the +:ref:`autotools ` class or the +:ref:`package ` class. + +The class also contains some commonly used functions such as +``oe_runmake``, which runs ``make`` with the arguments specified in +:term:`EXTRA_OEMAKE` variable as well as the +arguments passed directly to ``oe_runmake``. + +.. _ref-classes-bash-completion: + +``bash-completion.bbclass`` +=========================== + +Sets up packaging and dependencies appropriate for recipes that build +software that includes bash-completion data. + +.. _ref-classes-bin-package: + +``bin_package.bbclass`` +======================= + +The ``bin_package`` 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 (``git://``), + the "subpath" parameter limits the checkout to a specific subpath + of the tree. Here is an example where ``${BP}`` is used so that the files + are extracted into the subdirectory expected by the default value of + ``S``: + :: + + SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}" + + + See the ":ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers`" section in the BitBake User Manual for + more information on supported BitBake Fetchers. + +.. _ref-classes-binconfig: + +``binconfig.bbclass`` +===================== + +The ``binconfig`` class helps to correct paths in shell scripts. + +Before ``pkg-config`` had become widespread, libraries shipped shell +scripts to give information about the libraries and include paths needed +to build software (usually named ``LIBNAME-config``). This class assists +any recipe using such scripts. + +During staging, the OpenEmbedded build system installs such scripts into +the ``sysroots/`` directory. Inheriting this class results in all paths +in these scripts being changed to point into the ``sysroots/`` directory +so that all builds that use the script use the correct directories for +the cross compiling layout. See the +:term:`BINCONFIG_GLOB` variable for more +information. + +.. _ref-classes-binconfig-disabled: + +``binconfig-disabled.bbclass`` +============================== + +An alternative version of the :ref:`binconfig ` +class, which disables binary configuration scripts by making them return +an error in favor of using ``pkg-config`` to query the information. The +scripts to be disabled should be specified using the +:term:`BINCONFIG` variable within the recipe inheriting +the class. + +.. _ref-classes-blacklist: + +``blacklist.bbclass`` +===================== + +The ``blacklist`` class prevents the OpenEmbedded build system from +building specific recipes (blacklists them). To use this class, inherit +the class globally and set :term:`PNBLACKLIST` for +each recipe you wish to blacklist. Specify the :term:`PN` +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 ``local.conf`` or distribution configuration: +:: + + INHERIT += "blacklist" + PNBLACKLIST[exoticware] = "Not supported by our organization." + +.. _ref-classes-buildhistory: + +``buildhistory.bbclass`` +======================== + +The ``buildhistory`` 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 +":ref:`dev-manual/common-tasks:maintaining build output quality`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-buildstats: + +``buildstats.bbclass`` +====================== + +The ``buildstats`` class records performance statistics about each task +executed during the build (e.g. elapsed time, CPU usage, and I/O usage). + +When you use this class, the output goes into the +:term:`BUILDSTATS_BASE` directory, which defaults +to ``${TMPDIR}/buildstats/``. You can analyze the elapsed time using +``scripts/pybootchartgui/pybootchartgui.py``, which produces a cascading +chart of the entire build process and can be useful for highlighting +bottlenecks. + +Collecting build statistics is enabled by default through the +:term:`USER_CLASSES` variable from your +``local.conf`` 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 ``USER_CLASSES`` list. + +.. _ref-classes-buildstats-summary: + +``buildstats-summary.bbclass`` +============================== + +When inherited globally, prints statistics at the end of the build on +sstate re-use. In order to function, this class requires the +:ref:`buildstats ` class be enabled. + +.. _ref-classes-ccache: + +``ccache.bbclass`` +================== + +The ``ccache`` class enables the C/C++ Compiler Cache 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 +http://ccache.samba.org/ for information on the C/C++ Compiler +Cache. + +.. _ref-classes-chrpath: + +``chrpath.bbclass`` +=================== + +The ``chrpath`` class is a wrapper around the "chrpath" utility, which +is used during the build process for ``nativesdk``, ``cross``, and +``cross-canadian`` recipes to change ``RPATH`` records within binaries +in order to make them relocatable. + +.. _ref-classes-clutter: + +``clutter.bbclass`` +=================== + +The ``clutter`` 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. + +.. _ref-classes-cmake: + +``cmake.bbclass`` +================= + +The ``cmake`` class allows for recipes that need to build software using +the `CMake `__ build system. You can use +the :term:`EXTRA_OECMAKE` variable to specify +additional configuration options to be passed using the ``cmake`` +command line. + +On the occasion that you would be installing custom CMake toolchain +files supplied by the application being built, you should install them +to the preferred CMake Module directory: ``${D}${datadir}/cmake/`` +Modules during +:ref:`ref-tasks-install`. + +.. _ref-classes-cml1: + +``cml1.bbclass`` +================ + +The ``cml1`` class provides basic support for the Linux kernel style +build configuration system. + +.. _ref-classes-compress_doc: + +``compress_doc.bbclass`` +======================== + +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 +:term:`DOC_COMPRESS` variable. + +.. _ref-classes-copyleft_compliance: + +``copyleft_compliance.bbclass`` +=============================== + +The ``copyleft_compliance`` class preserves source code for the purposes +of license compliance. This class is an alternative to the ``archiver`` +class and is still used by some users even though it has been deprecated +in favor of the :ref:`archiver ` class. + +.. _ref-classes-copyleft_filter: + +``copyleft_filter.bbclass`` +=========================== + +A class used by the :ref:`archiver ` and +:ref:`copyleft_compliance ` classes +for filtering licenses. The ``copyleft_filter`` class is an internal +class and is not intended to be used directly. + +.. _ref-classes-core-image: + +``core-image.bbclass`` +====================== + +The ``core-image`` class provides common definitions for the +``core-image-*`` image recipes, such as support for additional +:term:`IMAGE_FEATURES`. + +.. _ref-classes-cpan: + +``cpan*.bbclass`` +================= + +The ``cpan*`` classes support Perl modules. + +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. + +- Modules that use old ``Makefile.PL``-based build system require + ``cpan.bbclass`` in their recipes. + +- Modules that use ``Build.PL``-based build system require using + ``cpan_build.bbclass`` in their recipes. + +Both build methods inherit the ``cpan-base`` class for basic Perl +support. + +.. _ref-classes-cross: + +``cross.bbclass`` +================= + +The ``cross`` class provides support for the recipes that build the +cross-compilation tools. + +.. _ref-classes-cross-canadian: + +``cross-canadian.bbclass`` +========================== + +The ``cross-canadian`` class provides support for the recipes that build +the Canadian Cross-compilation tools for SDKs. See the +":ref:`overview-manual/concepts:cross-development toolchain generation`" +section in the Yocto Project Overview and Concepts Manual for more +discussion on these cross-compilation tools. + +.. _ref-classes-crosssdk: + +``crosssdk.bbclass`` +==================== + +The ``crosssdk`` class provides support for the recipes that build the +cross-compilation tools used for building SDKs. See the +":ref:`overview-manual/concepts:cross-development toolchain generation`" +section in the Yocto Project Overview and Concepts Manual for more +discussion on these cross-compilation tools. + +.. _ref-classes-debian: + +``debian.bbclass`` +================== + +The ``debian`` class renames output packages so that they follow the +Debian naming policy (i.e. ``glibc`` becomes ``libc6`` and +``glibc-devel`` becomes ``libc6-dev``.) Renaming includes the library +name and version as part of the package name. + +If a recipe creates packages for multiple libraries (shared object files +of ``.so`` type), use the :term:`LEAD_SONAME` +variable in the recipe to specify the library on which to apply the +naming scheme. + +.. _ref-classes-deploy: + +``deploy.bbclass`` +================== + +The ``deploy`` class handles deploying files to the +:term:`DEPLOY_DIR_IMAGE` 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 +:ref:`ref-tasks-deploy` function to copy the files to be +deployed to :term:`DEPLOYDIR`, and use ``addtask`` to +add the task at the appropriate place, which is usually after +:ref:`ref-tasks-compile` or +:ref:`ref-tasks-install`. The class then takes care of +staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``. + +.. _ref-classes-devshell: + +``devshell.bbclass`` +==================== + +The ``devshell`` class adds the ``do_devshell`` task. Distribution +policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`" +section in the Yocto Project Development Tasks Manual for more +information about using ``devshell``. + +.. _ref-classes-devupstream: + +``devupstream.bbclass`` +======================= + +The ``devupstream`` class uses +:term:`BBCLASSEXTEND` to add a variant of the +recipe that fetches from an alternative URI (e.g. Git) instead of a +tarball. Following is an example: +:: + + BBCLASSEXTEND = "devupstream:target" + SRC_URI_class-devupstream = "git://git.example.com/example" + SRCREV_class-devupstream = "abcd1234" + +Adding the above statements to your recipe creates a variant that has +:term:`DEFAULT_PREFERENCE` set to "-1". +Consequently, you need to select the variant of the recipe to use it. +Any development-specific adjustments can be done by using the +``class-devupstream`` override. Here is an example: +:: + + DEPENDS_append_class-devupstream = " gperf-native" + do_configure_prepend_class-devupstream() { + touch ${S}/README + } + +The class +currently only supports creating a development variant of the target +recipe, not ``native`` or ``nativesdk`` variants. + +The ``BBCLASSEXTEND`` syntax (i.e. ``devupstream:target``) provides +support for ``native`` and ``nativesdk`` variants. Consequently, this +functionality can be added in a future release. + +Support for other version control systems such as Subversion is limited +due to BitBake's automatic fetch dependencies (e.g. +``subversion-native``). + +.. _ref-classes-distutils: + +``distutils*.bbclass`` +====================== + +The ``distutils*`` 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. + +- Extensions that use an Autotools-based build system require Autotools + and the classes based on ``distutils`` in their recipes. + +- Extensions that use build systems based on ``distutils`` require the + ``distutils`` class in their recipes. + +- Extensions that use build systems based on ``setuptools`` require the + :ref:`setuptools ` class in their recipes. + +The ``distutils-common-base`` class is required by some of the +``distutils*`` classes to provide common Python2 support. + +.. _ref-classes-distutils3: + +``distutils3*.bbclass`` +======================= + +The ``distutils3*`` 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. + +- Extensions that use an Autotools-based build system require Autotools + and ``distutils``-based classes in their recipes. + +- Extensions that use ``distutils``-based build systems require the + ``distutils`` class in their recipes. + +- Extensions that use build systems based on ``setuptools3`` require + the :ref:`setuptools3 ` class in their + recipes. + +The ``distutils3*`` classes either inherit their corresponding +``distutils*`` class or replicate them using a Python3 version instead +(e.g. ``distutils3-base`` inherits ``distutils-common-base``, which is +the same as ``distutils-base`` but inherits ``python3native`` instead of +``pythonnative``). + +.. _ref-classes-externalsrc: + +``externalsrc.bbclass`` +======================= + +The ``externalsrc`` 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. + +By default, the OpenEmbedded build system uses the :term:`S` +and :term:`B` variables to locate unpacked recipe source code +and to build it, respectively. When your recipe inherits the +``externalsrc`` class, you use the +:term:`EXTERNALSRC` and +:term:`EXTERNALSRC_BUILD` variables to +ultimately define ``S`` and ``B``. + +By default, this class expects the source code to support recipe builds +that use the :term:`B` variable to point to the directory in +which the OpenEmbedded build system places the generated objects built +from the recipes. By default, the ``B`` directory is set to the +following, which is separate from the source directory (``S``): +:: + + ${WORKDIR}/${BPN}/{PV}/ + +See these variables for more information: +:term:`WORKDIR`, :term:`BPN`, and +:term:`PV`, + +For more information on the ``externalsrc`` class, see the comments in +``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. +For information on how to use the +``externalsrc`` class, see the +":ref:`dev-manual/common-tasks:building software from an external source`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-extrausers: + +``extrausers.bbclass`` +====================== + +The ``extrausers`` 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 +:term:`EXTRA_USERS_PARAMS` variable. + +.. note:: + + The user and group operations added using the + extrausers + 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 + useradd + class to add user and group configuration to a specific recipe. + +Here is an example that uses this class in an image recipe: +:: + + inherit extrausers + EXTRA_USERS_PARAMS = "\ + useradd -p '' tester; \ + groupadd developers; \ + userdel nobody; \ + groupdel -g video; \ + groupmod -g 1020 developers; \ + usermod -s /bin/sh tester; \ + " + +Here is an example that adds two users named "tester-jim" and "tester-sue" and assigns +passwords: +:: + + inherit extrausers + EXTRA_USERS_PARAMS = "\ + useradd -P tester01 tester-jim; \ + useradd -P tester01 tester-sue; \ + " + +Finally, here is an example that sets the root password to "1876*18": +:: + + inherit extrausers + EXTRA_USERS_PARAMS = "\ + usermod -P 1876*18 root; \ + " + +.. _ref-classes-features_check: + +``features_check.bbclass`` +================================= + +The ``features_check`` class allows individual recipes to check +for required and conflicting +:term:`DISTRO_FEATURES`, :term:`MACHINE_FEATURES` or :term:`COMBINED_FEATURES`. + +This class provides support for the following variables: + +- :term:`REQUIRED_DISTRO_FEATURES` +- :term:`CONFLICT_DISTRO_FEATURES` +- :term:`ANY_OF_DISTRO_FEATURES` +- ``REQUIRED_MACHINE_FEATURES`` +- ``CONFLICT_MACHINE_FEATURES`` +- ``ANY_OF_MACHINE_FEATURES`` +- ``REQUIRED_COMBINED_FEATURES`` +- ``CONFLICT_COMBINED_FEATURES`` +- ``ANY_OF_COMBINED_FEATURES`` + +If any conditions specified in the recipe using the above +variables are not met, the recipe will be skipped, and if the +build system attempts to build the recipe then an error will be +triggered. + +.. _ref-classes-fontcache: + +``fontcache.bbclass`` +===================== + +The ``fontcache`` class generates the proper post-install and +post-remove (postinst and postrm) scriptlets for font packages. These +scriptlets call ``fc-cache`` (part of ``Fontconfig``) to add the fonts +to the font information cache. Since the cache files are +architecture-specific, ``fc-cache`` runs using QEMU if the postinst +scriptlets need to be run on the build host during image creation. + +If the fonts being installed are in packages other than the main +package, set :term:`FONT_PACKAGES` to specify the +packages containing the fonts. + +.. _ref-classes-fs-uuid: + +``fs-uuid.bbclass`` +=================== + +The ``fs-uuid`` class extracts UUID from +``${``\ :term:`ROOTFS`\ ``}``, which must have been built +by the time that this function gets called. The ``fs-uuid`` class only +works on ``ext`` file systems and depends on ``tune2fs``. + +.. _ref-classes-gconf: + +``gconf.bbclass`` +================= + +The ``gconf`` class provides common functionality for recipes that need +to install GConf schemas. The schemas will be put into a separate +package (``${``\ :term:`PN`\ ``}-gconf``) 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. + +.. _ref-classes-gettext: + +``gettext.bbclass`` +=================== + +The ``gettext`` class provides support for building software that uses +the GNU ``gettext`` internationalization and localization system. All +recipes building software that use ``gettext`` should inherit this +class. + +.. _ref-classes-gnomebase: + +``gnomebase.bbclass`` +===================== + +The ``gnomebase`` class is the base class for recipes that build +software from the GNOME stack. This class sets +:term:`SRC_URI` to download the source from the GNOME +mirrors as well as extending :term:`FILES` with the typical +GNOME installation paths. + +.. _ref-classes-gobject-introspection: + +``gobject-introspection.bbclass`` +================================= + +Provides support for recipes building software that supports GObject +introspection. This functionality is only enabled if the +"gobject-introspection-data" feature is in +:term:`DISTRO_FEATURES` as well as +"qemu-usermode" being in +:term:`MACHINE_FEATURES`. + +.. note:: + + This functionality is backfilled by default and, if not applicable, + should be disabled through ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` or + ``MACHINE_FEATURES_BACKFILL_CONSIDERED``, respectively. + +.. _ref-classes-grub-efi: + +``grub-efi.bbclass`` +==================== + +The ``grub-efi`` class provides ``grub-efi``-specific functions for +building bootable images. + +This class supports several variables: + +- :term:`INITRD`: Indicates list of filesystem images to + concatenate and use as an initial RAM disk (initrd) (optional). + +- :term:`ROOTFS`: Indicates a filesystem image to include + as the root filesystem (optional). + +- :term:`GRUB_GFXSERIAL`: Set this to "1" to have + graphics and serial in the boot menu. + +- :term:`LABELS`: A list of targets for the automatic + configuration. + +- :term:`APPEND`: An override list of append strings for + each ``LABEL``. + +- :term:`GRUB_OPTS`: Additional options to add to the + configuration (optional). Options are delimited using semi-colon + characters (``;``). + +- :term:`GRUB_TIMEOUT`: Timeout before executing + the default ``LABEL`` (optional). + +.. _ref-classes-gsettings: + +``gsettings.bbclass`` +===================== + +The ``gsettings`` 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. + +.. _ref-classes-gtk-doc: + +``gtk-doc.bbclass`` +=================== + +The ``gtk-doc`` class is a helper class to pull in the appropriate +``gtk-doc`` dependencies and disable ``gtk-doc``. + +.. _ref-classes-gtk-icon-cache: + +``gtk-icon-cache.bbclass`` +========================== + +The ``gtk-icon-cache`` class generates the proper post-install and +post-remove (postinst/postrm) scriptlets for packages that use GTK+ and +install icons. These scriptlets call ``gtk-update-icon-cache`` to add +the fonts to GTK+'s icon cache. Since the cache files are +architecture-specific, ``gtk-update-icon-cache`` is run using QEMU if +the postinst scriptlets need to be run on the build host during image +creation. + +.. _ref-classes-gtk-immodules-cache: + +``gtk-immodules-cache.bbclass`` +=============================== + +The ``gtk-immodules-cache`` 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 +``gtk-update-icon-cache`` to add the input method modules to the cache. +Since the cache files are architecture-specific, +``gtk-update-icon-cache`` is run using QEMU if the postinst scriptlets +need to be run on the build host during image creation. + +If the input method modules being installed are in packages other than +the main package, set +:term:`GTKIMMODULES_PACKAGES` to specify +the packages containing the modules. + +.. _ref-classes-gzipnative: + +``gzipnative.bbclass`` +====================== + +The ``gzipnative`` class enables the use of different native versions of +``gzip`` and ``pigz`` rather than the versions of these tools from the +build host. + +.. _ref-classes-icecc: + +``icecc.bbclass`` +================= + +The ``icecc`` class supports +`Icecream `__, which facilitates +taking compile jobs and distributing them among remote machines. + +The class stages directories with symlinks from ``gcc`` and ``g++`` to +``icecc``, for both native and cross compilers. Depending on each +configure or compile, the OpenEmbedded build system adds the directories +at the head of the ``PATH`` list and then sets the ``ICECC_CXX`` and +``ICEC_CC`` variables, which are the paths to the ``g++`` and ``gcc`` +compilers, respectively. + +For the cross compiler, the class creates a ``tar.gz`` file that +contains the Yocto Project toolchain and sets ``ICECC_VERSION``, which +is the version of the cross-compiler used in the cross-development +toolchain, accordingly. + +The class handles all three different compile stages (i.e native +,cross-kernel and target) and creates the necessary environment +``tar.gz`` file to be used by the remote machines. The class also +supports SDK generation. + +If :term:`ICECC_PATH` is not set in your +``local.conf`` file, then the class tries to locate the ``icecc`` binary +using ``which``. If :term:`ICECC_ENV_EXEC` is set +in your ``local.conf`` file, the variable should point to the +``icecc-create-env`` 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 ``icecc-create-env-native.bb``. + +.. note:: + + This script is a modified version and not the one that comes with + icecc. + +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 +:term:`ICECC_USER_PACKAGE_BL` and +:term:`ICECC_USER_CLASS_BL`, variables, +respectively, in your ``local.conf`` file. Doing so causes the +OpenEmbedded build system to handle these compilations locally. + +Additionally, you can list recipes using the +:term:`ICECC_USER_PACKAGE_WL` variable in +your ``local.conf`` file to force ``icecc`` to be enabled for recipes +using an empty :term:`PARALLEL_MAKE` variable. + +Inheriting the ``icecc`` class changes all sstate signatures. +Consequently, if a development team has a dedicated build system that +populates :term:`SSTATE_MIRRORS` and they want to +reuse sstate from ``SSTATE_MIRRORS``, then all developers and the build +system need to either inherit the ``icecc`` class or nobody should. + +At the distribution level, you can inherit the ``icecc`` 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 +:term:`ICECC_DISABLED` variable to "1" as follows: +:: + + INHERIT_DISTRO_append = " icecc" + ICECC_DISABLED ??= "1" + +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 ``local.conf`` file: +:: + + ICECC_DISABLED = "" + +.. _ref-classes-image: + +``image.bbclass`` +================= + +The ``image`` class helps support creating images in different formats. +First, the root filesystem is created from packages using one of the +``rootfs*.bbclass`` files (depending on the package format used) and +then one or more image files are created. + +- The ``IMAGE_FSTYPES`` variable controls the types of images to + generate. + +- The ``IMAGE_INSTALL`` variable controls the list of packages to + install into the image. + +For information on customizing images, see the +":ref:`dev-manual/common-tasks:customizing images`" section +in the Yocto Project Development Tasks Manual. For information on how +images are created, see the +":ref:`overview-manual/concepts:images`" section in the +Yocto Project Overview and Concpets Manual. + +.. _ref-classes-image-buildinfo: + +``image-buildinfo.bbclass`` +=========================== + +The ``image-buildinfo`` class writes information to the target +filesystem on ``/etc/build``. + +.. _ref-classes-image_types: + +``image_types.bbclass`` +======================= + +The ``image_types`` class defines all of the standard image output types +that you can enable through the +:term:`IMAGE_FSTYPES` variable. You can use this +class as a reference on how to add support for custom image output +types. + +By default, the :ref:`image ` class automatically +enables the ``image_types`` class. The ``image`` class uses the +``IMGCLASSES`` variable as follows: +:: + + IMGCLASSES = "rootfs_${IMAGE_PKGTYPE} image_types ${IMAGE_CLASSES}" + IMGCLASSES += "${@['populate_sdk_base', 'populate_sdk_ext']['linux' in d.getVar("SDK_OS")]}" + IMGCLASSES += "${@bb.utils.contains_any('IMAGE_FSTYPES', 'live iso hddimg', 'image-live', '', d)}" + IMGCLASSES += "${@bb.utils.contains('IMAGE_FSTYPES', 'container', 'image-container', '', d)}" + IMGCLASSES += "image_types_wic" + IMGCLASSES += "rootfs-postcommands" + IMGCLASSES += "image-postinst-intercepts" + inherit ${IMGCLASSES} + +The ``image_types`` class also handles conversion and compression of images. + +.. note:: + + To build a VMware VMDK image, you need to add "wic.vmdk" to + ``IMAGE_FSTYPES``. This would also be similar for Virtual Box Virtual Disk + Image ("vdi") and QEMU Copy On Write Version 2 ("qcow2") images. + +.. _ref-classes-image-live: + +``image-live.bbclass`` +====================== + +This class controls building "live" (i.e. HDDIMG and ISO) images. Live +images contain syslinux for legacy booting, as well as the bootloader +specified by :term:`EFI_PROVIDER` if +:term:`MACHINE_FEATURES` contains "efi". + +Normally, you do not use this class directly. Instead, you add "live" to +:term:`IMAGE_FSTYPES`. + +.. _ref-classes-image-mklibs: + +``image-mklibs.bbclass`` +======================== + +The ``image-mklibs`` class enables the use of the ``mklibs`` utility +during the :ref:`ref-tasks-rootfs` task, which optimizes +the size of libraries contained in the image. + +By default, the class is enabled in the ``local.conf.template`` using +the :term:`USER_CLASSES` variable as follows: +:: + + USER_CLASSES ?= "buildstats image-mklibs image-prelink" + +.. _ref-classes-image-prelink: + +``image-prelink.bbclass`` +========================= + +The ``image-prelink`` class enables the use of the ``prelink`` utility +during the :ref:`ref-tasks-rootfs` task, which optimizes +the dynamic linking of shared libraries to reduce executable startup +time. + +By default, the class is enabled in the ``local.conf.template`` using +the :term:`USER_CLASSES` variable as follows: +:: + + USER_CLASSES ?= "buildstats image-mklibs image-prelink" + +.. _ref-classes-insane: + +``insane.bbclass`` +================== + +The ``insane`` 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. + +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 ":doc:`/ref-manual/qa-checks`" Chapter for a list of all the warning +and error messages you might encounter using a default configuration. + +Use the :term:`WARN_QA` and +:term:`ERROR_QA` 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 :term:`INSANE_SKIP`. For example, to skip +the check for symbolic link ``.so`` 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 ``${PN}``, must be used: +:: + + INSANE_SKIP_${PN} += "dev-so" + +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. + +The following list shows the tests you can list with the ``WARN_QA`` and +``ERROR_QA`` variables: + +- ``already-stripped:`` 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 ``-dbg`` packages, this stripping must be + disabled. + +- ``arch:`` 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. + +- ``buildpaths:`` 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. + +- ``build-deps:`` Determines if a build-time dependency that is + specified through :term:`DEPENDS`, explicit + :term:`RDEPENDS`, 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 + :ref:`ref-tasks-rootfs` task because the auto-detected + dependency was not satisfied. An example of this would be where the + :ref:`update-rc.d ` class automatically + adds a dependency on the ``initscripts-functions`` package to + packages that install an initscript that refers to + ``/etc/init.d/functions``. The recipe should really have an explicit + ``RDEPENDS`` for the package in question on ``initscripts-functions`` + so that the OpenEmbedded build system is able to ensure that the + ``initscripts`` recipe is actually built and thus the + ``initscripts-functions`` package is made available. + +- ``compile-host-path:`` Checks the + :ref:`ref-tasks-compile` 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. + +- ``debug-deps:`` Checks that all packages except ``-dbg`` packages + do not depend on ``-dbg`` packages, which would cause a packaging + bug. + +- ``debug-files:`` Checks for ``.debug`` directories in anything but + the ``-dbg`` package. The debug files should all be in the ``-dbg`` + package. Thus, anything packaged elsewhere is incorrect packaging. + +- ``dep-cmp:`` Checks for invalid version comparison statements in + runtime dependency relationships between packages (i.e. in + :term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, + :term:`RPROVIDES`, + :term:`RREPLACES`, and + :term:`RCONFLICTS` variable values). Any invalid + comparisons might trigger failures or undesirable behavior when + passed to the package manager. + +- ``desktop:`` Runs the ``desktop-file-validate`` program against any + ``.desktop`` files to validate their contents against the + specification for ``.desktop`` files. + +- ``dev-deps:`` Checks that all packages except ``-dev`` or + ``-staticdev`` packages do not depend on ``-dev`` packages, which + would be a packaging bug. + +- ``dev-so:`` Checks that the ``.so`` symbolic links are in the + ``-dev`` package and not in any of the other packages. In general, + these symlinks are only useful for development purposes. Thus, the + ``-dev`` 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. + +- ``file-rdeps:`` 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 ``#!/bin/bash``. + This line would translate to a file dependency on ``/bin/bash``. 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 + :term:`RDEPENDS` exist to handle any file-level + dependency detected in packaged files. + +- ``files-invalid:`` Checks for :term:`FILES` variable + values that contain "//", which is invalid. + +- ``host-user-contaminated:`` Checks that no package produced by the + recipe contains any files outside of ``/home`` with a user or group + ID that matches the user running BitBake. A match usually indicates + that the files are being installed with an incorrect UID/GID, since + target IDs are independent from host IDs. For additional information, + see the section describing the + :ref:`ref-tasks-install` task. + +- ``incompatible-license:`` Report when packages are excluded from + being created due to being marked with a license that is in + :term:`INCOMPATIBLE_LICENSE`. + +- ``install-host-path:`` Checks the + :ref:`ref-tasks-install` 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. + +- ``installed-vs-shipped:`` Reports when files have been installed + within ``do_install`` but have not been included in any package by + way of the :term:`FILES` 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 + ``do_install`` if the files are not needed in any package. + +- ``invalid-chars:`` Checks that the recipe metadata variables + :term:`DESCRIPTION`, + :term:`SUMMARY`, :term:`LICENSE`, and + :term:`SECTION` do not contain non-UTF-8 characters. + Some package managers do not support such characters. + +- ``invalid-packageconfig:`` Checks that no undefined features are + being added to :term:`PACKAGECONFIG`. For + example, any name "foo" for which the following form does not exist: + :: + + PACKAGECONFIG[foo] = "..." + +- ``la:`` Checks ``.la`` files for any ``TMPDIR`` paths. Any ``.la`` + file containing these paths is incorrect since ``libtool`` adds the + correct sysroot prefix when using the files automatically itself. + +- ``ldflags:`` Ensures that the binaries were linked with the + :term:`LDFLAGS` options provided by the build system. + If this test fails, check that the ``LDFLAGS`` variable is being + passed to the linker command. + +- ``libdir:`` Checks for libraries being installed into incorrect + (possibly hardcoded) installation paths. For example, this test will + catch recipes that install ``/lib/bar.so`` when ``${base_libdir}`` is + "lib32". Another example is when recipes install + ``/usr/lib64/foo.so`` when ``${libdir}`` is "/usr/lib". + +- ``libexec:`` Checks if a package contains files in + ``/usr/libexec``. This check is not performed if the ``libexecdir`` + variable has been set explicitly to ``/usr/libexec``. + +- ``packages-list:`` Checks for the same package being listed + multiple times through the :term:`PACKAGES` variable + value. Installing the package in this manner can cause errors during + packaging. + +- ``perm-config:`` Reports lines in ``fs-perms.txt`` that have an + invalid format. + +- ``perm-line:`` Reports lines in ``fs-perms.txt`` that have an + invalid format. + +- ``perm-link:`` Reports lines in ``fs-perms.txt`` that specify + 'link' where the specified target already exists. + +- ``perms:`` Currently, this check is unused but reserved. + +- ``pkgconfig:`` Checks ``.pc`` files for any + :term:`TMPDIR`/:term:`WORKDIR` paths. + Any ``.pc`` file containing these paths is incorrect since + ``pkg-config`` itself adds the correct sysroot prefix when the files + are accessed. + +- ``pkgname:`` Checks that all packages in + :term:`PACKAGES` have names that do not contain + invalid characters (i.e. characters other than 0-9, a-z, ., +, and + -). + +- ``pkgv-undefined:`` Checks to see if the ``PKGV`` variable is + undefined during :ref:`ref-tasks-package`. + +- ``pkgvarcheck:`` Checks through the variables + :term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, + :term:`RCONFLICTS`, + :term:`RPROVIDES`, + :term:`RREPLACES`, :term:`FILES`, + :term:`ALLOW_EMPTY`, ``pkg_preinst``, + ``pkg_postinst``, ``pkg_prerm`` and ``pkg_postrm``, 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. + +- ``pn-overrides:`` Checks that a recipe does not have a name + (:term:`PN`) value that appears in + :term:`OVERRIDES`. If a recipe is named such that + its ``PN`` value matches something already in ``OVERRIDES`` (e.g. + ``PN`` happens to be the same as :term:`MACHINE` or + :term:`DISTRO`), it can have unexpected consequences. + For example, assignments such as ``FILES_${PN} = "xyz"`` effectively + turn into ``FILES = "xyz"``. + +- ``rpaths:`` Checks for rpaths in the binaries that contain build + system paths such as ``TMPDIR``. If this test fails, bad ``-rpath`` + options are being passed to the linker commands and your binaries + have potential security issues. + +- ``split-strip:`` Reports that splitting or stripping debug symbols + from binaries has failed. + +- ``staticdev:`` Checks for static library files (``*.a``) in + non-``staticdev`` packages. + +- ``symlink-to-sysroot:`` Checks for symlinks in packages that point + into :term:`TMPDIR` on the host. Such symlinks will + work on the host, but are clearly invalid when running on the target. + +- ``textrel:`` Checks for ELF binaries that contain relocations in + their ``.text`` sections, which can result in a performance impact at + runtime. See the explanation for the ``ELF binary`` message in + ":doc:`/ref-manual/qa-checks`" for more information regarding runtime performance + issues. + +- ``unlisted-pkg-lics:`` Checks that all declared licenses applying + for a package are also declared on the recipe level (i.e. any license + in ``LICENSE_*`` should appear in :term:`LICENSE`). + +- ``useless-rpaths:`` Checks for dynamic library load paths (rpaths) + in the binaries that by default on a standard system are searched by + the linker (e.g. ``/lib`` and ``/usr/lib``). While these paths will + not cause any breakage, they do waste space and are unnecessary. + +- ``var-undefined:`` Reports when variables fundamental to packaging + (i.e. :term:`WORKDIR`, + :term:`DEPLOY_DIR`, :term:`D`, + :term:`PN`, and :term:`PKGD`) are undefined + during :ref:`ref-tasks-package`. + +- ``version-going-backwards:`` 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. + +- ``xorg-driver-abi:`` Checks that all packages containing Xorg + drivers have ABI dependencies. 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 + ``xorg-driver-input.inc`` or ``xorg-driver-video.inc`` will + automatically get these versions. Consequently, you should only need + to explicitly add dependencies to binary driver recipes. + +.. _ref-classes-insserv: + +``insserv.bbclass`` +=================== + +The ``insserv`` class uses the ``insserv`` utility to update the order +of symbolic links in ``/etc/rc?.d/`` within an image based on +dependencies specified by LSB headers in the ``init.d`` scripts +themselves. + +.. _ref-classes-kernel: + +``kernel.bbclass`` +================== + +The ``kernel`` class handles building Linux kernels. The class contains +code to build all kernel trees. All needed headers are staged into the +``STAGING_KERNEL_DIR`` directory to allow out-of-tree module builds +using the :ref:`module ` class. + +This means that each built kernel module is packaged separately and +inter-module dependencies are created by parsing the ``modinfo`` output. +If all modules are required, then installing the ``kernel-modules`` +package installs all packages with modules and various other kernel +packages such as ``kernel-vmlinux``. + +The ``kernel`` class contains logic that allows you to embed an initial +RAM filesystem (initramfs) image when you build the kernel image. For +information on how to build an initramfs, see the +":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in +the Yocto Project Development Tasks Manual. + +Various other classes are used by the ``kernel`` and ``module`` classes +internally including the :ref:`kernel-arch `, +:ref:`module-base `, and +:ref:`linux-kernel-base ` classes. + +.. _ref-classes-kernel-arch: + +``kernel-arch.bbclass`` +======================= + +The ``kernel-arch`` class sets the ``ARCH`` environment variable for +Linux kernel compilation (including modules). + +.. _ref-classes-kernel-devicetree: + +``kernel-devicetree.bbclass`` +============================= + +The ``kernel-devicetree`` class, which is inherited by the +:ref:`kernel ` class, supports device tree +generation. + +.. _ref-classes-kernel-fitimage: + +``kernel-fitimage.bbclass`` +=========================== + +The ``kernel-fitimage`` class provides support to pack a kernel Image, +device trees and a RAM disk into a single FIT image. In theory, a FIT +image can support any number of kernels, RAM disks and device-trees. +However, ``kernel-fitimage`` currently only supports +limited usescases: just one kernel image, an optional RAM disk, and +any number of device tree. + +To create a FIT image, it is required that :term:`KERNEL_CLASSES` +is set to "kernel-fitimage" and :term:`KERNEL_IMAGETYPE` +is set to "fitImage". + +The options for the device tree compiler passed to mkimage -D feature +when creating the FIT image are specified using the +:term:`UBOOT_MKIMAGE_DTCOPTS` variable. + +Only a single kernel can be added to the FIT image created by +``kernel-fitimage`` and the kernel image in FIT is mandatory. The +address where the kernel image is to be loaded by U-boot is +specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by +:term:`UBOOT_ENTRYPOINT`. + +Multiple device trees can be added to the FIT image created by +``kernel-fitimage`` and the device tree is optional. +The address where the device tree is to be loaded by U-boot is +specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays +and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries. + +Only a single RAM disk can be added to the FIT image created by +``kernel-fitimage`` and the RAM disk in FIT is optional. +The address where the RAM disk image is to be loaded by U-boot +is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by +:term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to FIT image when +:term:`INITRAMFS_IMAGE` is specified. + +The FIT image generated by ``kernel-fitimage`` class is signed when the +variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`, +:term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set +appropriately. The default values used for :term:`FIT_HASH_ALG` and +:term:`FIT_SIGN_ALG` in ``kernel-fitimage`` are "sha256" and +"rsa2048" respectively. The keys for signing fitImage can be generated using +the ``kernel-fitimage`` class when both :term:`FIT_GENERATE_KEYS` and +:term:`UBOOT_SIGN_ENABLE` are set to "1". + + +.. _ref-classes-kernel-grub: + +``kernel-grub.bbclass`` +======================= + +The ``kernel-grub`` 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. + +.. _ref-classes-kernel-module-split: + +``kernel-module-split.bbclass`` +=============================== + +The ``kernel-module-split`` class provides common functionality for +splitting Linux kernel modules into separate packages. + +.. _ref-classes-kernel-uboot: + +``kernel-uboot.bbclass`` +======================== + +The ``kernel-uboot`` class provides support for building from +vmlinux-style kernel sources. + +.. _ref-classes-kernel-uimage: + +``kernel-uimage.bbclass`` +========================= + +The ``kernel-uimage`` class provides support to pack uImage. + +.. _ref-classes-kernel-yocto: + +``kernel-yocto.bbclass`` +======================== + +The ``kernel-yocto`` class provides common functionality for building +from linux-yocto style kernel source repositories. + +.. _ref-classes-kernelsrc: + +``kernelsrc.bbclass`` +===================== + +The ``kernelsrc`` class sets the Linux kernel source and version. + +.. _ref-classes-lib_package: + +``lib_package.bbclass`` +======================= + +The ``lib_package`` 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 ``${``\ :term:`PN`\ ``}-bin`` package to +make their installation optional. + +.. _ref-classes-libc*: + +``libc*.bbclass`` +================= + +The ``libc*`` classes support recipes that build packages with ``libc``: + +- The ``libc-common`` class provides common support for building with + ``libc``. + +- The ``libc-package`` class supports packaging up ``glibc`` and + ``eglibc``. + +.. _ref-classes-license: + +``license.bbclass`` +=================== + +The ``license`` class provides license manifest creation and license +exclusion. This class is enabled by default using the default value for +the :term:`INHERIT_DISTRO` variable. + +.. _ref-classes-linux-kernel-base: + +``linux-kernel-base.bbclass`` +============================= + +The ``linux-kernel-base`` 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. + +.. _ref-classes-linuxloader: + +``linuxloader.bbclass`` +======================= + +Provides the function ``linuxloader()``, which gives the value of the +dynamic loader/linker provided on the platform. This value is used by a +number of other classes. + +.. _ref-classes-logging: + +``logging.bbclass`` +=================== + +The ``logging`` class provides the standard shell functions used to log +messages for various BitBake severity levels (i.e. ``bbplain``, +``bbnote``, ``bbwarn``, ``bberror``, ``bbfatal``, and ``bbdebug``). + +This class is enabled by default since it is inherited by the ``base`` +class. + +.. _ref-classes-meta: + +``meta.bbclass`` +================ + +The ``meta`` class is inherited by recipes that do not build any output +packages themselves, but act as a "meta" target for building other +recipes. + +.. _ref-classes-metadata_scm: + +``metadata_scm.bbclass`` +======================== + +The ``metadata_scm`` class provides functionality for querying the +branch and revision of a Source Code Manager (SCM) repository. + +The :ref:`base ` class uses this class to print the +revisions of each layer before starting every build. The +``metadata_scm`` class is enabled by default because it is inherited by +the ``base`` class. + +.. _ref-classes-migrate_localcount: + +``migrate_localcount.bbclass`` +============================== + +The ``migrate_localcount`` class verifies a recipe's localcount data and +increments it appropriately. + +.. _ref-classes-mime: + +``mime.bbclass`` +================ + +The ``mime`` class generates the proper post-install and post-remove +(postinst/postrm) scriptlets for packages that install MIME type files. +These scriptlets call ``update-mime-database`` to add the MIME types to +the shared database. + +.. _ref-classes-mirrors: + +``mirrors.bbclass`` +=================== + +The ``mirrors`` class sets up some standard +:term:`MIRRORS` entries for source code mirrors. These +mirrors provide a fall-back path in case the upstream source specified +in :term:`SRC_URI` within recipes is unavailable. + +This class is enabled by default since it is inherited by the +:ref:`base ` class. + +.. _ref-classes-module: + +``module.bbclass`` +================== + +The ``module`` class provides support for building out-of-tree Linux +kernel modules. The class inherits the +:ref:`module-base ` and +:ref:`kernel-module-split ` classes, +and implements the :ref:`ref-tasks-compile` and +:ref:`ref-tasks-install` tasks. The class provides +everything needed to build and package a kernel module. + +For general information on out-of-tree Linux kernel modules, see the +":ref:`kernel-dev/common:incorporating out-of-tree modules`" +section in the Yocto Project Linux Kernel Development Manual. + +.. _ref-classes-module-base: + +``module-base.bbclass`` +======================= + +The ``module-base`` 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 +:ref:`module ` class. + +.. _ref-classes-multilib*: + +``multilib*.bbclass`` +===================== + +The ``multilib*`` classes provide support for building libraries with +different target optimizations or target architectures and installing +them side-by-side in the same image. + +For more information on using the Multilib feature, see the +":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-native: + +``native.bbclass`` +================== + +The ``native`` class provides common functionality for recipes that +build tools to run on the :term:`Build Host` (i.e. tools that use the compiler +or other tools from the build host). + +You can create a recipe that builds tools that run natively on the host +a couple different ways: + +- Create a myrecipe\ ``-native.bb`` recipe that inherits the ``native`` + class. If you use this method, you must order the inherit statement + in the recipe after all other inherit statements so that the + ``native`` class is inherited last. + + .. note:: + + When creating a recipe this way, the recipe name must follow this + naming convention: + :: + + myrecipe-native.bb + + + Not using this naming convention can lead to subtle problems + caused by existing code that depends on that naming convention. + +- Create or modify a target recipe that contains the following: + :: + + BBCLASSEXTEND = "native" + + Inside the + recipe, use ``_class-native`` and ``_class-target`` overrides to + specify any functionality specific to the respective native or target + case. + +Although applied differently, the ``native`` 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. + +.. _ref-classes-nativesdk: + +``nativesdk.bbclass`` +===================== + +The ``nativesdk`` class provides common functionality for recipes that +wish to build tools to run as part of an SDK (i.e. tools that run on +:term:`SDKMACHINE`). + +You can create a recipe that builds tools that run on the SDK machine a +couple different ways: + +- Create a ``nativesdk-``\ myrecipe\ ``.bb`` recipe that inherits the + ``nativesdk`` class. If you use this method, you must order the + inherit statement in the recipe after all other inherit statements so + that the ``nativesdk`` class is inherited last. + +- Create a ``nativesdk`` variant of any recipe by adding the following: + :: + + BBCLASSEXTEND = "nativesdk" + + Inside the + recipe, use ``_class-nativesdk`` and ``_class-target`` overrides to + specify any functionality specific to the respective SDK machine or + target case. + +.. note:: + + When creating a recipe, you must follow this naming convention: + :: + + nativesdk-myrecipe.bb + + + Not doing so can lead to subtle problems because code exists that + depends on the naming convention. + +Although applied differently, the ``nativesdk`` 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. + +.. _ref-classes-nopackages: + +``nopackages.bbclass`` +====================== + +Disables packaging tasks for those recipes and classes where packaging +is not needed. + +.. _ref-classes-npm: + +``npm.bbclass`` +=============== + +Provides support for building Node.js software fetched using the `node +package manager (NPM) `__. + +.. note:: + + Currently, recipes inheriting this class must use the ``npm://`` + fetcher to have dependencies fetched and packaged automatically. + +For information on how to create NPM packages, see the +":ref:`dev-manual/common-tasks:creating node package manager (npm) packages`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-oelint: + +``oelint.bbclass`` +================== + +The ``oelint`` class is an obsolete lint checking tool that exists in +``meta/classes`` in the :term:`Source Directory`. + +A number of classes exist that could be generally useful in OE-Core but +are never actually used within OE-Core itself. The ``oelint`` class is +one such example. However, being aware of this class can reduce the +proliferation of different versions of similar classes across multiple +layers. + +.. _ref-classes-own-mirrors: + +``own-mirrors.bbclass`` +======================= + +The ``own-mirrors`` class makes it easier to set up your own +:term:`PREMIRRORS` from which to first fetch source +before attempting to fetch it from the upstream specified in +:term:`SRC_URI` within each recipe. + +To use this class, inherit it globally and specify +:term:`SOURCE_MIRROR_URL`. Here is an example: +:: + + INHERIT += "own-mirrors" + SOURCE_MIRROR_URL = "http://example.com/my-source-mirror" + +You can specify only a single URL +in ``SOURCE_MIRROR_URL``. + +.. _ref-classes-package: + +``package.bbclass`` +=================== + +The ``package`` class supports generating packages from a build's +output. The core generic functionality is in ``package.bbclass``. The +code specific to particular package types resides in these +package-specific classes: +:ref:`package_deb `, +:ref:`package_rpm `, +:ref:`package_ipk `, and +:ref:`package_tar `. + +.. note:: + + The + package_tar + class is broken and not supported. It is recommended that you do not + use this class. + +You can control the list of resulting package formats by using the +``PACKAGE_CLASSES`` variable defined in your ``conf/local.conf`` +configuration file, which is located in the :term:`Build Directory`. +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. + +If you take the optional step to set up a repository (package feed) on +the development host that can be used by DNF, 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 +":ref:`dev-manual/common-tasks:using runtime package management`" +section in the Yocto Project Development Tasks Manual. + +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 :term:`Metadata` than the IPK package +manager. Consequently, you might consider setting ``PACKAGE_CLASSES`` to +"package_ipk" if you are building smaller systems. + +Before making your package manager decision, however, you should +consider some further things about using RPM: + +- 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. + +- 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. + +You can find additional information on the effects of the package class +at these two Yocto Project mailing list links: + +- :yocto_lists:`/pipermail/poky/2011-May/006362.html` + +- :yocto_lists:`/pipermail/poky/2011-May/006363.html` + +.. _ref-classes-package_deb: + +``package_deb.bbclass`` +======================= + +The ``package_deb`` class provides support for creating packages that +use the Debian (i.e. ``.deb``) file format. The class ensures the +packages are written out in a ``.deb`` file format to the +``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory. + +This class inherits the :ref:`package ` class and +is enabled through the :term:`PACKAGE_CLASSES` +variable in the ``local.conf`` file. + +.. _ref-classes-package_ipk: + +``package_ipk.bbclass`` +======================= + +The ``package_ipk`` class provides support for creating packages that +use the IPK (i.e. ``.ipk``) file format. The class ensures the packages +are written out in a ``.ipk`` file format to the +``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory. + +This class inherits the :ref:`package ` class and +is enabled through the :term:`PACKAGE_CLASSES` +variable in the ``local.conf`` file. + +.. _ref-classes-package_rpm: + +``package_rpm.bbclass`` +======================= + +The ``package_rpm`` class provides support for creating packages that +use the RPM (i.e. ``.rpm``) file format. The class ensures the packages +are written out in a ``.rpm`` file format to the +``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory. + +This class inherits the :ref:`package ` class and +is enabled through the :term:`PACKAGE_CLASSES` +variable in the ``local.conf`` file. + +.. _ref-classes-package_tar: + +``package_tar.bbclass`` +======================= + +The ``package_tar`` class provides support for creating tarballs. The +class ensures the packages are written out in a tarball format to the +``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory. + +This class inherits the :ref:`package ` class and +is enabled through the :term:`PACKAGE_CLASSES` +variable in the ``local.conf`` file. + +.. note:: + + You cannot specify the ``package_tar`` class first using the + ``PACKAGE_CLASSES`` variable. You must use ``.deb``, ``.ipk``, or ``.rpm`` + file formats for your image or SDK. + +.. _ref-classes-packagedata: + +``packagedata.bbclass`` +======================= + +The ``packagedata`` class provides common functionality for reading +``pkgdata`` files found in :term:`PKGDATA_DIR`. These +files contain information about each output package produced by the +OpenEmbedded build system. + +This class is enabled by default because it is inherited by the +:ref:`package ` class. + +.. _ref-classes-packagegroup: + +``packagegroup.bbclass`` +======================== + +The ``packagegroup`` class sets default values appropriate for package +group recipes (e.g. ``PACKAGES``, ``PACKAGE_ARCH``, ``ALLOW_EMPTY``, and +so forth). It is highly recommended that all package group recipes +inherit this class. + +For information on how to use this class, see the +":ref:`dev-manual/common-tasks:customizing images using custom package groups`" +section in the Yocto Project Development Tasks Manual. + +Previously, this class was called the ``task`` class. + +.. _ref-classes-patch: + +``patch.bbclass`` +================= + +The ``patch`` class provides all functionality for applying patches +during the :ref:`ref-tasks-patch` task. + +This class is enabled by default because it is inherited by the +:ref:`base ` class. + +.. _ref-classes-perlnative: + +``perlnative.bbclass`` +====================== + +When inherited by a recipe, the ``perlnative`` class supports using the +native version of Perl built by the build system rather than using the +version provided by the build host. + +.. _ref-classes-pixbufcache: + +``pixbufcache.bbclass`` +======================= + +The ``pixbufcache`` class generates the proper post-install and +post-remove (postinst/postrm) scriptlets for packages that install +pixbuf loaders, which are used with ``gdk-pixbuf``. These scriptlets +call ``update_pixbuf_cache`` to add the pixbuf loaders to the cache. +Since the cache files are architecture-specific, ``update_pixbuf_cache`` +is run using QEMU if the postinst scriptlets need to be run on the build +host during image creation. + +If the pixbuf loaders being installed are in packages other than the +recipe's main package, set +:term:`PIXBUF_PACKAGES` to specify the packages +containing the loaders. + +.. _ref-classes-pkgconfig: + +``pkgconfig.bbclass`` +===================== + +The ``pkgconfig`` class provides a standard way to get header and +library information by using ``pkg-config``. This class aims to smooth +integration of ``pkg-config`` into libraries that use it. + +During staging, BitBake installs ``pkg-config`` data into the +``sysroots/`` directory. By making use of sysroot functionality within +``pkg-config``, the ``pkgconfig`` class no longer has to manipulate the +files. + +.. _ref-classes-populate-sdk: + +``populate_sdk.bbclass`` +======================== + +The ``populate_sdk`` class provides support for SDK-only recipes. For +information on advantages gained when building a cross-development +toolchain using the :ref:`ref-tasks-populate_sdk` +task, see the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`" +section in the Yocto Project Application Development and the Extensible +Software Development Kit (eSDK) manual. + +.. _ref-classes-populate-sdk-*: + +``populate_sdk_*.bbclass`` +========================== + +The ``populate_sdk_*`` classes support SDK creation and consist of the +following classes: + +- ``populate_sdk_base``: The base class supporting SDK creation under + all package managers (i.e. DEB, RPM, and opkg). + +- ``populate_sdk_deb``: Supports creation of the SDK given the Debian + package manager. + +- ``populate_sdk_rpm``: Supports creation of the SDK given the RPM + package manager. + +- ``populate_sdk_ipk``: Supports creation of the SDK given the opkg + (IPK format) package manager. + +- ``populate_sdk_ext``: Supports extensible SDK creation under all + package managers. + +The ``populate_sdk_base`` class inherits the appropriate +``populate_sdk_*`` (i.e. ``deb``, ``rpm``, and ``ipk``) based on +:term:`IMAGE_PKGTYPE`. + +The base class ensures all source and destination directories are +established and then populates the SDK. After populating the SDK, the +``populate_sdk_base`` class constructs two sysroots: +``${``\ :term:`SDK_ARCH`\ ``}-nativesdk``, 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 :term:`SDK_OUTPUT`, +which consists of the following: +:: + + ${SDK_OUTPUT}/${SDK_ARCH}-nativesdk-pkgs + ${SDK_OUTPUT}/${SDKTARGETSYSROOT}/target-pkgs + +Finally, the base populate SDK class creates the toolchain environment +setup script, the tarball of the SDK, and the installer. + +The respective ``populate_sdk_deb``, ``populate_sdk_rpm``, and +``populate_sdk_ipk`` classes each support the specific type of SDK. +These classes are inherited by and used with the ``populate_sdk_base`` +class. + +For more information on the cross-development toolchain generation, see +the ":ref:`overview-manual/concepts:cross-development toolchain generation`" +section in the Yocto Project Overview and Concepts Manual. For +information on advantages gained when building a cross-development +toolchain using the :ref:`ref-tasks-populate_sdk` +task, see the +":ref:`sdk-manual/appendix-obtain:building an sdk installer`" +section in the Yocto Project Application Development and the Extensible +Software Development Kit (eSDK) manual. + +.. _ref-classes-prexport: + +``prexport.bbclass`` +==================== + +The ``prexport`` class provides functionality for exporting +:term:`PR` values. + +.. note:: + + This class is not intended to be used directly. Rather, it is enabled + when using "``bitbake-prserv-tool export``". + +.. _ref-classes-primport: + +``primport.bbclass`` +==================== + +The ``primport`` class provides functionality for importing +:term:`PR` values. + +.. note:: + + This class is not intended to be used directly. Rather, it is enabled + when using "``bitbake-prserv-tool import``". + +.. _ref-classes-prserv: + +``prserv.bbclass`` +================== + +The ``prserv`` class provides functionality for using a :ref:`PR +service ` in order to +automatically manage the incrementing of the :term:`PR` +variable for each recipe. + +This class is enabled by default because it is inherited by the +:ref:`package ` class. However, the OpenEmbedded +build system will not enable the functionality of this class unless +:term:`PRSERV_HOST` has been set. + +.. _ref-classes-ptest: + +``ptest.bbclass`` +================= + +The ``ptest`` class provides functionality for packaging and installing +runtime tests for recipes that build software that provides these tests. + +This class is intended to be inherited by individual recipes. However, +the class' functionality is largely disabled unless "ptest" appears in +:term:`DISTRO_FEATURES`. See the +":ref:`dev-manual/common-tasks:testing packages with ptest`" +section in the Yocto Project Development Tasks Manual for more information +on ptest. + +.. _ref-classes-ptest-gnome: + +``ptest-gnome.bbclass`` +======================= + +Enables package tests (ptests) specifically for GNOME packages, which +have tests intended to be executed with ``gnome-desktop-testing``. + +For information on setting up and running ptests, see the +":ref:`dev-manual/common-tasks:testing packages with ptest`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-python-dir: + +``python-dir.bbclass`` +====================== + +The ``python-dir`` class provides the base version, location, and site +package location for Python. + +.. _ref-classes-python3native: + +``python3native.bbclass`` +========================= + +The ``python3native`` 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. + +.. _ref-classes-pythonnative: + +``pythonnative.bbclass`` +======================== + +When inherited by a recipe, the ``pythonnative`` class supports using +the native version of Python built by the build system rather than using +the version provided by the build host. + +.. _ref-classes-qemu: + +``qemu.bbclass`` +================ + +The ``qemu`` 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. + +.. _ref-classes-recipe_sanity: + +``recipe_sanity.bbclass`` +========================= + +The ``recipe_sanity`` 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). + +.. _ref-classes-relocatable: + +``relocatable.bbclass`` +======================= + +The ``relocatable`` class enables relocation of binaries when they are +installed into the sysroot. + +This class makes use of the :ref:`chrpath ` class +and is used by both the :ref:`cross ` and +:ref:`native ` classes. + +.. _ref-classes-remove-libtool: + +``remove-libtool.bbclass`` +========================== + +The ``remove-libtool`` class adds a post function to the +:ref:`ref-tasks-install` task to remove all ``.la`` files +installed by ``libtool``. Removing these files results in them being +absent from both the sysroot and target packages. + +If a recipe needs the ``.la`` files to be installed, then the recipe can +override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows: +:: + + REMOVE_LIBTOOL_LA = "0" + +.. note:: + + The ``remove-libtool`` class is not enabled by default. + +.. _ref-classes-report-error: + +``report-error.bbclass`` +======================== + +The ``report-error`` class supports enabling the :ref:`error reporting +tool `", +which allows you to submit build error information to a central database. + +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 +``${``\ :term:`LOG_DIR`\ ``}/error-report``. + +.. _ref-classes-rm-work: + +``rm_work.bbclass`` +=================== + +The ``rm_work`` class supports deletion of temporary workspace, which +can ease your hard drive demands during builds. + +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 ``${TMPDIR}/work`` 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 ``rm_work`` by adding the following to +your ``local.conf`` file, which is found in the :term:`Build Directory`. +:: + + INHERIT += "rm_work" + +If you are +modifying and building source code out of the work directory for a +recipe, enabling ``rm_work`` will potentially result in your changes to +the source being lost. To exclude some recipes from having their work +directories deleted by ``rm_work``, you can add the names of the recipe +or recipes you are working on to the ``RM_WORK_EXCLUDE`` variable, which +can also be set in your ``local.conf`` file. Here is an example: +:: + + RM_WORK_EXCLUDE += "busybox glibc" + +.. _ref-classes-rootfs*: + +``rootfs*.bbclass`` +=================== + +The ``rootfs*`` classes support creating the root filesystem for an +image and consist of the following classes: + +- The ``rootfs-postcommands`` class, which defines filesystem + post-processing functions for image recipes. + +- The ``rootfs_deb`` class, which supports creation of root filesystems + for images built using ``.deb`` packages. + +- The ``rootfs_rpm`` class, which supports creation of root filesystems + for images built using ``.rpm`` packages. + +- The ``rootfs_ipk`` class, which supports creation of root filesystems + for images built using ``.ipk`` packages. + +- The ``rootfsdebugfiles`` class, which installs additional files found + on the build host directly into the root filesystem. + +The root filesystem is created from packages using one of the +``rootfs*.bbclass`` files as determined by the +:term:`PACKAGE_CLASSES` variable. + +For information on how root filesystem images are created, see the +":ref:`overview-manual/concepts:image generation`" +section in the Yocto Project Overview and Concepts Manual. + +.. _ref-classes-sanity: + +``sanity.bbclass`` +================== + +The ``sanity`` 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 ``local.conf`` configuration file to +prevent common mistakes that cause build failures. Distribution policy +usually determines whether to include this class. + +.. _ref-classes-scons: + +``scons.bbclass`` +================= + +The ``scons`` class supports recipes that need to build software that +uses the SCons build system. You can use the +:term:`EXTRA_OESCONS` variable to specify +additional configuration options you want to pass SCons command line. + +.. _ref-classes-sdl: + +``sdl.bbclass`` +=============== + +The ``sdl`` class supports recipes that need to build software that uses +the Simple DirectMedia Layer (SDL) library. + +.. _ref-classes-setuptools: + +``setuptools.bbclass`` +====================== + +The ``setuptools`` class supports Python version 2.x extensions that use +build systems based on ``setuptools``. If your recipe uses these build +systems, the recipe needs to inherit the ``setuptools`` class. + +.. _ref-classes-setuptools3: + +``setuptools3.bbclass`` +======================= + +The ``setuptools3`` class supports Python version 3.x extensions that +use build systems based on ``setuptools3``. If your recipe uses these +build systems, the recipe needs to inherit the ``setuptools3`` class. + +.. _ref-classes-sign_rpm: + +``sign_rpm.bbclass`` +==================== + +The ``sign_rpm`` class supports generating signed RPM packages. + +.. _ref-classes-sip: + +``sip.bbclass`` +=============== + +The ``sip`` class supports recipes that build or package SIP-based +Python bindings. + +.. _ref-classes-siteconfig: + +``siteconfig.bbclass`` +====================== + +The ``siteconfig`` class provides functionality for handling site +configuration. The class is used by the +:ref:`autotools ` class to accelerate the +:ref:`ref-tasks-configure` task. + +.. _ref-classes-siteinfo: + +``siteinfo.bbclass`` +==================== + +The ``siteinfo`` class provides information about the targets that might +be needed by other classes or recipes. + +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 ``meta/site directory`` contains test results +sorted into different categories such as architecture, endianness, and +the ``libc`` used. Site information provides a list of files containing +data relevant to the current build in the ``CONFIG_SITE`` variable that +Autotools automatically picks up. + +The class also provides variables like ``SITEINFO_ENDIANNESS`` and +``SITEINFO_BITS`` that can be used elsewhere in the metadata. + +.. _ref-classes-sstate: + +``sstate.bbclass`` +================== + +The ``sstate`` class provides support for Shared State (sstate). By +default, the class is enabled through the +:term:`INHERIT_DISTRO` variable's default value. + +For more information on sstate, see the +":ref:`overview-manual/concepts:shared state cache`" +section in the Yocto Project Overview and Concepts Manual. + +.. _ref-classes-staging: + +``staging.bbclass`` +=================== + +The ``staging`` class installs files into individual recipe work +directories for sysroots. The class contains the following key tasks: + +- The :ref:`ref-tasks-populate_sysroot` task, + which is responsible for handing the files that end up in the recipe + sysroots. + +- The + :ref:`ref-tasks-prepare_recipe_sysroot` + task (a "partner" task to the ``populate_sysroot`` task), which + installs the files into the individual recipe work directories (i.e. + :term:`WORKDIR`). + +The code in the ``staging`` class is complex and basically works in two +stages: + +- *Stage One:* The first stage addresses recipes that have files they + want to share with other recipes that have dependencies on the + originating recipe. Normally these dependencies are installed through + the :ref:`ref-tasks-install` task into + ``${``\ :term:`D`\ ``}``. The ``do_populate_sysroot`` task + copies a subset of these files into ``${SYSROOT_DESTDIR}``. This + subset of files is controlled by the + :term:`SYSROOT_DIRS`, + :term:`SYSROOT_DIRS_NATIVE`, and + :term:`SYSROOT_DIRS_BLACKLIST` + variables. + + .. note:: + + Additionally, a recipe can customize the files further by + declaring a processing function in the ``SYSROOT_PREPROCESS_FUNCS`` + variable. + + A shared state (sstate) object is built from these files and the + files are placed into a subdirectory of + :ref:`structure-build-tmp-sysroots-components`. + The files are scanned for hardcoded paths to the original + installation location. If the location is found in text files, the + hardcoded locations are replaced by tokens and a list of the files + needing such replacements is created. These adjustments are referred + to as "FIXMEs". The list of files that are scanned for paths is + controlled by the :term:`SSTATE_SCAN_FILES` + variable. + +- *Stage Two:* The second stage addresses recipes that want to use + something from another recipe and declare a dependency on that recipe + through the :term:`DEPENDS` variable. The recipe will + have a + :ref:`ref-tasks-prepare_recipe_sysroot` + task and when this task executes, it creates the ``recipe-sysroot`` + and ``recipe-sysroot-native`` in the recipe work directory (i.e. + :term:`WORKDIR`). The OpenEmbedded build system + creates hard links to copies of the relevant files from + ``sysroots-components`` into the recipe work directory. + + .. note:: + + If hard links are not possible, the build system uses actual + copies. + + The build system then addresses any "FIXMEs" to paths as defined from + the list created in the first stage. + + Finally, any files in ``${bindir}`` within the sysroot that have the + prefix "``postinst-``" are executed. + + .. note:: + + Although such sysroot post installation scripts are not + recommended for general use, the files do allow some issues such + as user creation and module indexes to be addressed. + + Because recipes can have other dependencies outside of ``DEPENDS`` + (e.g. ``do_unpack[depends] += "tar-native:do_populate_sysroot"``), + the sysroot creation function ``extend_recipe_sysroot`` is also added + as a pre-function for those tasks whose dependencies are not through + ``DEPENDS`` but operate similarly. + + When installing dependencies into the sysroot, the code traverses the + dependency graph and processes dependencies in exactly the same way + as the dependencies would or would not be when installed from sstate. + This processing means, for example, a native tool would have its + native dependencies added but a target library would not have its + dependencies traversed or installed. The same sstate dependency code + is used so that builds should be identical regardless of whether + sstate was used or not. For a closer look, see the + ``setscene_depvalid()`` function in the + :ref:`sstate ` class. + + The build system is careful to maintain manifests of the files it + installs so that any given dependency can be installed as needed. The + sstate hash of the installed item is also stored so that if it + changes, the build system can reinstall it. + +.. _ref-classes-syslinux: + +``syslinux.bbclass`` +==================== + +The ``syslinux`` class provides syslinux-specific functions for building +bootable images. + +The class supports the following variables: + +- :term:`INITRD`: Indicates list of filesystem images to + concatenate and use as an initial RAM disk (initrd). This variable is + optional. + +- :term:`ROOTFS`: Indicates a filesystem image to include + as the root filesystem. This variable is optional. + +- :term:`AUTO_SYSLINUXMENU`: Enables creating + an automatic menu when set to "1". + +- :term:`LABELS`: Lists targets for automatic + configuration. + +- :term:`APPEND`: Lists append string overrides for each + label. + +- :term:`SYSLINUX_OPTS`: Lists additional options + to add to the syslinux file. Semicolon characters separate multiple + options. + +- :term:`SYSLINUX_SPLASH`: Lists a background + for the VGA boot menu when you are using the boot menu. + +- :term:`SYSLINUX_DEFAULT_CONSOLE`: Set + to "console=ttyX" to change kernel boot default console. + +- :term:`SYSLINUX_SERIAL`: Sets an alternate + serial port. Or, turns off serial when the variable is set with an + empty string. + +- :term:`SYSLINUX_SERIAL_TTY`: Sets an + alternate "console=tty..." kernel boot argument. + +.. _ref-classes-systemd: + +``systemd.bbclass`` +=================== + +The ``systemd`` class provides support for recipes that install systemd +unit files. + +The functionality for this class is disabled unless you have "systemd" +in :term:`DISTRO_FEATURES`. + +Under this class, the recipe or Makefile (i.e. whatever the recipe is +calling during the :ref:`ref-tasks-install` task) +installs unit files into +``${``\ :term:`D`\ ``}${systemd_unitdir}/system``. If the unit +files being installed go into packages other than the main package, you +need to set :term:`SYSTEMD_PACKAGES` in your +recipe to identify the packages in which the files will be installed. + +You should set :term:`SYSTEMD_SERVICE` 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 ``${``\ :term:`PN`\ ``}``. Here +is an example from the connman recipe: +:: + + SYSTEMD_SERVICE_${PN} = "connman.service" + +Services are set up to start on boot automatically +unless you have set +:term:`SYSTEMD_AUTO_ENABLE` to "disable". + +For more information on ``systemd``, see the +":ref:`dev-manual/common-tasks:selecting an initialization manager`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-systemd-boot: + +``systemd-boot.bbclass`` +======================== + +The ``systemd-boot`` class provides functions specific to the +systemd-boot bootloader for building bootable images. This is an +internal class and is not intended to be used directly. + +.. note:: + + The ``systemd-boot`` class is a result from merging the ``gummiboot`` class + used in previous Yocto Project releases with the ``systemd`` project. + +Set the :term:`EFI_PROVIDER` variable to +"systemd-boot" to use this class. Doing so creates a standalone EFI +bootloader that is not dependent on systemd. + +For information on more variables used and supported in this class, see +the :term:`SYSTEMD_BOOT_CFG`, +:term:`SYSTEMD_BOOT_ENTRIES`, and +:term:`SYSTEMD_BOOT_TIMEOUT` variables. + +You can also see the `Systemd-boot +documentation `__ +for more information. + +.. _ref-classes-terminal: + +``terminal.bbclass`` +==================== + +The ``terminal`` class provides support for starting a terminal session. +The :term:`OE_TERMINAL` variable controls which +terminal emulator is used for the session. + +Other classes use the ``terminal`` class anywhere a separate terminal +session needs to be started. For example, the +:ref:`patch ` class assuming +:term:`PATCHRESOLVE` is set to "user", the +:ref:`cml1 ` class, and the +:ref:`devshell ` class all use the ``terminal`` +class. + +.. _ref-classes-testimage*: + +``testimage*.bbclass`` +====================== + +The ``testimage*`` 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. + +.. note:: + + Best practices include using :term:`IMAGE_CLASSES` rather than + :term:`INHERIT` to inherit the ``testimage`` class for automated image + testing. + +The tests are commands that run on the target system over ``ssh``. Each +test is written in Python and makes use of the ``unittest`` module. + +The ``testimage.bbclass`` runs tests on an image when called using the +following: +:: + + $ bitbake -c testimage image + +The ``testimage-auto`` class +runs tests on an image after the image is constructed (i.e. +:term:`TESTIMAGE_AUTO` must be set to "1"). + +For information on how to enable, run, and create new tests, see the +":ref:`dev-manual/common-tasks:performing automated runtime testing`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-testsdk: + +``testsdk.bbclass`` +=================== + +This class supports running automated tests against software development +kits (SDKs). The ``testsdk`` class runs tests on an SDK when called +using the following: +:: + + $ bitbake -c testsdk image + +.. note:: + + Best practices include using :term:`IMAGE_CLASSES` rather than + :term:`INHERIT` to inherit the ``testsdk`` class for automated SDK + testing. + +.. _ref-classes-texinfo: + +``texinfo.bbclass`` +=================== + +This class should be inherited by recipes whose upstream packages invoke +the ``texinfo`` utilities at build-time. Native and cross recipes are +made to use the dummy scripts provided by ``texinfo-dummy-native``, 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 :term:`ASSUME_PROVIDED` and makeinfo + from :term:`SANITY_REQUIRED_UTILITIES`. + +.. _ref-classes-toaster: + +``toaster.bbclass`` +=================== + +The ``toaster`` 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. + +This class is not intended to be used directly. + +.. _ref-classes-toolchain-scripts: + +``toolchain-scripts.bbclass`` +============================= + +The ``toolchain-scripts`` class provides the scripts used for setting up +the environment for installed SDKs. + +.. _ref-classes-typecheck: + +``typecheck.bbclass`` +===================== + +The ``typecheck`` 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: +:: + + IMAGE_FEATURES[type] = "list" + +.. _ref-classes-uboot-config: + +``uboot-config.bbclass`` +======================== + +The ``uboot-config`` class provides support for U-Boot configuration for +a machine. Specify the machine in your recipe as follows: +:: + + UBOOT_CONFIG ??= + UBOOT_CONFIG[foo] = "config,images" + +You can also specify the machine using this method: +:: + + UBOOT_MACHINE = "config" + +See the :term:`UBOOT_CONFIG` and :term:`UBOOT_MACHINE` variables for additional +information. + +.. _ref-classes-uninative: + +``uninative.bbclass`` +===================== + +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 ``meta/conf/distro/include/yocto-uninative.inc``. Other +distributions that do not derive from poky can also +"``require conf/distro/include/yocto-uninative.inc``" 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 +``UNINATIVE_URL`` and ``UNINATIVE_CHECKSUM`` appropriately. For an +example, see the ``meta/conf/distro/include/yocto-uninative.inc``. + +The ``uninative`` class is also used unconditionally by the extensible +SDK. When building the extensible SDK, ``uninative-tarball`` is built +and the resulting tarball is included within the SDK. + +.. _ref-classes-update-alternatives: + +``update-alternatives.bbclass`` +=============================== + +The ``update-alternatives`` 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 ``ar`` command is available from +the ``busybox``, ``binutils`` and ``elfutils`` packages. The +``update-alternatives`` class handles renaming the binaries so that +multiple packages can be installed without conflicts. The ``ar`` 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. + +To use this class, you need to define a number of variables: + +- :term:`ALTERNATIVE` + +- :term:`ALTERNATIVE_LINK_NAME` + +- :term:`ALTERNATIVE_TARGET` + +- :term:`ALTERNATIVE_PRIORITY` + +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 +:yocto_git:`update-alternatives.bbclass ` +file. + +.. note:: + + You can use the ``update-alternatives`` command directly in your recipes. + However, this class simplifies things in most cases. + +.. _ref-classes-update-rc.d: + +``update-rc.d.bbclass`` +======================= + +The ``update-rc.d`` class uses ``update-rc.d`` 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. + +Three variables control this class: ``INITSCRIPT_PACKAGES``, +``INITSCRIPT_NAME`` and ``INITSCRIPT_PARAMS``. See the variable links +for details. + +.. _ref-classes-useradd: + +``useradd*.bbclass`` +==================== + +The ``useradd*`` 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 ``meta-skeleton/recipes-skeleton/useradd/useradd-example.bb`` +recipe in the :term:`Source Directory` provides a simple +example that shows how to add three users and groups to two packages. +See the ``useradd-example.bb`` recipe for more information on how to use +these classes. + +The ``useradd_base`` class provides basic functionality for user or +groups settings. + +The ``useradd*`` classes support the +:term:`USERADD_PACKAGES`, +:term:`USERADD_PARAM`, +:term:`GROUPADD_PARAM`, and +:term:`GROUPMEMS_PARAM` variables. + +The ``useradd-staticids`` class supports the addition of users or groups +that have static user identification (``uid``) and group identification +(``gid``) values. + +The default behavior of the OpenEmbedded build system for assigning +``uid`` and ``gid`` 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 ``uid`` and ``gid`` values. However, if non-deterministic +``uid`` and ``gid`` 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 +:term:`BBPATH` for ``files/passwd`` and ``files/group`` +files for the values. + +To use static ``uid`` and ``gid`` values, you need to set some +variables. See the :term:`USERADDEXTENSION`, +:term:`USERADD_UID_TABLES`, +:term:`USERADD_GID_TABLES`, and +:term:`USERADD_ERROR_DYNAMIC` variables. +You can also see the :ref:`useradd ` class for +additional information. + +.. note:: + + You do not use the ``useradd-staticids`` class directly. You either enable + or disable the class by setting the ``USERADDEXTENSION`` variable. If you + enable or disable the class in a configured system, :term:`TMPDIR` might + contain incorrect ``uid`` and ``gid`` values. Deleting the ``TMPDIR`` + directory will correct this condition. + +.. _ref-classes-utility-tasks: + +``utility-tasks.bbclass`` +========================= + +The ``utility-tasks`` class provides support for various "utility" type +tasks that are applicable to all recipes, such as +:ref:`ref-tasks-clean` and +:ref:`ref-tasks-listtasks`. + +This class is enabled by default because it is inherited by the +:ref:`base ` class. + +.. _ref-classes-utils: + +``utils.bbclass`` +================= + +The ``utils`` class provides some useful Python functions that are +typically used in inline Python expressions (e.g. ``${@...}``). One +example use is for ``bb.utils.contains()``. + +This class is enabled by default because it is inherited by the +:ref:`base ` class. + +.. _ref-classes-vala: + +``vala.bbclass`` +================ + +The ``vala`` class supports recipes that need to build software written +using the Vala programming language. + +.. _ref-classes-waf: + +``waf.bbclass`` +=============== + +The ``waf`` class supports recipes that need to build software that uses +the Waf build system. You can use the +:term:`EXTRA_OECONF` or +:term:`PACKAGECONFIG_CONFARGS` variables +to specify additional configuration options to be passed on the Waf +command line. diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst new file mode 100644 index 0000000000..cc5848fd4d --- /dev/null +++ b/documentation/ref-manual/devtool-reference.rst @@ -0,0 +1,631 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +*************************** +``devtool`` Quick Reference +*************************** + +The ``devtool`` command-line tool provides a number of features that +help you build, test, and package software. This command is available +alongside the ``bitbake`` command. Additionally, the ``devtool`` command +is a key part of the extensible SDK. + +This chapter provides a Quick Reference for the ``devtool`` command. For +more information on how to apply the command when using the extensible +SDK, see the ":doc:`/sdk-manual/extensible`" chapter in the Yocto +Project Application Development and the Extensible Software Development +Kit (eSDK) manual. + +.. _devtool-getting-help: + +Getting Help +============ + +The ``devtool`` command line is organized similarly to Git in that it +has a number of sub-commands for each function. You can run +``devtool --help`` to see all the commands: +:: + + $ devtool -h + NOTE: Starting bitbake server... + usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] [--color COLOR] [-h] ... + + OpenEmbedded development tool + + options: + --basepath BASEPATH Base directory of SDK / build directory + --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it from the metadata + -d, --debug Enable debug output + -q, --quiet Print only errors + --color COLOR Colorize output (where COLOR is auto, always, never) + -h, --help show this help message and exit + + subcommands: + Beginning work on a recipe: + add Add a new recipe + modify Modify the source for an existing recipe + upgrade Upgrade an existing recipe + Getting information: + status Show workspace status + latest-version Report the latest version of an existing recipe + check-upgrade-status Report upgradability for multiple (or all) recipes + search Search available recipes + Working on a recipe in the workspace: + build Build a recipe + rename Rename a recipe file in the workspace + edit-recipe Edit a recipe file + find-recipe Find a recipe file + configure-help Get help on configure script options + update-recipe Apply changes from external source tree to recipe + reset Remove a recipe from your workspace + finish Finish working on a recipe in your workspace + Testing changes on target: + deploy-target Deploy recipe output files to live target machine + undeploy-target Undeploy recipe output files in live target machine + build-image Build image including workspace recipe packages + Advanced: + create-workspace Set up workspace in an alternative location + extract Extract the source for an existing recipe + sync Synchronize the source tree for an existing recipe + menuconfig Alter build-time configuration for a recipe + import Import exported tar archive into workspace + export Export workspace into a tar archive + other: + selftest-reverse Reverse value (for selftest) + pluginfile Print the filename of this plugin + bbdir Print the BBPATH directory of this plugin + count How many times have this plugin been registered. + multiloaded How many times have this plugin been initialized + Use devtool --help to get help on a specific command + +As directed in the general help output, you can +get more syntax on a specific command by providing the command name and +using "--help": +:: + + $ devtool add --help + NOTE: Starting bitbake server... + usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] [--npm-dev] [--version VERSION] [--no-git] [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH] [--binary] [--also-native] [--src-subdir SUBDIR] [--mirrors] + [--provides PROVIDES] + [recipename] [srctree] [fetchuri] + + Adds a new recipe to the workspace to build a specified source tree. Can optionally fetch a remote URI and unpack it to create the source tree. + + arguments: + recipename Name for new recipe to add (just name - no version, path or extension). If not specified, will attempt to auto-detect it. + srctree Path to external source tree. If not specified, a subdirectory of /media/build1/poky/build/workspace/sources will be used. + fetchuri Fetch the specified URI and extract it to create the source tree + + options: + -h, --help show this help message and exit + --same-dir, -s Build in same directory as source + --no-same-dir Force build in a separate build directory + --fetch URI, -f URI Fetch the specified URI and extract it to create the source tree (deprecated - pass as positional argument instead) + --npm-dev For npm, also fetch devDependencies + --version VERSION, -V VERSION + Version to use within recipe (PV) + --no-git, -g If fetching source, do not set up source tree as a git repository + --srcrev SRCREV, -S SRCREV + Source revision to fetch if fetching from an SCM such as git (default latest) + --autorev, -a When fetching from a git repository, set SRCREV in the recipe to a floating revision instead of fixed + --srcbranch SRCBRANCH, -B SRCBRANCH + Branch in source repository if fetching from an SCM such as git (default master) + --binary, -b Treat the source tree as something that should be installed verbatim (no compilation, same directory structure). Useful with binary packages e.g. RPMs. + --also-native Also add native variant (i.e. support building recipe for the build host as well as the target machine) + --src-subdir SUBDIR Specify subdirectory within source tree to use + --mirrors Enable PREMIRRORS and MIRRORS for source tree fetching (disable by default). + --provides PROVIDES, -p PROVIDES + Specify an alias for the item provided by the recipe. E.g. virtual/libgl + +.. _devtool-the-workspace-layer-structure: + +The Workspace Layer Structure +============================= + +``devtool`` uses a "Workspace" layer in which to accomplish builds. This +layer is not specific to any single ``devtool`` command but is rather a +common working area used across the tool. + +The following figure shows the workspace structure: + +.. image:: figures/build-workspace-directory.png + :align: center + :scale: 70% + +.. code-block:: none + + attic - A directory created if devtool believes it must preserve + anything when you run "devtool reset". For example, if you + run "devtool add", make changes to the recipe, and then + run "devtool reset", devtool takes notice that the file has + been changed and moves it into the attic should you still + want the recipe. + + README - Provides information on what is in workspace layer and how to + manage it. + + .devtool_md5 - A checksum file used by devtool. + + appends - A directory that contains *.bbappend files, which point to + external source. + + conf - A configuration directory that contains the layer.conf file. + + recipes - A directory containing recipes. This directory contains a + folder for each directory added whose name matches that of the + added recipe. devtool places the recipe.bb file + within that sub-directory. + + sources - A directory containing a working copy of the source files used + when building the recipe. This is the default directory used + as the location of the source tree when you do not provide a + source tree path. This directory contains a folder for each + set of source files matched to a corresponding recipe. + +.. _devtool-adding-a-new-recipe-to-the-workspace: + +Adding a New Recipe to the Workspace Layer +========================================== + +Use the ``devtool add`` command to add a new recipe to the workspace +layer. The recipe you add should not exist - ``devtool`` creates it for +you. The source files the recipe uses should exist in an external area. + +The following example creates and adds a new recipe named ``jackson`` to +a workspace layer the tool creates. The source code built by the recipes +resides in ``/home/user/sources/jackson``: +:: + + $ devtool add jackson /home/user/sources/jackson + +If you add a recipe and the workspace layer does not exist, the command +creates the layer and populates it as described in "`The Workspace Layer +Structure <#devtool-the-workspace-layer-structure>`__" section. + +Running ``devtool add`` when the workspace layer exists causes the tool +to add the recipe, append files, and source files into the existing +workspace layer. The ``.bbappend`` file is created to point to the +external source tree. + +.. note:: + + If your recipe has runtime dependencies defined, you must be sure + that these packages exist on the target hardware before attempting to + run your application. If dependent packages (e.g. libraries) do not + exist on the target, your application, when run, will fail to find + those functions. For more information, see the + ":ref:`ref-manual/devtool-reference:deploying your software on the target machine`" + section. + +By default, ``devtool add`` uses the latest revision (i.e. master) when +unpacking files from a remote URI. In some cases, you might want to +specify a source revision by branch, tag, or commit hash. You can +specify these options when using the ``devtool add`` command: + +- To specify a source branch, use the ``--srcbranch`` option: + :: + + $ devtool add --srcbranch DISTRO_NAME_NO_CAP jackson /home/user/sources/jackson + + In the previous example, you are checking out the DISTRO_NAME_NO_CAP + branch. + +- To specify a specific tag or commit hash, use the ``--srcrev`` + option: + :: + + $ devtool add --srcrev DISTRO_REL_TAG jackson /home/user/sources/jackson + $ devtool add --srcrev some_commit_hash /home/user/sources/jackson + + The previous examples check out the + DISTRO_REL_TAG tag and the commit associated with the + some_commit_hash hash. + +.. note:: + + If you prefer to use the latest revision every time the recipe is + built, use the options ``--autorev`` or ``-a``. + +.. _devtool-extracting-the-source-for-an-existing-recipe: + +Extracting the Source for an Existing Recipe +============================================ + +Use the ``devtool extract`` command to extract the source for an +existing recipe. When you use this command, you must supply the root +name of the recipe (i.e. no version, paths, or extensions), and you must +supply the directory to which you want the source extracted. + +Additional command options let you control the name of a development +branch into which you can checkout the source and whether or not to keep +a temporary directory, which is useful for debugging. + +.. _devtool-synchronizing-a-recipes-extracted-source-tree: + +Synchronizing a Recipe's Extracted Source Tree +============================================== + +Use the ``devtool sync`` command to synchronize a previously extracted +source tree for an existing recipe. When you use this command, you must +supply the root name of the recipe (i.e. no version, paths, or +extensions), and you must supply the directory to which you want the +source extracted. + +Additional command options let you control the name of a development +branch into which you can checkout the source and whether or not to keep +a temporary directory, which is useful for debugging. + +.. _devtool-modifying-a-recipe: + +Modifying an Existing Recipe +============================ + +Use the ``devtool modify`` command to begin modifying the source of an +existing recipe. This command is very similar to the +:ref:`add ` command +except that it does not physically create the recipe in the workspace +layer because the recipe already exists in an another layer. + +The ``devtool modify`` command extracts the source for a recipe, sets it +up as a Git repository if the source had not already been fetched from +Git, checks out a branch for development, and applies any patches from +the recipe as commits on top. You can use the following command to +checkout the source files: +:: + + $ devtool modify recipe + +Using the above command form, ``devtool`` uses the existing recipe's +:term:`SRC_URI` statement to locate the upstream source, +extracts the source into the default sources location in the workspace. +The default development branch used is "devtool". + +.. _devtool-edit-an-existing-recipe: + +Edit an Existing Recipe +======================= + +Use the ``devtool edit-recipe`` command to run the default editor, which +is identified using the ``EDITOR`` variable, on the specified recipe. + +When you use the ``devtool edit-recipe`` command, you must supply the +root name of the recipe (i.e. no version, paths, or extensions). Also, +the recipe file itself must reside in the workspace as a result of the +``devtool add`` or ``devtool upgrade`` commands. However, you can +override that requirement by using the "-a" or "--any-recipe" option. +Using either of these options allows you to edit any recipe regardless +of its location. + +.. _devtool-updating-a-recipe: + +Updating a Recipe +================= + +Use the ``devtool update-recipe`` command to update your recipe with +patches that reflect changes you make to the source files. For example, +if you know you are going to work on some code, you could first use the +:ref:`devtool modify ` command to extract +the code and set up the workspace. After which, you could modify, +compile, and test the code. + +When you are satisfied with the results and you have committed your +changes to the Git repository, you can then run the +``devtool update-recipe`` to create the patches and update the recipe: +:: + + $ devtool update-recipe recipe + +If you run the ``devtool update-recipe`` +without committing your changes, the command ignores the changes. + +Often, you might want to apply customizations made to your software in +your own layer rather than apply them to the original recipe. If so, you +can use the ``-a`` or ``--append`` option with the +``devtool update-recipe`` command. These options allow you to specify +the layer into which to write an append file: +:: + + $ devtool update-recipe recipe -a base-layer-directory + +The ``*.bbappend`` file is created at the +appropriate path within the specified layer directory, which may or may +not be in your ``bblayers.conf`` file. If an append file already exists, +the command updates it appropriately. + +.. _devtool-checking-on-the-upgrade-status-of-a-recipe: + +Checking on the Upgrade Status of a Recipe +========================================== + +Upstream recipes change over time. Consequently, you might find that you +need to determine if you can upgrade a recipe to a newer version. + +To check on the upgrade status of a recipe, use the +``devtool check-upgrade-status`` command. The command displays a table +of your current recipe versions, the latest upstream versions, the email +address of the recipe's maintainer, and any additional information such +as commit hash strings and reasons you might not be able to upgrade a +particular recipe. + +.. note:: + + - For the ``oe-core`` layer, recipe maintainers come from the + :yocto_git:`maintainers.inc ` + file. + + - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` + rather than a + tarball, the commit hash points to the commit that matches the + recipe's latest version tag. + +As with all ``devtool`` commands, you can get help on the individual +command: +:: + + $ devtool check-upgrade-status -h + NOTE: Starting bitbake server... + usage: devtool check-upgrade-status [-h] [--all] [recipe [recipe ...]] + + Prints a table of recipes together with versions currently provided by recipes, and latest upstream versions, when there is a later version available + + arguments: + recipe Name of the recipe to report (omit to report upgrade info for all recipes) + + options: + -h, --help show this help message and exit + --all, -a Show all recipes, not just recipes needing upgrade + +Unless you provide a specific recipe name on the command line, the +command checks all recipes in all configured layers. + +Following is a partial example table that reports on all the recipes. +Notice the reported reason for not upgrading the ``base-passwd`` recipe. +In this example, while a new version is available upstream, you do not +want to use it because the dependency on ``cdebconf`` is not easily +satisfied. + +.. note:: + + When a reason for not upgrading displays, the reason is usually + written into the recipe using the ``RECIPE_NO_UPDATE_REASON`` + variable. See the + :yocto_git:`base-passwd.bb ` + recipe for an example. + +:: + + $ devtool check-upgrade-status + ... + NOTE: acpid 2.0.30 2.0.31 Ross Burton + NOTE: u-boot-fw-utils 2018.11 2019.01 Marek Vasut d3689267f92c5956e09cc7d1baa4700141662bff + NOTE: u-boot-tools 2018.11 2019.01 Marek Vasut d3689267f92c5956e09cc7d1baa4700141662bff + . + . + . + NOTE: base-passwd 3.5.29 3.5.45 Anuj Mittal cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility + NOTE: busybox 1.29.2 1.30.0 Andrej Valek + NOTE: dbus-test 1.12.10 1.12.12 Chen Qi + +.. _devtool-upgrading-a-recipe: + +Upgrading a Recipe +================== + +As software matures, upstream recipes are upgraded to newer versions. As +a developer, you need to keep your local recipes up-to-date with the +upstream version releases. Several methods exist by which you can +upgrade recipes. You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`" +section of the Yocto Project Development Tasks Manual. This section +overviews the ``devtool upgrade`` command. + +Before you upgrade a recipe, you can check on its upgrade status. See +the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" section +for more information. + +The ``devtool upgrade`` command upgrades an existing recipe to a more +recent version of the recipe upstream. The command puts the upgraded +recipe file along with any associated files into a "workspace" and, if +necessary, extracts the source tree to a specified location. During the +upgrade, patches associated with the recipe are rebased or added as +needed. + +When you use the ``devtool upgrade`` command, you must supply the root +name of the recipe (i.e. no version, paths, or extensions), and you must +supply the directory to which you want the source extracted. Additional +command options let you control things such as the version number to +which you want to upgrade (i.e. the :term:`PV`), the source +revision to which you want to upgrade (i.e. the +:term:`SRCREV`), whether or not to apply patches, and so +forth. + +You can read more on the ``devtool upgrade`` workflow in the +":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" +section in the Yocto Project Application Development and the Extensible +Software Development Kit (eSDK) manual. You can also see an example of +how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``" +section in the Yocto Project Development Tasks Manual. + +.. _devtool-resetting-a-recipe: + +Resetting a Recipe +================== + +Use the ``devtool reset`` command to remove a recipe and its +configuration (e.g. the corresponding ``.bbappend`` file) from the +workspace layer. Realize that this command deletes the recipe and the +append file. The command does not physically move them for you. +Consequently, you must be sure to physically relocate your updated +recipe and the append file outside of the workspace layer before running +the ``devtool reset`` command. + +If the ``devtool reset`` command detects that the recipe or the append +files have been modified, the command preserves the modified files in a +separate "attic" subdirectory under the workspace layer. + +Here is an example that resets the workspace directory that contains the +``mtr`` recipe: +:: + + $ devtool reset mtr + NOTE: Cleaning sysroot for recipe mtr... + NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually + $ + +.. _devtool-building-your-recipe: + +Building Your Recipe +==================== + +Use the ``devtool build`` command to build your recipe. The +``devtool build`` command is equivalent to the +``bitbake -c populate_sysroot`` command. + +When you use the ``devtool build`` command, you must supply the root +name of the recipe (i.e. do not provide versions, paths, or extensions). +You can use either the "-s" or the "--disable-parallel-make" options to +disable parallel makes during the build. Here is an example: +:: + + $ devtool build recipe + +.. _devtool-building-your-image: + +Building Your Image +=================== + +Use the ``devtool build-image`` command to build an image, extending it +to include packages from recipes in the workspace. Using this command is +useful when you want an image that ready for immediate deployment onto a +device for testing. For proper integration into a final image, you need +to edit your custom image recipe appropriately. + +When you use the ``devtool build-image`` command, you must supply the +name of the image. This command has no command line options: +:: + + $ devtool build-image image + +.. _devtool-deploying-your-software-on-the-target-machine: + +Deploying Your Software on the Target Machine +============================================= + +Use the ``devtool deploy-target`` command to deploy the recipe's build +output to the live target machine: +:: + + $ devtool deploy-target recipe target + +The target is the address of the target machine, which must be running +an SSH server (i.e. ``user@hostname[:destdir]``). + +This command deploys all files installed during the +:ref:`ref-tasks-install` task. Furthermore, you do not +need to have package management enabled within the target machine. If +you do, the package manager is bypassed. + +.. note:: + + The ``deploy-target`` functionality is for development only. You + should never use it to update an image that will be used in + production. + +Some conditions exist that could prevent a deployed application from +behaving as expected. When both of the following conditions exist, your +application has the potential to not behave correctly when run on the +target: + +- You are deploying a new application to the target and the recipe you + used to build the application had correctly defined runtime + dependencies. + +- The target does not physically have the packages on which the + application depends installed. + +If both of these conditions exist, your application will not behave as +expected. The reason for this misbehavior is because the +``devtool deploy-target`` command does not deploy the packages (e.g. +libraries) on which your new application depends. The assumption is that +the packages are already on the target. Consequently, when a runtime +call is made in the application for a dependent function (e.g. a library +call), the function cannot be found. + +To be sure you have all the dependencies local to the target, you need +to be sure that the packages are pre-deployed (installed) on the target +before attempting to run your application. + +.. _devtool-removing-your-software-from-the-target-machine: + +Removing Your Software from the Target Machine +============================================== + +Use the ``devtool undeploy-target`` command to remove deployed build +output from the target machine. For the ``devtool undeploy-target`` +command to work, you must have previously used the +":ref:`devtool deploy-target `" +command. +:: + + $ devtool undeploy-target recipe target + +The target is the +address of the target machine, which must be running an SSH server (i.e. +``user@hostname``). + +.. _devtool-creating-the-workspace: + +Creating the Workspace Layer in an Alternative Location +======================================================= + +Use the ``devtool create-workspace`` command to create a new workspace +layer in your :term:`Build Directory`. When you create a +new workspace layer, it is populated with the ``README`` file and the +``conf`` directory only. + +The following example creates a new workspace layer in your current +working and by default names the workspace layer "workspace": +:: + + $ devtool create-workspace + +You can create a workspace layer anywhere by supplying a pathname with +the command. The following command creates a new workspace layer named +"new-workspace": +:: + + $ devtool create-workspace /home/scottrif/new-workspace + +.. _devtool-get-the-status-of-the-recipes-in-your-workspace: + +Get the Status of the Recipes in Your Workspace +=============================================== + +Use the ``devtool status`` command to list the recipes currently in your +workspace. Information includes the paths to their respective external +source trees. + +The ``devtool status`` command has no command-line options: +:: + + $ devtool status + +Following is sample output after using +:ref:`devtool add ` +to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory: +:: + + $ devtool status + mtr:/home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb) + $ + +.. _devtool-search-for-available-target-recipes: + +Search for Available Target Recipes +=================================== + +Use the ``devtool search`` command to search for available target +recipes. The command matches the recipe name, package name, description, +and installed files. The command displays the recipe name as a result of +a match. + +When you use the ``devtool search`` command, you must supply a keyword. +The command uses the keyword when searching for a match. diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index cc6b3aee1b..f67c53824b 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst @@ -22,7 +22,7 @@ Can I still use the Yocto Project? **A:** 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 -":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`" +":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" section for steps on how to update your build tools. **Q:** How can you claim Poky / OpenEmbedded-Core is stable? diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst new file mode 100644 index 0000000000..89c06eb65f --- /dev/null +++ b/documentation/ref-manual/features.rst @@ -0,0 +1,350 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +******** +Features +******** + +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. + +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 ``DISTRO_FEATURES`` variable, +which is set or appended to in a distribution's configuration file such +as ``poky.conf``, ``poky-tiny.conf``, ``poky-lsb.conf`` and so forth. +Machine features are set in the ``MACHINE_FEATURES`` variable, which is +set in the machine configuration file and specifies the hardware +features for a given machine. + +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. + +One method you can use to determine which recipes are checking to see if +a particular feature is contained or not is to ``grep`` through the +:term:`Metadata` for the feature. Here is an example that +discovers the recipes whose build is potentially changed based on a +given feature: +:: + + $ cd poky + $ git grep 'contains.*MACHINE_FEATURES.*feature' + +.. _ref-features-machine: + +Machine Features +================ + +The items below are features you can use with +:term:`MACHINE_FEATURES`. 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 :ref:`ref-tasks-configure` task +for a particular recipe. + +This feature list only represents features as shipped with the Yocto +Project metadata: + +- *acpi:* Hardware has ACPI (x86/x86_64 only) + +- *alsa:* Hardware has ALSA audio drivers + +- *apm:* Hardware uses APM (or APM emulation) + +- *bluetooth:* Hardware has integrated BT + +- *efi:* Support for booting through EFI + +- *ext2:* Hardware HDD or Microdrive + +- *keyboard:* Hardware has a keyboard + +- *pcbios:* Support for booting through BIOS + +- *pci:* Hardware has a PCI bus + +- *pcmcia:* Hardware has PCMCIA or CompactFlash sockets + +- *phone:* Mobile phone (voice) support + +- *qvga:* Machine has a QVGA (320x240) display + +- *rtc:* Machine has a Real-Time Clock + +- *screen:* Hardware has a screen + +- *serial:* Hardware has serial support (usually RS232) + +- *touchscreen:* Hardware has a touchscreen + +- *usbgadget:* Hardware is USB gadget device capable + +- *usbhost:* Hardware is USB Host capable + +- *vfat:* FAT file system support + +- *wifi:* Hardware has integrated WiFi + +.. _ref-features-distro: + +Distro Features +=============== + +The items below are features you can use with +:term:`DISTRO_FEATURES` 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 :ref:`ref-tasks-configure` task for +the recipes that optionally support the feature. + +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 +:term:`COMBINED_FEATURES` variable for more +information. + +This list only represents features as shipped with the Yocto Project +metadata: + +- *alsa:* Include ALSA support (OSS compatibility kernel modules + installed if available). + +- *api-documentation:* Enables generation of API documentation during + recipe builds. The resulting documentation is added to SDK tarballs + when the ``bitbake -c populate_sdk`` command is used. See the + ":ref:`sdk-manual/appendix-customizing-standard:adding api documentation to the standard sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + +- *bluetooth:* Include bluetooth support (integrated BT only). + +- *cramfs:* Include CramFS support. + +- *directfb:* Include DirectFB support. + +- *ext2:* Include tools for supporting for devices with internal + HDD/Microdrive for storing files (instead of Flash only devices). + +- *ipsec:* Include IPSec support. + +- *ipv6:* Include IPv6 support. + +- *keyboard:* Include keyboard support (e.g. keymaps will be loaded + during boot). + +- *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the + target. + +- *nfs:* Include NFS client support (for mounting NFS exports on + device). + +- *opengl:* Include the Open Graphics Library, which is a + cross-language, multi-platform application programming interface used + for rendering two and three-dimensional graphics. + +- *pci:* Include PCI bus support. + +- *pcmcia:* Include PCMCIA/CompactFlash support. + +- *ppp:* Include PPP dialup support. + +- *ptest:* Enables building the package tests where supported by + individual recipes. For more information on package tests, see the + ":ref:`dev-manual/common-tasks:testing packages with ptest`" section + in the Yocto Project Development Tasks Manual. + +- *smbfs:* Include SMB networks client support (for mounting + Samba/Microsoft Windows shares on device). + +- *systemd:* Include support for this ``init`` manager, which is a full + replacement of for ``init`` with parallel starting of services, + reduced shell overhead, and other features. This ``init`` manager is + used by many distributions. + +- *usbgadget:* Include USB Gadget Device support (for USB + networking/serial/storage). + +- *usbhost:* Include USB Host support (allows to connect external + keyboard, mouse, storage, network etc). + +- *usrmerge:* Merges the ``/bin``, ``/sbin``, ``/lib``, and ``/lib64`` + directories into their respective counterparts in the ``/usr`` + directory to provide better package and application compatibility. + +- *wayland:* Include the Wayland display server protocol and the + library that supports it. + +- *wifi:* Include WiFi support (integrated only). + +- *x11:* Include the X server and libraries. + +.. _ref-features-image: + +Image Features +============== + +The contents of images generated by the OpenEmbedded build system can be +controlled by the :term:`IMAGE_FEATURES` and +:term:`EXTRA_IMAGE_FEATURES` 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. + +The following image features are available for all images: + +- *allow-empty-password:* Allows Dropbear and OpenSSH to accept root + logins and logins from accounts having an empty password string. + +- *dbg-pkgs:* Installs debug symbol packages for all packages installed + in a given image. + +- *debug-tweaks:* 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. + +- *dev-pkgs:* Installs development packages (headers and extra library + links) for all packages installed in a given image. + +- *doc-pkgs:* Installs documentation packages for all packages + installed in a given image. + +- *empty-root-password:* Sets the root password to an empty string, + which allows logins with a blank password. + +- *package-management:* Installs package management tools and preserves + the package manager database. + +- *post-install-logging:* Enables logging postinstall script runs to + the ``/var/log/postinstall.log`` file on first boot of the image on + the target system. + + .. note:: + + To make the ``/var/log`` directory on the target persistent, use the + :term:`VOLATILE_LOG_DIR` variable by setting it to "no". + +- *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes. + +- *read-only-rootfs:* Creates an image whose root filesystem is + read-only. See the + ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" + section in the Yocto Project Development Tasks Manual for more + information. + +- *splash:* Enables showing a splash screen during boot. By default, + this screen is provided by ``psplash``, which does allow + customization. If you prefer to use an alternative splash screen + package, you can do so by setting the ``SPLASH`` variable to a + different package name (or names) within the image recipe or at the + distro configuration level. + +- *staticdev-pkgs:* Installs static development packages, which are + static libraries (i.e. ``*.a`` files), for all packages installed in + a given image. + +Some image features are available only when you inherit the +:ref:`core-image ` class. The current list of +these valid features is as follows: + +- *hwcodecs:* Installs hardware acceleration codecs. + +- *nfs-server:* Installs an NFS server. + +- *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and + ``LTTng``. For general information on user-space tools, see the + :doc:`/sdk-manual/index` manual. + +- *ssh-server-dropbear:* Installs the Dropbear minimal SSH server. + +- *ssh-server-openssh:* 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 + ``IMAGE_FEATURES``, then OpenSSH will take precedence and Dropbear + will not be installed. + +- *tools-debug:* Installs debugging tools such as ``strace`` and + ``gdb``. For information on GDB, see the + ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section + in the Yocto Project Development Tasks Manual. For information on + tracing and profiling, see the :doc:`/profile-manual/index`. + +- *tools-sdk:* Installs a full SDK that runs on the device. + +- *tools-testapps:* Installs device testing tools (e.g. touchscreen + debugging). + +- *x11:* Installs the X server. + +- *x11-base:* Installs the X server with a minimal environment. + +- *x11-sato:* Installs the OpenedHand Sato environment. + +.. _ref-features-backfill: + +Feature Backfilling +=================== + +Sometimes it is necessary in the OpenEmbedded build system to extend +:term:`MACHINE_FEATURES` or +:term:`DISTRO_FEATURES` 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 +:term:`DISTRO_FEATURES_BACKFILL` and +:term:`MACHINE_FEATURES_BACKFILL` +variables in the ``meta/conf/bitbake.conf`` file. + +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 +:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` +or +:term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` +variables for distro features and machine features respectively. + +Here are two examples to help illustrate feature backfilling: + +- *The "pulseaudio" distro feature option*: 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 ``DISTRO_FEATURES_BACKFILL`` variable in the + ``meta/conf/bitbake.conf`` 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 ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` in + your distro's ``.conf`` file. Adding the feature to this variable + when it also exists in the ``DISTRO_FEATURES_BACKFILL`` variable + prevents the build system from adding the feature to your + configuration's ``DISTRO_FEATURES``, effectively disabling the + feature for that particular distro. + +- *The "rtc" machine feature option*: 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 + ``MACHINE_FEATURES_BACKFILL`` variable in the + ``meta/conf/bitbake.conf`` 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 ``MACHINE_FEATURES_BACKFILL_CONSIDERED`` + list in the machine's ``.conf`` file. Adding the feature to this + variable when it also exists in the ``MACHINE_FEATURES_BACKFILL`` + variable prevents the build system from adding the feature to your + configuration's ``MACHINE_FEATURES``, effectively disabling RTC + support for that particular machine. diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst new file mode 100644 index 0000000000..5e9374eae7 --- /dev/null +++ b/documentation/ref-manual/images.rst @@ -0,0 +1,138 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +****** +Images +****** + +The OpenEmbedded build system provides several example images to satisfy +different needs. When you issue the ``bitbake`` command you provide a +"top-level" recipe that essentially begins the build for the type of +image you want. + +.. 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 ``local.conf`` + file before using the BitBake command to build the minimal or base + image: + :: + + 1. Comment out the EXTRA_IMAGE_FEATURES line + 2. Set INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" + + +From within the ``poky`` Git repository, you can use the following +command to display the list of directories within the :term:`Source Directory` +that contain image recipe files: :: + + $ ls meta*/recipes*/images/*.bb + +Following is a list of supported recipes: + +- ``build-appliance-image``: 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 `VMware + Player `__ or + `VMware + Workstation `__. + For more information on this image, see the :yocto_home:`Build + Appliance ` page + on the Yocto Project website. + +- ``core-image-base``: A console-only image that fully supports the + target device hardware. + +- ``core-image-clutter``: An image with support for the Open GL-based + toolkit Clutter, which enables development of rich and animated + graphical user interfaces. + +- ``core-image-full-cmdline``: A console-only image with more + full-featured Linux system functionality installed. + +- ``core-image-lsb``: An image that conforms to the Linux Standard Base + (LSB) specification. This image requires a distribution configuration + that enables LSB compliance (e.g. ``poky-lsb``). If you build + ``core-image-lsb`` without that configuration, the image will not be + LSB-compliant. + +- ``core-image-lsb-dev``: A ``core-image-lsb`` 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. ``poky-lsb``). If you build ``core-image-lsb-dev`` without that + configuration, the image will not be LSB-compliant. + +- ``core-image-lsb-sdk``: A ``core-image-lsb`` 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. + ``poky-lsb``). If you build ``core-image-lsb-sdk`` without that + configuration, the image will not be LSB-compliant. This image is + suitable for development using the target. + +- ``core-image-minimal``: A small image just capable of allowing a + device to boot. + +- ``core-image-minimal-dev``: A ``core-image-minimal`` image suitable + for development work using the host. The image includes headers and + libraries you can use in a host development environment. + +- ``core-image-minimal-initramfs``: A ``core-image-minimal`` 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 + :term:`PACKAGE_INSTALL` variable for + additional information helpful when working with initramfs images. + +- ``core-image-minimal-mtdutils``: A ``core-image-minimal`` 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. + +- ``core-image-rt``: A ``core-image-minimal`` image plus a real-time + test suite and tools appropriate for real-time use. + +- ``core-image-rt-sdk``: A ``core-image-rt`` 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. + +- ``core-image-sato``: 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. + +- ``core-image-sato-dev``: A ``core-image-sato`` 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 ``core-image-sdk``. + +- ``core-image-sato-sdk``: A ``core-image-sato`` 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. + +- ``core-image-testmaster``: 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 + ":ref:`dev-manual/common-tasks:performing automated runtime testing`" + section in the Yocto Project Development Tasks Manual. + +- ``core-image-testmaster-initramfs``: A RAM-based Initial Root + Filesystem (initramfs) image tailored for use with the + ``core-image-testmaster`` image. + +- ``core-image-weston``: 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 + ":ref:`dev-manual/common-tasks:using wayland and weston`" + section in the Yocto Project Development Tasks Manual. + +- ``core-image-x11``: A very basic X11 image with a terminal. diff --git a/documentation/ref-manual/index.rst b/documentation/ref-manual/index.rst index 033f4ba28c..deb0383cfc 100644 --- a/documentation/ref-manual/index.rst +++ b/documentation/ref-manual/index.rst @@ -10,20 +10,20 @@ Yocto Project Reference Manual :caption: Table of Contents :numbered: - ref-system-requirements - ref-terms - ref-release-process + system-requirements + terms + release-process migration - ref-structure - ref-classes - ref-tasks - ref-devtool-reference - ref-kickstart - ref-qa-checks - ref-images - ref-features - ref-variables - ref-varlocality + structure + classes + tasks + devtool-reference + kickstart + qa-checks + images + features + variables + varlocality faq resources history diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst new file mode 100644 index 0000000000..bb9c0460f3 --- /dev/null +++ b/documentation/ref-manual/kickstart.rst @@ -0,0 +1,216 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +******************************************* +OpenEmbedded Kickstart (``.wks``) Reference +******************************************* + +.. _openembedded-kickstart-wks-reference: + +Introduction +============ + +The current Wic implementation supports only the basic kickstart +partitioning commands: ``partition`` (or ``part`` for short) and +``bootloader``. + +.. note:: + + Future updates will implement more commands and options. If you use + anything that is not specifically supported, results can be + unpredictable. + +This chapter provides a reference on the available kickstart commands. +The information lists the commands, their syntax, and meanings. +Kickstart commands are based on the Fedora kickstart versions but with +modifications to reflect Wic capabilities. You can see the original +documentation for those commands at the following link: +http://pykickstart.readthedocs.io/en/latest/kickstart-docs.html + +Command: part or partition +========================== + +Either of these commands creates a partition on the system and uses the +following syntax: +:: + + part [mntpoint] + partition [mntpoint] + +If you do not +provide mntpoint, Wic creates a partition but does not mount it. + +The ``mntpoint`` is where the partition is mounted and must be in one of +the following forms: + +- ``/path``: For example, "/", "/usr", or "/home" + +- ``swap``: The created partition is used as swap space + +Specifying a mntpoint causes the partition to automatically be mounted. +Wic achieves this by adding entries to the filesystem table (fstab) +during image generation. In order for Wic to generate a valid fstab, you +must also provide one of the ``--ondrive``, ``--ondisk``, or +``--use-uuid`` partition options as part of the command. + +.. note:: + + The mount program must understand the PARTUUID syntax you use with + ``--use-uuid`` and non-root *mountpoint*, including swap. The busybox + versions of these application are currently excluded. + +Here is an example that uses "/" as the mountpoint. The command uses +``--ondisk`` to force the partition onto the ``sdb`` disk: +:: + + part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 + +Here is a list that describes other supported options you can use with +the ``part`` and ``partition`` commands: + +- ``--size``: The minimum partition size in MBytes. Specify an + integer value such as 500. Do not append the number with "MB". You do + not need this option if you use ``--source``. + +- ``--fixed-size``: The exact partition size in MBytes. You cannot + specify with ``--size``. An error occurs when assembling the disk + image if the partition data is larger than ``--fixed-size``. + +- ``--source``: This option is a Wic-specific option that names the + source of the data that populates the partition. The most common + value for this option is "rootfs", but you can use any value that + maps to a valid source plugin. For information on the source plugins, + see the ":ref:`dev-manual/common-tasks:using the wic plugin interface`" + section in the Yocto Project Development Tasks Manual. + + If you use ``--source rootfs``, Wic creates a partition as large as + needed and fills it with the contents of the root filesystem pointed + to by the ``-r`` command-line option or the equivalent rootfs derived + from the ``-e`` command-line option. The filesystem type used to + create the partition is driven by the value of the ``--fstype`` + option specified for the partition. See the entry on ``--fstype`` + that follows for more information. + + If you use ``--source plugin-name``, Wic creates a partition as large + as needed and fills it with the contents of the partition that is + generated by the specified plugin name using the data pointed to by + the ``-r`` command-line option or the equivalent rootfs derived from + the ``-e`` command-line option. Exactly what those contents are and + filesystem type used are dependent on the given plugin + implementation. + + If you do not use the ``--source`` option, the ``wic`` command + creates an empty partition. Consequently, you must use the ``--size`` + option to specify the size of the empty partition. + +- ``--ondisk`` or ``--ondrive``: Forces the partition to be created + on a particular disk. + +- ``--fstype``: Sets the file system type for the partition. Valid + values are: + + - ``ext4`` + + - ``ext3`` + + - ``ext2`` + + - ``btrfs`` + + - ``squashfs`` + + - ``swap`` + +- ``--fsoptions``: Specifies a free-form string of options to be used + when mounting the filesystem. This string is copied into the + ``/etc/fstab`` file of the installed system and should be enclosed in + quotes. If not specified, the default string is "defaults". + +- ``--label label``: Specifies the label to give to the filesystem to + be made on the partition. If the given label is already in use by + another filesystem, a new label is created for the partition. + +- ``--active``: Marks the partition as active. + +- ``--align (in KBytes)``: This option is a Wic-specific option that + says to start partitions on boundaries given x KBytes. + +- ``--offset (in KBytes)``: This option is a Wic-specific option that + says to place a partition at exactly the specified offset. If the + partition cannot be placed at the specified offset, the image build + will fail. + +- ``--no-table``: This option is a Wic-specific option. Using the + option reserves space for the partition and causes it to become + populated. However, the partition is not added to the partition + table. + +- ``--exclude-path``: This option is a Wic-specific option that + excludes the given relative path from the resulting image. This + option is only effective with the rootfs source plugin. + +- ``--extra-space``: This option is a Wic-specific option that adds + extra space after the space filled by the content of the partition. + The final size can exceed the size specified by the ``--size`` + option. The default value is 10 Mbytes. + +- ``--overhead-factor``: This option is a Wic-specific option that + multiplies the size of the partition by the option's value. You must + supply a value greater than or equal to "1". The default value is + "1.3". + +- ``--part-name``: This option is a Wic-specific option that + specifies a name for GPT partitions. + +- ``--part-type``: This option is a Wic-specific option that + specifies the partition type globally unique identifier (GUID) for + GPT partitions. You can find the list of partition type GUIDs at + http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. + +- ``--use-uuid``: This option is a Wic-specific option that causes + Wic to generate a random GUID for the partition. The generated + identifier is used in the bootloader configuration to specify the + root partition. + +- ``--uuid``: This option is a Wic-specific option that specifies the + partition UUID. + +- ``--fsuuid``: This option is a Wic-specific option that specifies + the filesystem UUID. You can generate or modify + :term:`WKS_FILE` with this option if a preconfigured + filesystem UUID is added to the kernel command line in the bootloader + configuration before you run Wic. + +- ``--system-id``: This option is a Wic-specific option that + specifies the partition system ID, which is a one byte long, + hexadecimal parameter with or without the 0x prefix. + +- ``--mkfs-extraopts``: This option specifies additional options to + pass to the ``mkfs`` utility. Some default options for certain + filesystems do not take effect. See Wic's help on kickstart (i.e. + ``wic help kickstart``). + +Command: bootloader +=================== + +This command specifies how the bootloader should be configured and +supports the following options: + +.. note:: + + Bootloader functionality and boot partitions are implemented by the + various + --source + plugins that implement bootloader functionality. The bootloader + command essentially provides a means of modifying bootloader + configuration. + +- ``--timeout``: Specifies the number of seconds before the + bootloader times out and boots the default option. + +- ``--append``: Specifies kernel parameters. These parameters will be + added to the syslinux ``APPEND`` or ``grub`` kernel command line. + +- ``--configfile``: Specifies a user-defined configuration file for + the bootloader. You can provide a full pathname for the file or a + file that exists in the ``canned-wks`` folder. This option overrides + all other bootloader options. diff --git a/documentation/ref-manual/migration-1.5.rst b/documentation/ref-manual/migration-1.5.rst index b5e4bb1fd1..2716bc9cfd 100644 --- a/documentation/ref-manual/migration-1.5.rst +++ b/documentation/ref-manual/migration-1.5.rst @@ -26,7 +26,7 @@ provide packages for these, you can install and use the Buildtools tarball, which provides an SDK-like environment containing them. For more information on this requirement, see the -":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`" +":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" section. .. _migration-1.5-atom-pc-bsp: diff --git a/documentation/ref-manual/migration-1.6.rst b/documentation/ref-manual/migration-1.6.rst index f95f45ec9f..ed155d0df9 100644 --- a/documentation/ref-manual/migration-1.6.rst +++ b/documentation/ref-manual/migration-1.6.rst @@ -126,7 +126,7 @@ Changes to Variables -------------------- The following variables have changed. For information on the -OpenEmbedded build system variables, see the ":doc:`ref-variables`" Chapter. +OpenEmbedded build system variables, see the ":doc:`/ref-manual/variables`" Chapter. .. _migration-1.6-variable-changes-TMPDIR: diff --git a/documentation/ref-manual/migration-1.7.rst b/documentation/ref-manual/migration-1.7.rst index 177d40900f..19275b3cd6 100644 --- a/documentation/ref-manual/migration-1.7.rst +++ b/documentation/ref-manual/migration-1.7.rst @@ -32,7 +32,7 @@ build host is now 1.7.8 because the ``--list`` 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 ``buildtools-tarball`` that does. See the -":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`" +":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" section for more information. .. _migration-1.7-autotools-class-changes: @@ -157,7 +157,7 @@ The following changes have occurred to the QA check process: added in order to verify that file dependencies are satisfied (e.g. package contains a script requiring ``/bin/bash``) and build-time dependencies are declared, respectively. For more information, please - see the ":doc:`ref-qa-checks`" chapter. + see the ":doc:`/ref-manual/qa-checks`" chapter. - Package QA checks are now performed during a new :ref:`ref-tasks-package_qa` task rather than being diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst index a1d7b9a2da..e8b3ada264 100644 --- a/documentation/ref-manual/migration-2.1.rst +++ b/documentation/ref-manual/migration-2.1.rst @@ -360,7 +360,7 @@ These additional changes exist: - 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. See the - :ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions` + :ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` section for more information on the buildtools tarball. - The buggy and incomplete support for the RPM version 4 package diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst index 6984ff91e8..3e9758119b 100644 --- a/documentation/ref-manual/migration-2.3.rst +++ b/documentation/ref-manual/migration-2.3.rst @@ -404,7 +404,7 @@ The following QA checks have changed: For additional information, see the :ref:`insane ` class and the - ":ref:`ref-manual/ref-qa-checks:errors and warnings`" section. + ":ref:`ref-manual/qa-checks:errors and warnings`" section. .. _migration-2.3-miscellaneous-changes: diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst new file mode 100644 index 0000000000..54977dcb21 --- /dev/null +++ b/documentation/ref-manual/qa-checks.rst @@ -0,0 +1,761 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +***************************** +QA Error and Warning Messages +***************************** + +.. _qa-introduction: + +Introduction +============ + +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. + +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. + +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:: + + - At the end of each message, the name of the associated QA test (as + listed in the ":ref:`insane.bbclass `" + section) appears within square brackets. + + - 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. + + - Because some QA checks are disabled by default, this list does not + include all possible QA check errors and warnings. + +.. _qa-errors-and-warnings: + +Errors and Warnings +=================== + +.. _qa-check-libexec: + +- ``: is using libexec please relocate to [libexec]`` + + The specified package contains files in ``/usr/libexec`` when the + distro configuration uses a different path for ```` By + default, ```` is ``$prefix/libexec``. However, this + default can be changed (e.g. ``${libdir}``). + +   +.. _qa-check-rpaths: + +- ``package contains bad RPATH in file [rpaths]`` + + The specified binary produced by the recipe contains dynamic library + load paths (rpaths) that contain build system paths such as + :term:`TMPDIR`, which are incorrect for the target and + could potentially be a security issue. Check for bad ``-rpath`` + options being passed to the linker in your + :ref:`ref-tasks-compile` 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. + +   +.. _qa-check-useless-rpaths: + +- ``: contains probably-redundant RPATH [useless-rpaths]`` + + 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. ``/lib`` and ``/usr/lib``). 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. + +   +.. _qa-check-file-rdeps: + +- `` requires , but no providers in its RDEPENDS [file-rdeps]`` + + A file-level dependency has been identified from the specified + package on the specified files, but there is no explicit + corresponding entry in :term:`RDEPENDS`. If + particular files are required at runtime then ``RDEPENDS`` should be + declared in the recipe to ensure the packages providing them are + built. + +   +.. _qa-check-build-deps: + +- `` rdepends on , but it isn't a build dependency? [build-deps]`` + + 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 + :term:`RDEPENDS` 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 ``RDEPENDS`` for the dependency. + +   +.. _qa-check-dev-so: + +- ``non -dev/-dbg/nativesdk- package contains symlink .so: path '' [dev-so]`` + + Symlink ``.so`` files are for development only, and should therefore + go into the ``-dev`` package. This situation might occur if you add + ``*.so*`` rather than ``*.so.*`` to a non-dev package. Change + :term:`FILES` (and possibly + :term:`PACKAGES`) such that the specified ``.so`` + file goes into an appropriate ``-dev`` package. + +   +.. _qa-check-staticdev: + +- ``non -staticdev package contains static .a library: path '' [staticdev]`` + + Static ``.a`` library files should go into a ``-staticdev`` package. + Change :term:`FILES` (and possibly + :term:`PACKAGES`) such that the specified ``.a`` file + goes into an appropriate ``-staticdev`` package. + +   +.. _qa-check-libdir: + +- ``: found library in wrong location [libdir]`` + + The specified file may have been installed into an incorrect + (possibly hardcoded) installation path. For example, this test will + catch recipes that install ``/lib/bar.so`` when ``${base_libdir}`` is + "lib32". Another example is when recipes install + ``/usr/lib64/foo.so`` when ``${libdir}`` is "/usr/lib". False + positives occasionally exist. For these cases add "libdir" to + :term:`INSANE_SKIP` for the package. + +   +.. _qa-check-debug-files: + +- ``non debug package contains .debug directory: path [debug-files]`` + + The specified package contains a ``.debug`` directory, which should + not appear in anything but the ``-dbg`` package. This situation might + occur if you add a path which contains a ``.debug`` directory and do + not explicitly add the ``.debug`` directory to the ``-dbg`` package. + If this is the case, add the ``.debug`` directory explicitly to + ``FILES_${PN}-dbg``. See :term:`FILES` for additional + information on ``FILES``. + +   +.. _qa-check-arch: + +- ``Architecture did not match (, expected ) in [arch]`` + + 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 + :term:`INSANE_SKIP` for the package. Another + option is to check the :ref:`ref-tasks-compile` log + and verify that the compiler options being used are correct. + +   + +- ``Bit size did not match (, expected ) in [arch]`` + + 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 + :term:`INSANE_SKIP` for the package. Another + option is to check the :ref:`ref-tasks-compile` log + and verify that the compiler options being used are correct. + +   + +- ``Endianness did not match (, expected ) in [arch]`` + + 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 + :term:`INSANE_SKIP` for the package. Another + option is to check the :ref:`ref-tasks-compile` log + and verify that the compiler options being used are correct. + +   +.. _qa-check-textrel: + +- ``ELF binary '' has relocations in .text [textrel]`` + + The specified ELF binary contains relocations in its ``.text`` + sections. This situation can result in a performance impact at + runtime. + + 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 :term:`CFLAGS` when you build it, + you could add the following to your recipe: + :: + + CFLAGS_append = " -fPIC " + + For more information on text relocations at runtime, see + http://www.akkadia.org/drepper/textrelocs.html. + +   +.. _qa-check-ldflags: + +- ``File '' in package '' doesn't have GNU_HASH (didn't pass LDFLAGS?) [ldflags]`` + + This indicates that binaries produced when building the recipe have + not been linked with the :term:`LDFLAGS` options + provided by the build system. Check to be sure that the ``LDFLAGS`` + variable is being passed to the linker command. A common workaround + for this situation is to pass in ``LDFLAGS`` using + :term:`TARGET_CC_ARCH` within the recipe as + follows: + :: + + TARGET_CC_ARCH += "${LDFLAGS}" + +   +.. _qa-check-xorg-driver-abi: + +- ``Package contains Xorg driver () but no xorg-abi- dependencies [xorg-driver-abi]`` + + 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 ``xorg-driver-input.inc`` or ``xorg-driver-video.inc`` will + automatically get these versions. Consequently, you should only need + to explicitly add dependencies to binary driver recipes. + +   +.. _qa-check-infodir: + +- ``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]`` + + The ``/usr/share/info/dir`` should not be packaged. Add the following + line to your :ref:`ref-tasks-install` task or to your + ``do_install_append`` within the recipe as follows: + :: + + rm ${D}${infodir}/dir +   + +.. _qa-check-symlink-to-sysroot: + +- ``Symlink in points to TMPDIR [symlink-to-sysroot]`` + + The specified symlink points into :term:`TMPDIR` 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. + +   +.. _qa-check-la: + +- `` failed sanity test (workdir) in path [la]`` + + The specified ``.la`` file contains :term:`TMPDIR` + paths. Any ``.la`` file containing these paths is incorrect since + ``libtool`` adds the correct sysroot prefix when using the files + automatically itself. + +   +.. _qa-check-pkgconfig: + +- `` failed sanity test (tmpdir) in path [pkgconfig]`` + + The specified ``.pc`` file contains + :term:`TMPDIR`\ ``/``\ :term:`WORKDIR` + paths. Any ``.pc`` file containing these paths is incorrect since + ``pkg-config`` itself adds the correct sysroot prefix when the files + are accessed. + +   +.. _qa-check-debug-deps: + +- `` rdepends on [debug-deps]`` + + A dependency exists between the specified non-dbg package (i.e. a + package whose name does not end in ``-dbg``) and a package that is a + ``dbg`` package. The ``dbg`` packages contain debug symbols and are + brought in using several different methods: + + - Using the ``dbg-pkgs`` + :term:`IMAGE_FEATURES` value. + + - Using :term:`IMAGE_INSTALL`. + + - As a dependency of another ``dbg`` package that was brought in + using one of the above methods. + + The dependency might have been automatically added because the + ``dbg`` package erroneously contains files that it should not contain + (e.g. a non-symlink ``.so`` file) or it might have been added + manually (e.g. by adding to :term:`RDEPENDS`). + +   +.. _qa-check-dev-deps: + +- `` rdepends on [dev-deps]`` + + A dependency exists between the specified non-dev package (a package + whose name does not end in ``-dev``) and a package that is a ``dev`` + package. The ``dev`` packages contain development headers and are + usually brought in using several different methods: + + - Using the ``dev-pkgs`` + :term:`IMAGE_FEATURES` value. + + - Using :term:`IMAGE_INSTALL`. + + - As a dependency of another ``dev`` package that was brought in + using one of the above methods. + + The dependency might have been automatically added (because the + ``dev`` package erroneously contains files that it should not have + (e.g. a non-symlink ``.so`` file) or it might have been added + manually (e.g. by adding to :term:`RDEPENDS`). + +   +.. _qa-check-dep-cmp: + +- ``_ is invalid: () only comparisons <, =, >, <=, and >= are allowed [dep-cmp]`` + + If you are adding a versioned dependency relationship to one of the + dependency variables (:term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, + :term:`RPROVIDES`, + :term:`RREPLACES`, or + :term:`RCONFLICTS`), you must only use the named + comparison operators. Change the versioned dependency values you are + adding to match those listed in the message. + +   +.. _qa-check-compile-host-path: + +- ``: The compile log indicates that host include and/or library paths were used. Please check the log '' for more information. [compile-host-path]`` + + The log for the :ref:`ref-tasks-compile` 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. + +   +.. _qa-check-install-host-path: + +- ``: The install log indicates that host include and/or library paths were used. Please check the log '' for more information. [install-host-path]`` + + The log for the :ref:`ref-tasks-install` 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. + +   +.. _qa-check-configure-unsafe: + +- ``This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. [configure-unsafe]`` + + The log for the :ref:`ref-tasks-configure` 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. + +   +.. _qa-check-pkgname: + +- `` doesn't match the [a-z0-9.+-]+ regex [pkgname]`` + + 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 + :term:`PACKAGES` 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 ``PACKAGES``, + change the package name appropriately. + +   +.. _qa-check-unknown-configure-option: + +- ``: configure was passed unrecognized options: [unknown-configure-option]`` + + 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 ``./configure --help`` output, and + the upstream change log or release notes. Once you have worked out + what the appropriate change is, you can update + :term:`EXTRA_OECONF`, + :term:`PACKAGECONFIG_CONFARGS`, or the + individual :term:`PACKAGECONFIG` option values + accordingly. + +   +.. _qa-check-pn-overrides: + +- ``Recipe has PN of "" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]`` + + The specified recipe has a name (:term:`PN`) value that + appears in :term:`OVERRIDES`. If a recipe is named + such that its ``PN`` value matches something already in ``OVERRIDES`` + (e.g. ``PN`` happens to be the same as :term:`MACHINE` + or :term:`DISTRO`), it can have unexpected + consequences. For example, assignments such as + ``FILES_${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``. + Rename your recipe (or if ``PN`` is being set explicitly, change the + ``PN`` value) so that the conflict does not occur. See + :term:`FILES` for additional information. + +   +.. _qa-check-pkgvarcheck: + +- ``: Variable is set as not being package specific, please fix this. [pkgvarcheck]`` + + Certain variables (:term:`RDEPENDS`, + :term:`RRECOMMENDS`, + :term:`RSUGGESTS`, + :term:`RCONFLICTS`, + :term:`RPROVIDES`, + :term:`RREPLACES`, :term:`FILES`, + ``pkg_preinst``, ``pkg_postinst``, ``pkg_prerm``, ``pkg_postrm``, and + :term:`ALLOW_EMPTY`) should always be set specific + to a package (i.e. they should be set with a package name override + such as ``RDEPENDS_${PN} = "value"`` rather than + ``RDEPENDS = "value"``). If you receive this error, correct any + assignments to these variables within your recipe. + + +- ``recipe uses DEPENDS_${PN}, should use DEPENDS [pkgvarcheck]`` + + This check looks for instances of setting ``DEPENDS_${PN}`` + which is erroneous (:term:`DEPENDS` is a recipe-wide variable and thus + it is not correct to specify it for a particular package, nor will such + an assignment actually work.) Set ``DEPENDS`` instead. + + +.. _qa-check-already-stripped: + +- ``File '' from was already stripped, this will prevent future debugging! [already-stripped]`` + + 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 ``-dbg`` packages, + this stripping must be disabled. + + 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 ``-dbg`` package, it will then + strip the symbols from the binaries. + +   +.. _qa-check-packages-list: + +- `` is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]`` + + Package names must appear only once in the + :term:`PACKAGES` variable. You might receive this + error if you are attempting to add a package to ``PACKAGES`` that is + already in the variable's value. + +   +.. _qa-check-files-invalid: + +- ``FILES variable for package contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]`` + + The string "//" is invalid in a Unix path. Correct all occurrences + where this string appears in a :term:`FILES` variable so + that there is only a single "/". + +   +.. _qa-check-installed-vs-shipped: + +- ``: Files/directories were installed but not shipped in any package [installed-vs-shipped]`` + + Files have been installed within the + :ref:`ref-tasks-install` task but have not been + included in any package by way of the :term:`FILES` + 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: + + - Add the files to ``FILES`` for the package you want them to appear + in (e.g. ``FILES_${``\ :term:`PN`\ ``}`` for the main + package). + + - Delete the files at the end of the ``do_install`` task if the + files are not needed in any package. + +   + +- ``- was registered as shlib provider for , changing it to - because it was built later`` + + This message means that both ```` and ```` + 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 ``.so`` file name to + :term:`PRIVATE_LIBS` in the recipe that provides + the private version of the library. + + +.. _qa-check-unlisted-pkg-lics: + +- ``LICENSE_ includes licenses () that are not listed in LICENSE [unlisted-pkg-lics]`` + + The :term:`LICENSE` of the recipe should be a superset + of all the licenses of all packages produced by this recipe. In other + words, any license in ``LICENSE_*`` should also appear in + :term:`LICENSE`. + + +.. _qa-check-configure-gettext: + +- ``AM_GNU_GETTEXT used but no inherit gettext [configure-gettext]`` + + If a recipe is building something that uses automake and the automake + files contain an ``AM_GNU_GETTEXT`` directive then this check will fail + if there is no ``inherit gettext`` statement in the recipe to ensure + that gettext is available during the build. Add ``inherit gettext`` to + remove the warning. + + +.. _qa-check-mime: + +- ``package contains mime types but does not inherit mime: path '' [mime]`` + + The specified package contains mime type files (``.xml`` files in + ``${datadir}/mime/packages``) and yet does not inherit the mime + class which will ensure that these get properly installed. Either + add ``inherit mime`` to the recipe or remove the files at the + ``do_install`` step if they are not needed. + + +.. _qa-check-mime-xdg: + +- ``package contains desktop file with key 'MimeType' but does not inhert mime-xdg: path '' [mime-xdg]`` + + The specified package contains a .desktop file with a 'MimeType' key + present, but does not inherit the mime-xdg class that is required in + order for that to be activated. Either add ``inherit mime`` to the + recipe or remove the files at the ``do_install`` step if they are not + needed. + + +.. _qa-check-src-uri-bad: + +- ``: SRC_URI uses unstable GitHub archives [src-uri-bad]`` + + GitHub provides "archive" tarballs, however these can be re-generated + on the fly and thus the file's signature will not necessarily match that + in the SRC_URI checksums in future leading to build failures. It is + recommended that you use an official release tarball or switch to + pulling the corresponding revision in the actual git repository instead. + + +- ``SRC_URI uses PN not BPN [src-uri-bad]`` + + If some part of :term:`SRC_URI` needs to reference the recipe name, it should do + so using ${:term:`BPN`} rather than ${:term:`PN`} as the latter will change + for different variants of the same recipe e.g. when :term:`BBCLASSEXTEND` + or multilib are being used. This check will fail if a reference to ``${PN}`` + is found within the ``SRC_URI`` value - change it to ``${BPN}`` instead. + + +.. _qa-check-unhandled-features-check: + +- ``: recipe doesn't inherit features_check [unhandled-features-check]`` + + This check ensures that if one of the variables that the :ref:`features_check ` + class supports (e.g. :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe + inherits ``features_check`` in order for the requirement to actually work. If + you are seeing this message, either add ``inherit features_check`` to your recipe + or remove the reference to the variable if it is not needed. + + +.. _qa-check-missing-update-alternatives: + +- ``: recipe defines ALTERNATIVE_ but doesn't inherit update-alternatives. This might fail during do_rootfs later! [missing-update-alternatives]`` + + This check ensures that if a recipe sets the :term:`ALTERNATIVE` variable that the + recipe also inherits :ref:`update-alternatives ` such + that the alternative will be correctly set up. If you are seeing this message, either + add ``inherit update-alternatives`` to your recipe or remove the reference to the variable + if it is not needed. + + +.. _qa-check-shebang-size: + +- ``: maximum shebang size exceeded, the maximum size is 128. [shebang-size]`` + + This check ensures that the shebang line (``#!`` in the first line) for a script + is not longer than 128 characters, which can cause an error at runtime depending + on the operating system. If you are seeing this message then the specified script + may need to be patched to have a shorter in order to avoid runtime problems. + + +.. _qa-check-perllocalpod: + +- `` contains perllocal.pod (), should not be installed [perllocalpod]`` + + ``perllocal.pod`` is an index file of locally installed modules and so shouldn't be + installed by any distribution packages. The :ref:`cpan ` class + already sets ``NO_PERLLOCAL`` to stop this file being generated by most Perl recipes, + but if a recipe is using ``MakeMaker`` directly then they might not be doing this + correctly. This check ensures that perllocal.pod is not in any package in order to + avoid multiple packages shipping this file and thus their packages conflicting + if installed together. + + +.. _qa-check-usrmerge: + +- `` package is not obeying usrmerge distro feature. / should be relocated to /usr. [usrmerge]`` + + If ``usrmerge`` is in :term:`DISTRO_FEATURES`, this check will ensure that no package + installs files to root (``/bin``, ``/sbin``, ``/lib``, ``/lib64``) directories. If you are seeing this + message, it indicates that the ``do_install`` step (or perhaps the build process that + ``do_install`` is calling into, e.g. ``make install`` is using hardcoded paths instead + of the variables set up for this (``bindir``, ``sbindir``, etc.), and should be + changed so that it does. + + +.. _qa-check-patch-fuzz: + +- ``Fuzz detected: [patch-fuzz]`` + + This check looks for evidence of "fuzz" when applying patches within the ``do_patch`` + task. Patch fuzz is a situation when the ``patch`` tool ignores some of the context + lines in order to apply the patch. Consider this example: + + Patch to be applied: :: + + --- filename + +++ filename + context line 1 + context line 2 + context line 3 + +newly added line + context line 4 + context line 5 + context line 6 + + Original source code: :: + + different context line 1 + different context line 2 + context line 3 + context line 4 + different context line 5 + different context line 6 + + Outcome (after applying patch with fuzz): :: + + different context line 1 + different context line 2 + context line 3 + newly added line + context line 4 + different context line 5 + different context line 6 + + Chances are, the newly added line was actually added in a completely + wrong location, or it was already in the original source and was added + for the second time. This is especially possible if the context line 3 + and 4 are blank or have only generic things in them, such as ``#endif`` or ``}``. + Depending on the patched code, it is entirely possible for an incorrectly + patched file to still compile without errors. + + *How to eliminate patch fuzz warnings* + + Use the ``devtool`` command as explained by the warning. First, unpack the + source into devtool workspace: :: + + devtool modify + + This will apply all of the patches, and create new commits out of them in + the workspace - with the patch context updated. + + Then, replace the patches in the recipe layer: :: + + devtool finish --force-patch-refresh + + The patch updates then need be reviewed (preferably with a side-by-side diff + tool) to ensure they are indeed doing the right thing i.e.: + + #. they are applied in the correct location within the file; + #. they do not introduce duplicate lines, or otherwise do things that + are no longer necessary. + + To confirm these things, you can also review the patched source code in + devtool's workspace, typically in ``/workspace/sources//`` + + Once the review is done, you can create and publish a layer commit with + the patch updates that modify the context. Devtool may also refresh + other things in the patches, those can be discarded. + + + +Configuring and Disabling QA Checks +=================================== + +You can configure the QA checks globally so that specific check failures +either raise a warning or an error message, using the +:term:`WARN_QA` and :term:`ERROR_QA` +variables, respectively. You can also disable checks within a particular +recipe using :term:`INSANE_SKIP`. For information on +how to work with the QA checks, see the +":ref:`insane.bbclass `" section. + +.. note:: + + 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. diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst deleted file mode 100644 index 37ab4992eb..0000000000 --- a/documentation/ref-manual/ref-classes.rst +++ /dev/null @@ -1,2898 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -******* -Classes -******* - -Class files are used to abstract common functionality and share it -amongst multiple recipe (``.bb``) 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. - -Any :term:`Metadata` usually found in a recipe can also be -placed in a class file. Class files are identified by the extension -``.bbclass`` and are usually placed in a ``classes/`` directory beneath -the ``meta*/`` directory found in the :term:`Source Directory`. -Class files can also be pointed to by -:term:`BUILDDIR` (e.g. ``build/``) in the same way as -``.conf`` files in the ``conf`` directory. Class files are searched for -in :term:`BBPATH` using the same method by which ``.conf`` -files are searched. - -This chapter discusses only the most useful and important classes. Other -classes do exist within the ``meta/classes`` directory in the Source -Directory. You can reference the ``.bbclass`` files directly for more -information. - -.. _ref-classes-allarch: - -``allarch.bbclass`` -=================== - -The ``allarch`` 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:: - - Unlike some distro recipes (e.g. Debian), OpenEmbedded recipes that - produce packages that depend on tunings through use of the - :term:`RDEPENDS` and - :term:`TUNE_PKGARCH` variables, should never be - configured for all architectures using ``allarch``. This is the case - even if the recipes do not produce architecture-specific output. - - Configuring such recipes for all architectures causes the - ``do_package_write_*`` tasks to - have different signatures for the machines with different tunings. - Additionally, unnecessary rebuilds occur every time an image for a - different ``MACHINE`` is built even when the recipe never changes. - -By default, all recipes inherit the :ref:`base ` and -:ref:`package ` 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 ``allarch`` class. - -.. _ref-classes-archiver: - -``archiver.bbclass`` -==================== - -The ``archiver`` class supports releasing source code and other -materials with the binaries. - -For more details on the source archiver, see the -":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" -section in the Yocto Project Development Tasks Manual. You can also see -the :term:`ARCHIVER_MODE` variable for information -about the variable flags (varflags) that help control archive creation. - -.. _ref-classes-autotools: - -``autotools*.bbclass`` -====================== - -The ``autotools*`` classes support Autotooled packages. - -The ``autoconf``, ``automake``, and ``libtool`` packages bring -standardization. This class defines a set of tasks (e.g. ``configure``, -``compile`` and so forth) that work for all Autotooled packages. It -should usually be enough to define a few standard variables and then -simply ``inherit autotools``. These classes can also work with software -that emulates Autotools. For more information, see the -":ref:`dev-manual/common-tasks:autotooled package`" section -in the Yocto Project Development Tasks Manual. - -By default, the ``autotools*`` classes use out-of-tree builds (i.e. -``autotools.bbclass`` building with ``B != S``). - -If the software being built by a recipe does not support using -out-of-tree builds, you should have the recipe inherit the -``autotools-brokensep`` class. The ``autotools-brokensep`` class behaves -the same as the ``autotools`` class but builds with :term:`B` -== :term:`S`. 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. - -It's useful to have some idea of how the tasks defined by the -``autotools*`` classes work and what they do behind the scenes. - -- :ref:`ref-tasks-configure` - Regenerates the - configure script (using ``autoreconf``) and then launches it with a - standard set of arguments used during cross-compilation. You can pass - additional parameters to ``configure`` through the ``EXTRA_OECONF`` - or :term:`PACKAGECONFIG_CONFARGS` - variables. - -- :ref:`ref-tasks-compile` - Runs ``make`` with - arguments that specify the compiler and linker. You can pass - additional arguments through the ``EXTRA_OEMAKE`` variable. - -- :ref:`ref-tasks-install` - Runs ``make install`` and - passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``. - -.. _ref-classes-base: - -``base.bbclass`` -================ - -The ``base`` class is special in that every ``.bb`` file implicitly -inherits the class. This class contains definitions for standard basic -tasks such as fetching, unpacking, configuring (empty by default), -compiling (runs any ``Makefile`` present), installing (empty by default) -and packaging (empty by default). These classes are often overridden or -extended by other classes such as the -:ref:`autotools ` class or the -:ref:`package ` class. - -The class also contains some commonly used functions such as -``oe_runmake``, which runs ``make`` with the arguments specified in -:term:`EXTRA_OEMAKE` variable as well as the -arguments passed directly to ``oe_runmake``. - -.. _ref-classes-bash-completion: - -``bash-completion.bbclass`` -=========================== - -Sets up packaging and dependencies appropriate for recipes that build -software that includes bash-completion data. - -.. _ref-classes-bin-package: - -``bin_package.bbclass`` -======================= - -The ``bin_package`` 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 (``git://``), - the "subpath" parameter limits the checkout to a specific subpath - of the tree. Here is an example where ``${BP}`` is used so that the files - are extracted into the subdirectory expected by the default value of - ``S``: - :: - - SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}" - - - See the ":ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers`" section in the BitBake User Manual for - more information on supported BitBake Fetchers. - -.. _ref-classes-binconfig: - -``binconfig.bbclass`` -===================== - -The ``binconfig`` class helps to correct paths in shell scripts. - -Before ``pkg-config`` had become widespread, libraries shipped shell -scripts to give information about the libraries and include paths needed -to build software (usually named ``LIBNAME-config``). This class assists -any recipe using such scripts. - -During staging, the OpenEmbedded build system installs such scripts into -the ``sysroots/`` directory. Inheriting this class results in all paths -in these scripts being changed to point into the ``sysroots/`` directory -so that all builds that use the script use the correct directories for -the cross compiling layout. See the -:term:`BINCONFIG_GLOB` variable for more -information. - -.. _ref-classes-binconfig-disabled: - -``binconfig-disabled.bbclass`` -============================== - -An alternative version of the :ref:`binconfig ` -class, which disables binary configuration scripts by making them return -an error in favor of using ``pkg-config`` to query the information. The -scripts to be disabled should be specified using the -:term:`BINCONFIG` variable within the recipe inheriting -the class. - -.. _ref-classes-blacklist: - -``blacklist.bbclass`` -===================== - -The ``blacklist`` class prevents the OpenEmbedded build system from -building specific recipes (blacklists them). To use this class, inherit -the class globally and set :term:`PNBLACKLIST` for -each recipe you wish to blacklist. Specify the :term:`PN` -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 ``local.conf`` or distribution configuration: -:: - - INHERIT += "blacklist" - PNBLACKLIST[exoticware] = "Not supported by our organization." - -.. _ref-classes-buildhistory: - -``buildhistory.bbclass`` -======================== - -The ``buildhistory`` 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 -":ref:`dev-manual/common-tasks:maintaining build output quality`" -section in the Yocto Project Development Tasks Manual. - -.. _ref-classes-buildstats: - -``buildstats.bbclass`` -====================== - -The ``buildstats`` class records performance statistics about each task -executed during the build (e.g. elapsed time, CPU usage, and I/O usage). - -When you use this class, the output goes into the -:term:`BUILDSTATS_BASE` directory, which defaults -to ``${TMPDIR}/buildstats/``. You can analyze the elapsed time using -``scripts/pybootchartgui/pybootchartgui.py``, which produces a cascading -chart of the entire build process and can be useful for highlighting -bottlenecks. - -Collecting build statistics is enabled by default through the -:term:`USER_CLASSES` variable from your -``local.conf`` 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 ``USER_CLASSES`` list. - -.. _ref-classes-buildstats-summary: - -``buildstats-summary.bbclass`` -============================== - -When inherited globally, prints statistics at the end of the build on -sstate re-use. In order to function, this class requires the -:ref:`buildstats ` class be enabled. - -.. _ref-classes-ccache: - -``ccache.bbclass`` -================== - -The ``ccache`` class enables the C/C++ Compiler Cache 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 -http://ccache.samba.org/ for information on the C/C++ Compiler -Cache. - -.. _ref-classes-chrpath: - -``chrpath.bbclass`` -=================== - -The ``chrpath`` class is a wrapper around the "chrpath" utility, which -is used during the build process for ``nativesdk``, ``cross``, and -``cross-canadian`` recipes to change ``RPATH`` records within binaries -in order to make them relocatable. - -.. _ref-classes-clutter: - -``clutter.bbclass`` -=================== - -The ``clutter`` 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. - -.. _ref-classes-cmake: - -``cmake.bbclass`` -================= - -The ``cmake`` class allows for recipes that need to build software using -the `CMake `__ build system. You can use -the :term:`EXTRA_OECMAKE` variable to specify -additional configuration options to be passed using the ``cmake`` -command line. - -On the occasion that you would be installing custom CMake toolchain -files supplied by the application being built, you should install them -to the preferred CMake Module directory: ``${D}${datadir}/cmake/`` -Modules during -:ref:`ref-tasks-install`. - -.. _ref-classes-cml1: - -``cml1.bbclass`` -================ - -The ``cml1`` class provides basic support for the Linux kernel style -build configuration system. - -.. _ref-classes-compress_doc: - -``compress_doc.bbclass`` -======================== - -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 -:term:`DOC_COMPRESS` variable. - -.. _ref-classes-copyleft_compliance: - -``copyleft_compliance.bbclass`` -=============================== - -The ``copyleft_compliance`` class preserves source code for the purposes -of license compliance. This class is an alternative to the ``archiver`` -class and is still used by some users even though it has been deprecated -in favor of the :ref:`archiver ` class. - -.. _ref-classes-copyleft_filter: - -``copyleft_filter.bbclass`` -=========================== - -A class used by the :ref:`archiver ` and -:ref:`copyleft_compliance ` classes -for filtering licenses. The ``copyleft_filter`` class is an internal -class and is not intended to be used directly. - -.. _ref-classes-core-image: - -``core-image.bbclass`` -====================== - -The ``core-image`` class provides common definitions for the -``core-image-*`` image recipes, such as support for additional -:term:`IMAGE_FEATURES`. - -.. _ref-classes-cpan: - -``cpan*.bbclass`` -================= - -The ``cpan*`` classes support Perl modules. - -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. - -- Modules that use old ``Makefile.PL``-based build system require - ``cpan.bbclass`` in their recipes. - -- Modules that use ``Build.PL``-based build system require using - ``cpan_build.bbclass`` in their recipes. - -Both build methods inherit the ``cpan-base`` class for basic Perl -support. - -.. _ref-classes-cross: - -``cross.bbclass`` -================= - -The ``cross`` class provides support for the recipes that build the -cross-compilation tools. - -.. _ref-classes-cross-canadian: - -``cross-canadian.bbclass`` -========================== - -The ``cross-canadian`` class provides support for the recipes that build -the Canadian Cross-compilation tools for SDKs. See the -":ref:`overview-manual/concepts:cross-development toolchain generation`" -section in the Yocto Project Overview and Concepts Manual for more -discussion on these cross-compilation tools. - -.. _ref-classes-crosssdk: - -``crosssdk.bbclass`` -==================== - -The ``crosssdk`` class provides support for the recipes that build the -cross-compilation tools used for building SDKs. See the -":ref:`overview-manual/concepts:cross-development toolchain generation`" -section in the Yocto Project Overview and Concepts Manual for more -discussion on these cross-compilation tools. - -.. _ref-classes-debian: - -``debian.bbclass`` -================== - -The ``debian`` class renames output packages so that they follow the -Debian naming policy (i.e. ``glibc`` becomes ``libc6`` and -``glibc-devel`` becomes ``libc6-dev``.) Renaming includes the library -name and version as part of the package name. - -If a recipe creates packages for multiple libraries (shared object files -of ``.so`` type), use the :term:`LEAD_SONAME` -variable in the recipe to specify the library on which to apply the -naming scheme. - -.. _ref-classes-deploy: - -``deploy.bbclass`` -================== - -The ``deploy`` class handles deploying files to the -:term:`DEPLOY_DIR_IMAGE` 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 -:ref:`ref-tasks-deploy` function to copy the files to be -deployed to :term:`DEPLOYDIR`, and use ``addtask`` to -add the task at the appropriate place, which is usually after -:ref:`ref-tasks-compile` or -:ref:`ref-tasks-install`. The class then takes care of -staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``. - -.. _ref-classes-devshell: - -``devshell.bbclass`` -==================== - -The ``devshell`` class adds the ``do_devshell`` task. Distribution -policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`" -section in the Yocto Project Development Tasks Manual for more -information about using ``devshell``. - -.. _ref-classes-devupstream: - -``devupstream.bbclass`` -======================= - -The ``devupstream`` class uses -:term:`BBCLASSEXTEND` to add a variant of the -recipe that fetches from an alternative URI (e.g. Git) instead of a -tarball. Following is an example: -:: - - BBCLASSEXTEND = "devupstream:target" - SRC_URI_class-devupstream = "git://git.example.com/example" - SRCREV_class-devupstream = "abcd1234" - -Adding the above statements to your recipe creates a variant that has -:term:`DEFAULT_PREFERENCE` set to "-1". -Consequently, you need to select the variant of the recipe to use it. -Any development-specific adjustments can be done by using the -``class-devupstream`` override. Here is an example: -:: - - DEPENDS_append_class-devupstream = " gperf-native" - do_configure_prepend_class-devupstream() { - touch ${S}/README - } - -The class -currently only supports creating a development variant of the target -recipe, not ``native`` or ``nativesdk`` variants. - -The ``BBCLASSEXTEND`` syntax (i.e. ``devupstream:target``) provides -support for ``native`` and ``nativesdk`` variants. Consequently, this -functionality can be added in a future release. - -Support for other version control systems such as Subversion is limited -due to BitBake's automatic fetch dependencies (e.g. -``subversion-native``). - -.. _ref-classes-distutils: - -``distutils*.bbclass`` -====================== - -The ``distutils*`` 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. - -- Extensions that use an Autotools-based build system require Autotools - and the classes based on ``distutils`` in their recipes. - -- Extensions that use build systems based on ``distutils`` require the - ``distutils`` class in their recipes. - -- Extensions that use build systems based on ``setuptools`` require the - :ref:`setuptools ` class in their recipes. - -The ``distutils-common-base`` class is required by some of the -``distutils*`` classes to provide common Python2 support. - -.. _ref-classes-distutils3: - -``distutils3*.bbclass`` -======================= - -The ``distutils3*`` 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. - -- Extensions that use an Autotools-based build system require Autotools - and ``distutils``-based classes in their recipes. - -- Extensions that use ``distutils``-based build systems require the - ``distutils`` class in their recipes. - -- Extensions that use build systems based on ``setuptools3`` require - the :ref:`setuptools3 ` class in their - recipes. - -The ``distutils3*`` classes either inherit their corresponding -``distutils*`` class or replicate them using a Python3 version instead -(e.g. ``distutils3-base`` inherits ``distutils-common-base``, which is -the same as ``distutils-base`` but inherits ``python3native`` instead of -``pythonnative``). - -.. _ref-classes-externalsrc: - -``externalsrc.bbclass`` -======================= - -The ``externalsrc`` 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. - -By default, the OpenEmbedded build system uses the :term:`S` -and :term:`B` variables to locate unpacked recipe source code -and to build it, respectively. When your recipe inherits the -``externalsrc`` class, you use the -:term:`EXTERNALSRC` and -:term:`EXTERNALSRC_BUILD` variables to -ultimately define ``S`` and ``B``. - -By default, this class expects the source code to support recipe builds -that use the :term:`B` variable to point to the directory in -which the OpenEmbedded build system places the generated objects built -from the recipes. By default, the ``B`` directory is set to the -following, which is separate from the source directory (``S``): -:: - - ${WORKDIR}/${BPN}/{PV}/ - -See these variables for more information: -:term:`WORKDIR`, :term:`BPN`, and -:term:`PV`, - -For more information on the ``externalsrc`` class, see the comments in -``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. -For information on how to use the -``externalsrc`` class, see the -":ref:`dev-manual/common-tasks:building software from an external source`" -section in the Yocto Project Development Tasks Manual. - -.. _ref-classes-extrausers: - -``extrausers.bbclass`` -====================== - -The ``extrausers`` 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 -:term:`EXTRA_USERS_PARAMS` variable. - -.. note:: - - The user and group operations added using the - extrausers - 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 - useradd - class to add user and group configuration to a specific recipe. - -Here is an example that uses this class in an image recipe: -:: - - inherit extrausers - EXTRA_USERS_PARAMS = "\ - useradd -p '' tester; \ - groupadd developers; \ - userdel nobody; \ - groupdel -g video; \ - groupmod -g 1020 developers; \ - usermod -s /bin/sh tester; \ - " - -Here is an example that adds two users named "tester-jim" and "tester-sue" and assigns -passwords: -:: - - inherit extrausers - EXTRA_USERS_PARAMS = "\ - useradd -P tester01 tester-jim; \ - useradd -P tester01 tester-sue; \ - " - -Finally, here is an example that sets the root password to "1876*18": -:: - - inherit extrausers - EXTRA_USERS_PARAMS = "\ - usermod -P 1876*18 root; \ - " - -.. _ref-classes-features_check: - -``features_check.bbclass`` -================================= - -The ``features_check`` class allows individual recipes to check -for required and conflicting -:term:`DISTRO_FEATURES`, :term:`MACHINE_FEATURES` or :term:`COMBINED_FEATURES`. - -This class provides support for the following variables: - -- :term:`REQUIRED_DISTRO_FEATURES` -- :term:`CONFLICT_DISTRO_FEATURES` -- :term:`ANY_OF_DISTRO_FEATURES` -- ``REQUIRED_MACHINE_FEATURES`` -- ``CONFLICT_MACHINE_FEATURES`` -- ``ANY_OF_MACHINE_FEATURES`` -- ``REQUIRED_COMBINED_FEATURES`` -- ``CONFLICT_COMBINED_FEATURES`` -- ``ANY_OF_COMBINED_FEATURES`` - -If any conditions specified in the recipe using the above -variables are not met, the recipe will be skipped, and if the -build system attempts to build the recipe then an error will be -triggered. - -.. _ref-classes-fontcache: - -``fontcache.bbclass`` -===================== - -The ``fontcache`` class generates the proper post-install and -post-remove (postinst and postrm) scriptlets for font packages. These -scriptlets call ``fc-cache`` (part of ``Fontconfig``) to add the fonts -to the font information cache. Since the cache files are -architecture-specific, ``fc-cache`` runs using QEMU if the postinst -scriptlets need to be run on the build host during image creation. - -If the fonts being installed are in packages other than the main -package, set :term:`FONT_PACKAGES` to specify the -packages containing the fonts. - -.. _ref-classes-fs-uuid: - -``fs-uuid.bbclass`` -=================== - -The ``fs-uuid`` class extracts UUID from -``${``\ :term:`ROOTFS`\ ``}``, which must have been built -by the time that this function gets called. The ``fs-uuid`` class only -works on ``ext`` file systems and depends on ``tune2fs``. - -.. _ref-classes-gconf: - -``gconf.bbclass`` -================= - -The ``gconf`` class provides common functionality for recipes that need -to install GConf schemas. The schemas will be put into a separate -package (``${``\ :term:`PN`\ ``}-gconf``) 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. - -.. _ref-classes-gettext: - -``gettext.bbclass`` -=================== - -The ``gettext`` class provides support for building software that uses -the GNU ``gettext`` internationalization and localization system. All -recipes building software that use ``gettext`` should inherit this -class. - -.. _ref-classes-gnomebase: - -``gnomebase.bbclass`` -===================== - -The ``gnomebase`` class is the base class for recipes that build -software from the GNOME stack. This class sets -:term:`SRC_URI` to download the source from the GNOME -mirrors as well as extending :term:`FILES` with the typical -GNOME installation paths. - -.. _ref-classes-gobject-introspection: - -``gobject-introspection.bbclass`` -================================= - -Provides support for recipes building software that supports GObject -introspection. This functionality is only enabled if the -"gobject-introspection-data" feature is in -:term:`DISTRO_FEATURES` as well as -"qemu-usermode" being in -:term:`MACHINE_FEATURES`. - -.. note:: - - This functionality is backfilled by default and, if not applicable, - should be disabled through ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` or - ``MACHINE_FEATURES_BACKFILL_CONSIDERED``, respectively. - -.. _ref-classes-grub-efi: - -``grub-efi.bbclass`` -==================== - -The ``grub-efi`` class provides ``grub-efi``-specific functions for -building bootable images. - -This class supports several variables: - -- :term:`INITRD`: Indicates list of filesystem images to - concatenate and use as an initial RAM disk (initrd) (optional). - -- :term:`ROOTFS`: Indicates a filesystem image to include - as the root filesystem (optional). - -- :term:`GRUB_GFXSERIAL`: Set this to "1" to have - graphics and serial in the boot menu. - -- :term:`LABELS`: A list of targets for the automatic - configuration. - -- :term:`APPEND`: An override list of append strings for - each ``LABEL``. - -- :term:`GRUB_OPTS`: Additional options to add to the - configuration (optional). Options are delimited using semi-colon - characters (``;``). - -- :term:`GRUB_TIMEOUT`: Timeout before executing - the default ``LABEL`` (optional). - -.. _ref-classes-gsettings: - -``gsettings.bbclass`` -===================== - -The ``gsettings`` 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. - -.. _ref-classes-gtk-doc: - -``gtk-doc.bbclass`` -=================== - -The ``gtk-doc`` class is a helper class to pull in the appropriate -``gtk-doc`` dependencies and disable ``gtk-doc``. - -.. _ref-classes-gtk-icon-cache: - -``gtk-icon-cache.bbclass`` -========================== - -The ``gtk-icon-cache`` class generates the proper post-install and -post-remove (postinst/postrm) scriptlets for packages that use GTK+ and -install icons. These scriptlets call ``gtk-update-icon-cache`` to add -the fonts to GTK+'s icon cache. Since the cache files are -architecture-specific, ``gtk-update-icon-cache`` is run using QEMU if -the postinst scriptlets need to be run on the build host during image -creation. - -.. _ref-classes-gtk-immodules-cache: - -``gtk-immodules-cache.bbclass`` -=============================== - -The ``gtk-immodules-cache`` 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 -``gtk-update-icon-cache`` to add the input method modules to the cache. -Since the cache files are architecture-specific, -``gtk-update-icon-cache`` is run using QEMU if the postinst scriptlets -need to be run on the build host during image creation. - -If the input method modules being installed are in packages other than -the main package, set -:term:`GTKIMMODULES_PACKAGES` to specify -the packages containing the modules. - -.. _ref-classes-gzipnative: - -``gzipnative.bbclass`` -====================== - -The ``gzipnative`` class enables the use of different native versions of -``gzip`` and ``pigz`` rather than the versions of these tools from the -build host. - -.. _ref-classes-icecc: - -``icecc.bbclass`` -================= - -The ``icecc`` class supports -`Icecream `__, which facilitates -taking compile jobs and distributing them among remote machines. - -The class stages directories with symlinks from ``gcc`` and ``g++`` to -``icecc``, for both native and cross compilers. Depending on each -configure or compile, the OpenEmbedded build system adds the directories -at the head of the ``PATH`` list and then sets the ``ICECC_CXX`` and -``ICEC_CC`` variables, which are the paths to the ``g++`` and ``gcc`` -compilers, respectively. - -For the cross compiler, the class creates a ``tar.gz`` file that -contains the Yocto Project toolchain and sets ``ICECC_VERSION``, which -is the version of the cross-compiler used in the cross-development -toolchain, accordingly. - -The class handles all three different compile stages (i.e native -,cross-kernel and target) and creates the necessary environment -``tar.gz`` file to be used by the remote machines. The class also -supports SDK generation. - -If :term:`ICECC_PATH` is not set in your -``local.conf`` file, then the class tries to locate the ``icecc`` binary -using ``which``. If :term:`ICECC_ENV_EXEC` is set -in your ``local.conf`` file, the variable should point to the -``icecc-create-env`` 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 ``icecc-create-env-native.bb``. - -.. note:: - - This script is a modified version and not the one that comes with - icecc. - -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 -:term:`ICECC_USER_PACKAGE_BL` and -:term:`ICECC_USER_CLASS_BL`, variables, -respectively, in your ``local.conf`` file. Doing so causes the -OpenEmbedded build system to handle these compilations locally. - -Additionally, you can list recipes using the -:term:`ICECC_USER_PACKAGE_WL` variable in -your ``local.conf`` file to force ``icecc`` to be enabled for recipes -using an empty :term:`PARALLEL_MAKE` variable. - -Inheriting the ``icecc`` class changes all sstate signatures. -Consequently, if a development team has a dedicated build system that -populates :term:`SSTATE_MIRRORS` and they want to -reuse sstate from ``SSTATE_MIRRORS``, then all developers and the build -system need to either inherit the ``icecc`` class or nobody should. - -At the distribution level, you can inherit the ``icecc`` 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 -:term:`ICECC_DISABLED` variable to "1" as follows: -:: - - INHERIT_DISTRO_append = " icecc" - ICECC_DISABLED ??= "1" - -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 ``local.conf`` file: -:: - - ICECC_DISABLED = "" - -.. _ref-classes-image: - -``image.bbclass`` -================= - -The ``image`` class helps support creating images in different formats. -First, the root filesystem is created from packages using one of the -``rootfs*.bbclass`` files (depending on the package format used) and -then one or more image files are created. - -- The ``IMAGE_FSTYPES`` variable controls the types of images to - generate. - -- The ``IMAGE_INSTALL`` variable controls the list of packages to - install into the image. - -For information on customizing images, see the -":ref:`dev-manual/common-tasks:customizing images`" section -in the Yocto Project Development Tasks Manual. For information on how -images are created, see the -":ref:`overview-manual/concepts:images`" section in the -Yocto Project Overview and Concpets Manual. - -.. _ref-classes-image-buildinfo: - -``image-buildinfo.bbclass`` -=========================== - -The ``image-buildinfo`` class writes information to the target -filesystem on ``/etc/build``. - -.. _ref-classes-image_types: - -``image_types.bbclass`` -======================= - -The ``image_types`` class defines all of the standard image output types -that you can enable through the -:term:`IMAGE_FSTYPES` variable. You can use this -class as a reference on how to add support for custom image output -types. - -By default, the :ref:`image ` class automatically -enables the ``image_types`` class. The ``image`` class uses the -``IMGCLASSES`` variable as follows: -:: - - IMGCLASSES = "rootfs_${IMAGE_PKGTYPE} image_types ${IMAGE_CLASSES}" - IMGCLASSES += "${@['populate_sdk_base', 'populate_sdk_ext']['linux' in d.getVar("SDK_OS")]}" - IMGCLASSES += "${@bb.utils.contains_any('IMAGE_FSTYPES', 'live iso hddimg', 'image-live', '', d)}" - IMGCLASSES += "${@bb.utils.contains('IMAGE_FSTYPES', 'container', 'image-container', '', d)}" - IMGCLASSES += "image_types_wic" - IMGCLASSES += "rootfs-postcommands" - IMGCLASSES += "image-postinst-intercepts" - inherit ${IMGCLASSES} - -The ``image_types`` class also handles conversion and compression of images. - -.. note:: - - To build a VMware VMDK image, you need to add "wic.vmdk" to - ``IMAGE_FSTYPES``. This would also be similar for Virtual Box Virtual Disk - Image ("vdi") and QEMU Copy On Write Version 2 ("qcow2") images. - -.. _ref-classes-image-live: - -``image-live.bbclass`` -====================== - -This class controls building "live" (i.e. HDDIMG and ISO) images. Live -images contain syslinux for legacy booting, as well as the bootloader -specified by :term:`EFI_PROVIDER` if -:term:`MACHINE_FEATURES` contains "efi". - -Normally, you do not use this class directly. Instead, you add "live" to -:term:`IMAGE_FSTYPES`. - -.. _ref-classes-image-mklibs: - -``image-mklibs.bbclass`` -======================== - -The ``image-mklibs`` class enables the use of the ``mklibs`` utility -during the :ref:`ref-tasks-rootfs` task, which optimizes -the size of libraries contained in the image. - -By default, the class is enabled in the ``local.conf.template`` using -the :term:`USER_CLASSES` variable as follows: -:: - - USER_CLASSES ?= "buildstats image-mklibs image-prelink" - -.. _ref-classes-image-prelink: - -``image-prelink.bbclass`` -========================= - -The ``image-prelink`` class enables the use of the ``prelink`` utility -during the :ref:`ref-tasks-rootfs` task, which optimizes -the dynamic linking of shared libraries to reduce executable startup -time. - -By default, the class is enabled in the ``local.conf.template`` using -the :term:`USER_CLASSES` variable as follows: -:: - - USER_CLASSES ?= "buildstats image-mklibs image-prelink" - -.. _ref-classes-insane: - -``insane.bbclass`` -================== - -The ``insane`` 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. - -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 ":doc:`ref-qa-checks`" Chapter for a list of all the warning -and error messages you might encounter using a default configuration. - -Use the :term:`WARN_QA` and -:term:`ERROR_QA` 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 :term:`INSANE_SKIP`. For example, to skip -the check for symbolic link ``.so`` 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 ``${PN}``, must be used: -:: - - INSANE_SKIP_${PN} += "dev-so" - -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. - -The following list shows the tests you can list with the ``WARN_QA`` and -``ERROR_QA`` variables: - -- ``already-stripped:`` 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 ``-dbg`` packages, this stripping must be - disabled. - -- ``arch:`` 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. - -- ``buildpaths:`` 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. - -- ``build-deps:`` Determines if a build-time dependency that is - specified through :term:`DEPENDS`, explicit - :term:`RDEPENDS`, 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 - :ref:`ref-tasks-rootfs` task because the auto-detected - dependency was not satisfied. An example of this would be where the - :ref:`update-rc.d ` class automatically - adds a dependency on the ``initscripts-functions`` package to - packages that install an initscript that refers to - ``/etc/init.d/functions``. The recipe should really have an explicit - ``RDEPENDS`` for the package in question on ``initscripts-functions`` - so that the OpenEmbedded build system is able to ensure that the - ``initscripts`` recipe is actually built and thus the - ``initscripts-functions`` package is made available. - -- ``compile-host-path:`` Checks the - :ref:`ref-tasks-compile` 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. - -- ``debug-deps:`` Checks that all packages except ``-dbg`` packages - do not depend on ``-dbg`` packages, which would cause a packaging - bug. - -- ``debug-files:`` Checks for ``.debug`` directories in anything but - the ``-dbg`` package. The debug files should all be in the ``-dbg`` - package. Thus, anything packaged elsewhere is incorrect packaging. - -- ``dep-cmp:`` Checks for invalid version comparison statements in - runtime dependency relationships between packages (i.e. in - :term:`RDEPENDS`, - :term:`RRECOMMENDS`, - :term:`RSUGGESTS`, - :term:`RPROVIDES`, - :term:`RREPLACES`, and - :term:`RCONFLICTS` variable values). Any invalid - comparisons might trigger failures or undesirable behavior when - passed to the package manager. - -- ``desktop:`` Runs the ``desktop-file-validate`` program against any - ``.desktop`` files to validate their contents against the - specification for ``.desktop`` files. - -- ``dev-deps:`` Checks that all packages except ``-dev`` or - ``-staticdev`` packages do not depend on ``-dev`` packages, which - would be a packaging bug. - -- ``dev-so:`` Checks that the ``.so`` symbolic links are in the - ``-dev`` package and not in any of the other packages. In general, - these symlinks are only useful for development purposes. Thus, the - ``-dev`` 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. - -- ``file-rdeps:`` 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 ``#!/bin/bash``. - This line would translate to a file dependency on ``/bin/bash``. 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 - :term:`RDEPENDS` exist to handle any file-level - dependency detected in packaged files. - -- ``files-invalid:`` Checks for :term:`FILES` variable - values that contain "//", which is invalid. - -- ``host-user-contaminated:`` Checks that no package produced by the - recipe contains any files outside of ``/home`` with a user or group - ID that matches the user running BitBake. A match usually indicates - that the files are being installed with an incorrect UID/GID, since - target IDs are independent from host IDs. For additional information, - see the section describing the - :ref:`ref-tasks-install` task. - -- ``incompatible-license:`` Report when packages are excluded from - being created due to being marked with a license that is in - :term:`INCOMPATIBLE_LICENSE`. - -- ``install-host-path:`` Checks the - :ref:`ref-tasks-install` 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. - -- ``installed-vs-shipped:`` Reports when files have been installed - within ``do_install`` but have not been included in any package by - way of the :term:`FILES` 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 - ``do_install`` if the files are not needed in any package. - -- ``invalid-chars:`` Checks that the recipe metadata variables - :term:`DESCRIPTION`, - :term:`SUMMARY`, :term:`LICENSE`, and - :term:`SECTION` do not contain non-UTF-8 characters. - Some package managers do not support such characters. - -- ``invalid-packageconfig:`` Checks that no undefined features are - being added to :term:`PACKAGECONFIG`. For - example, any name "foo" for which the following form does not exist: - :: - - PACKAGECONFIG[foo] = "..." - -- ``la:`` Checks ``.la`` files for any ``TMPDIR`` paths. Any ``.la`` - file containing these paths is incorrect since ``libtool`` adds the - correct sysroot prefix when using the files automatically itself. - -- ``ldflags:`` Ensures that the binaries were linked with the - :term:`LDFLAGS` options provided by the build system. - If this test fails, check that the ``LDFLAGS`` variable is being - passed to the linker command. - -- ``libdir:`` Checks for libraries being installed into incorrect - (possibly hardcoded) installation paths. For example, this test will - catch recipes that install ``/lib/bar.so`` when ``${base_libdir}`` is - "lib32". Another example is when recipes install - ``/usr/lib64/foo.so`` when ``${libdir}`` is "/usr/lib". - -- ``libexec:`` Checks if a package contains files in - ``/usr/libexec``. This check is not performed if the ``libexecdir`` - variable has been set explicitly to ``/usr/libexec``. - -- ``packages-list:`` Checks for the same package being listed - multiple times through the :term:`PACKAGES` variable - value. Installing the package in this manner can cause errors during - packaging. - -- ``perm-config:`` Reports lines in ``fs-perms.txt`` that have an - invalid format. - -- ``perm-line:`` Reports lines in ``fs-perms.txt`` that have an - invalid format. - -- ``perm-link:`` Reports lines in ``fs-perms.txt`` that specify - 'link' where the specified target already exists. - -- ``perms:`` Currently, this check is unused but reserved. - -- ``pkgconfig:`` Checks ``.pc`` files for any - :term:`TMPDIR`/:term:`WORKDIR` paths. - Any ``.pc`` file containing these paths is incorrect since - ``pkg-config`` itself adds the correct sysroot prefix when the files - are accessed. - -- ``pkgname:`` Checks that all packages in - :term:`PACKAGES` have names that do not contain - invalid characters (i.e. characters other than 0-9, a-z, ., +, and - -). - -- ``pkgv-undefined:`` Checks to see if the ``PKGV`` variable is - undefined during :ref:`ref-tasks-package`. - -- ``pkgvarcheck:`` Checks through the variables - :term:`RDEPENDS`, - :term:`RRECOMMENDS`, - :term:`RSUGGESTS`, - :term:`RCONFLICTS`, - :term:`RPROVIDES`, - :term:`RREPLACES`, :term:`FILES`, - :term:`ALLOW_EMPTY`, ``pkg_preinst``, - ``pkg_postinst``, ``pkg_prerm`` and ``pkg_postrm``, 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. - -- ``pn-overrides:`` Checks that a recipe does not have a name - (:term:`PN`) value that appears in - :term:`OVERRIDES`. If a recipe is named such that - its ``PN`` value matches something already in ``OVERRIDES`` (e.g. - ``PN`` happens to be the same as :term:`MACHINE` or - :term:`DISTRO`), it can have unexpected consequences. - For example, assignments such as ``FILES_${PN} = "xyz"`` effectively - turn into ``FILES = "xyz"``. - -- ``rpaths:`` Checks for rpaths in the binaries that contain build - system paths such as ``TMPDIR``. If this test fails, bad ``-rpath`` - options are being passed to the linker commands and your binaries - have potential security issues. - -- ``split-strip:`` Reports that splitting or stripping debug symbols - from binaries has failed. - -- ``staticdev:`` Checks for static library files (``*.a``) in - non-``staticdev`` packages. - -- ``symlink-to-sysroot:`` Checks for symlinks in packages that point - into :term:`TMPDIR` on the host. Such symlinks will - work on the host, but are clearly invalid when running on the target. - -- ``textrel:`` Checks for ELF binaries that contain relocations in - their ``.text`` sections, which can result in a performance impact at - runtime. See the explanation for the ``ELF binary`` message in - ":doc:`ref-qa-checks`" for more information regarding runtime performance - issues. - -- ``unlisted-pkg-lics:`` Checks that all declared licenses applying - for a package are also declared on the recipe level (i.e. any license - in ``LICENSE_*`` should appear in :term:`LICENSE`). - -- ``useless-rpaths:`` Checks for dynamic library load paths (rpaths) - in the binaries that by default on a standard system are searched by - the linker (e.g. ``/lib`` and ``/usr/lib``). While these paths will - not cause any breakage, they do waste space and are unnecessary. - -- ``var-undefined:`` Reports when variables fundamental to packaging - (i.e. :term:`WORKDIR`, - :term:`DEPLOY_DIR`, :term:`D`, - :term:`PN`, and :term:`PKGD`) are undefined - during :ref:`ref-tasks-package`. - -- ``version-going-backwards:`` 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. - -- ``xorg-driver-abi:`` Checks that all packages containing Xorg - drivers have ABI dependencies. 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 - ``xorg-driver-input.inc`` or ``xorg-driver-video.inc`` will - automatically get these versions. Consequently, you should only need - to explicitly add dependencies to binary driver recipes. - -.. _ref-classes-insserv: - -``insserv.bbclass`` -=================== - -The ``insserv`` class uses the ``insserv`` utility to update the order -of symbolic links in ``/etc/rc?.d/`` within an image based on -dependencies specified by LSB headers in the ``init.d`` scripts -themselves. - -.. _ref-classes-kernel: - -``kernel.bbclass`` -================== - -The ``kernel`` class handles building Linux kernels. The class contains -code to build all kernel trees. All needed headers are staged into the -``STAGING_KERNEL_DIR`` directory to allow out-of-tree module builds -using the :ref:`module ` class. - -This means that each built kernel module is packaged separately and -inter-module dependencies are created by parsing the ``modinfo`` output. -If all modules are required, then installing the ``kernel-modules`` -package installs all packages with modules and various other kernel -packages such as ``kernel-vmlinux``. - -The ``kernel`` class contains logic that allows you to embed an initial -RAM filesystem (initramfs) image when you build the kernel image. For -information on how to build an initramfs, see the -":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in -the Yocto Project Development Tasks Manual. - -Various other classes are used by the ``kernel`` and ``module`` classes -internally including the :ref:`kernel-arch `, -:ref:`module-base `, and -:ref:`linux-kernel-base ` classes. - -.. _ref-classes-kernel-arch: - -``kernel-arch.bbclass`` -======================= - -The ``kernel-arch`` class sets the ``ARCH`` environment variable for -Linux kernel compilation (including modules). - -.. _ref-classes-kernel-devicetree: - -``kernel-devicetree.bbclass`` -============================= - -The ``kernel-devicetree`` class, which is inherited by the -:ref:`kernel ` class, supports device tree -generation. - -.. _ref-classes-kernel-fitimage: - -``kernel-fitimage.bbclass`` -=========================== - -The ``kernel-fitimage`` class provides support to pack a kernel Image, -device trees and a RAM disk into a single FIT image. In theory, a FIT -image can support any number of kernels, RAM disks and device-trees. -However, ``kernel-fitimage`` currently only supports -limited usescases: just one kernel image, an optional RAM disk, and -any number of device tree. - -To create a FIT image, it is required that :term:`KERNEL_CLASSES` -is set to "kernel-fitimage" and :term:`KERNEL_IMAGETYPE` -is set to "fitImage". - -The options for the device tree compiler passed to mkimage -D feature -when creating the FIT image are specified using the -:term:`UBOOT_MKIMAGE_DTCOPTS` variable. - -Only a single kernel can be added to the FIT image created by -``kernel-fitimage`` and the kernel image in FIT is mandatory. The -address where the kernel image is to be loaded by U-boot is -specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by -:term:`UBOOT_ENTRYPOINT`. - -Multiple device trees can be added to the FIT image created by -``kernel-fitimage`` and the device tree is optional. -The address where the device tree is to be loaded by U-boot is -specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays -and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries. - -Only a single RAM disk can be added to the FIT image created by -``kernel-fitimage`` and the RAM disk in FIT is optional. -The address where the RAM disk image is to be loaded by U-boot -is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by -:term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to FIT image when -:term:`INITRAMFS_IMAGE` is specified. - -The FIT image generated by ``kernel-fitimage`` class is signed when the -variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`, -:term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set -appropriately. The default values used for :term:`FIT_HASH_ALG` and -:term:`FIT_SIGN_ALG` in ``kernel-fitimage`` are "sha256" and -"rsa2048" respectively. The keys for signing fitImage can be generated using -the ``kernel-fitimage`` class when both :term:`FIT_GENERATE_KEYS` and -:term:`UBOOT_SIGN_ENABLE` are set to "1". - - -.. _ref-classes-kernel-grub: - -``kernel-grub.bbclass`` -======================= - -The ``kernel-grub`` 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. - -.. _ref-classes-kernel-module-split: - -``kernel-module-split.bbclass`` -=============================== - -The ``kernel-module-split`` class provides common functionality for -splitting Linux kernel modules into separate packages. - -.. _ref-classes-kernel-uboot: - -``kernel-uboot.bbclass`` -======================== - -The ``kernel-uboot`` class provides support for building from -vmlinux-style kernel sources. - -.. _ref-classes-kernel-uimage: - -``kernel-uimage.bbclass`` -========================= - -The ``kernel-uimage`` class provides support to pack uImage. - -.. _ref-classes-kernel-yocto: - -``kernel-yocto.bbclass`` -======================== - -The ``kernel-yocto`` class provides common functionality for building -from linux-yocto style kernel source repositories. - -.. _ref-classes-kernelsrc: - -``kernelsrc.bbclass`` -===================== - -The ``kernelsrc`` class sets the Linux kernel source and version. - -.. _ref-classes-lib_package: - -``lib_package.bbclass`` -======================= - -The ``lib_package`` 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 ``${``\ :term:`PN`\ ``}-bin`` package to -make their installation optional. - -.. _ref-classes-libc*: - -``libc*.bbclass`` -================= - -The ``libc*`` classes support recipes that build packages with ``libc``: - -- The ``libc-common`` class provides common support for building with - ``libc``. - -- The ``libc-package`` class supports packaging up ``glibc`` and - ``eglibc``. - -.. _ref-classes-license: - -``license.bbclass`` -=================== - -The ``license`` class provides license manifest creation and license -exclusion. This class is enabled by default using the default value for -the :term:`INHERIT_DISTRO` variable. - -.. _ref-classes-linux-kernel-base: - -``linux-kernel-base.bbclass`` -============================= - -The ``linux-kernel-base`` 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. - -.. _ref-classes-linuxloader: - -``linuxloader.bbclass`` -======================= - -Provides the function ``linuxloader()``, which gives the value of the -dynamic loader/linker provided on the platform. This value is used by a -number of other classes. - -.. _ref-classes-logging: - -``logging.bbclass`` -=================== - -The ``logging`` class provides the standard shell functions used to log -messages for various BitBake severity levels (i.e. ``bbplain``, -``bbnote``, ``bbwarn``, ``bberror``, ``bbfatal``, and ``bbdebug``). - -This class is enabled by default since it is inherited by the ``base`` -class. - -.. _ref-classes-meta: - -``meta.bbclass`` -================ - -The ``meta`` class is inherited by recipes that do not build any output -packages themselves, but act as a "meta" target for building other -recipes. - -.. _ref-classes-metadata_scm: - -``metadata_scm.bbclass`` -======================== - -The ``metadata_scm`` class provides functionality for querying the -branch and revision of a Source Code Manager (SCM) repository. - -The :ref:`base ` class uses this class to print the -revisions of each layer before starting every build. The -``metadata_scm`` class is enabled by default because it is inherited by -the ``base`` class. - -.. _ref-classes-migrate_localcount: - -``migrate_localcount.bbclass`` -============================== - -The ``migrate_localcount`` class verifies a recipe's localcount data and -increments it appropriately. - -.. _ref-classes-mime: - -``mime.bbclass`` -================ - -The ``mime`` class generates the proper post-install and post-remove -(postinst/postrm) scriptlets for packages that install MIME type files. -These scriptlets call ``update-mime-database`` to add the MIME types to -the shared database. - -.. _ref-classes-mirrors: - -``mirrors.bbclass`` -=================== - -The ``mirrors`` class sets up some standard -:term:`MIRRORS` entries for source code mirrors. These -mirrors provide a fall-back path in case the upstream source specified -in :term:`SRC_URI` within recipes is unavailable. - -This class is enabled by default since it is inherited by the -:ref:`base ` class. - -.. _ref-classes-module: - -``module.bbclass`` -================== - -The ``module`` class provides support for building out-of-tree Linux -kernel modules. The class inherits the -:ref:`module-base ` and -:ref:`kernel-module-split ` classes, -and implements the :ref:`ref-tasks-compile` and -:ref:`ref-tasks-install` tasks. The class provides -everything needed to build and package a kernel module. - -For general information on out-of-tree Linux kernel modules, see the -":ref:`kernel-dev/common:incorporating out-of-tree modules`" -section in the Yocto Project Linux Kernel Development Manual. - -.. _ref-classes-module-base: - -``module-base.bbclass`` -======================= - -The ``module-base`` 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 -:ref:`module ` class. - -.. _ref-classes-multilib*: - -``multilib*.bbclass`` -===================== - -The ``multilib*`` classes provide support for building libraries with -different target optimizations or target architectures and installing -them side-by-side in the same image. - -For more information on using the Multilib feature, see the -":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" -section in the Yocto Project Development Tasks Manual. - -.. _ref-classes-native: - -``native.bbclass`` -================== - -The ``native`` class provides common functionality for recipes that -build tools to run on the :term:`Build Host` (i.e. tools that use the compiler -or other tools from the build host). - -You can create a recipe that builds tools that run natively on the host -a couple different ways: - -- Create a myrecipe\ ``-native.bb`` recipe that inherits the ``native`` - class. If you use this method, you must order the inherit statement - in the recipe after all other inherit statements so that the - ``native`` class is inherited last. - - .. note:: - - When creating a recipe this way, the recipe name must follow this - naming convention: - :: - - myrecipe-native.bb - - - Not using this naming convention can lead to subtle problems - caused by existing code that depends on that naming convention. - -- Create or modify a target recipe that contains the following: - :: - - BBCLASSEXTEND = "native" - - Inside the - recipe, use ``_class-native`` and ``_class-target`` overrides to - specify any functionality specific to the respective native or target - case. - -Although applied differently, the ``native`` 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. - -.. _ref-classes-nativesdk: - -``nativesdk.bbclass`` -===================== - -The ``nativesdk`` class provides common functionality for recipes that -wish to build tools to run as part of an SDK (i.e. tools that run on -:term:`SDKMACHINE`). - -You can create a recipe that builds tools that run on the SDK machine a -couple different ways: - -- Create a ``nativesdk-``\ myrecipe\ ``.bb`` recipe that inherits the - ``nativesdk`` class. If you use this method, you must order the - inherit statement in the recipe after all other inherit statements so - that the ``nativesdk`` class is inherited last. - -- Create a ``nativesdk`` variant of any recipe by adding the following: - :: - - BBCLASSEXTEND = "nativesdk" - - Inside the - recipe, use ``_class-nativesdk`` and ``_class-target`` overrides to - specify any functionality specific to the respective SDK machine or - target case. - -.. note:: - - When creating a recipe, you must follow this naming convention: - :: - - nativesdk-myrecipe.bb - - - Not doing so can lead to subtle problems because code exists that - depends on the naming convention. - -Although applied differently, the ``nativesdk`` 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. - -.. _ref-classes-nopackages: - -``nopackages.bbclass`` -====================== - -Disables packaging tasks for those recipes and classes where packaging -is not needed. - -.. _ref-classes-npm: - -``npm.bbclass`` -=============== - -Provides support for building Node.js software fetched using the `node -package manager (NPM) `__. - -.. note:: - - Currently, recipes inheriting this class must use the ``npm://`` - fetcher to have dependencies fetched and packaged automatically. - -For information on how to create NPM packages, see the -":ref:`dev-manual/common-tasks:creating node package manager (npm) packages`" -section in the Yocto Project Development Tasks Manual. - -.. _ref-classes-oelint: - -``oelint.bbclass`` -================== - -The ``oelint`` class is an obsolete lint checking tool that exists in -``meta/classes`` in the :term:`Source Directory`. - -A number of classes exist that could be generally useful in OE-Core but -are never actually used within OE-Core itself. The ``oelint`` class is -one such example. However, being aware of this class can reduce the -proliferation of different versions of similar classes across multiple -layers. - -.. _ref-classes-own-mirrors: - -``own-mirrors.bbclass`` -======================= - -The ``own-mirrors`` class makes it easier to set up your own -:term:`PREMIRRORS` from which to first fetch source -before attempting to fetch it from the upstream specified in -:term:`SRC_URI` within each recipe. - -To use this class, inherit it globally and specify -:term:`SOURCE_MIRROR_URL`. Here is an example: -:: - - INHERIT += "own-mirrors" - SOURCE_MIRROR_URL = "http://example.com/my-source-mirror" - -You can specify only a single URL -in ``SOURCE_MIRROR_URL``. - -.. _ref-classes-package: - -``package.bbclass`` -=================== - -The ``package`` class supports generating packages from a build's -output. The core generic functionality is in ``package.bbclass``. The -code specific to particular package types resides in these -package-specific classes: -:ref:`package_deb `, -:ref:`package_rpm `, -:ref:`package_ipk `, and -:ref:`package_tar `. - -.. note:: - - The - package_tar - class is broken and not supported. It is recommended that you do not - use this class. - -You can control the list of resulting package formats by using the -``PACKAGE_CLASSES`` variable defined in your ``conf/local.conf`` -configuration file, which is located in the :term:`Build Directory`. -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. - -If you take the optional step to set up a repository (package feed) on -the development host that can be used by DNF, 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 -":ref:`dev-manual/common-tasks:using runtime package management`" -section in the Yocto Project Development Tasks Manual. - -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 :term:`Metadata` than the IPK package -manager. Consequently, you might consider setting ``PACKAGE_CLASSES`` to -"package_ipk" if you are building smaller systems. - -Before making your package manager decision, however, you should -consider some further things about using RPM: - -- 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. - -- 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. - -You can find additional information on the effects of the package class -at these two Yocto Project mailing list links: - -- :yocto_lists:`/pipermail/poky/2011-May/006362.html` - -- :yocto_lists:`/pipermail/poky/2011-May/006363.html` - -.. _ref-classes-package_deb: - -``package_deb.bbclass`` -======================= - -The ``package_deb`` class provides support for creating packages that -use the Debian (i.e. ``.deb``) file format. The class ensures the -packages are written out in a ``.deb`` file format to the -``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory. - -This class inherits the :ref:`package ` class and -is enabled through the :term:`PACKAGE_CLASSES` -variable in the ``local.conf`` file. - -.. _ref-classes-package_ipk: - -``package_ipk.bbclass`` -======================= - -The ``package_ipk`` class provides support for creating packages that -use the IPK (i.e. ``.ipk``) file format. The class ensures the packages -are written out in a ``.ipk`` file format to the -``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory. - -This class inherits the :ref:`package ` class and -is enabled through the :term:`PACKAGE_CLASSES` -variable in the ``local.conf`` file. - -.. _ref-classes-package_rpm: - -``package_rpm.bbclass`` -======================= - -The ``package_rpm`` class provides support for creating packages that -use the RPM (i.e. ``.rpm``) file format. The class ensures the packages -are written out in a ``.rpm`` file format to the -``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory. - -This class inherits the :ref:`package ` class and -is enabled through the :term:`PACKAGE_CLASSES` -variable in the ``local.conf`` file. - -.. _ref-classes-package_tar: - -``package_tar.bbclass`` -======================= - -The ``package_tar`` class provides support for creating tarballs. The -class ensures the packages are written out in a tarball format to the -``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory. - -This class inherits the :ref:`package ` class and -is enabled through the :term:`PACKAGE_CLASSES` -variable in the ``local.conf`` file. - -.. note:: - - You cannot specify the ``package_tar`` class first using the - ``PACKAGE_CLASSES`` variable. You must use ``.deb``, ``.ipk``, or ``.rpm`` - file formats for your image or SDK. - -.. _ref-classes-packagedata: - -``packagedata.bbclass`` -======================= - -The ``packagedata`` class provides common functionality for reading -``pkgdata`` files found in :term:`PKGDATA_DIR`. These -files contain information about each output package produced by the -OpenEmbedded build system. - -This class is enabled by default because it is inherited by the -:ref:`package ` class. - -.. _ref-classes-packagegroup: - -``packagegroup.bbclass`` -======================== - -The ``packagegroup`` class sets default values appropriate for package -group recipes (e.g. ``PACKAGES``, ``PACKAGE_ARCH``, ``ALLOW_EMPTY``, and -so forth). It is highly recommended that all package group recipes -inherit this class. - -For information on how to use this class, see the -":ref:`dev-manual/common-tasks:customizing images using custom package groups`" -section in the Yocto Project Development Tasks Manual. - -Previously, this class was called the ``task`` class. - -.. _ref-classes-patch: - -``patch.bbclass`` -================= - -The ``patch`` class provides all functionality for applying patches -during the :ref:`ref-tasks-patch` task. - -This class is enabled by default because it is inherited by the -:ref:`base ` class. - -.. _ref-classes-perlnative: - -``perlnative.bbclass`` -====================== - -When inherited by a recipe, the ``perlnative`` class supports using the -native version of Perl built by the build system rather than using the -version provided by the build host. - -.. _ref-classes-pixbufcache: - -``pixbufcache.bbclass`` -======================= - -The ``pixbufcache`` class generates the proper post-install and -post-remove (postinst/postrm) scriptlets for packages that install -pixbuf loaders, which are used with ``gdk-pixbuf``. These scriptlets -call ``update_pixbuf_cache`` to add the pixbuf loaders to the cache. -Since the cache files are architecture-specific, ``update_pixbuf_cache`` -is run using QEMU if the postinst scriptlets need to be run on the build -host during image creation. - -If the pixbuf loaders being installed are in packages other than the -recipe's main package, set -:term:`PIXBUF_PACKAGES` to specify the packages -containing the loaders. - -.. _ref-classes-pkgconfig: - -``pkgconfig.bbclass`` -===================== - -The ``pkgconfig`` class provides a standard way to get header and -library information by using ``pkg-config``. This class aims to smooth -integration of ``pkg-config`` into libraries that use it. - -During staging, BitBake installs ``pkg-config`` data into the -``sysroots/`` directory. By making use of sysroot functionality within -``pkg-config``, the ``pkgconfig`` class no longer has to manipulate the -files. - -.. _ref-classes-populate-sdk: - -``populate_sdk.bbclass`` -======================== - -The ``populate_sdk`` class provides support for SDK-only recipes. For -information on advantages gained when building a cross-development -toolchain using the :ref:`ref-tasks-populate_sdk` -task, see the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`" -section in the Yocto Project Application Development and the Extensible -Software Development Kit (eSDK) manual. - -.. _ref-classes-populate-sdk-*: - -``populate_sdk_*.bbclass`` -========================== - -The ``populate_sdk_*`` classes support SDK creation and consist of the -following classes: - -- ``populate_sdk_base``: The base class supporting SDK creation under - all package managers (i.e. DEB, RPM, and opkg). - -- ``populate_sdk_deb``: Supports creation of the SDK given the Debian - package manager. - -- ``populate_sdk_rpm``: Supports creation of the SDK given the RPM - package manager. - -- ``populate_sdk_ipk``: Supports creation of the SDK given the opkg - (IPK format) package manager. - -- ``populate_sdk_ext``: Supports extensible SDK creation under all - package managers. - -The ``populate_sdk_base`` class inherits the appropriate -``populate_sdk_*`` (i.e. ``deb``, ``rpm``, and ``ipk``) based on -:term:`IMAGE_PKGTYPE`. - -The base class ensures all source and destination directories are -established and then populates the SDK. After populating the SDK, the -``populate_sdk_base`` class constructs two sysroots: -``${``\ :term:`SDK_ARCH`\ ``}-nativesdk``, 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 :term:`SDK_OUTPUT`, -which consists of the following: -:: - - ${SDK_OUTPUT}/${SDK_ARCH}-nativesdk-pkgs - ${SDK_OUTPUT}/${SDKTARGETSYSROOT}/target-pkgs - -Finally, the base populate SDK class creates the toolchain environment -setup script, the tarball of the SDK, and the installer. - -The respective ``populate_sdk_deb``, ``populate_sdk_rpm``, and -``populate_sdk_ipk`` classes each support the specific type of SDK. -These classes are inherited by and used with the ``populate_sdk_base`` -class. - -For more information on the cross-development toolchain generation, see -the ":ref:`overview-manual/concepts:cross-development toolchain generation`" -section in the Yocto Project Overview and Concepts Manual. For -information on advantages gained when building a cross-development -toolchain using the :ref:`ref-tasks-populate_sdk` -task, see the -":ref:`sdk-manual/appendix-obtain:building an sdk installer`" -section in the Yocto Project Application Development and the Extensible -Software Development Kit (eSDK) manual. - -.. _ref-classes-prexport: - -``prexport.bbclass`` -==================== - -The ``prexport`` class provides functionality for exporting -:term:`PR` values. - -.. note:: - - This class is not intended to be used directly. Rather, it is enabled - when using "``bitbake-prserv-tool export``". - -.. _ref-classes-primport: - -``primport.bbclass`` -==================== - -The ``primport`` class provides functionality for importing -:term:`PR` values. - -.. note:: - - This class is not intended to be used directly. Rather, it is enabled - when using "``bitbake-prserv-tool import``". - -.. _ref-classes-prserv: - -``prserv.bbclass`` -================== - -The ``prserv`` class provides functionality for using a :ref:`PR -service ` in order to -automatically manage the incrementing of the :term:`PR` -variable for each recipe. - -This class is enabled by default because it is inherited by the -:ref:`package ` class. However, the OpenEmbedded -build system will not enable the functionality of this class unless -:term:`PRSERV_HOST` has been set. - -.. _ref-classes-ptest: - -``ptest.bbclass`` -================= - -The ``ptest`` class provides functionality for packaging and installing -runtime tests for recipes that build software that provides these tests. - -This class is intended to be inherited by individual recipes. However, -the class' functionality is largely disabled unless "ptest" appears in -:term:`DISTRO_FEATURES`. See the -":ref:`dev-manual/common-tasks:testing packages with ptest`" -section in the Yocto Project Development Tasks Manual for more information -on ptest. - -.. _ref-classes-ptest-gnome: - -``ptest-gnome.bbclass`` -======================= - -Enables package tests (ptests) specifically for GNOME packages, which -have tests intended to be executed with ``gnome-desktop-testing``. - -For information on setting up and running ptests, see the -":ref:`dev-manual/common-tasks:testing packages with ptest`" -section in the Yocto Project Development Tasks Manual. - -.. _ref-classes-python-dir: - -``python-dir.bbclass`` -====================== - -The ``python-dir`` class provides the base version, location, and site -package location for Python. - -.. _ref-classes-python3native: - -``python3native.bbclass`` -========================= - -The ``python3native`` 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. - -.. _ref-classes-pythonnative: - -``pythonnative.bbclass`` -======================== - -When inherited by a recipe, the ``pythonnative`` class supports using -the native version of Python built by the build system rather than using -the version provided by the build host. - -.. _ref-classes-qemu: - -``qemu.bbclass`` -================ - -The ``qemu`` 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. - -.. _ref-classes-recipe_sanity: - -``recipe_sanity.bbclass`` -========================= - -The ``recipe_sanity`` 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). - -.. _ref-classes-relocatable: - -``relocatable.bbclass`` -======================= - -The ``relocatable`` class enables relocation of binaries when they are -installed into the sysroot. - -This class makes use of the :ref:`chrpath ` class -and is used by both the :ref:`cross ` and -:ref:`native ` classes. - -.. _ref-classes-remove-libtool: - -``remove-libtool.bbclass`` -========================== - -The ``remove-libtool`` class adds a post function to the -:ref:`ref-tasks-install` task to remove all ``.la`` files -installed by ``libtool``. Removing these files results in them being -absent from both the sysroot and target packages. - -If a recipe needs the ``.la`` files to be installed, then the recipe can -override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows: -:: - - REMOVE_LIBTOOL_LA = "0" - -.. note:: - - The ``remove-libtool`` class is not enabled by default. - -.. _ref-classes-report-error: - -``report-error.bbclass`` -======================== - -The ``report-error`` class supports enabling the :ref:`error reporting -tool `", -which allows you to submit build error information to a central database. - -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 -``${``\ :term:`LOG_DIR`\ ``}/error-report``. - -.. _ref-classes-rm-work: - -``rm_work.bbclass`` -=================== - -The ``rm_work`` class supports deletion of temporary workspace, which -can ease your hard drive demands during builds. - -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 ``${TMPDIR}/work`` 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 ``rm_work`` by adding the following to -your ``local.conf`` file, which is found in the :term:`Build Directory`. -:: - - INHERIT += "rm_work" - -If you are -modifying and building source code out of the work directory for a -recipe, enabling ``rm_work`` will potentially result in your changes to -the source being lost. To exclude some recipes from having their work -directories deleted by ``rm_work``, you can add the names of the recipe -or recipes you are working on to the ``RM_WORK_EXCLUDE`` variable, which -can also be set in your ``local.conf`` file. Here is an example: -:: - - RM_WORK_EXCLUDE += "busybox glibc" - -.. _ref-classes-rootfs*: - -``rootfs*.bbclass`` -=================== - -The ``rootfs*`` classes support creating the root filesystem for an -image and consist of the following classes: - -- The ``rootfs-postcommands`` class, which defines filesystem - post-processing functions for image recipes. - -- The ``rootfs_deb`` class, which supports creation of root filesystems - for images built using ``.deb`` packages. - -- The ``rootfs_rpm`` class, which supports creation of root filesystems - for images built using ``.rpm`` packages. - -- The ``rootfs_ipk`` class, which supports creation of root filesystems - for images built using ``.ipk`` packages. - -- The ``rootfsdebugfiles`` class, which installs additional files found - on the build host directly into the root filesystem. - -The root filesystem is created from packages using one of the -``rootfs*.bbclass`` files as determined by the -:term:`PACKAGE_CLASSES` variable. - -For information on how root filesystem images are created, see the -":ref:`overview-manual/concepts:image generation`" -section in the Yocto Project Overview and Concepts Manual. - -.. _ref-classes-sanity: - -``sanity.bbclass`` -================== - -The ``sanity`` 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 ``local.conf`` configuration file to -prevent common mistakes that cause build failures. Distribution policy -usually determines whether to include this class. - -.. _ref-classes-scons: - -``scons.bbclass`` -================= - -The ``scons`` class supports recipes that need to build software that -uses the SCons build system. You can use the -:term:`EXTRA_OESCONS` variable to specify -additional configuration options you want to pass SCons command line. - -.. _ref-classes-sdl: - -``sdl.bbclass`` -=============== - -The ``sdl`` class supports recipes that need to build software that uses -the Simple DirectMedia Layer (SDL) library. - -.. _ref-classes-setuptools: - -``setuptools.bbclass`` -====================== - -The ``setuptools`` class supports Python version 2.x extensions that use -build systems based on ``setuptools``. If your recipe uses these build -systems, the recipe needs to inherit the ``setuptools`` class. - -.. _ref-classes-setuptools3: - -``setuptools3.bbclass`` -======================= - -The ``setuptools3`` class supports Python version 3.x extensions that -use build systems based on ``setuptools3``. If your recipe uses these -build systems, the recipe needs to inherit the ``setuptools3`` class. - -.. _ref-classes-sign_rpm: - -``sign_rpm.bbclass`` -==================== - -The ``sign_rpm`` class supports generating signed RPM packages. - -.. _ref-classes-sip: - -``sip.bbclass`` -=============== - -The ``sip`` class supports recipes that build or package SIP-based -Python bindings. - -.. _ref-classes-siteconfig: - -``siteconfig.bbclass`` -====================== - -The ``siteconfig`` class provides functionality for handling site -configuration. The class is used by the -:ref:`autotools ` class to accelerate the -:ref:`ref-tasks-configure` task. - -.. _ref-classes-siteinfo: - -``siteinfo.bbclass`` -==================== - -The ``siteinfo`` class provides information about the targets that might -be needed by other classes or recipes. - -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 ``meta/site directory`` contains test results -sorted into different categories such as architecture, endianness, and -the ``libc`` used. Site information provides a list of files containing -data relevant to the current build in the ``CONFIG_SITE`` variable that -Autotools automatically picks up. - -The class also provides variables like ``SITEINFO_ENDIANNESS`` and -``SITEINFO_BITS`` that can be used elsewhere in the metadata. - -.. _ref-classes-sstate: - -``sstate.bbclass`` -================== - -The ``sstate`` class provides support for Shared State (sstate). By -default, the class is enabled through the -:term:`INHERIT_DISTRO` variable's default value. - -For more information on sstate, see the -":ref:`overview-manual/concepts:shared state cache`" -section in the Yocto Project Overview and Concepts Manual. - -.. _ref-classes-staging: - -``staging.bbclass`` -=================== - -The ``staging`` class installs files into individual recipe work -directories for sysroots. The class contains the following key tasks: - -- The :ref:`ref-tasks-populate_sysroot` task, - which is responsible for handing the files that end up in the recipe - sysroots. - -- The - :ref:`ref-tasks-prepare_recipe_sysroot` - task (a "partner" task to the ``populate_sysroot`` task), which - installs the files into the individual recipe work directories (i.e. - :term:`WORKDIR`). - -The code in the ``staging`` class is complex and basically works in two -stages: - -- *Stage One:* The first stage addresses recipes that have files they - want to share with other recipes that have dependencies on the - originating recipe. Normally these dependencies are installed through - the :ref:`ref-tasks-install` task into - ``${``\ :term:`D`\ ``}``. The ``do_populate_sysroot`` task - copies a subset of these files into ``${SYSROOT_DESTDIR}``. This - subset of files is controlled by the - :term:`SYSROOT_DIRS`, - :term:`SYSROOT_DIRS_NATIVE`, and - :term:`SYSROOT_DIRS_BLACKLIST` - variables. - - .. note:: - - Additionally, a recipe can customize the files further by - declaring a processing function in the ``SYSROOT_PREPROCESS_FUNCS`` - variable. - - A shared state (sstate) object is built from these files and the - files are placed into a subdirectory of - :ref:`structure-build-tmp-sysroots-components`. - The files are scanned for hardcoded paths to the original - installation location. If the location is found in text files, the - hardcoded locations are replaced by tokens and a list of the files - needing such replacements is created. These adjustments are referred - to as "FIXMEs". The list of files that are scanned for paths is - controlled by the :term:`SSTATE_SCAN_FILES` - variable. - -- *Stage Two:* The second stage addresses recipes that want to use - something from another recipe and declare a dependency on that recipe - through the :term:`DEPENDS` variable. The recipe will - have a - :ref:`ref-tasks-prepare_recipe_sysroot` - task and when this task executes, it creates the ``recipe-sysroot`` - and ``recipe-sysroot-native`` in the recipe work directory (i.e. - :term:`WORKDIR`). The OpenEmbedded build system - creates hard links to copies of the relevant files from - ``sysroots-components`` into the recipe work directory. - - .. note:: - - If hard links are not possible, the build system uses actual - copies. - - The build system then addresses any "FIXMEs" to paths as defined from - the list created in the first stage. - - Finally, any files in ``${bindir}`` within the sysroot that have the - prefix "``postinst-``" are executed. - - .. note:: - - Although such sysroot post installation scripts are not - recommended for general use, the files do allow some issues such - as user creation and module indexes to be addressed. - - Because recipes can have other dependencies outside of ``DEPENDS`` - (e.g. ``do_unpack[depends] += "tar-native:do_populate_sysroot"``), - the sysroot creation function ``extend_recipe_sysroot`` is also added - as a pre-function for those tasks whose dependencies are not through - ``DEPENDS`` but operate similarly. - - When installing dependencies into the sysroot, the code traverses the - dependency graph and processes dependencies in exactly the same way - as the dependencies would or would not be when installed from sstate. - This processing means, for example, a native tool would have its - native dependencies added but a target library would not have its - dependencies traversed or installed. The same sstate dependency code - is used so that builds should be identical regardless of whether - sstate was used or not. For a closer look, see the - ``setscene_depvalid()`` function in the - :ref:`sstate ` class. - - The build system is careful to maintain manifests of the files it - installs so that any given dependency can be installed as needed. The - sstate hash of the installed item is also stored so that if it - changes, the build system can reinstall it. - -.. _ref-classes-syslinux: - -``syslinux.bbclass`` -==================== - -The ``syslinux`` class provides syslinux-specific functions for building -bootable images. - -The class supports the following variables: - -- :term:`INITRD`: Indicates list of filesystem images to - concatenate and use as an initial RAM disk (initrd). This variable is - optional. - -- :term:`ROOTFS`: Indicates a filesystem image to include - as the root filesystem. This variable is optional. - -- :term:`AUTO_SYSLINUXMENU`: Enables creating - an automatic menu when set to "1". - -- :term:`LABELS`: Lists targets for automatic - configuration. - -- :term:`APPEND`: Lists append string overrides for each - label. - -- :term:`SYSLINUX_OPTS`: Lists additional options - to add to the syslinux file. Semicolon characters separate multiple - options. - -- :term:`SYSLINUX_SPLASH`: Lists a background - for the VGA boot menu when you are using the boot menu. - -- :term:`SYSLINUX_DEFAULT_CONSOLE`: Set - to "console=ttyX" to change kernel boot default console. - -- :term:`SYSLINUX_SERIAL`: Sets an alternate - serial port. Or, turns off serial when the variable is set with an - empty string. - -- :term:`SYSLINUX_SERIAL_TTY`: Sets an - alternate "console=tty..." kernel boot argument. - -.. _ref-classes-systemd: - -``systemd.bbclass`` -=================== - -The ``systemd`` class provides support for recipes that install systemd -unit files. - -The functionality for this class is disabled unless you have "systemd" -in :term:`DISTRO_FEATURES`. - -Under this class, the recipe or Makefile (i.e. whatever the recipe is -calling during the :ref:`ref-tasks-install` task) -installs unit files into -``${``\ :term:`D`\ ``}${systemd_unitdir}/system``. If the unit -files being installed go into packages other than the main package, you -need to set :term:`SYSTEMD_PACKAGES` in your -recipe to identify the packages in which the files will be installed. - -You should set :term:`SYSTEMD_SERVICE` 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 ``${``\ :term:`PN`\ ``}``. Here -is an example from the connman recipe: -:: - - SYSTEMD_SERVICE_${PN} = "connman.service" - -Services are set up to start on boot automatically -unless you have set -:term:`SYSTEMD_AUTO_ENABLE` to "disable". - -For more information on ``systemd``, see the -":ref:`dev-manual/common-tasks:selecting an initialization manager`" -section in the Yocto Project Development Tasks Manual. - -.. _ref-classes-systemd-boot: - -``systemd-boot.bbclass`` -======================== - -The ``systemd-boot`` class provides functions specific to the -systemd-boot bootloader for building bootable images. This is an -internal class and is not intended to be used directly. - -.. note:: - - The ``systemd-boot`` class is a result from merging the ``gummiboot`` class - used in previous Yocto Project releases with the ``systemd`` project. - -Set the :term:`EFI_PROVIDER` variable to -"systemd-boot" to use this class. Doing so creates a standalone EFI -bootloader that is not dependent on systemd. - -For information on more variables used and supported in this class, see -the :term:`SYSTEMD_BOOT_CFG`, -:term:`SYSTEMD_BOOT_ENTRIES`, and -:term:`SYSTEMD_BOOT_TIMEOUT` variables. - -You can also see the `Systemd-boot -documentation `__ -for more information. - -.. _ref-classes-terminal: - -``terminal.bbclass`` -==================== - -The ``terminal`` class provides support for starting a terminal session. -The :term:`OE_TERMINAL` variable controls which -terminal emulator is used for the session. - -Other classes use the ``terminal`` class anywhere a separate terminal -session needs to be started. For example, the -:ref:`patch ` class assuming -:term:`PATCHRESOLVE` is set to "user", the -:ref:`cml1 ` class, and the -:ref:`devshell ` class all use the ``terminal`` -class. - -.. _ref-classes-testimage*: - -``testimage*.bbclass`` -====================== - -The ``testimage*`` 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. - -.. note:: - - Best practices include using :term:`IMAGE_CLASSES` rather than - :term:`INHERIT` to inherit the ``testimage`` class for automated image - testing. - -The tests are commands that run on the target system over ``ssh``. Each -test is written in Python and makes use of the ``unittest`` module. - -The ``testimage.bbclass`` runs tests on an image when called using the -following: -:: - - $ bitbake -c testimage image - -The ``testimage-auto`` class -runs tests on an image after the image is constructed (i.e. -:term:`TESTIMAGE_AUTO` must be set to "1"). - -For information on how to enable, run, and create new tests, see the -":ref:`dev-manual/common-tasks:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. - -.. _ref-classes-testsdk: - -``testsdk.bbclass`` -=================== - -This class supports running automated tests against software development -kits (SDKs). The ``testsdk`` class runs tests on an SDK when called -using the following: -:: - - $ bitbake -c testsdk image - -.. note:: - - Best practices include using :term:`IMAGE_CLASSES` rather than - :term:`INHERIT` to inherit the ``testsdk`` class for automated SDK - testing. - -.. _ref-classes-texinfo: - -``texinfo.bbclass`` -=================== - -This class should be inherited by recipes whose upstream packages invoke -the ``texinfo`` utilities at build-time. Native and cross recipes are -made to use the dummy scripts provided by ``texinfo-dummy-native``, 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 :term:`ASSUME_PROVIDED` and makeinfo - from :term:`SANITY_REQUIRED_UTILITIES`. - -.. _ref-classes-toaster: - -``toaster.bbclass`` -=================== - -The ``toaster`` 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. - -This class is not intended to be used directly. - -.. _ref-classes-toolchain-scripts: - -``toolchain-scripts.bbclass`` -============================= - -The ``toolchain-scripts`` class provides the scripts used for setting up -the environment for installed SDKs. - -.. _ref-classes-typecheck: - -``typecheck.bbclass`` -===================== - -The ``typecheck`` 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: -:: - - IMAGE_FEATURES[type] = "list" - -.. _ref-classes-uboot-config: - -``uboot-config.bbclass`` -======================== - -The ``uboot-config`` class provides support for U-Boot configuration for -a machine. Specify the machine in your recipe as follows: -:: - - UBOOT_CONFIG ??= - UBOOT_CONFIG[foo] = "config,images" - -You can also specify the machine using this method: -:: - - UBOOT_MACHINE = "config" - -See the :term:`UBOOT_CONFIG` and :term:`UBOOT_MACHINE` variables for additional -information. - -.. _ref-classes-uninative: - -``uninative.bbclass`` -===================== - -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 ``meta/conf/distro/include/yocto-uninative.inc``. Other -distributions that do not derive from poky can also -"``require conf/distro/include/yocto-uninative.inc``" 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 -``UNINATIVE_URL`` and ``UNINATIVE_CHECKSUM`` appropriately. For an -example, see the ``meta/conf/distro/include/yocto-uninative.inc``. - -The ``uninative`` class is also used unconditionally by the extensible -SDK. When building the extensible SDK, ``uninative-tarball`` is built -and the resulting tarball is included within the SDK. - -.. _ref-classes-update-alternatives: - -``update-alternatives.bbclass`` -=============================== - -The ``update-alternatives`` 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 ``ar`` command is available from -the ``busybox``, ``binutils`` and ``elfutils`` packages. The -``update-alternatives`` class handles renaming the binaries so that -multiple packages can be installed without conflicts. The ``ar`` 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. - -To use this class, you need to define a number of variables: - -- :term:`ALTERNATIVE` - -- :term:`ALTERNATIVE_LINK_NAME` - -- :term:`ALTERNATIVE_TARGET` - -- :term:`ALTERNATIVE_PRIORITY` - -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 -:yocto_git:`update-alternatives.bbclass ` -file. - -.. note:: - - You can use the ``update-alternatives`` command directly in your recipes. - However, this class simplifies things in most cases. - -.. _ref-classes-update-rc.d: - -``update-rc.d.bbclass`` -======================= - -The ``update-rc.d`` class uses ``update-rc.d`` 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. - -Three variables control this class: ``INITSCRIPT_PACKAGES``, -``INITSCRIPT_NAME`` and ``INITSCRIPT_PARAMS``. See the variable links -for details. - -.. _ref-classes-useradd: - -``useradd*.bbclass`` -==================== - -The ``useradd*`` 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 ``meta-skeleton/recipes-skeleton/useradd/useradd-example.bb`` -recipe in the :term:`Source Directory` provides a simple -example that shows how to add three users and groups to two packages. -See the ``useradd-example.bb`` recipe for more information on how to use -these classes. - -The ``useradd_base`` class provides basic functionality for user or -groups settings. - -The ``useradd*`` classes support the -:term:`USERADD_PACKAGES`, -:term:`USERADD_PARAM`, -:term:`GROUPADD_PARAM`, and -:term:`GROUPMEMS_PARAM` variables. - -The ``useradd-staticids`` class supports the addition of users or groups -that have static user identification (``uid``) and group identification -(``gid``) values. - -The default behavior of the OpenEmbedded build system for assigning -``uid`` and ``gid`` 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 ``uid`` and ``gid`` values. However, if non-deterministic -``uid`` and ``gid`` 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 -:term:`BBPATH` for ``files/passwd`` and ``files/group`` -files for the values. - -To use static ``uid`` and ``gid`` values, you need to set some -variables. See the :term:`USERADDEXTENSION`, -:term:`USERADD_UID_TABLES`, -:term:`USERADD_GID_TABLES`, and -:term:`USERADD_ERROR_DYNAMIC` variables. -You can also see the :ref:`useradd ` class for -additional information. - -.. note:: - - You do not use the ``useradd-staticids`` class directly. You either enable - or disable the class by setting the ``USERADDEXTENSION`` variable. If you - enable or disable the class in a configured system, :term:`TMPDIR` might - contain incorrect ``uid`` and ``gid`` values. Deleting the ``TMPDIR`` - directory will correct this condition. - -.. _ref-classes-utility-tasks: - -``utility-tasks.bbclass`` -========================= - -The ``utility-tasks`` class provides support for various "utility" type -tasks that are applicable to all recipes, such as -:ref:`ref-tasks-clean` and -:ref:`ref-tasks-listtasks`. - -This class is enabled by default because it is inherited by the -:ref:`base ` class. - -.. _ref-classes-utils: - -``utils.bbclass`` -================= - -The ``utils`` class provides some useful Python functions that are -typically used in inline Python expressions (e.g. ``${@...}``). One -example use is for ``bb.utils.contains()``. - -This class is enabled by default because it is inherited by the -:ref:`base ` class. - -.. _ref-classes-vala: - -``vala.bbclass`` -================ - -The ``vala`` class supports recipes that need to build software written -using the Vala programming language. - -.. _ref-classes-waf: - -``waf.bbclass`` -=============== - -The ``waf`` class supports recipes that need to build software that uses -the Waf build system. You can use the -:term:`EXTRA_OECONF` or -:term:`PACKAGECONFIG_CONFARGS` variables -to specify additional configuration options to be passed on the Waf -command line. diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst deleted file mode 100644 index 2b97bb4605..0000000000 --- a/documentation/ref-manual/ref-devtool-reference.rst +++ /dev/null @@ -1,631 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -*************************** -``devtool`` Quick Reference -*************************** - -The ``devtool`` command-line tool provides a number of features that -help you build, test, and package software. This command is available -alongside the ``bitbake`` command. Additionally, the ``devtool`` command -is a key part of the extensible SDK. - -This chapter provides a Quick Reference for the ``devtool`` command. For -more information on how to apply the command when using the extensible -SDK, see the ":doc:`/sdk-manual/extensible`" chapter in the Yocto -Project Application Development and the Extensible Software Development -Kit (eSDK) manual. - -.. _devtool-getting-help: - -Getting Help -============ - -The ``devtool`` command line is organized similarly to Git in that it -has a number of sub-commands for each function. You can run -``devtool --help`` to see all the commands: -:: - - $ devtool -h - NOTE: Starting bitbake server... - usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] [--color COLOR] [-h] ... - - OpenEmbedded development tool - - options: - --basepath BASEPATH Base directory of SDK / build directory - --bbpath BBPATH Explicitly specify the BBPATH, rather than getting it from the metadata - -d, --debug Enable debug output - -q, --quiet Print only errors - --color COLOR Colorize output (where COLOR is auto, always, never) - -h, --help show this help message and exit - - subcommands: - Beginning work on a recipe: - add Add a new recipe - modify Modify the source for an existing recipe - upgrade Upgrade an existing recipe - Getting information: - status Show workspace status - latest-version Report the latest version of an existing recipe - check-upgrade-status Report upgradability for multiple (or all) recipes - search Search available recipes - Working on a recipe in the workspace: - build Build a recipe - rename Rename a recipe file in the workspace - edit-recipe Edit a recipe file - find-recipe Find a recipe file - configure-help Get help on configure script options - update-recipe Apply changes from external source tree to recipe - reset Remove a recipe from your workspace - finish Finish working on a recipe in your workspace - Testing changes on target: - deploy-target Deploy recipe output files to live target machine - undeploy-target Undeploy recipe output files in live target machine - build-image Build image including workspace recipe packages - Advanced: - create-workspace Set up workspace in an alternative location - extract Extract the source for an existing recipe - sync Synchronize the source tree for an existing recipe - menuconfig Alter build-time configuration for a recipe - import Import exported tar archive into workspace - export Export workspace into a tar archive - other: - selftest-reverse Reverse value (for selftest) - pluginfile Print the filename of this plugin - bbdir Print the BBPATH directory of this plugin - count How many times have this plugin been registered. - multiloaded How many times have this plugin been initialized - Use devtool --help to get help on a specific command - -As directed in the general help output, you can -get more syntax on a specific command by providing the command name and -using "--help": -:: - - $ devtool add --help - NOTE: Starting bitbake server... - usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] [--npm-dev] [--version VERSION] [--no-git] [--srcrev SRCREV | --autorev] [--srcbranch SRCBRANCH] [--binary] [--also-native] [--src-subdir SUBDIR] [--mirrors] - [--provides PROVIDES] - [recipename] [srctree] [fetchuri] - - Adds a new recipe to the workspace to build a specified source tree. Can optionally fetch a remote URI and unpack it to create the source tree. - - arguments: - recipename Name for new recipe to add (just name - no version, path or extension). If not specified, will attempt to auto-detect it. - srctree Path to external source tree. If not specified, a subdirectory of /media/build1/poky/build/workspace/sources will be used. - fetchuri Fetch the specified URI and extract it to create the source tree - - options: - -h, --help show this help message and exit - --same-dir, -s Build in same directory as source - --no-same-dir Force build in a separate build directory - --fetch URI, -f URI Fetch the specified URI and extract it to create the source tree (deprecated - pass as positional argument instead) - --npm-dev For npm, also fetch devDependencies - --version VERSION, -V VERSION - Version to use within recipe (PV) - --no-git, -g If fetching source, do not set up source tree as a git repository - --srcrev SRCREV, -S SRCREV - Source revision to fetch if fetching from an SCM such as git (default latest) - --autorev, -a When fetching from a git repository, set SRCREV in the recipe to a floating revision instead of fixed - --srcbranch SRCBRANCH, -B SRCBRANCH - Branch in source repository if fetching from an SCM such as git (default master) - --binary, -b Treat the source tree as something that should be installed verbatim (no compilation, same directory structure). Useful with binary packages e.g. RPMs. - --also-native Also add native variant (i.e. support building recipe for the build host as well as the target machine) - --src-subdir SUBDIR Specify subdirectory within source tree to use - --mirrors Enable PREMIRRORS and MIRRORS for source tree fetching (disable by default). - --provides PROVIDES, -p PROVIDES - Specify an alias for the item provided by the recipe. E.g. virtual/libgl - -.. _devtool-the-workspace-layer-structure: - -The Workspace Layer Structure -============================= - -``devtool`` uses a "Workspace" layer in which to accomplish builds. This -layer is not specific to any single ``devtool`` command but is rather a -common working area used across the tool. - -The following figure shows the workspace structure: - -.. image:: figures/build-workspace-directory.png - :align: center - :scale: 70% - -.. code-block:: none - - attic - A directory created if devtool believes it must preserve - anything when you run "devtool reset". For example, if you - run "devtool add", make changes to the recipe, and then - run "devtool reset", devtool takes notice that the file has - been changed and moves it into the attic should you still - want the recipe. - - README - Provides information on what is in workspace layer and how to - manage it. - - .devtool_md5 - A checksum file used by devtool. - - appends - A directory that contains *.bbappend files, which point to - external source. - - conf - A configuration directory that contains the layer.conf file. - - recipes - A directory containing recipes. This directory contains a - folder for each directory added whose name matches that of the - added recipe. devtool places the recipe.bb file - within that sub-directory. - - sources - A directory containing a working copy of the source files used - when building the recipe. This is the default directory used - as the location of the source tree when you do not provide a - source tree path. This directory contains a folder for each - set of source files matched to a corresponding recipe. - -.. _devtool-adding-a-new-recipe-to-the-workspace: - -Adding a New Recipe to the Workspace Layer -========================================== - -Use the ``devtool add`` command to add a new recipe to the workspace -layer. The recipe you add should not exist - ``devtool`` creates it for -you. The source files the recipe uses should exist in an external area. - -The following example creates and adds a new recipe named ``jackson`` to -a workspace layer the tool creates. The source code built by the recipes -resides in ``/home/user/sources/jackson``: -:: - - $ devtool add jackson /home/user/sources/jackson - -If you add a recipe and the workspace layer does not exist, the command -creates the layer and populates it as described in "`The Workspace Layer -Structure <#devtool-the-workspace-layer-structure>`__" section. - -Running ``devtool add`` when the workspace layer exists causes the tool -to add the recipe, append files, and source files into the existing -workspace layer. The ``.bbappend`` file is created to point to the -external source tree. - -.. note:: - - If your recipe has runtime dependencies defined, you must be sure - that these packages exist on the target hardware before attempting to - run your application. If dependent packages (e.g. libraries) do not - exist on the target, your application, when run, will fail to find - those functions. For more information, see the - ":ref:`ref-manual/ref-devtool-reference:deploying your software on the target machine`" - section. - -By default, ``devtool add`` uses the latest revision (i.e. master) when -unpacking files from a remote URI. In some cases, you might want to -specify a source revision by branch, tag, or commit hash. You can -specify these options when using the ``devtool add`` command: - -- To specify a source branch, use the ``--srcbranch`` option: - :: - - $ devtool add --srcbranch DISTRO_NAME_NO_CAP jackson /home/user/sources/jackson - - In the previous example, you are checking out the DISTRO_NAME_NO_CAP - branch. - -- To specify a specific tag or commit hash, use the ``--srcrev`` - option: - :: - - $ devtool add --srcrev DISTRO_REL_TAG jackson /home/user/sources/jackson - $ devtool add --srcrev some_commit_hash /home/user/sources/jackson - - The previous examples check out the - DISTRO_REL_TAG tag and the commit associated with the - some_commit_hash hash. - -.. note:: - - If you prefer to use the latest revision every time the recipe is - built, use the options ``--autorev`` or ``-a``. - -.. _devtool-extracting-the-source-for-an-existing-recipe: - -Extracting the Source for an Existing Recipe -============================================ - -Use the ``devtool extract`` command to extract the source for an -existing recipe. When you use this command, you must supply the root -name of the recipe (i.e. no version, paths, or extensions), and you must -supply the directory to which you want the source extracted. - -Additional command options let you control the name of a development -branch into which you can checkout the source and whether or not to keep -a temporary directory, which is useful for debugging. - -.. _devtool-synchronizing-a-recipes-extracted-source-tree: - -Synchronizing a Recipe's Extracted Source Tree -============================================== - -Use the ``devtool sync`` command to synchronize a previously extracted -source tree for an existing recipe. When you use this command, you must -supply the root name of the recipe (i.e. no version, paths, or -extensions), and you must supply the directory to which you want the -source extracted. - -Additional command options let you control the name of a development -branch into which you can checkout the source and whether or not to keep -a temporary directory, which is useful for debugging. - -.. _devtool-modifying-a-recipe: - -Modifying an Existing Recipe -============================ - -Use the ``devtool modify`` command to begin modifying the source of an -existing recipe. This command is very similar to the -:ref:`add ` command -except that it does not physically create the recipe in the workspace -layer because the recipe already exists in an another layer. - -The ``devtool modify`` command extracts the source for a recipe, sets it -up as a Git repository if the source had not already been fetched from -Git, checks out a branch for development, and applies any patches from -the recipe as commits on top. You can use the following command to -checkout the source files: -:: - - $ devtool modify recipe - -Using the above command form, ``devtool`` uses the existing recipe's -:term:`SRC_URI` statement to locate the upstream source, -extracts the source into the default sources location in the workspace. -The default development branch used is "devtool". - -.. _devtool-edit-an-existing-recipe: - -Edit an Existing Recipe -======================= - -Use the ``devtool edit-recipe`` command to run the default editor, which -is identified using the ``EDITOR`` variable, on the specified recipe. - -When you use the ``devtool edit-recipe`` command, you must supply the -root name of the recipe (i.e. no version, paths, or extensions). Also, -the recipe file itself must reside in the workspace as a result of the -``devtool add`` or ``devtool upgrade`` commands. However, you can -override that requirement by using the "-a" or "--any-recipe" option. -Using either of these options allows you to edit any recipe regardless -of its location. - -.. _devtool-updating-a-recipe: - -Updating a Recipe -================= - -Use the ``devtool update-recipe`` command to update your recipe with -patches that reflect changes you make to the source files. For example, -if you know you are going to work on some code, you could first use the -:ref:`devtool modify ` command to extract -the code and set up the workspace. After which, you could modify, -compile, and test the code. - -When you are satisfied with the results and you have committed your -changes to the Git repository, you can then run the -``devtool update-recipe`` to create the patches and update the recipe: -:: - - $ devtool update-recipe recipe - -If you run the ``devtool update-recipe`` -without committing your changes, the command ignores the changes. - -Often, you might want to apply customizations made to your software in -your own layer rather than apply them to the original recipe. If so, you -can use the ``-a`` or ``--append`` option with the -``devtool update-recipe`` command. These options allow you to specify -the layer into which to write an append file: -:: - - $ devtool update-recipe recipe -a base-layer-directory - -The ``*.bbappend`` file is created at the -appropriate path within the specified layer directory, which may or may -not be in your ``bblayers.conf`` file. If an append file already exists, -the command updates it appropriately. - -.. _devtool-checking-on-the-upgrade-status-of-a-recipe: - -Checking on the Upgrade Status of a Recipe -========================================== - -Upstream recipes change over time. Consequently, you might find that you -need to determine if you can upgrade a recipe to a newer version. - -To check on the upgrade status of a recipe, use the -``devtool check-upgrade-status`` command. The command displays a table -of your current recipe versions, the latest upstream versions, the email -address of the recipe's maintainer, and any additional information such -as commit hash strings and reasons you might not be able to upgrade a -particular recipe. - -.. note:: - - - For the ``oe-core`` layer, recipe maintainers come from the - :yocto_git:`maintainers.inc ` - file. - - - If the recipe is using the :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:git fetcher (\`\`git://\`\`)` - rather than a - tarball, the commit hash points to the commit that matches the - recipe's latest version tag. - -As with all ``devtool`` commands, you can get help on the individual -command: -:: - - $ devtool check-upgrade-status -h - NOTE: Starting bitbake server... - usage: devtool check-upgrade-status [-h] [--all] [recipe [recipe ...]] - - Prints a table of recipes together with versions currently provided by recipes, and latest upstream versions, when there is a later version available - - arguments: - recipe Name of the recipe to report (omit to report upgrade info for all recipes) - - options: - -h, --help show this help message and exit - --all, -a Show all recipes, not just recipes needing upgrade - -Unless you provide a specific recipe name on the command line, the -command checks all recipes in all configured layers. - -Following is a partial example table that reports on all the recipes. -Notice the reported reason for not upgrading the ``base-passwd`` recipe. -In this example, while a new version is available upstream, you do not -want to use it because the dependency on ``cdebconf`` is not easily -satisfied. - -.. note:: - - When a reason for not upgrading displays, the reason is usually - written into the recipe using the ``RECIPE_NO_UPDATE_REASON`` - variable. See the - :yocto_git:`base-passwd.bb ` - recipe for an example. - -:: - - $ devtool check-upgrade-status - ... - NOTE: acpid 2.0.30 2.0.31 Ross Burton - NOTE: u-boot-fw-utils 2018.11 2019.01 Marek Vasut d3689267f92c5956e09cc7d1baa4700141662bff - NOTE: u-boot-tools 2018.11 2019.01 Marek Vasut d3689267f92c5956e09cc7d1baa4700141662bff - . - . - . - NOTE: base-passwd 3.5.29 3.5.45 Anuj Mittal cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility - NOTE: busybox 1.29.2 1.30.0 Andrej Valek - NOTE: dbus-test 1.12.10 1.12.12 Chen Qi - -.. _devtool-upgrading-a-recipe: - -Upgrading a Recipe -================== - -As software matures, upstream recipes are upgraded to newer versions. As -a developer, you need to keep your local recipes up-to-date with the -upstream version releases. Several methods exist by which you can -upgrade recipes. You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`" -section of the Yocto Project Development Tasks Manual. This section -overviews the ``devtool upgrade`` command. - -Before you upgrade a recipe, you can check on its upgrade status. See -the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" section -for more information. - -The ``devtool upgrade`` command upgrades an existing recipe to a more -recent version of the recipe upstream. The command puts the upgraded -recipe file along with any associated files into a "workspace" and, if -necessary, extracts the source tree to a specified location. During the -upgrade, patches associated with the recipe are rebased or added as -needed. - -When you use the ``devtool upgrade`` command, you must supply the root -name of the recipe (i.e. no version, paths, or extensions), and you must -supply the directory to which you want the source extracted. Additional -command options let you control things such as the version number to -which you want to upgrade (i.e. the :term:`PV`), the source -revision to which you want to upgrade (i.e. the -:term:`SRCREV`), whether or not to apply patches, and so -forth. - -You can read more on the ``devtool upgrade`` workflow in the -":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" -section in the Yocto Project Application Development and the Extensible -Software Development Kit (eSDK) manual. You can also see an example of -how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``" -section in the Yocto Project Development Tasks Manual. - -.. _devtool-resetting-a-recipe: - -Resetting a Recipe -================== - -Use the ``devtool reset`` command to remove a recipe and its -configuration (e.g. the corresponding ``.bbappend`` file) from the -workspace layer. Realize that this command deletes the recipe and the -append file. The command does not physically move them for you. -Consequently, you must be sure to physically relocate your updated -recipe and the append file outside of the workspace layer before running -the ``devtool reset`` command. - -If the ``devtool reset`` command detects that the recipe or the append -files have been modified, the command preserves the modified files in a -separate "attic" subdirectory under the workspace layer. - -Here is an example that resets the workspace directory that contains the -``mtr`` recipe: -:: - - $ devtool reset mtr - NOTE: Cleaning sysroot for recipe mtr... - NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually - $ - -.. _devtool-building-your-recipe: - -Building Your Recipe -==================== - -Use the ``devtool build`` command to build your recipe. The -``devtool build`` command is equivalent to the -``bitbake -c populate_sysroot`` command. - -When you use the ``devtool build`` command, you must supply the root -name of the recipe (i.e. do not provide versions, paths, or extensions). -You can use either the "-s" or the "--disable-parallel-make" options to -disable parallel makes during the build. Here is an example: -:: - - $ devtool build recipe - -.. _devtool-building-your-image: - -Building Your Image -=================== - -Use the ``devtool build-image`` command to build an image, extending it -to include packages from recipes in the workspace. Using this command is -useful when you want an image that ready for immediate deployment onto a -device for testing. For proper integration into a final image, you need -to edit your custom image recipe appropriately. - -When you use the ``devtool build-image`` command, you must supply the -name of the image. This command has no command line options: -:: - - $ devtool build-image image - -.. _devtool-deploying-your-software-on-the-target-machine: - -Deploying Your Software on the Target Machine -============================================= - -Use the ``devtool deploy-target`` command to deploy the recipe's build -output to the live target machine: -:: - - $ devtool deploy-target recipe target - -The target is the address of the target machine, which must be running -an SSH server (i.e. ``user@hostname[:destdir]``). - -This command deploys all files installed during the -:ref:`ref-tasks-install` task. Furthermore, you do not -need to have package management enabled within the target machine. If -you do, the package manager is bypassed. - -.. note:: - - The ``deploy-target`` functionality is for development only. You - should never use it to update an image that will be used in - production. - -Some conditions exist that could prevent a deployed application from -behaving as expected. When both of the following conditions exist, your -application has the potential to not behave correctly when run on the -target: - -- You are deploying a new application to the target and the recipe you - used to build the application had correctly defined runtime - dependencies. - -- The target does not physically have the packages on which the - application depends installed. - -If both of these conditions exist, your application will not behave as -expected. The reason for this misbehavior is because the -``devtool deploy-target`` command does not deploy the packages (e.g. -libraries) on which your new application depends. The assumption is that -the packages are already on the target. Consequently, when a runtime -call is made in the application for a dependent function (e.g. a library -call), the function cannot be found. - -To be sure you have all the dependencies local to the target, you need -to be sure that the packages are pre-deployed (installed) on the target -before attempting to run your application. - -.. _devtool-removing-your-software-from-the-target-machine: - -Removing Your Software from the Target Machine -============================================== - -Use the ``devtool undeploy-target`` command to remove deployed build -output from the target machine. For the ``devtool undeploy-target`` -command to work, you must have previously used the -":ref:`devtool deploy-target `" -command. -:: - - $ devtool undeploy-target recipe target - -The target is the -address of the target machine, which must be running an SSH server (i.e. -``user@hostname``). - -.. _devtool-creating-the-workspace: - -Creating the Workspace Layer in an Alternative Location -======================================================= - -Use the ``devtool create-workspace`` command to create a new workspace -layer in your :term:`Build Directory`. When you create a -new workspace layer, it is populated with the ``README`` file and the -``conf`` directory only. - -The following example creates a new workspace layer in your current -working and by default names the workspace layer "workspace": -:: - - $ devtool create-workspace - -You can create a workspace layer anywhere by supplying a pathname with -the command. The following command creates a new workspace layer named -"new-workspace": -:: - - $ devtool create-workspace /home/scottrif/new-workspace - -.. _devtool-get-the-status-of-the-recipes-in-your-workspace: - -Get the Status of the Recipes in Your Workspace -=============================================== - -Use the ``devtool status`` command to list the recipes currently in your -workspace. Information includes the paths to their respective external -source trees. - -The ``devtool status`` command has no command-line options: -:: - - $ devtool status - -Following is sample output after using -:ref:`devtool add ` -to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory: -:: - - $ devtool status - mtr:/home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb) - $ - -.. _devtool-search-for-available-target-recipes: - -Search for Available Target Recipes -=================================== - -Use the ``devtool search`` command to search for available target -recipes. The command matches the recipe name, package name, description, -and installed files. The command displays the recipe name as a result of -a match. - -When you use the ``devtool search`` command, you must supply a keyword. -The command uses the keyword when searching for a match. diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst deleted file mode 100644 index 89c06eb65f..0000000000 --- a/documentation/ref-manual/ref-features.rst +++ /dev/null @@ -1,350 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -******** -Features -******** - -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. - -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 ``DISTRO_FEATURES`` variable, -which is set or appended to in a distribution's configuration file such -as ``poky.conf``, ``poky-tiny.conf``, ``poky-lsb.conf`` and so forth. -Machine features are set in the ``MACHINE_FEATURES`` variable, which is -set in the machine configuration file and specifies the hardware -features for a given machine. - -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. - -One method you can use to determine which recipes are checking to see if -a particular feature is contained or not is to ``grep`` through the -:term:`Metadata` for the feature. Here is an example that -discovers the recipes whose build is potentially changed based on a -given feature: -:: - - $ cd poky - $ git grep 'contains.*MACHINE_FEATURES.*feature' - -.. _ref-features-machine: - -Machine Features -================ - -The items below are features you can use with -:term:`MACHINE_FEATURES`. 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 :ref:`ref-tasks-configure` task -for a particular recipe. - -This feature list only represents features as shipped with the Yocto -Project metadata: - -- *acpi:* Hardware has ACPI (x86/x86_64 only) - -- *alsa:* Hardware has ALSA audio drivers - -- *apm:* Hardware uses APM (or APM emulation) - -- *bluetooth:* Hardware has integrated BT - -- *efi:* Support for booting through EFI - -- *ext2:* Hardware HDD or Microdrive - -- *keyboard:* Hardware has a keyboard - -- *pcbios:* Support for booting through BIOS - -- *pci:* Hardware has a PCI bus - -- *pcmcia:* Hardware has PCMCIA or CompactFlash sockets - -- *phone:* Mobile phone (voice) support - -- *qvga:* Machine has a QVGA (320x240) display - -- *rtc:* Machine has a Real-Time Clock - -- *screen:* Hardware has a screen - -- *serial:* Hardware has serial support (usually RS232) - -- *touchscreen:* Hardware has a touchscreen - -- *usbgadget:* Hardware is USB gadget device capable - -- *usbhost:* Hardware is USB Host capable - -- *vfat:* FAT file system support - -- *wifi:* Hardware has integrated WiFi - -.. _ref-features-distro: - -Distro Features -=============== - -The items below are features you can use with -:term:`DISTRO_FEATURES` 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 :ref:`ref-tasks-configure` task for -the recipes that optionally support the feature. - -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 -:term:`COMBINED_FEATURES` variable for more -information. - -This list only represents features as shipped with the Yocto Project -metadata: - -- *alsa:* Include ALSA support (OSS compatibility kernel modules - installed if available). - -- *api-documentation:* Enables generation of API documentation during - recipe builds. The resulting documentation is added to SDK tarballs - when the ``bitbake -c populate_sdk`` command is used. See the - ":ref:`sdk-manual/appendix-customizing-standard:adding api documentation to the standard sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - -- *bluetooth:* Include bluetooth support (integrated BT only). - -- *cramfs:* Include CramFS support. - -- *directfb:* Include DirectFB support. - -- *ext2:* Include tools for supporting for devices with internal - HDD/Microdrive for storing files (instead of Flash only devices). - -- *ipsec:* Include IPSec support. - -- *ipv6:* Include IPv6 support. - -- *keyboard:* Include keyboard support (e.g. keymaps will be loaded - during boot). - -- *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the - target. - -- *nfs:* Include NFS client support (for mounting NFS exports on - device). - -- *opengl:* Include the Open Graphics Library, which is a - cross-language, multi-platform application programming interface used - for rendering two and three-dimensional graphics. - -- *pci:* Include PCI bus support. - -- *pcmcia:* Include PCMCIA/CompactFlash support. - -- *ppp:* Include PPP dialup support. - -- *ptest:* Enables building the package tests where supported by - individual recipes. For more information on package tests, see the - ":ref:`dev-manual/common-tasks:testing packages with ptest`" section - in the Yocto Project Development Tasks Manual. - -- *smbfs:* Include SMB networks client support (for mounting - Samba/Microsoft Windows shares on device). - -- *systemd:* Include support for this ``init`` manager, which is a full - replacement of for ``init`` with parallel starting of services, - reduced shell overhead, and other features. This ``init`` manager is - used by many distributions. - -- *usbgadget:* Include USB Gadget Device support (for USB - networking/serial/storage). - -- *usbhost:* Include USB Host support (allows to connect external - keyboard, mouse, storage, network etc). - -- *usrmerge:* Merges the ``/bin``, ``/sbin``, ``/lib``, and ``/lib64`` - directories into their respective counterparts in the ``/usr`` - directory to provide better package and application compatibility. - -- *wayland:* Include the Wayland display server protocol and the - library that supports it. - -- *wifi:* Include WiFi support (integrated only). - -- *x11:* Include the X server and libraries. - -.. _ref-features-image: - -Image Features -============== - -The contents of images generated by the OpenEmbedded build system can be -controlled by the :term:`IMAGE_FEATURES` and -:term:`EXTRA_IMAGE_FEATURES` 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. - -The following image features are available for all images: - -- *allow-empty-password:* Allows Dropbear and OpenSSH to accept root - logins and logins from accounts having an empty password string. - -- *dbg-pkgs:* Installs debug symbol packages for all packages installed - in a given image. - -- *debug-tweaks:* 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. - -- *dev-pkgs:* Installs development packages (headers and extra library - links) for all packages installed in a given image. - -- *doc-pkgs:* Installs documentation packages for all packages - installed in a given image. - -- *empty-root-password:* Sets the root password to an empty string, - which allows logins with a blank password. - -- *package-management:* Installs package management tools and preserves - the package manager database. - -- *post-install-logging:* Enables logging postinstall script runs to - the ``/var/log/postinstall.log`` file on first boot of the image on - the target system. - - .. note:: - - To make the ``/var/log`` directory on the target persistent, use the - :term:`VOLATILE_LOG_DIR` variable by setting it to "no". - -- *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes. - -- *read-only-rootfs:* Creates an image whose root filesystem is - read-only. See the - ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" - section in the Yocto Project Development Tasks Manual for more - information. - -- *splash:* Enables showing a splash screen during boot. By default, - this screen is provided by ``psplash``, which does allow - customization. If you prefer to use an alternative splash screen - package, you can do so by setting the ``SPLASH`` variable to a - different package name (or names) within the image recipe or at the - distro configuration level. - -- *staticdev-pkgs:* Installs static development packages, which are - static libraries (i.e. ``*.a`` files), for all packages installed in - a given image. - -Some image features are available only when you inherit the -:ref:`core-image ` class. The current list of -these valid features is as follows: - -- *hwcodecs:* Installs hardware acceleration codecs. - -- *nfs-server:* Installs an NFS server. - -- *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and - ``LTTng``. For general information on user-space tools, see the - :doc:`/sdk-manual/index` manual. - -- *ssh-server-dropbear:* Installs the Dropbear minimal SSH server. - -- *ssh-server-openssh:* 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 - ``IMAGE_FEATURES``, then OpenSSH will take precedence and Dropbear - will not be installed. - -- *tools-debug:* Installs debugging tools such as ``strace`` and - ``gdb``. For information on GDB, see the - ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section - in the Yocto Project Development Tasks Manual. For information on - tracing and profiling, see the :doc:`/profile-manual/index`. - -- *tools-sdk:* Installs a full SDK that runs on the device. - -- *tools-testapps:* Installs device testing tools (e.g. touchscreen - debugging). - -- *x11:* Installs the X server. - -- *x11-base:* Installs the X server with a minimal environment. - -- *x11-sato:* Installs the OpenedHand Sato environment. - -.. _ref-features-backfill: - -Feature Backfilling -=================== - -Sometimes it is necessary in the OpenEmbedded build system to extend -:term:`MACHINE_FEATURES` or -:term:`DISTRO_FEATURES` 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 -:term:`DISTRO_FEATURES_BACKFILL` and -:term:`MACHINE_FEATURES_BACKFILL` -variables in the ``meta/conf/bitbake.conf`` file. - -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 -:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` -or -:term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` -variables for distro features and machine features respectively. - -Here are two examples to help illustrate feature backfilling: - -- *The "pulseaudio" distro feature option*: 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 ``DISTRO_FEATURES_BACKFILL`` variable in the - ``meta/conf/bitbake.conf`` 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 ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` in - your distro's ``.conf`` file. Adding the feature to this variable - when it also exists in the ``DISTRO_FEATURES_BACKFILL`` variable - prevents the build system from adding the feature to your - configuration's ``DISTRO_FEATURES``, effectively disabling the - feature for that particular distro. - -- *The "rtc" machine feature option*: 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 - ``MACHINE_FEATURES_BACKFILL`` variable in the - ``meta/conf/bitbake.conf`` 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 ``MACHINE_FEATURES_BACKFILL_CONSIDERED`` - list in the machine's ``.conf`` file. Adding the feature to this - variable when it also exists in the ``MACHINE_FEATURES_BACKFILL`` - variable prevents the build system from adding the feature to your - configuration's ``MACHINE_FEATURES``, effectively disabling RTC - support for that particular machine. diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst deleted file mode 100644 index 5e9374eae7..0000000000 --- a/documentation/ref-manual/ref-images.rst +++ /dev/null @@ -1,138 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -****** -Images -****** - -The OpenEmbedded build system provides several example images to satisfy -different needs. When you issue the ``bitbake`` command you provide a -"top-level" recipe that essentially begins the build for the type of -image you want. - -.. 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 ``local.conf`` - file before using the BitBake command to build the minimal or base - image: - :: - - 1. Comment out the EXTRA_IMAGE_FEATURES line - 2. Set INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" - - -From within the ``poky`` Git repository, you can use the following -command to display the list of directories within the :term:`Source Directory` -that contain image recipe files: :: - - $ ls meta*/recipes*/images/*.bb - -Following is a list of supported recipes: - -- ``build-appliance-image``: 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 `VMware - Player `__ or - `VMware - Workstation `__. - For more information on this image, see the :yocto_home:`Build - Appliance ` page - on the Yocto Project website. - -- ``core-image-base``: A console-only image that fully supports the - target device hardware. - -- ``core-image-clutter``: An image with support for the Open GL-based - toolkit Clutter, which enables development of rich and animated - graphical user interfaces. - -- ``core-image-full-cmdline``: A console-only image with more - full-featured Linux system functionality installed. - -- ``core-image-lsb``: An image that conforms to the Linux Standard Base - (LSB) specification. This image requires a distribution configuration - that enables LSB compliance (e.g. ``poky-lsb``). If you build - ``core-image-lsb`` without that configuration, the image will not be - LSB-compliant. - -- ``core-image-lsb-dev``: A ``core-image-lsb`` 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. ``poky-lsb``). If you build ``core-image-lsb-dev`` without that - configuration, the image will not be LSB-compliant. - -- ``core-image-lsb-sdk``: A ``core-image-lsb`` 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. - ``poky-lsb``). If you build ``core-image-lsb-sdk`` without that - configuration, the image will not be LSB-compliant. This image is - suitable for development using the target. - -- ``core-image-minimal``: A small image just capable of allowing a - device to boot. - -- ``core-image-minimal-dev``: A ``core-image-minimal`` image suitable - for development work using the host. The image includes headers and - libraries you can use in a host development environment. - -- ``core-image-minimal-initramfs``: A ``core-image-minimal`` 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 - :term:`PACKAGE_INSTALL` variable for - additional information helpful when working with initramfs images. - -- ``core-image-minimal-mtdutils``: A ``core-image-minimal`` 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. - -- ``core-image-rt``: A ``core-image-minimal`` image plus a real-time - test suite and tools appropriate for real-time use. - -- ``core-image-rt-sdk``: A ``core-image-rt`` 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. - -- ``core-image-sato``: 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. - -- ``core-image-sato-dev``: A ``core-image-sato`` 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 ``core-image-sdk``. - -- ``core-image-sato-sdk``: A ``core-image-sato`` 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. - -- ``core-image-testmaster``: 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 - ":ref:`dev-manual/common-tasks:performing automated runtime testing`" - section in the Yocto Project Development Tasks Manual. - -- ``core-image-testmaster-initramfs``: A RAM-based Initial Root - Filesystem (initramfs) image tailored for use with the - ``core-image-testmaster`` image. - -- ``core-image-weston``: 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 - ":ref:`dev-manual/common-tasks:using wayland and weston`" - section in the Yocto Project Development Tasks Manual. - -- ``core-image-x11``: A very basic X11 image with a terminal. diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst deleted file mode 100644 index bb9c0460f3..0000000000 --- a/documentation/ref-manual/ref-kickstart.rst +++ /dev/null @@ -1,216 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -******************************************* -OpenEmbedded Kickstart (``.wks``) Reference -******************************************* - -.. _openembedded-kickstart-wks-reference: - -Introduction -============ - -The current Wic implementation supports only the basic kickstart -partitioning commands: ``partition`` (or ``part`` for short) and -``bootloader``. - -.. note:: - - Future updates will implement more commands and options. If you use - anything that is not specifically supported, results can be - unpredictable. - -This chapter provides a reference on the available kickstart commands. -The information lists the commands, their syntax, and meanings. -Kickstart commands are based on the Fedora kickstart versions but with -modifications to reflect Wic capabilities. You can see the original -documentation for those commands at the following link: -http://pykickstart.readthedocs.io/en/latest/kickstart-docs.html - -Command: part or partition -========================== - -Either of these commands creates a partition on the system and uses the -following syntax: -:: - - part [mntpoint] - partition [mntpoint] - -If you do not -provide mntpoint, Wic creates a partition but does not mount it. - -The ``mntpoint`` is where the partition is mounted and must be in one of -the following forms: - -- ``/path``: For example, "/", "/usr", or "/home" - -- ``swap``: The created partition is used as swap space - -Specifying a mntpoint causes the partition to automatically be mounted. -Wic achieves this by adding entries to the filesystem table (fstab) -during image generation. In order for Wic to generate a valid fstab, you -must also provide one of the ``--ondrive``, ``--ondisk``, or -``--use-uuid`` partition options as part of the command. - -.. note:: - - The mount program must understand the PARTUUID syntax you use with - ``--use-uuid`` and non-root *mountpoint*, including swap. The busybox - versions of these application are currently excluded. - -Here is an example that uses "/" as the mountpoint. The command uses -``--ondisk`` to force the partition onto the ``sdb`` disk: -:: - - part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 - -Here is a list that describes other supported options you can use with -the ``part`` and ``partition`` commands: - -- ``--size``: The minimum partition size in MBytes. Specify an - integer value such as 500. Do not append the number with "MB". You do - not need this option if you use ``--source``. - -- ``--fixed-size``: The exact partition size in MBytes. You cannot - specify with ``--size``. An error occurs when assembling the disk - image if the partition data is larger than ``--fixed-size``. - -- ``--source``: This option is a Wic-specific option that names the - source of the data that populates the partition. The most common - value for this option is "rootfs", but you can use any value that - maps to a valid source plugin. For information on the source plugins, - see the ":ref:`dev-manual/common-tasks:using the wic plugin interface`" - section in the Yocto Project Development Tasks Manual. - - If you use ``--source rootfs``, Wic creates a partition as large as - needed and fills it with the contents of the root filesystem pointed - to by the ``-r`` command-line option or the equivalent rootfs derived - from the ``-e`` command-line option. The filesystem type used to - create the partition is driven by the value of the ``--fstype`` - option specified for the partition. See the entry on ``--fstype`` - that follows for more information. - - If you use ``--source plugin-name``, Wic creates a partition as large - as needed and fills it with the contents of the partition that is - generated by the specified plugin name using the data pointed to by - the ``-r`` command-line option or the equivalent rootfs derived from - the ``-e`` command-line option. Exactly what those contents are and - filesystem type used are dependent on the given plugin - implementation. - - If you do not use the ``--source`` option, the ``wic`` command - creates an empty partition. Consequently, you must use the ``--size`` - option to specify the size of the empty partition. - -- ``--ondisk`` or ``--ondrive``: Forces the partition to be created - on a particular disk. - -- ``--fstype``: Sets the file system type for the partition. Valid - values are: - - - ``ext4`` - - - ``ext3`` - - - ``ext2`` - - - ``btrfs`` - - - ``squashfs`` - - - ``swap`` - -- ``--fsoptions``: Specifies a free-form string of options to be used - when mounting the filesystem. This string is copied into the - ``/etc/fstab`` file of the installed system and should be enclosed in - quotes. If not specified, the default string is "defaults". - -- ``--label label``: Specifies the label to give to the filesystem to - be made on the partition. If the given label is already in use by - another filesystem, a new label is created for the partition. - -- ``--active``: Marks the partition as active. - -- ``--align (in KBytes)``: This option is a Wic-specific option that - says to start partitions on boundaries given x KBytes. - -- ``--offset (in KBytes)``: This option is a Wic-specific option that - says to place a partition at exactly the specified offset. If the - partition cannot be placed at the specified offset, the image build - will fail. - -- ``--no-table``: This option is a Wic-specific option. Using the - option reserves space for the partition and causes it to become - populated. However, the partition is not added to the partition - table. - -- ``--exclude-path``: This option is a Wic-specific option that - excludes the given relative path from the resulting image. This - option is only effective with the rootfs source plugin. - -- ``--extra-space``: This option is a Wic-specific option that adds - extra space after the space filled by the content of the partition. - The final size can exceed the size specified by the ``--size`` - option. The default value is 10 Mbytes. - -- ``--overhead-factor``: This option is a Wic-specific option that - multiplies the size of the partition by the option's value. You must - supply a value greater than or equal to "1". The default value is - "1.3". - -- ``--part-name``: This option is a Wic-specific option that - specifies a name for GPT partitions. - -- ``--part-type``: This option is a Wic-specific option that - specifies the partition type globally unique identifier (GUID) for - GPT partitions. You can find the list of partition type GUIDs at - http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. - -- ``--use-uuid``: This option is a Wic-specific option that causes - Wic to generate a random GUID for the partition. The generated - identifier is used in the bootloader configuration to specify the - root partition. - -- ``--uuid``: This option is a Wic-specific option that specifies the - partition UUID. - -- ``--fsuuid``: This option is a Wic-specific option that specifies - the filesystem UUID. You can generate or modify - :term:`WKS_FILE` with this option if a preconfigured - filesystem UUID is added to the kernel command line in the bootloader - configuration before you run Wic. - -- ``--system-id``: This option is a Wic-specific option that - specifies the partition system ID, which is a one byte long, - hexadecimal parameter with or without the 0x prefix. - -- ``--mkfs-extraopts``: This option specifies additional options to - pass to the ``mkfs`` utility. Some default options for certain - filesystems do not take effect. See Wic's help on kickstart (i.e. - ``wic help kickstart``). - -Command: bootloader -=================== - -This command specifies how the bootloader should be configured and -supports the following options: - -.. note:: - - Bootloader functionality and boot partitions are implemented by the - various - --source - plugins that implement bootloader functionality. The bootloader - command essentially provides a means of modifying bootloader - configuration. - -- ``--timeout``: Specifies the number of seconds before the - bootloader times out and boots the default option. - -- ``--append``: Specifies kernel parameters. These parameters will be - added to the syslinux ``APPEND`` or ``grub`` kernel command line. - -- ``--configfile``: Specifies a user-defined configuration file for - the bootloader. You can provide a full pathname for the file or a - file that exists in the ``canned-wks`` folder. This option overrides - all other bootloader options. diff --git a/documentation/ref-manual/ref-qa-checks.rst b/documentation/ref-manual/ref-qa-checks.rst deleted file mode 100644 index 54977dcb21..0000000000 --- a/documentation/ref-manual/ref-qa-checks.rst +++ /dev/null @@ -1,761 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -***************************** -QA Error and Warning Messages -***************************** - -.. _qa-introduction: - -Introduction -============ - -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. - -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. - -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:: - - - At the end of each message, the name of the associated QA test (as - listed in the ":ref:`insane.bbclass `" - section) appears within square brackets. - - - 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. - - - Because some QA checks are disabled by default, this list does not - include all possible QA check errors and warnings. - -.. _qa-errors-and-warnings: - -Errors and Warnings -=================== - -.. _qa-check-libexec: - -- ``: is using libexec please relocate to [libexec]`` - - The specified package contains files in ``/usr/libexec`` when the - distro configuration uses a different path for ```` By - default, ```` is ``$prefix/libexec``. However, this - default can be changed (e.g. ``${libdir}``). - -   -.. _qa-check-rpaths: - -- ``package contains bad RPATH in file [rpaths]`` - - The specified binary produced by the recipe contains dynamic library - load paths (rpaths) that contain build system paths such as - :term:`TMPDIR`, which are incorrect for the target and - could potentially be a security issue. Check for bad ``-rpath`` - options being passed to the linker in your - :ref:`ref-tasks-compile` 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. - -   -.. _qa-check-useless-rpaths: - -- ``: contains probably-redundant RPATH [useless-rpaths]`` - - 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. ``/lib`` and ``/usr/lib``). 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. - -   -.. _qa-check-file-rdeps: - -- `` requires , but no providers in its RDEPENDS [file-rdeps]`` - - A file-level dependency has been identified from the specified - package on the specified files, but there is no explicit - corresponding entry in :term:`RDEPENDS`. If - particular files are required at runtime then ``RDEPENDS`` should be - declared in the recipe to ensure the packages providing them are - built. - -   -.. _qa-check-build-deps: - -- `` rdepends on , but it isn't a build dependency? [build-deps]`` - - 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 - :term:`RDEPENDS` 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 ``RDEPENDS`` for the dependency. - -   -.. _qa-check-dev-so: - -- ``non -dev/-dbg/nativesdk- package contains symlink .so: path '' [dev-so]`` - - Symlink ``.so`` files are for development only, and should therefore - go into the ``-dev`` package. This situation might occur if you add - ``*.so*`` rather than ``*.so.*`` to a non-dev package. Change - :term:`FILES` (and possibly - :term:`PACKAGES`) such that the specified ``.so`` - file goes into an appropriate ``-dev`` package. - -   -.. _qa-check-staticdev: - -- ``non -staticdev package contains static .a library: path '' [staticdev]`` - - Static ``.a`` library files should go into a ``-staticdev`` package. - Change :term:`FILES` (and possibly - :term:`PACKAGES`) such that the specified ``.a`` file - goes into an appropriate ``-staticdev`` package. - -   -.. _qa-check-libdir: - -- ``: found library in wrong location [libdir]`` - - The specified file may have been installed into an incorrect - (possibly hardcoded) installation path. For example, this test will - catch recipes that install ``/lib/bar.so`` when ``${base_libdir}`` is - "lib32". Another example is when recipes install - ``/usr/lib64/foo.so`` when ``${libdir}`` is "/usr/lib". False - positives occasionally exist. For these cases add "libdir" to - :term:`INSANE_SKIP` for the package. - -   -.. _qa-check-debug-files: - -- ``non debug package contains .debug directory: path [debug-files]`` - - The specified package contains a ``.debug`` directory, which should - not appear in anything but the ``-dbg`` package. This situation might - occur if you add a path which contains a ``.debug`` directory and do - not explicitly add the ``.debug`` directory to the ``-dbg`` package. - If this is the case, add the ``.debug`` directory explicitly to - ``FILES_${PN}-dbg``. See :term:`FILES` for additional - information on ``FILES``. - -   -.. _qa-check-arch: - -- ``Architecture did not match (, expected ) in [arch]`` - - 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 - :term:`INSANE_SKIP` for the package. Another - option is to check the :ref:`ref-tasks-compile` log - and verify that the compiler options being used are correct. - -   - -- ``Bit size did not match (, expected ) in [arch]`` - - 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 - :term:`INSANE_SKIP` for the package. Another - option is to check the :ref:`ref-tasks-compile` log - and verify that the compiler options being used are correct. - -   - -- ``Endianness did not match (, expected ) in [arch]`` - - 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 - :term:`INSANE_SKIP` for the package. Another - option is to check the :ref:`ref-tasks-compile` log - and verify that the compiler options being used are correct. - -   -.. _qa-check-textrel: - -- ``ELF binary '' has relocations in .text [textrel]`` - - The specified ELF binary contains relocations in its ``.text`` - sections. This situation can result in a performance impact at - runtime. - - 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 :term:`CFLAGS` when you build it, - you could add the following to your recipe: - :: - - CFLAGS_append = " -fPIC " - - For more information on text relocations at runtime, see - http://www.akkadia.org/drepper/textrelocs.html. - -   -.. _qa-check-ldflags: - -- ``File '' in package '' doesn't have GNU_HASH (didn't pass LDFLAGS?) [ldflags]`` - - This indicates that binaries produced when building the recipe have - not been linked with the :term:`LDFLAGS` options - provided by the build system. Check to be sure that the ``LDFLAGS`` - variable is being passed to the linker command. A common workaround - for this situation is to pass in ``LDFLAGS`` using - :term:`TARGET_CC_ARCH` within the recipe as - follows: - :: - - TARGET_CC_ARCH += "${LDFLAGS}" - -   -.. _qa-check-xorg-driver-abi: - -- ``Package contains Xorg driver () but no xorg-abi- dependencies [xorg-driver-abi]`` - - 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 ``xorg-driver-input.inc`` or ``xorg-driver-video.inc`` will - automatically get these versions. Consequently, you should only need - to explicitly add dependencies to binary driver recipes. - -   -.. _qa-check-infodir: - -- ``The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir]`` - - The ``/usr/share/info/dir`` should not be packaged. Add the following - line to your :ref:`ref-tasks-install` task or to your - ``do_install_append`` within the recipe as follows: - :: - - rm ${D}${infodir}/dir -   - -.. _qa-check-symlink-to-sysroot: - -- ``Symlink in points to TMPDIR [symlink-to-sysroot]`` - - The specified symlink points into :term:`TMPDIR` 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. - -   -.. _qa-check-la: - -- `` failed sanity test (workdir) in path [la]`` - - The specified ``.la`` file contains :term:`TMPDIR` - paths. Any ``.la`` file containing these paths is incorrect since - ``libtool`` adds the correct sysroot prefix when using the files - automatically itself. - -   -.. _qa-check-pkgconfig: - -- `` failed sanity test (tmpdir) in path [pkgconfig]`` - - The specified ``.pc`` file contains - :term:`TMPDIR`\ ``/``\ :term:`WORKDIR` - paths. Any ``.pc`` file containing these paths is incorrect since - ``pkg-config`` itself adds the correct sysroot prefix when the files - are accessed. - -   -.. _qa-check-debug-deps: - -- `` rdepends on [debug-deps]`` - - A dependency exists between the specified non-dbg package (i.e. a - package whose name does not end in ``-dbg``) and a package that is a - ``dbg`` package. The ``dbg`` packages contain debug symbols and are - brought in using several different methods: - - - Using the ``dbg-pkgs`` - :term:`IMAGE_FEATURES` value. - - - Using :term:`IMAGE_INSTALL`. - - - As a dependency of another ``dbg`` package that was brought in - using one of the above methods. - - The dependency might have been automatically added because the - ``dbg`` package erroneously contains files that it should not contain - (e.g. a non-symlink ``.so`` file) or it might have been added - manually (e.g. by adding to :term:`RDEPENDS`). - -   -.. _qa-check-dev-deps: - -- `` rdepends on [dev-deps]`` - - A dependency exists between the specified non-dev package (a package - whose name does not end in ``-dev``) and a package that is a ``dev`` - package. The ``dev`` packages contain development headers and are - usually brought in using several different methods: - - - Using the ``dev-pkgs`` - :term:`IMAGE_FEATURES` value. - - - Using :term:`IMAGE_INSTALL`. - - - As a dependency of another ``dev`` package that was brought in - using one of the above methods. - - The dependency might have been automatically added (because the - ``dev`` package erroneously contains files that it should not have - (e.g. a non-symlink ``.so`` file) or it might have been added - manually (e.g. by adding to :term:`RDEPENDS`). - -   -.. _qa-check-dep-cmp: - -- ``_ is invalid: () only comparisons <, =, >, <=, and >= are allowed [dep-cmp]`` - - If you are adding a versioned dependency relationship to one of the - dependency variables (:term:`RDEPENDS`, - :term:`RRECOMMENDS`, - :term:`RSUGGESTS`, - :term:`RPROVIDES`, - :term:`RREPLACES`, or - :term:`RCONFLICTS`), you must only use the named - comparison operators. Change the versioned dependency values you are - adding to match those listed in the message. - -   -.. _qa-check-compile-host-path: - -- ``: The compile log indicates that host include and/or library paths were used. Please check the log '' for more information. [compile-host-path]`` - - The log for the :ref:`ref-tasks-compile` 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. - -   -.. _qa-check-install-host-path: - -- ``: The install log indicates that host include and/or library paths were used. Please check the log '' for more information. [install-host-path]`` - - The log for the :ref:`ref-tasks-install` 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. - -   -.. _qa-check-configure-unsafe: - -- ``This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. [configure-unsafe]`` - - The log for the :ref:`ref-tasks-configure` 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. - -   -.. _qa-check-pkgname: - -- `` doesn't match the [a-z0-9.+-]+ regex [pkgname]`` - - 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 - :term:`PACKAGES` 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 ``PACKAGES``, - change the package name appropriately. - -   -.. _qa-check-unknown-configure-option: - -- ``: configure was passed unrecognized options: [unknown-configure-option]`` - - 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 ``./configure --help`` output, and - the upstream change log or release notes. Once you have worked out - what the appropriate change is, you can update - :term:`EXTRA_OECONF`, - :term:`PACKAGECONFIG_CONFARGS`, or the - individual :term:`PACKAGECONFIG` option values - accordingly. - -   -.. _qa-check-pn-overrides: - -- ``Recipe has PN of "" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides]`` - - The specified recipe has a name (:term:`PN`) value that - appears in :term:`OVERRIDES`. If a recipe is named - such that its ``PN`` value matches something already in ``OVERRIDES`` - (e.g. ``PN`` happens to be the same as :term:`MACHINE` - or :term:`DISTRO`), it can have unexpected - consequences. For example, assignments such as - ``FILES_${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``. - Rename your recipe (or if ``PN`` is being set explicitly, change the - ``PN`` value) so that the conflict does not occur. See - :term:`FILES` for additional information. - -   -.. _qa-check-pkgvarcheck: - -- ``: Variable is set as not being package specific, please fix this. [pkgvarcheck]`` - - Certain variables (:term:`RDEPENDS`, - :term:`RRECOMMENDS`, - :term:`RSUGGESTS`, - :term:`RCONFLICTS`, - :term:`RPROVIDES`, - :term:`RREPLACES`, :term:`FILES`, - ``pkg_preinst``, ``pkg_postinst``, ``pkg_prerm``, ``pkg_postrm``, and - :term:`ALLOW_EMPTY`) should always be set specific - to a package (i.e. they should be set with a package name override - such as ``RDEPENDS_${PN} = "value"`` rather than - ``RDEPENDS = "value"``). If you receive this error, correct any - assignments to these variables within your recipe. - - -- ``recipe uses DEPENDS_${PN}, should use DEPENDS [pkgvarcheck]`` - - This check looks for instances of setting ``DEPENDS_${PN}`` - which is erroneous (:term:`DEPENDS` is a recipe-wide variable and thus - it is not correct to specify it for a particular package, nor will such - an assignment actually work.) Set ``DEPENDS`` instead. - - -.. _qa-check-already-stripped: - -- ``File '' from was already stripped, this will prevent future debugging! [already-stripped]`` - - 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 ``-dbg`` packages, - this stripping must be disabled. - - 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 ``-dbg`` package, it will then - strip the symbols from the binaries. - -   -.. _qa-check-packages-list: - -- `` is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list]`` - - Package names must appear only once in the - :term:`PACKAGES` variable. You might receive this - error if you are attempting to add a package to ``PACKAGES`` that is - already in the variable's value. - -   -.. _qa-check-files-invalid: - -- ``FILES variable for package contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid]`` - - The string "//" is invalid in a Unix path. Correct all occurrences - where this string appears in a :term:`FILES` variable so - that there is only a single "/". - -   -.. _qa-check-installed-vs-shipped: - -- ``: Files/directories were installed but not shipped in any package [installed-vs-shipped]`` - - Files have been installed within the - :ref:`ref-tasks-install` task but have not been - included in any package by way of the :term:`FILES` - 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: - - - Add the files to ``FILES`` for the package you want them to appear - in (e.g. ``FILES_${``\ :term:`PN`\ ``}`` for the main - package). - - - Delete the files at the end of the ``do_install`` task if the - files are not needed in any package. - -   - -- ``- was registered as shlib provider for , changing it to - because it was built later`` - - This message means that both ```` and ```` - 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 ``.so`` file name to - :term:`PRIVATE_LIBS` in the recipe that provides - the private version of the library. - - -.. _qa-check-unlisted-pkg-lics: - -- ``LICENSE_ includes licenses () that are not listed in LICENSE [unlisted-pkg-lics]`` - - The :term:`LICENSE` of the recipe should be a superset - of all the licenses of all packages produced by this recipe. In other - words, any license in ``LICENSE_*`` should also appear in - :term:`LICENSE`. - - -.. _qa-check-configure-gettext: - -- ``AM_GNU_GETTEXT used but no inherit gettext [configure-gettext]`` - - If a recipe is building something that uses automake and the automake - files contain an ``AM_GNU_GETTEXT`` directive then this check will fail - if there is no ``inherit gettext`` statement in the recipe to ensure - that gettext is available during the build. Add ``inherit gettext`` to - remove the warning. - - -.. _qa-check-mime: - -- ``package contains mime types but does not inherit mime: path '' [mime]`` - - The specified package contains mime type files (``.xml`` files in - ``${datadir}/mime/packages``) and yet does not inherit the mime - class which will ensure that these get properly installed. Either - add ``inherit mime`` to the recipe or remove the files at the - ``do_install`` step if they are not needed. - - -.. _qa-check-mime-xdg: - -- ``package contains desktop file with key 'MimeType' but does not inhert mime-xdg: path '' [mime-xdg]`` - - The specified package contains a .desktop file with a 'MimeType' key - present, but does not inherit the mime-xdg class that is required in - order for that to be activated. Either add ``inherit mime`` to the - recipe or remove the files at the ``do_install`` step if they are not - needed. - - -.. _qa-check-src-uri-bad: - -- ``: SRC_URI uses unstable GitHub archives [src-uri-bad]`` - - GitHub provides "archive" tarballs, however these can be re-generated - on the fly and thus the file's signature will not necessarily match that - in the SRC_URI checksums in future leading to build failures. It is - recommended that you use an official release tarball or switch to - pulling the corresponding revision in the actual git repository instead. - - -- ``SRC_URI uses PN not BPN [src-uri-bad]`` - - If some part of :term:`SRC_URI` needs to reference the recipe name, it should do - so using ${:term:`BPN`} rather than ${:term:`PN`} as the latter will change - for different variants of the same recipe e.g. when :term:`BBCLASSEXTEND` - or multilib are being used. This check will fail if a reference to ``${PN}`` - is found within the ``SRC_URI`` value - change it to ``${BPN}`` instead. - - -.. _qa-check-unhandled-features-check: - -- ``: recipe doesn't inherit features_check [unhandled-features-check]`` - - This check ensures that if one of the variables that the :ref:`features_check ` - class supports (e.g. :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe - inherits ``features_check`` in order for the requirement to actually work. If - you are seeing this message, either add ``inherit features_check`` to your recipe - or remove the reference to the variable if it is not needed. - - -.. _qa-check-missing-update-alternatives: - -- ``: recipe defines ALTERNATIVE_ but doesn't inherit update-alternatives. This might fail during do_rootfs later! [missing-update-alternatives]`` - - This check ensures that if a recipe sets the :term:`ALTERNATIVE` variable that the - recipe also inherits :ref:`update-alternatives ` such - that the alternative will be correctly set up. If you are seeing this message, either - add ``inherit update-alternatives`` to your recipe or remove the reference to the variable - if it is not needed. - - -.. _qa-check-shebang-size: - -- ``: maximum shebang size exceeded, the maximum size is 128. [shebang-size]`` - - This check ensures that the shebang line (``#!`` in the first line) for a script - is not longer than 128 characters, which can cause an error at runtime depending - on the operating system. If you are seeing this message then the specified script - may need to be patched to have a shorter in order to avoid runtime problems. - - -.. _qa-check-perllocalpod: - -- `` contains perllocal.pod (), should not be installed [perllocalpod]`` - - ``perllocal.pod`` is an index file of locally installed modules and so shouldn't be - installed by any distribution packages. The :ref:`cpan ` class - already sets ``NO_PERLLOCAL`` to stop this file being generated by most Perl recipes, - but if a recipe is using ``MakeMaker`` directly then they might not be doing this - correctly. This check ensures that perllocal.pod is not in any package in order to - avoid multiple packages shipping this file and thus their packages conflicting - if installed together. - - -.. _qa-check-usrmerge: - -- `` package is not obeying usrmerge distro feature. / should be relocated to /usr. [usrmerge]`` - - If ``usrmerge`` is in :term:`DISTRO_FEATURES`, this check will ensure that no package - installs files to root (``/bin``, ``/sbin``, ``/lib``, ``/lib64``) directories. If you are seeing this - message, it indicates that the ``do_install`` step (or perhaps the build process that - ``do_install`` is calling into, e.g. ``make install`` is using hardcoded paths instead - of the variables set up for this (``bindir``, ``sbindir``, etc.), and should be - changed so that it does. - - -.. _qa-check-patch-fuzz: - -- ``Fuzz detected: [patch-fuzz]`` - - This check looks for evidence of "fuzz" when applying patches within the ``do_patch`` - task. Patch fuzz is a situation when the ``patch`` tool ignores some of the context - lines in order to apply the patch. Consider this example: - - Patch to be applied: :: - - --- filename - +++ filename - context line 1 - context line 2 - context line 3 - +newly added line - context line 4 - context line 5 - context line 6 - - Original source code: :: - - different context line 1 - different context line 2 - context line 3 - context line 4 - different context line 5 - different context line 6 - - Outcome (after applying patch with fuzz): :: - - different context line 1 - different context line 2 - context line 3 - newly added line - context line 4 - different context line 5 - different context line 6 - - Chances are, the newly added line was actually added in a completely - wrong location, or it was already in the original source and was added - for the second time. This is especially possible if the context line 3 - and 4 are blank or have only generic things in them, such as ``#endif`` or ``}``. - Depending on the patched code, it is entirely possible for an incorrectly - patched file to still compile without errors. - - *How to eliminate patch fuzz warnings* - - Use the ``devtool`` command as explained by the warning. First, unpack the - source into devtool workspace: :: - - devtool modify - - This will apply all of the patches, and create new commits out of them in - the workspace - with the patch context updated. - - Then, replace the patches in the recipe layer: :: - - devtool finish --force-patch-refresh - - The patch updates then need be reviewed (preferably with a side-by-side diff - tool) to ensure they are indeed doing the right thing i.e.: - - #. they are applied in the correct location within the file; - #. they do not introduce duplicate lines, or otherwise do things that - are no longer necessary. - - To confirm these things, you can also review the patched source code in - devtool's workspace, typically in ``/workspace/sources//`` - - Once the review is done, you can create and publish a layer commit with - the patch updates that modify the context. Devtool may also refresh - other things in the patches, those can be discarded. - - - -Configuring and Disabling QA Checks -=================================== - -You can configure the QA checks globally so that specific check failures -either raise a warning or an error message, using the -:term:`WARN_QA` and :term:`ERROR_QA` -variables, respectively. You can also disable checks within a particular -recipe using :term:`INSANE_SKIP`. For information on -how to work with the QA checks, see the -":ref:`insane.bbclass `" section. - -.. note:: - - 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. diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst deleted file mode 100644 index 20be09a4ff..0000000000 --- a/documentation/ref-manual/ref-release-process.rst +++ /dev/null @@ -1,191 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -***************************************************** -Yocto Project Releases and the Stable Release Process -***************************************************** - -The Yocto Project release process is predictable and consists of both -major and minor (point) releases. This brief chapter provides -information on how releases are named, their life cycle, and their -stability. - -Major and Minor Release Cadence -=============================== - -The Yocto Project delivers major releases (e.g. DISTRO) using a six -month cadence roughly timed each April and October of the year. -Following are examples of some major YP releases with their codenames -also shown. See the "`Major Release -Codenames <#major-release-codenames>`__" section for information on -codenames used with major releases. - - - 2.2 (Morty) - - 2.1 (Krogoth) - - 2.0 (Jethro) - -While the cadence is never perfect, this timescale facilitates -regular releases that have strong QA cycles while not overwhelming users -with too many new releases. The cadence is predictable and avoids many -major holidays in various geographies. - -The Yocto project delivers minor (point) releases on an unscheduled -basis and are usually driven by the accumulation of enough significant -fixes or enhancements to the associated major release. Following are -some example past point releases: - - - 2.1.1 - - 2.1.2 - - 2.2.1 - -The point release -indicates a point in the major release branch where a full QA cycle and -release process validates the content of the new branch. - -.. note:: - - Realize that there can be patches merged onto the stable release - branches as and when they become available. - -Major Release Codenames -======================= - -Each major release receives a codename that identifies the release in -the :ref:`overview-manual/development-environment:yocto project source repositories`. -The concept is that branches of :term:`Metadata` with the same -codename are likely to be compatible and thus work together. - -.. note:: - - Codenames are associated with major releases because a Yocto Project - release number (e.g. DISTRO) could conflict with a given layer or - company versioning scheme. Codenames are unique, interesting, and - easily identifiable. - -Releases are given a nominal release version as well but the codename is -used in repositories for this reason. You can find information on Yocto -Project releases and codenames at -:yocto_wiki:`/Releases`. - -Stable Release Process -====================== - -Once released, the release enters the stable release process at which -time a person is assigned as the maintainer for that stable release. -This maintainer monitors activity for the release by investigating and -handling nominated patches and backport activity. Only fixes and -enhancements that have first been applied on the "master" branch (i.e. -the current, in-development branch) are considered for backporting to a -stable release. - -.. note:: - - The current Yocto Project policy regarding backporting is to consider - bug fixes and security fixes only. Policy dictates that features are - not backported to a stable release. This policy means generic recipe - version upgrades are unlikely to be accepted for backporting. The - exception to this policy occurs when a strong reason exists such as - the fix happens to also be the preferred upstream approach. - -Stable release branches have strong maintenance for about a year after -their initial release. Should significant issues be found for any -release regardless of its age, fixes could be backported to older -releases. For issues that are not backported given an older release, -Community LTS trees and branches exist where community members share -patches for older releases. However, these types of patches do not go -through the same release process as do point releases. You can find more -information about stable branch maintenance at -:yocto_wiki:`/Stable_branch_maintenance`. - -Testing and Quality Assurance -============================= - -Part of the Yocto Project development and release process is quality -assurance through the execution of test strategies. Test strategies -provide the Yocto Project team a way to ensure a release is validated. -Additionally, because the test strategies are visible to you as a -developer, you can validate your projects. This section overviews the -available test infrastructure used in the Yocto Project. For information -on how to run available tests on your projects, see the -":ref:`dev-manual/common-tasks:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. - -The QA/testing infrastructure is woven into the project to the point -where core developers take some of it for granted. The infrastructure -consists of the following pieces: - -- ``bitbake-selftest``: A standalone command that runs unit tests on - key pieces of BitBake and its fetchers. - -- :ref:`sanity.bbclass `: This automatically - included class checks the build environment for missing tools (e.g. - ``gcc``) or common misconfigurations such as - :term:`MACHINE` set incorrectly. - -- :ref:`insane.bbclass `: This class checks the - generated output from builds for sanity. For example, if building for - an ARM target, did the build produce ARM binaries. If, for example, - the build produced PPC binaries then there is a problem. - -- :ref:`testimage.bbclass `: This class - performs runtime testing of images after they are built. The tests - are usually used with :doc:`QEMU ` - to boot the images and check the combined runtime result boot - operation and functions. However, the test can also use the IP - address of a machine to test. - -- :ref:`ptest `: - Runs tests against packages produced during the build for a given - piece of software. The test allows the packages to be be run within a - target image. - -- ``oe-selftest``: Tests combination BitBake invocations. These tests - operate outside the OpenEmbedded build system itself. The - ``oe-selftest`` can run all tests by default or can run selected - tests or test suites. - - .. note:: - - Running ``oe-selftest`` requires host packages beyond the "Essential" - grouping. See the :ref:`ref-manual/ref-system-requirements:required packages for the build host` - section for more information. - -Originally, much of this testing was done manually. However, significant -effort has been made to automate the tests so that more people can use -them and the Yocto Project development team can run them faster and more -efficiently. - -The Yocto Project's main Autobuilder (&YOCTO_AB_URL;) -publicly tests each Yocto Project release's code in the -:term:`OpenEmbedded-Core (OE-Core)`, Poky, and BitBake repositories. The testing -occurs for both the current state of the "master" branch and also for -submitted patches. Testing for submitted patches usually occurs in the -"ross/mut" branch in the ``poky-contrib`` repository (i.e. the -master-under-test branch) or in the "master-next" branch in the ``poky`` -repository. - -.. note:: - - You can find all these branches in the Yocto Project - Source Repositories - . - -Testing within these public branches ensures in a publicly visible way -that all of the main supposed architectures and recipes in OE-Core -successfully build and behave properly. - -Various features such as ``multilib``, sub architectures (e.g. ``x32``, -``poky-tiny``, ``musl``, ``no-x11`` and and so forth), -``bitbake-selftest``, and ``oe-selftest`` are tested as part of the QA -process of a release. Complete testing and validation for a release -takes the Autobuilder workers several hours. - -.. note:: - - The Autobuilder workers are non-homogeneous, which means regular - testing across a variety of Linux distributions occurs. The - Autobuilder is limited to only testing QEMU-based setups and not real - hardware. - -Finally, in addition to the Autobuilder's tests, the Yocto Project QA -team also performs testing on a variety of platforms, which includes -actual hardware, to ensure expected results. diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst deleted file mode 100644 index ab9075b9c5..0000000000 --- a/documentation/ref-manual/ref-structure.rst +++ /dev/null @@ -1,874 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -************************** -Source Directory Structure -************************** - -The :term:`Source Directory` consists of numerous files, -directories and subdirectories; understanding their locations and -contents is key to using the Yocto Project effectively. This chapter -describes the Source Directory and gives information about those files -and directories. - -For information on how to establish a local Source Directory on your -development system, see the -":ref:`dev-manual/start:locating yocto project source files`" -section in the Yocto Project Development Tasks Manual. - -.. 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. - -.. _structure-core: - -Top-Level Core Components -========================= - -This section describes the top-level components of the :term:`Source Directory`. - -.. _structure-core-bitbake: - -``bitbake/`` ------------- - -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 :term:`Metadata` interpreter, reads the -Yocto Project Metadata and runs the tasks defined by that data. Failures -are usually caused by errors in your Metadata and not from BitBake -itself; consequently, most users do not need to worry about BitBake. - -When you run the ``bitbake`` command, the main BitBake executable (which -resides in the ``bitbake/bin/`` directory) starts. Sourcing the -environment setup script (i.e. :ref:`structure-core-script`) places -the ``scripts/`` and ``bitbake/bin/`` directories (in that order) into -the shell's ``PATH`` environment variable. - -For more information on BitBake, see the :doc:`BitBake User Manual -`. - -.. _structure-core-build: - -``build/`` ----------- - -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 :term:`Build Directory` -is created initially when you ``source`` -the OpenEmbedded build environment setup script (i.e. -:ref:`structure-core-script`). - -It is also possible to place output and configuration files in a -directory separate from the :term:`Source Directory` by -providing a directory name when you ``source`` the setup script. For -information on separating output from your local Source Directory files -(commonly described as an "out of tree" build), see the -":ref:`structure-core-script`" section. - -.. _handbook: - -``documentation/`` ------------------- - -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 its own sub-folder; -for example, the files for this reference manual reside in the -``ref-manual/`` directory. - -.. _structure-core-meta: - -``meta/`` ---------- - -This directory contains the minimal, underlying OpenEmbedded-Core -metadata. The directory holds recipes, common classes, and machine -configuration for strictly emulated targets (``qemux86``, ``qemuarm``, -and so forth.) - -.. _structure-core-meta-poky: - -``meta-poky/`` --------------- - -Designed above the ``meta/`` content, this directory adds just enough -metadata to define the Poky reference distribution. - -.. _structure-core-meta-yocto-bsp: - -``meta-yocto-bsp/`` -------------------- - -This directory contains the Yocto Project reference hardware Board -Support Packages (BSPs). For more information on BSPs, see the -:doc:`/bsp-guide/index`. - -.. _structure-meta-selftest: - -``meta-selftest/`` ------------------- - -This directory adds additional recipes and append files used by the -OpenEmbedded selftests to verify the behavior of the build system. You -do not have to add this layer to your ``bblayers.conf`` file unless you -want to run the selftests. - -.. _structure-meta-skeleton: - -``meta-skeleton/`` ------------------- - -This directory contains template recipes for BSP and kernel development. - -.. _structure-core-scripts: - -``scripts/`` ------------- - -This directory contains various integration scripts that implement extra -functionality in the Yocto Project environment (e.g. QEMU scripts). The -:ref:`structure-core-script` script prepends this directory to the -shell's ``PATH`` environment variable. - -The ``scripts`` directory has useful scripts that assist in contributing -back to the Yocto Project, such as ``create-pull-request`` and -``send-pull-request``. - -.. _structure-core-script: - -``oe-init-build-env`` ---------------------- - -This script sets up the OpenEmbedded build environment. Running this -script with the ``source`` command in a shell makes changes to ``PATH`` -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 ``scripts`` -directory to do the bulk of the work. - -When you run this script, your Yocto Project environment is set up, a -:term:`Build Directory` is created, your working -directory becomes the Build Directory, and you are presented with some -simple suggestions as to what to do next, including a list of some -possible targets to build. Here is an example: -:: - - $ source oe-init-build-env - - ### Shell environment set up for builds. ### - - You can now run 'bitbake ' - - 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-64' - -The default output of the ``oe-init-build-env`` script is from the -``conf-notes.txt`` file, which is found in the ``meta-poky`` directory -within the :term:`Source Directory`. If you design a -custom distribution, you can include your own version of this -configuration file to mention the targets defined by your distribution. -See the -":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" -section in the Yocto Project Development Tasks Manual for more -information. - -By default, running this script without a Build Directory argument -creates the ``build/`` directory in your current working directory. If -you provide a Build Directory argument when you ``source`` 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 ``mybuilds/`` that is outside of the :term:`Source Directory`: -:: - - $ source oe-init-build-env ~/mybuilds - -The OpenEmbedded build system uses the template configuration files, which -are found by default in the ``meta-poky/conf/`` directory in the Source -Directory. See the -":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" -section in the Yocto Project Development Tasks 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 ``oe-init-build-env`` - 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. - -.. _structure-basic-top-level: - -``LICENSE, README, and README.hardware`` ----------------------------------------- - -These files are standard top-level files. - -.. _structure-build: - -The Build Directory - ``build/`` -================================ - -The OpenEmbedded build system creates the :term:`Build Directory` -when you run the build environment setup -script :ref:`structure-core-script`. If you do not give the Build -Directory a specific name when you run the setup script, the name -defaults to ``build/``. - -For subsequent parsing and processing, the name of the Build directory -is available via the :term:`TOPDIR` variable. - -.. _structure-build-buildhistory: - -``build/buildhistory/`` ------------------------ - -The OpenEmbedded build system creates this directory when you enable -build history via the ``buildhistory`` class file. The directory -organizes build information into image, packages, and SDK -subdirectories. For information on the build history feature, see the -":ref:`dev-manual/common-tasks:maintaining build output quality`" -section in the Yocto Project Development Tasks Manual. - -.. _structure-build-conf-local.conf: - -``build/conf/local.conf`` -------------------------- - -This configuration file contains all the local user configurations for -your build environment. The ``local.conf`` 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 such variables are -relatively rare. - -At a minimum, you would normally edit this file to select the target -``MACHINE``, which package types you wish to use -(:term:`PACKAGE_CLASSES`), and the location from -which you want to access downloaded files (``DL_DIR``). - -If ``local.conf`` is not present when you start the build, the -OpenEmbedded build system creates it from ``local.conf.sample`` when you -``source`` the top-level build environment setup script -:ref:`structure-core-script`. - -The source ``local.conf.sample`` file used depends on the -``$TEMPLATECONF`` script variable, which defaults to ``meta-poky/conf/`` -when you are building from the Yocto Project development environment, -and to ``meta/conf/`` when you are building from the OpenEmbedded-Core -environment. Because the script variable points to the source of the -``local.conf.sample`` 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: -:: - - TEMPLATECONF=your_layer/conf - -Once the build process gets the sample -file, it uses ``sed`` to substitute final -``${``\ :term:`OEROOT`\ ``}`` values for all -``##OEROOT##`` values. - -.. note:: - - You can see how the ``TEMPLATECONF`` variable is used by looking at the - ``scripts/oe-setup-builddir``` script in the :term:`Source Directory`. - You can find the Yocto Project version of the ``local.conf.sample`` file in - the ``meta-poky/conf`` directory. - -.. _structure-build-conf-bblayers.conf: - -``build/conf/bblayers.conf`` ----------------------------- - -This configuration file defines -:ref:`layers `, -which are directory trees, traversed (or walked) by BitBake. The -``bblayers.conf`` file uses the :term:`BBLAYERS` -variable to list the layers BitBake tries to find. - -If ``bblayers.conf`` is not present when you start the build, the -OpenEmbedded build system creates it from ``bblayers.conf.sample`` when -you ``source`` the top-level build environment setup script (i.e. -:ref:`structure-core-script`). - -As with the ``local.conf`` file, the source ``bblayers.conf.sample`` -file used depends on the ``$TEMPLATECONF`` script variable, which -defaults to ``meta-poky/conf/`` when you are building from the Yocto -Project development environment, and to ``meta/conf/`` when you are -building from the OpenEmbedded-Core environment. Because the script -variable points to the source of the ``bblayers.conf.sample`` 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: -:: - - TEMPLATECONF=your_layer/conf - -Once the build process gets the sample file, it uses ``sed`` to substitute final -``${``\ :term:`OEROOT`\ ``}`` values for all ``##OEROOT##`` values. - -.. note:: - - You can see how the ``TEMPLATECONF`` variable ``scripts/oe-setup-builddir`` - script in the :term:`Source Directory`. You can find the Yocto Project - version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/`` - directory. - -.. _structure-build-conf-sanity_info: - -``build/cache/sanity_info`` ---------------------------- - -This file indicates the state of the sanity checks and is created during -the build. - -.. _structure-build-downloads: - -``build/downloads/`` --------------------- - -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 -``DL_DIR`` variable. - -.. _structure-build-sstate-cache: - -``build/sstate-cache/`` ------------------------ - -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 -``SSTATE_DIR`` variable. - -.. _structure-build-tmp: - -``build/tmp/`` --------------- - -The OpenEmbedded build system creates and uses this directory for all -the build system's output. The :term:`TMPDIR` variable -points to this directory. - -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 ``tmp`` directory or get -rid of the directory completely. If you do, you should also completely -remove the ``build/sstate-cache`` directory. - -.. _structure-build-tmp-buildstats: - -``build/tmp/buildstats/`` -------------------------- - -This directory stores the build statistics. - -.. _structure-build-tmp-cache: - -``build/tmp/cache/`` --------------------- - -When BitBake parses the metadata (recipes and configuration files), it -caches the results in ``build/tmp/cache/`` to speed up future builds. -The results are stored on a per-machine basis. - -During subsequent builds, BitBake checks each recipe (together with, for -example, any files included or appended to it) to see if they have been -modified. Changes can be detected, for example, through file -modification time (mtime) changes and hashing of file contents. If no -changes to the file are detected, then the parsed result stored in the -cache is reused. If the file has changed, it is reparsed. - -.. _structure-build-tmp-deploy: - -``build/tmp/deploy/`` ---------------------- - -This directory contains any "end result" output from the OpenEmbedded -build process. The :term:`DEPLOY_DIR` variable points -to this directory. For more detail on the contents of the ``deploy`` -directory, see the -":ref:`overview-manual/concepts:images`" and -":ref:`overview-manual/concepts:application development sdk`" sections in the Yocto -Project Overview and Concepts Manual. - -.. _structure-build-tmp-deploy-deb: - -``build/tmp/deploy/deb/`` -------------------------- - -This directory receives any ``.deb`` packages produced by the build -process. The packages are sorted into feeds for different architecture -types. - -.. _structure-build-tmp-deploy-rpm: - -``build/tmp/deploy/rpm/`` -------------------------- - -This directory receives any ``.rpm`` packages produced by the build -process. The packages are sorted into feeds for different architecture -types. - -.. _structure-build-tmp-deploy-ipk: - -``build/tmp/deploy/ipk/`` -------------------------- - -This directory receives ``.ipk`` packages produced by the build process. - -.. _structure-build-tmp-deploy-licenses: - -``build/tmp/deploy/licenses/`` ------------------------------- - -This directory receives package licensing information. For example, the -directory contains sub-directories for ``bash``, ``busybox``, and -``glibc`` (among others) that in turn contain appropriate ``COPYING`` -license files with other licensing information. For information on -licensing, see the -":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" -section in the Yocto Project Development Tasks Manual. - -.. _structure-build-tmp-deploy-images: - -``build/tmp/deploy/images/`` ----------------------------- - -This directory is populated with the basic output objects of the build -(think of them as the "generated artifacts" of the build process), -including things like the boot loader image, kernel, root filesystem and -more. If you want to flash the resulting image from a build onto a -device, look here for the necessary components. - -Be careful when deleting files in this directory. You can safely delete -old images from this directory (e.g. ``core-image-*``). However, the -kernel (``*zImage*``, ``*uImage*``, 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. - -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: -:: - - $ bitbake -c clean virtual/kernel - $ bitbake virtual/kernel - -.. _structure-build-tmp-deploy-sdk: - -``build/tmp/deploy/sdk/`` -------------------------- - -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 ":ref:`sdk-manual/appendix-obtain:building an sdk installer`" -section in the Yocto Project Application Development and the Extensible -Software Development Kit (eSDK) manual. - -.. _structure-build-tmp-sstate-control: - -``build/tmp/sstate-control/`` ------------------------------ - -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. - -.. _structure-build-tmp-sysroots-components: - -``build/tmp/sysroots-components/`` ----------------------------------- - -This directory is the location of the sysroot contents that the task -:ref:`ref-tasks-prepare_recipe_sysroot` -links or copies into the recipe-specific sysroot for each recipe listed -in :term:`DEPENDS`. Population of this directory is -handled through shared state, while the path is specified by the -:term:`COMPONENTS_DIR` variable. Apart from a few -unusual circumstances, handling of the ``sysroots-components`` directory -should be automatic, and recipes should not directly reference -``build/tmp/sysroots-components``. - -.. _structure-build-tmp-sysroots: - -``build/tmp/sysroots/`` ------------------------ - -Previous versions of the OpenEmbedded build system used to create a -global shared sysroot per machine along with a native sysroot. Beginning -with the 2.3 version of the Yocto Project, sysroots exist in -recipe-specific :term:`WORKDIR` directories. Thus, the -``build/tmp/sysroots/`` directory is unused. - -.. note:: - - The ``build/tmp/sysroots/`` directory can still be populated using the - ``bitbake build-sysroots`` command and can be used for compatibility in some - cases. However, in general it is not recommended to populate this directory. - Individual recipe-specific sysroots should be used. - -.. _structure-build-tmp-stamps: - -``build/tmp/stamps/`` ---------------------- - -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: -:: - - stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do - -Although the files in the directory are empty of data, BitBake uses the filenames -and timestamps for tracking purposes. - -For information on how BitBake uses stamp files to determine if a task -should be rerun, see the -":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`" -section in the Yocto Project Overview and Concepts Manual. - -.. _structure-build-tmp-log: - -``build/tmp/log/`` ------------------- - -This directory contains general logs that are not otherwise placed using -the package's ``WORKDIR``. Examples of logs are the output from the -``do_check_pkg`` or ``do_distro_check`` tasks. Running a build does not -necessarily mean this directory is created. - -.. _structure-build-tmp-work: - -``build/tmp/work/`` -------------------- - -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 -:term:`WORKDIR`. - -It is worth considering the structure of a typical work directory. As an -example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86`` -built within the Yocto Project. For this package, a work directory of -``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred -to as the ``WORKDIR``, is created. Within this directory, the source is -unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. -(See the ":ref:`dev-manual/common-tasks:using quilt in your workflow`" section in -the Yocto Project Development Tasks Manual for more information.) Within -the ``linux-qemux86-standard-build`` directory, standard Quilt -directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and -standard Quilt commands can be used. - -There are other directories generated within ``WORKDIR``. The most -important directory is ``WORKDIR/temp/``, which has log files for each -task (``log.do_*.pid``) and contains the scripts BitBake runs for each -task (``run.do_*.pid``). The ``WORKDIR/image/`` directory is where "make -install" places its output that is then split into sub-packages within -``WORKDIR/packages-split/``. - -.. _structure-build-tmp-work-tunearch-recipename-version: - -``build/tmp/work/tunearch/recipename/version/`` ------------------------------------------------ - -The recipe work directory - ``${WORKDIR}``. - -As described earlier in the -":ref:`structure-build-tmp-sysroots`" section, -beginning with the 2.3 release of the Yocto Project, the OpenEmbedded -build system builds each recipe in its own work directory (i.e. -:term:`WORKDIR`). The path to the work directory is -constructed using the architecture of the given build (e.g. -:term:`TUNE_PKGARCH`, :term:`MACHINE_ARCH`, or "allarch"), the recipe -name, and the version of the recipe (i.e. -:term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`). - -A number of key subdirectories exist within each recipe work directory: - -- ``${WORKDIR}/temp``: Contains the log files of each task executed for - this recipe, the "run" files for each executed task, which contain - the code run, and a ``log.task_order`` file, which lists the order in - which tasks were executed. - -- ``${WORKDIR}/image``: Contains the output of the - :ref:`ref-tasks-install` task, which corresponds to - the ``${``\ :term:`D`\ ``}`` variable in that task. - -- ``${WORKDIR}/pseudo``: Contains the pseudo database and log for any - tasks executed under pseudo for the recipe. - -- ``${WORKDIR}/sysroot-destdir``: Contains the output of the - :ref:`ref-tasks-populate_sysroot` task. - -- ``${WORKDIR}/package``: Contains the output of the - :ref:`ref-tasks-package` task before the output is - split into individual packages. - -- ``${WORKDIR}/packages-split``: Contains the output of the - ``do_package`` task after the output has been split into individual - packages. Subdirectories exist for each individual package created by - the recipe. - -- ``${WORKDIR}/recipe-sysroot``: A directory populated with the target - dependencies of the recipe. This directory looks like the target - filesystem and contains libraries that the recipe might need to link - against (e.g. the C library). - -- ``${WORKDIR}/recipe-sysroot-native``: A directory populated with the - native dependencies of the recipe. This directory contains the tools - the recipe needs to build (e.g. the compiler, Autoconf, libtool, and - so forth). - -- ``${WORKDIR}/build``: This subdirectory applies only to recipes that - support builds where the source is separate from the build artifacts. - The OpenEmbedded build system uses this directory as a separate build - directory (i.e. ``${``\ :term:`B`\ ``}``). - -.. _structure-build-work-shared: - -``build/tmp/work-shared/`` --------------------------- - -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 ``gcc`` and its variants -(e.g. ``gcc-cross``, ``libgcc``, ``gcc-runtime``, and so forth). - -.. _structure-meta: - -The Metadata - ``meta/`` -======================== - -As mentioned previously, :term:`Metadata` is the core of the -Yocto Project. Metadata has several important subdivisions: - -.. _structure-meta-classes: - -``meta/classes/`` ------------------ - -This directory contains the ``*.bbclass`` files. Class files are used to -abstract common code so it can be reused by multiple packages. Every -package inherits the ``base.bbclass`` file. Examples of other important -classes are ``autotools.bbclass``, which in theory allows any -Autotool-enabled package to work with the Yocto Project with minimal -effort. Another example is ``kernel.bbclass`` 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 -``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``. - -For reference information on classes, see the -":ref:`ref-manual/ref-classes:Classes`" chapter. - -.. _structure-meta-conf: - -``meta/conf/`` --------------- - -This directory contains the core set of configuration files that start -from ``bitbake.conf`` and from which all other configuration files are -included. See the include statements at the end of the ``bitbake.conf`` -file and you will note that even ``local.conf`` is loaded from there. -While ``bitbake.conf`` sets up the defaults, you can often override -these by using the (``local.conf``) file, machine file or the -distribution configuration file. - -.. _structure-meta-conf-machine: - -``meta/conf/machine/`` ----------------------- - -This directory contains all the machine configuration files. If you set -``MACHINE = "qemux86"``, the OpenEmbedded build system looks for a -``qemux86.conf`` file in this directory. The ``include`` 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. - -.. _structure-meta-conf-distro: - -``meta/conf/distro/`` ---------------------- - -The contents of this directory controls any distribution-specific -configurations. For the Yocto Project, the ``defaultsetup.conf`` is the -main file here. This directory includes the versions and the ``SRCDATE`` -definitions for applications that are configured here. An example of an -alternative configuration might be ``poky-bleeding.conf``. Although this -file mainly inherits its configuration from Poky. - -.. _structure-meta-conf-machine-sdk: - -``meta/conf/machine-sdk/`` --------------------------- - -The OpenEmbedded build system searches this directory for configuration -files that correspond to the value of -:term:`SDKMACHINE`. 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. - -.. _structure-meta-files: - -``meta/files/`` ---------------- - -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. - -.. _structure-meta-lib: - -``meta/lib/`` -------------- - -This directory contains OpenEmbedded Python library code used during the -build process. - -.. _structure-meta-recipes-bsp: - -``meta/recipes-bsp/`` ---------------------- - -This directory contains anything linking to specific hardware or -hardware configuration information such as "u-boot" and "grub". - -.. _structure-meta-recipes-connectivity: - -``meta/recipes-connectivity/`` ------------------------------- - -This directory contains libraries and applications related to -communication with other devices. - -.. _structure-meta-recipes-core: - -``meta/recipes-core/`` ----------------------- - -This directory contains what is needed to build a basic working Linux -image including commonly used dependencies. - -.. _structure-meta-recipes-devtools: - -``meta/recipes-devtools/`` --------------------------- - -This directory contains tools that are primarily used by the build -system. The tools, however, can also be used on targets. - -.. _structure-meta-recipes-extended: - -``meta/recipes-extended/`` --------------------------- - -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. - -.. _structure-meta-recipes-gnome: - -``meta/recipes-gnome/`` ------------------------ - -This directory contains all things related to the GTK+ application -framework. - -.. _structure-meta-recipes-graphics: - -``meta/recipes-graphics/`` --------------------------- - -This directory contains X and other graphically related system -libraries. - -.. _structure-meta-recipes-kernel: - -``meta/recipes-kernel/`` ------------------------- - -This directory contains the kernel and generic applications and -libraries that have strong kernel dependencies. - -.. _structure-meta-recipes-lsb4: - -``meta/recipes-lsb4/`` ----------------------- - -This directory contains recipes specifically added to support the Linux -Standard Base (LSB) version 4.x. - -.. _structure-meta-recipes-multimedia: - -``meta/recipes-multimedia/`` ----------------------------- - -This directory contains codecs and support utilities for audio, images -and video. - -.. _structure-meta-recipes-rt: - -``meta/recipes-rt/`` --------------------- - -This directory contains package and image recipes for using and testing -the ``PREEMPT_RT`` kernel. - -.. _structure-meta-recipes-sato: - -``meta/recipes-sato/`` ----------------------- - -This directory contains the Sato demo/reference UI/UX and its associated -applications and configuration data. - -.. _structure-meta-recipes-support: - -``meta/recipes-support/`` -------------------------- - -This directory contains recipes used by other recipes, but that are not -directly included in images (i.e. dependencies of other recipes). - -.. _structure-meta-site: - -``meta/site/`` --------------- - -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. - -.. _structure-meta-recipes-txt: - -``meta/recipes.txt`` --------------------- - -This file is a description of the contents of ``recipes-*``. diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst deleted file mode 100644 index 66afb08102..0000000000 --- a/documentation/ref-manual/ref-system-requirements.rst +++ /dev/null @@ -1,442 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -******************* -System Requirements -******************* - -Welcome to the Yocto Project Reference Manual! This manual provides -reference information for the current release of the Yocto Project, and -is most effectively used after you have an understanding of the basics -of the Yocto Project. The manual is neither meant to be read as a -starting point to the Yocto Project, nor read from start to finish. -Rather, use this manual to find variable definitions, class -descriptions, and so forth as needed during the course of using the -Yocto Project. - -For introductory information on the Yocto Project, see the -:yocto_home:`Yocto Project Website <>` and the -":ref:`overview-manual/development-environment:the yocto project development environment`" -chapter in the Yocto Project Overview and Concepts Manual. - -If you want to use the Yocto Project to quickly build an image without -having to understand concepts, work through the -:doc:`/brief-yoctoprojectqs/index` document. You can find "how-to" -information in the :doc:`/dev-manual/index`. You can find Yocto Project overview -and conceptual information in the :doc:`/overview-manual/index`. - -.. note:: - - For more information about the Yocto Project Documentation set, see - the :ref:`ref-manual/resources:links and related documentation` section. - -.. _detailed-supported-distros: - -Supported Linux Distributions -============================= - -Currently, the Yocto Project is supported on the following -distributions: - -- Ubuntu 16.04 (LTS) - -- Ubuntu 18.04 (LTS) - -- Ubuntu 20.04 - -- Fedora 30 - -- Fedora 31 - -- Fedora 32 - -- CentOS 7.x - -- CentOS 8.x - -- Debian GNU/Linux 8.x (Jessie) - -- Debian GNU/Linux 9.x (Stretch) - -- Debian GNU/Linux 10.x (Buster) - -- OpenSUSE Leap 15.1 - - -.. 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. - - - Yocto Project releases are tested against the stable Linux - distributions in the above list. The Yocto Project should work - on other distributions but validation is not performed against - them. - - - 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. - - - You may use Windows Subsystem For Linux v2 to set up a build host - using Windows 10, but validation is not performed against build - hosts using WSLv2. - - - The Yocto Project is not compatible with WSLv1, it is - compatible but not officially supported nor validated with - WSLv2, if you still decide to use WSL please upgrade to WSLv2. - - - If you encounter problems, please go to :yocto_bugs:`Yocto Project - Bugzilla <>` and submit a bug. We are - interested in hearing about your experience. For information on - how to submit a bug, see the Yocto Project - :yocto_wiki:`Bugzilla wiki page ` - and the ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" - section in the Yocto Project Development Tasks Manual. - - -Required Packages for the Build Host -==================================== - -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 describes required packages according to Linux distribution and -function. - -.. _ubuntu-packages: - -Ubuntu and Debian ------------------ - -The following list shows the required packages by function given a -supported Ubuntu or Debian Linux distribution: - -.. note:: - - - If your build system has the ``oss4-dev`` package installed, you - might experience QEMU build failures due to the package installing - its own custom ``/usr/include/linux/soundcard.h`` on the Debian - system. If you run into this situation, either of the following - solutions exist: - :: - - $ sudo apt-get build-dep qemu - $ sudo apt-get remove oss4-dev - - - For Debian-8, ``python3-git`` and ``pylint3`` are no longer - available via ``apt-get``. - :: - - $ sudo pip3 install GitPython pylint==1.9.5 - -- *Essentials:* Packages needed to build an image on a headless system: - :: - - $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; - -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: - - $ sudo apt-get install make python3-pip - &PIP3_HOST_PACKAGES_DOC; - - .. note:: - - It is currently not possible to build out documentation from Debian 8 - (Jessie) because of outdated ``pip3`` and ``python3``. ``python3-sphinx`` - is too outdated. - -Fedora Packages ---------------- - -The following list shows the required packages by function given a -supported Fedora Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system: - :: - - $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; - -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: - - $ sudo dnf install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; - -openSUSE Packages ------------------ - -The following list shows the required packages by function given a -supported openSUSE Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system: - :: - - $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; - -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: - - $ sudo zypper install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; - - -CentOS-7 Packages ------------------ - -The following list shows the required packages by function given a -supported CentOS-7 Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system: - :: - - $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL; - - .. note:: - - - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is - a collection of packages from Fedora built on RHEL/CentOS for - easy installation of packages not included in enterprise Linux - by default. You need to install these packages separately. - - - The ``makecache`` command consumes additional Metadata from - ``epel-release``. - -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: - - $ sudo yum install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; - -CentOS-8 Packages ------------------ - -The following list shows the required packages by function given a -supported CentOS-8 Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system: - :: - - $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL; - - .. note:: - - - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is - a collection of packages from Fedora built on RHEL/CentOS for - easy installation of packages not included in enterprise Linux - by default. You need to install these packages separately. - - - The ``PowerTools`` repo provides additional packages such as - ``rpcgen`` and ``texinfo``. - - - The ``makecache`` command consumes additional Metadata from - ``epel-release``. - -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: - - $ sudo dnf install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; - -Required Git, tar, Python and gcc Versions -========================================== - -In order to use the build system, your host development system must meet -the following version requirements for Git, tar, and Python: - -- Git 1.8.3.1 or greater - -- tar 1.28 or greater - -- Python 3.5.0 or greater - -If your host development system does not meet all these requirements, -you can resolve this by installing a ``buildtools`` 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. - -In addition, your host development system must meet the following -version requirement for gcc: - -- gcc 5.0 or greater - -If your host development system does not meet this requirement, you can -resolve this by installing a ``buildtools-extended`` tarball that -contains additional tools, the equivalent of ``buildtools-essential``. - -Installing a Pre-Built ``buildtools`` Tarball with ``install-buildtools`` script --------------------------------------------------------------------------------- - -The ``install-buildtools`` script is the easiest of the three methods by -which you can get these tools. It downloads a pre-built buildtools -installer and automatically installs the tools for you: - -1. Execute the ``install-buildtools`` script. Here is an example: - :: - - $ cd poky - $ scripts/install-buildtools --without-extended-buildtools \ - --base-url &YOCTO_DL_URL;/releases/yocto \ - --release yocto-&DISTRO; \ - --installer-version &DISTRO; - - During execution, the buildtools tarball will be downloaded, the - checksum of the download will be verified, the installer will be run - for you, and some basic checks will be run to to make sure the - installation is functional. - - To avoid the need of ``sudo`` privileges, the ``install-buildtools`` - script will by default tell the installer to install in: - :: - - /path/to/poky/buildtools - - If your host development system needs the additional tools provided - in the ``buildtools-extended`` tarball, you can instead execute the - ``install-buildtools`` script with the default parameters: - :: - - $ cd poky - $ scripts/install-buildtools - -2. Source the tools environment setup script by using a command like the - following: - :: - - $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux - - Of course, you need to supply your installation directory and be sure to - use the right file (i.e. i586 or x86_64). - - After you have sourced the setup script, the tools are added to - ``PATH`` and any other environment variables required to run the - tools are initialized. The results are working versions versions of - Git, tar, Python and ``chrpath``. And in the case of the - ``buildtools-extended`` tarball, additional working versions of tools - including ``gcc``, ``make`` and the other tools included in - ``packagegroup-core-buildessential``. - -Downloading a Pre-Built ``buildtools`` Tarball ----------------------------------------------- - -Downloading and running a pre-built buildtools installer is the easiest -of the two methods by which you can get these tools: - -1. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ - -2. Execute the installation script. Here is an example for the - traditional installer: - :: - - $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-DISTRO.sh - - Here is an example for the extended installer: - :: - - $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-DISTRO.sh - - During execution, a prompt appears that allows you to choose the - installation directory. For example, you could choose the following: - ``/home/your-username/buildtools`` - -3. Source the tools environment setup script by using a command like the - following: - :: - - $ source /home/your_username/buildtools/environment-setup-i586-poky-linux - - Of - course, you need to supply your installation directory and be sure to - use the right file (i.e. i585 or x86-64). - - After you have sourced the setup script, the tools are added to - ``PATH`` and any other environment variables required to run the - tools are initialized. The results are working versions versions of - Git, tar, Python and ``chrpath``. And in the case of the - ``buildtools-extended`` tarball, additional working versions of tools - including ``gcc``, ``make`` and the other tools included in - ``packagegroup-core-buildessential``. - -Building Your Own ``buildtools`` Tarball ----------------------------------------- - -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 ``.sh`` file and then take steps to transfer -and run it on a machine that does not meet the minimal Git, tar, and -Python (or gcc) requirements. - -Here are the steps to take to build and run your own buildtools -installer: - -1. On the machine that is able to run BitBake, be sure you have set up - your build environment with the setup script - (:ref:`structure-core-script`). - -2. Run the BitBake command to build the tarball: - :: - - $ bitbake buildtools-tarball - - or run the BitBake command to build the extended tarball: - :: - - $ bitbake buildtools-extended-tarball - - .. note:: - - The :term:`SDKMACHINE` variable in your ``local.conf`` file determines - whether you build tools for a 32-bit or 64-bit system. - - Once the build completes, you can find the ``.sh`` file that installs - the tools in the ``tmp/deploy/sdk`` subdirectory of the - :term:`Build Directory`. The installer file has the string - "buildtools" (or "buildtools-extended") in the name. - -3. Transfer the ``.sh`` file from the build host to the machine that - does not meet the Git, tar, or Python (or gcc) requirements. - -4. On the machine that does not meet the requirements, run the ``.sh`` - file to install the tools. Here is an example for the traditional - installer: - :: - - $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh - - Here is an example for the extended installer: - :: - - $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh - - During execution, a prompt appears that allows you to choose the - installation directory. For example, you could choose the following: - ``/home/your_username/buildtools`` - -5. Source the tools environment setup script by using a command like the - following: - :: - - $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux - - Of course, you need to supply your installation directory and be sure to - use the right file (i.e. i586 or x86_64). - - After you have sourced the setup script, the tools are added to - ``PATH`` and any other environment variables required to run the - tools are initialized. The results are working versions versions of - Git, tar, Python and ``chrpath``. And in the case of the - ``buildtools-extended`` tarball, additional working versions of tools - including ``gcc``, ``make`` and the other tools included in - ``packagegroup-core-buildessential``. diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst deleted file mode 100644 index 8b9e0c2d89..0000000000 --- a/documentation/ref-manual/ref-tasks.rst +++ /dev/null @@ -1,844 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -***** -Tasks -***** - -Tasks are units of execution for BitBake. Recipes (``.bb`` files) use -tasks to complete configuring, compiling, and packaging software. This -chapter provides a reference of the tasks defined in the OpenEmbedded -build system. - -Normal Recipe Build Tasks -========================= - -The following sections describe normal tasks associated with building a -recipe. For more information on tasks and dependencies, see the -":ref:`Tasks `" and -":ref:`Dependencies `" sections in the -BitBake User Manual. - -.. _ref-tasks-build: - -``do_build`` ------------- - -The default task for all recipes. This task depends on all other normal -tasks required to build a recipe. - -.. _ref-tasks-compile: - -``do_compile`` --------------- - -Compiles the source code. This task runs with the current working -directory set to ``${``\ :term:`B`\ ``}``. - -The default behavior of this task is to run the ``oe_runmake`` function -if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found. -If no such file is found, the ``do_compile`` task does nothing. - -.. _ref-tasks-compile_ptest_base: - -``do_compile_ptest_base`` -------------------------- - -Compiles the runtime test suite included in the software being built. - -.. _ref-tasks-configure: - -``do_configure`` ----------------- - -Configures the source by enabling and disabling any build-time and -configuration options for the software being built. The task runs with -the current working directory set to ``${``\ :term:`B`\ ``}``. - -The default behavior of this task is to run ``oe_runmake clean`` if a -makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and -:term:`CLEANBROKEN` is not set to "1". If no such -file is found or the ``CLEANBROKEN`` variable is set to "1", the -``do_configure`` task does nothing. - -.. _ref-tasks-configure_ptest_base: - -``do_configure_ptest_base`` ---------------------------- - -Configures the runtime test suite included in the software being built. - -.. _ref-tasks-deploy: - -``do_deploy`` -------------- - -Writes output files that are to be deployed to -``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}``. The -task runs with the current working directory set to -``${``\ :term:`B`\ ``}``. - -Recipes implementing this task should inherit the -:ref:`deploy ` class and should write the output -to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be -confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up -``do_deploy`` as a shared state (sstate) task that can be accelerated -through sstate use. The sstate mechanism takes care of copying the -output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. - -.. note:: - - Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes - the sstate mechanism to malfunction. - -The ``do_deploy`` task is not added as a task by default and -consequently needs to be added manually. If you want the task to run -after :ref:`ref-tasks-compile`, you can add it by doing -the following: -:: - - addtask deploy after do_compile - -Adding ``do_deploy`` after other tasks works the same way. - -.. note:: - - You do not need to add ``before do_build`` to the ``addtask`` command - (though it is harmless), because the ``base`` class contains the following: - :: - - do_build[recrdeptask] += "do_deploy" - - - See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" - section in the BitBake User Manual for more information. - -If the ``do_deploy`` task re-executes, any previous output is removed -(i.e. "cleaned"). - -.. _ref-tasks-fetch: - -``do_fetch`` ------------- - -Fetches the source code. This task uses the -:term:`SRC_URI` variable and the argument's prefix to -determine the correct :ref:`fetcher ` -module. - -.. _ref-tasks-image: - -``do_image`` ------------- - -Starts the image generation process. The ``do_image`` task runs after -the OpenEmbedded build system has run the -:ref:`ref-tasks-rootfs` task during which packages are -identified for installation into the image and the root filesystem is -created, complete with post-processing. - -The ``do_image`` task performs pre-processing on the image through the -:term:`IMAGE_PREPROCESS_COMMAND` and -dynamically generates supporting ``do_image_*`` tasks as needed. - -For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`" -section in the Yocto Project Overview and Concepts Manual. - -.. _ref-tasks-image-complete: - -``do_image_complete`` ---------------------- - -Completes the image generation process. The ``do_image_complete`` task -runs after the OpenEmbedded build system has run the -:ref:`ref-tasks-image` task during which image -pre-processing occurs and through dynamically generated ``do_image_*`` -tasks the image is constructed. - -The ``do_image_complete`` task performs post-processing on the image -through the -:term:`IMAGE_POSTPROCESS_COMMAND`. - -For more information on image creation, see the -":ref:`overview-manual/concepts:image generation`" -section in the Yocto Project Overview and Concepts Manual. - -.. _ref-tasks-install: - -``do_install`` --------------- - -Copies files that are to be packaged into the holding area -``${``\ :term:`D`\ ``}``. This task runs with the current -working directory set to ``${``\ :term:`B`\ ``}``, which is the -compilation directory. The ``do_install`` task, as well as other tasks -that either directly or indirectly depend on the installed files (e.g. -:ref:`ref-tasks-package`, ``do_package_write_*``, and -:ref:`ref-tasks-rootfs`), run under -:ref:`fakeroot `. - -.. note:: - - When installing files, be careful not to set the owner and group IDs - of the installed files to unintended values. Some methods of copying - files, notably when using the recursive ``cp`` command, can preserve - the UID and/or GID of the original file, which is usually not what - you want. The ``host-user-contaminated`` QA check checks for files - that probably have the wrong ownership. - - Safe methods for installing files include the following: - - - The ``install`` utility. This utility is the preferred method. - - - The ``cp`` command with the "--no-preserve=ownership" option. - - - The ``tar`` command with the "--no-same-owner" option. See the - ``bin_package.bbclass`` file in the ``meta/classes`` directory of - the :term:`Source Directory` for an example. - -.. _ref-tasks-install_ptest_base: - -``do_install_ptest_base`` -------------------------- - -Copies the runtime test suite files from the compilation directory to a -holding area. - -.. _ref-tasks-package: - -``do_package`` --------------- - -Analyzes the content of the holding area -``${``\ :term:`D`\ ``}`` and splits the content into subsets -based on available packages and files. This task makes use of the -:term:`PACKAGES` and :term:`FILES` -variables. - -The ``do_package`` task, in conjunction with the -:ref:`ref-tasks-packagedata` task, also saves some -important package metadata. For additional information, see the -:term:`PKGDESTWORK` variable and the -":ref:`overview-manual/concepts:automatically added runtime dependencies`" -section in the Yocto Project Overview and Concepts Manual. - -.. _ref-tasks-package_qa: - -``do_package_qa`` ------------------ - -Runs QA checks on packaged files. For more information on these checks, -see the :ref:`insane ` class. - -.. _ref-tasks-package_write_deb: - -``do_package_write_deb`` ------------------------- - -Creates Debian packages (i.e. ``*.deb`` files) and places them in the -``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in -the package feeds area. For more information, see the -":ref:`overview-manual/concepts:package feeds`" section in -the Yocto Project Overview and Concepts Manual. - -.. _ref-tasks-package_write_ipk: - -``do_package_write_ipk`` ------------------------- - -Creates IPK packages (i.e. ``*.ipk`` files) and places them in the -``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in -the package feeds area. For more information, see the -":ref:`overview-manual/concepts:package feeds`" section in -the Yocto Project Overview and Concepts Manual. - -.. _ref-tasks-package_write_rpm: - -``do_package_write_rpm`` ------------------------- - -Creates RPM packages (i.e. ``*.rpm`` files) and places them in the -``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in -the package feeds area. For more information, see the -":ref:`overview-manual/concepts:package feeds`" section in -the Yocto Project Overview and Concepts Manual. - -.. _ref-tasks-package_write_tar: - -``do_package_write_tar`` ------------------------- - -Creates tarballs and places them in the -``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in -the package feeds area. For more information, see the -":ref:`overview-manual/concepts:package feeds`" section in -the Yocto Project Overview and Concepts Manual. - -.. _ref-tasks-packagedata: - -``do_packagedata`` ------------------- - -Saves package metadata generated by the -:ref:`ref-tasks-package` task in -:term:`PKGDATA_DIR` to make it available globally. - -.. _ref-tasks-patch: - -``do_patch`` ------------- - -Locates patch files and applies them to the source code. - -After fetching and unpacking source files, the build system uses the -recipe's :term:`SRC_URI` statements -to locate and apply patch files to the source code. - -.. note:: - - The build system uses the :term:`FILESPATH` variable to determine the - default set of directories when searching for patches. - -Patch files, by default, are ``*.patch`` and ``*.diff`` files created -and kept in a subdirectory of the directory holding the recipe file. For -example, consider the -:yocto_git:`bluez5 ` -recipe from the OE-Core layer (i.e. ``poky/meta``): -:: - - poky/meta/recipes-connectivity/bluez5 - -This recipe has two patch files located here: -:: - - poky/meta/recipes-connectivity/bluez5/bluez5 - -In the ``bluez5`` recipe, the ``SRC_URI`` statements point to the source -and patch files needed to build the package. - -.. note:: - - In the case for the ``bluez5_5.48.bb`` recipe, the ``SRC_URI`` statements - are from an include file ``bluez5.inc``. - -As mentioned earlier, the build system treats files whose file types are -``.patch`` and ``.diff`` as patch files. However, you can use the -"apply=yes" parameter with the ``SRC_URI`` statement to indicate any -file as a patch file: -:: - - SRC_URI = " \ - git://path_to_repo/some_package \ - file://file;apply=yes \ - " - -Conversely, if you have a directory full of patch files and you want to -exclude some so that the ``do_patch`` task does not apply them during -the patch phase, you can use the "apply=no" parameter with the -``SRC_URI`` statement: -:: - - SRC_URI = " \ - git://path_to_repo/some_package \ - file://path_to_lots_of_patch_files \ - file://path_to_lots_of_patch_files/patch_file5;apply=no \ - " - -In the -previous example, assuming all the files in the directory holding the -patch files end with either ``.patch`` or ``.diff``, every file would be -applied as a patch by default except for the ``patch_file5`` patch. - -You can find out more about the patching process in the -":ref:`overview-manual/concepts:patching`" section in -the Yocto Project Overview and Concepts Manual and the -":ref:`dev-manual/common-tasks:patching code`" section in the -Yocto Project Development Tasks Manual. - -.. _ref-tasks-populate_lic: - -``do_populate_lic`` -------------------- - -Writes license information for the recipe that is collected later when -the image is constructed. - -.. _ref-tasks-populate_sdk: - -``do_populate_sdk`` -------------------- - -Creates the file and directory structure for an installable SDK. See the -":ref:`overview-manual/concepts:sdk generation`" -section in the Yocto Project Overview and Concepts Manual for more -information. - -.. _ref-tasks-populate_sdk_ext: - -``do_populate_sdk_ext`` ------------------------ - -Creates the file and directory structure for an installable extensible -SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`" -section in the Yocto Project Overview and Concepts Manual for more -information. - - -.. _ref-tasks-populate_sysroot: - -``do_populate_sysroot`` ------------------------ - -Stages (copies) a subset of the files installed by the -:ref:`ref-tasks-install` task into the appropriate -sysroot. For information on how to access these files from other -recipes, see the :term:`STAGING_DIR* ` variables. -Directories that would typically not be needed by other recipes at build -time (e.g. ``/etc``) are not copied by default. - -For information on what directories are copied by default, see the -:term:`SYSROOT_DIRS* ` variables. You can change -these variables inside your recipe if you need to make additional (or -fewer) directories available to other recipes at build time. - -The ``do_populate_sysroot`` 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"). - -.. _ref-tasks-prepare_recipe_sysroot: - -``do_prepare_recipe_sysroot`` ------------------------------ - -Installs the files into the individual recipe specific sysroots (i.e. -``recipe-sysroot`` and ``recipe-sysroot-native`` under -``${``\ :term:`WORKDIR`\ ``}`` based upon the -dependencies specified by :term:`DEPENDS`). See the -":ref:`staging `" class for more information. - -.. _ref-tasks-rm_work: - -``do_rm_work`` --------------- - -Removes work files after the OpenEmbedded build system has finished with -them. You can learn more by looking at the -":ref:`rm_work.bbclass `" section. - -.. _ref-tasks-unpack: - -``do_unpack`` -------------- - -Unpacks the source code into a working directory pointed to by -``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` -variable also plays a role in where unpacked source files ultimately -reside. For more information on how source files are unpacked, see the -":ref:`overview-manual/concepts:source fetching`" -section in the Yocto Project Overview and Concepts Manual and also see -the ``WORKDIR`` and ``S`` variable descriptions. - -Manually Called Tasks -===================== - -These tasks are typically manually triggered (e.g. by using the -``bitbake -c`` command-line option): - -.. _ref-tasks-checkpkg: - -``do_checkpkg`` ---------------- - -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. - -To check the upstream version and status of a recipe, use the following -devtool commands: -:: - - $ devtool latest-version - $ devtool check-upgrade-status - -See the ":ref:`ref-manual/ref-devtool-reference:\`\`devtool\`\` quick reference`" -chapter for more information on -``devtool``. See the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" -section for information on checking the upgrade status of a recipe. - -To build the ``checkpkg`` task, use the ``bitbake`` command with the -"-c" option and task name: -:: - - $ bitbake core-image-minimal -c checkpkg - -By default, the results are stored in :term:`$LOG_DIR ` (e.g. -``$BUILD_DIR/tmp/log``). - -.. _ref-tasks-checkuri: - -``do_checkuri`` ---------------- - -Validates the :term:`SRC_URI` value. - -.. _ref-tasks-clean: - -``do_clean`` ------------- - -Removes all output files for a target from the -:ref:`ref-tasks-unpack` task forward (i.e. ``do_unpack``, -:ref:`ref-tasks-configure`, -:ref:`ref-tasks-compile`, -:ref:`ref-tasks-install`, and -:ref:`ref-tasks-package`). - -You can run this task using BitBake as follows: -:: - - $ bitbake -c clean recipe - -Running this task does not remove the -:ref:`sstate ` 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 :ref:`ref-tasks-cleansstate` task instead -(i.e. ``bitbake -c cleansstate`` recipe). - -.. _ref-tasks-cleanall: - -``do_cleanall`` ---------------- - -Removes all output files, shared state -(:ref:`sstate `) cache, and -downloaded source files for a target (i.e. the contents of -:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is -identical to the :ref:`ref-tasks-cleansstate` task -with the added removal of downloaded source files. - -You can run this task using BitBake as follows: -:: - - $ bitbake -c cleanall recipe - -Typically, you would not normally use the ``cleanall`` task. Do so only -if you want to start fresh with the :ref:`ref-tasks-fetch` -task. - -.. _ref-tasks-cleansstate: - -``do_cleansstate`` ------------------- - -Removes all output files and shared state -(:ref:`sstate `) cache for a -target. Essentially, the ``do_cleansstate`` task is identical to the -:ref:`ref-tasks-clean` task with the added removal of -shared state (:ref:`sstate `) -cache. - -You can run this task using BitBake as follows: -:: - - $ bitbake -c cleansstate recipe - -When you run the ``do_cleansstate`` task, the OpenEmbedded build system -no longer uses any sstate. Consequently, building the recipe from -scratch is guaranteed. - -.. note:: - - The ``do_cleansstate`` 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: - :: - - $ bitbake -f -c do_cleansstate target - - -.. _ref-tasks-devpyshell: - -``do_devpyshell`` ------------------ - -Starts a shell in which an interactive Python interpreter allows you to -interact with the BitBake build environment. From within this shell, you -can directly examine and set bits from the data store and execute -functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a development python shell`" section in -the Yocto Project Development Tasks Manual for more information about -using ``devpyshell``. - -.. _ref-tasks-devshell: - -``do_devshell`` ---------------- - -Starts a shell whose environment is set up for development, debugging, -or both. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the -Yocto Project Development Tasks Manual for more information about using -``devshell``. - -.. _ref-tasks-listtasks: - -``do_listtasks`` ----------------- - -Lists all defined tasks for a target. - -.. _ref-tasks-package_index: - -``do_package_index`` --------------------- - -Creates or updates the index in the :ref:`overview-manual/concepts:package feeds` area. - -.. note:: - - This task is not triggered with the ``bitbake -c`` command-line option as - are the other tasks in this section. Because this task is specifically for - the ``package-index`` recipe, you run it using ``bitbake package-index``. - -Image-Related Tasks -=================== - -The following tasks are applicable to image recipes. - -.. _ref-tasks-bootimg: - -``do_bootimg`` --------------- - -Creates a bootable live image. See the -:term:`IMAGE_FSTYPES` variable for additional -information on live image types. - -.. _ref-tasks-bundle_initramfs: - -``do_bundle_initramfs`` ------------------------ - -Combines an initial RAM disk (initramfs) image and kernel together to -form a single image. The -:term:`CONFIG_INITRAMFS_SOURCE` variable -has some more information about these types of images. - -.. _ref-tasks-rootfs: - -``do_rootfs`` -------------- - -Creates the root filesystem (file and directory structure) for an image. -See the ":ref:`overview-manual/concepts:image generation`" -section in the Yocto Project Overview and Concepts Manual for more -information on how the root filesystem is created. - -.. _ref-tasks-testimage: - -``do_testimage`` ----------------- - -Boots an image and performs runtime tests within the image. For -information on automatically testing images, see the -":ref:`dev-manual/common-tasks:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. - -.. _ref-tasks-testimage_auto: - -``do_testimage_auto`` ---------------------- - -Boots an image and performs runtime tests within the image immediately -after it has been built. This task is enabled when you set -:term:`TESTIMAGE_AUTO` equal to "1". - -For information on automatically testing images, see the -":ref:`dev-manual/common-tasks:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. - -Kernel-Related Tasks -==================== - -The following tasks are applicable to kernel recipes. Some of these -tasks (e.g. the :ref:`ref-tasks-menuconfig` task) are -also applicable to recipes that use Linux kernel style configuration -such as the BusyBox recipe. - -.. _ref-tasks-compile_kernelmodules: - -``do_compile_kernelmodules`` ----------------------------- - -Runs the step that builds the kernel modules (if needed). Building a -kernel consists of two steps: 1) the kernel (``vmlinux``) is built, and -2) the modules are built (i.e. ``make modules``). - -.. _ref-tasks-diffconfig: - -``do_diffconfig`` ------------------ - -When invoked by the user, this task creates a file containing the -differences between the original config as produced by -:ref:`ref-tasks-kernel_configme` task and the -changes made by the user with other methods (i.e. using -(:ref:`ref-tasks-kernel_menuconfig`). Once the -file of differences is created, it can be used to create a config -fragment that only contains the differences. You can invoke this task -from the command line as follows: -:: - - $ bitbake linux-yocto -c diffconfig - -For more information, see the -":ref:`kernel-dev/common:creating configuration fragments`" -section in the Yocto Project Linux Kernel Development Manual. - -.. _ref-tasks-kernel_checkout: - -``do_kernel_checkout`` ----------------------- - -Converts the newly unpacked kernel source into a form with which the -OpenEmbedded build system can work. Because the kernel source can be -fetched in several different ways, the ``do_kernel_checkout`` task makes -sure that subsequent tasks are given a clean working tree copy of the -kernel with the correct branches checked out. - -.. _ref-tasks-kernel_configcheck: - -``do_kernel_configcheck`` -------------------------- - -Validates the configuration produced by the -:ref:`ref-tasks-kernel_menuconfig` task. The -``do_kernel_configcheck`` task produces warnings when a requested -configuration does not appear in the final ``.config`` file or when you -override a policy configuration in a hardware configuration fragment. -You can run this task explicitly and view the output by using the -following command: -:: - - $ bitbake linux-yocto -c kernel_configcheck -f - -For more information, see the -":ref:`kernel-dev/common:validating configuration`" -section in the Yocto Project Linux Kernel Development Manual. - -.. _ref-tasks-kernel_configme: - -``do_kernel_configme`` ----------------------- - -After the kernel is patched by the :ref:`ref-tasks-patch` -task, the ``do_kernel_configme`` task assembles and merges all the -kernel config fragments into a merged configuration that can then be -passed to the kernel configuration phase proper. This is also the time -during which user-specified defconfigs are applied if present, and where -configuration modes such as ``--allnoconfig`` are applied. - -.. _ref-tasks-kernel_menuconfig: - -``do_kernel_menuconfig`` ------------------------- - -Invoked by the user to manipulate the ``.config`` file used to build a -linux-yocto recipe. This task starts the Linux kernel configuration -tool, which you then use to modify the kernel configuration. - -.. note:: - - You can also invoke this tool from the command line as follows: - :: - - $ bitbake linux-yocto -c menuconfig - - -See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" -section in the Yocto Project Linux Kernel Development Manual for more -information on this configuration tool. - -.. _ref-tasks-kernel_metadata: - -``do_kernel_metadata`` ----------------------- - -Collects all the features required for a given kernel build, whether the -features come from :term:`SRC_URI` or from Git -repositories. After collection, the ``do_kernel_metadata`` task -processes the features into a series of config fragments and patches, -which can then be applied by subsequent tasks such as -:ref:`ref-tasks-patch` and -:ref:`ref-tasks-kernel_configme`. - -.. _ref-tasks-menuconfig: - -``do_menuconfig`` ------------------ - -Runs ``make menuconfig`` for the kernel. For information on -``menuconfig``, see the -":ref:`kernel-dev/common:using \`\`menuconfig\`\``" -section in the Yocto Project Linux Kernel Development Manual. - -.. _ref-tasks-savedefconfig: - -``do_savedefconfig`` --------------------- - -When invoked by the user, creates a defconfig file that can be used -instead of the default defconfig. The saved defconfig contains the -differences between the default defconfig and the changes made by the -user using other methods (i.e. the -:ref:`ref-tasks-kernel_menuconfig` task. You -can invoke the task using the following command: -:: - - $ bitbake linux-yocto -c savedefconfig - -.. _ref-tasks-shared_workdir: - -``do_shared_workdir`` ---------------------- - -After the kernel has been compiled but before the kernel modules have -been compiled, this task copies files required for module builds and -which are generated from the kernel build into the shared work -directory. With these copies successfully copied, the -:ref:`ref-tasks-compile_kernelmodules` task -can successfully build the kernel modules in the next step of the build. - -.. _ref-tasks-sizecheck: - -``do_sizecheck`` ----------------- - -After the kernel has been built, this task checks the size of the -stripped kernel image against -:term:`KERNEL_IMAGE_MAXSIZE`. If that -variable was set and the size of the stripped kernel exceeds that size, -the kernel build produces a warning to that effect. - -.. _ref-tasks-strip: - -``do_strip`` ------------- - -If ``KERNEL_IMAGE_STRIP_EXTRA_SECTIONS`` is defined, this task strips -the sections named in that variable from ``vmlinux``. This stripping is -typically used to remove nonessential sections such as ``.comment`` -sections from a size-sensitive configuration. - -.. _ref-tasks-validate_branches: - -``do_validate_branches`` ------------------------- - -After the kernel is unpacked but before it is patched, this task makes -sure that the machine and metadata branches as specified by the -:term:`SRCREV` variables actually exist on the specified -branches. If these branches do not exist and -:term:`AUTOREV` is not being used, the -``do_validate_branches`` task fails during the build. diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst deleted file mode 100644 index f41073602d..0000000000 --- a/documentation/ref-manual/ref-terms.rst +++ /dev/null @@ -1,390 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -******************* -Yocto Project Terms -******************* - -Following is a list of terms and definitions users new to the Yocto Project -development environment might find helpful. While some of these terms are -universal, the list includes them just in case: - -.. glossary:: - - :term:`Append Files` - Files that append build information to a recipe file. Append files are - known as BitBake append files and ``.bbappend`` files. The OpenEmbedded - build system expects every append file to have a corresponding recipe - (``.bb``) file. Furthermore, the append file and corresponding recipe file - must use the same root filename. The filenames can differ only in the - file type suffix used (e.g. ``formfactor_0.0.bb`` and - ``formfactor_0.0.bbappend``). - - Information in append files extends or overrides the information in the - similarly-named recipe file. For an example of an append file in use, see - the ":ref:`dev-manual/common-tasks:Using .bbappend Files in - Your Layer`" section in the Yocto Project Development Tasks Manual. - - When you name an append file, you can use the "``%``" wildcard character - to allow for matching recipe names. For example, suppose you have an - append file named as follows: - :: - - busybox_1.21.%.bbappend - - That append file - would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So, - the append file would match any of the following recipe names: - - .. code-block:: shell - - busybox_1.21.1.bb - busybox_1.21.2.bb - busybox_1.21.3.bb - busybox_1.21.10.bb - busybox_1.21.25.bb - - .. note:: - - The use of the "%" character is limited in that it only works - directly in front of the .bbappend portion of the append file's - name. You cannot use the wildcard character in any other location of - the name. - - :term:`BitBake` - The task executor and scheduler used by the OpenEmbedded build system to - build images. For more information on BitBake, see the :doc:`BitBake User - Manual `. - - :term:`Board Support Package (BSP)` - A group of drivers, definitions, and other components that provide support - for a specific hardware configuration. For more information on BSPs, see - the :doc:`/bsp-guide/index`. - - :term:`Build Directory` - This term refers to the area used by the OpenEmbedded build system for - builds. The area is created when you ``source`` the setup environment - script that is found in the Source Directory - (i.e. :ref:`ref-manual/ref-structure:\`\`oe-init-build-env\`\``). The - :term:`TOPDIR` variable points to the Build Directory. - - You have a lot of flexibility when creating the Build Directory. - Following are some examples that show how to create the directory. The - examples assume your :term:`Source Directory` is named ``poky``: - - - Create the Build Directory inside your Source Directory and let - the name of the Build Directory default to ``build``: - - .. code-block:: shell - - $ cd $HOME/poky - $ source oe-init-build-env - - - Create the Build Directory inside your home directory and - specifically name it ``test-builds``: - - .. code-block:: shell - - $ cd $HOME - $ source poky/oe-init-build-env test-builds - - - Provide a directory path and specifically name the Build - Directory. Any intermediate folders in the pathname must exist. - This next example creates a Build Directory named - ``YP-POKYVERSION`` in your home directory within the existing - directory ``mybuilds``: - - .. code-block:: shell - - $ cd $HOME - $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-POKYVERSION - - .. note:: - - By default, the Build Directory contains :term:`TMPDIR`, which is a - temporary directory the build system uses for its work. ``TMPDIR`` cannot - be under NFS. Thus, by default, the Build Directory cannot be under - NFS. However, if you need the Build Directory to be under NFS, you can - set this up by setting ``TMPDIR`` in your ``local.conf`` file to use a local - drive. Doing so effectively separates ``TMPDIR`` from :term:`TOPDIR`, which is the - Build Directory. - - :term:`Build Host` - The system used to build images in a Yocto Project Development - environment. The build system is sometimes referred to as the development - host. - - :term:`Classes` - Files that provide for logic encapsulation and inheritance so that - commonly used patterns can be defined once and then easily used in - multiple recipes. For reference information on the Yocto Project classes, - see the ":ref:`ref-manual/ref-classes:Classes`" chapter. Class files end with the - ``.bbclass`` filename extension. - - :term:`Configuration File` - Files that hold global definitions of variables, user-defined variables, - and hardware configuration information. These files tell the OpenEmbedded - build system what to build and what to put into the image to support a - particular platform. - - Configuration files end with a ``.conf`` filename extension. The - :file:`conf/local.conf` configuration file in the :term:`Build Directory` - contains user-defined variables that affect every build. The - :file:`meta-poky/conf/distro/poky.conf` configuration file defines Yocto - "distro" configuration variables used only when building with this - policy. Machine configuration files, which are located throughout the - :term:`Source Directory`, define variables for specific hardware and are - only used when building for that target (e.g. the - :file:`machine/beaglebone.conf` configuration file defines variables for - the Texas Instruments ARM Cortex-A8 development board). - - :term:`Container Layer` - Layers that hold other layers. An example of a container layer is - OpenEmbedded's `meta-openembedded - `_ layer. The - ``meta-openembedded`` layer contains many ``meta-*`` layers. - - :term:`Cross-Development Toolchain` - In general, a cross-development toolchain is a collection of software - development tools and utilities that run on one architecture and allow you - to develop software for a different, or targeted, architecture. These - toolchains contain cross-compilers, linkers, and debuggers that are - specific to the target architecture. - - The Yocto Project supports two different cross-development toolchains: - - - A toolchain only used by and within BitBake when building an image for a - target architecture. - - - A relocatable toolchain used outside of BitBake by developers when - developing applications that will run on a targeted device. - - Creation of these toolchains is simple and automated. For information on - toolchain concepts as they apply to the Yocto Project, see the - ":ref:`overview-manual/concepts:Cross-Development - Toolchain Generation`" section in the Yocto Project Overview and Concepts - Manual. You can also find more information on using the relocatable - toolchain in the :doc:`/sdk-manual/index` manual. - - :term:`Extensible Software Development Kit (eSDK)` - A custom SDK for application developers. This eSDK allows developers to - incorporate their library and programming changes back into the image to - make their code available to other application developers. - - For information on the eSDK, see the :doc:`/sdk-manual/index` manual. - - :term:`Image` - An image is an artifact of the BitBake build process given a collection of - recipes and related Metadata. Images are the binary output that run on - specific hardware or QEMU and are used for specific use-cases. For a list - of the supported image types that the Yocto Project provides, see the - ":ref:`ref-manual/ref-images:Images`" chapter. - - :term:`Layer` - A collection of related recipes. Layers allow you to consolidate related - metadata to customize your build. Layers also isolate information used - when building for multiple architectures. Layers are hierarchical in - their ability to override previous specifications. You can include any - number of available layers from the Yocto Project and customize the build - by adding your layers after them. You can search the Layer Index for - layers used within Yocto Project. - - For introductory information on layers, see the - ":ref:`overview-manual/yp-intro:The Yocto Project Layer - Model`" section in the Yocto Project Overview and Concepts Manual. For - more detailed information on layers, see the - ":ref:`dev-manual/common-tasks:Understanding and Creating - Layers`" section in the Yocto Project Development Tasks Manual. For a - discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP - Layers`" section in the Yocto Project Board Support Packages (BSP) - Developer's Guide. - - :term:`Metadata` - A key element of the Yocto Project is the Metadata that - is used to construct a Linux distribution and is contained in the - files that the :term:`OpenEmbedded Build System` - parses when building an image. In general, Metadata includes recipes, - configuration files, and other information that refers to the build - instructions themselves, as well as the data used to control what - things get built and the effects of the build. Metadata also includes - commands and data used to indicate what versions of software are - used, from where they are obtained, and changes or additions to the - software itself (patches or auxiliary files) that are used to fix - bugs or customize the software for use in a particular situation. - OpenEmbedded-Core is an important set of validated metadata. - - In the context of the kernel ("kernel Metadata"), the term refers to - the kernel config fragments and features contained in the - :yocto_git:`yocto-kernel-cache ` - Git repository. - - :term:`OpenEmbedded-Core (OE-Core)` - OE-Core is metadata comprised of - foundational recipes, classes, and associated files that are meant to - be common among many different OpenEmbedded-derived systems, - including the Yocto Project. OE-Core is a curated subset of an - original repository developed by the OpenEmbedded community that has - been pared down into a smaller, core set of continuously validated - recipes. The result is a tightly controlled and an quality-assured - core set of recipes. - - You can see the Metadata in the ``meta`` directory of the Yocto - Project :yocto_git:`Source Repositories `. - - :term:`OpenEmbedded Build System` - The build system specific to the Yocto - Project. The OpenEmbedded build system is based on another project - known as "Poky", which uses :term:`BitBake` as the task - executor. Throughout the Yocto Project documentation set, the - OpenEmbedded build system is sometimes referred to simply as "the - build system". If other build systems, such as a host or target build - system are referenced, the documentation clearly states the - difference. - - .. note:: - - For some historical information about Poky, see the :term:`Poky` term. - - :term:`Package` - In the context of the Yocto Project, this term refers to a - recipe's packaged output produced by BitBake (i.e. a "baked recipe"). - A package is generally the compiled binaries produced from the - recipe's sources. You "bake" something by running it through BitBake. - - It is worth noting that the term "package" can, in general, have - subtle meanings. For example, the packages referred to in the - ":ref:`ref-manual/ref-system-requirements:required packages for the build host`" - section are compiled binaries that, when installed, add functionality to - your Linux distribution. - - Another point worth noting is that historically within the Yocto - Project, recipes were referred to as packages - thus, the existence - of several BitBake variables that are seemingly mis-named, (e.g. - :term:`PR`, :term:`PV`, and - :term:`PE`). - - :term:`Package Groups` - Arbitrary groups of software Recipes. You use - package groups to hold recipes that, when built, usually accomplish a - single task. For example, a package group could contain the recipes - for a company's proprietary or value-add software. Or, the package - group could contain the recipes that enable graphics. A package group - is really just another recipe. Because package group files are - recipes, they end with the ``.bb`` filename extension. - - :term:`Poky` - Poky, which is pronounced *Pock*-ee, is a reference embedded - distribution and a reference test configuration. Poky provides the - following: - - - A base-level functional distro used to illustrate how to customize - a distribution. - - - A means by which to test the Yocto Project components (i.e. Poky - is used to validate the Yocto Project). - - - A vehicle through which you can download the Yocto Project. - - Poky is not a product level distro. Rather, it is a good starting - point for customization. - - .. note:: - - Poky began as an open-source project initially developed by - OpenedHand. OpenedHand developed Poky from the existing - OpenEmbedded build system to create a commercially supportable - build system for embedded Linux. After Intel Corporation acquired - OpenedHand, the poky project became the basis for the Yocto - Project's build system. - - :term:`Recipe` - A set of instructions for building packages. A recipe - describes where you get source code, which patches to apply, how to - configure the source, how to compile it and so on. Recipes also - describe dependencies for libraries or for other recipes. Recipes - represent the logical unit of execution, the software to build, the - images to build, and use the ``.bb`` file extension. - - :term:`Reference Kit` - A working example of a system, which includes a - :term:`BSP` as well as a - :term:`build host` and other components, that can - work on specific hardware. - - :term:`Source Directory` - This term refers to the directory structure - created as a result of creating a local copy of the ``poky`` Git - repository ``git://git.yoctoproject.org/poky`` or expanding a - released ``poky`` tarball. - - .. note:: - - Creating a local copy of the - poky - Git repository is the recommended method for setting up your - Source Directory. - - Sometimes you might hear the term "poky directory" used to refer to - this directory structure. - - .. 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. - - The Source Directory contains BitBake, Documentation, Metadata and - other files that all support the Yocto Project. Consequently, you - must have the Source Directory in place on your development system in - order to do any development using the Yocto Project. - - When you create a local copy of the Git repository, you can name the - repository anything you like. Throughout much of the documentation, - "poky" is used as the name of the top-level folder of the local copy - of the poky Git repository. So, for example, cloning the ``poky`` Git - repository results in a local Git repository whose top-level folder - is also named "poky". - - While it is not recommended that you use tarball expansion to set up - the Source Directory, if you do, the top-level directory name of the - Source Directory is derived from the Yocto Project release tarball. - For example, downloading and unpacking - :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2` - results in a Source Directory whose root folder is named ``poky``. - - It is important to understand the differences between the Source - Directory created by unpacking a released tarball as compared to - cloning ``git://git.yoctoproject.org/poky``. When you unpack a - tarball, you have an exact copy of the files based on the time of - release - a fixed release point. Any changes you make to your local - files in the Source Directory are on top of the release and will - remain local only. On the other hand, when you clone the ``poky`` Git - repository, you have an active development repository with access to - the upstream repository's branches and tags. In this case, any local - changes you make to the local Source Directory can be later applied - to active development branches of the upstream ``poky`` Git - repository. - - For more information on concepts related to Git repositories, - branches, and tags, see the - ":ref:`overview-manual/development-environment:repositories, tags, and branches`" - section in the Yocto Project Overview and Concepts Manual. - - :term:`Task` - A unit of execution for BitBake (e.g. - :ref:`ref-tasks-compile`, - :ref:`ref-tasks-fetch`, - :ref:`ref-tasks-patch`, and so forth). - - :term:`Toaster` - A web interface to the Yocto Project's :term:`OpenEmbedded Build System`. - The interface enables you to - configure and run your builds. Information about builds is collected - and stored in a database. For information on Toaster, see the - :doc:`/toaster-manual/index`. - - :term:`Upstream` - A reference to source code or repositories that are not - local to the development system but located in a master area that is - controlled by the maintainer of the source code. For example, in - order for a developer to work on a particular piece of code, they - need to first get a copy of it from an "upstream" source. diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst deleted file mode 100644 index 865d17c1fc..0000000000 --- a/documentation/ref-manual/ref-variables.rst +++ /dev/null @@ -1,8807 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -****************** -Variables Glossary -****************** - -This chapter lists common variables used in the OpenEmbedded build -system and gives an overview of their function and contents. - -:term:`A ` :term:`B` :term:`C ` -:term:`D` :term:`E ` :term:`F ` -:term:`G ` :term:`H ` :term:`I ` -:term:`K ` :term:`L ` :term:`M ` -:term:`N ` :term:`O ` :term:`P` -:term:`R ` :term:`S` :term:`T` -:term:`U ` :term:`V ` -:term:`W ` :term:`X ` - -.. glossary:: - - :term:`ABIEXTENSION` - Extension to the Application Binary Interface (ABI) field of the GNU - canonical architecture name (e.g. "eabi"). - - ABI extensions are set in the machine include files. For example, the - ``meta/conf/machine/include/arm/arch-arm.inc`` file sets the - following extension: - :: - - ABIEXTENSION = "eabi" - - :term:`ALLOW_EMPTY` - Specifies whether to produce an output package even if it is empty. - By default, BitBake does not produce empty packages. This default - behavior can cause issues when there is an - :term:`RDEPENDS` or some other hard runtime - requirement on the existence of the package. - - Like all package-controlling variables, you must always use them in - conjunction with a package name override, as in: - :: - - ALLOW_EMPTY_${PN} = "1" - ALLOW_EMPTY_${PN}-dev = "1" - ALLOW_EMPTY_${PN}-staticdev = "1" - - :term:`ALTERNATIVE` - 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. - - To use the variable, list out the package's commands that also exist - as part of another package. For example, if the ``busybox`` package - has four commands that also exist as part of another package, you - identify them as follows: - :: - - ALTERNATIVE_busybox = "sh sed test bracket" - - For more information on the alternatives system, see the - ":ref:`update-alternatives.bbclass `" - section. - - :term:`ALTERNATIVE_LINK_NAME` - Used by the alternatives system to map duplicated commands to actual - locations. For example, if the ``bracket`` command provided by the - ``busybox`` package is duplicated through another package, you must - use the ``ALTERNATIVE_LINK_NAME`` variable to specify the actual - location: - :: - - ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/[" - - In this example, the binary for the ``bracket`` command (i.e. ``[``) - from the ``busybox`` package resides in ``/usr/bin/``. - - .. note:: - - If ``ALTERNATIVE_LINK_NAME`` is not defined, it defaults to ``${bindir}/name``. - - For more information on the alternatives system, see the - ":ref:`update-alternatives.bbclass `" - section. - - :term:`ALTERNATIVE_PRIORITY` - 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: - :: - - ALTERNATIVE_PRIORITY = "priority" - ALTERNATIVE_PRIORITY[name] = "priority" - ALTERNATIVE_PRIORITY_pkg[name] = "priority" - - For more information on the alternatives system, see the - ":ref:`update-alternatives.bbclass `" - section. - - :term:`ALTERNATIVE_TARGET` - 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: - :: - - ALTERNATIVE_TARGET = "target" - ALTERNATIVE_TARGET[name] = "target" - ALTERNATIVE_TARGET_pkg[name] = "target" - - .. note:: - - If ``ALTERNATIVE_TARGET`` is not defined, it inherits the value - from the :term:`ALTERNATIVE_LINK_NAME` variable. - - If ``ALTERNATIVE_LINK_NAME`` and ``ALTERNATIVE_TARGET`` are the - same, the target for ``ALTERNATIVE_TARGET`` has "``.{BPN}``" - appended to it. - - 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 :ref:`ref-tasks-install` - task while retaining support for the command if necessary. - - For more information on the alternatives system, see the - ":ref:`update-alternatives.bbclass `" - section. - - :term:`ANY_OF_DISTRO_FEATURES` - When inheriting the - :ref:`features_check ` - class, this variable identifies a list of distribution features where - at least one must be enabled in the current configuration in order - for the OpenEmbedded build system to build the recipe. In other words, - if none of the features listed in ``ANY_OF_DISTRO_FEATURES`` - appear in ``DISTRO_FEATURES`` within the current configuration, then - the recipe will be skipped, and if the build system attempts to build - the recipe then an error will be triggered. - - - :term:`APPEND` - An override list of append strings for each target specified with - :term:`LABELS`. - - See the :ref:`grub-efi ` class for more - information on how this variable is used. - - :term:`AR` - The minimal command and arguments used to run ``ar``. - - :term:`ARCHIVER_MODE` - When used with the :ref:`archiver ` 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): - :: - - 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] ?= "file file ..." # 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. - - For information on how the variable works, see the - ``meta/classes/archiver.bbclass`` file in the :term:`Source Directory`. - - :term:`AS` - Minimal command and arguments needed to run the assembler. - - :term:`ASSUME_PROVIDED` - Lists recipe names (:term:`PN` values) BitBake does not - attempt to build. Instead, BitBake assumes these recipes have already - been built. - - In OpenEmbedded-Core, ``ASSUME_PROVIDED`` mostly specifies native - tools that should not be built. An example is ``git-native``, which - when specified, allows for the Git binary from the host to be used - rather than building ``git-native``. - - :term:`ASSUME_SHLIBS` - Provides additional ``shlibs`` provider mapping information, which - adds to or overwrites the information provided automatically by the - system. Separate multiple entries using spaces. - - As an example, use the following form to add an ``shlib`` provider of - shlibname in packagename with the optional version: - :: - - shlibname:packagename[_version] - - Here is an example that adds a shared library named ``libEGL.so.1`` - as being provided by the ``libegl-implementation`` package: - :: - - ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation" - - :term:`AUTHOR` - The email address used to contact the original author or authors in - order to send patches and forward bugs. - - :term:`AUTO_LIBNAME_PKGS` - When the :ref:`debian ` class is inherited, - which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which - packages should be checked for libraries and renamed according to - Debian library package naming. - - The default value is "${PACKAGES}", which causes the debian class to - act on all packages that are explicitly generated by the recipe. - - :term:`AUTO_SYSLINUXMENU` - Enables creating an automatic menu for the syslinux bootloader. You - must set this variable in your recipe. The - :ref:`syslinux ` class checks this variable. - - :term:`AUTOREV` - When ``SRCREV`` is set to the value of this variable, it specifies to - use the latest source revision in the repository. Here is an example: - :: - - SRCREV = "${AUTOREV}" - - If you use the previous statement to retrieve the latest version of - software, you need to be sure :term:`PV` contains - ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you - have a kernel recipe that inherits the - :ref:`kernel ` class and you use the previous - statement. In this example, ``${SRCPV}`` does not automatically get - into ``PV``. Consequently, you need to change ``PV`` in your recipe - so that it does contain ``${SRCPV}``. - - For more information see the - ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" - section in the Yocto Project Development Tasks Manual. - - :term:`AVAILABLE_LICENSES` - List of licenses found in the directories specified by - :term:`COMMON_LICENSE_DIR` and - :term:`LICENSE_PATH`. - - .. note:: - - It is assumed that all changes to ``COMMON_LICENSE_DIR`` and - ``LICENSE_PATH`` have been done before ``AVAILABLE_LICENSES`` - is defined (in :ref:`ref-classes-license`). - - :term:`AVAILTUNES` - The list of defined CPU and Application Binary Interface (ABI) - tunings (i.e. "tunes") available for use by the OpenEmbedded build - system. - - 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 - :ref:`Multilib ` - configuration. - - 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 - ":ref:`Basic Syntax `" section in the BitBake - User Manual for more information. - - :term:`B` - The directory within the :term:`Build Directory` in - which the OpenEmbedded build system places generated objects during a - recipe's build process. By default, this directory is the same as the - :term:`S` directory, which is defined as: - :: - - S = "${WORKDIR}/${BP}" - - You can separate the (``S``) directory and the directory pointed to - by the ``B`` variable. Most Autotools-based recipes support - separating these directories. The build system defaults to using - separate directories for ``gcc`` and some kernel recipes. - - :term:`BAD_RECOMMENDATIONS` - Lists "recommended-only" packages to not install. Recommended-only - packages are packages installed only through the - :term:`RRECOMMENDS` variable. You can prevent any - of these "recommended" packages from being installed by listing them - with the ``BAD_RECOMMENDATIONS`` variable: - :: - - BAD_RECOMMENDATIONS = "package_name package_name package_name ..." - - You can set this variable globally in your ``local.conf`` file or you - can attach it to a specific image recipe by using the recipe name - override: - :: - - BAD_RECOMMENDATIONS_pn-target_image = "package_name" - - 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 :term:`RDEPENDS` - variable), the OpenEmbedded build system ignores your request and - will install the packages to avoid dependency errors. - - Support for this variable exists only when using the IPK and RPM - packaging backend. Support does not exist for DEB. - - See the :term:`NO_RECOMMENDATIONS` and the - :term:`PACKAGE_EXCLUDE` variables for related - information. - - :term:`BASE_LIB` - The library directory name for the CPU or Application Binary - Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib - context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" - section in the Yocto Project Development Tasks Manual for information - on Multilib. - - The ``BASE_LIB`` variable is defined in the machine include files in - the :term:`Source Directory`. If Multilib is not - being used, the value defaults to "lib". - - :term:`BASE_WORKDIR` - Points to the base of the work directory for all recipes. The default - value is "${TMPDIR}/work". - - :term:`BB_ALLOWED_NETWORKS` - 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: - - - This host list is only used if ``BB_NO_NETWORK`` is either not set - or set to "0". - - - Limited support for wildcard matching against the beginning of - host names exists. For example, the following setting matches - ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``. - :: - - BB_ALLOWED_NETWORKS = "*.gnu.org" - - .. note:: - - The use of the "``*``" character only works at the beginning of - a host name and it must be isolated from the remainder of the - host name. You cannot use the wildcard character in any other - location of the name or combined with the front part of the - name. - - For example, ``*.foo.bar`` is supported, while ``*aa.foo.bar`` - is not. - - - Mirrors not in the host list are skipped and logged in debug. - - - Attempts to access networks not in the host list cause a failure. - - Using ``BB_ALLOWED_NETWORKS`` in conjunction with - :term:`PREMIRRORS` is very useful. Adding the host - you want to use to ``PREMIRRORS`` 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 :term:`SRC_URI` - statement. This is because the fetcher does not attempt to use the - host listed in ``SRC_URI`` after a successful fetch from the - ``PREMIRRORS`` occurs. - - :term:`BB_DANGLINGAPPENDS_WARNONLY` - Defines how BitBake handles situations where an append file - (``.bbappend``) has no corresponding recipe file (``.bb``). This - condition often occurs when layers get out of sync (e.g. ``oe-core`` - 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). - - 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. - - You can change the default behavior by setting this variable to "1", - "yes", or "true" in your ``local.conf`` file, which is located in the - :term:`Build Directory`: Here is an example: - :: - - BB_DANGLINGAPPENDS_WARNONLY = "1" - - :term:`BB_DISKMON_DIRS` - Monitors disk space and available inodes during the build and allows - you to control the build based on these parameters. - - Disk space monitoring is disabled by default. To enable monitoring, - add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file - found in the :term:`Build Directory`. Use the - following form: - - .. code-block:: none - - BB_DISKMON_DIRS = "action,dir,threshold [...]" - - where: - - action 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 BB_DISKMON_WARNINTERVAL - variable, which must be defined in - the conf/local.conf file. - - dir 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. - - threshold 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. - - Here are some examples: - :: - - BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" - BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" - BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" - - The first example works only if you also provide the - :term:`BB_DISKMON_WARNINTERVAL` - variable in the ``conf/local.conf``. This example causes the build - system to immediately abort when either the disk space in - ``${TMPDIR}`` 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 ``${SSTATE_DIR}`` 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 ``BB_DISKMON_WARNINTERVAL`` - variable. - - The second example stops the build after all currently executing - tasks complete when the minimum disk space in the ``${TMPDIR}`` - directory drops below 1 Gbyte. No disk monitoring occurs for the free - inodes in this case. - - The final example immediately aborts the build when the number of - free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No - disk space monitoring for the directory itself occurs in this case. - - :term:`BB_DISKMON_WARNINTERVAL` - Defines the disk space and free inode warning intervals. To set these - intervals, define the variable in your ``conf/local.conf`` file in - the :term:`Build Directory`. - - If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you - must also use the :term:`BB_DISKMON_DIRS` - 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. - - If you do not provide a ``BB_DISKMON_WARNINTERVAL`` variable and you - do use ``BB_DISKMON_DIRS`` with the "WARN" action, the disk - monitoring interval defaults to the following: - :: - - BB_DISKMON_WARNINTERVAL = "50M,5K" - - When specifying the variable in your configuration file, use the - following form: - - .. code-block:: none - - BB_DISKMON_WARNINTERVAL = "disk_space_interval,disk_inode_interval" - - where: - - disk_space_interval 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. - - disk_inode_interval 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. - - Here is an example: - :: - - BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K" - BB_DISKMON_WARNINTERVAL = "50M,5K" - - 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 ``${SSTATE_DIR}`` - 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). - - :term:`BB_GENERATE_MIRROR_TARBALLS` - Causes tarballs of the source control repositories (e.g. Git - repositories), including metadata, to be placed in the - :term:`DL_DIR` directory. - - For performance reasons, creating and placing tarballs of these - repositories is not the default action by the OpenEmbedded build - system. - :: - - BB_GENERATE_MIRROR_TARBALLS = "1" - - Set this variable in your - ``local.conf`` file in the :term:`Build Directory`. - - Once you have the tarballs containing your source files, you can - clean up your ``DL_DIR`` directory by deleting any Git or other - source control work directories. - - :term:`BB_NUMBER_THREADS` - 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 ``BB_NUMBER_THREADS`` variable to default - to "4". - - 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 ``BB_NUMBER_THREADS`` variable - is not set higher than "20". - - For more information on speeding up builds, see the - ":ref:`dev-manual/common-tasks:speeding up a build`" - section in the Yocto Project Development Tasks Manual. - - :term:`BB_SERVER_TIMEOUT` - Specifies the time (in seconds) after which to unload the BitBake - server due to inactivity. Set ``BB_SERVER_TIMEOUT`` to determine how - long the BitBake server stays resident between invocations. - - For example, the following statement in your ``local.conf`` file - instructs the server to be unloaded after 20 seconds of inactivity: - :: - - BB_SERVER_TIMEOUT = "20" - - If you want the server to never be unloaded, - set ``BB_SERVER_TIMEOUT`` to "-1". - - :term:`BBCLASSEXTEND` - Allows you to extend a recipe so that it builds variants of the - software. Common variants for recipes exist such as "natives" like - ``quilt-native``, which is a copy of Quilt built to run on the build - system; "crosses" such as ``gcc-cross``, which is a compiler built to - run on the build machine but produces binaries that run on the target - :term:`MACHINE`; "nativesdk", which targets the SDK - machine instead of ``MACHINE``; and "mulitlibs" in the form - "``multilib:``\ multilib_name". - - 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: - :: - - BBCLASSEXTEND =+ "native nativesdk" - BBCLASSEXTEND =+ "multilib:multilib_name" - - .. note:: - - Internally, the ``BBCLASSEXTEND`` mechanism generates recipe - variants by rewriting variable values and applying overrides such - as ``_class-native``. For example, to generate a native version of - a recipe, a :term:`DEPENDS` on "foo" is rewritten - to a ``DEPENDS`` on "foo-native". - - Even when using ``BBCLASSEXTEND``, the recipe is only parsed once. - Parsing once adds some limitations. For example, it is not - possible to include a different file depending on the variant, - since ``include`` statements are processed when the recipe is - parsed. - - :term:`BBFILE_COLLECTIONS` - Lists the names of configured layers. These names are used to find - the other ``BBFILE_*`` variables. Typically, each layer will append - its name to this variable in its ``conf/layer.conf`` file. - - :term:`BBFILE_PATTERN` - Variable that expands to match files from - :term:`BBFILES` in a particular layer. This variable - is used in the ``conf/layer.conf`` file and must be suffixed with the - name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``). - - :term:`BBFILE_PRIORITY` - Assigns the priority for recipe files in each layer. - - 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 (:term:`PV` variable). For - example, a layer that has a recipe with a higher ``PV`` value but for - which the ``BBFILE_PRIORITY`` is set to have a lower precedence still - has a lower precedence. - - A larger value for the ``BBFILE_PRIORITY`` variable results in a - higher precedence. For example, the value 6 has a higher precedence - than the value 5. If not specified, the ``BBFILE_PRIORITY`` variable - is set based on layer dependencies (see the ``LAYERDEPENDS`` 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). - - .. tip:: - - You can use the command ``bitbake-layers show-layers`` - to list all configured layers along with their priorities. - - :term:`BBFILES` - A space-separated list of recipe files BitBake uses to build - software. - - When specifying recipe files, you can pattern match using Python's - `glob `_ syntax. - For details on the syntax, see the documentation by following the - previous link. - - :term:`BBFILES_DYNAMIC` - Activates content when identified layers are present. You identify - the layers by the collections that the layers define. - - Use the ``BBFILES_DYNAMIC`` variable to avoid ``.bbappend`` files - whose corresponding ``.bb`` file is in a layer that attempts to - modify other layers through ``.bbappend`` but does not want to - introduce a hard dependency on those other layers. - - Use the following form for ``BBFILES_DYNAMIC``: - collection_name:filename_pattern The following example identifies two - collection names and two filename patterns: - :: - - BBFILES_DYNAMIC += " \ - clang-layer:${LAYERDIR}/bbappends/meta-clang/*/*/*.bbappend \ - core:${LAYERDIR}/bbappends/openembedded-core/meta/*/*/*.bbappend \ - " - - This next example shows an error message that occurs because invalid - entries are found, which cause parsing to abort: - - .. code-block:: none - - ERROR: BBFILES_DYNAMIC entries must be of the form :, not: - /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend - /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend - - :term:`BBINCLUDELOGS` - Variable that controls how BitBake displays logs on build failure. - - :term:`BBINCLUDELOGS_LINES` - If :term:`BBINCLUDELOGS` 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 ``BBINCLUDELOGS_LINES``, - the entire log is printed. - - :term:`BBLAYERS` - Lists the layers to enable during the build. This variable is defined - in the ``bblayers.conf`` configuration file in the :term:`Build Directory`. - Here is an example: - :: - - BBLAYERS = " \ - /home/scottrif/poky/meta \ - /home/scottrif/poky/meta-poky \ - /home/scottrif/poky/meta-yocto-bsp \ - /home/scottrif/poky/meta-mykernel \ - " - - This example enables four layers, one of which is a custom, - user-defined layer named ``meta-mykernel``. - - :term:`BBMASK` - Prevents BitBake from processing recipes and recipe append files. - - You can use the ``BBMASK`` variable to "hide" these ``.bb`` and - ``.bbappend`` 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. - - The values you provide are passed to Python's regular expression - compiler. Consequently, the syntax follows Python's Regular - Expression (re) syntax. The expressions are compared against the full - paths to the files. For complete syntax information, see Python's - documentation at https://docs.python.org/3/library/re.html#regular-expression-syntax. - - The following example uses a complete regular expression to tell - BitBake to ignore all recipe and recipe append files in the - ``meta-ti/recipes-misc/`` directory: - :: - - BBMASK = "meta-ti/recipes-misc/" - - 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: :: - - BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/" - BBMASK += "/meta-oe/recipes-support/" - BBMASK += "/meta-foo/.*/openldap" - BBMASK += "opencv.*\.bbappend" - BBMASK += "lzma" - - .. note:: - - When specifying a directory name, use the trailing slash character - to ensure you match just that directory name. - - :term:`BBMULTICONFIG` - Specifies each additional separate configuration when you are - building targets with multiple configurations. Use this variable in - your ``conf/local.conf`` configuration file. Specify a - multiconfigname for each configuration file you are using. For - example, the following line specifies three configuration files: - :: - - BBMULTICONFIG = "configA configB configC" - - Each configuration file you - use must reside in the :term:`Build Directory` - ``conf/multiconfig`` directory (e.g. - build_directory\ ``/conf/multiconfig/configA.conf``). - - For information on how to use ``BBMULTICONFIG`` in an environment - that supports building targets with multiple configurations, see the - ":ref:`dev-manual/common-tasks:building images for multiple targets using multiple configurations`" - section in the Yocto Project Development Tasks Manual. - - :term:`BBPATH` - Used by BitBake to locate ``.bbclass`` and configuration files. This - variable is analogous to the ``PATH`` variable. - - .. note:: - - If you run BitBake from a directory outside of the - Build Directory - , you must be sure to set - BBPATH - to point to the Build Directory. Set the variable as you would any - environment variable and then run BitBake: - :: - - $ BBPATH = "build_directory" - $ export BBPATH - $ bitbake target - - - :term:`BBSERVER` - If defined in the BitBake environment, ``BBSERVER`` points to the - BitBake remote server. - - Use the following format to export the variable to the BitBake - environment: - :: - - export BBSERVER=localhost:$port - - By default, ``BBSERVER`` also appears in - :term:`bitbake:BB_HASHBASE_WHITELIST`. - Consequently, ``BBSERVER`` is excluded from checksum and dependency - data. - - :term:`BINCONFIG` - When inheriting the - :ref:`binconfig-disabled ` class, - this variable specifies binary configuration scripts to disable in - favor of using ``pkg-config`` to query the information. The - ``binconfig-disabled`` class will modify the specified scripts to - return an error so that calls to them can be easily found and - replaced. - - To add multiple scripts, separate them by spaces. Here is an example - from the ``libpng`` recipe: - :: - - BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config" - - :term:`BINCONFIG_GLOB` - When inheriting the :ref:`binconfig ` 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. - - .. note:: - - The ``BINCONFIG_GLOB`` variable uses - `shell globbing `__, - which is recognition and expansion of wildcards during pattern - matching. Shell globbing is very similar to - `fnmatch `__ - and `glob `__. - - For more information on how this variable works, see - ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`. - You can also find general - information on the class in the - ":ref:`binconfig.bbclass `" section. - - :term:`BP` - The base recipe name and version but without any special recipe name - suffix (i.e. ``-native``, ``lib64-``, and so forth). ``BP`` is - comprised of the following: - :: - - ${BPN}-${PV} - - :term:`BPN` - This variable is a version of the :term:`PN` variable with - common prefixes and suffixes removed, such as ``nativesdk-``, - ``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``. - The exact lists of prefixes and suffixes removed are specified by the - :term:`MLPREFIX` and - :term:`SPECIAL_PKGSUFFIX` variables, - respectively. - - :term:`BUGTRACKER` - 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. - - :term:`BUILD_ARCH` - Specifies the architecture of the build host (e.g. ``i686``). The - OpenEmbedded build system sets the value of ``BUILD_ARCH`` from the - machine name reported by the ``uname`` command. - - :term:`BUILD_AS_ARCH` - Specifies the architecture-specific assembler flags for the build - host. By default, the value of ``BUILD_AS_ARCH`` is empty. - - :term:`BUILD_CC_ARCH` - Specifies the architecture-specific C compiler flags for the build - host. By default, the value of ``BUILD_CC_ARCH`` is empty. - - :term:`BUILD_CCLD` - Specifies the linker command to be used for the build host when the C - compiler is being used as the linker. By default, ``BUILD_CCLD`` - points to GCC and passes as arguments the value of - :term:`BUILD_CC_ARCH`, assuming - ``BUILD_CC_ARCH`` is set. - - :term:`BUILD_CFLAGS` - Specifies the flags to pass to the C compiler when building for the - build host. When building in the ``-native`` context, - :term:`CFLAGS` is set to the value of this variable by - default. - - :term:`BUILD_CPPFLAGS` - Specifies the flags to pass to the C preprocessor (i.e. to both the C - and the C++ compilers) when building for the build host. When - building in the ``-native`` context, :term:`CPPFLAGS` - is set to the value of this variable by default. - - :term:`BUILD_CXXFLAGS` - Specifies the flags to pass to the C++ compiler when building for the - build host. When building in the ``-native`` context, - :term:`CXXFLAGS` is set to the value of this variable - by default. - - :term:`BUILD_FC` - Specifies the Fortran compiler command for the build host. By - default, ``BUILD_FC`` points to Gfortran and passes as arguments the - value of :term:`BUILD_CC_ARCH`, assuming - ``BUILD_CC_ARCH`` is set. - - :term:`BUILD_LD` - Specifies the linker command for the build host. By default, - ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments - the value of :term:`BUILD_LD_ARCH`, assuming - ``BUILD_LD_ARCH`` is set. - - :term:`BUILD_LD_ARCH` - Specifies architecture-specific linker flags for the build host. By - default, the value of ``BUILD_LD_ARCH`` is empty. - - :term:`BUILD_LDFLAGS` - Specifies the flags to pass to the linker when building for the build - host. When building in the ``-native`` context, - :term:`LDFLAGS` is set to the value of this variable - by default. - - :term:`BUILD_OPTIMIZATION` - Specifies the optimization flags passed to the C compiler when - building for the build host or the SDK. The flags are passed through - the :term:`BUILD_CFLAGS` and - :term:`BUILDSDK_CFLAGS` default values. - - The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2 - -pipe". - - :term:`BUILD_OS` - Specifies the operating system in use on the build host (e.g. - "linux"). The OpenEmbedded build system sets the value of - ``BUILD_OS`` from the OS reported by the ``uname`` command - the - first word, converted to lower-case characters. - - :term:`BUILD_PREFIX` - The toolchain binary prefix used for native recipes. The OpenEmbedded - build system uses the ``BUILD_PREFIX`` value to set the - :term:`TARGET_PREFIX` when building for - ``native`` recipes. - - :term:`BUILD_STRIP` - Specifies the command to be used to strip debugging symbols from - binaries produced for the build host. By default, ``BUILD_STRIP`` - points to - ``${``\ :term:`BUILD_PREFIX`\ ``}strip``. - - :term:`BUILD_SYS` - Specifies the system, including the architecture and the operating - system, to use when building for the build host (i.e. when building - ``native`` recipes). - - The OpenEmbedded build system automatically sets this variable based - on :term:`BUILD_ARCH`, - :term:`BUILD_VENDOR`, and - :term:`BUILD_OS`. You do not need to set the - ``BUILD_SYS`` variable yourself. - - :term:`BUILD_VENDOR` - Specifies the vendor name to use when building for the build host. - The default value is an empty string (""). - - :term:`BUILDDIR` - Points to the location of the :term:`Build Directory`. - You can define this directory indirectly through the - :ref:`structure-core-script` script by passing in a Build - Directory path when you run the script. If you run the script and do - not provide a Build Directory path, the ``BUILDDIR`` defaults to - ``build`` in the current directory. - - :term:`BUILDHISTORY_COMMIT` - When inheriting the :ref:`buildhistory ` - 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 ``buildhistory`` - 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". - - By default, the ``buildhistory`` class does not commit the build - history output in a local Git repository: - :: - - BUILDHISTORY_COMMIT ?= "0" - - :term:`BUILDHISTORY_COMMIT_AUTHOR` - When inheriting the :ref:`buildhistory ` - class, this variable specifies the author to use for each Git commit. - In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the - :term:`BUILDHISTORY_COMMIT` variable must - be set to "1". - - Git requires that the value you provide for the - ``BUILDHISTORY_COMMIT_AUTHOR`` variable takes the form of "name - email@host". Providing an email address or host that is not valid - does not produce an error. - - By default, the ``buildhistory`` class sets the variable as follows: - :: - - BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory " - - :term:`BUILDHISTORY_DIR` - When inheriting the :ref:`buildhistory ` - class, this variable specifies the directory in which build history - information is kept. For more information on how the variable works, - see the ``buildhistory.class``. - - By default, the ``buildhistory`` class sets the directory as follows: - :: - - BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" - - :term:`BUILDHISTORY_FEATURES` - When inheriting the :ref:`buildhistory ` - class, this variable specifies the build history features to be - enabled. For more information on how build history works, see the - ":ref:`dev-manual/common-tasks:maintaining build output quality`" - section in the Yocto Project Development Tasks Manual. - - You can specify these features in the form of a space-separated list: - - - *image:* Analysis of the contents of images, which includes the - list of installed packages among other things. - - - *package:* Analysis of the contents of individual packages. - - - *sdk:* Analysis of the contents of the software development kit - (SDK). - - - *task:* Save output file signatures for - :ref:`shared state ` - (sstate) tasks. - This saves one file per task and lists the SHA-256 checksums for - each file staged (i.e. the output of the task). - - By default, the ``buildhistory`` class enables the following - features: - :: - - BUILDHISTORY_FEATURES ?= "image package sdk" - - :term:`BUILDHISTORY_IMAGE_FILES` - When inheriting the :ref:`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. The default is to copy - ``/etc/passwd`` and ``/etc/group``, 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. - - By default, the ``buildhistory`` class provides paths to the - following files: - :: - - BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" - - :term:`BUILDHISTORY_PUSH_REPO` - When inheriting the :ref:`buildhistory ` - class, this variable optionally specifies a remote repository to - which build history pushes Git changes. In order for - ``BUILDHISTORY_PUSH_REPO`` to work, - :term:`BUILDHISTORY_COMMIT` must be set to - "1". - - 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 ``git remote`` within the local - repository. - - By default, the ``buildhistory`` class sets the variable as follows: - :: - - BUILDHISTORY_PUSH_REPO ?= "" - - :term:`BUILDSDK_CFLAGS` - Specifies the flags to pass to the C compiler when building for the - SDK. When building in the ``nativesdk-`` context, - :term:`CFLAGS` is set to the value of this variable by - default. - - :term:`BUILDSDK_CPPFLAGS` - 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 ``nativesdk-`` context, :term:`CPPFLAGS` is set - to the value of this variable by default. - - :term:`BUILDSDK_CXXFLAGS` - Specifies the flags to pass to the C++ compiler when building for the - SDK. When building in the ``nativesdk-`` context, - :term:`CXXFLAGS` is set to the value of this variable - by default. - - :term:`BUILDSDK_LDFLAGS` - Specifies the flags to pass to the linker when building for the SDK. - When building in the ``nativesdk-`` context, - :term:`LDFLAGS` is set to the value of this variable - by default. - - :term:`BUILDSTATS_BASE` - Points to the location of the directory that holds build statistics - when you use and enable the - :ref:`buildstats ` class. The - ``BUILDSTATS_BASE`` directory defaults to - ``${``\ :term:`TMPDIR`\ ``}/buildstats/``. - - :term:`BUSYBOX_SPLIT_SUID` - 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 (i.e. those that - do not require ``setuid root``). - - The ``BUSYBOX_SPLIT_SUID`` variable defaults to "1", which results in - splitting the output executable file. Set the variable to "0" to get - a single output executable file. - - :term:`CACHE` - Specifies the directory BitBake uses to store a cache of the - :term:`Metadata` so it does not need to be parsed every time - BitBake is started. - - :term:`CC` - The minimal command and arguments used to run the C compiler. - - :term:`CFLAGS` - 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. - - Default initialization for ``CFLAGS`` varies depending on what is - being built: - - - :term:`TARGET_CFLAGS` when building for the - target - - - :term:`BUILD_CFLAGS` when building for the - build host (i.e. ``-native``) - - - :term:`BUILDSDK_CFLAGS` when building for - an SDK (i.e. ``nativesdk-``) - - :term:`CLASSOVERRIDE` - 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 (e.g. - :ref:`native `, - :ref:`nativesdk `, and so forth) set the - variable to appropriate values. - - .. note:: - - ``CLASSOVERRIDE`` gets its default "class-target" value from the - ``bitbake.conf`` file. - - As an example, the following override allows you to install extra - files, but only when building for the target: - :: - - do_install_append_class-target() { - install my-extra-file ${D}${sysconfdir} - } - - Here is an example where ``FOO`` is set to - "native" when building for the build host, and to "other" when not - building for the build host: - :: - - FOO_class-native = "native" - FOO = "other" - - The underlying mechanism behind ``CLASSOVERRIDE`` is simply - that it is included in the default value of - :term:`OVERRIDES`. - - :term:`CLEANBROKEN` - If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the - ``make clean`` command does not work for the software being built. - Consequently, the OpenEmbedded build system will not try to run - ``make clean`` during the :ref:`ref-tasks-configure` - task, which is the default behavior. - - :term:`COMBINED_FEATURES` - Provides a list of hardware features that are enabled in both - :term:`MACHINE_FEATURES` and - :term:`DISTRO_FEATURES`. 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. - - :term:`COMMON_LICENSE_DIR` - Points to ``meta/files/common-licenses`` in the - :term:`Source Directory`, which is where generic license - files reside. - - :term:`COMPATIBLE_HOST` - 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 :term:`HOST_SYS`. 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. - - :term:`COMPATIBLE_MACHINE` - A regular expression that resolves to one or more target machines - with which a recipe is compatible. The regular expression is matched - against :term:`MACHINEOVERRIDES`. 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. - - :term:`COMPLEMENTARY_GLOB` - Defines wildcards to match when installing a list of complementary - packages for all the packages explicitly (or implicitly) installed in - an image. - - .. note:: - - The ``COMPLEMENTARY_GLOB`` variable uses Unix filename pattern matching - (`fnmatch `__), - which is similar to the Unix style pathname pattern expansion - (`glob `__). - - The resulting list of complementary packages is associated with an - item that can be added to - :term:`IMAGE_FEATURES`. An example usage of - this is the "dev-pkgs" item that when added to ``IMAGE_FEATURES`` - will install -dev packages (containing headers and other development - files) for every package in the image. - - 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: - :: - - COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev' - - :term:`COMPONENTS_DIR` - Stores sysroot components for each recipe. The OpenEmbedded build - system uses ``COMPONENTS_DIR`` when constructing recipe-specific - sysroots for other recipes. - - The default is - "``${``\ :term:`STAGING_DIR`\ ``}-components``." - (i.e. - "``${``\ :term:`TMPDIR`\ ``}/sysroots-components``"). - - :term:`CONF_VERSION` - Tracks the version of the local configuration file (i.e. - ``local.conf``). The value for ``CONF_VERSION`` increments each time - ``build/conf/`` compatibility changes. - - :term:`CONFFILES` - 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 ``CONFFILES`` - variable to list the files in the package that you wish to prevent - the PMS from overwriting during this update process. - - To use the ``CONFFILES`` variable, provide a package name override - that identifies the resulting package. Then, provide a - space-separated list of files. Here is an example: - :: - - CONFFILES_${PN} += "${sysconfdir}/file1 \ - ${sysconfdir}/file2 ${sysconfdir}/file3" - - A relationship exists between the ``CONFFILES`` and ``FILES`` - variables. The files listed within ``CONFFILES`` must be a subset of - the files listed within ``FILES``. Because the configuration files - you provide with ``CONFFILES`` 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 ``FILES`` - variable. - - .. note:: - - When specifying paths as part of the ``CONFFILES`` variable, it is - good practice to use appropriate path variables. - For example, ``${sysconfdir}`` rather than ``/etc`` or ``${bindir}`` - rather than ``/usr/bin``. You can find a list of these variables at - the top of the ``meta/conf/bitbake.conf`` file in the - :term:`Source Directory`. - - :term:`CONFIG_INITRAMFS_SOURCE` - Identifies the initial RAM filesystem (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 (""). - - The ``CONFIG_INITRAMFS_SOURCE`` can be either a single cpio archive - with a ``.cpio`` 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 ``usr/gen_init_cpio`` program in the kernel tree. - - If you specify multiple directories and files, the initramfs image - will be the aggregate of all of them. - - For information on creating an initramfs, see the - ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section - in the Yocto Project Development Tasks Manual. - - :term:`CONFIG_SITE` - 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``. - - :term:`CONFIGURE_FLAGS` - The minimal arguments for GNU configure. - - :term:`CONFLICT_DISTRO_FEATURES` - When inheriting the - :ref:`features_check ` - class, this variable identifies distribution features that would be - in conflict should the recipe be built. In other words, if the - ``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also - appears in ``DISTRO_FEATURES`` within the current configuration, then - the recipe will be skipped, and if the build system attempts to build - the recipe then an error will be triggered. - - :term:`COPYLEFT_LICENSE_EXCLUDE` - A space-separated list of licenses to exclude from the source - archived by the :ref:`archiver ` class. In - other words, if a license in a recipe's - :term:`LICENSE` value is in the value of - ``COPYLEFT_LICENSE_EXCLUDE``, then its source is not archived by the - class. - - .. note:: - - The ``COPYLEFT_LICENSE_EXCLUDE`` variable takes precedence over the - :term:`COPYLEFT_LICENSE_INCLUDE` variable. - - The default value, which is "CLOSED Proprietary", for - ``COPYLEFT_LICENSE_EXCLUDE`` is set by the - :ref:`copyleft_filter ` class, which - is inherited by the ``archiver`` class. - - :term:`COPYLEFT_LICENSE_INCLUDE` - A space-separated list of licenses to include in the source archived - by the :ref:`archiver ` class. In other - words, if a license in a recipe's :term:`LICENSE` - value is in the value of ``COPYLEFT_LICENSE_INCLUDE``, then its - source is archived by the class. - - The default value is set by the - :ref:`copyleft_filter ` class, which - is inherited by the ``archiver`` class. The default value includes - "GPL*", "LGPL*", and "AGPL*". - - :term:`COPYLEFT_PN_EXCLUDE` - A list of recipes to exclude in the source archived by the - :ref:`archiver ` class. The - ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and - exclusion caused through the - :term:`COPYLEFT_LICENSE_INCLUDE` and - :term:`COPYLEFT_LICENSE_EXCLUDE` - variables, respectively. - - The default value, which is "" indicating to not explicitly exclude - any recipes by name, for ``COPYLEFT_PN_EXCLUDE`` is set by the - :ref:`copyleft_filter ` class, which - is inherited by the ``archiver`` class. - - :term:`COPYLEFT_PN_INCLUDE` - A list of recipes to include in the source archived by the - :ref:`archiver ` class. The - ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and - exclusion caused through the - :term:`COPYLEFT_LICENSE_INCLUDE` and - :term:`COPYLEFT_LICENSE_EXCLUDE` - variables, respectively. - - The default value, which is "" indicating to not explicitly include - any recipes by name, for ``COPYLEFT_PN_INCLUDE`` is set by the - :ref:`copyleft_filter ` class, which - is inherited by the ``archiver`` class. - - :term:`COPYLEFT_RECIPE_TYPES` - A space-separated list of recipe types to include in the source - archived by the :ref:`archiver ` class. - Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``, - ``crosssdk``, and ``cross-canadian``. - - The default value, which is "target*", for ``COPYLEFT_RECIPE_TYPES`` - is set by the :ref:`copyleft_filter ` - class, which is inherited by the ``archiver`` class. - - :term:`COPY_LIC_DIRS` - If set to "1" along with the - :term:`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. The license files are placed in directories within the image - itself during build time. - - .. note:: - - The ``COPY_LIC_DIRS`` 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 - :term:`LICENSE_CREATE_PACKAGE` variable for additional information. - You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" - section in the Yocto Project Development Tasks Manual for - information on providing license text. - - :term:`COPY_LIC_MANIFEST` - 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 during build time. - - .. note:: - - The ``COPY_LIC_MANIFEST`` 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 - :term:`LICENSE_CREATE_PACKAGE` variable for additional information. - You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" - section in the Yocto Project Development Tasks Manual for - information on providing license text. - - :term:`CORE_IMAGE_EXTRA_INSTALL` - Specifies the list of packages to be added to the image. You should - only set this variable in the ``local.conf`` configuration file found - in the :term:`Build Directory`. - - This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer - supported. - - :term:`COREBASE` - Specifies the parent directory of the OpenEmbedded-Core Metadata - layer (i.e. ``meta``). - - It is an important distinction that ``COREBASE`` 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 ``poky`` name - for your local copy of the repository. In this case, ``COREBASE`` - points to the ``poky`` folder because it is the parent directory of - the ``poky/meta`` layer. - - :term:`COREBASE_FILES` - Lists files from the :term:`COREBASE` directory that - should be copied other than the layers listed in the - ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for - the purpose of copying metadata from the OpenEmbedded build system - into the extensible SDK. - - Explicitly listing files in ``COREBASE`` 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 ``COREBASE_FILES`` is used in order to only copy the files that - are actually needed. - - :term:`CPP` - The minimal command and arguments used to run the C preprocessor. - - :term:`CPPFLAGS` - 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. - - Default initialization for ``CPPFLAGS`` varies depending on what is - being built: - - - :term:`TARGET_CPPFLAGS` when building for - the target - - - :term:`BUILD_CPPFLAGS` when building for the - build host (i.e. ``-native``) - - - :term:`BUILDSDK_CPPFLAGS` when building - for an SDK (i.e. ``nativesdk-``) - - :term:`CROSS_COMPILE` - The toolchain binary prefix for the target tools. The - ``CROSS_COMPILE`` variable is the same as the - :term:`TARGET_PREFIX` variable. - - .. note:: - - The OpenEmbedded build system sets the ``CROSS_COMPILE`` - variable only in certain contexts (e.g. when building for kernel - and kernel module recipes). - - :term:`CVSDIR` - The directory in which files checked out under the CVS system are - stored. - - :term:`CXX` - The minimal command and arguments used to run the C++ compiler. - - :term:`CXXFLAGS` - 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. - - Default initialization for ``CXXFLAGS`` varies depending on what is - being built: - - - :term:`TARGET_CXXFLAGS` when building for - the target - - - :term:`BUILD_CXXFLAGS` when building for the - build host (i.e. ``-native``) - - - :term:`BUILDSDK_CXXFLAGS` when building - for an SDK (i.e. ``nativesdk-``) - - :term:`D` - The destination directory. The location in the :term:`Build Directory` - where components are installed by the - :ref:`ref-tasks-install` task. This location defaults - to: - :: - - ${WORKDIR}/image - - .. note:: - - Tasks that read from or write to this directory should run under - :ref:`fakeroot `. - - :term:`DATE` - The date the build was started. Dates appear using the year, month, - and day (YMD) format (e.g. "20150209" for February 9th, 2015). - - :term:`DATETIME` - The date and time on which the current build started. The format is - suitable for timestamps. - - :term:`DEBIAN_NOAUTONAME` - When the :ref:`debian ` class is inherited, - which is the default behavior, ``DEBIAN_NOAUTONAME`` 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 ``fontconfig`` recipe: - :: - - DEBIAN_NOAUTONAME_fontconfig-utils = "1" - - :term:`DEBIANNAME` - When the :ref:`debian ` class is inherited, - which is the default behavior, ``DEBIANNAME`` 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 - ``dbus`` recipe: - :: - - DEBIANNAME_${PN} = "dbus-1" - - :term:`DEBUG_BUILD` - Specifies to build packages with debugging information. This - influences the value of the ``SELECTED_OPTIMIZATION`` variable. - - :term:`DEBUG_OPTIMIZATION` - The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when - compiling a system for debugging. This variable defaults to "-O - -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe". - - :term:`DEFAULT_PREFERENCE` - Specifies a weak bias for recipe selection priority. - - 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 ``PREFERRED_VERSION`` being used to - build the development version. - - .. note:: - - The bias provided by ``DEFAULT_PREFERENCE`` is weak and is overridden - by :term:`BBFILE_PRIORITY` if that variable is different between two - layers that contain different versions of the same recipe. - - :term:`DEFAULTTUNE` - The default CPU and Application Binary Interface (ABI) tunings (i.e. - the "tune") used by the OpenEmbedded build system. The - ``DEFAULTTUNE`` helps define - :term:`TUNE_FEATURES`. - - The default tune is either implicitly or explicitly set by the - machine (:term:`MACHINE`). However, you can override - the setting using available tunes as defined with - :term:`AVAILTUNES`. - - :term:`DEPENDS` - Lists a recipe's build-time dependencies. These are dependencies on - other recipes whose contents (e.g. headers and shared libraries) are - needed by the recipe at build time. - - As an example, consider a recipe ``foo`` that contains the following - assignment: - :: - - DEPENDS = "bar" - - The practical effect of the previous - assignment is that all files installed by bar will be available in - the appropriate staging sysroot, given by the - :term:`STAGING_DIR* ` variables, by the time the - :ref:`ref-tasks-configure` task for ``foo`` runs. - This mechanism is implemented by having ``do_configure`` depend on - the :ref:`ref-tasks-populate_sysroot` task of - each recipe listed in ``DEPENDS``, through a - ``[``\ :ref:`deptask `\ ``]`` - declaration in the :ref:`base ` class. - - .. note:: - - It seldom is necessary to reference, for example, ``STAGING_DIR_HOST`` - explicitly. The standard classes and build-related variables are - configured to automatically use the appropriate staging sysroots. - - As another example, ``DEPENDS`` can also be used to add utilities - that run on the build machine during the build. For example, a recipe - that makes use of a code generator built by the recipe ``codegen`` - might have the following: - :: - - DEPENDS = "codegen-native" - - For more - information, see the :ref:`native ` class and - the :term:`EXTRANATIVEPATH` variable. - - .. note:: - - - ``DEPENDS`` is a list of recipe names. Or, to be more precise, - it is a list of :term:`PROVIDES` names, which - usually match recipe names. Putting a package name such as - "foo-dev" in ``DEPENDS`` does not make sense. Use "foo" - instead, as this will put files from all the packages that make - up ``foo``, which includes those from ``foo-dev``, into the - sysroot. - - - One recipe having another recipe in ``DEPENDS`` does not by - itself add any runtime dependencies between the packages - produced by the two recipes. However, as explained in the - ":ref:`overview-manual/concepts:automatically added runtime dependencies`" - section in the Yocto Project Overview and Concepts Manual, - runtime dependencies will often be added automatically, meaning - ``DEPENDS`` alone is sufficient for most recipes. - - - Counterintuitively, ``DEPENDS`` is often necessary even for - recipes that install precompiled components. For example, if - ``libfoo`` is a precompiled library that links against - ``libbar``, then linking against ``libfoo`` requires both - ``libfoo`` and ``libbar`` to be available in the sysroot. - Without a ``DEPENDS`` from the recipe that installs ``libfoo`` - to the recipe that installs ``libbar``, other recipes might - fail to link against ``libfoo``. - - For information on runtime dependencies, see the - :term:`RDEPENDS` variable. You can also see the - ":ref:`Tasks `" and - ":ref:`Dependencies `" sections in the - BitBake User Manual for additional information on tasks and - dependencies. - - :term:`DEPLOY_DIR` - 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 :term:`Build Directory` as - ``${TMPDIR}/deploy``. - - For more information on the structure of the Build Directory, see - ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. - For more detail on the contents of the ``deploy`` directory, see the - ":ref:`overview-manual/concepts:images`", - ":ref:`overview-manual/concepts:package feeds`", and - ":ref:`overview-manual/concepts:application development sdk`" sections all in the - Yocto Project Overview and Concepts Manual. - - :term:`DEPLOY_DIR_DEB` - 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 - :term:`PACKAGE_CLASSES` contains - "package_deb". - - The BitBake configuration file initially defines the - ``DEPLOY_DIR_DEB`` variable as a sub-folder of - :term:`DEPLOY_DIR`: - :: - - DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" - - The :ref:`package_deb ` class uses the - ``DEPLOY_DIR_DEB`` variable to make sure the - :ref:`ref-tasks-package_write_deb` task - writes Debian packages into the appropriate folder. For more - information on how packaging works, see the - ":ref:`overview-manual/concepts:package feeds`" section - in the Yocto Project Overview and Concepts Manual. - - :term:`DEPLOY_DIR_IMAGE` - 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 ``${MACHINE}`` name. By default, this directory - resides within the :term:`Build Directory` as - ``${DEPLOY_DIR}/images/${MACHINE}/``. - - For more information on the structure of the Build Directory, see - ":ref:`ref-manual/ref-structure:the build directory - \`\`build/\`\``" section. - For more detail on the contents of the ``deploy`` directory, see the - ":ref:`overview-manual/concepts:images`" and - ":ref:`overview-manual/concepts:application development sdk`" sections both in - the Yocto Project Overview and Concepts Manual. - - :term:`DEPLOY_DIR_IPK` - 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 - :term:`PACKAGE_CLASSES` contains - "package_ipk". - - The BitBake configuration file initially defines this variable as a - sub-folder of :term:`DEPLOY_DIR`: - :: - - DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk" - - The :ref:`package_ipk ` class uses the - ``DEPLOY_DIR_IPK`` variable to make sure the - :ref:`ref-tasks-package_write_ipk` task - writes IPK packages into the appropriate folder. For more information - on how packaging works, see the - ":ref:`overview-manual/concepts:package feeds`" section - in the Yocto Project Overview and Concepts Manual. - - :term:`DEPLOY_DIR_RPM` - 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 - :term:`PACKAGE_CLASSES` contains - "package_rpm". - - The BitBake configuration file initially defines this variable as a - sub-folder of :term:`DEPLOY_DIR`: - :: - - DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm" - - The :ref:`package_rpm ` class uses the - ``DEPLOY_DIR_RPM`` variable to make sure the - :ref:`ref-tasks-package_write_rpm` task - writes RPM packages into the appropriate folder. For more information - on how packaging works, see the - ":ref:`overview-manual/concepts:package feeds`" section - in the Yocto Project Overview and Concepts Manual. - - :term:`DEPLOY_DIR_TAR` - 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 - :term:`PACKAGE_CLASSES` contains - "package_tar". - - The BitBake configuration file initially defines this variable as a - sub-folder of :term:`DEPLOY_DIR`: - :: - - DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar" - - The :ref:`package_tar ` class uses the - ``DEPLOY_DIR_TAR`` variable to make sure the - :ref:`ref-tasks-package_write_tar` task - writes TAR packages into the appropriate folder. For more information - on how packaging works, see the - ":ref:`overview-manual/concepts:package feeds`" section - in the Yocto Project Overview and Concepts Manual. - - :term:`DEPLOYDIR` - When inheriting the :ref:`deploy ` class, the - ``DEPLOYDIR`` points to a temporary work area for deployed files that - is set in the ``deploy`` class as follows: - :: - - DEPLOYDIR = "${WORKDIR}/deploy-${PN}" - - Recipes inheriting the ``deploy`` class should copy files to be - deployed into ``DEPLOYDIR``, and the class will take care of copying - them into :term:`DEPLOY_DIR_IMAGE` - afterwards. - - :term:`DESCRIPTION` - The package description used by package managers. If not set, - ``DESCRIPTION`` takes the value of the :term:`SUMMARY` - variable. - - :term:`DISTRO` - The short name of the distribution. For information on the long name - of the distribution, see the :term:`DISTRO_NAME` - variable. - - The ``DISTRO`` variable corresponds to a distribution configuration - file whose root name is the same as the variable's argument and whose - filename extension is ``.conf``. For example, the distribution - configuration file for the Poky distribution is named ``poky.conf`` - and resides in the ``meta-poky/conf/distro`` directory of the - :term:`Source Directory`. - - Within that ``poky.conf`` file, the ``DISTRO`` variable is set as - follows: - :: - - DISTRO = "poky" - - Distribution configuration files are located in a ``conf/distro`` - directory within the :term:`Metadata` that contains the - distribution configuration. The value for ``DISTRO`` must not contain - spaces, and is typically all lower-case. - - .. note:: - - If the ``DISTRO`` variable is blank, a set of default configurations - are used, which are specified within - ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory. - - :term:`DISTRO_CODENAME` - Specifies a codename for the distribution being built. - - :term:`DISTRO_EXTRA_RDEPENDS` - Specifies a list of distro-specific packages to add to all images. - This variable takes affect through ``packagegroup-base`` so the - variable only really applies to the more full-featured images that - include ``packagegroup-base``. 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 ``.conf`` file. - - :term:`DISTRO_EXTRA_RRECOMMENDS` - 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. - - :term:`DISTRO_FEATURES` - The software support you want in your distribution for various - features. You define your distribution features in the distribution - configuration file. - - In most cases, the presence or absence of a feature in - ``DISTRO_FEATURES`` is translated to the appropriate option supplied - to the configure script during the - :ref:`ref-tasks-configure` task for recipes that - optionally support the feature. For example, specifying "x11" in - ``DISTRO_FEATURES``, causes every piece of software built for the - target that can optionally support X11 to have its X11 support - enabled. - - 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 ":ref:`ref-features-distro`" section. - - :term:`DISTRO_FEATURES_BACKFILL` - 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. 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 ":ref:`ref-features-backfill`" section - for more information. - - :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` - Features from ``DISTRO_FEATURES_BACKFILL`` that should not be - backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See - the ":ref:`ref-features-backfill`" section for more information. - - :term:`DISTRO_FEATURES_DEFAULT` - A convenience variable that gives you the default list of distro - features with the exception of any features specific to the C library - (``libc``). - - When creating a custom distribution, you might find it useful to be - able to reuse the default - :term:`DISTRO_FEATURES` options without the - need to write out the full set. Here is an example that uses - ``DISTRO_FEATURES_DEFAULT`` from a custom distro configuration file: - :: - - DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature" - - :term:`DISTRO_FEATURES_FILTER_NATIVE` - Specifies a list of features that if present in the target - :term:`DISTRO_FEATURES` value should be - included in ``DISTRO_FEATURES`` when building native recipes. This - variable is used in addition to the features filtered using the - :term:`DISTRO_FEATURES_NATIVE` - variable. - - :term:`DISTRO_FEATURES_FILTER_NATIVESDK` - Specifies a list of features that if present in the target - :term:`DISTRO_FEATURES` value should be - included in ``DISTRO_FEATURES`` when building nativesdk recipes. This - variable is used in addition to the features filtered using the - :term:`DISTRO_FEATURES_NATIVESDK` - variable. - - :term:`DISTRO_FEATURES_NATIVE` - Specifies a list of features that should be included in - :term:`DISTRO_FEATURES` when building native - recipes. This variable is used in addition to the features filtered - using the - :term:`DISTRO_FEATURES_FILTER_NATIVE` - variable. - - :term:`DISTRO_FEATURES_NATIVESDK` - Specifies a list of features that should be included in - :term:`DISTRO_FEATURES` when building - nativesdk recipes. This variable is used in addition to the features - filtered using the - :term:`DISTRO_FEATURES_FILTER_NATIVESDK` - variable. - - :term:`DISTRO_NAME` - The long name of the distribution. For information on the short name - of the distribution, see the :term:`DISTRO` variable. - - The ``DISTRO_NAME`` variable corresponds to a distribution - configuration file whose root name is the same as the variable's - argument and whose filename extension is ``.conf``. For example, the - distribution configuration file for the Poky distribution is named - ``poky.conf`` and resides in the ``meta-poky/conf/distro`` directory - of the :term:`Source Directory`. - - Within that ``poky.conf`` file, the ``DISTRO_NAME`` variable is set - as follows: - :: - - DISTRO_NAME = "Poky (Yocto Project Reference Distro)" - - Distribution configuration files are located in a ``conf/distro`` - directory within the :term:`Metadata` that contains the - distribution configuration. - - .. note:: - - If the ``DISTRO_NAME`` variable is blank, a set of default - configurations are used, which are specified within - ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory. - - :term:`DISTRO_VERSION` - The version of the distribution. - - :term:`DISTROOVERRIDES` - A colon-separated list of overrides specific to the current - distribution. By default, this list includes the value of - :term:`DISTRO`. - - You can extend ``DISTROOVERRIDES`` to add extra overrides that should - apply to the distribution. - - The underlying mechanism behind ``DISTROOVERRIDES`` is simply that it - is included in the default value of - :term:`OVERRIDES`. - - :term:`DL_DIR` - The central download directory used by the build process to store - downloads. By default, ``DL_DIR`` gets files suitable for mirroring - for everything except Git repositories. If you want tarballs of Git - repositories, use the - :term:`BB_GENERATE_MIRROR_TARBALLS` - variable. - - You can set this directory by defining the ``DL_DIR`` variable in the - ``conf/local.conf`` file. This directory is self-maintaining and you - should not have to touch it. By default, the directory is - ``downloads`` in the :term:`Build Directory`. - :: - - #DL_DIR ?= "${TOPDIR}/downloads" - - To specify a different download directory, - simply remove the comment from the line and provide your directory. - - 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 ``DL_DIR`` 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. - - 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 ":doc:`faq`" - chapter. You can also refer to the - ":yocto_wiki:`Working Behind a Network Proxy `" - Wiki page. - - :term:`DOC_COMPRESS` - When inheriting the :ref:`compress_doc ` - 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. - - For information on policies and on how to use this variable, see the - comments in the ``meta/classes/compress_doc.bbclass`` file. - - :term:`EFI_PROVIDER` - When building bootable images (i.e. where ``hddimg``, ``iso``, or - ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the - ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The - default is "grub-efi", but "systemd-boot" can be used instead. - - See the :ref:`systemd-boot ` and - :ref:`image-live ` classes for more - information. - - :term:`ENABLE_BINARY_LOCALE_GENERATION` - Variable that controls which locales for ``glibc`` are generated - during the build (useful if the target device has 64Mbytes of RAM or - less). - - :term:`ERR_REPORT_DIR` - When used with the :ref:`report-error ` - class, specifies the path used for storing the debug files created by - the :ref:`error reporting - tool `, which - allows you to submit build errors you encounter to a central - database. By default, the value of this variable is - ``${``\ :term:`LOG_DIR`\ ``}/error-report``. - - You can set ``ERR_REPORT_DIR`` to the path you want the error - reporting tool to store the debug files as follows in your - ``local.conf`` file: - :: - - ERR_REPORT_DIR = "path" - - :term:`ERROR_QA` - 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 - ":ref:`insane.bbclass `" section. - - :term:`EXCLUDE_FROM_SHLIBS` - 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 ``package_do_shlibs``, which is part of the - :ref:`ref-tasks-package` task. You should be aware that the shared - libraries resolver might implicitly define some dependencies between - packages. - - The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the - :term:`PRIVATE_LIBS` variable, which excludes a - package's particular libraries only and not the whole package. - - Use the ``EXCLUDE_FROM_SHLIBS`` variable by setting it to "1" for a - particular package: - :: - - EXCLUDE_FROM_SHLIBS = "1" - - :term:`EXCLUDE_FROM_WORLD` - Directs BitBake to exclude a recipe from world builds (i.e. - ``bitbake world``). During world builds, BitBake locates, parses and - builds all recipes found in every layer exposed in the - ``bblayers.conf`` configuration file. - - To exclude a recipe from a world build using this variable, set the - variable to "1" in the recipe. - - .. note:: - - Recipes added to ``EXCLUDE_FROM_WORLD`` may still be built during a - world build in order to satisfy dependencies of other recipes. Adding - a recipe to ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not - explicitly added to the list of build targets in a world build. - - :term:`EXTENDPE` - Used with file and pathnames to create a prefix for a recipe's - version based on the recipe's :term:`PE` value. If ``PE`` - is set and greater than zero for a recipe, ``EXTENDPE`` becomes that - value (e.g if ``PE`` is equal to "1" then ``EXTENDPE`` becomes "1"). - If a recipe's ``PE`` is not set (the default) or is equal to zero, - ``EXTENDPE`` becomes "". - - See the :term:`STAMP` variable for an example. - - :term:`EXTENDPKGV` - 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: - :: - - RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})" - - The dependency relationships are intended to force the package - manager to upgrade these types of packages in lock-step. - - :term:`EXTERNAL_KERNEL_TOOLS` - When set, the ``EXTERNAL_KERNEL_TOOLS`` variable indicates that these - tools are not in the source tree. - - When kernel tools are available in the tree, they are preferred over - any externally installed tools. Setting the ``EXTERNAL_KERNEL_TOOLS`` - variable tells the OpenEmbedded build system to prefer the installed - external tools. See the - :ref:`kernel-yocto ` class in - ``meta/classes`` to see how the variable is used. - - :term:`EXTERNALSRC` - When inheriting the :ref:`externalsrc ` - class, this variable points to the source tree, which is outside of - the OpenEmbedded build system. When set, this variable sets the - :term:`S` variable, which is what the OpenEmbedded build - system uses to locate unpacked recipe source code. - - For more information on ``externalsrc.bbclass``, see the - ":ref:`externalsrc.bbclass `" section. You - can also find information on how to use this variable in the - ":ref:`dev-manual/common-tasks:building software from an external source`" - section in the Yocto Project Development Tasks Manual. - - :term:`EXTERNALSRC_BUILD` - When inheriting the :ref:`externalsrc ` - 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 :term:`B` variable, - which is what the OpenEmbedded build system uses to locate the Build - Directory. - - For more information on ``externalsrc.bbclass``, see the - ":ref:`externalsrc.bbclass `" section. You - can also find information on how to use this variable in the - ":ref:`dev-manual/common-tasks:building software from an external source`" - section in the Yocto Project Development Tasks Manual. - - :term:`EXTRA_AUTORECONF` - For recipes inheriting the :ref:`autotools ` - class, you can use ``EXTRA_AUTORECONF`` to specify extra options to - pass to the ``autoreconf`` command that is executed during the - :ref:`ref-tasks-configure` task. - - The default value is "--exclude=autopoint". - - :term:`EXTRA_IMAGE_FEATURES` - A list of additional features to include in an image. When listing - more than one feature, separate them with a space. - - Typically, you configure this variable in your ``local.conf`` file, - which is found in the :term:`Build Directory`. - 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 - :term:`IMAGE_FEATURES` variable. - - Here are some examples of features you can add: - - - "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 ":ref:`ref-features-image`" - 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 - ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" - section in the Yocto Project Development Tasks 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. - - For a complete list of image features that ships with the Yocto - Project, see the ":ref:`ref-features-image`" section. - - For an example that shows how to customize your image by using this - variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" - section in the Yocto Project Development Tasks Manual. - - :term:`EXTRA_IMAGECMD` - Specifies additional options for the image creation command that has - been specified in :term:`IMAGE_CMD`. When setting - this variable, use an override for the associated image type. Here is - an example: - :: - - EXTRA_IMAGECMD_ext3 ?= "-i 4096" - - :term:`EXTRA_IMAGEDEPENDS` - A list of recipes to build that do not provide packages for - installing into the root filesystem. - - Sometimes a recipe is required to build the final image but is not - needed in the root filesystem. You can use the ``EXTRA_IMAGEDEPENDS`` - variable to list these recipes and thus specify the dependencies. A - typical example is a required bootloader in a machine configuration. - - .. note:: - - To add packages to the root filesystem, see the various - \*:term:`RDEPENDS` and \*:term:`RRECOMMENDS` variables. - - :term:`EXTRANATIVEPATH` - A list of subdirectories of - ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}`` - added to the beginning of the environment variable ``PATH``. As an - example, the following prepends - "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to - ``PATH``: - :: - - EXTRANATIVEPATH = "foo bar" - - :term:`EXTRA_OECMAKE` - Additional `CMake `__ options. See the - :ref:`cmake ` class for additional information. - - :term:`EXTRA_OECONF` - Additional ``configure`` script options. See - :term:`PACKAGECONFIG_CONFARGS` for - additional information on passing configure script options. - - :term:`EXTRA_OEMAKE` - Additional GNU ``make`` options. - - Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the - variable to specify any required GNU options. - - :term:`PARALLEL_MAKE` and - :term:`PARALLEL_MAKEINST` also make use of - ``EXTRA_OEMAKE`` to pass the required flags. - - :term:`EXTRA_OESCONS` - When inheriting the :ref:`scons ` class, this - variable specifies additional configuration options you want to pass - to the ``scons`` command line. - - :term:`EXTRA_USERS_PARAMS` - When inheriting the :ref:`extrausers ` - 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 - :ref:`useradd ` class, which ties user and - group configurations to a specific recipe. - - The set list of commands you can configure using the - ``EXTRA_USERS_PARAMS`` is shown in the ``extrausers`` class. These - commands map to the normal Unix commands of the same names: - :: - - # EXTRA_USERS_PARAMS = "\ - # useradd -p '' tester; \ - # groupadd developers; \ - # userdel nobody; \ - # groupdel -g video; \ - # groupmod -g 1020 developers; \ - # usermod -s /bin/sh tester; \ - # " - - :term:`FEATURE_PACKAGES` - Defines one or more packages to include in an image when a specific - item is included in :term:`IMAGE_FEATURES`. - When setting the value, ``FEATURE_PACKAGES`` should have the name of - the feature item as an override. Here is an example: - :: - - FEATURE_PACKAGES_widget = "package1 package2" - - In this example, if "widget" were added to ``IMAGE_FEATURES``, - package1 and package2 would be included in the image. - - .. note:: - - Packages installed by features defined through ``FEATURE_PACKAGES`` - are often package groups. While similarly named, you should not - confuse the ``FEATURE_PACKAGES`` variable with package groups, which - are discussed elsewhere in the documentation. - - :term:`FEED_DEPLOYDIR_BASE_URI` - 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 ``local.conf`` file. - - Consider the following example: - :: - - FEED_DEPLOYDIR_BASE_URI = "http://192.168.7.1/BOARD-dir" - - This example assumes you are serving - your packages over HTTP and your databases are located in a directory - named ``BOARD-dir``, 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. - - :term:`FILES` - The list of files and directories that are placed in a package. The - :term:`PACKAGES` variable lists the packages - generated by a recipe. - - To use the ``FILES`` 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: - :: - - FILES_${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile" - - .. note:: - - - When specifying files or paths, you can pattern match using - Python's - `glob `_ - syntax. For details on the syntax, see the documentation by - following the previous link. - - - When specifying paths as part of the ``FILES`` variable, it is - good practice to use appropriate path variables. For example, - use ``${sysconfdir}`` rather than ``/etc``, or ``${bindir}`` - rather than ``/usr/bin``. You can find a list of these - variables at the top of the ``meta/conf/bitbake.conf`` file in - the :term:`Source Directory`. You will also - find the default values of the various ``FILES_*`` variables in - this file. - - If some of the files you provide with the ``FILES`` 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 :term:`CONFFILES` variable for information on - how to identify these files to the PMS. - - :term:`FILES_SOLIBSDEV` - Defines the file specification to match - :term:`SOLIBSDEV`. In other words, - ``FILES_SOLIBSDEV`` defines the full path name of the development - symbolic link (symlink) for shared libraries on the target platform. - - The following statement from the ``bitbake.conf`` shows how it is - set: - :: - - FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" - - :term:`FILESEXTRAPATHS` - 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 :term:`FILESPATH` - variable. You can extend ``FILESPATH`` variable by using - ``FILESEXTRAPATHS``. - - Best practices dictate that you accomplish this by using - ``FILESEXTRAPATHS`` from within a ``.bbappend`` file and that you - prepend paths as follows: - :: - - FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" - - 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:: - - When extending ``FILESEXTRAPATHS``, be sure to use the immediate - expansion (``:=``) operator. Immediate expansion makes sure that - BitBake evaluates :term:`THISDIR` 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. - - 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. - - Here is another common use: - :: - - FILESEXTRAPATHS_prepend := "${THISDIR}/files:" - - In this example, the build system extends the - ``FILESPATH`` variable to include a directory named ``files`` that is - in the same directory as the corresponding append file. - - This next example specifically adds three paths: - :: - - FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" - - A final example shows how you can extend the search path and include - a :term:`MACHINE`-specific override, which is useful - in a BSP layer: - :: - - FILESEXTRAPATHS_prepend_intel-x86-common := "${THISDIR}/${PN}:" - - The previous statement appears in the - ``linux-yocto-dev.bbappend`` file, which is found in the - :ref:`overview-manual/development-environment:yocto project source repositories` in - ``meta-intel/common/recipes-kernel/linux``. Here, the machine - override is a special :term:`PACKAGE_ARCH` - definition for multiple ``meta-intel`` machines. - - .. note:: - - For a layer that supports a single BSP, the override could just be - the value of ``MACHINE``. - - By prepending paths in ``.bbappend`` files, you allow multiple append - files that reside in different layers but are used for the same - recipe to correctly extend the path. - - :term:`FILESOVERRIDES` - A subset of :term:`OVERRIDES` used by the - OpenEmbedded build system for creating - :term:`FILESPATH`. The ``FILESOVERRIDES`` variable - uses overrides to automatically extend the - :term:`FILESPATH` variable. For an example of how - that works, see the :term:`FILESPATH` variable - description. Additionally, you find more information on how overrides - are handled in the - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" - section of the BitBake User Manual. - - By default, the ``FILESOVERRIDES`` variable is defined as: - :: - - FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}" - - .. note:: - - Do not hand-edit the ``FILESOVERRIDES`` variable. The values match up - with expected overrides and are used in an expected manner by the - build system. - - :term:`FILESPATH` - 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 - ``FILESPATH`` in the specified order when looking for files and - patches specified by each ``file://`` URI in a recipe's - :term:`SRC_URI` statements. - - The default value for the ``FILESPATH`` variable is defined in the - ``base.bbclass`` class found in ``meta/classes`` in the - :term:`Source Directory`: - :: - - FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ - "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" - - The - ``FILESPATH`` variable is automatically extended using the overrides - from the :term:`FILESOVERRIDES` variable. - - .. note:: - - - Do not hand-edit the ``FILESPATH`` variable. If you want the - build system to look in directories other than the defaults, - extend the ``FILESPATH`` variable by using the - :term:`FILESEXTRAPATHS` variable. - - - Be aware that the default ``FILESPATH`` directories do not map - to directories in custom layers where append files - (``.bbappend``) are used. If you want the build system to find - patches or files that reside with your append files, you need - to extend the ``FILESPATH`` variable by using the - ``FILESEXTRAPATHS`` variable. - - You can take advantage of this searching behavior in useful ways. For - example, consider a case where the following directory structure - exists for general and machine-specific configurations: - :: - - files/defconfig - files/MACHINEA/defconfig - files/MACHINEB/defconfig - - Also in the example, the ``SRC_URI`` statement contains - "file://defconfig". Given this scenario, you can set - :term:`MACHINE` to "MACHINEA" and cause the build - system to use files from ``files/MACHINEA``. Set ``MACHINE`` to - "MACHINEB" and the build system uses files from ``files/MACHINEB``. - Finally, for any machine other than "MACHINEA" and "MACHINEB", the - build system uses files from ``files/defconfig``. - - You can find out more about the patching process in the - ":ref:`overview-manual/concepts:patching`" section - in the Yocto Project Overview and Concepts Manual and the - ":ref:`dev-manual/common-tasks:patching code`" section in - the Yocto Project Development Tasks Manual. See the - :ref:`ref-tasks-patch` task as well. - - :term:`FILESYSTEM_PERMS_TABLES` - 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. - - By default, the OpenEmbedded build system uses the ``fs-perms.txt``, - which is located in the ``meta/files`` folder in the :term:`Source Directory`. - If you create your own file - permissions setting table, you should place it in your layer or the - distro's layer. - - You define the ``FILESYSTEM_PERMS_TABLES`` variable in the - ``conf/local.conf`` file, which is found in the :term:`Build Directory`, - to point to your custom - ``fs-perms.txt``. You can specify more than a single file permissions - setting table. The paths you specify to these files must be defined - within the :term:`BBPATH` variable. - - For guidance on how to create your own file permissions settings - table file, examine the existing ``fs-perms.txt``. - - :term:`FIT_GENERATE_KEYS` - Decides whether to generate the keys for signing fitImage if they - don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. - The default value is 0. - - :term:`FIT_HASH_ALG` - Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256. - - :term:`FIT_KEY_GENRSA_ARGS` - Arguments to openssl genrsa for generating RSA private key for signing - fitImage. The default value is "-F4". i.e. the public exponent 65537 to - use. - - :term:`FIT_KEY_REQ_ARGS` - Arguments to openssl req for generating certificate for signing fitImage. - The default value is "-batch -new". batch for non interactive mode - and new for generating new keys. - - :term:`FIT_KEY_SIGN_PKCS` - Format for public key ceritifcate used in signing fitImage. - The default value is "x509". - - :term:`FIT_SIGN_ALG` - Specifies the signature algorithm used in creating the FIT Image. - For e.g. rsa2048. - - :term:`FIT_SIGN_NUMBITS` - Size of private key in number of bits used in fitImage. The default - value is "2048". - - :term:`FONT_EXTRA_RDEPENDS` - When inheriting the :ref:`fontcache ` class, - this variable specifies the runtime dependencies for font packages. - By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". - - :term:`FONT_PACKAGES` - When inheriting the :ref:`fontcache ` class, - this variable identifies packages containing font files that need to - be cached by Fontconfig. By default, the ``fontcache`` class assumes - that fonts are in the recipe's main package (i.e. - ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you - need are in a package other than that main package. - - :term:`FORCE_RO_REMOVE` - Forces the removal of the packages listed in ``ROOTFS_RO_UNNEEDED`` - during the generation of the root filesystem. - - Set the variable to "1" to force the removal of these packages. - - :term:`FULL_OPTIMIZATION` - The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when - compiling an optimized system. This variable defaults to "-O2 -pipe - ${DEBUG_FLAGS}". - - :term:`GCCPIE` - Enables Position Independent Executables (PIE) within the GNU C - Compiler (GCC). Enabling PIE in the GCC makes Return Oriented - Programming (ROP) attacks much more difficult to execute. - - By default the ``security_flags.inc`` file enables PIE by setting the - variable as follows: - :: - - GCCPIE ?= "--enable-default-pie" - - :term:`GCCVERSION` - Specifies the default version of the GNU C Compiler (GCC) used for - compilation. By default, ``GCCVERSION`` is set to "8.x" in the - ``meta/conf/distro/include/tcmode-default.inc`` include file: - :: - - GCCVERSION ?= "8.%" - - You can override this value by setting it in a - configuration file such as the ``local.conf``. - - :term:`GDB` - The minimal command and arguments to run the GNU Debugger. - - :term:`GITDIR` - The directory in which a local copy of a Git repository is stored - when it is cloned. - - :term:`GLIBC_GENERATE_LOCALES` - Specifies the list of GLIBC locales to generate should you not wish - to generate all LIBC locals, which can be time consuming. - - .. note:: - - If you specifically remove the locale ``en_US.UTF-8``, you must set - :term:`IMAGE_LINGUAS` appropriately. - - You can set ``GLIBC_GENERATE_LOCALES`` in your ``local.conf`` file. - By default, all locales are generated. - :: - - GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" - - :term:`GROUPADD_PARAM` - When inheriting the :ref:`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. - - Here is an example from the ``dbus`` recipe: - :: - - GROUPADD_PARAM_${PN} = "-r netdev" - - For information on the standard Linux shell command - ``groupadd``, see http://linux.die.net/man/8/groupadd. - - :term:`GROUPMEMS_PARAM` - When inheriting the :ref:`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. - - For information on the standard Linux shell command ``groupmems``, - see http://linux.die.net/man/8/groupmems. - - :term:`GRUB_GFXSERIAL` - Configures the GNU GRand Unified Bootloader (GRUB) to have graphics - and serial in the boot menu. Set this variable to "1" in your - ``local.conf`` or distribution configuration file to enable graphics - and serial in the menu. - - See the :ref:`grub-efi ` class for more - information on how this variable is used. - - :term:`GRUB_OPTS` - Additional options to add to the GNU GRand Unified Bootloader (GRUB) - configuration. Use a semi-colon character (``;``) to separate - multiple options. - - The ``GRUB_OPTS`` variable is optional. See the - :ref:`grub-efi ` class for more information - on how this variable is used. - - :term:`GRUB_TIMEOUT` - Specifies the timeout before executing the default ``LABEL`` in the - GNU GRand Unified Bootloader (GRUB). - - The ``GRUB_TIMEOUT`` variable is optional. See the - :ref:`grub-efi ` class for more information - on how this variable is used. - - :term:`GTKIMMODULES_PACKAGES` - When inheriting the - :ref:`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. - - :term:`HOMEPAGE` - Website where more information about the software the recipe is - building can be found. - - :term:`HOST_ARCH` - The name of the target architecture, which is normally the same as - :term:`TARGET_ARCH`. 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: - - - arm - - i586 - - x86_64 - - powerpc - - powerpc64 - - mips - - mipsel - - :term:`HOST_CC_ARCH` - Specifies architecture-specific compiler flags that are passed to the - C compiler. - - Default initialization for ``HOST_CC_ARCH`` varies depending on what - is being built: - - - :term:`TARGET_CC_ARCH` when building for the - target - - - :term:`BUILD_CC_ARCH` when building for the build host (i.e. - ``-native``) - - - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. - ``nativesdk-``) - - :term:`HOST_OS` - Specifies the name of the target operating system, which is normally - the same as the :term:`TARGET_OS`. The variable can - be set to "linux" for ``glibc``-based systems and to "linux-musl" for - ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and - "linux-musleabi" values possible. - - :term:`HOST_PREFIX` - Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX`` - is normally the same as :term:`TARGET_PREFIX`. - - :term:`HOST_SYS` - Specifies the system, including the architecture and the operating - system, for which the build is occurring in the context of the - current recipe. - - The OpenEmbedded build system automatically sets this variable based - on :term:`HOST_ARCH`, - :term:`HOST_VENDOR`, and - :term:`HOST_OS` variables. - - .. note:: - - You do not need to set the variable yourself. - - Consider these two examples: - - - Given a native recipe on a 32-bit x86 machine running Linux, the - value is "i686-linux". - - - Given a recipe being built for a little-endian MIPS target running - Linux, the value might be "mipsel-linux". - - :term:`HOSTTOOLS` - A space-separated list (filter) of tools on the build host that - should be allowed to be called from within build tasks. Using this - filter helps reduce the possibility of host contamination. If a tool - specified in the value of ``HOSTTOOLS`` is not found on the build - host, the OpenEmbedded build system produces an error and the build - is not started. - - For additional information, see - :term:`HOSTTOOLS_NONFATAL`. - - :term:`HOSTTOOLS_NONFATAL` - A space-separated list (filter) of tools on the build host that - should be allowed to be called from within build tasks. Using this - filter helps reduce the possibility of host contamination. Unlike - :term:`HOSTTOOLS`, the OpenEmbedded build system - does not produce an error if a tool specified in the value of - ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can - use ``HOSTTOOLS_NONFATAL`` to filter optional host tools. - - :term:`HOST_VENDOR` - Specifies the name of the vendor. ``HOST_VENDOR`` is normally the - same as :term:`TARGET_VENDOR`. - - :term:`ICECC_DISABLED` - Disables or enables the ``icecc`` (Icecream) function. For more - information on this function and best practices for using this - variable, see the ":ref:`icecc.bbclass `" - section. - - Setting this variable to "1" in your ``local.conf`` disables the - function: - :: - - ICECC_DISABLED ??= "1" - - To enable the function, set the variable as follows: - :: - - ICECC_DISABLED = "" - - :term:`ICECC_ENV_EXEC` - Points to the ``icecc-create-env`` script that you provide. This - variable is used by the :ref:`icecc ` class. You - set this variable in your ``local.conf`` file. - - If you do not point to a script that you provide, the OpenEmbedded - build system uses the default script provided by the - ``icecc-create-env.bb`` recipe, which is a modified version and not - the one that comes with ``icecc``. - - :term:`ICECC_PARALLEL_MAKE` - Extra options passed to the ``make`` command during the - :ref:`ref-tasks-compile` task that specify parallel - compilation. This variable usually takes the form of "-j x", where x - represents the maximum number of parallel threads ``make`` can run. - - .. note:: - - The options passed affect builds on all enabled machines on the - network, which are machines running the ``iceccd`` daemon. - - 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 - :term:`PARALLEL_MAKE` variable, there is no - rule-of-thumb for setting ``ICECC_PARALLEL_MAKE`` to achieve optimal - performance. - - If you do not set ``ICECC_PARALLEL_MAKE``, the build system does not - use it (i.e. the system does not detect and assign the number of - cores as is done with ``PARALLEL_MAKE``). - - :term:`ICECC_PATH` - The location of the ``icecc`` binary. You can set this variable in - your ``local.conf`` file. If your ``local.conf`` file does not define - this variable, the :ref:`icecc ` class attempts - to define it by locating ``icecc`` using ``which``. - - :term:`ICECC_USER_CLASS_BL` - Identifies user classes that you do not want the Icecream distributed - compile support to consider. This variable is used by the - :ref:`icecc ` class. You set this variable in - your ``local.conf`` file. - - 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. - - :term:`ICECC_USER_PACKAGE_BL` - Identifies user recipes that you do not want the Icecream distributed - compile support to consider. This variable is used by the - :ref:`icecc ` class. You set this variable in - your ``local.conf`` file. - - 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. - - :term:`ICECC_USER_PACKAGE_WL` - Identifies user recipes that use an empty - :term:`PARALLEL_MAKE` variable that you want to - force remote distributed compilation on using the Icecream - distributed compile support. This variable is used by the - :ref:`icecc ` class. You set this variable in - your ``local.conf`` file. - - :term:`IMAGE_BASENAME` - The base name of image output files. This variable defaults to the - recipe name (``${``\ :term:`PN`\ ``}``). - - :term:`IMAGE_EFI_BOOT_FILES` - A space-separated list of files installed into the boot partition - when preparing an image using the Wic tool with the - ``bootimg-efi`` 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 - :term:`DEPLOY_DIR_IMAGE`. Here are two - examples: - :: - - IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2" - IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio" - - Alternatively, source files can be picked up using a glob pattern. In - this case, the destination file must 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: - :: - - IMAGE_EFI_BOOT_FILES = "boot/loader/*" - IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/" - - The first example - installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/`` - into the root of the target partition. The second example installs - the same files into a ``boot`` directory within the target partition. - - You can find information on how to use the Wic tool in the - ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" - section of the Yocto Project Development Tasks Manual. Reference - material for Wic is located in the - ":doc:`/ref-manual/ref-kickstart`" chapter. - - :term:`IMAGE_BOOT_FILES` - A space-separated list of files installed into the boot partition - when preparing an image using the Wic tool with the - ``bootimg-partition`` 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 - :term:`DEPLOY_DIR_IMAGE`. Here are two - examples: - :: - - IMAGE_BOOT_FILES = "u-boot.img uImage;kernel" - IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}" - - Alternatively, source files can be picked up using a glob pattern. In - this case, the destination file must 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: - :: - - IMAGE_BOOT_FILES = "bcm2835-bootfiles/*" - IMAGE_BOOT_FILES = "bcm2835-bootfiles/*;boot/" - - The first example - installs all files from ``${DEPLOY_DIR_IMAGE}/bcm2835-bootfiles`` - into the root of the target partition. The second example installs - the same files into a ``boot`` directory within the target partition. - - You can find information on how to use the Wic tool in the - ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" - section of the Yocto Project Development Tasks Manual. Reference - material for Wic is located in the - ":doc:`/ref-manual/ref-kickstart`" chapter. - - :term:`IMAGE_CLASSES` - 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. - - The default value for ``IMAGE_CLASSES`` is ``image_types``. You can - set this variable in your ``local.conf`` or in a distribution - configuration file. - - For more information, see ``meta/classes/image_types.bbclass`` in the - :term:`Source Directory`. - - :term:`IMAGE_CMD` - Specifies the command to create the image file for a specific image - type, which corresponds to the value set set in - :term:`IMAGE_FSTYPES`, (e.g. ``ext3``, - ``btrfs``, and so forth). When setting this variable, you should use - an override for the associated type. Here is an example: - :: - - IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \ - --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \ - ${EXTRA_IMAGECMD}" - - 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 :ref:`image_types ` - class file, which is ``meta/classes/image_types.bbclass``. - - :term:`IMAGE_DEVICE_TABLES` - Specifies one or more files that contain custom device tables that - are passed to the ``makedevs`` command as part of creating an image. - These files list basic device nodes that should be created under - ``/dev`` within the image. If ``IMAGE_DEVICE_TABLES`` is not set, - ``files/device_table-minimal.txt`` is used, which is located by - :term:`BBPATH`. For details on how you should write - device table files, see ``meta/files/device_table-minimal.txt`` as an - example. - - :term:`IMAGE_FEATURES` - 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 ``local.conf`` file, which is found in the - :term:`Build Directory`, best practices dictate that you do - not. - - .. note:: - - To enable extra features from outside the image recipe, use the - :term:`EXTRA_IMAGE_FEATURES` variable. - - For a list of image features that ships with the Yocto Project, see - the ":ref:`ref-features-image`" section. - - For an example that shows how to customize your image by using this - variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" - section in the Yocto Project Development Tasks Manual. - - :term:`IMAGE_FSTYPES` - Specifies the formats the OpenEmbedded build system uses during the - build when creating the root filesystem. For example, setting - ``IMAGE_FSTYPES`` as follows causes the build system to create root - filesystems using two formats: ``.ext3`` and ``.tar.bz2``: - :: - - IMAGE_FSTYPES = "ext3 tar.bz2" - - For the complete list of supported image formats from which you can - choose, see :term:`IMAGE_TYPES`. - - .. note:: - - - If an image recipe uses the "inherit image" line and you are - setting ``IMAGE_FSTYPES`` inside the recipe, you must set - ``IMAGE_FSTYPES`` prior to using the "inherit image" line. - - - Due to the way the OpenEmbedded build system processes this - variable, you cannot update its contents by using ``_append`` - or ``_prepend``. You must use the ``+=`` operator to add one or - more options to the ``IMAGE_FSTYPES`` variable. - - :term:`IMAGE_INSTALL` - Used by recipes to specify the packages to install into an image - through the :ref:`image ` class. Use the - ``IMAGE_INSTALL`` variable with care to avoid ordering issues. - - Image recipes set ``IMAGE_INSTALL`` to specify the packages to - install into an image through ``image.bbclass``. Additionally, - "helper" classes such as the - :ref:`core-image ` class exist that can - take lists used with ``IMAGE_FEATURES`` and turn them into - auto-generated entries in ``IMAGE_INSTALL`` in addition to its - default contents. - - When you use this variable, it is best to use it as follows: - :: - - IMAGE_INSTALL_append = " package-name" - - Be sure to include the space - between the quotation character and the start of the package name or - names. - - .. note:: - - - When working with a - :ref:`core-image-minimal-initramfs ` - image, do not use the ``IMAGE_INSTALL`` variable to specify - packages for installation. Instead, use the - :term:`PACKAGE_INSTALL` variable, which - allows the initial RAM filesystem (initramfs) recipe to use a - fixed set of packages and not be affected by ``IMAGE_INSTALL``. - For information on creating an initramfs, see the - ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" - section in the Yocto Project Development Tasks Manual. - - - Using ``IMAGE_INSTALL`` with the - :ref:`+= ` - BitBake operator within the ``/conf/local.conf`` file or from - within an image recipe is not recommended. Use of this operator - in these ways can cause ordering issues. Since - ``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default - value using the - :ref:`?= ` - operator, using a ``+=`` operation against ``IMAGE_INSTALL`` - results in unexpected behavior when used within - ``conf/local.conf``. 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 ``+=`` operator to work. - - :term:`IMAGE_LINGUAS` - 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 ``IMAGE_LINGUAS`` variable - ensures that any locale packages that correspond to packages already - selected for installation into the image are also installed. Here is - an example: - :: - - IMAGE_LINGUAS = "pt-br de-de" - - 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. ``*-locale-pt-br`` and ``*-locale-de-de`` as well as - ``*-locale-pt`` and ``*-locale-de``, since some software packages - only provide locale files by language and not by country-specific - language). - - See the :term:`GLIBC_GENERATE_LOCALES` - variable for information on generating GLIBC locales. - - - :term:`IMAGE_LINK_NAME` - The name of the output image symlink (which does not include - the version part as :term:`IMAGE_NAME` does). The default value - is derived using the :term:`IMAGE_BASENAME` and :term:`MACHINE` - variables: - :: - - IMAGE_LINK_NAME ?= "${IMAGE_BASENAME}-${MACHINE}" - - - :term:`IMAGE_MANIFEST` - 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: - :: - - packagename packagearch version - - The :ref:`image ` class defines the manifest - file as follows: - :: - - IMAGE_MANIFEST ="${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest" - - The location is - derived using the :term:`DEPLOY_DIR_IMAGE` - and :term:`IMAGE_NAME` variables. You can find - information on how the image is created in the ":ref:`overview-manual/concepts:image generation`" - section in the Yocto Project Overview and Concepts Manual. - - :term:`IMAGE_NAME` - The name of the output image files minus the extension. This variable - is derived using the :term:`IMAGE_BASENAME`, - :term:`MACHINE`, and :term:`IMAGE_VERSION_SUFFIX` - variables: - :: - - IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - - :term:`IMAGE_NAME_SUFFIX` - Suffix used for the image output file name - defaults to ``".rootfs"`` - to distinguish the image file from other files created during image - building; however if this suffix is redundant or not desired you can - clear the value of this variable (set the value to ""). For example, - this is typically cleared in initramfs image recipes. - - :term:`IMAGE_OVERHEAD_FACTOR` - 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``. 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 - ``IMAGE_ROOTFS_SIZE`` for information on how the build system - determines the overall image size. - - 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: - :: - - IMAGE_OVERHEAD_FACTOR = "1.5" - - Alternatively, you can ensure a specific amount of free disk space is - added to the image by using the ``IMAGE_ROOTFS_EXTRA_SPACE`` - variable. - - :term:`IMAGE_PKGTYPE` - Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the - OpenEmbedded build system. The variable is defined appropriately by - the :ref:`package_deb `, - :ref:`package_rpm `, - :ref:`package_ipk `, or - :ref:`package_tar ` class. - - .. note:: - - The ``package_tar`` class is broken and is not supported. It is - recommended that you do not use it. - - The :ref:`populate_sdk_* ` and - :ref:`image ` classes use the ``IMAGE_PKGTYPE`` - for packaging up images and SDKs. - - You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the - variable is set indirectly through the appropriate - :ref:`package_* ` class using the - :term:`PACKAGE_CLASSES` 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 ``.tar`` format are never used as a substitute - packaging format for DEB, RPM, and IPK formatted files for your image - or SDK. - - :term:`IMAGE_POSTPROCESS_COMMAND` - Specifies a list of functions to call once the OpenEmbedded build - system creates the final image output files. You can specify - functions separated by semicolons: - :: - - IMAGE_POSTPROCESS_COMMAND += "function; ... " - - If you need to pass the root filesystem path to a command within the - function, you can use ``${IMAGE_ROOTFS}``, which points to the - directory that becomes the root filesystem image. See the - :term:`IMAGE_ROOTFS` variable for more - information. - - :term:`IMAGE_PREPROCESS_COMMAND` - Specifies a list of functions to call before the OpenEmbedded build - system creates the final image output files. You can specify - functions separated by semicolons: - :: - - IMAGE_PREPROCESS_COMMAND += "function; ... " - - If you need to pass the root filesystem path to a command within the - function, you can use ``${IMAGE_ROOTFS}``, which points to the - directory that becomes the root filesystem image. See the - :term:`IMAGE_ROOTFS` variable for more - information. - - :term:`IMAGE_ROOTFS` - The location of the root filesystem while it is under construction - (i.e. during the :ref:`ref-tasks-rootfs` task). This - variable is not configurable. Do not change it. - - :term:`IMAGE_ROOTFS_ALIGNMENT` - 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 :term:`IMAGE_ROOTFS_SIZE` for - additional information. - - :term:`IMAGE_ROOTFS_EXTRA_SPACE` - 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 ``IMAGE_ROOTFS_SIZE``. - - 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: - :: - - IMAGE_ROOTFS_EXTRA_SPACE = "5242880" - - For example, the Yocto Project Build Appliance specifically requests - 40 Gbytes of extra space with the line: - :: - - IMAGE_ROOTFS_EXTRA_SPACE = "41943040" - - :term:`IMAGE_ROOTFS_SIZE` - 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: - :: - - 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 - - See the :term:`IMAGE_OVERHEAD_FACTOR` - and :term:`IMAGE_ROOTFS_EXTRA_SPACE` - variables for related information. - - :term:`IMAGE_TYPEDEP` - Specifies a dependency from one image type on another. Here is an - example from the :ref:`image-live ` class: - :: - - IMAGE_TYPEDEP_live = "ext3" - - In the previous example, the variable ensures that when "live" is - listed with the :term:`IMAGE_FSTYPES` variable, - the OpenEmbedded build system produces an ``ext3`` image first since - one of the components of the live image is an ``ext3`` formatted - partition containing the root filesystem. - - :term:`IMAGE_TYPES` - Specifies the complete list of supported image types by default: - - - btrfs - - container - - cpio - - cpio.gz - - cpio.lz4 - - cpio.lzma - - cpio.xz - - cramfs - - ext2 - - ext2.bz2 - - ext2.gz - - ext2.lzma - - ext3 - - ext3.gz - - ext4 - - ext4.gz - - f2fs - - hddimg - - iso - - jffs2 - - jffs2.sum - - multiubi - - squashfs - - squashfs-lz4 - - squashfs-lzo - - squashfs-xz - - tar - - tar.bz2 - - tar.gz - - tar.lz4 - - tar.xz - - tar.zst - - ubi - - ubifs - - wic - - wic.bz2 - - wic.gz - - wic.lzma - - For more information about these types of images, see - ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`. - - :term:`IMAGE_VERSION_SUFFIX` - Version suffix that is part of the default :term:`IMAGE_NAME` and - :term:`KERNEL_ARTIFACT_NAME` values. - Defaults to ``"-${DATETIME}"``, however you could set this to a - version string that comes from your external build environment if - desired, and this suffix would then be used consistently across - the build artifacts. - - :term:`INC_PR` - Helps define the recipe revision for recipes that share a common - ``include`` file. You can think of this variable as part of the - recipe revision as set from within an include file. - - Suppose, for example, you have a set of recipes that are used across - several projects. And, within each of those recipes the revision (its - :term:`PR` 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. - - A more efficient way of dealing with this situation is to set the - ``INC_PR`` variable inside the ``include`` files that the recipes - share and then expand the ``INC_PR`` variable within the recipes to - help define the recipe revision. - - The following provides an example that shows how to use the - ``INC_PR`` variable given a common ``include`` file that defines the - variable. Once the variable is defined in the ``include`` file, you - can use the variable to set the ``PR`` values in each recipe. You - will notice that when you set a recipe's ``PR`` you can provide more - granular revisioning by appending values to the ``INC_PR`` variable: - :: - - 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" - - The - first line of the example establishes the baseline revision to be - used for all recipes that use the ``include`` file. The remaining - lines in the example are from individual recipes and show how the - ``PR`` value is set. - - :term:`INCOMPATIBLE_LICENSE` - Specifies a space-separated list of license names (as they would - appear in :term:`LICENSE`) 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. - - .. note:: - - This functionality is only regularly tested using the following - setting: - :: - - INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" - - - 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:: - - It is possible to define a list of licenses that are allowed to be - used instead of the licenses that are excluded. To do this, define - a variable ``COMPATIBLE_LICENSES`` with the names of the licences - that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as: - :: - - INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}" - - - This will result in ``INCOMPATIBLE_LICENSE`` containing the names of - all licences from :term:`AVAILABLE_LICENSES` except the ones specified - in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licences to - be used. - - :term:`INHERIT` - Causes the named class or classes to be inherited globally. Anonymous - functions in the class or classes are not executed for the base - configuration and in each individual recipe. The OpenEmbedded build - system ignores changes to ``INHERIT`` in individual recipes. - - For more information on ``INHERIT``, see the - :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" - section in the Bitbake User Manual. - - :term:`INHERIT_DISTRO` - Lists classes that will be inherited at the distribution level. It is - unlikely that you want to edit this variable. - - The default value of the variable is set as follows in the - ``meta/conf/distro/defaultsetup.conf`` file: - :: - - INHERIT_DISTRO ?= "debian devshell sstate license" - - :term:`INHIBIT_DEFAULT_DEPS` - Prevents the default dependencies, namely the C compiler and standard - C library (libc), from being added to :term:`DEPENDS`. - This variable is usually used within recipes that do not require any - compilation using the C compiler. - - Set the variable to "1" to prevent the default dependencies from - being added. - - :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` - Prevents the OpenEmbedded build system from splitting out debug - information during packaging. By default, the build system splits out - debugging information during the - :ref:`ref-tasks-package` task. For more information on - how debug information is split out, see the - :term:`PACKAGE_DEBUG_SPLIT_STYLE` - variable. - - To prevent the build system from splitting out debug information - during packaging, set the ``INHIBIT_PACKAGE_DEBUG_SPLIT`` variable as - follows: - :: - - INHIBIT_PACKAGE_DEBUG_SPLIT = "1" - - :term:`INHIBIT_PACKAGE_STRIP` - If set to "1", causes the build to not strip binaries in resulting - packages and prevents the ``-dbg`` package from containing the source - files. - - By default, the OpenEmbedded build system strips binaries and puts - the debugging symbols into ``${``\ :term:`PN`\ ``}-dbg``. - Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you - plan to debug in general. - - :term:`INHIBIT_SYSROOT_STRIP` - If set to "1", causes the build to not strip binaries in the - resulting sysroot. - - By default, the OpenEmbedded build system strips binaries in the - resulting sysroot. When you specifically set the - ``INHIBIT_SYSROOT_STRIP`` variable to "1" in your recipe, you inhibit - this stripping. - - If you want to use this variable, include the - :ref:`staging ` class. This class uses a - ``sys_strip()`` function to test for the variable and acts - accordingly. - - .. note:: - - Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and - special circumstances. For example, suppose you are building - bare-metal firmware by using an external GCC toolchain. Furthermore, - even if the toolchain's binaries are strippable, other files exist - that are needed for the build that are not strippable. - - :term:`INITRAMFS_FSTYPES` - Defines the format for the output image of an initial RAM filesystem - (initramfs), which is used during boot. Supported formats are the - same as those supported by the - :term:`IMAGE_FSTYPES` variable. - - The default value of this variable, which is set in the - ``meta/conf/bitbake.conf`` configuration file in the - :term:`Source Directory`, is "cpio.gz". The Linux kernel's - initramfs mechanism, as opposed to the initial RAM filesystem - `initrd `__ mechanism, expects - an optionally compressed cpio archive. - - :term:`INITRAMFS_IMAGE` - Specifies the :term:`PROVIDES` name of an image - recipe that is used to build an initial RAM filesystem (initramfs) - image. In other words, the ``INITRAMFS_IMAGE`` variable causes an - additional recipe to be built as a dependency to whatever root - filesystem recipe you might be using (e.g. ``core-image-sato``). The - initramfs image recipe you provide should set - :term:`IMAGE_FSTYPES` to - :term:`INITRAMFS_FSTYPES`. - - An initramfs image provides a temporary root filesystem used for - early system initialization (e.g. loading of modules needed to locate - and mount the "real" root filesystem). - - .. note:: - - See the ``meta/recipes-core/images/core-image-minimal-initramfs.bb`` - recipe in the :term:`Source Directory` - for an example initramfs recipe. To select this sample recipe as - the one built to provide the initramfs image, set ``INITRAMFS_IMAGE`` - to "core-image-minimal-initramfs". - - You can also find more information by referencing the - ``meta-poky/conf/local.conf.sample.extended`` configuration file in - the Source Directory, the :ref:`image ` class, - and the :ref:`kernel ` class to see how to use - the ``INITRAMFS_IMAGE`` variable. - - If ``INITRAMFS_IMAGE`` is empty, which is the default, then no - initramfs image is built. - - For more information, you can also see the - :term:`INITRAMFS_IMAGE_BUNDLE` - variable, which allows the generated image to be bundled inside the - kernel image. Additionally, for information on creating an initramfs - image, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section - in the Yocto Project Development Tasks Manual. - - :term:`INITRAMFS_IMAGE_BUNDLE` - Controls whether or not the image recipe specified by - :term:`INITRAMFS_IMAGE` is run through an - extra pass - (:ref:`ref-tasks-bundle_initramfs`) during - kernel compilation in order to build a single binary that contains - both the kernel image and the initial RAM filesystem (initramfs) - image. This makes use of the - :term:`CONFIG_INITRAMFS_SOURCE` kernel - feature. - - .. note:: - - Using an extra compilation pass to bundle the initramfs avoids a - circular dependency between the kernel recipe and the initramfs - recipe should the initramfs include kernel modules. Should that be - the case, the initramfs recipe depends on the kernel for the - kernel modules, and the kernel depends on the initramfs recipe - since the initramfs is bundled inside the kernel image. - - The combined binary is deposited into the ``tmp/deploy`` directory, - which is part of the :term:`Build Directory`. - - Setting the variable to "1" in a configuration file causes the - OpenEmbedded build system to generate a kernel image with the - initramfs specified in ``INITRAMFS_IMAGE`` bundled within: - :: - - INITRAMFS_IMAGE_BUNDLE = "1" - - By default, the - :ref:`kernel ` class sets this variable to a - null string as follows: - :: - - INITRAMFS_IMAGE_BUNDLE ?= "" - - .. note:: - - You must set the ``INITRAMFS_IMAGE_BUNDLE`` variable in a - configuration file. You cannot set the variable in a recipe file. - - See the - :yocto_git:`local.conf.sample.extended ` - file for additional information. Also, for information on creating an - initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section - in the Yocto Project Development Tasks Manual. - - :term:`INITRAMFS_LINK_NAME` - The link name of the initial RAM filesystem image. This variable is - set in the ``meta/classes/kernel-artifact-names.bbclass`` file as - follows: - :: - - INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}" - - The value of the - ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same - file, has the following value: - :: - - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - - See the :term:`MACHINE` variable for additional - information. - - :term:`INITRAMFS_NAME` - The base name of the initial RAM filesystem image. This variable is - set in the ``meta/classes/kernel-artifact-names.bbclass`` file as - follows: - :: - - INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" - - The value of the :term:`KERNEL_ARTIFACT_NAME` - variable, which is set in the same file, has the following value: - :: - - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - - :term:`INITRD` - Indicates list of filesystem images to concatenate and use as an - initial RAM disk (``initrd``). - - The ``INITRD`` variable is an optional variable used with the - :ref:`image-live ` class. - - :term:`INITRD_IMAGE` - When building a "live" bootable image (i.e. when - :term:`IMAGE_FSTYPES` contains "live"), - ``INITRD_IMAGE`` specifies the image recipe that should be built to - provide the initial RAM disk image. The default value is - "core-image-minimal-initramfs". - - See the :ref:`image-live ` class for more - information. - - :term:`INITSCRIPT_NAME` - The filename of the initialization script as installed to - ``${sysconfdir}/init.d``. - - This variable is used in recipes when using ``update-rc.d.bbclass``. - The variable is mandatory. - - :term:`INITSCRIPT_PACKAGES` - A list of the packages that contain initscripts. If multiple packages - are specified, you need to append the package name to the other - ``INITSCRIPT_*`` as an override. - - This variable is used in recipes when using ``update-rc.d.bbclass``. - The variable is optional and defaults to the :term:`PN` - variable. - - :term:`INITSCRIPT_PARAMS` - Specifies the options to pass to ``update-rc.d``. Here is an example: - :: - - INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ." - - 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. - - The variable's default value is "defaults", which is set in the - :ref:`update-rc.d ` class. - - The value in ``INITSCRIPT_PARAMS`` is passed through to the - ``update-rc.d`` command. For more information on valid parameters, - please see the ``update-rc.d`` manual page at - https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html - - :term:`INSANE_SKIP` - Specifies the QA checks to skip for a specific package within a - recipe. For example, to skip the check for symbolic link ``.so`` - 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 ``${PN}``: - :: - - INSANE_SKIP_${PN} += "dev-so" - - See the ":ref:`insane.bbclass `" section for a - list of the valid QA checks you can specify using this variable. - - :term:`INSTALL_TIMEZONE_FILE` - By default, the ``tzdata`` recipe packages an ``/etc/timezone`` file. - Set the ``INSTALL_TIMEZONE_FILE`` variable to "0" at the - configuration level to disable this behavior. - - :term:`IPK_FEED_URIS` - When the IPK backend is in use and package management is enabled on - the target, you can use this variable to set up ``opkg`` 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. - - :term:`KARCH` - Defines the kernel architecture used when assembling the - configuration. Architectures supported for this release are: - - - powerpc - - i386 - - x86_64 - - arm - - qemu - - mips - - You define the ``KARCH`` variable in the :ref:`kernel-dev/advanced:bsp descriptions`. - - :term:`KBRANCH` - 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. - - 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 - ``linux-yocto_4.12`` kernel, the kernel recipe file is the - ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` file. ``KBRANCH`` - is set as follows in that kernel recipe file: - :: - - KBRANCH ?= "standard/base" - - This variable is also used from the kernel's append file to identify - the kernel branch specific to a particular machine or target - hardware. Continuing with the previous kernel example, the kernel's - append file (i.e. ``linux-yocto_4.12.bbappend``) is located in the - BSP layer for a given machine. For example, the append file for the - Beaglebone, EdgeRouter, and generic versions of both 32 and 64-bit IA - machines (``meta-yocto-bsp``) is named - ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend``. - Here are the related statements from that append file: - :: - - KBRANCH_genericx86 = "standard/base" - KBRANCH_genericx86-64 = "standard/base" - KBRANCH_edgerouter = "standard/edgerouter" - KBRANCH_beaglebone = "standard/beaglebone" - - The ``KBRANCH`` statements - identify the kernel branch to use when building for each supported - BSP. - - :term:`KBUILD_DEFCONFIG` - When used with the :ref:`kernel-yocto ` - class, specifies an "in-tree" kernel configuration file for use - during a kernel build. - - Typically, when using a ``defconfig`` to configure a kernel during a - build, you place the file in your layer in the same manner as you - would place patch files and configuration fragment files (i.e. - "out-of-tree"). However, if you want to use a ``defconfig`` file that - is part of the kernel tree (i.e. "in-tree"), you can use the - ``KBUILD_DEFCONFIG`` variable and append the - :term:`KMACHINE` variable to point to the - ``defconfig`` file. - - To use the variable, set it in the append file for your kernel recipe - using the following form: - :: - - KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file - - Here is an example from a "raspberrypi2" ``KMACHINE`` build that uses - a ``defconfig`` file named "bcm2709_defconfig": - :: - - KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig" - - As an alternative, you can use the following within your append file: - :: - - KBUILD_DEFCONFIG_pn-linux-yocto ?= defconfig_file - - For more - information on how to use the ``KBUILD_DEFCONFIG`` variable, see the - ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`" - section in the Yocto Project Linux Kernel Development Manual. - - :term:`KERNEL_ALT_IMAGETYPE` - Specifies an alternate kernel image type for creation in addition to - the kernel image type specified using the - :term:`KERNEL_IMAGETYPE` variable. - - :term:`KERNEL_ARTIFACT_NAME` - Specifies the name of all of the build artifacts. You can change the - name of the artifacts by changing the ``KERNEL_ARTIFACT_NAME`` - variable. - - The value of ``KERNEL_ARTIFACT_NAME``, which is set in the - ``meta/classes/kernel-artifact-names.bbclass`` file, has the - following default value: - :: - - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - - See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, :term:`MACHINE` - and :term:`IMAGE_VERSION_SUFFIX` variables for additional information. - - :term:`KERNEL_CLASSES` - A list of classes defining kernel image types that the - :ref:`kernel ` 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 ``meta/classes/kernel-fitimage.bbclass``. You can register - custom kernel image types with the ``kernel`` class using this - variable. - - :term:`KERNEL_DEVICETREE` - Specifies the name of the generated Linux kernel device tree (i.e. - the ``.dtb``) file. - - .. note:: - - Legacy support exists for specifying the full path to the device - tree. However, providing just the ``.dtb`` file is preferred. - - In order to use this variable, the - :ref:`kernel-devicetree ` class must - be inherited. - - :term:`KERNEL_DTB_LINK_NAME` - The link name of the kernel device tree binary (DTB). This variable - is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as - follows: - :: - - KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" - - The - value of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in - the same file, has the following value: - :: - - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - - See the :term:`MACHINE` variable for additional - information. - - :term:`KERNEL_DTB_NAME` - The base name of the kernel device tree binary (DTB). This variable - is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as - follows: - :: - - KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" - - The value of the :term:`KERNEL_ARTIFACT_NAME` - variable, which is set in the same file, has the following value: - :: - - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - - :term:`KERNEL_EXTRA_ARGS` - Specifies additional ``make`` command-line arguments the OpenEmbedded - build system passes on when compiling the kernel. - - :term:`KERNEL_FEATURES` - Includes additional kernel metadata. In the OpenEmbedded build - system, the default Board Support Packages (BSPs) - :term:`Metadata` is provided through the - :term:`KMACHINE` and :term:`KBRANCH` - variables. You can use the ``KERNEL_FEATURES`` variable from within - the kernel recipe or kernel append file to further add metadata for - all BSPs or specific BSPs. - - 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 ``KERNEL_FEATURES`` - variable for a specific machine. In this way, you can provide - validated, but optional, sets of kernel configurations and features. - - For example, the following example from the ``linux-yocto-rt_4.12`` - kernel recipe adds "netfilter" and "taskstats" features to all BSPs - as well as "virtio" configurations to all QEMU machines. The last two - statements add specific configurations to targeted machine types: - :: - - KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc" - KERNEL_FEATURES_append = "${KERNEL_EXTRA_FEATURES}" - KERNEL_FEATURES_append_qemuall = "cfg/virtio.scc" - KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc" - KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc" - - :term:`KERNEL_FIT_LINK_NAME` - The link name of the kernel flattened image tree (FIT) image. This - variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` - file as follows: - :: - - KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" - - The value of the - ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same - file, has the following value: - :: - - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - - See the :term:`MACHINE` variable for additional - information. - - :term:`KERNEL_FIT_NAME` - The base name of the kernel flattened image tree (FIT) image. This - variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` - file as follows: - :: - - KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" - - The value of the :term:`KERNEL_ARTIFACT_NAME` - variable, which is set in the same file, has the following value: - :: - - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - - :term:`KERNEL_IMAGE_LINK_NAME` - The link name for the kernel image. This variable is set in the - ``meta/classes/kernel-artifact-names.bbclass`` file as follows: - :: - - KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" - - The value of - the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same - file, has the following value: - :: - - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - - See the :term:`MACHINE` variable for additional - information. - - :term:`KERNEL_IMAGE_MAXSIZE` - Specifies the maximum size of the kernel image file in kilobytes. If - ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is - checked against the set value during the - :ref:`ref-tasks-sizecheck` task. The task fails if - the kernel image file is larger than the setting. - - ``KERNEL_IMAGE_MAXSIZE`` is useful for target devices that have a - limited amount of space in which the kernel image must be stored. - - By default, this variable is not set, which means the size of the - kernel image is not checked. - - :term:`KERNEL_IMAGE_NAME` - The base name of the kernel image. This variable is set in the - ``meta/classes/kernel-artifact-names.bbclass`` file as follows: - :: - - KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" - - The value of the - :term:`KERNEL_ARTIFACT_NAME` variable, - which is set in the same file, has the following value: - :: - - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - - :term:`KERNEL_IMAGETYPE` - 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 ``make`` as the target to - build. - - If you want to build an alternate kernel image type, use the - :term:`KERNEL_ALT_IMAGETYPE` variable. - - :term:`KERNEL_MODULE_AUTOLOAD` - Lists kernel modules that need to be auto-loaded during boot. - - .. note:: - - This variable replaces the deprecated :term:`module_autoload` - variable. - - You can use the ``KERNEL_MODULE_AUTOLOAD`` 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). - - Specify it as follows: - :: - - KERNEL_MODULE_AUTOLOAD += "module_name1 module_name2 module_name3" - - Including ``KERNEL_MODULE_AUTOLOAD`` causes the OpenEmbedded build - system to populate the ``/etc/modules-load.d/modname.conf`` 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: - :: - - KERNEL_MODULE_AUTOLOAD += "module_name" - - For information on how to populate the ``modname.conf`` file with - ``modprobe.d`` syntax lines, see the :term:`KERNEL_MODULE_PROBECONF` variable. - - :term:`KERNEL_MODULE_PROBECONF` - Provides a list of modules for which the OpenEmbedded build system - expects to find ``module_conf_``\ modname values that specify - configuration for each of the modules. For information on how to - provide those module configurations, see the - :term:`module_conf_* ` variable. - - :term:`KERNEL_PATH` - The location of the kernel sources. This variable is set to the value - of the :term:`STAGING_KERNEL_DIR` within - the :ref:`module ` class. For information on - how this variable is used, see the - ":ref:`kernel-dev/common:incorporating out-of-tree modules`" - section in the Yocto Project Linux Kernel Development Manual. - - To help maximize compatibility with out-of-tree drivers used to build - modules, the OpenEmbedded build system also recognizes and uses the - :term:`KERNEL_SRC` variable, which is identical to - the ``KERNEL_PATH`` variable. Both variables are common variables - used by external Makefiles to point to the kernel source directory. - - :term:`KERNEL_SRC` - The location of the kernel sources. This variable is set to the value - of the :term:`STAGING_KERNEL_DIR` within - the :ref:`module ` class. For information on - how this variable is used, see the - ":ref:`kernel-dev/common:incorporating out-of-tree modules`" - section in the Yocto Project Linux Kernel Development Manual. - - To help maximize compatibility with out-of-tree drivers used to build - modules, the OpenEmbedded build system also recognizes and uses the - :term:`KERNEL_PATH` variable, which is identical - to the ``KERNEL_SRC`` variable. Both variables are common variables - used by external Makefiles to point to the kernel source directory. - - :term:`KERNEL_VERSION` - Specifies the version of the kernel as extracted from ``version.h`` - or ``utsrelease.h`` 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. - - :term:`KERNELDEPMODDEPEND` - Specifies whether the data referenced through - :term:`PKGDATA_DIR` is needed or not. The - ``KERNELDEPMODDEPEND`` 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 ``KERNELDEPMODDEPEND`` variable in your - ``initramfs`` recipe. Setting the variable there when the data is not - needed avoids a potential dependency loop. - - :term:`KFEATURE_DESCRIPTION` - Provides a short description of a configuration fragment. You use - this variable in the ``.scc`` file that describes a configuration - fragment file. Here is the variable used in a file named ``smp.scc`` - to describe SMP being enabled: - :: - - define KFEATURE_DESCRIPTION "Enable SMP" - - :term:`KMACHINE` - 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 ``core2-32-intel-common`` - goes by a different name in the Linux Yocto kernel. The kernel - understands that machine as ``intel-core2-32``. For cases like these, - the ``KMACHINE`` variable maps the kernel machine name to the - OpenEmbedded build system machine name. - - These mappings between different names occur in the Yocto Linux - Kernel's ``meta`` branch. As an example take a look in the - ``common/recipes-kernel/linux/linux-yocto_3.19.bbappend`` file: - :: - - 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}" - - The ``KMACHINE`` 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". - - :term:`KTYPE` - 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 ":ref:`kernel-dev/advanced:kernel types`" - section in the - Yocto Project Linux Kernel Development Manual for more information on - kernel types. - - You define the ``KTYPE`` variable in the - :ref:`kernel-dev/advanced:bsp descriptions`. The - value you use must match the value used for the - :term:`LINUX_KERNEL_TYPE` value used by the - kernel recipe. - - :term:`LABELS` - Provides a list of targets for automatic configuration. - - See the :ref:`grub-efi ` class for more - information on how this variable is used. - - :term:`LAYERDEPENDS` - Lists the layers, separated by spaces, on which this recipe depends. - Optionally, you can specify a specific layer version for a dependency - by adding it to the end of the layer name. Here is an example: - :: - - LAYERDEPENDS_mylayer = "anotherlayer (=3)" - - In this previous example, - version 3 of "anotherlayer" is compared against - :term:`LAYERVERSION`\ ``_anotherlayer``. - - An error is produced if any dependency is missing or the version - numbers (if specified) do not match exactly. This variable is used in - the ``conf/layer.conf`` file and must be suffixed with the name of - the specific layer (e.g. ``LAYERDEPENDS_mylayer``). - - :term:`LAYERDIR` - When used inside the ``layer.conf`` configuration file, this variable - provides the path of the current layer. This variable is not - available outside of ``layer.conf`` and references are expanded - immediately when parsing of the file completes. - - :term:`LAYERRECOMMENDS` - Lists the layers, separated by spaces, recommended for use with this - layer. - - Optionally, you can specify a specific layer version for a - recommendation by adding the version to the end of the layer name. - Here is an example: - :: - - LAYERRECOMMENDS_mylayer = "anotherlayer (=3)" - - In this previous example, version 3 of "anotherlayer" is compared - against ``LAYERVERSION_anotherlayer``. - - This variable is used in the ``conf/layer.conf`` file and must be - suffixed with the name of the specific layer (e.g. - ``LAYERRECOMMENDS_mylayer``). - - :term:`LAYERSERIES_COMPAT` - Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which - a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable - allows the layer maintainer to indicate which combinations of the - layer and OE-Core can be expected to work. The variable gives the - system a way to detect when a layer has not been tested with new - releases of OE-Core (e.g. the layer is not maintained). - - To specify the OE-Core versions for which a layer is compatible, use - this variable in your layer's ``conf/layer.conf`` configuration file. - For the list, use the Yocto Project - :yocto_wiki:`Release Name ` (e.g. - DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the - layer, use a space-separated list: - :: - - LAYERSERIES_COMPAT_layer_root_name = "DISTRO_NAME_NO_CAP DISTRO_NAME_NO_CAP_MINUS_ONE" - - .. note:: - - Setting ``LAYERSERIES_COMPAT`` is required by the Yocto Project - Compatible version 2 standard. - The OpenEmbedded build system produces a warning if the variable - is not set for any given layer. - - See the ":ref:`dev-manual/common-tasks:creating your own layer`" - section in the Yocto Project Development Tasks Manual. - - :term:`LAYERVERSION` - Optionally specifies the version of a layer as a single number. You - can use this within :term:`LAYERDEPENDS` for - another layer in order to depend on a specific version of the layer. - This variable is used in the ``conf/layer.conf`` file and must be - suffixed with the name of the specific layer (e.g. - ``LAYERVERSION_mylayer``). - - :term:`LD` - The minimal command and arguments used to run the linker. - - :term:`LDFLAGS` - 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. - - Default initialization for ``LDFLAGS`` varies depending on what is - being built: - - - :term:`TARGET_LDFLAGS` when building for the - target - - - :term:`BUILD_LDFLAGS` when building for the - build host (i.e. ``-native``) - - - :term:`BUILDSDK_LDFLAGS` when building for - an SDK (i.e. ``nativesdk-``) - - :term:`LEAD_SONAME` - Specifies the lead (or primary) compiled library file (i.e. ``.so``) - that the :ref:`debian ` class applies its - naming policy to given a recipe that packages multiple libraries. - - This variable works in conjunction with the ``debian`` class. - - :term:`LIC_FILES_CHKSUM` - Checksums of the license text in the recipe source code. - - 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. - - This variable must be defined for all recipes (unless - :term:`LICENSE` is set to "CLOSED"). - - For more information, see the ":ref:`dev-manual/common-tasks:tracking license changes`" - section in the Yocto Project Development Tasks Manual. - - :term:`LICENSE` - The list of source licenses for the recipe. Follow these rules: - - - Do not use spaces within individual license names. - - - Separate license names using \| (pipe) when there is a choice - between licenses. - - - Separate license names using & (ampersand) when multiple licenses - exist that cover different parts of the source. - - - You can use spaces between license names. - - - For standard licenses, use the names of the files in - ``meta/files/common-licenses/`` or the - :term:`SPDXLICENSEMAP` flag names defined in - ``meta/conf/licenses.conf``. - - Here are some examples: - :: - - LICENSE = "LGPLv2.1 | GPLv3" - LICENSE = "MPL-1 & LGPLv2.1" - LICENSE = "GPLv2+" - - 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 ``sysstat``, which presents a single - license. - - 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: - :: - - LICENSE = "GFDL-1.2 & GPLv2" - LICENSE_${PN} = "GPLv2" - LICENSE_${PN}-doc = "GFDL-1.2" - - :term:`LICENSE_CREATE_PACKAGE` - Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded - build system to create an extra package (i.e. - ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add - those packages to the - :term:`RRECOMMENDS`\ ``_${PN}``. - - The ``${PN}-lic`` package installs a directory in - ``/usr/share/licenses`` named ``${PN}``, 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 ``meta/common-licenses`` that match the licenses specified in - the :term:`LICENSE` variable of the recipe metadata - and copies of files marked in - :term:`LIC_FILES_CHKSUM` as containing - license text). - - For related information on providing license text, see the - :term:`COPY_LIC_DIRS` variable, the - :term:`COPY_LIC_MANIFEST` variable, and the - ":ref:`dev-manual/common-tasks:providing license text`" - section in the Yocto Project Development Tasks Manual. - - :term:`LICENSE_FLAGS` - Specifies additional flags for a recipe you must whitelist through - :term:`LICENSE_FLAGS_WHITELIST` in - order to allow the recipe to be built. When providing multiple flags, - separate them with spaces. - - This value is independent of :term:`LICENSE` 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 - ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" - section in the Yocto Project Development Tasks Manual. - - :term:`LICENSE_FLAGS_WHITELIST` - Lists license flags that when specified in - :term:`LICENSE_FLAGS` 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 - ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" - section in the Yocto Project Development Tasks Manual. - - :term:`LICENSE_PATH` - Path to additional licenses used during the build. By default, the - OpenEmbedded build system uses ``COMMON_LICENSE_DIR`` to define the - directory that holds common license text used during the build. The - ``LICENSE_PATH`` variable allows you to extend that location to other - areas that have additional licenses: - :: - - LICENSE_PATH += "path-to-additional-common-licenses" - - :term:`LINUX_KERNEL_TYPE` - 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 ":ref:`kernel-dev/advanced:kernel types`" - section in the - Yocto Project Linux Kernel Development Manual for more information on - kernel types. - - If you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to - "standard". Together with :term:`KMACHINE`, the - ``LINUX_KERNEL_TYPE`` variable defines the search arguments used by - the kernel tools to find the appropriate description within the - kernel :term:`Metadata` with which to build out the sources - and configuration. - - :term:`LINUX_VERSION` - 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. For example, the - ``linux-yocto-3.4.bb`` kernel recipe found in - ``meta/recipes-kernel/linux`` defines the variables as follows: - :: - - LINUX_VERSION ?= "3.4.24" - - The ``LINUX_VERSION`` variable is used to define :term:`PV` - for the recipe: - :: - - PV = "${LINUX_VERSION}+git${SRCPV}" - - :term:`LINUX_VERSION_EXTENSION` - 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: - :: - - LINUX_VERSION_EXTENSION ?= "-yocto-${LINUX_KERNEL_TYPE}" - - Defining this variable essentially sets the Linux kernel - configuration item ``CONFIG_LOCALVERSION``, which is visible through - the ``uname`` command. Here is an example that shows the extension - assuming it was set as previously shown: - :: - - $ uname -r - 3.7.0-rc8-custom - - :term:`LOG_DIR` - Specifies the directory to which the OpenEmbedded build system writes - overall log files. The default directory is ``${TMPDIR}/log``. - - For the directory containing logs specific to each task, see the - :term:`T` variable. - - :term:`MACHINE` - Specifies the target device for which the image is built. You define - ``MACHINE`` in the ``local.conf`` file found in the - :term:`Build Directory`. By default, ``MACHINE`` is set to - "qemux86", which is an x86-based architecture machine to be emulated - using QEMU: - :: - - MACHINE ?= "qemux86" - - The variable corresponds to a machine configuration file of the same - name, through which machine-specific configurations are set. Thus, - when ``MACHINE`` is set to "qemux86" there exists the corresponding - ``qemux86.conf`` machine configuration file, which can be found in - the :term:`Source Directory` in - ``meta/conf/machine``. - - The list of machines supported by the Yocto Project as shipped - include the following: - :: - - MACHINE ?= "qemuarm" - MACHINE ?= "qemuarm64" - MACHINE ?= "qemumips" - MACHINE ?= "qemumips64" - MACHINE ?= "qemuppc" - MACHINE ?= "qemux86" - MACHINE ?= "qemux86-64" - MACHINE ?= "genericx86" - MACHINE ?= "genericx86-64" - MACHINE ?= "beaglebone" - MACHINE ?= "edgerouter" - - The last five are Yocto Project reference hardware - boards, which are provided in the ``meta-yocto-bsp`` layer. - - .. note:: - - Adding additional Board Support Package (BSP) layers to your - configuration adds new possible settings for ``MACHINE``. - - :term:`MACHINE_ARCH` - Specifies the name of the machine-specific architecture. This - variable is set automatically from :term:`MACHINE` or - :term:`TUNE_PKGARCH`. You should not hand-edit - the ``MACHINE_ARCH`` variable. - - :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS` - 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 - ``packagegroup-core-boot``, including the ``core-image-minimal`` - image. - - This variable is similar to the - ``MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` 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. - - As an example, suppose the machine for which you are building - requires ``example-init`` to be run during boot to initialize the - hardware. In this case, you would use the following in the machine's - ``.conf`` configuration file: - :: - - MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init" - - :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` - 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 ``packagegroup-core-boot``, including the ``core-image-minimal`` - image. - - This variable is similar to the ``MACHINE_ESSENTIAL_EXTRA_RDEPENDS`` - 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. - - 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 ``kernel-module-ab123``, you would - use the following in the machine's ``.conf`` configuration file: - :: - - MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123" - - .. note:: - - In this example, the ``kernel-module-ab123`` recipe needs to - explicitly set its :term:`PACKAGES` variable to ensure that BitBake - does not use the kernel recipe's :term:`PACKAGES_DYNAMIC` variable to - satisfy the dependency. - - Some examples of these machine essentials are flash, screen, - keyboard, mouse, or touchscreen drivers (depending on the machine). - - :term:`MACHINE_EXTRA_RDEPENDS` - 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. - - This variable affects all images based on ``packagegroup-base``, - which does not include the ``core-image-minimal`` or - ``core-image-full-cmdline`` images. - - The variable is similar to the ``MACHINE_EXTRA_RRECOMMENDS`` 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. - - 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 ``wifidriver-firmware``, you would use the - following in the ``.conf`` file for the machine: - :: - - MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware" - - :term:`MACHINE_EXTRA_RRECOMMENDS` - 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. - - This variable affects only images based on ``packagegroup-base``, - which does not include the ``core-image-minimal`` or - ``core-image-full-cmdline`` images. - - This variable is similar to the ``MACHINE_EXTRA_RDEPENDS`` 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. - - 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 ``kernel-module-examplewifi``, you would use the - following in the ``.conf`` file for the machine: - :: - - MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi" - - :term:`MACHINE_FEATURES` - Specifies the list of hardware features the - :term:`MACHINE` is capable of supporting. For related - information on enabling features, see the - :term:`DISTRO_FEATURES`, - :term:`COMBINED_FEATURES`, and - :term:`IMAGE_FEATURES` variables. - - For a list of hardware features supported by the Yocto Project as - shipped, see the ":ref:`ref-features-machine`" section. - - :term:`MACHINE_FEATURES_BACKFILL` - 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. 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 ":ref:`ref-features-backfill`" - section for more information. - - :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` - Features from ``MACHINE_FEATURES_BACKFILL`` that should not be - backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See - the ":ref:`ref-features-backfill`" section for more information. - - :term:`MACHINEOVERRIDES` - A colon-separated list of overrides that apply to the current - machine. By default, this list includes the value of - :term:`MACHINE`. - - You can extend ``MACHINEOVERRIDES`` to add extra overrides that - should apply to a machine. For example, all machines emulated in QEMU - (e.g. ``qemuarm``, ``qemux86``, and so forth) include a file named - ``meta/conf/machine/include/qemu.inc`` that prepends the following - override to ``MACHINEOVERRIDES``: - :: - - MACHINEOVERRIDES =. "qemuall:" - - This - override allows variables to be overridden for all machines emulated - in QEMU, like in the following example from the ``connman-conf`` - recipe: - :: - - SRC_URI_append_qemuall = " file://wired.config \ - file://wired-setup \ - " - - The underlying mechanism behind - ``MACHINEOVERRIDES`` is simply that it is included in the default - value of :term:`OVERRIDES`. - - :term:`MAINTAINER` - The email address of the distribution maintainer. - - :term:`MIRRORS` - 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 - :term:`PREMIRRORS`, the upstream source, and then - locations specified by ``MIRRORS`` in that order. - - Assuming your distribution (:term:`DISTRO`) is "poky", - the default value for ``MIRRORS`` is defined in the - ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. - - :term:`MLPREFIX` - Specifies a prefix has been added to :term:`PN` to create a - special version of a recipe or package (i.e. 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 :term:`BPN` variable). - ``MLPREFIX`` gets set when a prefix has been added to ``PN``. - - .. note:: - - The "ML" in ``MLPREFIX`` stands for "MultiLib". This representation is - historical and comes from a time when ``nativesdk`` was a suffix - rather than a prefix on the recipe name. When ``nativesdk`` was turned - into a prefix, it made sense to set ``MLPREFIX`` for it as well. - - To help understand when ``MLPREFIX`` might be needed, consider when - :term:`BBCLASSEXTEND` is used to provide a - ``nativesdk`` version of a recipe in addition to the target version. - If that recipe declares build-time dependencies on tasks in other - recipes by using :term:`DEPENDS`, then a dependency on - "foo" will automatically get rewritten to a dependency on - "nativesdk-foo". However, dependencies like the following will not - get rewritten automatically: - :: - - do_foo[depends] += "recipe:do_foo" - - If you want such a dependency to also get transformed, you can do the - following: - :: - - do_foo[depends] += "${MLPREFIX}recipe:do_foo" - - module_autoload - 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``, for example: - :: - - module_autoload_rfcomm = "rfcomm" - - should now be replaced with: - :: - - KERNEL_MODULE_AUTOLOAD += "rfcomm" - - See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. - - module_conf - Specifies `modprobe.d `_ - syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` - file. - - 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 - :term:`KERNEL_MODULE_AUTOLOAD` - variable. - - Here is the general syntax: - :: - - module_conf_module_name = "modprobe.d-syntax" - - You must use the kernel module name override. - - Run ``man modprobe.d`` in the shell to find out more information on - the exact syntax you want to provide with ``module_conf``. - - Including ``module_conf`` causes the OpenEmbedded build system to - populate the ``/etc/modprobe.d/modname.conf`` file with - ``modprobe.d`` syntax lines. Here is an example that adds the options - ``arg1`` and ``arg2`` to a module named ``mymodule``: - :: - - module_conf_mymodule = "options mymodule arg1=val1 arg2=val2" - - For information on how to specify kernel modules to auto-load on - boot, see the :term:`KERNEL_MODULE_AUTOLOAD` variable. - - :term:`MODULE_TARBALL_DEPLOY` - 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. - - :term:`MODULE_TARBALL_LINK_NAME` - The link name of the kernel module tarball. This variable is set in - the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: - :: - - MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" - - The value - of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the - same file, has the following value: - :: - - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - - See the :term:`MACHINE` variable for additional information. - - :term:`MODULE_TARBALL_NAME` - The base name of the kernel module tarball. This variable is set in - the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: - :: - - MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" - - The value of the :term:`KERNEL_ARTIFACT_NAME` variable, - which is set in the same file, has the following value: - :: - - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - - :term:`MULTIMACH_TARGET_SYS` - Uniquely identifies the type of the target system for which packages - are being built. This variable allows output for different types of - target systems to be put into different subdirectories of the same - output directory. - - The default value of this variable is: - :: - - ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} - - Some classes (e.g. - :ref:`cross-canadian `) modify the - ``MULTIMACH_TARGET_SYS`` value. - - See the :term:`STAMP` variable for an example. See the - :term:`STAGING_DIR_TARGET` variable for more information. - - :term:`NATIVELSBSTRING` - A string identifying the host distribution. Strings consist of the - host distributor ID followed by the release, as reported by the - ``lsb_release`` tool or as read from ``/etc/lsb-release``. 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". - - This variable is used by default to isolate native shared state - packages for different distributions (e.g. to avoid problems with - ``glibc`` version incompatibilities). Additionally, the variable is - checked against - :term:`SANITY_TESTED_DISTROS` if that - variable is set. - - :term:`NM` - The minimal command and arguments to run ``nm``. - - :term:`NO_GENERIC_LICENSE` - Avoids QA errors when you use a non-common, non-CLOSED license in a - recipe. Packages exist, such as the linux-firmware package, with many - licenses that are not in any way common. Also, new licenses are added - occasionally to avoid introducing a lot of common license files, - which are only applicable to a specific package. - ``NO_GENERIC_LICENSE`` is used to allow copying a license that does - not exist in common licenses. - - The following example shows how to add ``NO_GENERIC_LICENSE`` to a - recipe: - :: - - NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source" - - The following is an example that - uses the ``LICENSE.Abilis.txt`` file as the license from the fetched - source: - :: - - NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" - - :term:`NO_RECOMMENDATIONS` - Prevents installation of all "recommended-only" packages. - Recommended-only packages are packages installed only through the - :term:`RRECOMMENDS` variable). Setting the - ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on: :: - - NO_RECOMMENDATIONS = "1" - - You can set this variable globally in your ``local.conf`` file or you - can attach it to a specific image recipe by using the recipe name - override: :: - - NO_RECOMMENDATIONS_pn-target_image = "1" - - 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 :term:`RDEPENDS` - 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 :term:`IMAGE_INSTALL` variable. - - Support for this variable exists only when using the IPK and RPM - packaging backend. Support does not exist for DEB. - - See the :term:`BAD_RECOMMENDATIONS` and - the :term:`PACKAGE_EXCLUDE` variables for - related information. - - :term:`NOAUTOPACKAGEDEBUG` - Disables auto package from splitting ``.debug`` files. If a recipe - requires ``FILES_${PN}-dbg`` to be set manually, the - ``NOAUTOPACKAGEDEBUG`` can be defined allowing you to define the - content of the debug package. For example: - :: - - NOAUTOPACKAGEDEBUG = "1" - FILES_${PN}-dev = "${includedir}/${QT_DIR_NAME}/Qt/*" - FILES_${PN}-dbg = "/usr/src/debug/" - FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch" - - :term:`OBJCOPY` - The minimal command and arguments to run ``objcopy``. - - :term:`OBJDUMP` - The minimal command and arguments to run ``objdump``. - - :term:`OE_BINCONFIG_EXTRA_MANGLE` - When inheriting the :ref:`binconfig ` 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 - ``sysroots/`` directory so that all builds that use the script will - use the correct directories for the cross compiling layout. - - See the ``meta/classes/binconfig.bbclass`` in the - :term:`Source Directory` for details on how this class - applies these additional sed command arguments. For general - information on the ``binconfig`` class, see the - ":ref:`binconfig.bbclass `" section. - - :term:`OE_IMPORTS` - An internal variable used to tell the OpenEmbedded build system what - Python modules to import for every Python function run by the system. - - .. note:: - - Do not set this variable. It is for internal use only. - - :term:`OE_INIT_ENV_SCRIPT` - 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". - - If you use a custom script to set up your build environment, set the - ``OE_INIT_ENV_SCRIPT`` variable to its name. - - :term:`OE_TERMINAL` - Controls how the OpenEmbedded build system spawns interactive - terminals on the host development system (e.g. using the BitBake - command with the ``-c devshell`` command-line option). For more - information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in - the Yocto Project Development Tasks Manual. - - You can use the following values for the ``OE_TERMINAL`` variable: - - - auto - - gnome - - xfce - - rxvt - - screen - - konsole - - none - - :term:`OEROOT` - The directory from which the top-level build environment setup script - is sourced. The Yocto Project provides a top-level build environment - setup script: :ref:`structure-core-script`. When you run this - script, the ``OEROOT`` variable resolves to the directory that - contains the script. - - For additional information on how this variable is used, see the - initialization script. - - :term:`OLDEST_KERNEL` - 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 (``glibc``). - - The default for this variable comes from the - ``meta/conf/bitbake.conf`` configuration file. You can override this - default by setting the variable in a custom distribution - configuration file. - - :term:`OVERRIDES` - A colon-separated list of overrides that currently apply. Overrides - are a BitBake mechanism that allows variables to be selectively - overridden at the end of parsing. The set of overrides in - ``OVERRIDES`` represents the "state" during building, which includes - the current recipe being built, the machine for which it is being - built, and so forth. - - As an example, if the string "an-override" appears as an element in - the colon-separated list in ``OVERRIDES``, then the following - assignment will override ``FOO`` with the value "overridden" at the - end of parsing: - :: - - FOO_an-override = "overridden" - - See the - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" - section in the BitBake User Manual for more information on the - overrides mechanism. - - The default value of ``OVERRIDES`` includes the values of the - :term:`CLASSOVERRIDE`, - :term:`MACHINEOVERRIDES`, and - :term:`DISTROOVERRIDES` variables. Another - important override included by default is ``pn-${PN}``. This override - allows variables to be set for a single recipe within configuration - (``.conf``) files. Here is an example: - :: - - FOO_pn-myrecipe = "myrecipe-specific value" - - .. note:: - - An easy way to see what overrides apply is to search for ``OVERRIDES`` - in the output of the ``bitbake -e`` command. See the - ":ref:`dev-manual/common-tasks:viewing variable values`" section in the Yocto - Project Development Tasks Manual for more information. - - :term:`P` - The recipe name and version. ``P`` is comprised of the following: - :: - - ${PN}-${PV} - - :term:`PACKAGE_ADD_METADATA` - This variable defines additional metdata to add to packages. - - You may find you need to inject additional metadata into packages. - This variable allows you to do that by setting the injected data as - the value. Multiple fields can be added by splitting the content with - the literal separator "\n". - - The suffixes '_IPK', '_DEB', or '_RPM' can be applied to the variable - to do package type specific settings. It can also be made package - specific by using the package name as a suffix. - - You can find out more about applying this variable in the - ":ref:`dev-manual/common-tasks:adding custom metadata to packages`" - section in the Yocto Project Development Tasks Manual. - - :term:`PACKAGE_ARCH` - The architecture of the resulting package or packages. - - By default, the value of this variable is set to - :term:`TUNE_PKGARCH` when building for the - target, :term:`BUILD_ARCH` when building for the - build host, and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building for the - SDK. - - .. note:: - - See :term:`SDK_ARCH` for more information. - - However, if your recipe's output packages are built specific to the - target machine rather than generally for the architecture of the - machine, you should set ``PACKAGE_ARCH`` to the value of - :term:`MACHINE_ARCH` in the recipe as follows: - :: - - PACKAGE_ARCH = "${MACHINE_ARCH}" - - :term:`PACKAGE_ARCHS` - 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 ``PACKAGE_ARCHS`` is "all any - noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}". - - :term:`PACKAGE_BEFORE_PN` - Enables easily adding packages to ``PACKAGES`` before ``${PN}`` so - that those added packages can pick up files that would normally be - included in the default package. - - :term:`PACKAGE_CLASSES` - This variable, which is set in the ``local.conf`` configuration file - found in the ``conf`` folder of the - :term:`Build Directory`, specifies the package manager the - OpenEmbedded build system uses when packaging data. - - You can provide one or more of the following arguments for the - variable: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk - package_tar" - - .. note:: - - While it is a legal option, the ``package_tar`` - class has limited functionality due to no support for package - dependencies by that backend. Therefore, it is recommended that - you do not use it. - - 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 ``local.conf`` file: - :: - - PACKAGE_CLASSES ?= "package_ipk" - - The OpenEmbedded build system uses - the IPK package manager to create your image or SDK. - - For information on packaging and build performance effects as a - result of the package manager in use, see the - ":ref:`package.bbclass `" section. - - :term:`PACKAGE_DEBUG_SPLIT_STYLE` - Determines how to split up the binary and debug information when - creating ``*-dbg`` packages to be used with the GNU Project Debugger - (GDB). - - With the ``PACKAGE_DEBUG_SPLIT_STYLE`` variable, you can control - where debug information, which can include or exclude source files, - is stored: - - - ".debug": Debug symbol files are placed next to the binary in a - ``.debug`` directory on the target. For example, if a binary is - installed into ``/bin``, the corresponding debug symbol files are - installed in ``/bin/.debug``. Source files are placed in - ``/usr/src/debug``. - - - "debug-file-directory": Debug symbol files are placed under - ``/usr/lib/debug`` on the target, and separated by the path from - where the binary is installed. For example, if a binary is - installed in ``/bin``, the corresponding debug symbols are - installed in ``/usr/lib/debug/bin``. Source files are placed in - ``/usr/src/debug``. - - - "debug-without-src": The same behavior as ".debug" previously - described with the exception that no source files are installed. - - - "debug-with-srcpkg": The same behavior as ".debug" previously - described with the exception that all source files are placed in a - separate ``*-src`` pkg. This is the default behavior. - - You can find out more about debugging using GDB by reading the - ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section - in the Yocto Project Development Tasks Manual. - - :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` - Prevents specific packages from being installed when you are - installing complementary packages. - - You might find that you want to prevent installing certain packages - when you are installing complementary packages. For example, if you - are using :term:`IMAGE_FEATURES` to install - ``dev-pkgs``, you might not want to install all packages from a - particular multilib. If you find yourself in this situation, you can - use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular - expressions to match the packages you want to exclude. - - :term:`PACKAGE_EXCLUDE` - Lists packages that should not be installed into an image. For - example: - :: - - PACKAGE_EXCLUDE = "package_name package_name package_name ..." - - You can set this variable globally in your ``local.conf`` file or you - can attach it to a specific image recipe by using the recipe name - override: - :: - - PACKAGE_EXCLUDE_pn-target_image = "package_name" - - 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 - :term:`RDEPENDS` 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. - - Support for this variable exists only when using the IPK and RPM - packaging backend. Support does not exist for DEB. - - See the :term:`NO_RECOMMENDATIONS` and the - :term:`BAD_RECOMMENDATIONS` variables for - related information. - - :term:`PACKAGE_EXTRA_ARCHS` - 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. - - :term:`PACKAGE_FEED_ARCHS` - Optionally specifies the package architectures used as part of the - package feed URIs during the build. When used, the - ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed - URI, which is constructed using the - :term:`PACKAGE_FEED_URIS` and - :term:`PACKAGE_FEED_BASE_PATHS` - variables. - - .. note:: - - You can use the ``PACKAGE_FEED_ARCHS`` - variable to whitelist specific package architectures. If you do - not need to whitelist specific architectures, which is a common - case, you can omit this variable. Omitting the variable results in - all available architectures for the current machine being included - into remote package feeds. - - Consider the following example where the ``PACKAGE_FEED_URIS``, - ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are - defined in your ``local.conf`` file: - :: - - 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" - - Given these settings, the resulting package feeds are as follows: - - .. code-block:: none - - 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 - - :term:`PACKAGE_FEED_BASE_PATHS` - Specifies the base path used when constructing package feed URIs. The - ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a - package feed URI used by the OpenEmbedded build system. The base path - lies between the :term:`PACKAGE_FEED_URIS` - and :term:`PACKAGE_FEED_ARCHS` variables. - - Consider the following example where the ``PACKAGE_FEED_URIS``, - ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are - defined in your ``local.conf`` file: - :: - - 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" - - Given these settings, the resulting package feeds are as follows: - - .. code-block:: none - - 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 - - :term:`PACKAGE_FEED_URIS` - Specifies the front portion of the package feed URI used by the - OpenEmbedded build system. Each final package feed URI is comprised - of ``PACKAGE_FEED_URIS``, - :term:`PACKAGE_FEED_BASE_PATHS`, and - :term:`PACKAGE_FEED_ARCHS` variables. - - Consider the following example where the ``PACKAGE_FEED_URIS``, - ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are - defined in your ``local.conf`` file: - :: - - 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" - - Given these settings, the resulting package feeds are as follows: - - .. code-block:: none - - 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 - - :term:`PACKAGE_INSTALL` - The final list of packages passed to the package manager for - installation into the image. - - Because the package manager controls actual installation of all - packages, the list of packages passed using ``PACKAGE_INSTALL`` 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 - :term:`IMAGE_INSTALL` variable to specify - packages for installation. The exception to this is when working with - the :ref:`core-image-minimal-initramfs ` - image. When working with an initial RAM filesystem (initramfs) image, - use the ``PACKAGE_INSTALL`` variable. For information on creating an - initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section - in the Yocto Project Development Tasks Manual. - - :term:`PACKAGE_INSTALL_ATTEMPTONLY` - 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. - - :term:`PACKAGE_PREPROCESS_FUNCS` - Specifies a list of functions run to pre-process the - :term:`PKGD` directory prior to splitting the files out - to individual packages. - - :term:`PACKAGE_WRITE_DEPS` - Specifies a list of dependencies for post-installation and - pre-installation scripts on native/cross tools. If your - post-installation or pre-installation script can execute at rootfs - creation time rather than on the target but depends on a native tool - in order to execute, you need to list the tools in - ``PACKAGE_WRITE_DEPS``. - - For information on running post-installation scripts, see the - ":ref:`dev-manual/common-tasks:post-installation scripts`" - section in the Yocto Project Development Tasks Manual. - - :term:`PACKAGECONFIG` - This variable provides a means of enabling or disabling features of a - recipe on a per-recipe basis. ``PACKAGECONFIG`` blocks are defined in - recipes when you specify features and then arguments that define - feature behaviors. Here is the basic block structure (broken over - multiple lines for readability): - :: - - PACKAGECONFIG ??= "f1 f2 f3 ..." - PACKAGECONFIG[f1] = "\ - --with-f1, \ - --without-f1, \ - build-deps-for-f1, \ - runtime-deps-for-f1, \ - runtime-recommends-for-f1, \ - packageconfig-conflicts-for-f1" - PACKAGECONFIG[f2] = "\ - ... and so on and so on ... - - The ``PACKAGECONFIG`` 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 six - 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: - - 1. Extra arguments that should be added to the configure script - argument list (:term:`EXTRA_OECONF` or - :term:`PACKAGECONFIG_CONFARGS`) if - the feature is enabled. - - 2. Extra arguments that should be added to ``EXTRA_OECONF`` or - ``PACKAGECONFIG_CONFARGS`` if the feature is disabled. - - 3. Additional build dependencies (:term:`DEPENDS`) - that should be added if the feature is enabled. - - 4. Additional runtime dependencies (:term:`RDEPENDS`) - that should be added if the feature is enabled. - - 5. Additional runtime recommendations - (:term:`RRECOMMENDS`) that should be added if - the feature is enabled. - - 6. Any conflicting (that is, mutually exclusive) ``PACKAGECONFIG`` - settings for this feature. - - Consider the following ``PACKAGECONFIG`` block taken from the - ``librsvg`` recipe. In this example the feature is ``gtk``, which has - three arguments that determine the feature's behavior. - :: - - PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3" - - The - ``--with-gtk3`` and ``gtk+3`` arguments apply only if the feature is - enabled. In this case, ``--with-gtk3`` is added to the configure - script argument list and ``gtk+3`` is added to ``DEPENDS``. On the - other hand, if the feature is disabled say through a ``.bbappend`` - file in another layer, then the second argument ``--without-gtk3`` is - added to the configure script instead. - - The basic ``PACKAGECONFIG`` 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. - - If you want to change an existing ``PACKAGECONFIG`` block, you can do - so one of two ways: - - - *Append file:* Create an append file named - recipename\ ``.bbappend`` in your layer and override the value of - ``PACKAGECONFIG``. You can either completely override the - variable: - :: - - PACKAGECONFIG = "f4 f5" - - Or, you can just append the variable: - :: - - PACKAGECONFIG_append = " f4" - - - *Configuration file:* This method is identical to changing the - block through an append file except you edit your ``local.conf`` - or ``mydistro.conf`` file. As with append files previously - described, you can either completely override the variable: - :: - - PACKAGECONFIG_pn-recipename = "f4 f5" - - Or, you can just amend the variable: - :: - - PACKAGECONFIG_append_pn-recipename = " f4" - - :term:`PACKAGECONFIG_CONFARGS` - A space-separated list of configuration options generated from the - :term:`PACKAGECONFIG` setting. - - Classes such as :ref:`autotools ` and - :ref:`cmake ` use ``PACKAGECONFIG_CONFARGS`` to - pass ``PACKAGECONFIG`` options to ``configure`` and ``cmake``, - respectively. If you are using ``PACKAGECONFIG`` but not a class that - handles the ``do_configure`` task, then you need to use - ``PACKAGECONFIG_CONFARGS`` appropriately. - - :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY` - For recipes inheriting the - :ref:`packagegroup ` class, setting - ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the - normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth) - should not be automatically created by the ``packagegroup`` recipe, - which is the default behavior. - - :term:`PACKAGES` - The list of packages the recipe creates. The default value is the - following: - :: - - ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} - - During packaging, the :ref:`ref-tasks-package` task - goes through ``PACKAGES`` and uses the :term:`FILES` - variable corresponding to each package to assign files to the - package. If a file matches the ``FILES`` variable for more than one - package in ``PACKAGES``, it will be assigned to the earliest - (leftmost) package. - - Packages in the variable's list that are empty (i.e. where none of - the patterns in ``FILES_``\ pkg match any files installed by the - :ref:`ref-tasks-install` task) are not generated, - unless generation is forced through the - :term:`ALLOW_EMPTY` variable. - - :term:`PACKAGES_DYNAMIC` - A promise that your recipe satisfies runtime dependencies for - optional modules that are found in other recipes. - ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it - only states that they should be satisfied. For example, if a hard, - runtime dependency (:term:`RDEPENDS`) of another - package is satisfied at build time through the ``PACKAGES_DYNAMIC`` - 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 - :ref:`ref-tasks-rootfs` task. - - 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 :term:`RRECOMMENDS` - (a soft runtime dependency) instead of ``RDEPENDS``. - - For an example of how to use the ``PACKAGES_DYNAMIC`` variable when - you are splitting packages, see the - ":ref:`dev-manual/common-tasks:handling optional module packaging`" - section in the Yocto Project Development Tasks Manual. - - :term:`PACKAGESPLITFUNCS` - 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 ``populate_packages`` function in order to - perform additional package splitting. In either case, the function - should set :term:`PACKAGES`, - :term:`FILES`, :term:`RDEPENDS` and - other packaging variables appropriately in order to perform the - desired splitting. - - :term:`PARALLEL_MAKE` - Extra options passed to the ``make`` command during the - :ref:`ref-tasks-compile` task in order to specify - parallel compilation on the local build host. This variable is - usually in the form "-j x", where x represents the maximum number of - parallel threads ``make`` can run. - - .. note:: - - In order for ``PARALLEL_MAKE`` to be effective, ``make`` must be - called with ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure - this is to use the ``oe_runmake`` function. - - 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 ``do_compile`` task that result in race conditions, you can clear - the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For - information on addressing race conditions, see the - ":ref:`dev-manual/common-tasks:debugging parallel make races`" - section in the Yocto Project Development Tasks Manual. - - 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 ``PARALLEL_MAKE`` variable is - not set higher than "-j 20". - - For more information on speeding up builds, see the - ":ref:`dev-manual/common-tasks:speeding up a build`" - section in the Yocto Project Development Tasks Manual. - - :term:`PARALLEL_MAKEINST` - Extra options passed to the ``make install`` command during the - :ref:`ref-tasks-install` task in order to specify - parallel installation. This variable defaults to the value of - :term:`PARALLEL_MAKE`. - - .. note:: - - In order for ``PARALLEL_MAKEINST`` to be effective, ``make`` must - be called with - ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy - way to ensure this is to use the ``oe_runmake`` function. - - If the software being built experiences dependency issues during - the ``do_install`` task that result in race conditions, you can - clear the ``PARALLEL_MAKEINST`` variable within the recipe as a - workaround. For information on addressing race conditions, see the - ":ref:`dev-manual/common-tasks:debugging parallel make races`" - section in the Yocto Project Development Tasks Manual. - - :term:`PATCHRESOLVE` - Determines the action to take when a patch fails. You can set this - variable to one of two values: "noop" and "user". - - 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. - - Set this variable in your ``local.conf`` file. - - :term:`PATCHTOOL` - Specifies the utility used to apply patches for a recipe during the - :ref:`ref-tasks-patch` 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". - - If you wish to use an alternative patching tool, set the variable in - the recipe using one of the following: - :: - - PATCHTOOL = "patch" - PATCHTOOL = "quilt" - PATCHTOOL = "git" - - :term:`PE` - 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. - - ``PE`` is the default value of the :term:`PKGE` variable. - - :term:`PF` - Specifies the recipe or package name and includes all version and - revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and - ``bash-4.2-r1/``). This variable is comprised of the following: - ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} - - :term:`PIXBUF_PACKAGES` - When inheriting the :ref:`pixbufcache ` - class, this variable identifies packages that contain the pixbuf - loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` - class assumes that the loaders are in the recipe's main package (i.e. - ``${``\ :term:`PN`\ ``}``). Use this variable if the - loaders you need are in a package other than that main package. - - :term:`PKG` - The name of the resulting package created by the OpenEmbedded build - system. - - .. note:: - - When using the ``PKG`` variable, you must use a package name override. - - For example, when the :ref:`debian ` class - renames the output package, it does so by setting - ``PKG_packagename``. - - :term:`PKG_CONFIG_PATH` - The path to ``pkg-config`` files for the current build context. - ``pkg-config`` reads this variable from the environment. - - :term:`PKGD` - Points to the destination directory for files to be packaged before - they are split into individual packages. This directory defaults to - the following: - :: - - ${WORKDIR}/package - - Do not change this default. - - :term:`PKGDATA_DIR` - Points to a shared, global-state directory that holds data generated - during the packaging process. During the packaging process, the - :ref:`ref-tasks-packagedata` task packages data - for each recipe and installs it into this temporary, shared area. - This directory defaults to the following, which you should not - change: - :: - - ${STAGING_DIR_HOST}/pkgdata - - For examples of how this data is used, see the - ":ref:`overview-manual/concepts:automatically added runtime dependencies`" - section in the Yocto Project Overview and Concepts Manual and the - ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" - section in the Yocto Project Development Tasks Manual. For more - information on the shared, global-state directory, see - :term:`STAGING_DIR_HOST`. - - :term:`PKGDEST` - Points to the parent directory for files to be packaged after they - have been split into individual packages. This directory defaults to - the following: - :: - - ${WORKDIR}/packages-split - - Under this directory, the build system creates directories for each - package specified in :term:`PACKAGES`. Do not change - this default. - - :term:`PKGDESTWORK` - Points to a temporary work area where the - :ref:`ref-tasks-package` task saves package metadata. - The ``PKGDESTWORK`` location defaults to the following: - :: - - ${WORKDIR}/pkgdata - - Do not change this default. - - The :ref:`ref-tasks-packagedata` task copies the - package metadata from ``PKGDESTWORK`` to - :term:`PKGDATA_DIR` to make it available globally. - - :term:`PKGE` - The epoch of the package(s) built by the recipe. By default, ``PKGE`` - is set to :term:`PE`. - - :term:`PKGR` - The revision of the package(s) built by the recipe. By default, - ``PKGR`` is set to :term:`PR`. - - :term:`PKGV` - The version of the package(s) built by the recipe. By default, - ``PKGV`` is set to :term:`PV`. - - :term:`PN` - This variable can have two separate functions depending on the - context: a recipe name or a resulting package name. - - ``PN`` 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 ``expat_2.0.1.bb``, then the default value of ``PN`` - will be "expat". - - The variable refers to a package name in the context of a file - created or produced by the OpenEmbedded build system. - - If applicable, the ``PN`` variable also contains any special suffix - or prefix. For example, using ``bash`` to build packages for the - native machine, ``PN`` is ``bash-native``. Using ``bash`` to build - packages for the target and for Multilib, ``PN`` would be ``bash`` - and ``lib64-bash``, respectively. - - :term:`PNBLACKLIST` - Lists recipes you do not want the OpenEmbedded build system to build. - This variable works in conjunction with the - :ref:`blacklist ` class, which is inherited - globally. - - To prevent a recipe from being built, use the ``PNBLACKLIST`` - variable in your ``local.conf`` file. Here is an example that - prevents ``myrecipe`` from being built: - :: - - PNBLACKLIST[myrecipe] = "Not supported by our organization." - - :term:`POPULATE_SDK_POST_HOST_COMMAND` - 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: - :: - - POPULATE_SDK_POST_HOST_COMMAND += "function; ... " - - If you need to pass the SDK path to a command within a function, you - can use ``${SDK_DIR}``, which points to the parent directory used by - the OpenEmbedded build system when creating SDK output. See the - :term:`SDK_DIR` variable for more information. - - :term:`POPULATE_SDK_POST_TARGET_COMMAND` - 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: - :: - - POPULATE_SDK_POST_TARGET_COMMAND += "function; ... " - - If you need to pass the SDK path to a command within a function, you - can use ``${SDK_DIR}``, which points to the parent directory used by - the OpenEmbedded build system when creating SDK output. See the - :term:`SDK_DIR` variable for more information. - - :term:`PR` - The revision of the recipe. The default value for this variable is - "r0". Subsequent revisions of the recipe conventionally have the - values "r1", "r2", and so forth. When :term:`PV` increases, - ``PR`` is conventionally reset to "r0". - - .. note:: - - The OpenEmbedded build system does not need the aid of ``PR`` - to know when to rebuild a recipe. The build system uses the task - :ref:`input checksums ` along with the - :ref:`stamp ` and - :ref:`overview-manual/concepts:shared state cache` - mechanisms. - - The ``PR`` variable primarily becomes significant when a package - manager dynamically installs packages on an already built image. In - this case, ``PR``, which is the default value of - :term:`PKGR`, helps the package manager distinguish which - package is the most recent one in cases where many packages have the - same ``PV`` (i.e. ``PKGV``). A component having many packages with - the same ``PV`` usually means that the packages all install the same - upstream version, but with later (``PR``) version packages including - packaging fixes. - - .. note:: - - ``PR`` does not need to be increased for changes that do not change the - package contents or metadata. - - Because manually managing ``PR`` can be cumbersome and error-prone, - an automated solution exists. See the - ":ref:`dev-manual/common-tasks:working with a pr service`" section - in the Yocto Project Development Tasks Manual for more information. - - :term:`PREFERRED_PROVIDER` - If multiple recipes provide the same item, this variable determines - which recipe is preferred and thus provides the item (i.e. the - preferred provider). You should always suffix this variable with the - name of the provided item. And, you should define the variable using - the preferred recipe's name (:term:`PN`). Here is a common - example: - :: - - PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" - - In the previous example, multiple recipes are providing "virtual/kernel". - The ``PREFERRED_PROVIDER`` variable is set with the name (``PN``) of - the recipe you prefer to provide "virtual/kernel". - - Following are more examples: - :: - - PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" - PREFERRED_PROVIDER_virtual/libgl ?= "mesa" - - For more - information, see the ":ref:`dev-manual/common-tasks:using virtual providers`" - section in the Yocto Project Development Tasks Manual. - - .. note:: - - If you use a ``virtual/\*`` item with ``PREFERRED_PROVIDER``, then any - recipe that :term:`PROVIDES` that item but is not selected (defined) - by ``PREFERRED_PROVIDER`` is prevented from building, which is usually - desirable since this mechanism is designed to select between mutually - exclusive alternative providers. - - :term:`PREFERRED_VERSION` - If multiple versions of recipes exist, this variable determines which - version is given preference. You must always suffix the variable with - the :term:`PN` you want to select, and you should set the - :term:`PV` accordingly for precedence. - - The ``PREFERRED_VERSION`` variable supports limited wildcard use - through the "``%``" character. You can use the character to match any - number of characters, which can be useful when specifying versions - that contain long revision numbers that potentially change. Here are - two examples: - :: - - PREFERRED_VERSION_python = "3.4.0" - PREFERRED_VERSION_linux-yocto = "5.0%" - - .. note:: - - The use of the "%" character is limited in that it only works at the end of the - string. You cannot use the wildcard character in any other - location of the string. - - The specified version is matched against :term:`PV`, which - does not necessarily match the version part of the recipe's filename. - For example, consider two recipes ``foo_1.2.bb`` and ``foo_git.bb`` - where ``foo_git.bb`` contains the following assignment: - :: - - PV = "1.1+git${SRCPV}" - - In this case, the correct way to select - ``foo_git.bb`` is by using an assignment such as the following: - :: - - PREFERRED_VERSION_foo = "1.1+git%" - - Compare that previous example - against the following incorrect example, which does not work: - :: - - PREFERRED_VERSION_foo = "git" - - Sometimes the ``PREFERRED_VERSION`` variable can be set by - configuration files in a way that is hard to change. You can use - :term:`OVERRIDES` to set a machine-specific - override. Here is an example: - :: - - PREFERRED_VERSION_linux-yocto_qemux86 = "5.0%" - - Although not recommended, worst case, you can also use the - "forcevariable" override, which is the strongest override possible. - Here is an example: - :: - - PREFERRED_VERSION_linux-yocto_forcevariable = "5.0%" - - .. note:: - - The ``\_forcevariable`` override is not handled specially. This override - only works because the default value of ``OVERRIDES`` includes "forcevariable". - - :term:`PREMIRRORS` - 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 ``PREMIRRORS``, the upstream - source, and then locations specified by - :term:`MIRRORS` in that order. - - Assuming your distribution (:term:`DISTRO`) is "poky", - the default value for ``PREMIRRORS`` is defined in the - ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. - - Typically, you could add a specific server for the build system to - attempt before any others by adding something like the following to - the ``local.conf`` configuration file in the - :term:`Build Directory`: - :: - - 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" - - These changes cause the - build system to intercept Git, FTP, HTTP, and HTTPS requests and - direct them to the ``http://`` sources mirror. You can use - ``file://`` URLs to point to local directories or network shares as - well. - - :term:`PRIORITY` - Indicates the importance of a package. - - ``PRIORITY`` 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, ``PRIORITY`` is not - normally set within recipes. - - You can set ``PRIORITY`` to "required", "standard", "extra", and - "optional", which is the default. - - :term:`PRIVATE_LIBS` - 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. - - Libraries specified in this variable should be specified by their - file name. For example, from the Firefox recipe in meta-browser: - :: - - PRIVATE_LIBS = "libmozjs.so \ - libxpcom.so \ - libnspr4.so \ - libxul.so \ - libmozalloc.so \ - libplc4.so \ - libplds4.so" - - For more information, see the - ":ref:`overview-manual/concepts:automatically added runtime dependencies`" - section in the Yocto Project Overview and Concepts Manual. - - :term:`PROVIDES` - A list of aliases by which a particular recipe can be known. By - default, a recipe's own ``PN`` is implicitly already in its - ``PROVIDES`` list and therefore does not need to mention that it - provides itself. If a recipe uses ``PROVIDES``, the additional - aliases are synonyms for the recipe and can be useful for satisfying - dependencies of other recipes during the build as specified by - ``DEPENDS``. - - Consider the following example ``PROVIDES`` statement from the recipe - file ``eudev_3.2.9.bb``: - :: - - PROVIDES = "udev" - - The ``PROVIDES`` statement - results in the "eudev" recipe also being available as simply "udev". - - .. note:: - - Given that a recipe's own recipe name is already implicitly in its - own PROVIDES list, it is unnecessary to add aliases with the "+=" operator; - using a simple assignment will be sufficient. In other words, - while you could write: - :: - - PROVIDES += "udev" - - - in the above, the "+=" is overkill and unnecessary. - - In addition to providing recipes under alternate names, the - ``PROVIDES`` mechanism is also used to implement virtual targets. A - virtual target is a name that corresponds to some particular - functionality (e.g. a Linux kernel). Recipes that provide the - functionality in question list the virtual target in ``PROVIDES``. - Recipes that depend on the functionality in question can include the - virtual target in ``DEPENDS`` to leave the choice of provider open. - - Conventionally, virtual targets have names on the form - "virtual/function" (e.g. "virtual/kernel"). The slash is simply part - of the name and has no syntactical significance. - - The :term:`PREFERRED_PROVIDER` variable is - used to select which particular recipe provides a virtual target. - - .. note:: - - A corresponding mechanism for virtual runtime dependencies - (packages) exists. However, the mechanism does not depend on any - special functionality beyond ordinary variable assignments. For - example, ``VIRTUAL-RUNTIME_dev_manager`` refers to the package of - the component that manages the ``/dev`` directory. - - Setting the "preferred provider" for runtime dependencies is as - simple as using the following assignment in a configuration file: - :: - - VIRTUAL-RUNTIME_dev_manager = "udev" - - - :term:`PRSERV_HOST` - The network based :term:`PR` service host and port. - - The ``conf/local.conf.sample.extended`` configuration file in the - :term:`Source Directory` shows how the - ``PRSERV_HOST`` variable is set: - :: - - PRSERV_HOST = "localhost:0" - - You must - set the variable if you want to automatically start a local :ref:`PR - service `. You can - set ``PRSERV_HOST`` to other values to use a remote PR service. - - - :term:`PSEUDO_IGNORE_PATHS` - A comma-separated (without spaces) list of path prefixes that should be ignored - by pseudo when monitoring and recording file operations, in order to avoid - problems with files being written to outside of the pseudo context and - reduce pseudo's overhead. A path is ignored if it matches any prefix in the list - and can include partial directory (or file) names. - - - :term:`PTEST_ENABLED` - Specifies whether or not :ref:`Package - Test ` (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) :term:`DISTRO_FEATURES`. - - :term:`PV` - The version of the recipe. The version is normally extracted from the - recipe filename. For example, if the recipe is named - ``expat_2.0.1.bb``, then the default value of ``PV`` will be "2.0.1". - ``PV`` 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). - - ``PV`` is the default value of the :term:`PKGV` variable. - - :term:`PYTHON_ABI` - When used by recipes that inherit the - :ref:`distutils3 `, - :ref:`setuptools3 `, - :ref:`distutils `, or - :ref:`setuptools ` 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. - - The OpenEmbedded build system uses the ABI to construct directory - names used when installing the Python headers and libraries in - sysroot (e.g. ``.../python3.3m/...``). - - Recipes that inherit the ``distutils`` class during cross-builds also - use this variable to locate the headers and libraries of the - appropriate Python that the extension is targeting. - - :term:`PYTHON_PN` - When used by recipes that inherit the - `distutils3 `, - :ref:`setuptools3 `, - :ref:`distutils `, or - :ref:`setuptools ` classes, specifies the - major Python version being built. For Python 3.x, ``PYTHON_PN`` would - be "python3". You do not have to set this variable as the - OpenEmbedded build system automatically sets it for you. - - The variable allows recipes to use common infrastructure such as the - following: - :: - - DEPENDS += "${PYTHON_PN}-native" - - In the previous example, - the version of the dependency is ``PYTHON_PN``. - - :term:`RANLIB` - The minimal command and arguments to run ``ranlib``. - - :term:`RCONFLICTS` - The list of packages that conflict with packages. Note that packages - will not be installed if conflicting packages are not first removed. - - Like all package-controlling variables, you must always use them in - conjunction with a package name override. Here is an example: - :: - - RCONFLICTS_${PN} = "another_conflicting_package_name" - - 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 - ``RCONFLICTS`` variable: - :: - - RCONFLICTS_${PN} = "package (operator version)" - - For ``operator``, you can specify the following: - - - = - - < - - > - - <= - - >= - - For example, the following sets up a dependency on version 1.2 or - greater of the package ``foo``: - :: - - RCONFLICTS_${PN} = "foo (>= 1.2)" - - :term:`RDEPENDS` - Lists runtime dependencies of a package. These dependencies are other - packages that must be installed in order for the package to function - correctly. As an example, the following assignment declares that the - package ``foo`` needs the packages ``bar`` and ``baz`` to be - installed: - :: - - RDEPENDS_foo = "bar baz" - - The most common types of package - runtime dependencies are automatically detected and added. Therefore, - most recipes do not need to set ``RDEPENDS``. For more information, - see the - ":ref:`overview-manual/concepts:automatically added runtime dependencies`" - section in the Yocto Project Overview and Concepts Manual. - - The practical effect of the above ``RDEPENDS`` assignment is that - ``bar`` and ``baz`` will be declared as dependencies inside the - package ``foo`` when it is written out by one of the - :ref:`do_package_write_\* ` tasks. - Exactly how this is done depends on which package format is used, - which is determined by - :term:`PACKAGE_CLASSES`. When the - corresponding package manager installs the package, it will know to - also install the packages on which it depends. - - To ensure that the packages ``bar`` and ``baz`` get built, the - previous ``RDEPENDS`` assignment also causes a task dependency to be - added. This dependency is from the recipe's - :ref:`ref-tasks-build` (not to be confused with - :ref:`ref-tasks-compile`) task to the - ``do_package_write_*`` task of the recipes that build ``bar`` and - ``baz``. - - The names of the packages you list within ``RDEPENDS`` 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 ``RDEPENDS`` - variable. For an example of the default list of packages created from - a recipe, see the :term:`PACKAGES` variable. - - Because the ``RDEPENDS`` variable applies to packages being built, - you should always use the variable in a form with an attached package - name (remember that a single recipe can build multiple packages). For - example, suppose you are building a development package that depends - on the ``perl`` package. In this case, you would use the following - ``RDEPENDS`` statement: - :: - - RDEPENDS_${PN}-dev += "perl" - - In the example, - the development package depends on the ``perl`` package. Thus, the - ``RDEPENDS`` variable has the ``${PN}-dev`` package name as part of - the variable. - - .. note:: - - ``RDEPENDS_${PN}-dev`` includes ``${``\ :term:`PN`\ ``}`` - by default. This default is set in the BitBake configuration file - (``meta/conf/bitbake.conf``). Be careful not to accidentally remove - ``${PN}`` when modifying ``RDEPENDS_${PN}-dev``. Use the "+=" operator - rather than the "=" operator. - - The package names you use with ``RDEPENDS`` must appear as they would - in the ``PACKAGES`` variable. The :term:`PKG` variable - allows a different name to be used for the final package (e.g. the - :ref:`debian ` class uses this to rename - packages), but this final package name cannot be used with - ``RDEPENDS``, which makes sense as ``RDEPENDS`` is meant to be - independent of the package format used. - - 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 - ``RDEPENDS`` variable: - :: - - RDEPENDS_${PN} = "package (operator version)" - - For ``operator``, you can specify the following: - - - = - - < - - > - - <= - - >= - - For version, provide the version number. - - .. note:: - - You can use ``EXTENDPKGV`` to provide a full package version - specification. - - For example, the following sets up a dependency on version 1.2 or - greater of the package ``foo``: - :: - - RDEPENDS_${PN} = "foo (>= 1.2)" - - For information on build-time dependencies, see the - :term:`DEPENDS` variable. You can also see the - ":ref:`Tasks `" and - ":ref:`Dependencies `" sections in the - BitBake User Manual for additional information on tasks and - dependencies. - - :term:`REQUIRED_DISTRO_FEATURES` - When inheriting the - :ref:`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. In other words, if the - ``REQUIRED_DISTRO_FEATURES`` variable lists a feature that does not - appear in ``DISTRO_FEATURES`` within the current configuration, then - the recipe will be skipped, and if the build system attempts to build - the recipe then an error will be triggered. - - :term:`RM_WORK_EXCLUDE` - With ``rm_work`` enabled, this variable specifies a list of recipes - whose work directories should not be removed. See the - ":ref:`rm_work.bbclass `" section for more - details. - - :term:`ROOT_HOME` - Defines the root home directory. By default, this directory is set as - follows in the BitBake configuration file: - :: - - ROOT_HOME ??= "/home/root" - - .. 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. - - You can override the default by setting the variable in any layer or - in the ``local.conf`` file. Because the default is set using a "weak" - assignment (i.e. "??="), you can use either of the following forms to - define your override: - :: - - ROOT_HOME = "/root" - ROOT_HOME ?= "/root" - - These - override examples use ``/root``, which is probably the most commonly - used override. - - :term:`ROOTFS` - Indicates a filesystem image to include as the root filesystem. - - The ``ROOTFS`` variable is an optional variable used with the - :ref:`image-live ` class. - - :term:`ROOTFS_POSTINSTALL_COMMAND` - Specifies a list of functions to call after the OpenEmbedded build - system has installed packages. You can specify functions separated by - semicolons: - :: - - ROOTFS_POSTINSTALL_COMMAND += "function; ... " - - If you need to pass the root filesystem path to a command within a - function, you can use ``${IMAGE_ROOTFS}``, which points to the - directory that becomes the root filesystem image. See the - :term:`IMAGE_ROOTFS` variable for more - information. - - :term:`ROOTFS_POSTPROCESS_COMMAND` - Specifies a list of functions to call once the OpenEmbedded build - system has created the root filesystem. You can specify functions - separated by semicolons: - :: - - ROOTFS_POSTPROCESS_COMMAND += "function; ... " - - If you need to pass the root filesystem path to a command within a - function, you can use ``${IMAGE_ROOTFS}``, which points to the - directory that becomes the root filesystem image. See the - :term:`IMAGE_ROOTFS` variable for more - information. - - :term:`ROOTFS_POSTUNINSTALL_COMMAND` - 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 ``base-passwd``, ``shadow``, and ``update-alternatives``. - You can specify functions separated by semicolons: - :: - - ROOTFS_POSTUNINSTALL_COMMAND += "function; ... " - - If you need to pass the root filesystem path to a command within a - function, you can use ``${IMAGE_ROOTFS}``, which points to the - directory that becomes the root filesystem image. See the - :term:`IMAGE_ROOTFS` variable for more - information. - - :term:`ROOTFS_PREPROCESS_COMMAND` - Specifies a list of functions to call before the OpenEmbedded build - system has created the root filesystem. You can specify functions - separated by semicolons: - :: - - ROOTFS_PREPROCESS_COMMAND += "function; ... " - - If you need to pass the root filesystem path to a command within a - function, you can use ``${IMAGE_ROOTFS}``, which points to the - directory that becomes the root filesystem image. See the - :term:`IMAGE_ROOTFS` variable for more - information. - - :term:`RPROVIDES` - 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 - ``RDEPENDS``). - - .. note:: - - A package's own name is implicitly already in its ``RPROVIDES`` list. - - As with all package-controlling variables, you must always use the - variable in conjunction with a package name override. Here is an - example: - :: - - RPROVIDES_${PN} = "widget-abi-2" - - :term:`RRECOMMENDS` - 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 ``RDEPENDS`` variable. - - The package manager will automatically install the ``RRECOMMENDS`` - list of packages when installing the built package. However, you can - prevent listed packages from being installed by using the - :term:`BAD_RECOMMENDATIONS`, - :term:`NO_RECOMMENDATIONS`, and - :term:`PACKAGE_EXCLUDE` variables. - - Packages specified in ``RRECOMMENDS`` need not actually be produced. - However, a recipe must exist that provides each package, either - through the :term:`PACKAGES` or - :term:`PACKAGES_DYNAMIC` variables or the - :term:`RPROVIDES` 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. - - Because the ``RRECOMMENDS`` 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: - :: - - RRECOMMENDS_${PN}-dev += "wireless_package_name" - - In the - example, the package name (``${PN}-dev``) must appear as it would in - the ``PACKAGES`` namespace before any renaming of the output package - by classes such as ``debian.bbclass``. - - 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 - ``RRECOMMENDS`` variable: - :: - - RRECOMMENDS_${PN} = "package (operator version)" - - For ``operator``, you can specify the following: - - - = - - < - - > - - <= - - >= - - For example, the following sets up a recommend on version 1.2 or - greater of the package ``foo``: - :: - - RRECOMMENDS_${PN} = "foo (>= 1.2)" - - :term:`RREPLACES` - 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 ``RCONFLICTS`` variable. - - As with all package-controlling variables, you must use this variable - in conjunction with a package name override. Here is an example: - :: - - RREPLACES_${PN} = "other_package_being_replaced" - - 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 - ``RREPLACES`` variable: - :: - - RREPLACES_${PN} = "package (operator version)" - - For ``operator``, you can specify the following: - - - = - - < - - > - - <= - - >= - - For example, the following sets up a replacement using version 1.2 - or greater of the package ``foo``: - :: - - RREPLACES_${PN} = "foo (>= 1.2)" - - :term:`RSUGGESTS` - 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. - - As with all package-controlling variables, you must always use this - variable in conjunction with a package name override. Here is an - example: - :: - - RSUGGESTS_${PN} = "useful_package another_package" - - :term:`S` - The location in the :term:`Build Directory` where - unpacked recipe source code resides. By default, this directory is - ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, - where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe - version. If the source tarball extracts the code to a directory named - anything other than ``${BPN}-${PV}``, or if the source code is - fetched from an SCM such as Git or Subversion, then you must set - ``S`` in the recipe so that the OpenEmbedded build system knows where - to find the unpacked source. - - As an example, assume a :term:`Source Directory` - top-level folder named ``poky`` and a default Build Directory at - ``poky/build``. In this case, the work directory the build system - uses to keep the unpacked recipe for ``db`` is the following: - :: - - poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19 - - The unpacked source code resides in the ``db-5.1.19`` folder. - - This next example assumes a Git repository. By default, Git - repositories are cloned to ``${WORKDIR}/git`` during - :ref:`ref-tasks-fetch`. Since this path is different - from the default value of ``S``, you must set it specifically so the - source can be located: - :: - - SRC_URI = "git://path/to/repo.git" - S = "${WORKDIR}/git" - - :term:`SANITY_REQUIRED_UTILITIES` - 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. - - :term:`SANITY_TESTED_DISTROS` - 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 ``lsb_release`` tool or - as read from ``/etc/lsb-release``. Separate the list items with - explicit newline characters (``\n``). If ``SANITY_TESTED_DISTROS`` is - not empty and the current value of - :term:`NATIVELSBSTRING` 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. - - :term:`SDK_ARCH` - The target architecture for the SDK. Typically, you do not directly - set this variable. Instead, use :term:`SDKMACHINE`. - - :term:`SDK_DEPLOY` - The directory set up and used by the - :ref:`populate_sdk_base ` class to which - the SDK is deployed. The ``populate_sdk_base`` class defines - ``SDK_DEPLOY`` as follows: - :: - - SDK_DEPLOY = "${TMPDIR}/deploy/sdk" - - :term:`SDK_DIR` - The parent directory used by the OpenEmbedded build system when - creating SDK output. The - :ref:`populate_sdk_base ` class defines - the variable as follows: - :: - - SDK_DIR = "${WORKDIR}/sdk" - - .. note:: - - The ``SDK_DIR`` directory is a temporary directory as it is part of - ``WORKDIR``. The final output directory is :term:`SDK_DEPLOY`. - - :term:`SDK_EXT_TYPE` - 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 - :term:`SSTATE_MIRRORS` is set in the SDK's configuration to enable the - artifacts to be fetched as needed. - - :term:`SDK_HOST_MANIFEST` - 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. The - file contains package information on a line-per-package basis as - follows: - :: - - packagename packagearch version - - The :ref:`populate_sdk_base ` class - defines the manifest file as follows: - :: - - SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" - - The location is derived using the :term:`SDK_DEPLOY` and - :term:`TOOLCHAIN_OUTPUTNAME` variables. - - :term:`SDK_INCLUDE_PKGDATA` - 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 ``devtool search`` command to find these recipes in search - results, as well as allows the ``devtool add`` command to map - dependencies more effectively. - - .. note:: - - Enabling the ``SDK_INCLUDE_PKGDATA`` - 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. - - :term:`SDK_INCLUDE_TOOLCHAIN` - When set to "1", specifies to include the toolchain in the extensible - SDK. Including the toolchain is useful particularly when - :term:`SDK_EXT_TYPE` is set to "minimal" to keep - the SDK reasonably small but you still want to provide a usable - toolchain. For example, suppose you want to use the toolchain from an - IDE or from other tools and you do not want to perform additional - steps to install the toolchain. - - The ``SDK_INCLUDE_TOOLCHAIN`` variable defaults to "0" if - ``SDK_EXT_TYPE`` is set to "minimal", and defaults to "1" if - ``SDK_EXT_TYPE`` is set to "full". - - :term:`SDK_INHERIT_BLACKLIST` - A list of classes to remove from the :term:`INHERIT` - value globally within the extensible SDK configuration. The - :ref:`populate-sdk-ext ` class sets the - default value: - :: - - SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" - - Some classes are not generally applicable within the extensible SDK - context. You can use this variable to disable those classes. - - For additional information on how to customize the extensible SDK's - configuration, see the - ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - :term:`SDK_LOCAL_CONF_BLACKLIST` - A list of variables not allowed through from the OpenEmbedded 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. - - By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the - :ref:`populate-sdk-ext ` class and - excludes the following variables: - - - :term:`CONF_VERSION` - - :term:`BB_NUMBER_THREADS` - - :term:`bitbake:BB_NUMBER_PARSE_THREADS` - - :term:`PARALLEL_MAKE` - - :term:`PRSERV_HOST` - - :term:`SSTATE_MIRRORS` :term:`DL_DIR` - - :term:`SSTATE_DIR` :term:`TMPDIR` - - :term:`BB_SERVER_TIMEOUT` - - For additional information on how to customize the extensible SDK's - configuration, see the - ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - :term:`SDK_LOCAL_CONF_WHITELIST` - A list of variables allowed through from the OpenEmbedded build - system configuration into the extensible SDK configuration. By - default, the list of variables is empty and is set in the - :ref:`populate-sdk-ext ` class. - - This list overrides the variables specified using the - :term:`SDK_LOCAL_CONF_BLACKLIST` - 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. - - For additional information on how to customize the extensible SDK's - configuration, see the - ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - :term:`SDK_NAME` - The base name for SDK output files. The name is derived from the - :term:`DISTRO`, :term:`TCLIBC`, - :term:`SDK_ARCH`, - :term:`IMAGE_BASENAME`, and - :term:`TUNE_PKGARCH` variables: - :: - - SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" - - :term:`SDK_OS` - Specifies the operating system for which the SDK will be built. The - default value is the value of :term:`BUILD_OS`. - - :term:`SDK_OUTPUT` - The location used by the OpenEmbedded build system when creating SDK - output. The :ref:`populate_sdk_base ` - class defines the variable as follows: - :: - - SDK_DIR = "${WORKDIR}/sdk" - SDK_OUTPUT = "${SDK_DIR}/image" - SDK_DEPLOY = "${DEPLOY_DIR}/sdk" - - .. note:: - - The ``SDK_OUTPUT`` directory is a temporary directory as it is part of - :term:`WORKDIR` by way of :term:`SDK_DIR`. The final output directory is - :term:`SDK_DEPLOY`. - - :term:`SDK_PACKAGE_ARCHS` - 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 ``SDK_PACKAGE_ARCHS`` is "all any - noarch ${SDK_ARCH}-${SDKPKGSUFFIX}". - - :term:`SDK_POSTPROCESS_COMMAND` - Specifies a list of functions to call once the OpenEmbedded build - system creates the SDK. You can specify functions separated by - semicolons: SDK_POSTPROCESS_COMMAND += "function; ... " - - If you need to pass an SDK path to a command within a function, you - can use ``${SDK_DIR}``, which points to the parent directory used by - the OpenEmbedded build system when creating SDK output. See the - :term:`SDK_DIR` variable for more information. - - :term:`SDK_PREFIX` - The toolchain binary prefix used for ``nativesdk`` recipes. The - OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the - :term:`TARGET_PREFIX` when building - ``nativesdk`` recipes. The default value is "${SDK_SYS}-". - - :term:`SDK_RECRDEP_TASKS` - A list of shared state tasks added to the extensible SDK. By default, - the following tasks are added: - - - do_populate_lic - - do_package_qa - - do_populate_sysroot - - do_deploy - - Despite the default value of "" for the - ``SDK_RECRDEP_TASKS`` variable, the above four tasks are always added - to the SDK. To specify tasks beyond these four, you need to use the - ``SDK_RECRDEP_TASKS`` variable (e.g. you are defining additional - tasks that are needed in order to build - :term:`SDK_TARGETS`). - - :term:`SDK_SYS` - Specifies the system, including the architecture and the operating - system, for which the SDK will be built. - - The OpenEmbedded build system automatically sets this variable based - on :term:`SDK_ARCH`, - :term:`SDK_VENDOR`, and - :term:`SDK_OS`. You do not need to set the ``SDK_SYS`` - variable yourself. - - :term:`SDK_TARGET_MANIFEST` - 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: - :: - - packagename packagearch version - - The :ref:`populate_sdk_base ` class - defines the manifest file as follows: - :: - - SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" - - The location is derived using the :term:`SDK_DEPLOY` and - :term:`TOOLCHAIN_OUTPUTNAME` variables. - - :term:`SDK_TARGETS` - 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). - - The ``SDK_TARGETS`` variable is an internal variable and typically - would not be changed. - - :term:`SDK_TITLE` - The title to be printed when running the SDK installer. By default, - this title is based on the :term:`DISTRO_NAME` or - :term:`DISTRO` variable and is set in the - :ref:`populate_sdk_base ` class as - follows: - :: - - SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" - - For the default distribution "poky", - ``SDK_TITLE`` is set to "Poky (Yocto Project Reference Distro)". - - For information on how to change this default title, see the - ":ref:`sdk-manual/appendix-customizing:changing the extensible sdk installer title`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - :term:`SDK_UPDATE_URL` - An optional URL for an update server for the extensible SDK. If set, - the value is used as the default update server when running - ``devtool sdk-update`` within the extensible SDK. - - :term:`SDK_VENDOR` - Specifies the name of the SDK vendor. - - :term:`SDK_VERSION` - Specifies the version of the SDK. The distribution configuration file - (e.g. ``/meta-poky/conf/distro/poky.conf``) defines the - ``SDK_VERSION`` as follows: - :: - - SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${DATE}','snapshot')}" - - For additional information, see the - :term:`DISTRO_VERSION` and - :term:`DATE` variables. - - :term:`SDKEXTPATH` - The default installation directory for the Extensible SDK. By - default, this directory is based on the :term:`DISTRO` - variable and is set in the - :ref:`populate_sdk_base ` class as - follows: - :: - - SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" - - For the - default distribution "poky", the ``SDKEXTPATH`` is set to "poky_sdk". - - For information on how to change this default directory, see the - ":ref:`sdk-manual/appendix-customizing:changing the default sdk installation directory`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - :term:`SDKIMAGE_FEATURES` - Equivalent to ``IMAGE_FEATURES``. However, this variable applies to - the SDK generated from an image using the following command: - :: - - $ bitbake -c populate_sdk imagename - - :term:`SDKMACHINE` - 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 - ``SDKMACHINE`` value. The value points to a corresponding ``.conf`` - file under ``conf/machine-sdk/``. - - 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. - :: - - SDKMACHINE ?= "i686" - - .. note:: - - You cannot set the ``SDKMACHINE`` - variable in your distribution configuration file. If you do, the - configuration will not take affect. - - :term:`SDKPATH` - 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. - - :term:`SDKTARGETSYSROOT` - The full path to the sysroot used for cross-compilation within an SDK - as it will be when installed into the default - :term:`SDKPATH`. - - :term:`SECTION` - The section in which packages should be categorized. Package - management utilities can make use of this variable. - - :term:`SELECTED_OPTIMIZATION` - Specifies the optimization flags passed to the C compiler when - building for the target. The flags are passed through the default - value of the :term:`TARGET_CFLAGS` variable. - - The ``SELECTED_OPTIMIZATION`` variable takes the value of - ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the - case, the value of ``DEBUG_OPTIMIZATION`` is used. - - :term:`SERIAL_CONSOLE` - 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: - :: - - SERIAL_CONSOLE = "115200 ttyS0" - - .. note:: - - The ``SERIAL_CONSOLE`` variable is deprecated. Please use the - :term:`SERIAL_CONSOLES` variable. - - :term:`SERIAL_CONSOLES` - 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 semicolon. Use spaces to separate multiple devices: - :: - - SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1" - - :term:`SERIAL_CONSOLES_CHECK` - Specifies serial consoles, which must be listed in - :term:`SERIAL_CONSOLES`, to check against - ``/proc/console`` before enabling them using getty. This variable - allows aliasing in the format: :. If a device was - listed as "sclp_line0" in ``/dev/`` and "ttyS0" was listed in - ``/proc/console``, you would do the following: :: - - SERIAL_CONSOLES_CHECK = "slcp_line0:ttyS0" - - This variable is currently only supported with SysVinit (i.e. not - with systemd). - - :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` - 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: :: - - SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2" - - In the previous example, ``intone`` depends on ``mplayer2``. - - You can use the special token ``"*"`` on the left-hand side of the - dependency to match all recipes except the one on the right-hand - side. Here is an example: :: - - SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "*->quilt-native" - - In the previous example, all recipes except ``quilt-native`` ignore - task signatures from the ``quilt-native`` recipe when determining - their task signatures. - - Use of this variable is one mechanism to remove dependencies that - affect task signatures and thus force rebuilds when a recipe changes. - - .. note:: - - 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. - - :term:`SIGGEN_EXCLUDERECIPES_ABISAFE` - 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:: - - 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. - - :term:`SITEINFO_BITS` - Specifies the number of bits for the target system CPU. The value - should be either "32" or "64". - - :term:`SITEINFO_ENDIANNESS` - Specifies the endian byte order of the target system. The value - should be either "le" for little-endian or "be" for big-endian. - - :term:`SKIP_FILEDEPS` - 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 ``libstdc++`` and ``glibc``. - - To enable file removal, set the variable to "1" in your - ``conf/local.conf`` configuration file in your: - :term:`Build Directory`. - :: - - SKIP_FILEDEPS = "1" - - :term:`SOC_FAMILY` - 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. - - .. note:: - - You must include ``conf/machine/include/soc-family.inc`` for this - variable to appear in :term:`MACHINEOVERRIDES`. - - :term:`SOLIBS` - 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 ``meta/conf/bitbake.conf`` configuration file. - - You will see this variable referenced in the default values of - ``FILES_${PN}``. - - :term:`SOLIBSDEV` - 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 - ``meta/conf/bitbake.conf`` configuration file. - - You will see this variable referenced in the default values of - ``FILES_${PN}-dev``. - - :term:`SOURCE_MIRROR_FETCH` - When you are fetching files to create a mirror of sources (i.e. - creating a source mirror), setting ``SOURCE_MIRROR_FETCH`` to "1" in - your ``local.conf`` 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 :term:`COMPATIBLE_MACHINE` - variable and :term:`COMPATIBLE_HOST` variables - specify compatibility with a machine other than that of the current - machine or host. - - .. note:: - - Do not set the ``SOURCE_MIRROR_FETCH`` - variable unless you are creating a source mirror. In other words, - do not set the variable during a normal build. - - :term:`SOURCE_MIRROR_URL` - Defines your own :term:`PREMIRRORS` from which to - first fetch source before attempting to fetch from the upstream - specified in :term:`SRC_URI`. - - To use this variable, you must globally inherit the - :ref:`own-mirrors ` class and then provide - the URL to your mirrors. Here is the general syntax: - :: - - INHERIT += "own-mirrors" - SOURCE_MIRROR_URL = "http://example.com/my_source_mirror" - - .. note:: - - You can specify only a single URL in ``SOURCE_MIRROR_URL``. - - :term:`SPDXLICENSEMAP` - Maps commonly used license names to their SPDX counterparts found in - ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP`` - mappings, see the ``meta/conf/licenses.conf`` file. - - For additional information, see the :term:`LICENSE` - variable. - - :term:`SPECIAL_PKGSUFFIX` - A list of prefixes for :term:`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 :term:`BPN` variable. - - :term:`SPL_BINARY` - The file type for the Secondary Program Loader (SPL). Some devices - use an SPL from which to boot (e.g. the BeagleBone development - board). For such cases, you can declare the file type of the SPL - binary in the ``u-boot.inc`` include file, which is used in the - U-Boot recipe. - - The SPL file type is set to "null" by default in the ``u-boot.inc`` - file as follows: - :: - - # Some versions of u-boot build an SPL (Second Program Loader) image that - # should be packaged along with the u-boot binary as well as placed in the - # deploy directory. For those versions they can set the following variables - # to allow packaging the SPL. - SPL_BINARY ?= "" - SPL_BINARYNAME ?= "${@os.path.basename(d.getVar("SPL_BINARY"))}" - SPL_IMAGE ?= "${SPL_BINARYNAME}-${MACHINE}-${PV}-${PR}" - SPL_SYMLINK ?= "${SPL_BINARYNAME}-${MACHINE}" - - The ``SPL_BINARY`` variable helps form - various ``SPL_*`` variables used by the OpenEmbedded build system. - - See the BeagleBone machine configuration example in the - ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" - section in the Yocto Project Board Support Package Developer's Guide - for additional information. - - :term:`SRC_URI` - 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 ``SRC_URI`` 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. - - 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 ":ref:`Fetchers `" section in the - BitBake User Manual. - - - ``file://`` - Fetches files, which are usually files shipped - with the :term:`Metadata`, from the local machine (e.g. - :ref:`patch ` files). - The path is relative to the :term:`FILESPATH` - 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 (``.bb``) or append file - (``.bbappend``) resides: - - - ``${BPN}`` - The base recipe name without any special suffix - or version numbers. - - - ``${BP}`` - ``${BPN}-${PV}``. The base recipe name and - version but without any special package name suffix. - - - *files -* Files within a directory, which is named ``files`` - and is also alongside the recipe or append file. - - .. note:: - - If you want the build system to pick up files specified through - a - SRC_URI - statement from your append file, you need to be sure to extend - the - FILESPATH - variable by also using the - FILESEXTRAPATHS - variable from within your append file. - - - ``bzr://`` - Fetches files from a Bazaar revision control - repository. - - - ``git://`` - Fetches files from a Git revision control - repository. - - - ``osc://`` - Fetches files from an OSC (OpenSUSE Build service) - revision control repository. - - - ``repo://`` - Fetches files from a repo (Git) repository. - - - ``ccrc://`` - Fetches files from a ClearCase repository. - - - ``http://`` - Fetches files from the Internet using ``http``. - - - ``https://`` - Fetches files from the Internet using ``https``. - - - ``ftp://`` - Fetches files from the Internet using ``ftp``. - - - ``cvs://`` - Fetches files from a CVS revision control - repository. - - - ``hg://`` - Fetches files from a Mercurial (``hg``) revision - control repository. - - - ``p4://`` - Fetches files from a Perforce (``p4``) revision - control repository. - - - ``ssh://`` - Fetches files from a secure shell. - - - ``svn://`` - Fetches files from a Subversion (``svn``) revision - control repository. - - - ``npm://`` - Fetches JavaScript modules from a registry. - - Standard and recipe-specific options for ``SRC_URI`` exist. Here are - standard options: - - - ``apply`` - Whether to apply the patch or not. The default - action is to apply the patch. - - - ``striplevel`` - Which striplevel to use when applying the - patch. The default level is 1. - - - ``patchdir`` - Specifies the directory in which the patch should - be applied. The default is ``${``\ :term:`S`\ ``}``. - - Here are options specific to recipes building code from a revision - control system: - - - ``mindate`` - Apply the patch only if - :term:`SRCDATE` is equal to or greater than - ``mindate``. - - - ``maxdate`` - Apply the patch only if ``SRCDATE`` is not later - than ``maxdate``. - - - ``minrev`` - Apply the patch only if ``SRCREV`` is equal to or - greater than ``minrev``. - - - ``maxrev`` - Apply the patch only if ``SRCREV`` is not later - than ``maxrev``. - - - ``rev`` - Apply the patch only if ``SRCREV`` is equal to - ``rev``. - - - ``notrev`` - Apply the patch only if ``SRCREV`` is not equal to - ``rev``. - - Here are some additional options worth mentioning: - - - ``unpack`` - Controls whether or not to unpack the file if it is - an archive. The default action is to unpack the file. - - - ``destsuffix`` - Places the file (or extracts its contents) into - the specified subdirectory of :term:`WORKDIR` when - the Git fetcher is used. - - - ``subdir`` - Places the file (or extracts its contents) into the - specified subdirectory of ``WORKDIR`` when the local (``file://``) - fetcher is used. - - - ``localdir`` - Places the file (or extracts its contents) into - the specified subdirectory of ``WORKDIR`` when the CVS fetcher is - used. - - - ``subpath`` - Limits the checkout to a specific subpath of the - tree when using the Git fetcher is used. - - - ``name`` - Specifies a name to be used for association with - ``SRC_URI`` checksums or :term:`SRCREV` when you have more than one - file or git repository specified in ``SRC_URI``. For example: - :: - - SRC_URI = "git://example.com/foo.git;name=first \ - git://example.com/bar.git;name=second \ - http://example.com/file.tar.gz;name=third" - - SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15" - SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f" - SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de" - - - - ``downloadfilename`` - Specifies the filename used when storing - the downloaded file. - - :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` - 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. - - :term:`SRCDATE` - 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). - - :term:`SRCPV` - Returns the version string of the current package. This string is - used to help define the value of :term:`PV`. - - The ``SRCPV`` variable is defined in the ``meta/conf/bitbake.conf`` - configuration file in the :term:`Source Directory` as - follows: - :: - - SRCPV = "${@bb.fetch2.get_srcrev(d)}" - - Recipes that need to define ``PV`` do so with the help of the - ``SRCPV``. For example, the ``ofono`` recipe (``ofono_git.bb``) - located in ``meta/recipes-connectivity`` in the Source Directory - defines ``PV`` as follows: - :: - - PV = "0.12-git${SRCPV}" - - :term:`SRCREV` - 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 ``SRCREV`` that is a full revision - identifier and not just a tag. - - .. note:: - - For information on limitations when inheriting the latest revision - of software using ``SRCREV``, see the :term:`AUTOREV` variable - description and the - ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" - section, which is in the Yocto Project Development Tasks Manual. - - :term:`SSTATE_DIR` - The directory for the shared state cache. - - :term:`SSTATE_MIRROR_ALLOW_NETWORK` - If set to "1", allows fetches from mirrors that are specified in - :term:`SSTATE_MIRRORS` to work even when - fetching from the network is disabled by setting ``BB_NO_NETWORK`` to - "1". Using the ``SSTATE_MIRROR_ALLOW_NETWORK`` variable is useful if - you have set ``SSTATE_MIRRORS`` to point to an internal server for - your shared state cache, but you want to disable any other fetching - from the network. - - :term:`SSTATE_MIRRORS` - 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 :term:`MIRRORS` - and :term:`PREMIRRORS` and points to the cache - locations to check for the shared state (sstate) objects. - - 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. - - When pointing to sstate build artifacts on another machine that uses - a different GCC version for native builds, you must configure - ``SSTATE_MIRRORS`` with a regular expression that maps local search - paths to server paths. The paths need to take into account - :term:`NATIVELSBSTRING` set by the - :ref:`uninative ` class. For example, the - following maps the local search path ``universal-4.9`` to the - server-provided path server_url_sstate_path: - :: - - SSTATE_MIRRORS ?= "file://universal-4.9/(.*) http://server_url_sstate_path/universal-4.8/\1 \n" - - If a mirror uses the same structure as - :term:`SSTATE_DIR`, 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. - :: - - SSTATE_MIRRORS ?= "\ - file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \ - file://.* file:///some-local-dir/sstate/PATH" - - :term:`SSTATE_SCAN_FILES` - Controls the list of files the OpenEmbedded build system scans for - hardcoded installation paths. The variable uses a space-separated - list of filenames (not paths) with standard wildcard characters - allowed. - - During a build, the OpenEmbedded build system creates a shared state - (sstate) object during the first stage of preparing the sysroots. - That object is scanned for hardcoded paths for original installation - locations. The list of files that are scanned for paths is controlled - by the ``SSTATE_SCAN_FILES`` variable. Typically, recipes add files - they want to be scanned to the value of ``SSTATE_SCAN_FILES`` rather - than the variable being comprehensively set. The - :ref:`sstate ` class specifies the default list - of files. - - For details on the process, see the - :ref:`staging ` class. - - :term:`STAGING_BASE_LIBDIR_NATIVE` - Specifies the path to the ``/lib`` subdirectory of the sysroot - directory for the build host. - - :term:`STAGING_BASELIBDIR` - Specifies the path to the ``/lib`` subdirectory of the sysroot - directory for the target for which the current recipe is being built - (:term:`STAGING_DIR_HOST`). - - :term:`STAGING_BINDIR` - Specifies the path to the ``/usr/bin`` subdirectory of the sysroot - directory for the target for which the current recipe is being built - (:term:`STAGING_DIR_HOST`). - - :term:`STAGING_BINDIR_CROSS` - 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 - ``pkg-config``. Consequently, if ``pkg-config`` is supported by the - library to which you are linking, it is recommended you use - ``pkg-config`` instead of a provided configuration script. - - :term:`STAGING_BINDIR_NATIVE` - Specifies the path to the ``/usr/bin`` subdirectory of the sysroot - directory for the build host. - - :term:`STAGING_DATADIR` - Specifies the path to the ``/usr/share`` subdirectory of the sysroot - directory for the target for which the current recipe is being built - (:term:`STAGING_DIR_HOST`). - - :term:`STAGING_DATADIR_NATIVE` - Specifies the path to the ``/usr/share`` subdirectory of the sysroot - directory for the build host. - - :term:`STAGING_DIR` - Helps construct the ``recipe-sysroots`` directory, which is used - during packaging. - - For information on how staging for recipe-specific sysroots occurs, - see the :ref:`ref-tasks-populate_sysroot` - task, the ":ref:`sdk-manual/extensible:sharing files between recipes`" - section in the Yocto Project Development Tasks Manual, the - ":ref:`overview-manual/concepts:configuration, compilation, and staging`" - section in the Yocto Project Overview and Concepts Manual, and the - :term:`SYSROOT_DIRS` variable. - - .. note:: - - Recipes should never write files directly under the ``STAGING_DIR`` - directory because the OpenEmbedded build system manages the - directory automatically. Instead, files should be installed to - ``${``\ :term:`D`\ ``}`` within your recipe's :ref:`ref-tasks-install` - task and then the OpenEmbedded build system will stage a subset of - those files into the sysroot. - - :term:`STAGING_DIR_HOST` - Specifies the path to the sysroot directory for the system on which - the component is built to run (the system that hosts the component). - For most recipes, this sysroot is the one in which that recipe's - :ref:`ref-tasks-populate_sysroot` task copies - files. Exceptions include ``-native`` recipes, where the - ``do_populate_sysroot`` task instead uses - :term:`STAGING_DIR_NATIVE`. Depending on - the type of recipe and the build target, ``STAGING_DIR_HOST`` can - have the following values: - - - For recipes building for the target machine, the value is - "${:term:`STAGING_DIR`}/${:term:`MACHINE`}". - - - 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. - - .. note:: - - ``-native`` recipes are not installed into host paths like such - as ``/usr``. Rather, these recipes are installed into - ``STAGING_DIR_NATIVE``. When compiling ``-native`` recipes, - standard build environment variables such as - :term:`CPPFLAGS` and - :term:`CFLAGS` are set up so that both host paths - and ``STAGING_DIR_NATIVE`` are searched for libraries and - headers using, for example, GCC's ``-isystem`` option. - - Thus, the emphasis is that the ``STAGING_DIR*`` variables - should be viewed as input variables by tasks such as - :ref:`ref-tasks-configure`, - :ref:`ref-tasks-compile`, and - :ref:`ref-tasks-install`. Having the real system - root correspond to ``STAGING_DIR_HOST`` makes conceptual sense - for ``-native`` recipes, as they make use of host headers and - libraries. - - :term:`STAGING_DIR_NATIVE` - Specifies the path to the sysroot directory used when building - components that run on the build host itself. - - :term:`STAGING_DIR_TARGET` - Specifies the path to the sysroot used for the system for which the - component generates code. For components that do not generate code, - which is the majority, ``STAGING_DIR_TARGET`` is set to match - :term:`STAGING_DIR_HOST`. - - 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 generate binaries for the "TARGET" - system. The ``STAGING_DIR_HOST`` variable points to the sysroot used - for the "HOST" system, while ``STAGING_DIR_TARGET`` points to the - sysroot used for the "TARGET" system. - - :term:`STAGING_ETCDIR_NATIVE` - Specifies the path to the ``/etc`` subdirectory of the sysroot - directory for the build host. - - :term:`STAGING_EXECPREFIXDIR` - Specifies the path to the ``/usr`` subdirectory of the sysroot - directory for the target for which the current recipe is being built - (:term:`STAGING_DIR_HOST`). - - :term:`STAGING_INCDIR` - Specifies the path to the ``/usr/include`` subdirectory of the - sysroot directory for the target for which the current recipe being - built (:term:`STAGING_DIR_HOST`). - - :term:`STAGING_INCDIR_NATIVE` - Specifies the path to the ``/usr/include`` subdirectory of the - sysroot directory for the build host. - - :term:`STAGING_KERNEL_BUILDDIR` - Points to the directory containing the kernel build artifacts. - Recipes building software that needs to access kernel build artifacts - (e.g. ``systemtap-uprobes``) can look in the directory specified with - the ``STAGING_KERNEL_BUILDDIR`` variable to find these artifacts - after the kernel has been built. - - :term:`STAGING_KERNEL_DIR` - The directory with kernel headers that are required to build - out-of-tree modules. - - :term:`STAGING_LIBDIR` - Specifies the path to the ``/usr/lib`` subdirectory of the sysroot - directory for the target for which the current recipe is being built - (:term:`STAGING_DIR_HOST`). - - :term:`STAGING_LIBDIR_NATIVE` - Specifies the path to the ``/usr/lib`` subdirectory of the sysroot - directory for the build host. - - :term:`STAMP` - 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 ``STAMP`` as set in the ``meta/conf/bitbake.conf`` - file is: - :: - - STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}" - - For information on how BitBake uses stamp files to determine if a - task should be rerun, see the - ":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`" - section in the Yocto Project Overview and Concepts Manual. - - See :term:`STAMPS_DIR`, - :term:`MULTIMACH_TARGET_SYS`, - :term:`PN`, :term:`EXTENDPE`, - :term:`PV`, and :term:`PR` for related variable - information. - - :term:`STAMPS_DIR` - Specifies the base directory in which the OpenEmbedded build system - places stamps. The default directory is ``${TMPDIR}/stamps``. - - :term:`STRIP` - The minimal command and arguments to run ``strip``, which is used to - strip symbols. - - :term:`SUMMARY` - The short (72 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 - :term:`DESCRIPTION` variable if ``DESCRIPTION`` is - not set in the recipe. - - :term:`SVNDIR` - The directory in which files checked out of a Subversion system are - stored. - - :term:`SYSLINUX_DEFAULT_CONSOLE` - 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: - :: - - SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" - - The :ref:`syslinux ` class initially sets - this variable to null but then checks for a value later. - - :term:`SYSLINUX_OPTS` - 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 (``;``). - - The :ref:`syslinux ` class uses this variable - to create a set of options. - - :term:`SYSLINUX_SERIAL` - 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 - :ref:`syslinux ` class as follows: - :: - - SYSLINUX_SERIAL ?= "0 115200" - - The class checks for and uses the variable as needed. - - :term:`SYSLINUX_SERIAL_TTY` - Specifies the alternate console=tty... kernel boot argument. The - variable's default value is set in the - :ref:`syslinux ` class as follows: - :: - - SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" - - The class checks for and uses the variable as needed. - - :term:`SYSLINUX_SPLASH` - An ``.LSS`` file used as the background for the VGA boot menu when - you use the boot menu. You need to set this variable in your recipe. - - The :ref:`syslinux ` class checks for this - variable and if found, the OpenEmbedded build system installs the - splash screen. - - :term:`SYSROOT_DESTDIR` - Points to the temporary directory under the work directory (default - "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") - where the files populated into the sysroot are assembled during the - :ref:`ref-tasks-populate_sysroot` task. - - :term:`SYSROOT_DIRS` - Directories that are staged into the sysroot by the - :ref:`ref-tasks-populate_sysroot` task. By - default, the following directories are staged: - :: - - SYSROOT_DIRS = " \ - ${includedir} \ - ${libdir} \ - ${base_libdir} \ - ${nonarch_base_libdir} \ - ${datadir} \ - " - - :term:`SYSROOT_DIRS_BLACKLIST` - Directories that are not staged into the sysroot by the - :ref:`ref-tasks-populate_sysroot` task. You - can use this variable to exclude certain subdirectories of - directories listed in :term:`SYSROOT_DIRS` from - staging. By default, the following directories are not staged: - :: - - SYSROOT_DIRS_BLACKLIST = " \ - ${mandir} \ - ${docdir} \ - ${infodir} \ - ${datadir}/locale \ - ${datadir}/applications \ - ${datadir}/fonts \ - ${datadir}/pixmaps \ - " - - :term:`SYSROOT_DIRS_NATIVE` - Extra directories staged into the sysroot by the - :ref:`ref-tasks-populate_sysroot` task for - ``-native`` recipes, in addition to those specified in - :term:`SYSROOT_DIRS`. By default, the following - extra directories are staged: - :: - - SYSROOT_DIRS_NATIVE = " \ - ${bindir} \ - ${sbindir} \ - ${base_bindir} \ - ${base_sbindir} \ - ${libexecdir} \ - ${sysconfdir} \ - ${localstatedir} \ - " - - .. note:: - - Programs built by ``-native`` recipes run directly from the sysroot - (:term:`STAGING_DIR_NATIVE`), which is why additional directories - containing program executables and supporting files need to be staged. - - :term:`SYSROOT_PREPROCESS_FUNCS` - 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. - - :term:`SYSTEMD_AUTO_ENABLE` - When inheriting the :ref:`systemd ` class, - this variable specifies whether the specified service in - :term:`SYSTEMD_SERVICE` should start - automatically or not. By default, the service is enabled to - automatically start at boot time. The default setting is in the - :ref:`systemd ` class as follows: - :: - - SYSTEMD_AUTO_ENABLE ??= "enable" - - You can disable the service by setting the variable to "disable". - - :term:`SYSTEMD_BOOT_CFG` - When :term:`EFI_PROVIDER` is set to - "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the - configuration file that should be used. By default, the - :ref:`systemd-boot ` class sets the - ``SYSTEMD_BOOT_CFG`` as follows: - :: - - SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf" - - For information on Systemd-boot, see the `Systemd-boot - documentation `__. - - :term:`SYSTEMD_BOOT_ENTRIES` - When :term:`EFI_PROVIDER` is set to - "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a - list of entry files (``*.conf``) to install that contain one boot - entry per file. By default, the - :ref:`systemd-boot ` class sets the - ``SYSTEMD_BOOT_ENTRIES`` as follows: - :: - - SYSTEMD_BOOT_ENTRIES ?= "" - - For information on Systemd-boot, see the `Systemd-boot - documentation `__. - - :term:`SYSTEMD_BOOT_TIMEOUT` - When :term:`EFI_PROVIDER` is set to - "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the - boot menu timeout in seconds. By default, the - :ref:`systemd-boot ` class sets the - ``SYSTEMD_BOOT_TIMEOUT`` as follows: - :: - - SYSTEMD_BOOT_TIMEOUT ?= "10" - - For information on Systemd-boot, see the `Systemd-boot - documentation `__. - - :term:`SYSTEMD_PACKAGES` - When inheriting the :ref:`systemd ` class, - this variable locates the systemd unit files when they are not found - in the main recipe's package. By default, the ``SYSTEMD_PACKAGES`` - variable is set such that the systemd unit files are assumed to - reside in the recipes main package: - :: - - SYSTEMD_PACKAGES ?= "${PN}" - - If these unit files are not in this recipe's main package, you need - to use ``SYSTEMD_PACKAGES`` to list the package or packages in which - the build system can find the systemd unit files. - - :term:`SYSTEMD_SERVICE` - When inheriting the :ref:`systemd ` class, - this variable specifies the systemd service name for a package. - - 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: - :: - - SYSTEMD_SERVICE_${PN} = "connman.service" - - :term:`SYSVINIT_ENABLED_GETTYS` - When using - :ref:`SysVinit `, - specifies a space-separated list of the virtual terminals that should - run a `getty `__ - (allowing login), assuming :term:`USE_VT` is not set to - "0". - - The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only - run a getty on the first virtual terminal). - - :term:`T` - 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: - :: - - T = "${WORKDIR}/temp" - - The :term:`WORKDIR` is the directory into which - BitBake unpacks and builds the recipe. The default ``bitbake.conf`` - file sets this variable. - - The ``T`` variable is not to be confused with the - :term:`TMPDIR` variable, which points to the root of - the directory tree where BitBake places the output of an entire - build. - - :term:`TARGET_ARCH` - 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: - - - arm - - i586 - - x86_64 - - powerpc - - powerpc64 - - mips - - mipsel - - For additional information on machine architectures, see the - :term:`TUNE_ARCH` variable. - - :term:`TARGET_AS_ARCH` - Specifies architecture-specific assembler flags for the target - system. ``TARGET_AS_ARCH`` is initialized from - :term:`TUNE_ASARGS` by default in the BitBake - configuration file (``meta/conf/bitbake.conf``): - :: - - TARGET_AS_ARCH = "${TUNE_ASARGS}" - - :term:`TARGET_CC_ARCH` - Specifies architecture-specific C compiler flags for the target - system. ``TARGET_CC_ARCH`` is initialized from - :term:`TUNE_CCARGS` by default. - - .. note:: - - It is a common workaround to append :term:`LDFLAGS` to - ``TARGET_CC_ARCH`` in recipes that build software for the target that - would not otherwise respect the exported ``LDFLAGS`` variable. - - :term:`TARGET_CC_KERNEL_ARCH` - 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 :term:`TUNE_CCARGS` is not - compatible with the kernel compilation. The ``TARGET_CC_KERNEL_ARCH`` - variable allows the kernel (and associated modules) to use a - different configuration. See the - ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the - :term:`Source Directory` for an example. - - :term:`TARGET_CFLAGS` - Specifies the flags to pass to the C compiler when building for the - target. When building in the target context, - :term:`CFLAGS` is set to the value of this variable by - default. - - Additionally, the SDK's environment setup script sets the ``CFLAGS`` - variable in the environment to the ``TARGET_CFLAGS`` value so that - executables built using the SDK also have the flags applied. - - :term:`TARGET_CPPFLAGS` - 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, :term:`CPPFLAGS` is set to the - value of this variable by default. - - Additionally, the SDK's environment setup script sets the - ``CPPFLAGS`` variable in the environment to the ``TARGET_CPPFLAGS`` - value so that executables built using the SDK also have the flags - applied. - - :term:`TARGET_CXXFLAGS` - Specifies the flags to pass to the C++ compiler when building for the - target. When building in the target context, - :term:`CXXFLAGS` is set to the value of this variable - by default. - - Additionally, the SDK's environment setup script sets the - ``CXXFLAGS`` variable in the environment to the ``TARGET_CXXFLAGS`` - value so that executables built using the SDK also have the flags - applied. - - :term:`TARGET_FPU` - 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. - - :term:`TARGET_LD_ARCH` - Specifies architecture-specific linker flags for the target system. - ``TARGET_LD_ARCH`` is initialized from - :term:`TUNE_LDARGS` by default in the BitBake - configuration file (``meta/conf/bitbake.conf``): - :: - - TARGET_LD_ARCH = "${TUNE_LDARGS}" - - :term:`TARGET_LDFLAGS` - Specifies the flags to pass to the linker when building for the - target. When building in the target context, - :term:`LDFLAGS` is set to the value of this variable - by default. - - Additionally, the SDK's environment setup script sets the - :term:`LDFLAGS` variable in the environment to the - ``TARGET_LDFLAGS`` value so that executables built using the SDK also - have the flags applied. - - :term:`TARGET_OS` - Specifies the target's operating system. The variable can be set to - "linux" for glibc-based systems (GNU C Library) and to "linux-musl" - for musl libc. For ARM/EABI targets, "linux-gnueabi" and - "linux-musleabi" possible values exist. - - :term:`TARGET_PREFIX` - Specifies the prefix used for the toolchain binary target tools. - - Depending on the type of recipe and the build target, - ``TARGET_PREFIX`` is set as follows: - - - For recipes building for the target machine, the value is - "${:term:`TARGET_SYS`}-". - - - For native recipes, the build system sets the variable to the - value of ``BUILD_PREFIX``. - - - For native SDK recipes (``nativesdk``), the build system sets the - variable to the value of ``SDK_PREFIX``. - - :term:`TARGET_SYS` - Specifies the system, including the architecture and the operating - system, for which the build is occurring in the context of the - current recipe. - - The OpenEmbedded build system automatically sets this variable based - on :term:`TARGET_ARCH`, - :term:`TARGET_VENDOR`, and - :term:`TARGET_OS` variables. - - .. note:: - - You do not need to set the ``TARGET_SYS`` variable yourself. - - Consider these two examples: - - - Given a native recipe on a 32-bit, x86 machine running Linux, the - value is "i686-linux". - - - Given a recipe being built for a little-endian, MIPS target - running Linux, the value might be "mipsel-linux". - - :term:`TARGET_VENDOR` - Specifies the name of the target vendor. - - :term:`TCLIBC` - Specifies the GNU standard C library (``libc``) variant to use during - the build process. This variable replaces ``POKYLIBC``, which is no - longer supported. - - You can select "glibc", "musl", "newlib", or "baremetal" - - :term:`TCLIBCAPPEND` - Specifies a suffix to be appended onto the - :term:`TMPDIR` value. The suffix identifies the - ``libc`` variant for building. When you are building for multiple - variants with the same :term:`Build Directory`, this - mechanism ensures that output for different ``libc`` variants is kept - separate to avoid potential conflicts. - - In the ``defaultsetup.conf`` file, the default value of - ``TCLIBCAPPEND`` is "-${TCLIBC}". However, distros such as poky, - which normally only support one ``libc`` variant, set - ``TCLIBCAPPEND`` to "" in their distro configuration file resulting - in no suffix being applied. - - :term:`TCMODE` - Specifies the toolchain selector. ``TCMODE`` 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 ``TCMODE`` 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 Release Notes for - the Yocto Project release for the specific components with which - the toolchain must be compatible. To access the Release Notes, go - to the :yocto_home:`Downloads ` - page on the Yocto Project website and click on the "RELEASE - INFORMATION" link for the appropriate release. - - The ``TCMODE`` variable is similar to :term:`TCLIBC`, - which controls the variant of the GNU standard C library (``libc``) - used during the build process: ``glibc`` or ``musl``. - - 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 Mentor Graphics - ``meta-sourcery`` layer at - http://github.com/MentorEmbedded/meta-sourcery/. - - The layer's ``README`` 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 ``bblayers.conf`` file in front of - the ``meta`` layer and then set the ``EXTERNAL_TOOLCHAIN`` variable - in your ``local.conf`` file to the location in which you installed - the toolchain. - - The fundamentals used for this example apply to any external - toolchain. You can use ``meta-sourcery`` as a template for adding - support for other external toolchains. - - :term:`TEST_EXPORT_DIR` - The location the OpenEmbedded build system uses to export tests when - the :term:`TEST_EXPORT_ONLY` variable is set - to "1". - - The ``TEST_EXPORT_DIR`` variable defaults to - ``"${TMPDIR}/testimage/${PN}"``. - - :term:`TEST_EXPORT_ONLY` - 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. - - :term:`TEST_LOG_DIR` - Holds the SSH log and the boot log for QEMU machines. The - ``TEST_LOG_DIR`` variable defaults to ``"${WORKDIR}/testimage"``. - - .. note:: - - Actual test results reside in the task log (``log.do_testimage``), - which is in the ``${WORKDIR}/temp/`` directory. - - :term:`TEST_POWERCONTROL_CMD` - 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. - - :term:`TEST_POWERCONTROL_EXTRA_ARGS` - For automated hardware testing, specifies additional arguments to - pass through to the command specified in - :term:`TEST_POWERCONTROL_CMD`. Setting - ``TEST_POWERCONTROL_EXTRA_ARGS`` is optional. You can use it if you - wish, for example, to separate the machine-specific and - non-machine-specific parts of the arguments. - - :term:`TEST_QEMUBOOT_TIMEOUT` - 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 ``local.conf`` - file. - - For more information on testing images, see the - ":ref:`dev-manual/common-tasks:performing automated runtime testing`" - section in the Yocto Project Development Tasks Manual. - - :term:`TEST_SERIALCONTROL_CMD` - 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. - - For example, to use the Picocom terminal program on serial device - ``/dev/ttyUSB0`` at 115200bps, you would set the variable as follows: - :: - - TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" - - :term:`TEST_SERIALCONTROL_EXTRA_ARGS` - For automated hardware testing, specifies additional arguments to - pass through to the command specified in - :term:`TEST_SERIALCONTROL_CMD`. Setting - ``TEST_SERIALCONTROL_EXTRA_ARGS`` is optional. You can use it if you - wish, for example, to separate the machine-specific and - non-machine-specific parts of the command. - - :term:`TEST_SERVER_IP` - 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 ``TEST_SERVER_IP`` variable is only used for a small number of - tests such as the "dnf" test suite, which needs to download packages - from ``WORKDIR/oe-rootfs-repo``. - - :term:`TEST_SUITES` - An ordered list of tests (modules) to run against an image when - performing automated runtime testing. - - 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. - - Tests include ``ping``, ``ssh``, ``df`` among others. You can add - your own tests to the list of tests by appending ``TEST_SUITES`` as - follows: - :: - - TEST_SUITES_append = " mytest" - - Alternatively, you can - provide the "auto" option to have all applicable tests run against - the image. - :: - - TEST_SUITES_append = " auto" - - Using this option causes the - build system to automatically run tests that are applicable to the - image. Tests that are not applicable are skipped. - - 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 (``test_A`` and ``test_B``) where ``test_B`` is dependent on - ``test_A``, then you must order the tests as follows: - :: - - TEST_SUITES = "test_A test_B" - - For more information on testing images, see the - ":ref:`dev-manual/common-tasks:performing automated runtime testing`" - section in the Yocto Project Development Tasks Manual. - - :term:`TEST_TARGET` - Specifies the target controller to use when running tests against a - test image. The default controller to use is "qemu": - :: - - TEST_TARGET = "qemu" - - 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 - ``/lib/oeqa/controllers`` directory and by inheriting the - ``BaseTarget`` class, which is an abstract class that cannot be used - as a value of ``TEST_TARGET``. - - You can provide the following arguments with ``TEST_TARGET``: - - - *"qemu":* Boots a QEMU image and runs the tests. See the - ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section - in the Yocto Project Development Tasks Manual for more - information. - - - *"simpleremote":* 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 - :term:`TEST_TARGET_IP` when you use - "simpleremote". - - .. note:: - - This argument is defined in - ``meta/lib/oeqa/controllers/simpleremote.py``. - - For information on running tests on hardware, see the - ":ref:`dev-manual/common-tasks:enabling runtime tests on hardware`" - section in the Yocto Project Development Tasks Manual. - - :term:`TEST_TARGET_IP` - The IP address of your hardware under test. The ``TEST_TARGET_IP`` - variable has no effect when :term:`TEST_TARGET` is - set to "qemu". - - When you specify the IP address, you can also include a port. Here is - an example: - :: - - TEST_TARGET_IP = "192.168.1.4:2201" - - 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. - - :term:`TESTIMAGE_AUTO` - Automatically runs the series of automated tests for images when an - image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes - any image that successfully builds to automatically boot under QEMU. - Using the variable also adds in dependencies so that any SDK for - which testing is requested is automatically built first. - - These tests are written in Python making use of the ``unittest`` - module, and the majority of them run commands on the target system - over ``ssh``. You can set this variable to "1" in your ``local.conf`` - file in the :term:`Build Directory` to have the - OpenEmbedded build system automatically run these tests after an - image successfully builds: - - TESTIMAGE_AUTO = "1" - - For more information - on enabling, running, and writing these tests, see the - ":ref:`dev-manual/common-tasks:performing automated runtime testing`" - section in the Yocto Project Development Tasks Manual and the - ":ref:`testimage*.bbclass `" section. - - :term:`THISDIR` - The directory in which the file BitBake is currently parsing is - located. Do not manually set this variable. - - :term:`TIME` - 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). - - :term:`TMPDIR` - 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 ``TMPDIR`` variable points to - ``tmp`` within the :term:`Build Directory`. - - If you want to establish this directory in a location other than the - default, you can uncomment and edit the following statement in the - ``conf/local.conf`` file in the :term:`Source Directory`: - :: - - #TMPDIR = "${TOPDIR}/tmp" - - An example use for this scenario is to set ``TMPDIR`` to a local disk, - which does not use NFS, while having the Build Directory use NFS. - - The filesystem used by ``TMPDIR`` 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, ``TMPDIR`` cannot be on NFS. - - :term:`TOOLCHAIN_HOST_TASK` - 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 :term:`SDKMACHINE`, and each - package should usually have the prefix ``nativesdk-``. For example, - consider the following command when building an SDK: - :: - - $ bitbake -c populate_sdk imagename - - In this case, a default list of packages is - set in this variable, but you can add additional packages to the - list. See the - ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section - in the Yocto Project Application Development and the Extensible - Software Development Kit (eSDK) manual for more information. - - For background information on cross-development toolchains in the - Yocto Project development environment, see the - ":ref:`sdk-manual/intro:the cross-development toolchain`" - section in the Yocto Project Overview and Concepts Manual. For - information on setting up a cross-development environment, see the - :doc:`/sdk-manual/index` manual. - - :term:`TOOLCHAIN_OUTPUTNAME` - This variable defines the name used for the toolchain output. The - :ref:`populate_sdk_base ` class sets - the ``TOOLCHAIN_OUTPUTNAME`` variable as follows: - :: - - TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" - - See - the :term:`SDK_NAME` and - :term:`SDK_VERSION` variables for additional - information. - - :term:`TOOLCHAIN_TARGET_TASK` - 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. Use this - variable to add individual packages to the part of the SDK that runs - on the target. See the - ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section - in the Yocto Project Application Development and the Extensible - Software Development Kit (eSDK) manual for more information. - - For background information on cross-development toolchains in the - Yocto Project development environment, see the - ":ref:`sdk-manual/intro:the cross-development toolchain`" - section in the Yocto Project Overview and Concepts Manual. For - information on setting up a cross-development environment, see the - :doc:`/sdk-manual/index` manual. - - :term:`TOPDIR` - The top-level :term:`Build Directory`. BitBake - automatically sets this variable when you initialize your build - environment using :ref:`structure-core-script`. - - :term:`TRANSLATED_TARGET_ARCH` - A sanitized version of :term:`TARGET_ARCH`. 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``. - - Do not edit this variable. - - :term:`TUNE_ARCH` - The GNU canonical architecture for a specific architecture (i.e. - ``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses - this value to setup configuration. - - ``TUNE_ARCH`` 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 ``README`` file. For example, the - ``meta/conf/machine/include/mips/README`` file in the - :term:`Source Directory` provides information for - ``TUNE_ARCH`` specific to the ``mips`` architecture. - - ``TUNE_ARCH`` is tied closely to - :term:`TARGET_ARCH`, which defines the target - machine's architecture. The BitBake configuration file - (``meta/conf/bitbake.conf``) sets ``TARGET_ARCH`` as follows: - :: - - TARGET_ARCH = "${TUNE_ARCH}" - - The following list, which is by no means complete since architectures - are configurable, shows supported machine architectures: - - - arm - - i586 - - x86_64 - - powerpc - - powerpc64 - - mips - - mipsel - - :term:`TUNE_ASARGS` - Specifies architecture-specific assembler flags for the target - system. The set of flags is based on the selected tune features. - ``TUNE_ASARGS`` is set using the tune include files, which are - typically under ``meta/conf/machine/include/`` and are influenced - through :term:`TUNE_FEATURES`. For example, the - ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags - for the x86 architecture as follows: - :: - - TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}" - - .. 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). - - :term:`TUNE_CCARGS` - Specifies architecture-specific C compiler flags for the target - system. The set of flags is based on the selected tune features. - ``TUNE_CCARGS`` is set using the tune include files, which are - typically under ``meta/conf/machine/include/`` and are influenced - through :term:`TUNE_FEATURES`. - - .. 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). - - :term:`TUNE_FEATURES` - 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. ``TUNE_*ARGS``) to be dynamically generated based on - the features. - - The OpenEmbedded build system verifies the features to be sure they - are not conflicting and that they are supported. - - The BitBake configuration file (``meta/conf/bitbake.conf``) defines - ``TUNE_FEATURES`` as follows: - :: - - TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" - - See the :term:`DEFAULTTUNE` variable for more information. - - :term:`TUNE_LDARGS` - Specifies architecture-specific linker flags for the target system. - The set of flags is based on the selected tune features. - ``TUNE_LDARGS`` is set using the tune include files, which are - typically under ``meta/conf/machine/include/`` and are influenced - through :term:`TUNE_FEATURES`. For example, the - ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags - for the x86 architecture as follows: - :: - - TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}" - - .. 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). - - :term:`TUNE_PKGARCH` - 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: - :: - - TUNE_PKGARCH_tune-tune = "tune" - - 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 ``meta/conf/machine/include/tune-core2.inc`` file: - :: - - TUNE_PKGARCH_tune-core2-32 = "core2-32" - - :term:`TUNEABI` - An underlying Application Binary Interface (ABI) used by a particular - tuning in a given toolchain layer. Providers that use prebuilt - libraries can use the ``TUNEABI``, - :term:`TUNEABI_OVERRIDE`, and - :term:`TUNEABI_WHITELIST` variables to check - compatibility of tunings against their selection of libraries. - - If ``TUNEABI`` is undefined, then every tuning is allowed. See the - :ref:`sanity ` class to see how the variable is - used. - - :term:`TUNEABI_OVERRIDE` - If set, the OpenEmbedded system ignores the - :term:`TUNEABI_WHITELIST` variable. - Providers that use prebuilt libraries can use the - ``TUNEABI_OVERRIDE``, ``TUNEABI_WHITELIST``, and - :term:`TUNEABI` variables to check compatibility of a - tuning against their selection of libraries. - - See the :ref:`sanity ` class to see how the - variable is used. - - :term:`TUNEABI_WHITELIST` - A whitelist of permissible :term:`TUNEABI` values. If - ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers - that use prebuilt libraries can use the ``TUNEABI_WHITELIST``, - :term:`TUNEABI_OVERRIDE`, and ``TUNEABI`` - variables to check compatibility of a tuning against their selection - of libraries. - - See the :ref:`sanity ` class to see how the - variable is used. - - :term:`TUNECONFLICTS[feature]` - Specifies CPU or Application Binary Interface (ABI) tuning features - that conflict with feature. - - Known tuning conflicts are specified in the machine include files in - the :term:`Source Directory`. Here is an example from - the ``meta/conf/machine/include/mips/arch-mips.inc`` include file - that lists the "o32" and "n64" features as conflicting with the "n32" - feature: - :: - - TUNECONFLICTS[n32] = "o32 n64" - - :term:`TUNEVALID[feature]` - 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. - ``meta/conf/machine/include/arm/arch-arm.inc``). Here is an example - from that file: - :: - - TUNEVALID[bigendian] = "Enable big-endian mode." - - See the machine include files in the :term:`Source Directory` - for these features. - - :term:`UBOOT_CONFIG` - Configures the :term:`UBOOT_MACHINE` and can - also define :term:`IMAGE_FSTYPES` for individual - cases. - - Following is an example from the ``meta-fsl-arm`` layer. :: - - 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" - - In this example, "sd" is selected as the configuration of the possible four for the - ``UBOOT_MACHINE``. The "sd" configuration defines - "mx6qsabreauto_config" as the value for ``UBOOT_MACHINE``, while the - "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-boot image. - - For more information on how the ``UBOOT_CONFIG`` is handled, see the - :ref:`uboot-config ` - class. - - :term:`UBOOT_DTB_LOADADDRESS` - Specifies the load address for the dtb image used by U-boot. During FIT - image creation, the ``UBOOT_DTB_LOADADDRESS`` variable is used in - :ref:`kernel-fitimage ` class to specify - the load address to be used in - creating the dtb sections of Image Tree Source for the FIT image. - - :term:`UBOOT_DTBO_LOADADDRESS` - Specifies the load address for the dtbo image used by U-boot. During FIT - image creation, the ``UBOOT_DTBO_LOADADDRESS`` variable is used in - :ref:`kernel-fitimage ` class to specify the load address to be used in - creating the dtbo sections of Image Tree Source for the FIT image. - - :term:`UBOOT_ENTRYPOINT` - Specifies the entry point for the U-Boot image. During U-Boot image - creation, the ``UBOOT_ENTRYPOINT`` variable is passed as a - command-line parameter to the ``uboot-mkimage`` utility. - - :term:`UBOOT_LOADADDRESS` - Specifies the load address for the U-Boot image. During U-Boot image - creation, the ``UBOOT_LOADADDRESS`` variable is passed as a - command-line parameter to the ``uboot-mkimage`` utility. - - :term:`UBOOT_LOCALVERSION` - 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: - :: - - UBOOT_LOCALVERSION = "-yocto" - - :term:`UBOOT_MACHINE` - Specifies the value passed on the ``make`` 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. ``conf/machine/machine_name.conf``). - - Please see the "Selection of Processor Architecture and Board Type" - section in the U-Boot README for valid values for this variable. - - :term:`UBOOT_MAKE_TARGET` - Specifies the target called in the ``Makefile``. The default target - is "all". - - :term:`UBOOT_MKIMAGE_DTCOPTS` - Options for the device tree compiler passed to mkimage '-D' - feature while creating FIT image in :ref:`kernel-fitimage ` class. - - :term:`UBOOT_RD_ENTRYPOINT` - Specifies the entrypoint for the RAM disk image. - During FIT image creation, the - ``UBOOT_RD_ENTRYPOINT`` variable is used - in :ref:`kernel-fitimage ` class to specify the - entrypoint to be used in creating the Image Tree Source for - the FIT image. - - :term:`UBOOT_RD_LOADADDRESS` - Specifies the load address for the RAM disk image. - During FIT image creation, the - ``UBOOT_RD_LOADADDRESS`` variable is used - in :ref:`kernel-fitimage ` class to specify the - load address to be used in creating the Image Tree Source for - the FIT image. - - :term:`UBOOT_SIGN_ENABLE` - Enable signing of FIT image. The default value is "0". - - :term:`UBOOT_SIGN_KEYDIR` - Location of the directory containing the RSA key and - certificate used for signing FIT image. - - :term:`UBOOT_SIGN_KEYNAME` - The name of keys used for signing U-boot FIT image stored in - :term:`UBOOT_SIGN_KEYDIR` directory. For e.g. dev.key key and dev.crt - certificate stored in :term:`UBOOT_SIGN_KEYDIR` directory will have - :term:`UBOOT_SIGN_KEYNAME` set to "dev". - - :term:`UBOOT_SUFFIX` - Points to the generated U-Boot extension. For example, ``u-boot.sb`` - has a ``.sb`` extension. - - The default U-Boot extension is ``.bin`` - - :term:`UBOOT_TARGET` - 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. - - :term:`UNKNOWN_CONFIGURE_WHITELIST` - Specifies a list of options that, if reported by the configure script - as being invalid, should not generate a warning during the - :ref:`ref-tasks-configure` task. Normally, invalid - configure options are simply not passed to the configure script (e.g. - should be removed from :term:`EXTRA_OECONF` or - :term:`PACKAGECONFIG_CONFARGS`). - 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 ``UNKNOWN_CONFIGURE_WHITELIST``. - - The configure arguments check that uses - ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the - :ref:`insane ` class and is only enabled if the - recipe inherits the :ref:`autotools ` class. - - :term:`UPDATERCPN` - For recipes inheriting the - :ref:`update-rc.d ` class, ``UPDATERCPN`` - specifies the package that contains the initscript that is enabled. - - 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. - - :term:`UPSTREAM_CHECK_GITTAGREGEX` - You can perform a per-recipe check for what the latest upstream - source code version is by calling ``bitbake -c checkpkg`` recipe. If - the recipe source code is provided from Git repositories, the - OpenEmbedded build system determines the latest upstream version by - picking the latest tag from the list of all repository tags. - - You can use the ``UPSTREAM_CHECK_GITTAGREGEX`` variable to provide a - regular expression to filter only the relevant tags should the - default filter not work correctly. - :: - - UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" - - :term:`UPSTREAM_CHECK_REGEX` - Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different - regular expression instead of the default one when the package - checking system is parsing the page found using - :term:`UPSTREAM_CHECK_URI`. - :: - - UPSTREAM_CHECK_REGEX = "package_regex" - - :term:`UPSTREAM_CHECK_URI` - You can perform a per-recipe check for what the latest upstream - source code version is by calling ``bitbake -c checkpkg`` recipe. If - the source code is provided from tarballs, the latest version is - determined by fetching the directory listing where the tarball is and - attempting to find a later tarball. When this approach does not work, - you can use ``UPSTREAM_CHECK_URI`` to provide a different URI that - contains the link to the latest tarball. - :: - - UPSTREAM_CHECK_URI = "recipe_url" - - :term:`USE_DEVFS` - Determines if ``devtmpfs`` is used for ``/dev`` population. The - default value used for ``USE_DEVFS`` is "1" when no value is - specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a - statically populated ``/dev`` directory. - - See the ":ref:`dev-manual/common-tasks:selecting a device manager`" section in - the Yocto Project Development Tasks Manual for information on how to - use this variable. - - :term:`USE_VT` - When using - :ref:`SysVinit `, - determines whether or not to run a - `getty `__ on any - virtual terminals in order to enable logging in through those - terminals. - - The default value used for ``USE_VT`` is "1" when no default value is - specifically set. Typically, you would set ``USE_VT`` 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. - - :term:`USER_CLASSES` - A list of classes to globally inherit. These classes are used by the - OpenEmbedded build system to enable extra features (e.g. - ``buildstats``, ``image-mklibs``, and so forth). - - The default list is set in your ``local.conf`` file: - :: - - USER_CLASSES ?= "buildstats image-mklibs image-prelink" - - For more information, see - ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`. - - :term:`USERADD_ERROR_DYNAMIC` - If set to ``error``, forces the OpenEmbedded build system to produce - an error if the user identification (``uid``) and group - identification (``gid``) values are not defined in any of the files - listed in :term:`USERADD_UID_TABLES` and - :term:`USERADD_GID_TABLES`. If set to - ``warn``, a warning will be issued instead. - - The default behavior for the build system is to dynamically apply - ``uid`` and ``gid`` values. Consequently, the - ``USERADD_ERROR_DYNAMIC`` variable is by default not set. If you plan - on using statically assigned ``gid`` and ``uid`` values, you should - set the ``USERADD_ERROR_DYNAMIC`` variable in your ``local.conf`` - file as follows: - :: - - USERADD_ERROR_DYNAMIC = "error" - - Overriding the - default behavior implies you are going to also take steps to set - static ``uid`` and ``gid`` values through use of the - :term:`USERADDEXTENSION`, - :term:`USERADD_UID_TABLES`, and - :term:`USERADD_GID_TABLES` variables. - - .. note:: - - There is a difference in behavior between setting - ``USERADD_ERROR_DYNAMIC`` to ``error`` and setting it to ``warn``. - When it is set to ``warn``, the build system will report a warning for - every undefined ``uid`` and ``gid`` in any recipe. But when it is set - to ``error``, it will only report errors for recipes that are actually - built. - This saves you from having to add static IDs for recipes that you - know will never be built. - - :term:`USERADD_GID_TABLES` - 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. - - When applying static group identification (``gid``) values, the - OpenEmbedded build system looks in :term:`BBPATH` for a - ``files/group`` file and then applies those ``uid`` values. Set the - variable as follows in your ``local.conf`` file: - :: - - - USERADD_GID_TABLES = "files/group" - - .. note:: - - Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids" - causes the build system to use static ``gid`` values. - - :term:`USERADD_PACKAGES` - When inheriting the :ref:`useradd ` class, - this variable specifies the individual packages within the recipe - that require users and/or groups to be added. - - 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: - :: - - USERADD_PACKAGES = "${PN}" - - .. note:: - - It follows that if you are going to use the ``USERADD_PACKAGES`` - variable, you need to set one or more of the :term:`USERADD_PARAM`, - :term:`GROUPADD_PARAM`, or :term:`GROUPMEMS_PARAM` variables. - - :term:`USERADD_PARAM` - When inheriting the :ref:`useradd ` class, - this variable specifies for a package what parameters should pass to - the ``useradd`` command if you add a user to the system when the - package is installed. - - Here is an example from the ``dbus`` recipe: - :: - - USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \ - --no-create-home --shell /bin/false \ - --user-group messagebus" - - For information on the - standard Linux shell command ``useradd``, see - http://linux.die.net/man/8/useradd. - - :term:`USERADD_UID_TABLES` - 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. - - When applying static user identification (``uid``) values, the - OpenEmbedded build system looks in :term:`BBPATH` for a - ``files/passwd`` file and then applies those ``uid`` values. Set the - variable as follows in your ``local.conf`` file: - :: - - USERADD_UID_TABLES = "files/passwd" - - .. note:: - - Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids" - causes the build system to use static ``uid`` values. - - :term:`USERADDEXTENSION` - 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 :term:`BBPATH`. - - To use static user identification (``uid``) and group identification - (``gid``) values, set the variable as follows in your ``local.conf`` - file: USERADDEXTENSION = "useradd-staticids" - - .. note:: - - Setting this variable to use static ``uid`` and ``gid`` - values causes the OpenEmbedded build system to employ the - :ref:`ref-classes-useradd` class. - - If you use static ``uid`` and ``gid`` information, you must also - specify the ``files/passwd`` and ``files/group`` files by setting the - :term:`USERADD_UID_TABLES` and - :term:`USERADD_GID_TABLES` variables. - Additionally, you should also set the - :term:`USERADD_ERROR_DYNAMIC` variable. - - :term:`VOLATILE_LOG_DIR` - Specifies the persistence of the target's ``/var/log`` directory, - which is used to house postinstall target log files. - - By default, ``VOLATILE_LOG_DIR`` is set to "yes", which means the - file is not persistent. You can override this setting by setting the - variable to "no" to make the log directory persistent. - - :term:`WARN_QA` - 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 - ":ref:`insane.bbclass `" section. - - :term:`WKS_FILE` - Specifies the location of the Wic kickstart file that is used by the - OpenEmbedded build system to create a partitioned image - (image\ ``.wic``). For information on how to create a partitioned - image, see the - ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" - section in the Yocto Project Development Tasks Manual. For details on - the kickstart file format, see the ":doc:`/ref-manual/ref-kickstart`" Chapter. - - :term:`WKS_FILE_DEPENDS` - When placed in the recipe that builds your image, this variable lists - build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only - applicable when Wic images are active (i.e. when - :term:`IMAGE_FSTYPES` contains entries related - to Wic). If your recipe does not create Wic images, the variable has - no effect. - - The ``WKS_FILE_DEPENDS`` variable is similar to the - :term:`DEPENDS` variable. When you use the variable in - your recipe that builds the Wic image, dependencies you list in the - ``WIC_FILE_DEPENDS`` variable are added to the ``DEPENDS`` variable. - - With the ``WKS_FILE_DEPENDS`` variable, you have the possibility to - specify a list of additional dependencies (e.g. native tools, - bootloaders, and so forth), that are required to build Wic images. - Following is an example: - :: - - WKS_FILE_DEPENDS = "some-native-tool" - - In the - previous example, some-native-tool would be replaced with an actual - native tool on which the build would depend. - - :term:`WORKDIR` - The pathname of the work directory in which the OpenEmbedded build - system builds a recipe. This directory is located within the - :term:`TMPDIR` directory structure and is specific to - the recipe being built and the system for which it is being built. - - The ``WORKDIR`` directory is defined as follows: - :: - - ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} - - The actual directory depends on several things: - - - :term:`TMPDIR`: The top-level build output directory - - :term:`MULTIMACH_TARGET_SYS`: The target system identifier - - :term:`PN`: The recipe name - - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which - is usually the case for most recipes, then `EXTENDPE` is blank) - - :term:`PV`: The recipe version - - :term:`PR`: The recipe revision - - As an example, assume a Source Directory top-level folder name - ``poky``, a default Build Directory at ``poky/build``, and a - ``qemux86-poky-linux`` machine target system. Furthermore, suppose - your recipe is named ``foo_1.3.0-r0.bb``. In this case, the work - directory the build system uses to build the package would be as - follows: - :: - - poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 - - :term:`XSERVER` - Specifies the packages that should be installed to provide an X - server and drivers for the current machine, assuming your image - directly includes ``packagegroup-core-x11-xserver`` or, perhaps - indirectly, includes "x11-base" in - :term:`IMAGE_FEATURES`. - - The default value of ``XSERVER``, if not specified in the machine - configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". - diff --git a/documentation/ref-manual/ref-varlocality.rst b/documentation/ref-manual/ref-varlocality.rst deleted file mode 100644 index 5f7dba8775..0000000000 --- a/documentation/ref-manual/ref-varlocality.rst +++ /dev/null @@ -1,166 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -**************** -Variable Context -**************** - -While you can use most variables in almost any context such as -``.conf``, ``.bbclass``, ``.inc``, and ``.bb`` files, some variables are -often associated with a particular locality or context. This chapter -describes some common associations. - -.. _ref-varlocality-configuration: - -Configuration -============= - -The following subsections provide lists of variables whose context is -configuration: distribution, machine, and local. - -.. _ref-varlocality-config-distro: - -Distribution (Distro) ---------------------- - -This section lists variables whose configuration context is the -distribution, or distro. - -- :term:`DISTRO` - -- :term:`DISTRO_NAME` - -- :term:`DISTRO_VERSION` - -- :term:`MAINTAINER` - -- :term:`PACKAGE_CLASSES` - -- :term:`TARGET_OS` - -- :term:`TARGET_FPU` - -- :term:`TCMODE` - -- :term:`TCLIBC` - -.. _ref-varlocality-config-machine: - -Machine -------- - -This section lists variables whose configuration context is the machine. - -- :term:`TARGET_ARCH` - -- :term:`SERIAL_CONSOLES` - -- :term:`PACKAGE_EXTRA_ARCHS` - -- :term:`IMAGE_FSTYPES` - -- :term:`MACHINE_FEATURES` - -- :term:`MACHINE_EXTRA_RDEPENDS` - -- :term:`MACHINE_EXTRA_RRECOMMENDS` - -- :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS` - -- :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` - -.. _ref-varlocality-config-local: - -Local ------ - -This section lists variables whose configuration context is the local -configuration through the ``local.conf`` file. - -- :term:`DISTRO` - -- :term:`MACHINE` - -- :term:`DL_DIR` - -- :term:`BBFILES` - -- :term:`EXTRA_IMAGE_FEATURES` - -- :term:`PACKAGE_CLASSES` - -- :term:`BB_NUMBER_THREADS` - -- :term:`BBINCLUDELOGS` - -- :term:`ENABLE_BINARY_LOCALE_GENERATION` - -.. _ref-varlocality-recipes: - -Recipes -======= - -The following subsections provide lists of variables whose context is -recipes: required, dependencies, path, and extra build information. - -.. _ref-varlocality-recipe-required: - -Required --------- - -This section lists variables that are required for recipes. - -- :term:`LICENSE` - -- :term:`LIC_FILES_CHKSUM` - -- :term:`SRC_URI` - used in recipes that fetch local or remote files. - -.. _ref-varlocality-recipe-dependencies: - -Dependencies ------------- - -This section lists variables that define recipe dependencies. - -- :term:`DEPENDS` - -- :term:`RDEPENDS` - -- :term:`RRECOMMENDS` - -- :term:`RCONFLICTS` - -- :term:`RREPLACES` - -.. _ref-varlocality-recipe-paths: - -Paths ------ - -This section lists variables that define recipe paths. - -- :term:`WORKDIR` - -- :term:`S` - -- :term:`FILES` - -.. _ref-varlocality-recipe-build: - -Extra Build Information ------------------------ - -This section lists variables that define extra build information for -recipes. - -- :term:`DEFAULT_PREFERENCE` - -- :term:`EXTRA_OECMAKE` - -- :term:`EXTRA_OECONF` - -- :term:`EXTRA_OEMAKE` - -- :term:`PACKAGECONFIG_CONFARGS` - -- :term:`PACKAGES` diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst new file mode 100644 index 0000000000..d8d362282b --- /dev/null +++ b/documentation/ref-manual/release-process.rst @@ -0,0 +1,191 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +***************************************************** +Yocto Project Releases and the Stable Release Process +***************************************************** + +The Yocto Project release process is predictable and consists of both +major and minor (point) releases. This brief chapter provides +information on how releases are named, their life cycle, and their +stability. + +Major and Minor Release Cadence +=============================== + +The Yocto Project delivers major releases (e.g. DISTRO) using a six +month cadence roughly timed each April and October of the year. +Following are examples of some major YP releases with their codenames +also shown. See the "`Major Release +Codenames <#major-release-codenames>`__" section for information on +codenames used with major releases. + + - 2.2 (Morty) + - 2.1 (Krogoth) + - 2.0 (Jethro) + +While the cadence is never perfect, this timescale facilitates +regular releases that have strong QA cycles while not overwhelming users +with too many new releases. The cadence is predictable and avoids many +major holidays in various geographies. + +The Yocto project delivers minor (point) releases on an unscheduled +basis and are usually driven by the accumulation of enough significant +fixes or enhancements to the associated major release. Following are +some example past point releases: + + - 2.1.1 + - 2.1.2 + - 2.2.1 + +The point release +indicates a point in the major release branch where a full QA cycle and +release process validates the content of the new branch. + +.. note:: + + Realize that there can be patches merged onto the stable release + branches as and when they become available. + +Major Release Codenames +======================= + +Each major release receives a codename that identifies the release in +the :ref:`overview-manual/development-environment:yocto project source repositories`. +The concept is that branches of :term:`Metadata` with the same +codename are likely to be compatible and thus work together. + +.. note:: + + Codenames are associated with major releases because a Yocto Project + release number (e.g. DISTRO) could conflict with a given layer or + company versioning scheme. Codenames are unique, interesting, and + easily identifiable. + +Releases are given a nominal release version as well but the codename is +used in repositories for this reason. You can find information on Yocto +Project releases and codenames at +:yocto_wiki:`/Releases`. + +Stable Release Process +====================== + +Once released, the release enters the stable release process at which +time a person is assigned as the maintainer for that stable release. +This maintainer monitors activity for the release by investigating and +handling nominated patches and backport activity. Only fixes and +enhancements that have first been applied on the "master" branch (i.e. +the current, in-development branch) are considered for backporting to a +stable release. + +.. note:: + + The current Yocto Project policy regarding backporting is to consider + bug fixes and security fixes only. Policy dictates that features are + not backported to a stable release. This policy means generic recipe + version upgrades are unlikely to be accepted for backporting. The + exception to this policy occurs when a strong reason exists such as + the fix happens to also be the preferred upstream approach. + +Stable release branches have strong maintenance for about a year after +their initial release. Should significant issues be found for any +release regardless of its age, fixes could be backported to older +releases. For issues that are not backported given an older release, +Community LTS trees and branches exist where community members share +patches for older releases. However, these types of patches do not go +through the same release process as do point releases. You can find more +information about stable branch maintenance at +:yocto_wiki:`/Stable_branch_maintenance`. + +Testing and Quality Assurance +============================= + +Part of the Yocto Project development and release process is quality +assurance through the execution of test strategies. Test strategies +provide the Yocto Project team a way to ensure a release is validated. +Additionally, because the test strategies are visible to you as a +developer, you can validate your projects. This section overviews the +available test infrastructure used in the Yocto Project. For information +on how to run available tests on your projects, see the +":ref:`dev-manual/common-tasks:performing automated runtime testing`" +section in the Yocto Project Development Tasks Manual. + +The QA/testing infrastructure is woven into the project to the point +where core developers take some of it for granted. The infrastructure +consists of the following pieces: + +- ``bitbake-selftest``: A standalone command that runs unit tests on + key pieces of BitBake and its fetchers. + +- :ref:`sanity.bbclass `: This automatically + included class checks the build environment for missing tools (e.g. + ``gcc``) or common misconfigurations such as + :term:`MACHINE` set incorrectly. + +- :ref:`insane.bbclass `: This class checks the + generated output from builds for sanity. For example, if building for + an ARM target, did the build produce ARM binaries. If, for example, + the build produced PPC binaries then there is a problem. + +- :ref:`testimage.bbclass `: This class + performs runtime testing of images after they are built. The tests + are usually used with :doc:`QEMU ` + to boot the images and check the combined runtime result boot + operation and functions. However, the test can also use the IP + address of a machine to test. + +- :ref:`ptest `: + Runs tests against packages produced during the build for a given + piece of software. The test allows the packages to be be run within a + target image. + +- ``oe-selftest``: Tests combination BitBake invocations. These tests + operate outside the OpenEmbedded build system itself. The + ``oe-selftest`` can run all tests by default or can run selected + tests or test suites. + + .. note:: + + Running ``oe-selftest`` requires host packages beyond the "Essential" + grouping. See the :ref:`ref-manual/system-requirements:required packages for the build host` + section for more information. + +Originally, much of this testing was done manually. However, significant +effort has been made to automate the tests so that more people can use +them and the Yocto Project development team can run them faster and more +efficiently. + +The Yocto Project's main Autobuilder (&YOCTO_AB_URL;) +publicly tests each Yocto Project release's code in the +:term:`OpenEmbedded-Core (OE-Core)`, Poky, and BitBake repositories. The testing +occurs for both the current state of the "master" branch and also for +submitted patches. Testing for submitted patches usually occurs in the +"ross/mut" branch in the ``poky-contrib`` repository (i.e. the +master-under-test branch) or in the "master-next" branch in the ``poky`` +repository. + +.. note:: + + You can find all these branches in the Yocto Project + Source Repositories + . + +Testing within these public branches ensures in a publicly visible way +that all of the main supposed architectures and recipes in OE-Core +successfully build and behave properly. + +Various features such as ``multilib``, sub architectures (e.g. ``x32``, +``poky-tiny``, ``musl``, ``no-x11`` and and so forth), +``bitbake-selftest``, and ``oe-selftest`` are tested as part of the QA +process of a release. Complete testing and validation for a release +takes the Autobuilder workers several hours. + +.. note:: + + The Autobuilder workers are non-homogeneous, which means regular + testing across a variety of Linux distributions occurs. The + Autobuilder is limited to only testing QEMU-based setups and not real + hardware. + +Finally, in addition to the Autobuilder's tests, the Yocto Project QA +team also performs testing on a variety of platforms, which includes +actual hardware, to ensure expected results. diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst new file mode 100644 index 0000000000..ad3f4ab44a --- /dev/null +++ b/documentation/ref-manual/structure.rst @@ -0,0 +1,874 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +************************** +Source Directory Structure +************************** + +The :term:`Source Directory` consists of numerous files, +directories and subdirectories; understanding their locations and +contents is key to using the Yocto Project effectively. This chapter +describes the Source Directory and gives information about those files +and directories. + +For information on how to establish a local Source Directory on your +development system, see the +":ref:`dev-manual/start:locating yocto project source files`" +section in the Yocto Project Development Tasks Manual. + +.. 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. + +.. _structure-core: + +Top-Level Core Components +========================= + +This section describes the top-level components of the :term:`Source Directory`. + +.. _structure-core-bitbake: + +``bitbake/`` +------------ + +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 :term:`Metadata` interpreter, reads the +Yocto Project Metadata and runs the tasks defined by that data. Failures +are usually caused by errors in your Metadata and not from BitBake +itself; consequently, most users do not need to worry about BitBake. + +When you run the ``bitbake`` command, the main BitBake executable (which +resides in the ``bitbake/bin/`` directory) starts. Sourcing the +environment setup script (i.e. :ref:`structure-core-script`) places +the ``scripts/`` and ``bitbake/bin/`` directories (in that order) into +the shell's ``PATH`` environment variable. + +For more information on BitBake, see the :doc:`BitBake User Manual +`. + +.. _structure-core-build: + +``build/`` +---------- + +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 :term:`Build Directory` +is created initially when you ``source`` +the OpenEmbedded build environment setup script (i.e. +:ref:`structure-core-script`). + +It is also possible to place output and configuration files in a +directory separate from the :term:`Source Directory` by +providing a directory name when you ``source`` the setup script. For +information on separating output from your local Source Directory files +(commonly described as an "out of tree" build), see the +":ref:`structure-core-script`" section. + +.. _handbook: + +``documentation/`` +------------------ + +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 its own sub-folder; +for example, the files for this reference manual reside in the +``ref-manual/`` directory. + +.. _structure-core-meta: + +``meta/`` +--------- + +This directory contains the minimal, underlying OpenEmbedded-Core +metadata. The directory holds recipes, common classes, and machine +configuration for strictly emulated targets (``qemux86``, ``qemuarm``, +and so forth.) + +.. _structure-core-meta-poky: + +``meta-poky/`` +-------------- + +Designed above the ``meta/`` content, this directory adds just enough +metadata to define the Poky reference distribution. + +.. _structure-core-meta-yocto-bsp: + +``meta-yocto-bsp/`` +------------------- + +This directory contains the Yocto Project reference hardware Board +Support Packages (BSPs). For more information on BSPs, see the +:doc:`/bsp-guide/index`. + +.. _structure-meta-selftest: + +``meta-selftest/`` +------------------ + +This directory adds additional recipes and append files used by the +OpenEmbedded selftests to verify the behavior of the build system. You +do not have to add this layer to your ``bblayers.conf`` file unless you +want to run the selftests. + +.. _structure-meta-skeleton: + +``meta-skeleton/`` +------------------ + +This directory contains template recipes for BSP and kernel development. + +.. _structure-core-scripts: + +``scripts/`` +------------ + +This directory contains various integration scripts that implement extra +functionality in the Yocto Project environment (e.g. QEMU scripts). The +:ref:`structure-core-script` script prepends this directory to the +shell's ``PATH`` environment variable. + +The ``scripts`` directory has useful scripts that assist in contributing +back to the Yocto Project, such as ``create-pull-request`` and +``send-pull-request``. + +.. _structure-core-script: + +``oe-init-build-env`` +--------------------- + +This script sets up the OpenEmbedded build environment. Running this +script with the ``source`` command in a shell makes changes to ``PATH`` +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 ``scripts`` +directory to do the bulk of the work. + +When you run this script, your Yocto Project environment is set up, a +:term:`Build Directory` is created, your working +directory becomes the Build Directory, and you are presented with some +simple suggestions as to what to do next, including a list of some +possible targets to build. Here is an example: +:: + + $ source oe-init-build-env + + ### Shell environment set up for builds. ### + + You can now run 'bitbake ' + + 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-64' + +The default output of the ``oe-init-build-env`` script is from the +``conf-notes.txt`` file, which is found in the ``meta-poky`` directory +within the :term:`Source Directory`. If you design a +custom distribution, you can include your own version of this +configuration file to mention the targets defined by your distribution. +See the +":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" +section in the Yocto Project Development Tasks Manual for more +information. + +By default, running this script without a Build Directory argument +creates the ``build/`` directory in your current working directory. If +you provide a Build Directory argument when you ``source`` 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 ``mybuilds/`` that is outside of the :term:`Source Directory`: +:: + + $ source oe-init-build-env ~/mybuilds + +The OpenEmbedded build system uses the template configuration files, which +are found by default in the ``meta-poky/conf/`` directory in the Source +Directory. See the +":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" +section in the Yocto Project Development Tasks 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 ``oe-init-build-env`` + 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. + +.. _structure-basic-top-level: + +``LICENSE, README, and README.hardware`` +---------------------------------------- + +These files are standard top-level files. + +.. _structure-build: + +The Build Directory - ``build/`` +================================ + +The OpenEmbedded build system creates the :term:`Build Directory` +when you run the build environment setup +script :ref:`structure-core-script`. If you do not give the Build +Directory a specific name when you run the setup script, the name +defaults to ``build/``. + +For subsequent parsing and processing, the name of the Build directory +is available via the :term:`TOPDIR` variable. + +.. _structure-build-buildhistory: + +``build/buildhistory/`` +----------------------- + +The OpenEmbedded build system creates this directory when you enable +build history via the ``buildhistory`` class file. The directory +organizes build information into image, packages, and SDK +subdirectories. For information on the build history feature, see the +":ref:`dev-manual/common-tasks:maintaining build output quality`" +section in the Yocto Project Development Tasks Manual. + +.. _structure-build-conf-local.conf: + +``build/conf/local.conf`` +------------------------- + +This configuration file contains all the local user configurations for +your build environment. The ``local.conf`` 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 such variables are +relatively rare. + +At a minimum, you would normally edit this file to select the target +``MACHINE``, which package types you wish to use +(:term:`PACKAGE_CLASSES`), and the location from +which you want to access downloaded files (``DL_DIR``). + +If ``local.conf`` is not present when you start the build, the +OpenEmbedded build system creates it from ``local.conf.sample`` when you +``source`` the top-level build environment setup script +:ref:`structure-core-script`. + +The source ``local.conf.sample`` file used depends on the +``$TEMPLATECONF`` script variable, which defaults to ``meta-poky/conf/`` +when you are building from the Yocto Project development environment, +and to ``meta/conf/`` when you are building from the OpenEmbedded-Core +environment. Because the script variable points to the source of the +``local.conf.sample`` 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: +:: + + TEMPLATECONF=your_layer/conf + +Once the build process gets the sample +file, it uses ``sed`` to substitute final +``${``\ :term:`OEROOT`\ ``}`` values for all +``##OEROOT##`` values. + +.. note:: + + You can see how the ``TEMPLATECONF`` variable is used by looking at the + ``scripts/oe-setup-builddir``` script in the :term:`Source Directory`. + You can find the Yocto Project version of the ``local.conf.sample`` file in + the ``meta-poky/conf`` directory. + +.. _structure-build-conf-bblayers.conf: + +``build/conf/bblayers.conf`` +---------------------------- + +This configuration file defines +:ref:`layers `, +which are directory trees, traversed (or walked) by BitBake. The +``bblayers.conf`` file uses the :term:`BBLAYERS` +variable to list the layers BitBake tries to find. + +If ``bblayers.conf`` is not present when you start the build, the +OpenEmbedded build system creates it from ``bblayers.conf.sample`` when +you ``source`` the top-level build environment setup script (i.e. +:ref:`structure-core-script`). + +As with the ``local.conf`` file, the source ``bblayers.conf.sample`` +file used depends on the ``$TEMPLATECONF`` script variable, which +defaults to ``meta-poky/conf/`` when you are building from the Yocto +Project development environment, and to ``meta/conf/`` when you are +building from the OpenEmbedded-Core environment. Because the script +variable points to the source of the ``bblayers.conf.sample`` 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: +:: + + TEMPLATECONF=your_layer/conf + +Once the build process gets the sample file, it uses ``sed`` to substitute final +``${``\ :term:`OEROOT`\ ``}`` values for all ``##OEROOT##`` values. + +.. note:: + + You can see how the ``TEMPLATECONF`` variable ``scripts/oe-setup-builddir`` + script in the :term:`Source Directory`. You can find the Yocto Project + version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/`` + directory. + +.. _structure-build-conf-sanity_info: + +``build/cache/sanity_info`` +--------------------------- + +This file indicates the state of the sanity checks and is created during +the build. + +.. _structure-build-downloads: + +``build/downloads/`` +-------------------- + +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 +``DL_DIR`` variable. + +.. _structure-build-sstate-cache: + +``build/sstate-cache/`` +----------------------- + +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 +``SSTATE_DIR`` variable. + +.. _structure-build-tmp: + +``build/tmp/`` +-------------- + +The OpenEmbedded build system creates and uses this directory for all +the build system's output. The :term:`TMPDIR` variable +points to this directory. + +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 ``tmp`` directory or get +rid of the directory completely. If you do, you should also completely +remove the ``build/sstate-cache`` directory. + +.. _structure-build-tmp-buildstats: + +``build/tmp/buildstats/`` +------------------------- + +This directory stores the build statistics. + +.. _structure-build-tmp-cache: + +``build/tmp/cache/`` +-------------------- + +When BitBake parses the metadata (recipes and configuration files), it +caches the results in ``build/tmp/cache/`` to speed up future builds. +The results are stored on a per-machine basis. + +During subsequent builds, BitBake checks each recipe (together with, for +example, any files included or appended to it) to see if they have been +modified. Changes can be detected, for example, through file +modification time (mtime) changes and hashing of file contents. If no +changes to the file are detected, then the parsed result stored in the +cache is reused. If the file has changed, it is reparsed. + +.. _structure-build-tmp-deploy: + +``build/tmp/deploy/`` +--------------------- + +This directory contains any "end result" output from the OpenEmbedded +build process. The :term:`DEPLOY_DIR` variable points +to this directory. For more detail on the contents of the ``deploy`` +directory, see the +":ref:`overview-manual/concepts:images`" and +":ref:`overview-manual/concepts:application development sdk`" sections in the Yocto +Project Overview and Concepts Manual. + +.. _structure-build-tmp-deploy-deb: + +``build/tmp/deploy/deb/`` +------------------------- + +This directory receives any ``.deb`` packages produced by the build +process. The packages are sorted into feeds for different architecture +types. + +.. _structure-build-tmp-deploy-rpm: + +``build/tmp/deploy/rpm/`` +------------------------- + +This directory receives any ``.rpm`` packages produced by the build +process. The packages are sorted into feeds for different architecture +types. + +.. _structure-build-tmp-deploy-ipk: + +``build/tmp/deploy/ipk/`` +------------------------- + +This directory receives ``.ipk`` packages produced by the build process. + +.. _structure-build-tmp-deploy-licenses: + +``build/tmp/deploy/licenses/`` +------------------------------ + +This directory receives package licensing information. For example, the +directory contains sub-directories for ``bash``, ``busybox``, and +``glibc`` (among others) that in turn contain appropriate ``COPYING`` +license files with other licensing information. For information on +licensing, see the +":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" +section in the Yocto Project Development Tasks Manual. + +.. _structure-build-tmp-deploy-images: + +``build/tmp/deploy/images/`` +---------------------------- + +This directory is populated with the basic output objects of the build +(think of them as the "generated artifacts" of the build process), +including things like the boot loader image, kernel, root filesystem and +more. If you want to flash the resulting image from a build onto a +device, look here for the necessary components. + +Be careful when deleting files in this directory. You can safely delete +old images from this directory (e.g. ``core-image-*``). However, the +kernel (``*zImage*``, ``*uImage*``, 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. + +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: +:: + + $ bitbake -c clean virtual/kernel + $ bitbake virtual/kernel + +.. _structure-build-tmp-deploy-sdk: + +``build/tmp/deploy/sdk/`` +------------------------- + +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 ":ref:`sdk-manual/appendix-obtain:building an sdk installer`" +section in the Yocto Project Application Development and the Extensible +Software Development Kit (eSDK) manual. + +.. _structure-build-tmp-sstate-control: + +``build/tmp/sstate-control/`` +----------------------------- + +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. + +.. _structure-build-tmp-sysroots-components: + +``build/tmp/sysroots-components/`` +---------------------------------- + +This directory is the location of the sysroot contents that the task +:ref:`ref-tasks-prepare_recipe_sysroot` +links or copies into the recipe-specific sysroot for each recipe listed +in :term:`DEPENDS`. Population of this directory is +handled through shared state, while the path is specified by the +:term:`COMPONENTS_DIR` variable. Apart from a few +unusual circumstances, handling of the ``sysroots-components`` directory +should be automatic, and recipes should not directly reference +``build/tmp/sysroots-components``. + +.. _structure-build-tmp-sysroots: + +``build/tmp/sysroots/`` +----------------------- + +Previous versions of the OpenEmbedded build system used to create a +global shared sysroot per machine along with a native sysroot. Beginning +with the 2.3 version of the Yocto Project, sysroots exist in +recipe-specific :term:`WORKDIR` directories. Thus, the +``build/tmp/sysroots/`` directory is unused. + +.. note:: + + The ``build/tmp/sysroots/`` directory can still be populated using the + ``bitbake build-sysroots`` command and can be used for compatibility in some + cases. However, in general it is not recommended to populate this directory. + Individual recipe-specific sysroots should be used. + +.. _structure-build-tmp-stamps: + +``build/tmp/stamps/`` +--------------------- + +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: +:: + + stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do + +Although the files in the directory are empty of data, BitBake uses the filenames +and timestamps for tracking purposes. + +For information on how BitBake uses stamp files to determine if a task +should be rerun, see the +":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`" +section in the Yocto Project Overview and Concepts Manual. + +.. _structure-build-tmp-log: + +``build/tmp/log/`` +------------------ + +This directory contains general logs that are not otherwise placed using +the package's ``WORKDIR``. Examples of logs are the output from the +``do_check_pkg`` or ``do_distro_check`` tasks. Running a build does not +necessarily mean this directory is created. + +.. _structure-build-tmp-work: + +``build/tmp/work/`` +------------------- + +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 +:term:`WORKDIR`. + +It is worth considering the structure of a typical work directory. As an +example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86`` +built within the Yocto Project. For this package, a work directory of +``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred +to as the ``WORKDIR``, is created. Within this directory, the source is +unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. +(See the ":ref:`dev-manual/common-tasks:using quilt in your workflow`" section in +the Yocto Project Development Tasks Manual for more information.) Within +the ``linux-qemux86-standard-build`` directory, standard Quilt +directories ``linux-3.0/patches`` and ``linux-3.0/.pc`` are created, and +standard Quilt commands can be used. + +There are other directories generated within ``WORKDIR``. The most +important directory is ``WORKDIR/temp/``, which has log files for each +task (``log.do_*.pid``) and contains the scripts BitBake runs for each +task (``run.do_*.pid``). The ``WORKDIR/image/`` directory is where "make +install" places its output that is then split into sub-packages within +``WORKDIR/packages-split/``. + +.. _structure-build-tmp-work-tunearch-recipename-version: + +``build/tmp/work/tunearch/recipename/version/`` +----------------------------------------------- + +The recipe work directory - ``${WORKDIR}``. + +As described earlier in the +":ref:`structure-build-tmp-sysroots`" section, +beginning with the 2.3 release of the Yocto Project, the OpenEmbedded +build system builds each recipe in its own work directory (i.e. +:term:`WORKDIR`). The path to the work directory is +constructed using the architecture of the given build (e.g. +:term:`TUNE_PKGARCH`, :term:`MACHINE_ARCH`, or "allarch"), the recipe +name, and the version of the recipe (i.e. +:term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`). + +A number of key subdirectories exist within each recipe work directory: + +- ``${WORKDIR}/temp``: Contains the log files of each task executed for + this recipe, the "run" files for each executed task, which contain + the code run, and a ``log.task_order`` file, which lists the order in + which tasks were executed. + +- ``${WORKDIR}/image``: Contains the output of the + :ref:`ref-tasks-install` task, which corresponds to + the ``${``\ :term:`D`\ ``}`` variable in that task. + +- ``${WORKDIR}/pseudo``: Contains the pseudo database and log for any + tasks executed under pseudo for the recipe. + +- ``${WORKDIR}/sysroot-destdir``: Contains the output of the + :ref:`ref-tasks-populate_sysroot` task. + +- ``${WORKDIR}/package``: Contains the output of the + :ref:`ref-tasks-package` task before the output is + split into individual packages. + +- ``${WORKDIR}/packages-split``: Contains the output of the + ``do_package`` task after the output has been split into individual + packages. Subdirectories exist for each individual package created by + the recipe. + +- ``${WORKDIR}/recipe-sysroot``: A directory populated with the target + dependencies of the recipe. This directory looks like the target + filesystem and contains libraries that the recipe might need to link + against (e.g. the C library). + +- ``${WORKDIR}/recipe-sysroot-native``: A directory populated with the + native dependencies of the recipe. This directory contains the tools + the recipe needs to build (e.g. the compiler, Autoconf, libtool, and + so forth). + +- ``${WORKDIR}/build``: This subdirectory applies only to recipes that + support builds where the source is separate from the build artifacts. + The OpenEmbedded build system uses this directory as a separate build + directory (i.e. ``${``\ :term:`B`\ ``}``). + +.. _structure-build-work-shared: + +``build/tmp/work-shared/`` +-------------------------- + +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 ``gcc`` and its variants +(e.g. ``gcc-cross``, ``libgcc``, ``gcc-runtime``, and so forth). + +.. _structure-meta: + +The Metadata - ``meta/`` +======================== + +As mentioned previously, :term:`Metadata` is the core of the +Yocto Project. Metadata has several important subdivisions: + +.. _structure-meta-classes: + +``meta/classes/`` +----------------- + +This directory contains the ``*.bbclass`` files. Class files are used to +abstract common code so it can be reused by multiple packages. Every +package inherits the ``base.bbclass`` file. Examples of other important +classes are ``autotools.bbclass``, which in theory allows any +Autotool-enabled package to work with the Yocto Project with minimal +effort. Another example is ``kernel.bbclass`` 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 +``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``. + +For reference information on classes, see the +":ref:`ref-manual/classes:Classes`" chapter. + +.. _structure-meta-conf: + +``meta/conf/`` +-------------- + +This directory contains the core set of configuration files that start +from ``bitbake.conf`` and from which all other configuration files are +included. See the include statements at the end of the ``bitbake.conf`` +file and you will note that even ``local.conf`` is loaded from there. +While ``bitbake.conf`` sets up the defaults, you can often override +these by using the (``local.conf``) file, machine file or the +distribution configuration file. + +.. _structure-meta-conf-machine: + +``meta/conf/machine/`` +---------------------- + +This directory contains all the machine configuration files. If you set +``MACHINE = "qemux86"``, the OpenEmbedded build system looks for a +``qemux86.conf`` file in this directory. The ``include`` 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. + +.. _structure-meta-conf-distro: + +``meta/conf/distro/`` +--------------------- + +The contents of this directory controls any distribution-specific +configurations. For the Yocto Project, the ``defaultsetup.conf`` is the +main file here. This directory includes the versions and the ``SRCDATE`` +definitions for applications that are configured here. An example of an +alternative configuration might be ``poky-bleeding.conf``. Although this +file mainly inherits its configuration from Poky. + +.. _structure-meta-conf-machine-sdk: + +``meta/conf/machine-sdk/`` +-------------------------- + +The OpenEmbedded build system searches this directory for configuration +files that correspond to the value of +:term:`SDKMACHINE`. 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. + +.. _structure-meta-files: + +``meta/files/`` +--------------- + +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. + +.. _structure-meta-lib: + +``meta/lib/`` +------------- + +This directory contains OpenEmbedded Python library code used during the +build process. + +.. _structure-meta-recipes-bsp: + +``meta/recipes-bsp/`` +--------------------- + +This directory contains anything linking to specific hardware or +hardware configuration information such as "u-boot" and "grub". + +.. _structure-meta-recipes-connectivity: + +``meta/recipes-connectivity/`` +------------------------------ + +This directory contains libraries and applications related to +communication with other devices. + +.. _structure-meta-recipes-core: + +``meta/recipes-core/`` +---------------------- + +This directory contains what is needed to build a basic working Linux +image including commonly used dependencies. + +.. _structure-meta-recipes-devtools: + +``meta/recipes-devtools/`` +-------------------------- + +This directory contains tools that are primarily used by the build +system. The tools, however, can also be used on targets. + +.. _structure-meta-recipes-extended: + +``meta/recipes-extended/`` +-------------------------- + +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. + +.. _structure-meta-recipes-gnome: + +``meta/recipes-gnome/`` +----------------------- + +This directory contains all things related to the GTK+ application +framework. + +.. _structure-meta-recipes-graphics: + +``meta/recipes-graphics/`` +-------------------------- + +This directory contains X and other graphically related system +libraries. + +.. _structure-meta-recipes-kernel: + +``meta/recipes-kernel/`` +------------------------ + +This directory contains the kernel and generic applications and +libraries that have strong kernel dependencies. + +.. _structure-meta-recipes-lsb4: + +``meta/recipes-lsb4/`` +---------------------- + +This directory contains recipes specifically added to support the Linux +Standard Base (LSB) version 4.x. + +.. _structure-meta-recipes-multimedia: + +``meta/recipes-multimedia/`` +---------------------------- + +This directory contains codecs and support utilities for audio, images +and video. + +.. _structure-meta-recipes-rt: + +``meta/recipes-rt/`` +-------------------- + +This directory contains package and image recipes for using and testing +the ``PREEMPT_RT`` kernel. + +.. _structure-meta-recipes-sato: + +``meta/recipes-sato/`` +---------------------- + +This directory contains the Sato demo/reference UI/UX and its associated +applications and configuration data. + +.. _structure-meta-recipes-support: + +``meta/recipes-support/`` +------------------------- + +This directory contains recipes used by other recipes, but that are not +directly included in images (i.e. dependencies of other recipes). + +.. _structure-meta-site: + +``meta/site/`` +-------------- + +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. + +.. _structure-meta-recipes-txt: + +``meta/recipes.txt`` +-------------------- + +This file is a description of the contents of ``recipes-*``. diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst new file mode 100644 index 0000000000..66afb08102 --- /dev/null +++ b/documentation/ref-manual/system-requirements.rst @@ -0,0 +1,442 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +******************* +System Requirements +******************* + +Welcome to the Yocto Project Reference Manual! This manual provides +reference information for the current release of the Yocto Project, and +is most effectively used after you have an understanding of the basics +of the Yocto Project. The manual is neither meant to be read as a +starting point to the Yocto Project, nor read from start to finish. +Rather, use this manual to find variable definitions, class +descriptions, and so forth as needed during the course of using the +Yocto Project. + +For introductory information on the Yocto Project, see the +:yocto_home:`Yocto Project Website <>` and the +":ref:`overview-manual/development-environment:the yocto project development environment`" +chapter in the Yocto Project Overview and Concepts Manual. + +If you want to use the Yocto Project to quickly build an image without +having to understand concepts, work through the +:doc:`/brief-yoctoprojectqs/index` document. You can find "how-to" +information in the :doc:`/dev-manual/index`. You can find Yocto Project overview +and conceptual information in the :doc:`/overview-manual/index`. + +.. note:: + + For more information about the Yocto Project Documentation set, see + the :ref:`ref-manual/resources:links and related documentation` section. + +.. _detailed-supported-distros: + +Supported Linux Distributions +============================= + +Currently, the Yocto Project is supported on the following +distributions: + +- Ubuntu 16.04 (LTS) + +- Ubuntu 18.04 (LTS) + +- Ubuntu 20.04 + +- Fedora 30 + +- Fedora 31 + +- Fedora 32 + +- CentOS 7.x + +- CentOS 8.x + +- Debian GNU/Linux 8.x (Jessie) + +- Debian GNU/Linux 9.x (Stretch) + +- Debian GNU/Linux 10.x (Buster) + +- OpenSUSE Leap 15.1 + + +.. 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. + + - Yocto Project releases are tested against the stable Linux + distributions in the above list. The Yocto Project should work + on other distributions but validation is not performed against + them. + + - 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. + + - You may use Windows Subsystem For Linux v2 to set up a build host + using Windows 10, but validation is not performed against build + hosts using WSLv2. + + - The Yocto Project is not compatible with WSLv1, it is + compatible but not officially supported nor validated with + WSLv2, if you still decide to use WSL please upgrade to WSLv2. + + - If you encounter problems, please go to :yocto_bugs:`Yocto Project + Bugzilla <>` and submit a bug. We are + interested in hearing about your experience. For information on + how to submit a bug, see the Yocto Project + :yocto_wiki:`Bugzilla wiki page ` + and the ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" + section in the Yocto Project Development Tasks Manual. + + +Required Packages for the Build Host +==================================== + +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 describes required packages according to Linux distribution and +function. + +.. _ubuntu-packages: + +Ubuntu and Debian +----------------- + +The following list shows the required packages by function given a +supported Ubuntu or Debian Linux distribution: + +.. note:: + + - If your build system has the ``oss4-dev`` package installed, you + might experience QEMU build failures due to the package installing + its own custom ``/usr/include/linux/soundcard.h`` on the Debian + system. If you run into this situation, either of the following + solutions exist: + :: + + $ sudo apt-get build-dep qemu + $ sudo apt-get remove oss4-dev + + - For Debian-8, ``python3-git`` and ``pylint3`` are no longer + available via ``apt-get``. + :: + + $ sudo pip3 install GitPython pylint==1.9.5 + +- *Essentials:* Packages needed to build an image on a headless system: + :: + + $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; + +- *Documentation:* Packages needed if you are going to build out the + Yocto Project documentation manuals: + :: + + $ sudo apt-get install make python3-pip + &PIP3_HOST_PACKAGES_DOC; + + .. note:: + + It is currently not possible to build out documentation from Debian 8 + (Jessie) because of outdated ``pip3`` and ``python3``. ``python3-sphinx`` + is too outdated. + +Fedora Packages +--------------- + +The following list shows the required packages by function given a +supported Fedora Linux distribution: + +- *Essentials:* Packages needed to build an image for a headless + system: + :: + + $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; + +- *Documentation:* Packages needed if you are going to build out the + Yocto Project documentation manuals: + :: + + $ sudo dnf install make python3-pip which + &PIP3_HOST_PACKAGES_DOC; + +openSUSE Packages +----------------- + +The following list shows the required packages by function given a +supported openSUSE Linux distribution: + +- *Essentials:* Packages needed to build an image for a headless + system: + :: + + $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; + +- *Documentation:* Packages needed if you are going to build out the + Yocto Project documentation manuals: + :: + + $ sudo zypper install make python3-pip which + &PIP3_HOST_PACKAGES_DOC; + + +CentOS-7 Packages +----------------- + +The following list shows the required packages by function given a +supported CentOS-7 Linux distribution: + +- *Essentials:* Packages needed to build an image for a headless + system: + :: + + $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL; + + .. note:: + + - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is + a collection of packages from Fedora built on RHEL/CentOS for + easy installation of packages not included in enterprise Linux + by default. You need to install these packages separately. + + - The ``makecache`` command consumes additional Metadata from + ``epel-release``. + +- *Documentation:* Packages needed if you are going to build out the + Yocto Project documentation manuals: + :: + + $ sudo yum install make python3-pip which + &PIP3_HOST_PACKAGES_DOC; + +CentOS-8 Packages +----------------- + +The following list shows the required packages by function given a +supported CentOS-8 Linux distribution: + +- *Essentials:* Packages needed to build an image for a headless + system: + :: + + $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL; + + .. note:: + + - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is + a collection of packages from Fedora built on RHEL/CentOS for + easy installation of packages not included in enterprise Linux + by default. You need to install these packages separately. + + - The ``PowerTools`` repo provides additional packages such as + ``rpcgen`` and ``texinfo``. + + - The ``makecache`` command consumes additional Metadata from + ``epel-release``. + +- *Documentation:* Packages needed if you are going to build out the + Yocto Project documentation manuals: + :: + + $ sudo dnf install make python3-pip which + &PIP3_HOST_PACKAGES_DOC; + +Required Git, tar, Python and gcc Versions +========================================== + +In order to use the build system, your host development system must meet +the following version requirements for Git, tar, and Python: + +- Git 1.8.3.1 or greater + +- tar 1.28 or greater + +- Python 3.5.0 or greater + +If your host development system does not meet all these requirements, +you can resolve this by installing a ``buildtools`` 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. + +In addition, your host development system must meet the following +version requirement for gcc: + +- gcc 5.0 or greater + +If your host development system does not meet this requirement, you can +resolve this by installing a ``buildtools-extended`` tarball that +contains additional tools, the equivalent of ``buildtools-essential``. + +Installing a Pre-Built ``buildtools`` Tarball with ``install-buildtools`` script +-------------------------------------------------------------------------------- + +The ``install-buildtools`` script is the easiest of the three methods by +which you can get these tools. It downloads a pre-built buildtools +installer and automatically installs the tools for you: + +1. Execute the ``install-buildtools`` script. Here is an example: + :: + + $ cd poky + $ scripts/install-buildtools --without-extended-buildtools \ + --base-url &YOCTO_DL_URL;/releases/yocto \ + --release yocto-&DISTRO; \ + --installer-version &DISTRO; + + During execution, the buildtools tarball will be downloaded, the + checksum of the download will be verified, the installer will be run + for you, and some basic checks will be run to to make sure the + installation is functional. + + To avoid the need of ``sudo`` privileges, the ``install-buildtools`` + script will by default tell the installer to install in: + :: + + /path/to/poky/buildtools + + If your host development system needs the additional tools provided + in the ``buildtools-extended`` tarball, you can instead execute the + ``install-buildtools`` script with the default parameters: + :: + + $ cd poky + $ scripts/install-buildtools + +2. Source the tools environment setup script by using a command like the + following: + :: + + $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux + + Of course, you need to supply your installation directory and be sure to + use the right file (i.e. i586 or x86_64). + + After you have sourced the setup script, the tools are added to + ``PATH`` and any other environment variables required to run the + tools are initialized. The results are working versions versions of + Git, tar, Python and ``chrpath``. And in the case of the + ``buildtools-extended`` tarball, additional working versions of tools + including ``gcc``, ``make`` and the other tools included in + ``packagegroup-core-buildessential``. + +Downloading a Pre-Built ``buildtools`` Tarball +---------------------------------------------- + +Downloading and running a pre-built buildtools installer is the easiest +of the two methods by which you can get these tools: + +1. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ + +2. Execute the installation script. Here is an example for the + traditional installer: + :: + + $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-DISTRO.sh + + Here is an example for the extended installer: + :: + + $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-DISTRO.sh + + During execution, a prompt appears that allows you to choose the + installation directory. For example, you could choose the following: + ``/home/your-username/buildtools`` + +3. Source the tools environment setup script by using a command like the + following: + :: + + $ source /home/your_username/buildtools/environment-setup-i586-poky-linux + + Of + course, you need to supply your installation directory and be sure to + use the right file (i.e. i585 or x86-64). + + After you have sourced the setup script, the tools are added to + ``PATH`` and any other environment variables required to run the + tools are initialized. The results are working versions versions of + Git, tar, Python and ``chrpath``. And in the case of the + ``buildtools-extended`` tarball, additional working versions of tools + including ``gcc``, ``make`` and the other tools included in + ``packagegroup-core-buildessential``. + +Building Your Own ``buildtools`` Tarball +---------------------------------------- + +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 ``.sh`` file and then take steps to transfer +and run it on a machine that does not meet the minimal Git, tar, and +Python (or gcc) requirements. + +Here are the steps to take to build and run your own buildtools +installer: + +1. On the machine that is able to run BitBake, be sure you have set up + your build environment with the setup script + (:ref:`structure-core-script`). + +2. Run the BitBake command to build the tarball: + :: + + $ bitbake buildtools-tarball + + or run the BitBake command to build the extended tarball: + :: + + $ bitbake buildtools-extended-tarball + + .. note:: + + The :term:`SDKMACHINE` variable in your ``local.conf`` file determines + whether you build tools for a 32-bit or 64-bit system. + + Once the build completes, you can find the ``.sh`` file that installs + the tools in the ``tmp/deploy/sdk`` subdirectory of the + :term:`Build Directory`. The installer file has the string + "buildtools" (or "buildtools-extended") in the name. + +3. Transfer the ``.sh`` file from the build host to the machine that + does not meet the Git, tar, or Python (or gcc) requirements. + +4. On the machine that does not meet the requirements, run the ``.sh`` + file to install the tools. Here is an example for the traditional + installer: + :: + + $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh + + Here is an example for the extended installer: + :: + + $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh + + During execution, a prompt appears that allows you to choose the + installation directory. For example, you could choose the following: + ``/home/your_username/buildtools`` + +5. Source the tools environment setup script by using a command like the + following: + :: + + $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux + + Of course, you need to supply your installation directory and be sure to + use the right file (i.e. i586 or x86_64). + + After you have sourced the setup script, the tools are added to + ``PATH`` and any other environment variables required to run the + tools are initialized. The results are working versions versions of + Git, tar, Python and ``chrpath``. And in the case of the + ``buildtools-extended`` tarball, additional working versions of tools + including ``gcc``, ``make`` and the other tools included in + ``packagegroup-core-buildessential``. diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst new file mode 100644 index 0000000000..9fe1c296aa --- /dev/null +++ b/documentation/ref-manual/tasks.rst @@ -0,0 +1,844 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +***** +Tasks +***** + +Tasks are units of execution for BitBake. Recipes (``.bb`` files) use +tasks to complete configuring, compiling, and packaging software. This +chapter provides a reference of the tasks defined in the OpenEmbedded +build system. + +Normal Recipe Build Tasks +========================= + +The following sections describe normal tasks associated with building a +recipe. For more information on tasks and dependencies, see the +":ref:`Tasks `" and +":ref:`Dependencies `" sections in the +BitBake User Manual. + +.. _ref-tasks-build: + +``do_build`` +------------ + +The default task for all recipes. This task depends on all other normal +tasks required to build a recipe. + +.. _ref-tasks-compile: + +``do_compile`` +-------------- + +Compiles the source code. This task runs with the current working +directory set to ``${``\ :term:`B`\ ``}``. + +The default behavior of this task is to run the ``oe_runmake`` function +if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found. +If no such file is found, the ``do_compile`` task does nothing. + +.. _ref-tasks-compile_ptest_base: + +``do_compile_ptest_base`` +------------------------- + +Compiles the runtime test suite included in the software being built. + +.. _ref-tasks-configure: + +``do_configure`` +---------------- + +Configures the source by enabling and disabling any build-time and +configuration options for the software being built. The task runs with +the current working directory set to ``${``\ :term:`B`\ ``}``. + +The default behavior of this task is to run ``oe_runmake clean`` if a +makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and +:term:`CLEANBROKEN` is not set to "1". If no such +file is found or the ``CLEANBROKEN`` variable is set to "1", the +``do_configure`` task does nothing. + +.. _ref-tasks-configure_ptest_base: + +``do_configure_ptest_base`` +--------------------------- + +Configures the runtime test suite included in the software being built. + +.. _ref-tasks-deploy: + +``do_deploy`` +------------- + +Writes output files that are to be deployed to +``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}``. The +task runs with the current working directory set to +``${``\ :term:`B`\ ``}``. + +Recipes implementing this task should inherit the +:ref:`deploy ` class and should write the output +to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be +confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up +``do_deploy`` as a shared state (sstate) task that can be accelerated +through sstate use. The sstate mechanism takes care of copying the +output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. + +.. note:: + + Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes + the sstate mechanism to malfunction. + +The ``do_deploy`` task is not added as a task by default and +consequently needs to be added manually. If you want the task to run +after :ref:`ref-tasks-compile`, you can add it by doing +the following: +:: + + addtask deploy after do_compile + +Adding ``do_deploy`` after other tasks works the same way. + +.. note:: + + You do not need to add ``before do_build`` to the ``addtask`` command + (though it is harmless), because the ``base`` class contains the following: + :: + + do_build[recrdeptask] += "do_deploy" + + + See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" + section in the BitBake User Manual for more information. + +If the ``do_deploy`` task re-executes, any previous output is removed +(i.e. "cleaned"). + +.. _ref-tasks-fetch: + +``do_fetch`` +------------ + +Fetches the source code. This task uses the +:term:`SRC_URI` variable and the argument's prefix to +determine the correct :ref:`fetcher ` +module. + +.. _ref-tasks-image: + +``do_image`` +------------ + +Starts the image generation process. The ``do_image`` task runs after +the OpenEmbedded build system has run the +:ref:`ref-tasks-rootfs` task during which packages are +identified for installation into the image and the root filesystem is +created, complete with post-processing. + +The ``do_image`` task performs pre-processing on the image through the +:term:`IMAGE_PREPROCESS_COMMAND` and +dynamically generates supporting ``do_image_*`` tasks as needed. + +For more information on image creation, see the ":ref:`overview-manual/concepts:image generation`" +section in the Yocto Project Overview and Concepts Manual. + +.. _ref-tasks-image-complete: + +``do_image_complete`` +--------------------- + +Completes the image generation process. The ``do_image_complete`` task +runs after the OpenEmbedded build system has run the +:ref:`ref-tasks-image` task during which image +pre-processing occurs and through dynamically generated ``do_image_*`` +tasks the image is constructed. + +The ``do_image_complete`` task performs post-processing on the image +through the +:term:`IMAGE_POSTPROCESS_COMMAND`. + +For more information on image creation, see the +":ref:`overview-manual/concepts:image generation`" +section in the Yocto Project Overview and Concepts Manual. + +.. _ref-tasks-install: + +``do_install`` +-------------- + +Copies files that are to be packaged into the holding area +``${``\ :term:`D`\ ``}``. This task runs with the current +working directory set to ``${``\ :term:`B`\ ``}``, which is the +compilation directory. The ``do_install`` task, as well as other tasks +that either directly or indirectly depend on the installed files (e.g. +:ref:`ref-tasks-package`, ``do_package_write_*``, and +:ref:`ref-tasks-rootfs`), run under +:ref:`fakeroot `. + +.. note:: + + When installing files, be careful not to set the owner and group IDs + of the installed files to unintended values. Some methods of copying + files, notably when using the recursive ``cp`` command, can preserve + the UID and/or GID of the original file, which is usually not what + you want. The ``host-user-contaminated`` QA check checks for files + that probably have the wrong ownership. + + Safe methods for installing files include the following: + + - The ``install`` utility. This utility is the preferred method. + + - The ``cp`` command with the "--no-preserve=ownership" option. + + - The ``tar`` command with the "--no-same-owner" option. See the + ``bin_package.bbclass`` file in the ``meta/classes`` directory of + the :term:`Source Directory` for an example. + +.. _ref-tasks-install_ptest_base: + +``do_install_ptest_base`` +------------------------- + +Copies the runtime test suite files from the compilation directory to a +holding area. + +.. _ref-tasks-package: + +``do_package`` +-------------- + +Analyzes the content of the holding area +``${``\ :term:`D`\ ``}`` and splits the content into subsets +based on available packages and files. This task makes use of the +:term:`PACKAGES` and :term:`FILES` +variables. + +The ``do_package`` task, in conjunction with the +:ref:`ref-tasks-packagedata` task, also saves some +important package metadata. For additional information, see the +:term:`PKGDESTWORK` variable and the +":ref:`overview-manual/concepts:automatically added runtime dependencies`" +section in the Yocto Project Overview and Concepts Manual. + +.. _ref-tasks-package_qa: + +``do_package_qa`` +----------------- + +Runs QA checks on packaged files. For more information on these checks, +see the :ref:`insane ` class. + +.. _ref-tasks-package_write_deb: + +``do_package_write_deb`` +------------------------ + +Creates Debian packages (i.e. ``*.deb`` files) and places them in the +``${``\ :term:`DEPLOY_DIR_DEB`\ ``}`` directory in +the package feeds area. For more information, see the +":ref:`overview-manual/concepts:package feeds`" section in +the Yocto Project Overview and Concepts Manual. + +.. _ref-tasks-package_write_ipk: + +``do_package_write_ipk`` +------------------------ + +Creates IPK packages (i.e. ``*.ipk`` files) and places them in the +``${``\ :term:`DEPLOY_DIR_IPK`\ ``}`` directory in +the package feeds area. For more information, see the +":ref:`overview-manual/concepts:package feeds`" section in +the Yocto Project Overview and Concepts Manual. + +.. _ref-tasks-package_write_rpm: + +``do_package_write_rpm`` +------------------------ + +Creates RPM packages (i.e. ``*.rpm`` files) and places them in the +``${``\ :term:`DEPLOY_DIR_RPM`\ ``}`` directory in +the package feeds area. For more information, see the +":ref:`overview-manual/concepts:package feeds`" section in +the Yocto Project Overview and Concepts Manual. + +.. _ref-tasks-package_write_tar: + +``do_package_write_tar`` +------------------------ + +Creates tarballs and places them in the +``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in +the package feeds area. For more information, see the +":ref:`overview-manual/concepts:package feeds`" section in +the Yocto Project Overview and Concepts Manual. + +.. _ref-tasks-packagedata: + +``do_packagedata`` +------------------ + +Saves package metadata generated by the +:ref:`ref-tasks-package` task in +:term:`PKGDATA_DIR` to make it available globally. + +.. _ref-tasks-patch: + +``do_patch`` +------------ + +Locates patch files and applies them to the source code. + +After fetching and unpacking source files, the build system uses the +recipe's :term:`SRC_URI` statements +to locate and apply patch files to the source code. + +.. note:: + + The build system uses the :term:`FILESPATH` variable to determine the + default set of directories when searching for patches. + +Patch files, by default, are ``*.patch`` and ``*.diff`` files created +and kept in a subdirectory of the directory holding the recipe file. For +example, consider the +:yocto_git:`bluez5 ` +recipe from the OE-Core layer (i.e. ``poky/meta``): +:: + + poky/meta/recipes-connectivity/bluez5 + +This recipe has two patch files located here: +:: + + poky/meta/recipes-connectivity/bluez5/bluez5 + +In the ``bluez5`` recipe, the ``SRC_URI`` statements point to the source +and patch files needed to build the package. + +.. note:: + + In the case for the ``bluez5_5.48.bb`` recipe, the ``SRC_URI`` statements + are from an include file ``bluez5.inc``. + +As mentioned earlier, the build system treats files whose file types are +``.patch`` and ``.diff`` as patch files. However, you can use the +"apply=yes" parameter with the ``SRC_URI`` statement to indicate any +file as a patch file: +:: + + SRC_URI = " \ + git://path_to_repo/some_package \ + file://file;apply=yes \ + " + +Conversely, if you have a directory full of patch files and you want to +exclude some so that the ``do_patch`` task does not apply them during +the patch phase, you can use the "apply=no" parameter with the +``SRC_URI`` statement: +:: + + SRC_URI = " \ + git://path_to_repo/some_package \ + file://path_to_lots_of_patch_files \ + file://path_to_lots_of_patch_files/patch_file5;apply=no \ + " + +In the +previous example, assuming all the files in the directory holding the +patch files end with either ``.patch`` or ``.diff``, every file would be +applied as a patch by default except for the ``patch_file5`` patch. + +You can find out more about the patching process in the +":ref:`overview-manual/concepts:patching`" section in +the Yocto Project Overview and Concepts Manual and the +":ref:`dev-manual/common-tasks:patching code`" section in the +Yocto Project Development Tasks Manual. + +.. _ref-tasks-populate_lic: + +``do_populate_lic`` +------------------- + +Writes license information for the recipe that is collected later when +the image is constructed. + +.. _ref-tasks-populate_sdk: + +``do_populate_sdk`` +------------------- + +Creates the file and directory structure for an installable SDK. See the +":ref:`overview-manual/concepts:sdk generation`" +section in the Yocto Project Overview and Concepts Manual for more +information. + +.. _ref-tasks-populate_sdk_ext: + +``do_populate_sdk_ext`` +----------------------- + +Creates the file and directory structure for an installable extensible +SDK (eSDK). See the ":ref:`overview-manual/concepts:sdk generation`" +section in the Yocto Project Overview and Concepts Manual for more +information. + + +.. _ref-tasks-populate_sysroot: + +``do_populate_sysroot`` +----------------------- + +Stages (copies) a subset of the files installed by the +:ref:`ref-tasks-install` task into the appropriate +sysroot. For information on how to access these files from other +recipes, see the :term:`STAGING_DIR* ` variables. +Directories that would typically not be needed by other recipes at build +time (e.g. ``/etc``) are not copied by default. + +For information on what directories are copied by default, see the +:term:`SYSROOT_DIRS* ` variables. You can change +these variables inside your recipe if you need to make additional (or +fewer) directories available to other recipes at build time. + +The ``do_populate_sysroot`` 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"). + +.. _ref-tasks-prepare_recipe_sysroot: + +``do_prepare_recipe_sysroot`` +----------------------------- + +Installs the files into the individual recipe specific sysroots (i.e. +``recipe-sysroot`` and ``recipe-sysroot-native`` under +``${``\ :term:`WORKDIR`\ ``}`` based upon the +dependencies specified by :term:`DEPENDS`). See the +":ref:`staging `" class for more information. + +.. _ref-tasks-rm_work: + +``do_rm_work`` +-------------- + +Removes work files after the OpenEmbedded build system has finished with +them. You can learn more by looking at the +":ref:`rm_work.bbclass `" section. + +.. _ref-tasks-unpack: + +``do_unpack`` +------------- + +Unpacks the source code into a working directory pointed to by +``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` +variable also plays a role in where unpacked source files ultimately +reside. For more information on how source files are unpacked, see the +":ref:`overview-manual/concepts:source fetching`" +section in the Yocto Project Overview and Concepts Manual and also see +the ``WORKDIR`` and ``S`` variable descriptions. + +Manually Called Tasks +===================== + +These tasks are typically manually triggered (e.g. by using the +``bitbake -c`` command-line option): + +.. _ref-tasks-checkpkg: + +``do_checkpkg`` +--------------- + +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. + +To check the upstream version and status of a recipe, use the following +devtool commands: +:: + + $ devtool latest-version + $ devtool check-upgrade-status + +See the ":ref:`ref-manual/devtool-reference:\`\`devtool\`\` quick reference`" +chapter for more information on +``devtool``. See the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" +section for information on checking the upgrade status of a recipe. + +To build the ``checkpkg`` task, use the ``bitbake`` command with the +"-c" option and task name: +:: + + $ bitbake core-image-minimal -c checkpkg + +By default, the results are stored in :term:`$LOG_DIR ` (e.g. +``$BUILD_DIR/tmp/log``). + +.. _ref-tasks-checkuri: + +``do_checkuri`` +--------------- + +Validates the :term:`SRC_URI` value. + +.. _ref-tasks-clean: + +``do_clean`` +------------ + +Removes all output files for a target from the +:ref:`ref-tasks-unpack` task forward (i.e. ``do_unpack``, +:ref:`ref-tasks-configure`, +:ref:`ref-tasks-compile`, +:ref:`ref-tasks-install`, and +:ref:`ref-tasks-package`). + +You can run this task using BitBake as follows: +:: + + $ bitbake -c clean recipe + +Running this task does not remove the +:ref:`sstate ` 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 :ref:`ref-tasks-cleansstate` task instead +(i.e. ``bitbake -c cleansstate`` recipe). + +.. _ref-tasks-cleanall: + +``do_cleanall`` +--------------- + +Removes all output files, shared state +(:ref:`sstate `) cache, and +downloaded source files for a target (i.e. the contents of +:term:`DL_DIR`). Essentially, the ``do_cleanall`` task is +identical to the :ref:`ref-tasks-cleansstate` task +with the added removal of downloaded source files. + +You can run this task using BitBake as follows: +:: + + $ bitbake -c cleanall recipe + +Typically, you would not normally use the ``cleanall`` task. Do so only +if you want to start fresh with the :ref:`ref-tasks-fetch` +task. + +.. _ref-tasks-cleansstate: + +``do_cleansstate`` +------------------ + +Removes all output files and shared state +(:ref:`sstate `) cache for a +target. Essentially, the ``do_cleansstate`` task is identical to the +:ref:`ref-tasks-clean` task with the added removal of +shared state (:ref:`sstate `) +cache. + +You can run this task using BitBake as follows: +:: + + $ bitbake -c cleansstate recipe + +When you run the ``do_cleansstate`` task, the OpenEmbedded build system +no longer uses any sstate. Consequently, building the recipe from +scratch is guaranteed. + +.. note:: + + The ``do_cleansstate`` 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: + :: + + $ bitbake -f -c do_cleansstate target + + +.. _ref-tasks-devpyshell: + +``do_devpyshell`` +----------------- + +Starts a shell in which an interactive Python interpreter allows you to +interact with the BitBake build environment. From within this shell, you +can directly examine and set bits from the data store and execute +functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a development python shell`" section in +the Yocto Project Development Tasks Manual for more information about +using ``devpyshell``. + +.. _ref-tasks-devshell: + +``do_devshell`` +--------------- + +Starts a shell whose environment is set up for development, debugging, +or both. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the +Yocto Project Development Tasks Manual for more information about using +``devshell``. + +.. _ref-tasks-listtasks: + +``do_listtasks`` +---------------- + +Lists all defined tasks for a target. + +.. _ref-tasks-package_index: + +``do_package_index`` +-------------------- + +Creates or updates the index in the :ref:`overview-manual/concepts:package feeds` area. + +.. note:: + + This task is not triggered with the ``bitbake -c`` command-line option as + are the other tasks in this section. Because this task is specifically for + the ``package-index`` recipe, you run it using ``bitbake package-index``. + +Image-Related Tasks +=================== + +The following tasks are applicable to image recipes. + +.. _ref-tasks-bootimg: + +``do_bootimg`` +-------------- + +Creates a bootable live image. See the +:term:`IMAGE_FSTYPES` variable for additional +information on live image types. + +.. _ref-tasks-bundle_initramfs: + +``do_bundle_initramfs`` +----------------------- + +Combines an initial RAM disk (initramfs) image and kernel together to +form a single image. The +:term:`CONFIG_INITRAMFS_SOURCE` variable +has some more information about these types of images. + +.. _ref-tasks-rootfs: + +``do_rootfs`` +------------- + +Creates the root filesystem (file and directory structure) for an image. +See the ":ref:`overview-manual/concepts:image generation`" +section in the Yocto Project Overview and Concepts Manual for more +information on how the root filesystem is created. + +.. _ref-tasks-testimage: + +``do_testimage`` +---------------- + +Boots an image and performs runtime tests within the image. For +information on automatically testing images, see the +":ref:`dev-manual/common-tasks:performing automated runtime testing`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-tasks-testimage_auto: + +``do_testimage_auto`` +--------------------- + +Boots an image and performs runtime tests within the image immediately +after it has been built. This task is enabled when you set +:term:`TESTIMAGE_AUTO` equal to "1". + +For information on automatically testing images, see the +":ref:`dev-manual/common-tasks:performing automated runtime testing`" +section in the Yocto Project Development Tasks Manual. + +Kernel-Related Tasks +==================== + +The following tasks are applicable to kernel recipes. Some of these +tasks (e.g. the :ref:`ref-tasks-menuconfig` task) are +also applicable to recipes that use Linux kernel style configuration +such as the BusyBox recipe. + +.. _ref-tasks-compile_kernelmodules: + +``do_compile_kernelmodules`` +---------------------------- + +Runs the step that builds the kernel modules (if needed). Building a +kernel consists of two steps: 1) the kernel (``vmlinux``) is built, and +2) the modules are built (i.e. ``make modules``). + +.. _ref-tasks-diffconfig: + +``do_diffconfig`` +----------------- + +When invoked by the user, this task creates a file containing the +differences between the original config as produced by +:ref:`ref-tasks-kernel_configme` task and the +changes made by the user with other methods (i.e. using +(:ref:`ref-tasks-kernel_menuconfig`). Once the +file of differences is created, it can be used to create a config +fragment that only contains the differences. You can invoke this task +from the command line as follows: +:: + + $ bitbake linux-yocto -c diffconfig + +For more information, see the +":ref:`kernel-dev/common:creating configuration fragments`" +section in the Yocto Project Linux Kernel Development Manual. + +.. _ref-tasks-kernel_checkout: + +``do_kernel_checkout`` +---------------------- + +Converts the newly unpacked kernel source into a form with which the +OpenEmbedded build system can work. Because the kernel source can be +fetched in several different ways, the ``do_kernel_checkout`` task makes +sure that subsequent tasks are given a clean working tree copy of the +kernel with the correct branches checked out. + +.. _ref-tasks-kernel_configcheck: + +``do_kernel_configcheck`` +------------------------- + +Validates the configuration produced by the +:ref:`ref-tasks-kernel_menuconfig` task. The +``do_kernel_configcheck`` task produces warnings when a requested +configuration does not appear in the final ``.config`` file or when you +override a policy configuration in a hardware configuration fragment. +You can run this task explicitly and view the output by using the +following command: +:: + + $ bitbake linux-yocto -c kernel_configcheck -f + +For more information, see the +":ref:`kernel-dev/common:validating configuration`" +section in the Yocto Project Linux Kernel Development Manual. + +.. _ref-tasks-kernel_configme: + +``do_kernel_configme`` +---------------------- + +After the kernel is patched by the :ref:`ref-tasks-patch` +task, the ``do_kernel_configme`` task assembles and merges all the +kernel config fragments into a merged configuration that can then be +passed to the kernel configuration phase proper. This is also the time +during which user-specified defconfigs are applied if present, and where +configuration modes such as ``--allnoconfig`` are applied. + +.. _ref-tasks-kernel_menuconfig: + +``do_kernel_menuconfig`` +------------------------ + +Invoked by the user to manipulate the ``.config`` file used to build a +linux-yocto recipe. This task starts the Linux kernel configuration +tool, which you then use to modify the kernel configuration. + +.. note:: + + You can also invoke this tool from the command line as follows: + :: + + $ bitbake linux-yocto -c menuconfig + + +See the ":ref:`kernel-dev/common:using \`\`menuconfig\`\``" +section in the Yocto Project Linux Kernel Development Manual for more +information on this configuration tool. + +.. _ref-tasks-kernel_metadata: + +``do_kernel_metadata`` +---------------------- + +Collects all the features required for a given kernel build, whether the +features come from :term:`SRC_URI` or from Git +repositories. After collection, the ``do_kernel_metadata`` task +processes the features into a series of config fragments and patches, +which can then be applied by subsequent tasks such as +:ref:`ref-tasks-patch` and +:ref:`ref-tasks-kernel_configme`. + +.. _ref-tasks-menuconfig: + +``do_menuconfig`` +----------------- + +Runs ``make menuconfig`` for the kernel. For information on +``menuconfig``, see the +":ref:`kernel-dev/common:using \`\`menuconfig\`\``" +section in the Yocto Project Linux Kernel Development Manual. + +.. _ref-tasks-savedefconfig: + +``do_savedefconfig`` +-------------------- + +When invoked by the user, creates a defconfig file that can be used +instead of the default defconfig. The saved defconfig contains the +differences between the default defconfig and the changes made by the +user using other methods (i.e. the +:ref:`ref-tasks-kernel_menuconfig` task. You +can invoke the task using the following command: +:: + + $ bitbake linux-yocto -c savedefconfig + +.. _ref-tasks-shared_workdir: + +``do_shared_workdir`` +--------------------- + +After the kernel has been compiled but before the kernel modules have +been compiled, this task copies files required for module builds and +which are generated from the kernel build into the shared work +directory. With these copies successfully copied, the +:ref:`ref-tasks-compile_kernelmodules` task +can successfully build the kernel modules in the next step of the build. + +.. _ref-tasks-sizecheck: + +``do_sizecheck`` +---------------- + +After the kernel has been built, this task checks the size of the +stripped kernel image against +:term:`KERNEL_IMAGE_MAXSIZE`. If that +variable was set and the size of the stripped kernel exceeds that size, +the kernel build produces a warning to that effect. + +.. _ref-tasks-strip: + +``do_strip`` +------------ + +If ``KERNEL_IMAGE_STRIP_EXTRA_SECTIONS`` is defined, this task strips +the sections named in that variable from ``vmlinux``. This stripping is +typically used to remove nonessential sections such as ``.comment`` +sections from a size-sensitive configuration. + +.. _ref-tasks-validate_branches: + +``do_validate_branches`` +------------------------ + +After the kernel is unpacked but before it is patched, this task makes +sure that the machine and metadata branches as specified by the +:term:`SRCREV` variables actually exist on the specified +branches. If these branches do not exist and +:term:`AUTOREV` is not being used, the +``do_validate_branches`` task fails during the build. diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst new file mode 100644 index 0000000000..c07dd4b128 --- /dev/null +++ b/documentation/ref-manual/terms.rst @@ -0,0 +1,390 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +******************* +Yocto Project Terms +******************* + +Following is a list of terms and definitions users new to the Yocto Project +development environment might find helpful. While some of these terms are +universal, the list includes them just in case: + +.. glossary:: + + :term:`Append Files` + Files that append build information to a recipe file. Append files are + known as BitBake append files and ``.bbappend`` files. The OpenEmbedded + build system expects every append file to have a corresponding recipe + (``.bb``) file. Furthermore, the append file and corresponding recipe file + must use the same root filename. The filenames can differ only in the + file type suffix used (e.g. ``formfactor_0.0.bb`` and + ``formfactor_0.0.bbappend``). + + Information in append files extends or overrides the information in the + similarly-named recipe file. For an example of an append file in use, see + the ":ref:`dev-manual/common-tasks:Using .bbappend Files in + Your Layer`" section in the Yocto Project Development Tasks Manual. + + When you name an append file, you can use the "``%``" wildcard character + to allow for matching recipe names. For example, suppose you have an + append file named as follows: + :: + + busybox_1.21.%.bbappend + + That append file + would match any ``busybox_1.21.``\ x\ ``.bb`` version of the recipe. So, + the append file would match any of the following recipe names: + + .. code-block:: shell + + busybox_1.21.1.bb + busybox_1.21.2.bb + busybox_1.21.3.bb + busybox_1.21.10.bb + busybox_1.21.25.bb + + .. note:: + + The use of the "%" character is limited in that it only works + directly in front of the .bbappend portion of the append file's + name. You cannot use the wildcard character in any other location of + the name. + + :term:`BitBake` + The task executor and scheduler used by the OpenEmbedded build system to + build images. For more information on BitBake, see the :doc:`BitBake User + Manual `. + + :term:`Board Support Package (BSP)` + A group of drivers, definitions, and other components that provide support + for a specific hardware configuration. For more information on BSPs, see + the :doc:`/bsp-guide/index`. + + :term:`Build Directory` + This term refers to the area used by the OpenEmbedded build system for + builds. The area is created when you ``source`` the setup environment + script that is found in the Source Directory + (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The + :term:`TOPDIR` variable points to the Build Directory. + + You have a lot of flexibility when creating the Build Directory. + Following are some examples that show how to create the directory. The + examples assume your :term:`Source Directory` is named ``poky``: + + - Create the Build Directory inside your Source Directory and let + the name of the Build Directory default to ``build``: + + .. code-block:: shell + + $ cd $HOME/poky + $ source oe-init-build-env + + - Create the Build Directory inside your home directory and + specifically name it ``test-builds``: + + .. code-block:: shell + + $ cd $HOME + $ source poky/oe-init-build-env test-builds + + - Provide a directory path and specifically name the Build + Directory. Any intermediate folders in the pathname must exist. + This next example creates a Build Directory named + ``YP-POKYVERSION`` in your home directory within the existing + directory ``mybuilds``: + + .. code-block:: shell + + $ cd $HOME + $ source $HOME/poky/oe-init-build-env $HOME/mybuilds/YP-POKYVERSION + + .. note:: + + By default, the Build Directory contains :term:`TMPDIR`, which is a + temporary directory the build system uses for its work. ``TMPDIR`` cannot + be under NFS. Thus, by default, the Build Directory cannot be under + NFS. However, if you need the Build Directory to be under NFS, you can + set this up by setting ``TMPDIR`` in your ``local.conf`` file to use a local + drive. Doing so effectively separates ``TMPDIR`` from :term:`TOPDIR`, which is the + Build Directory. + + :term:`Build Host` + The system used to build images in a Yocto Project Development + environment. The build system is sometimes referred to as the development + host. + + :term:`Classes` + Files that provide for logic encapsulation and inheritance so that + commonly used patterns can be defined once and then easily used in + multiple recipes. For reference information on the Yocto Project classes, + see the ":ref:`ref-manual/classes:Classes`" chapter. Class files end with the + ``.bbclass`` filename extension. + + :term:`Configuration File` + Files that hold global definitions of variables, user-defined variables, + and hardware configuration information. These files tell the OpenEmbedded + build system what to build and what to put into the image to support a + particular platform. + + Configuration files end with a ``.conf`` filename extension. The + :file:`conf/local.conf` configuration file in the :term:`Build Directory` + contains user-defined variables that affect every build. The + :file:`meta-poky/conf/distro/poky.conf` configuration file defines Yocto + "distro" configuration variables used only when building with this + policy. Machine configuration files, which are located throughout the + :term:`Source Directory`, define variables for specific hardware and are + only used when building for that target (e.g. the + :file:`machine/beaglebone.conf` configuration file defines variables for + the Texas Instruments ARM Cortex-A8 development board). + + :term:`Container Layer` + Layers that hold other layers. An example of a container layer is + OpenEmbedded's `meta-openembedded + `_ layer. The + ``meta-openembedded`` layer contains many ``meta-*`` layers. + + :term:`Cross-Development Toolchain` + In general, a cross-development toolchain is a collection of software + development tools and utilities that run on one architecture and allow you + to develop software for a different, or targeted, architecture. These + toolchains contain cross-compilers, linkers, and debuggers that are + specific to the target architecture. + + The Yocto Project supports two different cross-development toolchains: + + - A toolchain only used by and within BitBake when building an image for a + target architecture. + + - A relocatable toolchain used outside of BitBake by developers when + developing applications that will run on a targeted device. + + Creation of these toolchains is simple and automated. For information on + toolchain concepts as they apply to the Yocto Project, see the + ":ref:`overview-manual/concepts:Cross-Development + Toolchain Generation`" section in the Yocto Project Overview and Concepts + Manual. You can also find more information on using the relocatable + toolchain in the :doc:`/sdk-manual/index` manual. + + :term:`Extensible Software Development Kit (eSDK)` + A custom SDK for application developers. This eSDK allows developers to + incorporate their library and programming changes back into the image to + make their code available to other application developers. + + For information on the eSDK, see the :doc:`/sdk-manual/index` manual. + + :term:`Image` + An image is an artifact of the BitBake build process given a collection of + recipes and related Metadata. Images are the binary output that run on + specific hardware or QEMU and are used for specific use-cases. For a list + of the supported image types that the Yocto Project provides, see the + ":ref:`ref-manual/images:Images`" chapter. + + :term:`Layer` + A collection of related recipes. Layers allow you to consolidate related + metadata to customize your build. Layers also isolate information used + when building for multiple architectures. Layers are hierarchical in + their ability to override previous specifications. You can include any + number of available layers from the Yocto Project and customize the build + by adding your layers after them. You can search the Layer Index for + layers used within Yocto Project. + + For introductory information on layers, see the + ":ref:`overview-manual/yp-intro:The Yocto Project Layer + Model`" section in the Yocto Project Overview and Concepts Manual. For + more detailed information on layers, see the + ":ref:`dev-manual/common-tasks:Understanding and Creating + Layers`" section in the Yocto Project Development Tasks Manual. For a + discussion specifically on BSP Layers, see the ":ref:`bsp-guide/bsp:BSP + Layers`" section in the Yocto Project Board Support Packages (BSP) + Developer's Guide. + + :term:`Metadata` + A key element of the Yocto Project is the Metadata that + is used to construct a Linux distribution and is contained in the + files that the :term:`OpenEmbedded Build System` + parses when building an image. In general, Metadata includes recipes, + configuration files, and other information that refers to the build + instructions themselves, as well as the data used to control what + things get built and the effects of the build. Metadata also includes + commands and data used to indicate what versions of software are + used, from where they are obtained, and changes or additions to the + software itself (patches or auxiliary files) that are used to fix + bugs or customize the software for use in a particular situation. + OpenEmbedded-Core is an important set of validated metadata. + + In the context of the kernel ("kernel Metadata"), the term refers to + the kernel config fragments and features contained in the + :yocto_git:`yocto-kernel-cache ` + Git repository. + + :term:`OpenEmbedded-Core (OE-Core)` + OE-Core is metadata comprised of + foundational recipes, classes, and associated files that are meant to + be common among many different OpenEmbedded-derived systems, + including the Yocto Project. OE-Core is a curated subset of an + original repository developed by the OpenEmbedded community that has + been pared down into a smaller, core set of continuously validated + recipes. The result is a tightly controlled and an quality-assured + core set of recipes. + + You can see the Metadata in the ``meta`` directory of the Yocto + Project :yocto_git:`Source Repositories `. + + :term:`OpenEmbedded Build System` + The build system specific to the Yocto + Project. The OpenEmbedded build system is based on another project + known as "Poky", which uses :term:`BitBake` as the task + executor. Throughout the Yocto Project documentation set, the + OpenEmbedded build system is sometimes referred to simply as "the + build system". If other build systems, such as a host or target build + system are referenced, the documentation clearly states the + difference. + + .. note:: + + For some historical information about Poky, see the :term:`Poky` term. + + :term:`Package` + In the context of the Yocto Project, this term refers to a + recipe's packaged output produced by BitBake (i.e. a "baked recipe"). + A package is generally the compiled binaries produced from the + recipe's sources. You "bake" something by running it through BitBake. + + It is worth noting that the term "package" can, in general, have + subtle meanings. For example, the packages referred to in the + ":ref:`ref-manual/system-requirements:required packages for the build host`" + section are compiled binaries that, when installed, add functionality to + your Linux distribution. + + Another point worth noting is that historically within the Yocto + Project, recipes were referred to as packages - thus, the existence + of several BitBake variables that are seemingly mis-named, (e.g. + :term:`PR`, :term:`PV`, and + :term:`PE`). + + :term:`Package Groups` + Arbitrary groups of software Recipes. You use + package groups to hold recipes that, when built, usually accomplish a + single task. For example, a package group could contain the recipes + for a company's proprietary or value-add software. Or, the package + group could contain the recipes that enable graphics. A package group + is really just another recipe. Because package group files are + recipes, they end with the ``.bb`` filename extension. + + :term:`Poky` + Poky, which is pronounced *Pock*-ee, is a reference embedded + distribution and a reference test configuration. Poky provides the + following: + + - A base-level functional distro used to illustrate how to customize + a distribution. + + - A means by which to test the Yocto Project components (i.e. Poky + is used to validate the Yocto Project). + + - A vehicle through which you can download the Yocto Project. + + Poky is not a product level distro. Rather, it is a good starting + point for customization. + + .. note:: + + Poky began as an open-source project initially developed by + OpenedHand. OpenedHand developed Poky from the existing + OpenEmbedded build system to create a commercially supportable + build system for embedded Linux. After Intel Corporation acquired + OpenedHand, the poky project became the basis for the Yocto + Project's build system. + + :term:`Recipe` + A set of instructions for building packages. A recipe + describes where you get source code, which patches to apply, how to + configure the source, how to compile it and so on. Recipes also + describe dependencies for libraries or for other recipes. Recipes + represent the logical unit of execution, the software to build, the + images to build, and use the ``.bb`` file extension. + + :term:`Reference Kit` + A working example of a system, which includes a + :term:`BSP` as well as a + :term:`build host` and other components, that can + work on specific hardware. + + :term:`Source Directory` + This term refers to the directory structure + created as a result of creating a local copy of the ``poky`` Git + repository ``git://git.yoctoproject.org/poky`` or expanding a + released ``poky`` tarball. + + .. note:: + + Creating a local copy of the + poky + Git repository is the recommended method for setting up your + Source Directory. + + Sometimes you might hear the term "poky directory" used to refer to + this directory structure. + + .. 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. + + The Source Directory contains BitBake, Documentation, Metadata and + other files that all support the Yocto Project. Consequently, you + must have the Source Directory in place on your development system in + order to do any development using the Yocto Project. + + When you create a local copy of the Git repository, you can name the + repository anything you like. Throughout much of the documentation, + "poky" is used as the name of the top-level folder of the local copy + of the poky Git repository. So, for example, cloning the ``poky`` Git + repository results in a local Git repository whose top-level folder + is also named "poky". + + While it is not recommended that you use tarball expansion to set up + the Source Directory, if you do, the top-level directory name of the + Source Directory is derived from the Yocto Project release tarball. + For example, downloading and unpacking + :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2` + results in a Source Directory whose root folder is named ``poky``. + + It is important to understand the differences between the Source + Directory created by unpacking a released tarball as compared to + cloning ``git://git.yoctoproject.org/poky``. When you unpack a + tarball, you have an exact copy of the files based on the time of + release - a fixed release point. Any changes you make to your local + files in the Source Directory are on top of the release and will + remain local only. On the other hand, when you clone the ``poky`` Git + repository, you have an active development repository with access to + the upstream repository's branches and tags. In this case, any local + changes you make to the local Source Directory can be later applied + to active development branches of the upstream ``poky`` Git + repository. + + For more information on concepts related to Git repositories, + branches, and tags, see the + ":ref:`overview-manual/development-environment:repositories, tags, and branches`" + section in the Yocto Project Overview and Concepts Manual. + + :term:`Task` + A unit of execution for BitBake (e.g. + :ref:`ref-tasks-compile`, + :ref:`ref-tasks-fetch`, + :ref:`ref-tasks-patch`, and so forth). + + :term:`Toaster` + A web interface to the Yocto Project's :term:`OpenEmbedded Build System`. + The interface enables you to + configure and run your builds. Information about builds is collected + and stored in a database. For information on Toaster, see the + :doc:`/toaster-manual/index`. + + :term:`Upstream` + A reference to source code or repositories that are not + local to the development system but located in a master area that is + controlled by the maintainer of the source code. For example, in + order for a developer to work on a particular piece of code, they + need to first get a copy of it from an "upstream" source. diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst new file mode 100644 index 0000000000..8c6cc46b6c --- /dev/null +++ b/documentation/ref-manual/variables.rst @@ -0,0 +1,8807 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +****************** +Variables Glossary +****************** + +This chapter lists common variables used in the OpenEmbedded build +system and gives an overview of their function and contents. + +:term:`A ` :term:`B` :term:`C ` +:term:`D` :term:`E ` :term:`F ` +:term:`G ` :term:`H ` :term:`I ` +:term:`K ` :term:`L ` :term:`M ` +:term:`N ` :term:`O ` :term:`P` +:term:`R ` :term:`S` :term:`T` +:term:`U ` :term:`V ` +:term:`W ` :term:`X ` + +.. glossary:: + + :term:`ABIEXTENSION` + Extension to the Application Binary Interface (ABI) field of the GNU + canonical architecture name (e.g. "eabi"). + + ABI extensions are set in the machine include files. For example, the + ``meta/conf/machine/include/arm/arch-arm.inc`` file sets the + following extension: + :: + + ABIEXTENSION = "eabi" + + :term:`ALLOW_EMPTY` + Specifies whether to produce an output package even if it is empty. + By default, BitBake does not produce empty packages. This default + behavior can cause issues when there is an + :term:`RDEPENDS` or some other hard runtime + requirement on the existence of the package. + + Like all package-controlling variables, you must always use them in + conjunction with a package name override, as in: + :: + + ALLOW_EMPTY_${PN} = "1" + ALLOW_EMPTY_${PN}-dev = "1" + ALLOW_EMPTY_${PN}-staticdev = "1" + + :term:`ALTERNATIVE` + 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. + + To use the variable, list out the package's commands that also exist + as part of another package. For example, if the ``busybox`` package + has four commands that also exist as part of another package, you + identify them as follows: + :: + + ALTERNATIVE_busybox = "sh sed test bracket" + + For more information on the alternatives system, see the + ":ref:`update-alternatives.bbclass `" + section. + + :term:`ALTERNATIVE_LINK_NAME` + Used by the alternatives system to map duplicated commands to actual + locations. For example, if the ``bracket`` command provided by the + ``busybox`` package is duplicated through another package, you must + use the ``ALTERNATIVE_LINK_NAME`` variable to specify the actual + location: + :: + + ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/[" + + In this example, the binary for the ``bracket`` command (i.e. ``[``) + from the ``busybox`` package resides in ``/usr/bin/``. + + .. note:: + + If ``ALTERNATIVE_LINK_NAME`` is not defined, it defaults to ``${bindir}/name``. + + For more information on the alternatives system, see the + ":ref:`update-alternatives.bbclass `" + section. + + :term:`ALTERNATIVE_PRIORITY` + 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: + :: + + ALTERNATIVE_PRIORITY = "priority" + ALTERNATIVE_PRIORITY[name] = "priority" + ALTERNATIVE_PRIORITY_pkg[name] = "priority" + + For more information on the alternatives system, see the + ":ref:`update-alternatives.bbclass `" + section. + + :term:`ALTERNATIVE_TARGET` + 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: + :: + + ALTERNATIVE_TARGET = "target" + ALTERNATIVE_TARGET[name] = "target" + ALTERNATIVE_TARGET_pkg[name] = "target" + + .. note:: + + If ``ALTERNATIVE_TARGET`` is not defined, it inherits the value + from the :term:`ALTERNATIVE_LINK_NAME` variable. + + If ``ALTERNATIVE_LINK_NAME`` and ``ALTERNATIVE_TARGET`` are the + same, the target for ``ALTERNATIVE_TARGET`` has "``.{BPN}``" + appended to it. + + 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 :ref:`ref-tasks-install` + task while retaining support for the command if necessary. + + For more information on the alternatives system, see the + ":ref:`update-alternatives.bbclass `" + section. + + :term:`ANY_OF_DISTRO_FEATURES` + When inheriting the + :ref:`features_check ` + class, this variable identifies a list of distribution features where + at least one must be enabled in the current configuration in order + for the OpenEmbedded build system to build the recipe. In other words, + if none of the features listed in ``ANY_OF_DISTRO_FEATURES`` + appear in ``DISTRO_FEATURES`` within the current configuration, then + the recipe will be skipped, and if the build system attempts to build + the recipe then an error will be triggered. + + + :term:`APPEND` + An override list of append strings for each target specified with + :term:`LABELS`. + + See the :ref:`grub-efi ` class for more + information on how this variable is used. + + :term:`AR` + The minimal command and arguments used to run ``ar``. + + :term:`ARCHIVER_MODE` + When used with the :ref:`archiver ` 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): + :: + + 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] ?= "file file ..." # 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. + + For information on how the variable works, see the + ``meta/classes/archiver.bbclass`` file in the :term:`Source Directory`. + + :term:`AS` + Minimal command and arguments needed to run the assembler. + + :term:`ASSUME_PROVIDED` + Lists recipe names (:term:`PN` values) BitBake does not + attempt to build. Instead, BitBake assumes these recipes have already + been built. + + In OpenEmbedded-Core, ``ASSUME_PROVIDED`` mostly specifies native + tools that should not be built. An example is ``git-native``, which + when specified, allows for the Git binary from the host to be used + rather than building ``git-native``. + + :term:`ASSUME_SHLIBS` + Provides additional ``shlibs`` provider mapping information, which + adds to or overwrites the information provided automatically by the + system. Separate multiple entries using spaces. + + As an example, use the following form to add an ``shlib`` provider of + shlibname in packagename with the optional version: + :: + + shlibname:packagename[_version] + + Here is an example that adds a shared library named ``libEGL.so.1`` + as being provided by the ``libegl-implementation`` package: + :: + + ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation" + + :term:`AUTHOR` + The email address used to contact the original author or authors in + order to send patches and forward bugs. + + :term:`AUTO_LIBNAME_PKGS` + When the :ref:`debian ` class is inherited, + which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which + packages should be checked for libraries and renamed according to + Debian library package naming. + + The default value is "${PACKAGES}", which causes the debian class to + act on all packages that are explicitly generated by the recipe. + + :term:`AUTO_SYSLINUXMENU` + Enables creating an automatic menu for the syslinux bootloader. You + must set this variable in your recipe. The + :ref:`syslinux ` class checks this variable. + + :term:`AUTOREV` + When ``SRCREV`` is set to the value of this variable, it specifies to + use the latest source revision in the repository. Here is an example: + :: + + SRCREV = "${AUTOREV}" + + If you use the previous statement to retrieve the latest version of + software, you need to be sure :term:`PV` contains + ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you + have a kernel recipe that inherits the + :ref:`kernel ` class and you use the previous + statement. In this example, ``${SRCPV}`` does not automatically get + into ``PV``. Consequently, you need to change ``PV`` in your recipe + so that it does contain ``${SRCPV}``. + + For more information see the + ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" + section in the Yocto Project Development Tasks Manual. + + :term:`AVAILABLE_LICENSES` + List of licenses found in the directories specified by + :term:`COMMON_LICENSE_DIR` and + :term:`LICENSE_PATH`. + + .. note:: + + It is assumed that all changes to ``COMMON_LICENSE_DIR`` and + ``LICENSE_PATH`` have been done before ``AVAILABLE_LICENSES`` + is defined (in :ref:`ref-classes-license`). + + :term:`AVAILTUNES` + The list of defined CPU and Application Binary Interface (ABI) + tunings (i.e. "tunes") available for use by the OpenEmbedded build + system. + + 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 + :ref:`Multilib ` + configuration. + + 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 + ":ref:`Basic Syntax `" section in the BitBake + User Manual for more information. + + :term:`B` + The directory within the :term:`Build Directory` in + which the OpenEmbedded build system places generated objects during a + recipe's build process. By default, this directory is the same as the + :term:`S` directory, which is defined as: + :: + + S = "${WORKDIR}/${BP}" + + You can separate the (``S``) directory and the directory pointed to + by the ``B`` variable. Most Autotools-based recipes support + separating these directories. The build system defaults to using + separate directories for ``gcc`` and some kernel recipes. + + :term:`BAD_RECOMMENDATIONS` + Lists "recommended-only" packages to not install. Recommended-only + packages are packages installed only through the + :term:`RRECOMMENDS` variable. You can prevent any + of these "recommended" packages from being installed by listing them + with the ``BAD_RECOMMENDATIONS`` variable: + :: + + BAD_RECOMMENDATIONS = "package_name package_name package_name ..." + + You can set this variable globally in your ``local.conf`` file or you + can attach it to a specific image recipe by using the recipe name + override: + :: + + BAD_RECOMMENDATIONS_pn-target_image = "package_name" + + 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 :term:`RDEPENDS` + variable), the OpenEmbedded build system ignores your request and + will install the packages to avoid dependency errors. + + Support for this variable exists only when using the IPK and RPM + packaging backend. Support does not exist for DEB. + + See the :term:`NO_RECOMMENDATIONS` and the + :term:`PACKAGE_EXCLUDE` variables for related + information. + + :term:`BASE_LIB` + The library directory name for the CPU or Application Binary + Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib + context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" + section in the Yocto Project Development Tasks Manual for information + on Multilib. + + The ``BASE_LIB`` variable is defined in the machine include files in + the :term:`Source Directory`. If Multilib is not + being used, the value defaults to "lib". + + :term:`BASE_WORKDIR` + Points to the base of the work directory for all recipes. The default + value is "${TMPDIR}/work". + + :term:`BB_ALLOWED_NETWORKS` + 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: + + - This host list is only used if ``BB_NO_NETWORK`` is either not set + or set to "0". + + - Limited support for wildcard matching against the beginning of + host names exists. For example, the following setting matches + ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``. + :: + + BB_ALLOWED_NETWORKS = "*.gnu.org" + + .. note:: + + The use of the "``*``" character only works at the beginning of + a host name and it must be isolated from the remainder of the + host name. You cannot use the wildcard character in any other + location of the name or combined with the front part of the + name. + + For example, ``*.foo.bar`` is supported, while ``*aa.foo.bar`` + is not. + + - Mirrors not in the host list are skipped and logged in debug. + + - Attempts to access networks not in the host list cause a failure. + + Using ``BB_ALLOWED_NETWORKS`` in conjunction with + :term:`PREMIRRORS` is very useful. Adding the host + you want to use to ``PREMIRRORS`` 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 :term:`SRC_URI` + statement. This is because the fetcher does not attempt to use the + host listed in ``SRC_URI`` after a successful fetch from the + ``PREMIRRORS`` occurs. + + :term:`BB_DANGLINGAPPENDS_WARNONLY` + Defines how BitBake handles situations where an append file + (``.bbappend``) has no corresponding recipe file (``.bb``). This + condition often occurs when layers get out of sync (e.g. ``oe-core`` + 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). + + 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. + + You can change the default behavior by setting this variable to "1", + "yes", or "true" in your ``local.conf`` file, which is located in the + :term:`Build Directory`: Here is an example: + :: + + BB_DANGLINGAPPENDS_WARNONLY = "1" + + :term:`BB_DISKMON_DIRS` + Monitors disk space and available inodes during the build and allows + you to control the build based on these parameters. + + Disk space monitoring is disabled by default. To enable monitoring, + add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file + found in the :term:`Build Directory`. Use the + following form: + + .. code-block:: none + + BB_DISKMON_DIRS = "action,dir,threshold [...]" + + where: + + action 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 BB_DISKMON_WARNINTERVAL + variable, which must be defined in + the conf/local.conf file. + + dir 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. + + threshold 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. + + Here are some examples: + :: + + BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" + BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" + BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" + + The first example works only if you also provide the + :term:`BB_DISKMON_WARNINTERVAL` + variable in the ``conf/local.conf``. This example causes the build + system to immediately abort when either the disk space in + ``${TMPDIR}`` 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 ``${SSTATE_DIR}`` 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 ``BB_DISKMON_WARNINTERVAL`` + variable. + + The second example stops the build after all currently executing + tasks complete when the minimum disk space in the ``${TMPDIR}`` + directory drops below 1 Gbyte. No disk monitoring occurs for the free + inodes in this case. + + The final example immediately aborts the build when the number of + free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No + disk space monitoring for the directory itself occurs in this case. + + :term:`BB_DISKMON_WARNINTERVAL` + Defines the disk space and free inode warning intervals. To set these + intervals, define the variable in your ``conf/local.conf`` file in + the :term:`Build Directory`. + + If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you + must also use the :term:`BB_DISKMON_DIRS` + 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. + + If you do not provide a ``BB_DISKMON_WARNINTERVAL`` variable and you + do use ``BB_DISKMON_DIRS`` with the "WARN" action, the disk + monitoring interval defaults to the following: + :: + + BB_DISKMON_WARNINTERVAL = "50M,5K" + + When specifying the variable in your configuration file, use the + following form: + + .. code-block:: none + + BB_DISKMON_WARNINTERVAL = "disk_space_interval,disk_inode_interval" + + where: + + disk_space_interval 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. + + disk_inode_interval 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. + + Here is an example: + :: + + BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K" + BB_DISKMON_WARNINTERVAL = "50M,5K" + + 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 ``${SSTATE_DIR}`` + 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). + + :term:`BB_GENERATE_MIRROR_TARBALLS` + Causes tarballs of the source control repositories (e.g. Git + repositories), including metadata, to be placed in the + :term:`DL_DIR` directory. + + For performance reasons, creating and placing tarballs of these + repositories is not the default action by the OpenEmbedded build + system. + :: + + BB_GENERATE_MIRROR_TARBALLS = "1" + + Set this variable in your + ``local.conf`` file in the :term:`Build Directory`. + + Once you have the tarballs containing your source files, you can + clean up your ``DL_DIR`` directory by deleting any Git or other + source control work directories. + + :term:`BB_NUMBER_THREADS` + 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 ``BB_NUMBER_THREADS`` variable to default + to "4". + + 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 ``BB_NUMBER_THREADS`` variable + is not set higher than "20". + + For more information on speeding up builds, see the + ":ref:`dev-manual/common-tasks:speeding up a build`" + section in the Yocto Project Development Tasks Manual. + + :term:`BB_SERVER_TIMEOUT` + Specifies the time (in seconds) after which to unload the BitBake + server due to inactivity. Set ``BB_SERVER_TIMEOUT`` to determine how + long the BitBake server stays resident between invocations. + + For example, the following statement in your ``local.conf`` file + instructs the server to be unloaded after 20 seconds of inactivity: + :: + + BB_SERVER_TIMEOUT = "20" + + If you want the server to never be unloaded, + set ``BB_SERVER_TIMEOUT`` to "-1". + + :term:`BBCLASSEXTEND` + Allows you to extend a recipe so that it builds variants of the + software. Common variants for recipes exist such as "natives" like + ``quilt-native``, which is a copy of Quilt built to run on the build + system; "crosses" such as ``gcc-cross``, which is a compiler built to + run on the build machine but produces binaries that run on the target + :term:`MACHINE`; "nativesdk", which targets the SDK + machine instead of ``MACHINE``; and "mulitlibs" in the form + "``multilib:``\ multilib_name". + + 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: + :: + + BBCLASSEXTEND =+ "native nativesdk" + BBCLASSEXTEND =+ "multilib:multilib_name" + + .. note:: + + Internally, the ``BBCLASSEXTEND`` mechanism generates recipe + variants by rewriting variable values and applying overrides such + as ``_class-native``. For example, to generate a native version of + a recipe, a :term:`DEPENDS` on "foo" is rewritten + to a ``DEPENDS`` on "foo-native". + + Even when using ``BBCLASSEXTEND``, the recipe is only parsed once. + Parsing once adds some limitations. For example, it is not + possible to include a different file depending on the variant, + since ``include`` statements are processed when the recipe is + parsed. + + :term:`BBFILE_COLLECTIONS` + Lists the names of configured layers. These names are used to find + the other ``BBFILE_*`` variables. Typically, each layer will append + its name to this variable in its ``conf/layer.conf`` file. + + :term:`BBFILE_PATTERN` + Variable that expands to match files from + :term:`BBFILES` in a particular layer. This variable + is used in the ``conf/layer.conf`` file and must be suffixed with the + name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``). + + :term:`BBFILE_PRIORITY` + Assigns the priority for recipe files in each layer. + + 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 (:term:`PV` variable). For + example, a layer that has a recipe with a higher ``PV`` value but for + which the ``BBFILE_PRIORITY`` is set to have a lower precedence still + has a lower precedence. + + A larger value for the ``BBFILE_PRIORITY`` variable results in a + higher precedence. For example, the value 6 has a higher precedence + than the value 5. If not specified, the ``BBFILE_PRIORITY`` variable + is set based on layer dependencies (see the ``LAYERDEPENDS`` 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). + + .. tip:: + + You can use the command ``bitbake-layers show-layers`` + to list all configured layers along with their priorities. + + :term:`BBFILES` + A space-separated list of recipe files BitBake uses to build + software. + + When specifying recipe files, you can pattern match using Python's + `glob `_ syntax. + For details on the syntax, see the documentation by following the + previous link. + + :term:`BBFILES_DYNAMIC` + Activates content when identified layers are present. You identify + the layers by the collections that the layers define. + + Use the ``BBFILES_DYNAMIC`` variable to avoid ``.bbappend`` files + whose corresponding ``.bb`` file is in a layer that attempts to + modify other layers through ``.bbappend`` but does not want to + introduce a hard dependency on those other layers. + + Use the following form for ``BBFILES_DYNAMIC``: + collection_name:filename_pattern The following example identifies two + collection names and two filename patterns: + :: + + BBFILES_DYNAMIC += " \ + clang-layer:${LAYERDIR}/bbappends/meta-clang/*/*/*.bbappend \ + core:${LAYERDIR}/bbappends/openembedded-core/meta/*/*/*.bbappend \ + " + + This next example shows an error message that occurs because invalid + entries are found, which cause parsing to abort: + + .. code-block:: none + + ERROR: BBFILES_DYNAMIC entries must be of the form :, not: + /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend + /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend + + :term:`BBINCLUDELOGS` + Variable that controls how BitBake displays logs on build failure. + + :term:`BBINCLUDELOGS_LINES` + If :term:`BBINCLUDELOGS` 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 ``BBINCLUDELOGS_LINES``, + the entire log is printed. + + :term:`BBLAYERS` + Lists the layers to enable during the build. This variable is defined + in the ``bblayers.conf`` configuration file in the :term:`Build Directory`. + Here is an example: + :: + + BBLAYERS = " \ + /home/scottrif/poky/meta \ + /home/scottrif/poky/meta-poky \ + /home/scottrif/poky/meta-yocto-bsp \ + /home/scottrif/poky/meta-mykernel \ + " + + This example enables four layers, one of which is a custom, + user-defined layer named ``meta-mykernel``. + + :term:`BBMASK` + Prevents BitBake from processing recipes and recipe append files. + + You can use the ``BBMASK`` variable to "hide" these ``.bb`` and + ``.bbappend`` 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. + + The values you provide are passed to Python's regular expression + compiler. Consequently, the syntax follows Python's Regular + Expression (re) syntax. The expressions are compared against the full + paths to the files. For complete syntax information, see Python's + documentation at https://docs.python.org/3/library/re.html#regular-expression-syntax. + + The following example uses a complete regular expression to tell + BitBake to ignore all recipe and recipe append files in the + ``meta-ti/recipes-misc/`` directory: + :: + + BBMASK = "meta-ti/recipes-misc/" + + 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: :: + + BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/" + BBMASK += "/meta-oe/recipes-support/" + BBMASK += "/meta-foo/.*/openldap" + BBMASK += "opencv.*\.bbappend" + BBMASK += "lzma" + + .. note:: + + When specifying a directory name, use the trailing slash character + to ensure you match just that directory name. + + :term:`BBMULTICONFIG` + Specifies each additional separate configuration when you are + building targets with multiple configurations. Use this variable in + your ``conf/local.conf`` configuration file. Specify a + multiconfigname for each configuration file you are using. For + example, the following line specifies three configuration files: + :: + + BBMULTICONFIG = "configA configB configC" + + Each configuration file you + use must reside in the :term:`Build Directory` + ``conf/multiconfig`` directory (e.g. + build_directory\ ``/conf/multiconfig/configA.conf``). + + For information on how to use ``BBMULTICONFIG`` in an environment + that supports building targets with multiple configurations, see the + ":ref:`dev-manual/common-tasks:building images for multiple targets using multiple configurations`" + section in the Yocto Project Development Tasks Manual. + + :term:`BBPATH` + Used by BitBake to locate ``.bbclass`` and configuration files. This + variable is analogous to the ``PATH`` variable. + + .. note:: + + If you run BitBake from a directory outside of the + Build Directory + , you must be sure to set + BBPATH + to point to the Build Directory. Set the variable as you would any + environment variable and then run BitBake: + :: + + $ BBPATH = "build_directory" + $ export BBPATH + $ bitbake target + + + :term:`BBSERVER` + If defined in the BitBake environment, ``BBSERVER`` points to the + BitBake remote server. + + Use the following format to export the variable to the BitBake + environment: + :: + + export BBSERVER=localhost:$port + + By default, ``BBSERVER`` also appears in + :term:`bitbake:BB_HASHBASE_WHITELIST`. + Consequently, ``BBSERVER`` is excluded from checksum and dependency + data. + + :term:`BINCONFIG` + When inheriting the + :ref:`binconfig-disabled ` class, + this variable specifies binary configuration scripts to disable in + favor of using ``pkg-config`` to query the information. The + ``binconfig-disabled`` class will modify the specified scripts to + return an error so that calls to them can be easily found and + replaced. + + To add multiple scripts, separate them by spaces. Here is an example + from the ``libpng`` recipe: + :: + + BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config" + + :term:`BINCONFIG_GLOB` + When inheriting the :ref:`binconfig ` 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. + + .. note:: + + The ``BINCONFIG_GLOB`` variable uses + `shell globbing `__, + which is recognition and expansion of wildcards during pattern + matching. Shell globbing is very similar to + `fnmatch `__ + and `glob `__. + + For more information on how this variable works, see + ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`. + You can also find general + information on the class in the + ":ref:`binconfig.bbclass `" section. + + :term:`BP` + The base recipe name and version but without any special recipe name + suffix (i.e. ``-native``, ``lib64-``, and so forth). ``BP`` is + comprised of the following: + :: + + ${BPN}-${PV} + + :term:`BPN` + This variable is a version of the :term:`PN` variable with + common prefixes and suffixes removed, such as ``nativesdk-``, + ``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``. + The exact lists of prefixes and suffixes removed are specified by the + :term:`MLPREFIX` and + :term:`SPECIAL_PKGSUFFIX` variables, + respectively. + + :term:`BUGTRACKER` + 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. + + :term:`BUILD_ARCH` + Specifies the architecture of the build host (e.g. ``i686``). The + OpenEmbedded build system sets the value of ``BUILD_ARCH`` from the + machine name reported by the ``uname`` command. + + :term:`BUILD_AS_ARCH` + Specifies the architecture-specific assembler flags for the build + host. By default, the value of ``BUILD_AS_ARCH`` is empty. + + :term:`BUILD_CC_ARCH` + Specifies the architecture-specific C compiler flags for the build + host. By default, the value of ``BUILD_CC_ARCH`` is empty. + + :term:`BUILD_CCLD` + Specifies the linker command to be used for the build host when the C + compiler is being used as the linker. By default, ``BUILD_CCLD`` + points to GCC and passes as arguments the value of + :term:`BUILD_CC_ARCH`, assuming + ``BUILD_CC_ARCH`` is set. + + :term:`BUILD_CFLAGS` + Specifies the flags to pass to the C compiler when building for the + build host. When building in the ``-native`` context, + :term:`CFLAGS` is set to the value of this variable by + default. + + :term:`BUILD_CPPFLAGS` + Specifies the flags to pass to the C preprocessor (i.e. to both the C + and the C++ compilers) when building for the build host. When + building in the ``-native`` context, :term:`CPPFLAGS` + is set to the value of this variable by default. + + :term:`BUILD_CXXFLAGS` + Specifies the flags to pass to the C++ compiler when building for the + build host. When building in the ``-native`` context, + :term:`CXXFLAGS` is set to the value of this variable + by default. + + :term:`BUILD_FC` + Specifies the Fortran compiler command for the build host. By + default, ``BUILD_FC`` points to Gfortran and passes as arguments the + value of :term:`BUILD_CC_ARCH`, assuming + ``BUILD_CC_ARCH`` is set. + + :term:`BUILD_LD` + Specifies the linker command for the build host. By default, + ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments + the value of :term:`BUILD_LD_ARCH`, assuming + ``BUILD_LD_ARCH`` is set. + + :term:`BUILD_LD_ARCH` + Specifies architecture-specific linker flags for the build host. By + default, the value of ``BUILD_LD_ARCH`` is empty. + + :term:`BUILD_LDFLAGS` + Specifies the flags to pass to the linker when building for the build + host. When building in the ``-native`` context, + :term:`LDFLAGS` is set to the value of this variable + by default. + + :term:`BUILD_OPTIMIZATION` + Specifies the optimization flags passed to the C compiler when + building for the build host or the SDK. The flags are passed through + the :term:`BUILD_CFLAGS` and + :term:`BUILDSDK_CFLAGS` default values. + + The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2 + -pipe". + + :term:`BUILD_OS` + Specifies the operating system in use on the build host (e.g. + "linux"). The OpenEmbedded build system sets the value of + ``BUILD_OS`` from the OS reported by the ``uname`` command - the + first word, converted to lower-case characters. + + :term:`BUILD_PREFIX` + The toolchain binary prefix used for native recipes. The OpenEmbedded + build system uses the ``BUILD_PREFIX`` value to set the + :term:`TARGET_PREFIX` when building for + ``native`` recipes. + + :term:`BUILD_STRIP` + Specifies the command to be used to strip debugging symbols from + binaries produced for the build host. By default, ``BUILD_STRIP`` + points to + ``${``\ :term:`BUILD_PREFIX`\ ``}strip``. + + :term:`BUILD_SYS` + Specifies the system, including the architecture and the operating + system, to use when building for the build host (i.e. when building + ``native`` recipes). + + The OpenEmbedded build system automatically sets this variable based + on :term:`BUILD_ARCH`, + :term:`BUILD_VENDOR`, and + :term:`BUILD_OS`. You do not need to set the + ``BUILD_SYS`` variable yourself. + + :term:`BUILD_VENDOR` + Specifies the vendor name to use when building for the build host. + The default value is an empty string (""). + + :term:`BUILDDIR` + Points to the location of the :term:`Build Directory`. + You can define this directory indirectly through the + :ref:`structure-core-script` script by passing in a Build + Directory path when you run the script. If you run the script and do + not provide a Build Directory path, the ``BUILDDIR`` defaults to + ``build`` in the current directory. + + :term:`BUILDHISTORY_COMMIT` + When inheriting the :ref:`buildhistory ` + 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 ``buildhistory`` + 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". + + By default, the ``buildhistory`` class does not commit the build + history output in a local Git repository: + :: + + BUILDHISTORY_COMMIT ?= "0" + + :term:`BUILDHISTORY_COMMIT_AUTHOR` + When inheriting the :ref:`buildhistory ` + class, this variable specifies the author to use for each Git commit. + In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the + :term:`BUILDHISTORY_COMMIT` variable must + be set to "1". + + Git requires that the value you provide for the + ``BUILDHISTORY_COMMIT_AUTHOR`` variable takes the form of "name + email@host". Providing an email address or host that is not valid + does not produce an error. + + By default, the ``buildhistory`` class sets the variable as follows: + :: + + BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory " + + :term:`BUILDHISTORY_DIR` + When inheriting the :ref:`buildhistory ` + class, this variable specifies the directory in which build history + information is kept. For more information on how the variable works, + see the ``buildhistory.class``. + + By default, the ``buildhistory`` class sets the directory as follows: + :: + + BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" + + :term:`BUILDHISTORY_FEATURES` + When inheriting the :ref:`buildhistory ` + class, this variable specifies the build history features to be + enabled. For more information on how build history works, see the + ":ref:`dev-manual/common-tasks:maintaining build output quality`" + section in the Yocto Project Development Tasks Manual. + + You can specify these features in the form of a space-separated list: + + - *image:* Analysis of the contents of images, which includes the + list of installed packages among other things. + + - *package:* Analysis of the contents of individual packages. + + - *sdk:* Analysis of the contents of the software development kit + (SDK). + + - *task:* Save output file signatures for + :ref:`shared state ` + (sstate) tasks. + This saves one file per task and lists the SHA-256 checksums for + each file staged (i.e. the output of the task). + + By default, the ``buildhistory`` class enables the following + features: + :: + + BUILDHISTORY_FEATURES ?= "image package sdk" + + :term:`BUILDHISTORY_IMAGE_FILES` + When inheriting the :ref:`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. The default is to copy + ``/etc/passwd`` and ``/etc/group``, 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. + + By default, the ``buildhistory`` class provides paths to the + following files: + :: + + BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" + + :term:`BUILDHISTORY_PUSH_REPO` + When inheriting the :ref:`buildhistory ` + class, this variable optionally specifies a remote repository to + which build history pushes Git changes. In order for + ``BUILDHISTORY_PUSH_REPO`` to work, + :term:`BUILDHISTORY_COMMIT` must be set to + "1". + + 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 ``git remote`` within the local + repository. + + By default, the ``buildhistory`` class sets the variable as follows: + :: + + BUILDHISTORY_PUSH_REPO ?= "" + + :term:`BUILDSDK_CFLAGS` + Specifies the flags to pass to the C compiler when building for the + SDK. When building in the ``nativesdk-`` context, + :term:`CFLAGS` is set to the value of this variable by + default. + + :term:`BUILDSDK_CPPFLAGS` + 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 ``nativesdk-`` context, :term:`CPPFLAGS` is set + to the value of this variable by default. + + :term:`BUILDSDK_CXXFLAGS` + Specifies the flags to pass to the C++ compiler when building for the + SDK. When building in the ``nativesdk-`` context, + :term:`CXXFLAGS` is set to the value of this variable + by default. + + :term:`BUILDSDK_LDFLAGS` + Specifies the flags to pass to the linker when building for the SDK. + When building in the ``nativesdk-`` context, + :term:`LDFLAGS` is set to the value of this variable + by default. + + :term:`BUILDSTATS_BASE` + Points to the location of the directory that holds build statistics + when you use and enable the + :ref:`buildstats ` class. The + ``BUILDSTATS_BASE`` directory defaults to + ``${``\ :term:`TMPDIR`\ ``}/buildstats/``. + + :term:`BUSYBOX_SPLIT_SUID` + 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 (i.e. those that + do not require ``setuid root``). + + The ``BUSYBOX_SPLIT_SUID`` variable defaults to "1", which results in + splitting the output executable file. Set the variable to "0" to get + a single output executable file. + + :term:`CACHE` + Specifies the directory BitBake uses to store a cache of the + :term:`Metadata` so it does not need to be parsed every time + BitBake is started. + + :term:`CC` + The minimal command and arguments used to run the C compiler. + + :term:`CFLAGS` + 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. + + Default initialization for ``CFLAGS`` varies depending on what is + being built: + + - :term:`TARGET_CFLAGS` when building for the + target + + - :term:`BUILD_CFLAGS` when building for the + build host (i.e. ``-native``) + + - :term:`BUILDSDK_CFLAGS` when building for + an SDK (i.e. ``nativesdk-``) + + :term:`CLASSOVERRIDE` + 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 (e.g. + :ref:`native `, + :ref:`nativesdk `, and so forth) set the + variable to appropriate values. + + .. note:: + + ``CLASSOVERRIDE`` gets its default "class-target" value from the + ``bitbake.conf`` file. + + As an example, the following override allows you to install extra + files, but only when building for the target: + :: + + do_install_append_class-target() { + install my-extra-file ${D}${sysconfdir} + } + + Here is an example where ``FOO`` is set to + "native" when building for the build host, and to "other" when not + building for the build host: + :: + + FOO_class-native = "native" + FOO = "other" + + The underlying mechanism behind ``CLASSOVERRIDE`` is simply + that it is included in the default value of + :term:`OVERRIDES`. + + :term:`CLEANBROKEN` + If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the + ``make clean`` command does not work for the software being built. + Consequently, the OpenEmbedded build system will not try to run + ``make clean`` during the :ref:`ref-tasks-configure` + task, which is the default behavior. + + :term:`COMBINED_FEATURES` + Provides a list of hardware features that are enabled in both + :term:`MACHINE_FEATURES` and + :term:`DISTRO_FEATURES`. 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. + + :term:`COMMON_LICENSE_DIR` + Points to ``meta/files/common-licenses`` in the + :term:`Source Directory`, which is where generic license + files reside. + + :term:`COMPATIBLE_HOST` + 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 :term:`HOST_SYS`. 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. + + :term:`COMPATIBLE_MACHINE` + A regular expression that resolves to one or more target machines + with which a recipe is compatible. The regular expression is matched + against :term:`MACHINEOVERRIDES`. 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. + + :term:`COMPLEMENTARY_GLOB` + Defines wildcards to match when installing a list of complementary + packages for all the packages explicitly (or implicitly) installed in + an image. + + .. note:: + + The ``COMPLEMENTARY_GLOB`` variable uses Unix filename pattern matching + (`fnmatch `__), + which is similar to the Unix style pathname pattern expansion + (`glob `__). + + The resulting list of complementary packages is associated with an + item that can be added to + :term:`IMAGE_FEATURES`. An example usage of + this is the "dev-pkgs" item that when added to ``IMAGE_FEATURES`` + will install -dev packages (containing headers and other development + files) for every package in the image. + + 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: + :: + + COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev' + + :term:`COMPONENTS_DIR` + Stores sysroot components for each recipe. The OpenEmbedded build + system uses ``COMPONENTS_DIR`` when constructing recipe-specific + sysroots for other recipes. + + The default is + "``${``\ :term:`STAGING_DIR`\ ``}-components``." + (i.e. + "``${``\ :term:`TMPDIR`\ ``}/sysroots-components``"). + + :term:`CONF_VERSION` + Tracks the version of the local configuration file (i.e. + ``local.conf``). The value for ``CONF_VERSION`` increments each time + ``build/conf/`` compatibility changes. + + :term:`CONFFILES` + 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 ``CONFFILES`` + variable to list the files in the package that you wish to prevent + the PMS from overwriting during this update process. + + To use the ``CONFFILES`` variable, provide a package name override + that identifies the resulting package. Then, provide a + space-separated list of files. Here is an example: + :: + + CONFFILES_${PN} += "${sysconfdir}/file1 \ + ${sysconfdir}/file2 ${sysconfdir}/file3" + + A relationship exists between the ``CONFFILES`` and ``FILES`` + variables. The files listed within ``CONFFILES`` must be a subset of + the files listed within ``FILES``. Because the configuration files + you provide with ``CONFFILES`` 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 ``FILES`` + variable. + + .. note:: + + When specifying paths as part of the ``CONFFILES`` variable, it is + good practice to use appropriate path variables. + For example, ``${sysconfdir}`` rather than ``/etc`` or ``${bindir}`` + rather than ``/usr/bin``. You can find a list of these variables at + the top of the ``meta/conf/bitbake.conf`` file in the + :term:`Source Directory`. + + :term:`CONFIG_INITRAMFS_SOURCE` + Identifies the initial RAM filesystem (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 (""). + + The ``CONFIG_INITRAMFS_SOURCE`` can be either a single cpio archive + with a ``.cpio`` 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 ``usr/gen_init_cpio`` program in the kernel tree. + + If you specify multiple directories and files, the initramfs image + will be the aggregate of all of them. + + For information on creating an initramfs, see the + ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section + in the Yocto Project Development Tasks Manual. + + :term:`CONFIG_SITE` + 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``. + + :term:`CONFIGURE_FLAGS` + The minimal arguments for GNU configure. + + :term:`CONFLICT_DISTRO_FEATURES` + When inheriting the + :ref:`features_check ` + class, this variable identifies distribution features that would be + in conflict should the recipe be built. In other words, if the + ``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also + appears in ``DISTRO_FEATURES`` within the current configuration, then + the recipe will be skipped, and if the build system attempts to build + the recipe then an error will be triggered. + + :term:`COPYLEFT_LICENSE_EXCLUDE` + A space-separated list of licenses to exclude from the source + archived by the :ref:`archiver ` class. In + other words, if a license in a recipe's + :term:`LICENSE` value is in the value of + ``COPYLEFT_LICENSE_EXCLUDE``, then its source is not archived by the + class. + + .. note:: + + The ``COPYLEFT_LICENSE_EXCLUDE`` variable takes precedence over the + :term:`COPYLEFT_LICENSE_INCLUDE` variable. + + The default value, which is "CLOSED Proprietary", for + ``COPYLEFT_LICENSE_EXCLUDE`` is set by the + :ref:`copyleft_filter ` class, which + is inherited by the ``archiver`` class. + + :term:`COPYLEFT_LICENSE_INCLUDE` + A space-separated list of licenses to include in the source archived + by the :ref:`archiver ` class. In other + words, if a license in a recipe's :term:`LICENSE` + value is in the value of ``COPYLEFT_LICENSE_INCLUDE``, then its + source is archived by the class. + + The default value is set by the + :ref:`copyleft_filter ` class, which + is inherited by the ``archiver`` class. The default value includes + "GPL*", "LGPL*", and "AGPL*". + + :term:`COPYLEFT_PN_EXCLUDE` + A list of recipes to exclude in the source archived by the + :ref:`archiver ` class. The + ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and + exclusion caused through the + :term:`COPYLEFT_LICENSE_INCLUDE` and + :term:`COPYLEFT_LICENSE_EXCLUDE` + variables, respectively. + + The default value, which is "" indicating to not explicitly exclude + any recipes by name, for ``COPYLEFT_PN_EXCLUDE`` is set by the + :ref:`copyleft_filter ` class, which + is inherited by the ``archiver`` class. + + :term:`COPYLEFT_PN_INCLUDE` + A list of recipes to include in the source archived by the + :ref:`archiver ` class. The + ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and + exclusion caused through the + :term:`COPYLEFT_LICENSE_INCLUDE` and + :term:`COPYLEFT_LICENSE_EXCLUDE` + variables, respectively. + + The default value, which is "" indicating to not explicitly include + any recipes by name, for ``COPYLEFT_PN_INCLUDE`` is set by the + :ref:`copyleft_filter ` class, which + is inherited by the ``archiver`` class. + + :term:`COPYLEFT_RECIPE_TYPES` + A space-separated list of recipe types to include in the source + archived by the :ref:`archiver ` class. + Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``, + ``crosssdk``, and ``cross-canadian``. + + The default value, which is "target*", for ``COPYLEFT_RECIPE_TYPES`` + is set by the :ref:`copyleft_filter ` + class, which is inherited by the ``archiver`` class. + + :term:`COPY_LIC_DIRS` + If set to "1" along with the + :term:`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. The license files are placed in directories within the image + itself during build time. + + .. note:: + + The ``COPY_LIC_DIRS`` 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 + :term:`LICENSE_CREATE_PACKAGE` variable for additional information. + You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" + section in the Yocto Project Development Tasks Manual for + information on providing license text. + + :term:`COPY_LIC_MANIFEST` + 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 during build time. + + .. note:: + + The ``COPY_LIC_MANIFEST`` 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 + :term:`LICENSE_CREATE_PACKAGE` variable for additional information. + You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" + section in the Yocto Project Development Tasks Manual for + information on providing license text. + + :term:`CORE_IMAGE_EXTRA_INSTALL` + Specifies the list of packages to be added to the image. You should + only set this variable in the ``local.conf`` configuration file found + in the :term:`Build Directory`. + + This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer + supported. + + :term:`COREBASE` + Specifies the parent directory of the OpenEmbedded-Core Metadata + layer (i.e. ``meta``). + + It is an important distinction that ``COREBASE`` 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 ``poky`` name + for your local copy of the repository. In this case, ``COREBASE`` + points to the ``poky`` folder because it is the parent directory of + the ``poky/meta`` layer. + + :term:`COREBASE_FILES` + Lists files from the :term:`COREBASE` directory that + should be copied other than the layers listed in the + ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for + the purpose of copying metadata from the OpenEmbedded build system + into the extensible SDK. + + Explicitly listing files in ``COREBASE`` 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 ``COREBASE_FILES`` is used in order to only copy the files that + are actually needed. + + :term:`CPP` + The minimal command and arguments used to run the C preprocessor. + + :term:`CPPFLAGS` + 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. + + Default initialization for ``CPPFLAGS`` varies depending on what is + being built: + + - :term:`TARGET_CPPFLAGS` when building for + the target + + - :term:`BUILD_CPPFLAGS` when building for the + build host (i.e. ``-native``) + + - :term:`BUILDSDK_CPPFLAGS` when building + for an SDK (i.e. ``nativesdk-``) + + :term:`CROSS_COMPILE` + The toolchain binary prefix for the target tools. The + ``CROSS_COMPILE`` variable is the same as the + :term:`TARGET_PREFIX` variable. + + .. note:: + + The OpenEmbedded build system sets the ``CROSS_COMPILE`` + variable only in certain contexts (e.g. when building for kernel + and kernel module recipes). + + :term:`CVSDIR` + The directory in which files checked out under the CVS system are + stored. + + :term:`CXX` + The minimal command and arguments used to run the C++ compiler. + + :term:`CXXFLAGS` + 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. + + Default initialization for ``CXXFLAGS`` varies depending on what is + being built: + + - :term:`TARGET_CXXFLAGS` when building for + the target + + - :term:`BUILD_CXXFLAGS` when building for the + build host (i.e. ``-native``) + + - :term:`BUILDSDK_CXXFLAGS` when building + for an SDK (i.e. ``nativesdk-``) + + :term:`D` + The destination directory. The location in the :term:`Build Directory` + where components are installed by the + :ref:`ref-tasks-install` task. This location defaults + to: + :: + + ${WORKDIR}/image + + .. note:: + + Tasks that read from or write to this directory should run under + :ref:`fakeroot `. + + :term:`DATE` + The date the build was started. Dates appear using the year, month, + and day (YMD) format (e.g. "20150209" for February 9th, 2015). + + :term:`DATETIME` + The date and time on which the current build started. The format is + suitable for timestamps. + + :term:`DEBIAN_NOAUTONAME` + When the :ref:`debian ` class is inherited, + which is the default behavior, ``DEBIAN_NOAUTONAME`` 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 ``fontconfig`` recipe: + :: + + DEBIAN_NOAUTONAME_fontconfig-utils = "1" + + :term:`DEBIANNAME` + When the :ref:`debian ` class is inherited, + which is the default behavior, ``DEBIANNAME`` 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 + ``dbus`` recipe: + :: + + DEBIANNAME_${PN} = "dbus-1" + + :term:`DEBUG_BUILD` + Specifies to build packages with debugging information. This + influences the value of the ``SELECTED_OPTIMIZATION`` variable. + + :term:`DEBUG_OPTIMIZATION` + The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when + compiling a system for debugging. This variable defaults to "-O + -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe". + + :term:`DEFAULT_PREFERENCE` + Specifies a weak bias for recipe selection priority. + + 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 ``PREFERRED_VERSION`` being used to + build the development version. + + .. note:: + + The bias provided by ``DEFAULT_PREFERENCE`` is weak and is overridden + by :term:`BBFILE_PRIORITY` if that variable is different between two + layers that contain different versions of the same recipe. + + :term:`DEFAULTTUNE` + The default CPU and Application Binary Interface (ABI) tunings (i.e. + the "tune") used by the OpenEmbedded build system. The + ``DEFAULTTUNE`` helps define + :term:`TUNE_FEATURES`. + + The default tune is either implicitly or explicitly set by the + machine (:term:`MACHINE`). However, you can override + the setting using available tunes as defined with + :term:`AVAILTUNES`. + + :term:`DEPENDS` + Lists a recipe's build-time dependencies. These are dependencies on + other recipes whose contents (e.g. headers and shared libraries) are + needed by the recipe at build time. + + As an example, consider a recipe ``foo`` that contains the following + assignment: + :: + + DEPENDS = "bar" + + The practical effect of the previous + assignment is that all files installed by bar will be available in + the appropriate staging sysroot, given by the + :term:`STAGING_DIR* ` variables, by the time the + :ref:`ref-tasks-configure` task for ``foo`` runs. + This mechanism is implemented by having ``do_configure`` depend on + the :ref:`ref-tasks-populate_sysroot` task of + each recipe listed in ``DEPENDS``, through a + ``[``\ :ref:`deptask `\ ``]`` + declaration in the :ref:`base ` class. + + .. note:: + + It seldom is necessary to reference, for example, ``STAGING_DIR_HOST`` + explicitly. The standard classes and build-related variables are + configured to automatically use the appropriate staging sysroots. + + As another example, ``DEPENDS`` can also be used to add utilities + that run on the build machine during the build. For example, a recipe + that makes use of a code generator built by the recipe ``codegen`` + might have the following: + :: + + DEPENDS = "codegen-native" + + For more + information, see the :ref:`native ` class and + the :term:`EXTRANATIVEPATH` variable. + + .. note:: + + - ``DEPENDS`` is a list of recipe names. Or, to be more precise, + it is a list of :term:`PROVIDES` names, which + usually match recipe names. Putting a package name such as + "foo-dev" in ``DEPENDS`` does not make sense. Use "foo" + instead, as this will put files from all the packages that make + up ``foo``, which includes those from ``foo-dev``, into the + sysroot. + + - One recipe having another recipe in ``DEPENDS`` does not by + itself add any runtime dependencies between the packages + produced by the two recipes. However, as explained in the + ":ref:`overview-manual/concepts:automatically added runtime dependencies`" + section in the Yocto Project Overview and Concepts Manual, + runtime dependencies will often be added automatically, meaning + ``DEPENDS`` alone is sufficient for most recipes. + + - Counterintuitively, ``DEPENDS`` is often necessary even for + recipes that install precompiled components. For example, if + ``libfoo`` is a precompiled library that links against + ``libbar``, then linking against ``libfoo`` requires both + ``libfoo`` and ``libbar`` to be available in the sysroot. + Without a ``DEPENDS`` from the recipe that installs ``libfoo`` + to the recipe that installs ``libbar``, other recipes might + fail to link against ``libfoo``. + + For information on runtime dependencies, see the + :term:`RDEPENDS` variable. You can also see the + ":ref:`Tasks `" and + ":ref:`Dependencies `" sections in the + BitBake User Manual for additional information on tasks and + dependencies. + + :term:`DEPLOY_DIR` + 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 :term:`Build Directory` as + ``${TMPDIR}/deploy``. + + For more information on the structure of the Build Directory, see + ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. + For more detail on the contents of the ``deploy`` directory, see the + ":ref:`overview-manual/concepts:images`", + ":ref:`overview-manual/concepts:package feeds`", and + ":ref:`overview-manual/concepts:application development sdk`" sections all in the + Yocto Project Overview and Concepts Manual. + + :term:`DEPLOY_DIR_DEB` + 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 + :term:`PACKAGE_CLASSES` contains + "package_deb". + + The BitBake configuration file initially defines the + ``DEPLOY_DIR_DEB`` variable as a sub-folder of + :term:`DEPLOY_DIR`: + :: + + DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" + + The :ref:`package_deb ` class uses the + ``DEPLOY_DIR_DEB`` variable to make sure the + :ref:`ref-tasks-package_write_deb` task + writes Debian packages into the appropriate folder. For more + information on how packaging works, see the + ":ref:`overview-manual/concepts:package feeds`" section + in the Yocto Project Overview and Concepts Manual. + + :term:`DEPLOY_DIR_IMAGE` + 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 ``${MACHINE}`` name. By default, this directory + resides within the :term:`Build Directory` as + ``${DEPLOY_DIR}/images/${MACHINE}/``. + + For more information on the structure of the Build Directory, see + ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. + For more detail on the contents of the ``deploy`` directory, see the + ":ref:`overview-manual/concepts:images`" and + ":ref:`overview-manual/concepts:application development sdk`" sections both in + the Yocto Project Overview and Concepts Manual. + + :term:`DEPLOY_DIR_IPK` + 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 + :term:`PACKAGE_CLASSES` contains + "package_ipk". + + The BitBake configuration file initially defines this variable as a + sub-folder of :term:`DEPLOY_DIR`: + :: + + DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk" + + The :ref:`package_ipk ` class uses the + ``DEPLOY_DIR_IPK`` variable to make sure the + :ref:`ref-tasks-package_write_ipk` task + writes IPK packages into the appropriate folder. For more information + on how packaging works, see the + ":ref:`overview-manual/concepts:package feeds`" section + in the Yocto Project Overview and Concepts Manual. + + :term:`DEPLOY_DIR_RPM` + 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 + :term:`PACKAGE_CLASSES` contains + "package_rpm". + + The BitBake configuration file initially defines this variable as a + sub-folder of :term:`DEPLOY_DIR`: + :: + + DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm" + + The :ref:`package_rpm ` class uses the + ``DEPLOY_DIR_RPM`` variable to make sure the + :ref:`ref-tasks-package_write_rpm` task + writes RPM packages into the appropriate folder. For more information + on how packaging works, see the + ":ref:`overview-manual/concepts:package feeds`" section + in the Yocto Project Overview and Concepts Manual. + + :term:`DEPLOY_DIR_TAR` + 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 + :term:`PACKAGE_CLASSES` contains + "package_tar". + + The BitBake configuration file initially defines this variable as a + sub-folder of :term:`DEPLOY_DIR`: + :: + + DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar" + + The :ref:`package_tar ` class uses the + ``DEPLOY_DIR_TAR`` variable to make sure the + :ref:`ref-tasks-package_write_tar` task + writes TAR packages into the appropriate folder. For more information + on how packaging works, see the + ":ref:`overview-manual/concepts:package feeds`" section + in the Yocto Project Overview and Concepts Manual. + + :term:`DEPLOYDIR` + When inheriting the :ref:`deploy ` class, the + ``DEPLOYDIR`` points to a temporary work area for deployed files that + is set in the ``deploy`` class as follows: + :: + + DEPLOYDIR = "${WORKDIR}/deploy-${PN}" + + Recipes inheriting the ``deploy`` class should copy files to be + deployed into ``DEPLOYDIR``, and the class will take care of copying + them into :term:`DEPLOY_DIR_IMAGE` + afterwards. + + :term:`DESCRIPTION` + The package description used by package managers. If not set, + ``DESCRIPTION`` takes the value of the :term:`SUMMARY` + variable. + + :term:`DISTRO` + The short name of the distribution. For information on the long name + of the distribution, see the :term:`DISTRO_NAME` + variable. + + The ``DISTRO`` variable corresponds to a distribution configuration + file whose root name is the same as the variable's argument and whose + filename extension is ``.conf``. For example, the distribution + configuration file for the Poky distribution is named ``poky.conf`` + and resides in the ``meta-poky/conf/distro`` directory of the + :term:`Source Directory`. + + Within that ``poky.conf`` file, the ``DISTRO`` variable is set as + follows: + :: + + DISTRO = "poky" + + Distribution configuration files are located in a ``conf/distro`` + directory within the :term:`Metadata` that contains the + distribution configuration. The value for ``DISTRO`` must not contain + spaces, and is typically all lower-case. + + .. note:: + + If the ``DISTRO`` variable is blank, a set of default configurations + are used, which are specified within + ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory. + + :term:`DISTRO_CODENAME` + Specifies a codename for the distribution being built. + + :term:`DISTRO_EXTRA_RDEPENDS` + Specifies a list of distro-specific packages to add to all images. + This variable takes affect through ``packagegroup-base`` so the + variable only really applies to the more full-featured images that + include ``packagegroup-base``. 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 ``.conf`` file. + + :term:`DISTRO_EXTRA_RRECOMMENDS` + 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. + + :term:`DISTRO_FEATURES` + The software support you want in your distribution for various + features. You define your distribution features in the distribution + configuration file. + + In most cases, the presence or absence of a feature in + ``DISTRO_FEATURES`` is translated to the appropriate option supplied + to the configure script during the + :ref:`ref-tasks-configure` task for recipes that + optionally support the feature. For example, specifying "x11" in + ``DISTRO_FEATURES``, causes every piece of software built for the + target that can optionally support X11 to have its X11 support + enabled. + + 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 ":ref:`ref-features-distro`" section. + + :term:`DISTRO_FEATURES_BACKFILL` + 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. 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 ":ref:`ref-features-backfill`" section + for more information. + + :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` + Features from ``DISTRO_FEATURES_BACKFILL`` that should not be + backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See + the ":ref:`ref-features-backfill`" section for more information. + + :term:`DISTRO_FEATURES_DEFAULT` + A convenience variable that gives you the default list of distro + features with the exception of any features specific to the C library + (``libc``). + + When creating a custom distribution, you might find it useful to be + able to reuse the default + :term:`DISTRO_FEATURES` options without the + need to write out the full set. Here is an example that uses + ``DISTRO_FEATURES_DEFAULT`` from a custom distro configuration file: + :: + + DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature" + + :term:`DISTRO_FEATURES_FILTER_NATIVE` + Specifies a list of features that if present in the target + :term:`DISTRO_FEATURES` value should be + included in ``DISTRO_FEATURES`` when building native recipes. This + variable is used in addition to the features filtered using the + :term:`DISTRO_FEATURES_NATIVE` + variable. + + :term:`DISTRO_FEATURES_FILTER_NATIVESDK` + Specifies a list of features that if present in the target + :term:`DISTRO_FEATURES` value should be + included in ``DISTRO_FEATURES`` when building nativesdk recipes. This + variable is used in addition to the features filtered using the + :term:`DISTRO_FEATURES_NATIVESDK` + variable. + + :term:`DISTRO_FEATURES_NATIVE` + Specifies a list of features that should be included in + :term:`DISTRO_FEATURES` when building native + recipes. This variable is used in addition to the features filtered + using the + :term:`DISTRO_FEATURES_FILTER_NATIVE` + variable. + + :term:`DISTRO_FEATURES_NATIVESDK` + Specifies a list of features that should be included in + :term:`DISTRO_FEATURES` when building + nativesdk recipes. This variable is used in addition to the features + filtered using the + :term:`DISTRO_FEATURES_FILTER_NATIVESDK` + variable. + + :term:`DISTRO_NAME` + The long name of the distribution. For information on the short name + of the distribution, see the :term:`DISTRO` variable. + + The ``DISTRO_NAME`` variable corresponds to a distribution + configuration file whose root name is the same as the variable's + argument and whose filename extension is ``.conf``. For example, the + distribution configuration file for the Poky distribution is named + ``poky.conf`` and resides in the ``meta-poky/conf/distro`` directory + of the :term:`Source Directory`. + + Within that ``poky.conf`` file, the ``DISTRO_NAME`` variable is set + as follows: + :: + + DISTRO_NAME = "Poky (Yocto Project Reference Distro)" + + Distribution configuration files are located in a ``conf/distro`` + directory within the :term:`Metadata` that contains the + distribution configuration. + + .. note:: + + If the ``DISTRO_NAME`` variable is blank, a set of default + configurations are used, which are specified within + ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory. + + :term:`DISTRO_VERSION` + The version of the distribution. + + :term:`DISTROOVERRIDES` + A colon-separated list of overrides specific to the current + distribution. By default, this list includes the value of + :term:`DISTRO`. + + You can extend ``DISTROOVERRIDES`` to add extra overrides that should + apply to the distribution. + + The underlying mechanism behind ``DISTROOVERRIDES`` is simply that it + is included in the default value of + :term:`OVERRIDES`. + + :term:`DL_DIR` + The central download directory used by the build process to store + downloads. By default, ``DL_DIR`` gets files suitable for mirroring + for everything except Git repositories. If you want tarballs of Git + repositories, use the + :term:`BB_GENERATE_MIRROR_TARBALLS` + variable. + + You can set this directory by defining the ``DL_DIR`` variable in the + ``conf/local.conf`` file. This directory is self-maintaining and you + should not have to touch it. By default, the directory is + ``downloads`` in the :term:`Build Directory`. + :: + + #DL_DIR ?= "${TOPDIR}/downloads" + + To specify a different download directory, + simply remove the comment from the line and provide your directory. + + 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 ``DL_DIR`` 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. + + 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 ":doc:`faq`" + chapter. You can also refer to the + ":yocto_wiki:`Working Behind a Network Proxy `" + Wiki page. + + :term:`DOC_COMPRESS` + When inheriting the :ref:`compress_doc ` + 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. + + For information on policies and on how to use this variable, see the + comments in the ``meta/classes/compress_doc.bbclass`` file. + + :term:`EFI_PROVIDER` + When building bootable images (i.e. where ``hddimg``, ``iso``, or + ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the + ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The + default is "grub-efi", but "systemd-boot" can be used instead. + + See the :ref:`systemd-boot ` and + :ref:`image-live ` classes for more + information. + + :term:`ENABLE_BINARY_LOCALE_GENERATION` + Variable that controls which locales for ``glibc`` are generated + during the build (useful if the target device has 64Mbytes of RAM or + less). + + :term:`ERR_REPORT_DIR` + When used with the :ref:`report-error ` + class, specifies the path used for storing the debug files created by + the :ref:`error reporting + tool `, which + allows you to submit build errors you encounter to a central + database. By default, the value of this variable is + ``${``\ :term:`LOG_DIR`\ ``}/error-report``. + + You can set ``ERR_REPORT_DIR`` to the path you want the error + reporting tool to store the debug files as follows in your + ``local.conf`` file: + :: + + ERR_REPORT_DIR = "path" + + :term:`ERROR_QA` + 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 + ":ref:`insane.bbclass `" section. + + :term:`EXCLUDE_FROM_SHLIBS` + 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 ``package_do_shlibs``, which is part of the + :ref:`ref-tasks-package` task. You should be aware that the shared + libraries resolver might implicitly define some dependencies between + packages. + + The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the + :term:`PRIVATE_LIBS` variable, which excludes a + package's particular libraries only and not the whole package. + + Use the ``EXCLUDE_FROM_SHLIBS`` variable by setting it to "1" for a + particular package: + :: + + EXCLUDE_FROM_SHLIBS = "1" + + :term:`EXCLUDE_FROM_WORLD` + Directs BitBake to exclude a recipe from world builds (i.e. + ``bitbake world``). During world builds, BitBake locates, parses and + builds all recipes found in every layer exposed in the + ``bblayers.conf`` configuration file. + + To exclude a recipe from a world build using this variable, set the + variable to "1" in the recipe. + + .. note:: + + Recipes added to ``EXCLUDE_FROM_WORLD`` may still be built during a + world build in order to satisfy dependencies of other recipes. Adding + a recipe to ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not + explicitly added to the list of build targets in a world build. + + :term:`EXTENDPE` + Used with file and pathnames to create a prefix for a recipe's + version based on the recipe's :term:`PE` value. If ``PE`` + is set and greater than zero for a recipe, ``EXTENDPE`` becomes that + value (e.g if ``PE`` is equal to "1" then ``EXTENDPE`` becomes "1"). + If a recipe's ``PE`` is not set (the default) or is equal to zero, + ``EXTENDPE`` becomes "". + + See the :term:`STAMP` variable for an example. + + :term:`EXTENDPKGV` + 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: + :: + + RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})" + + The dependency relationships are intended to force the package + manager to upgrade these types of packages in lock-step. + + :term:`EXTERNAL_KERNEL_TOOLS` + When set, the ``EXTERNAL_KERNEL_TOOLS`` variable indicates that these + tools are not in the source tree. + + When kernel tools are available in the tree, they are preferred over + any externally installed tools. Setting the ``EXTERNAL_KERNEL_TOOLS`` + variable tells the OpenEmbedded build system to prefer the installed + external tools. See the + :ref:`kernel-yocto ` class in + ``meta/classes`` to see how the variable is used. + + :term:`EXTERNALSRC` + When inheriting the :ref:`externalsrc ` + class, this variable points to the source tree, which is outside of + the OpenEmbedded build system. When set, this variable sets the + :term:`S` variable, which is what the OpenEmbedded build + system uses to locate unpacked recipe source code. + + For more information on ``externalsrc.bbclass``, see the + ":ref:`externalsrc.bbclass `" section. You + can also find information on how to use this variable in the + ":ref:`dev-manual/common-tasks:building software from an external source`" + section in the Yocto Project Development Tasks Manual. + + :term:`EXTERNALSRC_BUILD` + When inheriting the :ref:`externalsrc ` + 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 :term:`B` variable, + which is what the OpenEmbedded build system uses to locate the Build + Directory. + + For more information on ``externalsrc.bbclass``, see the + ":ref:`externalsrc.bbclass `" section. You + can also find information on how to use this variable in the + ":ref:`dev-manual/common-tasks:building software from an external source`" + section in the Yocto Project Development Tasks Manual. + + :term:`EXTRA_AUTORECONF` + For recipes inheriting the :ref:`autotools ` + class, you can use ``EXTRA_AUTORECONF`` to specify extra options to + pass to the ``autoreconf`` command that is executed during the + :ref:`ref-tasks-configure` task. + + The default value is "--exclude=autopoint". + + :term:`EXTRA_IMAGE_FEATURES` + A list of additional features to include in an image. When listing + more than one feature, separate them with a space. + + Typically, you configure this variable in your ``local.conf`` file, + which is found in the :term:`Build Directory`. + 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 + :term:`IMAGE_FEATURES` variable. + + Here are some examples of features you can add: + + - "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 ":ref:`ref-features-image`" + 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 + ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" + section in the Yocto Project Development Tasks 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. + + For a complete list of image features that ships with the Yocto + Project, see the ":ref:`ref-features-image`" section. + + For an example that shows how to customize your image by using this + variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" + section in the Yocto Project Development Tasks Manual. + + :term:`EXTRA_IMAGECMD` + Specifies additional options for the image creation command that has + been specified in :term:`IMAGE_CMD`. When setting + this variable, use an override for the associated image type. Here is + an example: + :: + + EXTRA_IMAGECMD_ext3 ?= "-i 4096" + + :term:`EXTRA_IMAGEDEPENDS` + A list of recipes to build that do not provide packages for + installing into the root filesystem. + + Sometimes a recipe is required to build the final image but is not + needed in the root filesystem. You can use the ``EXTRA_IMAGEDEPENDS`` + variable to list these recipes and thus specify the dependencies. A + typical example is a required bootloader in a machine configuration. + + .. note:: + + To add packages to the root filesystem, see the various + \*:term:`RDEPENDS` and \*:term:`RRECOMMENDS` variables. + + :term:`EXTRANATIVEPATH` + A list of subdirectories of + ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}`` + added to the beginning of the environment variable ``PATH``. As an + example, the following prepends + "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to + ``PATH``: + :: + + EXTRANATIVEPATH = "foo bar" + + :term:`EXTRA_OECMAKE` + Additional `CMake `__ options. See the + :ref:`cmake ` class for additional information. + + :term:`EXTRA_OECONF` + Additional ``configure`` script options. See + :term:`PACKAGECONFIG_CONFARGS` for + additional information on passing configure script options. + + :term:`EXTRA_OEMAKE` + Additional GNU ``make`` options. + + Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the + variable to specify any required GNU options. + + :term:`PARALLEL_MAKE` and + :term:`PARALLEL_MAKEINST` also make use of + ``EXTRA_OEMAKE`` to pass the required flags. + + :term:`EXTRA_OESCONS` + When inheriting the :ref:`scons ` class, this + variable specifies additional configuration options you want to pass + to the ``scons`` command line. + + :term:`EXTRA_USERS_PARAMS` + When inheriting the :ref:`extrausers ` + 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 + :ref:`useradd ` class, which ties user and + group configurations to a specific recipe. + + The set list of commands you can configure using the + ``EXTRA_USERS_PARAMS`` is shown in the ``extrausers`` class. These + commands map to the normal Unix commands of the same names: + :: + + # EXTRA_USERS_PARAMS = "\ + # useradd -p '' tester; \ + # groupadd developers; \ + # userdel nobody; \ + # groupdel -g video; \ + # groupmod -g 1020 developers; \ + # usermod -s /bin/sh tester; \ + # " + + :term:`FEATURE_PACKAGES` + Defines one or more packages to include in an image when a specific + item is included in :term:`IMAGE_FEATURES`. + When setting the value, ``FEATURE_PACKAGES`` should have the name of + the feature item as an override. Here is an example: + :: + + FEATURE_PACKAGES_widget = "package1 package2" + + In this example, if "widget" were added to ``IMAGE_FEATURES``, + package1 and package2 would be included in the image. + + .. note:: + + Packages installed by features defined through ``FEATURE_PACKAGES`` + are often package groups. While similarly named, you should not + confuse the ``FEATURE_PACKAGES`` variable with package groups, which + are discussed elsewhere in the documentation. + + :term:`FEED_DEPLOYDIR_BASE_URI` + 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 ``local.conf`` file. + + Consider the following example: + :: + + FEED_DEPLOYDIR_BASE_URI = "http://192.168.7.1/BOARD-dir" + + This example assumes you are serving + your packages over HTTP and your databases are located in a directory + named ``BOARD-dir``, 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. + + :term:`FILES` + The list of files and directories that are placed in a package. The + :term:`PACKAGES` variable lists the packages + generated by a recipe. + + To use the ``FILES`` 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: + :: + + FILES_${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile" + + .. note:: + + - When specifying files or paths, you can pattern match using + Python's + `glob `_ + syntax. For details on the syntax, see the documentation by + following the previous link. + + - When specifying paths as part of the ``FILES`` variable, it is + good practice to use appropriate path variables. For example, + use ``${sysconfdir}`` rather than ``/etc``, or ``${bindir}`` + rather than ``/usr/bin``. You can find a list of these + variables at the top of the ``meta/conf/bitbake.conf`` file in + the :term:`Source Directory`. You will also + find the default values of the various ``FILES_*`` variables in + this file. + + If some of the files you provide with the ``FILES`` 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 :term:`CONFFILES` variable for information on + how to identify these files to the PMS. + + :term:`FILES_SOLIBSDEV` + Defines the file specification to match + :term:`SOLIBSDEV`. In other words, + ``FILES_SOLIBSDEV`` defines the full path name of the development + symbolic link (symlink) for shared libraries on the target platform. + + The following statement from the ``bitbake.conf`` shows how it is + set: + :: + + FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" + + :term:`FILESEXTRAPATHS` + 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 :term:`FILESPATH` + variable. You can extend ``FILESPATH`` variable by using + ``FILESEXTRAPATHS``. + + Best practices dictate that you accomplish this by using + ``FILESEXTRAPATHS`` from within a ``.bbappend`` file and that you + prepend paths as follows: + :: + + FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" + + 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:: + + When extending ``FILESEXTRAPATHS``, be sure to use the immediate + expansion (``:=``) operator. Immediate expansion makes sure that + BitBake evaluates :term:`THISDIR` 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. + + 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. + + Here is another common use: + :: + + FILESEXTRAPATHS_prepend := "${THISDIR}/files:" + + In this example, the build system extends the + ``FILESPATH`` variable to include a directory named ``files`` that is + in the same directory as the corresponding append file. + + This next example specifically adds three paths: + :: + + FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" + + A final example shows how you can extend the search path and include + a :term:`MACHINE`-specific override, which is useful + in a BSP layer: + :: + + FILESEXTRAPATHS_prepend_intel-x86-common := "${THISDIR}/${PN}:" + + The previous statement appears in the + ``linux-yocto-dev.bbappend`` file, which is found in the + :ref:`overview-manual/development-environment:yocto project source repositories` in + ``meta-intel/common/recipes-kernel/linux``. Here, the machine + override is a special :term:`PACKAGE_ARCH` + definition for multiple ``meta-intel`` machines. + + .. note:: + + For a layer that supports a single BSP, the override could just be + the value of ``MACHINE``. + + By prepending paths in ``.bbappend`` files, you allow multiple append + files that reside in different layers but are used for the same + recipe to correctly extend the path. + + :term:`FILESOVERRIDES` + A subset of :term:`OVERRIDES` used by the + OpenEmbedded build system for creating + :term:`FILESPATH`. The ``FILESOVERRIDES`` variable + uses overrides to automatically extend the + :term:`FILESPATH` variable. For an example of how + that works, see the :term:`FILESPATH` variable + description. Additionally, you find more information on how overrides + are handled in the + ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" + section of the BitBake User Manual. + + By default, the ``FILESOVERRIDES`` variable is defined as: + :: + + FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}" + + .. note:: + + Do not hand-edit the ``FILESOVERRIDES`` variable. The values match up + with expected overrides and are used in an expected manner by the + build system. + + :term:`FILESPATH` + 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 + ``FILESPATH`` in the specified order when looking for files and + patches specified by each ``file://`` URI in a recipe's + :term:`SRC_URI` statements. + + The default value for the ``FILESPATH`` variable is defined in the + ``base.bbclass`` class found in ``meta/classes`` in the + :term:`Source Directory`: + :: + + FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ + "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" + + The + ``FILESPATH`` variable is automatically extended using the overrides + from the :term:`FILESOVERRIDES` variable. + + .. note:: + + - Do not hand-edit the ``FILESPATH`` variable. If you want the + build system to look in directories other than the defaults, + extend the ``FILESPATH`` variable by using the + :term:`FILESEXTRAPATHS` variable. + + - Be aware that the default ``FILESPATH`` directories do not map + to directories in custom layers where append files + (``.bbappend``) are used. If you want the build system to find + patches or files that reside with your append files, you need + to extend the ``FILESPATH`` variable by using the + ``FILESEXTRAPATHS`` variable. + + You can take advantage of this searching behavior in useful ways. For + example, consider a case where the following directory structure + exists for general and machine-specific configurations: + :: + + files/defconfig + files/MACHINEA/defconfig + files/MACHINEB/defconfig + + Also in the example, the ``SRC_URI`` statement contains + "file://defconfig". Given this scenario, you can set + :term:`MACHINE` to "MACHINEA" and cause the build + system to use files from ``files/MACHINEA``. Set ``MACHINE`` to + "MACHINEB" and the build system uses files from ``files/MACHINEB``. + Finally, for any machine other than "MACHINEA" and "MACHINEB", the + build system uses files from ``files/defconfig``. + + You can find out more about the patching process in the + ":ref:`overview-manual/concepts:patching`" section + in the Yocto Project Overview and Concepts Manual and the + ":ref:`dev-manual/common-tasks:patching code`" section in + the Yocto Project Development Tasks Manual. See the + :ref:`ref-tasks-patch` task as well. + + :term:`FILESYSTEM_PERMS_TABLES` + 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. + + By default, the OpenEmbedded build system uses the ``fs-perms.txt``, + which is located in the ``meta/files`` folder in the :term:`Source Directory`. + If you create your own file + permissions setting table, you should place it in your layer or the + distro's layer. + + You define the ``FILESYSTEM_PERMS_TABLES`` variable in the + ``conf/local.conf`` file, which is found in the :term:`Build Directory`, + to point to your custom + ``fs-perms.txt``. You can specify more than a single file permissions + setting table. The paths you specify to these files must be defined + within the :term:`BBPATH` variable. + + For guidance on how to create your own file permissions settings + table file, examine the existing ``fs-perms.txt``. + + :term:`FIT_GENERATE_KEYS` + Decides whether to generate the keys for signing fitImage if they + don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. + The default value is 0. + + :term:`FIT_HASH_ALG` + Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256. + + :term:`FIT_KEY_GENRSA_ARGS` + Arguments to openssl genrsa for generating RSA private key for signing + fitImage. The default value is "-F4". i.e. the public exponent 65537 to + use. + + :term:`FIT_KEY_REQ_ARGS` + Arguments to openssl req for generating certificate for signing fitImage. + The default value is "-batch -new". batch for non interactive mode + and new for generating new keys. + + :term:`FIT_KEY_SIGN_PKCS` + Format for public key ceritifcate used in signing fitImage. + The default value is "x509". + + :term:`FIT_SIGN_ALG` + Specifies the signature algorithm used in creating the FIT Image. + For e.g. rsa2048. + + :term:`FIT_SIGN_NUMBITS` + Size of private key in number of bits used in fitImage. The default + value is "2048". + + :term:`FONT_EXTRA_RDEPENDS` + When inheriting the :ref:`fontcache ` class, + this variable specifies the runtime dependencies for font packages. + By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". + + :term:`FONT_PACKAGES` + When inheriting the :ref:`fontcache ` class, + this variable identifies packages containing font files that need to + be cached by Fontconfig. By default, the ``fontcache`` class assumes + that fonts are in the recipe's main package (i.e. + ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you + need are in a package other than that main package. + + :term:`FORCE_RO_REMOVE` + Forces the removal of the packages listed in ``ROOTFS_RO_UNNEEDED`` + during the generation of the root filesystem. + + Set the variable to "1" to force the removal of these packages. + + :term:`FULL_OPTIMIZATION` + The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when + compiling an optimized system. This variable defaults to "-O2 -pipe + ${DEBUG_FLAGS}". + + :term:`GCCPIE` + Enables Position Independent Executables (PIE) within the GNU C + Compiler (GCC). Enabling PIE in the GCC makes Return Oriented + Programming (ROP) attacks much more difficult to execute. + + By default the ``security_flags.inc`` file enables PIE by setting the + variable as follows: + :: + + GCCPIE ?= "--enable-default-pie" + + :term:`GCCVERSION` + Specifies the default version of the GNU C Compiler (GCC) used for + compilation. By default, ``GCCVERSION`` is set to "8.x" in the + ``meta/conf/distro/include/tcmode-default.inc`` include file: + :: + + GCCVERSION ?= "8.%" + + You can override this value by setting it in a + configuration file such as the ``local.conf``. + + :term:`GDB` + The minimal command and arguments to run the GNU Debugger. + + :term:`GITDIR` + The directory in which a local copy of a Git repository is stored + when it is cloned. + + :term:`GLIBC_GENERATE_LOCALES` + Specifies the list of GLIBC locales to generate should you not wish + to generate all LIBC locals, which can be time consuming. + + .. note:: + + If you specifically remove the locale ``en_US.UTF-8``, you must set + :term:`IMAGE_LINGUAS` appropriately. + + You can set ``GLIBC_GENERATE_LOCALES`` in your ``local.conf`` file. + By default, all locales are generated. + :: + + GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" + + :term:`GROUPADD_PARAM` + When inheriting the :ref:`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. + + Here is an example from the ``dbus`` recipe: + :: + + GROUPADD_PARAM_${PN} = "-r netdev" + + For information on the standard Linux shell command + ``groupadd``, see http://linux.die.net/man/8/groupadd. + + :term:`GROUPMEMS_PARAM` + When inheriting the :ref:`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. + + For information on the standard Linux shell command ``groupmems``, + see http://linux.die.net/man/8/groupmems. + + :term:`GRUB_GFXSERIAL` + Configures the GNU GRand Unified Bootloader (GRUB) to have graphics + and serial in the boot menu. Set this variable to "1" in your + ``local.conf`` or distribution configuration file to enable graphics + and serial in the menu. + + See the :ref:`grub-efi ` class for more + information on how this variable is used. + + :term:`GRUB_OPTS` + Additional options to add to the GNU GRand Unified Bootloader (GRUB) + configuration. Use a semi-colon character (``;``) to separate + multiple options. + + The ``GRUB_OPTS`` variable is optional. See the + :ref:`grub-efi ` class for more information + on how this variable is used. + + :term:`GRUB_TIMEOUT` + Specifies the timeout before executing the default ``LABEL`` in the + GNU GRand Unified Bootloader (GRUB). + + The ``GRUB_TIMEOUT`` variable is optional. See the + :ref:`grub-efi ` class for more information + on how this variable is used. + + :term:`GTKIMMODULES_PACKAGES` + When inheriting the + :ref:`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. + + :term:`HOMEPAGE` + Website where more information about the software the recipe is + building can be found. + + :term:`HOST_ARCH` + The name of the target architecture, which is normally the same as + :term:`TARGET_ARCH`. 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: + + - arm + - i586 + - x86_64 + - powerpc + - powerpc64 + - mips + - mipsel + + :term:`HOST_CC_ARCH` + Specifies architecture-specific compiler flags that are passed to the + C compiler. + + Default initialization for ``HOST_CC_ARCH`` varies depending on what + is being built: + + - :term:`TARGET_CC_ARCH` when building for the + target + + - :term:`BUILD_CC_ARCH` when building for the build host (i.e. + ``-native``) + + - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. + ``nativesdk-``) + + :term:`HOST_OS` + Specifies the name of the target operating system, which is normally + the same as the :term:`TARGET_OS`. The variable can + be set to "linux" for ``glibc``-based systems and to "linux-musl" for + ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and + "linux-musleabi" values possible. + + :term:`HOST_PREFIX` + Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX`` + is normally the same as :term:`TARGET_PREFIX`. + + :term:`HOST_SYS` + Specifies the system, including the architecture and the operating + system, for which the build is occurring in the context of the + current recipe. + + The OpenEmbedded build system automatically sets this variable based + on :term:`HOST_ARCH`, + :term:`HOST_VENDOR`, and + :term:`HOST_OS` variables. + + .. note:: + + You do not need to set the variable yourself. + + Consider these two examples: + + - Given a native recipe on a 32-bit x86 machine running Linux, the + value is "i686-linux". + + - Given a recipe being built for a little-endian MIPS target running + Linux, the value might be "mipsel-linux". + + :term:`HOSTTOOLS` + A space-separated list (filter) of tools on the build host that + should be allowed to be called from within build tasks. Using this + filter helps reduce the possibility of host contamination. If a tool + specified in the value of ``HOSTTOOLS`` is not found on the build + host, the OpenEmbedded build system produces an error and the build + is not started. + + For additional information, see + :term:`HOSTTOOLS_NONFATAL`. + + :term:`HOSTTOOLS_NONFATAL` + A space-separated list (filter) of tools on the build host that + should be allowed to be called from within build tasks. Using this + filter helps reduce the possibility of host contamination. Unlike + :term:`HOSTTOOLS`, the OpenEmbedded build system + does not produce an error if a tool specified in the value of + ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can + use ``HOSTTOOLS_NONFATAL`` to filter optional host tools. + + :term:`HOST_VENDOR` + Specifies the name of the vendor. ``HOST_VENDOR`` is normally the + same as :term:`TARGET_VENDOR`. + + :term:`ICECC_DISABLED` + Disables or enables the ``icecc`` (Icecream) function. For more + information on this function and best practices for using this + variable, see the ":ref:`icecc.bbclass `" + section. + + Setting this variable to "1" in your ``local.conf`` disables the + function: + :: + + ICECC_DISABLED ??= "1" + + To enable the function, set the variable as follows: + :: + + ICECC_DISABLED = "" + + :term:`ICECC_ENV_EXEC` + Points to the ``icecc-create-env`` script that you provide. This + variable is used by the :ref:`icecc ` class. You + set this variable in your ``local.conf`` file. + + If you do not point to a script that you provide, the OpenEmbedded + build system uses the default script provided by the + ``icecc-create-env.bb`` recipe, which is a modified version and not + the one that comes with ``icecc``. + + :term:`ICECC_PARALLEL_MAKE` + Extra options passed to the ``make`` command during the + :ref:`ref-tasks-compile` task that specify parallel + compilation. This variable usually takes the form of "-j x", where x + represents the maximum number of parallel threads ``make`` can run. + + .. note:: + + The options passed affect builds on all enabled machines on the + network, which are machines running the ``iceccd`` daemon. + + 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 + :term:`PARALLEL_MAKE` variable, there is no + rule-of-thumb for setting ``ICECC_PARALLEL_MAKE`` to achieve optimal + performance. + + If you do not set ``ICECC_PARALLEL_MAKE``, the build system does not + use it (i.e. the system does not detect and assign the number of + cores as is done with ``PARALLEL_MAKE``). + + :term:`ICECC_PATH` + The location of the ``icecc`` binary. You can set this variable in + your ``local.conf`` file. If your ``local.conf`` file does not define + this variable, the :ref:`icecc ` class attempts + to define it by locating ``icecc`` using ``which``. + + :term:`ICECC_USER_CLASS_BL` + Identifies user classes that you do not want the Icecream distributed + compile support to consider. This variable is used by the + :ref:`icecc ` class. You set this variable in + your ``local.conf`` file. + + 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. + + :term:`ICECC_USER_PACKAGE_BL` + Identifies user recipes that you do not want the Icecream distributed + compile support to consider. This variable is used by the + :ref:`icecc ` class. You set this variable in + your ``local.conf`` file. + + 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. + + :term:`ICECC_USER_PACKAGE_WL` + Identifies user recipes that use an empty + :term:`PARALLEL_MAKE` variable that you want to + force remote distributed compilation on using the Icecream + distributed compile support. This variable is used by the + :ref:`icecc ` class. You set this variable in + your ``local.conf`` file. + + :term:`IMAGE_BASENAME` + The base name of image output files. This variable defaults to the + recipe name (``${``\ :term:`PN`\ ``}``). + + :term:`IMAGE_EFI_BOOT_FILES` + A space-separated list of files installed into the boot partition + when preparing an image using the Wic tool with the + ``bootimg-efi`` 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 + :term:`DEPLOY_DIR_IMAGE`. Here are two + examples: + :: + + IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2" + IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio" + + Alternatively, source files can be picked up using a glob pattern. In + this case, the destination file must 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: + :: + + IMAGE_EFI_BOOT_FILES = "boot/loader/*" + IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/" + + The first example + installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/`` + into the root of the target partition. The second example installs + the same files into a ``boot`` directory within the target partition. + + You can find information on how to use the Wic tool in the + ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" + section of the Yocto Project Development Tasks Manual. Reference + material for Wic is located in the + ":doc:`/ref-manual/kickstart`" chapter. + + :term:`IMAGE_BOOT_FILES` + A space-separated list of files installed into the boot partition + when preparing an image using the Wic tool with the + ``bootimg-partition`` 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 + :term:`DEPLOY_DIR_IMAGE`. Here are two + examples: + :: + + IMAGE_BOOT_FILES = "u-boot.img uImage;kernel" + IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}" + + Alternatively, source files can be picked up using a glob pattern. In + this case, the destination file must 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: + :: + + IMAGE_BOOT_FILES = "bcm2835-bootfiles/*" + IMAGE_BOOT_FILES = "bcm2835-bootfiles/*;boot/" + + The first example + installs all files from ``${DEPLOY_DIR_IMAGE}/bcm2835-bootfiles`` + into the root of the target partition. The second example installs + the same files into a ``boot`` directory within the target partition. + + You can find information on how to use the Wic tool in the + ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" + section of the Yocto Project Development Tasks Manual. Reference + material for Wic is located in the + ":doc:`/ref-manual/kickstart`" chapter. + + :term:`IMAGE_CLASSES` + 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. + + The default value for ``IMAGE_CLASSES`` is ``image_types``. You can + set this variable in your ``local.conf`` or in a distribution + configuration file. + + For more information, see ``meta/classes/image_types.bbclass`` in the + :term:`Source Directory`. + + :term:`IMAGE_CMD` + Specifies the command to create the image file for a specific image + type, which corresponds to the value set set in + :term:`IMAGE_FSTYPES`, (e.g. ``ext3``, + ``btrfs``, and so forth). When setting this variable, you should use + an override for the associated type. Here is an example: + :: + + IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \ + --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \ + ${EXTRA_IMAGECMD}" + + 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 :ref:`image_types ` + class file, which is ``meta/classes/image_types.bbclass``. + + :term:`IMAGE_DEVICE_TABLES` + Specifies one or more files that contain custom device tables that + are passed to the ``makedevs`` command as part of creating an image. + These files list basic device nodes that should be created under + ``/dev`` within the image. If ``IMAGE_DEVICE_TABLES`` is not set, + ``files/device_table-minimal.txt`` is used, which is located by + :term:`BBPATH`. For details on how you should write + device table files, see ``meta/files/device_table-minimal.txt`` as an + example. + + :term:`IMAGE_FEATURES` + 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 ``local.conf`` file, which is found in the + :term:`Build Directory`, best practices dictate that you do + not. + + .. note:: + + To enable extra features from outside the image recipe, use the + :term:`EXTRA_IMAGE_FEATURES` variable. + + For a list of image features that ships with the Yocto Project, see + the ":ref:`ref-features-image`" section. + + For an example that shows how to customize your image by using this + variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" + section in the Yocto Project Development Tasks Manual. + + :term:`IMAGE_FSTYPES` + Specifies the formats the OpenEmbedded build system uses during the + build when creating the root filesystem. For example, setting + ``IMAGE_FSTYPES`` as follows causes the build system to create root + filesystems using two formats: ``.ext3`` and ``.tar.bz2``: + :: + + IMAGE_FSTYPES = "ext3 tar.bz2" + + For the complete list of supported image formats from which you can + choose, see :term:`IMAGE_TYPES`. + + .. note:: + + - If an image recipe uses the "inherit image" line and you are + setting ``IMAGE_FSTYPES`` inside the recipe, you must set + ``IMAGE_FSTYPES`` prior to using the "inherit image" line. + + - Due to the way the OpenEmbedded build system processes this + variable, you cannot update its contents by using ``_append`` + or ``_prepend``. You must use the ``+=`` operator to add one or + more options to the ``IMAGE_FSTYPES`` variable. + + :term:`IMAGE_INSTALL` + Used by recipes to specify the packages to install into an image + through the :ref:`image ` class. Use the + ``IMAGE_INSTALL`` variable with care to avoid ordering issues. + + Image recipes set ``IMAGE_INSTALL`` to specify the packages to + install into an image through ``image.bbclass``. Additionally, + "helper" classes such as the + :ref:`core-image ` class exist that can + take lists used with ``IMAGE_FEATURES`` and turn them into + auto-generated entries in ``IMAGE_INSTALL`` in addition to its + default contents. + + When you use this variable, it is best to use it as follows: + :: + + IMAGE_INSTALL_append = " package-name" + + Be sure to include the space + between the quotation character and the start of the package name or + names. + + .. note:: + + - When working with a + :ref:`core-image-minimal-initramfs ` + image, do not use the ``IMAGE_INSTALL`` variable to specify + packages for installation. Instead, use the + :term:`PACKAGE_INSTALL` variable, which + allows the initial RAM filesystem (initramfs) recipe to use a + fixed set of packages and not be affected by ``IMAGE_INSTALL``. + For information on creating an initramfs, see the + ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" + section in the Yocto Project Development Tasks Manual. + + - Using ``IMAGE_INSTALL`` with the + :ref:`+= ` + BitBake operator within the ``/conf/local.conf`` file or from + within an image recipe is not recommended. Use of this operator + in these ways can cause ordering issues. Since + ``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default + value using the + :ref:`?= ` + operator, using a ``+=`` operation against ``IMAGE_INSTALL`` + results in unexpected behavior when used within + ``conf/local.conf``. 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 ``+=`` operator to work. + + :term:`IMAGE_LINGUAS` + 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 ``IMAGE_LINGUAS`` variable + ensures that any locale packages that correspond to packages already + selected for installation into the image are also installed. Here is + an example: + :: + + IMAGE_LINGUAS = "pt-br de-de" + + 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. ``*-locale-pt-br`` and ``*-locale-de-de`` as well as + ``*-locale-pt`` and ``*-locale-de``, since some software packages + only provide locale files by language and not by country-specific + language). + + See the :term:`GLIBC_GENERATE_LOCALES` + variable for information on generating GLIBC locales. + + + :term:`IMAGE_LINK_NAME` + The name of the output image symlink (which does not include + the version part as :term:`IMAGE_NAME` does). The default value + is derived using the :term:`IMAGE_BASENAME` and :term:`MACHINE` + variables: + :: + + IMAGE_LINK_NAME ?= "${IMAGE_BASENAME}-${MACHINE}" + + + :term:`IMAGE_MANIFEST` + 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: + :: + + packagename packagearch version + + The :ref:`image ` class defines the manifest + file as follows: + :: + + IMAGE_MANIFEST ="${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest" + + The location is + derived using the :term:`DEPLOY_DIR_IMAGE` + and :term:`IMAGE_NAME` variables. You can find + information on how the image is created in the ":ref:`overview-manual/concepts:image generation`" + section in the Yocto Project Overview and Concepts Manual. + + :term:`IMAGE_NAME` + The name of the output image files minus the extension. This variable + is derived using the :term:`IMAGE_BASENAME`, + :term:`MACHINE`, and :term:`IMAGE_VERSION_SUFFIX` + variables: + :: + + IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + :term:`IMAGE_NAME_SUFFIX` + Suffix used for the image output file name - defaults to ``".rootfs"`` + to distinguish the image file from other files created during image + building; however if this suffix is redundant or not desired you can + clear the value of this variable (set the value to ""). For example, + this is typically cleared in initramfs image recipes. + + :term:`IMAGE_OVERHEAD_FACTOR` + 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``. 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 + ``IMAGE_ROOTFS_SIZE`` for information on how the build system + determines the overall image size. + + 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: + :: + + IMAGE_OVERHEAD_FACTOR = "1.5" + + Alternatively, you can ensure a specific amount of free disk space is + added to the image by using the ``IMAGE_ROOTFS_EXTRA_SPACE`` + variable. + + :term:`IMAGE_PKGTYPE` + Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the + OpenEmbedded build system. The variable is defined appropriately by + the :ref:`package_deb `, + :ref:`package_rpm `, + :ref:`package_ipk `, or + :ref:`package_tar ` class. + + .. note:: + + The ``package_tar`` class is broken and is not supported. It is + recommended that you do not use it. + + The :ref:`populate_sdk_* ` and + :ref:`image ` classes use the ``IMAGE_PKGTYPE`` + for packaging up images and SDKs. + + You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the + variable is set indirectly through the appropriate + :ref:`package_* ` class using the + :term:`PACKAGE_CLASSES` 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 ``.tar`` format are never used as a substitute + packaging format for DEB, RPM, and IPK formatted files for your image + or SDK. + + :term:`IMAGE_POSTPROCESS_COMMAND` + Specifies a list of functions to call once the OpenEmbedded build + system creates the final image output files. You can specify + functions separated by semicolons: + :: + + IMAGE_POSTPROCESS_COMMAND += "function; ... " + + If you need to pass the root filesystem path to a command within the + function, you can use ``${IMAGE_ROOTFS}``, which points to the + directory that becomes the root filesystem image. See the + :term:`IMAGE_ROOTFS` variable for more + information. + + :term:`IMAGE_PREPROCESS_COMMAND` + Specifies a list of functions to call before the OpenEmbedded build + system creates the final image output files. You can specify + functions separated by semicolons: + :: + + IMAGE_PREPROCESS_COMMAND += "function; ... " + + If you need to pass the root filesystem path to a command within the + function, you can use ``${IMAGE_ROOTFS}``, which points to the + directory that becomes the root filesystem image. See the + :term:`IMAGE_ROOTFS` variable for more + information. + + :term:`IMAGE_ROOTFS` + The location of the root filesystem while it is under construction + (i.e. during the :ref:`ref-tasks-rootfs` task). This + variable is not configurable. Do not change it. + + :term:`IMAGE_ROOTFS_ALIGNMENT` + 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 :term:`IMAGE_ROOTFS_SIZE` for + additional information. + + :term:`IMAGE_ROOTFS_EXTRA_SPACE` + 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 ``IMAGE_ROOTFS_SIZE``. + + 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: + :: + + IMAGE_ROOTFS_EXTRA_SPACE = "5242880" + + For example, the Yocto Project Build Appliance specifically requests + 40 Gbytes of extra space with the line: + :: + + IMAGE_ROOTFS_EXTRA_SPACE = "41943040" + + :term:`IMAGE_ROOTFS_SIZE` + 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: + :: + + 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 + + See the :term:`IMAGE_OVERHEAD_FACTOR` + and :term:`IMAGE_ROOTFS_EXTRA_SPACE` + variables for related information. + + :term:`IMAGE_TYPEDEP` + Specifies a dependency from one image type on another. Here is an + example from the :ref:`image-live ` class: + :: + + IMAGE_TYPEDEP_live = "ext3" + + In the previous example, the variable ensures that when "live" is + listed with the :term:`IMAGE_FSTYPES` variable, + the OpenEmbedded build system produces an ``ext3`` image first since + one of the components of the live image is an ``ext3`` formatted + partition containing the root filesystem. + + :term:`IMAGE_TYPES` + Specifies the complete list of supported image types by default: + + - btrfs + - container + - cpio + - cpio.gz + - cpio.lz4 + - cpio.lzma + - cpio.xz + - cramfs + - ext2 + - ext2.bz2 + - ext2.gz + - ext2.lzma + - ext3 + - ext3.gz + - ext4 + - ext4.gz + - f2fs + - hddimg + - iso + - jffs2 + - jffs2.sum + - multiubi + - squashfs + - squashfs-lz4 + - squashfs-lzo + - squashfs-xz + - tar + - tar.bz2 + - tar.gz + - tar.lz4 + - tar.xz + - tar.zst + - ubi + - ubifs + - wic + - wic.bz2 + - wic.gz + - wic.lzma + + For more information about these types of images, see + ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`. + + :term:`IMAGE_VERSION_SUFFIX` + Version suffix that is part of the default :term:`IMAGE_NAME` and + :term:`KERNEL_ARTIFACT_NAME` values. + Defaults to ``"-${DATETIME}"``, however you could set this to a + version string that comes from your external build environment if + desired, and this suffix would then be used consistently across + the build artifacts. + + :term:`INC_PR` + Helps define the recipe revision for recipes that share a common + ``include`` file. You can think of this variable as part of the + recipe revision as set from within an include file. + + Suppose, for example, you have a set of recipes that are used across + several projects. And, within each of those recipes the revision (its + :term:`PR` 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. + + A more efficient way of dealing with this situation is to set the + ``INC_PR`` variable inside the ``include`` files that the recipes + share and then expand the ``INC_PR`` variable within the recipes to + help define the recipe revision. + + The following provides an example that shows how to use the + ``INC_PR`` variable given a common ``include`` file that defines the + variable. Once the variable is defined in the ``include`` file, you + can use the variable to set the ``PR`` values in each recipe. You + will notice that when you set a recipe's ``PR`` you can provide more + granular revisioning by appending values to the ``INC_PR`` variable: + :: + + 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" + + The + first line of the example establishes the baseline revision to be + used for all recipes that use the ``include`` file. The remaining + lines in the example are from individual recipes and show how the + ``PR`` value is set. + + :term:`INCOMPATIBLE_LICENSE` + Specifies a space-separated list of license names (as they would + appear in :term:`LICENSE`) 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. + + .. note:: + + This functionality is only regularly tested using the following + setting: + :: + + INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" + + + 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:: + + It is possible to define a list of licenses that are allowed to be + used instead of the licenses that are excluded. To do this, define + a variable ``COMPATIBLE_LICENSES`` with the names of the licences + that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as: + :: + + INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}" + + + This will result in ``INCOMPATIBLE_LICENSE`` containing the names of + all licences from :term:`AVAILABLE_LICENSES` except the ones specified + in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licences to + be used. + + :term:`INHERIT` + Causes the named class or classes to be inherited globally. Anonymous + functions in the class or classes are not executed for the base + configuration and in each individual recipe. The OpenEmbedded build + system ignores changes to ``INHERIT`` in individual recipes. + + For more information on ``INHERIT``, see the + :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" + section in the Bitbake User Manual. + + :term:`INHERIT_DISTRO` + Lists classes that will be inherited at the distribution level. It is + unlikely that you want to edit this variable. + + The default value of the variable is set as follows in the + ``meta/conf/distro/defaultsetup.conf`` file: + :: + + INHERIT_DISTRO ?= "debian devshell sstate license" + + :term:`INHIBIT_DEFAULT_DEPS` + Prevents the default dependencies, namely the C compiler and standard + C library (libc), from being added to :term:`DEPENDS`. + This variable is usually used within recipes that do not require any + compilation using the C compiler. + + Set the variable to "1" to prevent the default dependencies from + being added. + + :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` + Prevents the OpenEmbedded build system from splitting out debug + information during packaging. By default, the build system splits out + debugging information during the + :ref:`ref-tasks-package` task. For more information on + how debug information is split out, see the + :term:`PACKAGE_DEBUG_SPLIT_STYLE` + variable. + + To prevent the build system from splitting out debug information + during packaging, set the ``INHIBIT_PACKAGE_DEBUG_SPLIT`` variable as + follows: + :: + + INHIBIT_PACKAGE_DEBUG_SPLIT = "1" + + :term:`INHIBIT_PACKAGE_STRIP` + If set to "1", causes the build to not strip binaries in resulting + packages and prevents the ``-dbg`` package from containing the source + files. + + By default, the OpenEmbedded build system strips binaries and puts + the debugging symbols into ``${``\ :term:`PN`\ ``}-dbg``. + Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you + plan to debug in general. + + :term:`INHIBIT_SYSROOT_STRIP` + If set to "1", causes the build to not strip binaries in the + resulting sysroot. + + By default, the OpenEmbedded build system strips binaries in the + resulting sysroot. When you specifically set the + ``INHIBIT_SYSROOT_STRIP`` variable to "1" in your recipe, you inhibit + this stripping. + + If you want to use this variable, include the + :ref:`staging ` class. This class uses a + ``sys_strip()`` function to test for the variable and acts + accordingly. + + .. note:: + + Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and + special circumstances. For example, suppose you are building + bare-metal firmware by using an external GCC toolchain. Furthermore, + even if the toolchain's binaries are strippable, other files exist + that are needed for the build that are not strippable. + + :term:`INITRAMFS_FSTYPES` + Defines the format for the output image of an initial RAM filesystem + (initramfs), which is used during boot. Supported formats are the + same as those supported by the + :term:`IMAGE_FSTYPES` variable. + + The default value of this variable, which is set in the + ``meta/conf/bitbake.conf`` configuration file in the + :term:`Source Directory`, is "cpio.gz". The Linux kernel's + initramfs mechanism, as opposed to the initial RAM filesystem + `initrd `__ mechanism, expects + an optionally compressed cpio archive. + + :term:`INITRAMFS_IMAGE` + Specifies the :term:`PROVIDES` name of an image + recipe that is used to build an initial RAM filesystem (initramfs) + image. In other words, the ``INITRAMFS_IMAGE`` variable causes an + additional recipe to be built as a dependency to whatever root + filesystem recipe you might be using (e.g. ``core-image-sato``). The + initramfs image recipe you provide should set + :term:`IMAGE_FSTYPES` to + :term:`INITRAMFS_FSTYPES`. + + An initramfs image provides a temporary root filesystem used for + early system initialization (e.g. loading of modules needed to locate + and mount the "real" root filesystem). + + .. note:: + + See the ``meta/recipes-core/images/core-image-minimal-initramfs.bb`` + recipe in the :term:`Source Directory` + for an example initramfs recipe. To select this sample recipe as + the one built to provide the initramfs image, set ``INITRAMFS_IMAGE`` + to "core-image-minimal-initramfs". + + You can also find more information by referencing the + ``meta-poky/conf/local.conf.sample.extended`` configuration file in + the Source Directory, the :ref:`image ` class, + and the :ref:`kernel ` class to see how to use + the ``INITRAMFS_IMAGE`` variable. + + If ``INITRAMFS_IMAGE`` is empty, which is the default, then no + initramfs image is built. + + For more information, you can also see the + :term:`INITRAMFS_IMAGE_BUNDLE` + variable, which allows the generated image to be bundled inside the + kernel image. Additionally, for information on creating an initramfs + image, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section + in the Yocto Project Development Tasks Manual. + + :term:`INITRAMFS_IMAGE_BUNDLE` + Controls whether or not the image recipe specified by + :term:`INITRAMFS_IMAGE` is run through an + extra pass + (:ref:`ref-tasks-bundle_initramfs`) during + kernel compilation in order to build a single binary that contains + both the kernel image and the initial RAM filesystem (initramfs) + image. This makes use of the + :term:`CONFIG_INITRAMFS_SOURCE` kernel + feature. + + .. note:: + + Using an extra compilation pass to bundle the initramfs avoids a + circular dependency between the kernel recipe and the initramfs + recipe should the initramfs include kernel modules. Should that be + the case, the initramfs recipe depends on the kernel for the + kernel modules, and the kernel depends on the initramfs recipe + since the initramfs is bundled inside the kernel image. + + The combined binary is deposited into the ``tmp/deploy`` directory, + which is part of the :term:`Build Directory`. + + Setting the variable to "1" in a configuration file causes the + OpenEmbedded build system to generate a kernel image with the + initramfs specified in ``INITRAMFS_IMAGE`` bundled within: + :: + + INITRAMFS_IMAGE_BUNDLE = "1" + + By default, the + :ref:`kernel ` class sets this variable to a + null string as follows: + :: + + INITRAMFS_IMAGE_BUNDLE ?= "" + + .. note:: + + You must set the ``INITRAMFS_IMAGE_BUNDLE`` variable in a + configuration file. You cannot set the variable in a recipe file. + + See the + :yocto_git:`local.conf.sample.extended ` + file for additional information. Also, for information on creating an + initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section + in the Yocto Project Development Tasks Manual. + + :term:`INITRAMFS_LINK_NAME` + The link name of the initial RAM filesystem image. This variable is + set in the ``meta/classes/kernel-artifact-names.bbclass`` file as + follows: + :: + + INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}" + + The value of the + ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same + file, has the following value: + :: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + See the :term:`MACHINE` variable for additional + information. + + :term:`INITRAMFS_NAME` + The base name of the initial RAM filesystem image. This variable is + set in the ``meta/classes/kernel-artifact-names.bbclass`` file as + follows: + :: + + INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" + + The value of the :term:`KERNEL_ARTIFACT_NAME` + variable, which is set in the same file, has the following value: + :: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + :term:`INITRD` + Indicates list of filesystem images to concatenate and use as an + initial RAM disk (``initrd``). + + The ``INITRD`` variable is an optional variable used with the + :ref:`image-live ` class. + + :term:`INITRD_IMAGE` + When building a "live" bootable image (i.e. when + :term:`IMAGE_FSTYPES` contains "live"), + ``INITRD_IMAGE`` specifies the image recipe that should be built to + provide the initial RAM disk image. The default value is + "core-image-minimal-initramfs". + + See the :ref:`image-live ` class for more + information. + + :term:`INITSCRIPT_NAME` + The filename of the initialization script as installed to + ``${sysconfdir}/init.d``. + + This variable is used in recipes when using ``update-rc.d.bbclass``. + The variable is mandatory. + + :term:`INITSCRIPT_PACKAGES` + A list of the packages that contain initscripts. If multiple packages + are specified, you need to append the package name to the other + ``INITSCRIPT_*`` as an override. + + This variable is used in recipes when using ``update-rc.d.bbclass``. + The variable is optional and defaults to the :term:`PN` + variable. + + :term:`INITSCRIPT_PARAMS` + Specifies the options to pass to ``update-rc.d``. Here is an example: + :: + + INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ." + + 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. + + The variable's default value is "defaults", which is set in the + :ref:`update-rc.d ` class. + + The value in ``INITSCRIPT_PARAMS`` is passed through to the + ``update-rc.d`` command. For more information on valid parameters, + please see the ``update-rc.d`` manual page at + https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html + + :term:`INSANE_SKIP` + Specifies the QA checks to skip for a specific package within a + recipe. For example, to skip the check for symbolic link ``.so`` + 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 ``${PN}``: + :: + + INSANE_SKIP_${PN} += "dev-so" + + See the ":ref:`insane.bbclass `" section for a + list of the valid QA checks you can specify using this variable. + + :term:`INSTALL_TIMEZONE_FILE` + By default, the ``tzdata`` recipe packages an ``/etc/timezone`` file. + Set the ``INSTALL_TIMEZONE_FILE`` variable to "0" at the + configuration level to disable this behavior. + + :term:`IPK_FEED_URIS` + When the IPK backend is in use and package management is enabled on + the target, you can use this variable to set up ``opkg`` 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. + + :term:`KARCH` + Defines the kernel architecture used when assembling the + configuration. Architectures supported for this release are: + + - powerpc + - i386 + - x86_64 + - arm + - qemu + - mips + + You define the ``KARCH`` variable in the :ref:`kernel-dev/advanced:bsp descriptions`. + + :term:`KBRANCH` + 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. + + 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 + ``linux-yocto_4.12`` kernel, the kernel recipe file is the + ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` file. ``KBRANCH`` + is set as follows in that kernel recipe file: + :: + + KBRANCH ?= "standard/base" + + This variable is also used from the kernel's append file to identify + the kernel branch specific to a particular machine or target + hardware. Continuing with the previous kernel example, the kernel's + append file (i.e. ``linux-yocto_4.12.bbappend``) is located in the + BSP layer for a given machine. For example, the append file for the + Beaglebone, EdgeRouter, and generic versions of both 32 and 64-bit IA + machines (``meta-yocto-bsp``) is named + ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend``. + Here are the related statements from that append file: + :: + + KBRANCH_genericx86 = "standard/base" + KBRANCH_genericx86-64 = "standard/base" + KBRANCH_edgerouter = "standard/edgerouter" + KBRANCH_beaglebone = "standard/beaglebone" + + The ``KBRANCH`` statements + identify the kernel branch to use when building for each supported + BSP. + + :term:`KBUILD_DEFCONFIG` + When used with the :ref:`kernel-yocto ` + class, specifies an "in-tree" kernel configuration file for use + during a kernel build. + + Typically, when using a ``defconfig`` to configure a kernel during a + build, you place the file in your layer in the same manner as you + would place patch files and configuration fragment files (i.e. + "out-of-tree"). However, if you want to use a ``defconfig`` file that + is part of the kernel tree (i.e. "in-tree"), you can use the + ``KBUILD_DEFCONFIG`` variable and append the + :term:`KMACHINE` variable to point to the + ``defconfig`` file. + + To use the variable, set it in the append file for your kernel recipe + using the following form: + :: + + KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file + + Here is an example from a "raspberrypi2" ``KMACHINE`` build that uses + a ``defconfig`` file named "bcm2709_defconfig": + :: + + KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig" + + As an alternative, you can use the following within your append file: + :: + + KBUILD_DEFCONFIG_pn-linux-yocto ?= defconfig_file + + For more + information on how to use the ``KBUILD_DEFCONFIG`` variable, see the + ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`" + section in the Yocto Project Linux Kernel Development Manual. + + :term:`KERNEL_ALT_IMAGETYPE` + Specifies an alternate kernel image type for creation in addition to + the kernel image type specified using the + :term:`KERNEL_IMAGETYPE` variable. + + :term:`KERNEL_ARTIFACT_NAME` + Specifies the name of all of the build artifacts. You can change the + name of the artifacts by changing the ``KERNEL_ARTIFACT_NAME`` + variable. + + The value of ``KERNEL_ARTIFACT_NAME``, which is set in the + ``meta/classes/kernel-artifact-names.bbclass`` file, has the + following default value: + :: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, :term:`MACHINE` + and :term:`IMAGE_VERSION_SUFFIX` variables for additional information. + + :term:`KERNEL_CLASSES` + A list of classes defining kernel image types that the + :ref:`kernel ` 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 ``meta/classes/kernel-fitimage.bbclass``. You can register + custom kernel image types with the ``kernel`` class using this + variable. + + :term:`KERNEL_DEVICETREE` + Specifies the name of the generated Linux kernel device tree (i.e. + the ``.dtb``) file. + + .. note:: + + Legacy support exists for specifying the full path to the device + tree. However, providing just the ``.dtb`` file is preferred. + + In order to use this variable, the + :ref:`kernel-devicetree ` class must + be inherited. + + :term:`KERNEL_DTB_LINK_NAME` + The link name of the kernel device tree binary (DTB). This variable + is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as + follows: + :: + + KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + + The + value of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in + the same file, has the following value: + :: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + See the :term:`MACHINE` variable for additional + information. + + :term:`KERNEL_DTB_NAME` + The base name of the kernel device tree binary (DTB). This variable + is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as + follows: + :: + + KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + The value of the :term:`KERNEL_ARTIFACT_NAME` + variable, which is set in the same file, has the following value: + :: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + :term:`KERNEL_EXTRA_ARGS` + Specifies additional ``make`` command-line arguments the OpenEmbedded + build system passes on when compiling the kernel. + + :term:`KERNEL_FEATURES` + Includes additional kernel metadata. In the OpenEmbedded build + system, the default Board Support Packages (BSPs) + :term:`Metadata` is provided through the + :term:`KMACHINE` and :term:`KBRANCH` + variables. You can use the ``KERNEL_FEATURES`` variable from within + the kernel recipe or kernel append file to further add metadata for + all BSPs or specific BSPs. + + 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 ``KERNEL_FEATURES`` + variable for a specific machine. In this way, you can provide + validated, but optional, sets of kernel configurations and features. + + For example, the following example from the ``linux-yocto-rt_4.12`` + kernel recipe adds "netfilter" and "taskstats" features to all BSPs + as well as "virtio" configurations to all QEMU machines. The last two + statements add specific configurations to targeted machine types: + :: + + KERNEL_EXTRA_FEATURES ?= "features/netfilter/netfilter.scc features/taskstats/taskstats.scc" + KERNEL_FEATURES_append = "${KERNEL_EXTRA_FEATURES}" + KERNEL_FEATURES_append_qemuall = "cfg/virtio.scc" + KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc" + KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc" + + :term:`KERNEL_FIT_LINK_NAME` + The link name of the kernel flattened image tree (FIT) image. This + variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` + file as follows: + :: + + KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + + The value of the + ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same + file, has the following value: + :: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + See the :term:`MACHINE` variable for additional + information. + + :term:`KERNEL_FIT_NAME` + The base name of the kernel flattened image tree (FIT) image. This + variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` + file as follows: + :: + + KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + The value of the :term:`KERNEL_ARTIFACT_NAME` + variable, which is set in the same file, has the following value: + :: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + :term:`KERNEL_IMAGE_LINK_NAME` + The link name for the kernel image. This variable is set in the + ``meta/classes/kernel-artifact-names.bbclass`` file as follows: + :: + + KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + + The value of + the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the same + file, has the following value: + :: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + See the :term:`MACHINE` variable for additional + information. + + :term:`KERNEL_IMAGE_MAXSIZE` + Specifies the maximum size of the kernel image file in kilobytes. If + ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is + checked against the set value during the + :ref:`ref-tasks-sizecheck` task. The task fails if + the kernel image file is larger than the setting. + + ``KERNEL_IMAGE_MAXSIZE`` is useful for target devices that have a + limited amount of space in which the kernel image must be stored. + + By default, this variable is not set, which means the size of the + kernel image is not checked. + + :term:`KERNEL_IMAGE_NAME` + The base name of the kernel image. This variable is set in the + ``meta/classes/kernel-artifact-names.bbclass`` file as follows: + :: + + KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + The value of the + :term:`KERNEL_ARTIFACT_NAME` variable, + which is set in the same file, has the following value: + :: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + :term:`KERNEL_IMAGETYPE` + 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 ``make`` as the target to + build. + + If you want to build an alternate kernel image type, use the + :term:`KERNEL_ALT_IMAGETYPE` variable. + + :term:`KERNEL_MODULE_AUTOLOAD` + Lists kernel modules that need to be auto-loaded during boot. + + .. note:: + + This variable replaces the deprecated :term:`module_autoload` + variable. + + You can use the ``KERNEL_MODULE_AUTOLOAD`` 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). + + Specify it as follows: + :: + + KERNEL_MODULE_AUTOLOAD += "module_name1 module_name2 module_name3" + + Including ``KERNEL_MODULE_AUTOLOAD`` causes the OpenEmbedded build + system to populate the ``/etc/modules-load.d/modname.conf`` 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: + :: + + KERNEL_MODULE_AUTOLOAD += "module_name" + + For information on how to populate the ``modname.conf`` file with + ``modprobe.d`` syntax lines, see the :term:`KERNEL_MODULE_PROBECONF` variable. + + :term:`KERNEL_MODULE_PROBECONF` + Provides a list of modules for which the OpenEmbedded build system + expects to find ``module_conf_``\ modname values that specify + configuration for each of the modules. For information on how to + provide those module configurations, see the + :term:`module_conf_* ` variable. + + :term:`KERNEL_PATH` + The location of the kernel sources. This variable is set to the value + of the :term:`STAGING_KERNEL_DIR` within + the :ref:`module ` class. For information on + how this variable is used, see the + ":ref:`kernel-dev/common:incorporating out-of-tree modules`" + section in the Yocto Project Linux Kernel Development Manual. + + To help maximize compatibility with out-of-tree drivers used to build + modules, the OpenEmbedded build system also recognizes and uses the + :term:`KERNEL_SRC` variable, which is identical to + the ``KERNEL_PATH`` variable. Both variables are common variables + used by external Makefiles to point to the kernel source directory. + + :term:`KERNEL_SRC` + The location of the kernel sources. This variable is set to the value + of the :term:`STAGING_KERNEL_DIR` within + the :ref:`module ` class. For information on + how this variable is used, see the + ":ref:`kernel-dev/common:incorporating out-of-tree modules`" + section in the Yocto Project Linux Kernel Development Manual. + + To help maximize compatibility with out-of-tree drivers used to build + modules, the OpenEmbedded build system also recognizes and uses the + :term:`KERNEL_PATH` variable, which is identical + to the ``KERNEL_SRC`` variable. Both variables are common variables + used by external Makefiles to point to the kernel source directory. + + :term:`KERNEL_VERSION` + Specifies the version of the kernel as extracted from ``version.h`` + or ``utsrelease.h`` 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. + + :term:`KERNELDEPMODDEPEND` + Specifies whether the data referenced through + :term:`PKGDATA_DIR` is needed or not. The + ``KERNELDEPMODDEPEND`` 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 ``KERNELDEPMODDEPEND`` variable in your + ``initramfs`` recipe. Setting the variable there when the data is not + needed avoids a potential dependency loop. + + :term:`KFEATURE_DESCRIPTION` + Provides a short description of a configuration fragment. You use + this variable in the ``.scc`` file that describes a configuration + fragment file. Here is the variable used in a file named ``smp.scc`` + to describe SMP being enabled: + :: + + define KFEATURE_DESCRIPTION "Enable SMP" + + :term:`KMACHINE` + 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 ``core2-32-intel-common`` + goes by a different name in the Linux Yocto kernel. The kernel + understands that machine as ``intel-core2-32``. For cases like these, + the ``KMACHINE`` variable maps the kernel machine name to the + OpenEmbedded build system machine name. + + These mappings between different names occur in the Yocto Linux + Kernel's ``meta`` branch. As an example take a look in the + ``common/recipes-kernel/linux/linux-yocto_3.19.bbappend`` file: + :: + + 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}" + + The ``KMACHINE`` 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". + + :term:`KTYPE` + 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 ":ref:`kernel-dev/advanced:kernel types`" + section in the + Yocto Project Linux Kernel Development Manual for more information on + kernel types. + + You define the ``KTYPE`` variable in the + :ref:`kernel-dev/advanced:bsp descriptions`. The + value you use must match the value used for the + :term:`LINUX_KERNEL_TYPE` value used by the + kernel recipe. + + :term:`LABELS` + Provides a list of targets for automatic configuration. + + See the :ref:`grub-efi ` class for more + information on how this variable is used. + + :term:`LAYERDEPENDS` + Lists the layers, separated by spaces, on which this recipe depends. + Optionally, you can specify a specific layer version for a dependency + by adding it to the end of the layer name. Here is an example: + :: + + LAYERDEPENDS_mylayer = "anotherlayer (=3)" + + In this previous example, + version 3 of "anotherlayer" is compared against + :term:`LAYERVERSION`\ ``_anotherlayer``. + + An error is produced if any dependency is missing or the version + numbers (if specified) do not match exactly. This variable is used in + the ``conf/layer.conf`` file and must be suffixed with the name of + the specific layer (e.g. ``LAYERDEPENDS_mylayer``). + + :term:`LAYERDIR` + When used inside the ``layer.conf`` configuration file, this variable + provides the path of the current layer. This variable is not + available outside of ``layer.conf`` and references are expanded + immediately when parsing of the file completes. + + :term:`LAYERRECOMMENDS` + Lists the layers, separated by spaces, recommended for use with this + layer. + + Optionally, you can specify a specific layer version for a + recommendation by adding the version to the end of the layer name. + Here is an example: + :: + + LAYERRECOMMENDS_mylayer = "anotherlayer (=3)" + + In this previous example, version 3 of "anotherlayer" is compared + against ``LAYERVERSION_anotherlayer``. + + This variable is used in the ``conf/layer.conf`` file and must be + suffixed with the name of the specific layer (e.g. + ``LAYERRECOMMENDS_mylayer``). + + :term:`LAYERSERIES_COMPAT` + Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which + a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable + allows the layer maintainer to indicate which combinations of the + layer and OE-Core can be expected to work. The variable gives the + system a way to detect when a layer has not been tested with new + releases of OE-Core (e.g. the layer is not maintained). + + To specify the OE-Core versions for which a layer is compatible, use + this variable in your layer's ``conf/layer.conf`` configuration file. + For the list, use the Yocto Project + :yocto_wiki:`Release Name ` (e.g. + DISTRO_NAME_NO_CAP). To specify multiple OE-Core versions for the + layer, use a space-separated list: + :: + + LAYERSERIES_COMPAT_layer_root_name = "DISTRO_NAME_NO_CAP DISTRO_NAME_NO_CAP_MINUS_ONE" + + .. note:: + + Setting ``LAYERSERIES_COMPAT`` is required by the Yocto Project + Compatible version 2 standard. + The OpenEmbedded build system produces a warning if the variable + is not set for any given layer. + + See the ":ref:`dev-manual/common-tasks:creating your own layer`" + section in the Yocto Project Development Tasks Manual. + + :term:`LAYERVERSION` + Optionally specifies the version of a layer as a single number. You + can use this within :term:`LAYERDEPENDS` for + another layer in order to depend on a specific version of the layer. + This variable is used in the ``conf/layer.conf`` file and must be + suffixed with the name of the specific layer (e.g. + ``LAYERVERSION_mylayer``). + + :term:`LD` + The minimal command and arguments used to run the linker. + + :term:`LDFLAGS` + 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. + + Default initialization for ``LDFLAGS`` varies depending on what is + being built: + + - :term:`TARGET_LDFLAGS` when building for the + target + + - :term:`BUILD_LDFLAGS` when building for the + build host (i.e. ``-native``) + + - :term:`BUILDSDK_LDFLAGS` when building for + an SDK (i.e. ``nativesdk-``) + + :term:`LEAD_SONAME` + Specifies the lead (or primary) compiled library file (i.e. ``.so``) + that the :ref:`debian ` class applies its + naming policy to given a recipe that packages multiple libraries. + + This variable works in conjunction with the ``debian`` class. + + :term:`LIC_FILES_CHKSUM` + Checksums of the license text in the recipe source code. + + 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. + + This variable must be defined for all recipes (unless + :term:`LICENSE` is set to "CLOSED"). + + For more information, see the ":ref:`dev-manual/common-tasks:tracking license changes`" + section in the Yocto Project Development Tasks Manual. + + :term:`LICENSE` + The list of source licenses for the recipe. Follow these rules: + + - Do not use spaces within individual license names. + + - Separate license names using \| (pipe) when there is a choice + between licenses. + + - Separate license names using & (ampersand) when multiple licenses + exist that cover different parts of the source. + + - You can use spaces between license names. + + - For standard licenses, use the names of the files in + ``meta/files/common-licenses/`` or the + :term:`SPDXLICENSEMAP` flag names defined in + ``meta/conf/licenses.conf``. + + Here are some examples: + :: + + LICENSE = "LGPLv2.1 | GPLv3" + LICENSE = "MPL-1 & LGPLv2.1" + LICENSE = "GPLv2+" + + 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 ``sysstat``, which presents a single + license. + + 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: + :: + + LICENSE = "GFDL-1.2 & GPLv2" + LICENSE_${PN} = "GPLv2" + LICENSE_${PN}-doc = "GFDL-1.2" + + :term:`LICENSE_CREATE_PACKAGE` + Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded + build system to create an extra package (i.e. + ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add + those packages to the + :term:`RRECOMMENDS`\ ``_${PN}``. + + The ``${PN}-lic`` package installs a directory in + ``/usr/share/licenses`` named ``${PN}``, 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 ``meta/common-licenses`` that match the licenses specified in + the :term:`LICENSE` variable of the recipe metadata + and copies of files marked in + :term:`LIC_FILES_CHKSUM` as containing + license text). + + For related information on providing license text, see the + :term:`COPY_LIC_DIRS` variable, the + :term:`COPY_LIC_MANIFEST` variable, and the + ":ref:`dev-manual/common-tasks:providing license text`" + section in the Yocto Project Development Tasks Manual. + + :term:`LICENSE_FLAGS` + Specifies additional flags for a recipe you must whitelist through + :term:`LICENSE_FLAGS_WHITELIST` in + order to allow the recipe to be built. When providing multiple flags, + separate them with spaces. + + This value is independent of :term:`LICENSE` 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 + ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" + section in the Yocto Project Development Tasks Manual. + + :term:`LICENSE_FLAGS_WHITELIST` + Lists license flags that when specified in + :term:`LICENSE_FLAGS` 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 + ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" + section in the Yocto Project Development Tasks Manual. + + :term:`LICENSE_PATH` + Path to additional licenses used during the build. By default, the + OpenEmbedded build system uses ``COMMON_LICENSE_DIR`` to define the + directory that holds common license text used during the build. The + ``LICENSE_PATH`` variable allows you to extend that location to other + areas that have additional licenses: + :: + + LICENSE_PATH += "path-to-additional-common-licenses" + + :term:`LINUX_KERNEL_TYPE` + 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 ":ref:`kernel-dev/advanced:kernel types`" + section in the + Yocto Project Linux Kernel Development Manual for more information on + kernel types. + + If you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to + "standard". Together with :term:`KMACHINE`, the + ``LINUX_KERNEL_TYPE`` variable defines the search arguments used by + the kernel tools to find the appropriate description within the + kernel :term:`Metadata` with which to build out the sources + and configuration. + + :term:`LINUX_VERSION` + 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. For example, the + ``linux-yocto-3.4.bb`` kernel recipe found in + ``meta/recipes-kernel/linux`` defines the variables as follows: + :: + + LINUX_VERSION ?= "3.4.24" + + The ``LINUX_VERSION`` variable is used to define :term:`PV` + for the recipe: + :: + + PV = "${LINUX_VERSION}+git${SRCPV}" + + :term:`LINUX_VERSION_EXTENSION` + 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: + :: + + LINUX_VERSION_EXTENSION ?= "-yocto-${LINUX_KERNEL_TYPE}" + + Defining this variable essentially sets the Linux kernel + configuration item ``CONFIG_LOCALVERSION``, which is visible through + the ``uname`` command. Here is an example that shows the extension + assuming it was set as previously shown: + :: + + $ uname -r + 3.7.0-rc8-custom + + :term:`LOG_DIR` + Specifies the directory to which the OpenEmbedded build system writes + overall log files. The default directory is ``${TMPDIR}/log``. + + For the directory containing logs specific to each task, see the + :term:`T` variable. + + :term:`MACHINE` + Specifies the target device for which the image is built. You define + ``MACHINE`` in the ``local.conf`` file found in the + :term:`Build Directory`. By default, ``MACHINE`` is set to + "qemux86", which is an x86-based architecture machine to be emulated + using QEMU: + :: + + MACHINE ?= "qemux86" + + The variable corresponds to a machine configuration file of the same + name, through which machine-specific configurations are set. Thus, + when ``MACHINE`` is set to "qemux86" there exists the corresponding + ``qemux86.conf`` machine configuration file, which can be found in + the :term:`Source Directory` in + ``meta/conf/machine``. + + The list of machines supported by the Yocto Project as shipped + include the following: + :: + + MACHINE ?= "qemuarm" + MACHINE ?= "qemuarm64" + MACHINE ?= "qemumips" + MACHINE ?= "qemumips64" + MACHINE ?= "qemuppc" + MACHINE ?= "qemux86" + MACHINE ?= "qemux86-64" + MACHINE ?= "genericx86" + MACHINE ?= "genericx86-64" + MACHINE ?= "beaglebone" + MACHINE ?= "edgerouter" + + The last five are Yocto Project reference hardware + boards, which are provided in the ``meta-yocto-bsp`` layer. + + .. note:: + + Adding additional Board Support Package (BSP) layers to your + configuration adds new possible settings for ``MACHINE``. + + :term:`MACHINE_ARCH` + Specifies the name of the machine-specific architecture. This + variable is set automatically from :term:`MACHINE` or + :term:`TUNE_PKGARCH`. You should not hand-edit + the ``MACHINE_ARCH`` variable. + + :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS` + 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 + ``packagegroup-core-boot``, including the ``core-image-minimal`` + image. + + This variable is similar to the + ``MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` 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. + + As an example, suppose the machine for which you are building + requires ``example-init`` to be run during boot to initialize the + hardware. In this case, you would use the following in the machine's + ``.conf`` configuration file: + :: + + MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init" + + :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` + 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 ``packagegroup-core-boot``, including the ``core-image-minimal`` + image. + + This variable is similar to the ``MACHINE_ESSENTIAL_EXTRA_RDEPENDS`` + 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. + + 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 ``kernel-module-ab123``, you would + use the following in the machine's ``.conf`` configuration file: + :: + + MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123" + + .. note:: + + In this example, the ``kernel-module-ab123`` recipe needs to + explicitly set its :term:`PACKAGES` variable to ensure that BitBake + does not use the kernel recipe's :term:`PACKAGES_DYNAMIC` variable to + satisfy the dependency. + + Some examples of these machine essentials are flash, screen, + keyboard, mouse, or touchscreen drivers (depending on the machine). + + :term:`MACHINE_EXTRA_RDEPENDS` + 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. + + This variable affects all images based on ``packagegroup-base``, + which does not include the ``core-image-minimal`` or + ``core-image-full-cmdline`` images. + + The variable is similar to the ``MACHINE_EXTRA_RRECOMMENDS`` 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. + + 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 ``wifidriver-firmware``, you would use the + following in the ``.conf`` file for the machine: + :: + + MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware" + + :term:`MACHINE_EXTRA_RRECOMMENDS` + 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. + + This variable affects only images based on ``packagegroup-base``, + which does not include the ``core-image-minimal`` or + ``core-image-full-cmdline`` images. + + This variable is similar to the ``MACHINE_EXTRA_RDEPENDS`` 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. + + 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 ``kernel-module-examplewifi``, you would use the + following in the ``.conf`` file for the machine: + :: + + MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi" + + :term:`MACHINE_FEATURES` + Specifies the list of hardware features the + :term:`MACHINE` is capable of supporting. For related + information on enabling features, see the + :term:`DISTRO_FEATURES`, + :term:`COMBINED_FEATURES`, and + :term:`IMAGE_FEATURES` variables. + + For a list of hardware features supported by the Yocto Project as + shipped, see the ":ref:`ref-features-machine`" section. + + :term:`MACHINE_FEATURES_BACKFILL` + 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. 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 ":ref:`ref-features-backfill`" + section for more information. + + :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` + Features from ``MACHINE_FEATURES_BACKFILL`` that should not be + backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See + the ":ref:`ref-features-backfill`" section for more information. + + :term:`MACHINEOVERRIDES` + A colon-separated list of overrides that apply to the current + machine. By default, this list includes the value of + :term:`MACHINE`. + + You can extend ``MACHINEOVERRIDES`` to add extra overrides that + should apply to a machine. For example, all machines emulated in QEMU + (e.g. ``qemuarm``, ``qemux86``, and so forth) include a file named + ``meta/conf/machine/include/qemu.inc`` that prepends the following + override to ``MACHINEOVERRIDES``: + :: + + MACHINEOVERRIDES =. "qemuall:" + + This + override allows variables to be overridden for all machines emulated + in QEMU, like in the following example from the ``connman-conf`` + recipe: + :: + + SRC_URI_append_qemuall = " file://wired.config \ + file://wired-setup \ + " + + The underlying mechanism behind + ``MACHINEOVERRIDES`` is simply that it is included in the default + value of :term:`OVERRIDES`. + + :term:`MAINTAINER` + The email address of the distribution maintainer. + + :term:`MIRRORS` + 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 + :term:`PREMIRRORS`, the upstream source, and then + locations specified by ``MIRRORS`` in that order. + + Assuming your distribution (:term:`DISTRO`) is "poky", + the default value for ``MIRRORS`` is defined in the + ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. + + :term:`MLPREFIX` + Specifies a prefix has been added to :term:`PN` to create a + special version of a recipe or package (i.e. 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 :term:`BPN` variable). + ``MLPREFIX`` gets set when a prefix has been added to ``PN``. + + .. note:: + + The "ML" in ``MLPREFIX`` stands for "MultiLib". This representation is + historical and comes from a time when ``nativesdk`` was a suffix + rather than a prefix on the recipe name. When ``nativesdk`` was turned + into a prefix, it made sense to set ``MLPREFIX`` for it as well. + + To help understand when ``MLPREFIX`` might be needed, consider when + :term:`BBCLASSEXTEND` is used to provide a + ``nativesdk`` version of a recipe in addition to the target version. + If that recipe declares build-time dependencies on tasks in other + recipes by using :term:`DEPENDS`, then a dependency on + "foo" will automatically get rewritten to a dependency on + "nativesdk-foo". However, dependencies like the following will not + get rewritten automatically: + :: + + do_foo[depends] += "recipe:do_foo" + + If you want such a dependency to also get transformed, you can do the + following: + :: + + do_foo[depends] += "${MLPREFIX}recipe:do_foo" + + module_autoload + 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``, for example: + :: + + module_autoload_rfcomm = "rfcomm" + + should now be replaced with: + :: + + KERNEL_MODULE_AUTOLOAD += "rfcomm" + + See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. + + module_conf + Specifies `modprobe.d `_ + syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` + file. + + 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 + :term:`KERNEL_MODULE_AUTOLOAD` + variable. + + Here is the general syntax: + :: + + module_conf_module_name = "modprobe.d-syntax" + + You must use the kernel module name override. + + Run ``man modprobe.d`` in the shell to find out more information on + the exact syntax you want to provide with ``module_conf``. + + Including ``module_conf`` causes the OpenEmbedded build system to + populate the ``/etc/modprobe.d/modname.conf`` file with + ``modprobe.d`` syntax lines. Here is an example that adds the options + ``arg1`` and ``arg2`` to a module named ``mymodule``: + :: + + module_conf_mymodule = "options mymodule arg1=val1 arg2=val2" + + For information on how to specify kernel modules to auto-load on + boot, see the :term:`KERNEL_MODULE_AUTOLOAD` variable. + + :term:`MODULE_TARBALL_DEPLOY` + 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. + + :term:`MODULE_TARBALL_LINK_NAME` + The link name of the kernel module tarball. This variable is set in + the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: + :: + + MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" + + The value + of the ``KERNEL_ARTIFACT_LINK_NAME`` variable, which is set in the + same file, has the following value: + :: + + KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" + + See the :term:`MACHINE` variable for additional information. + + :term:`MODULE_TARBALL_NAME` + The base name of the kernel module tarball. This variable is set in + the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: + :: + + MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + The value of the :term:`KERNEL_ARTIFACT_NAME` variable, + which is set in the same file, has the following value: + :: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + + :term:`MULTIMACH_TARGET_SYS` + Uniquely identifies the type of the target system for which packages + are being built. This variable allows output for different types of + target systems to be put into different subdirectories of the same + output directory. + + The default value of this variable is: + :: + + ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} + + Some classes (e.g. + :ref:`cross-canadian `) modify the + ``MULTIMACH_TARGET_SYS`` value. + + See the :term:`STAMP` variable for an example. See the + :term:`STAGING_DIR_TARGET` variable for more information. + + :term:`NATIVELSBSTRING` + A string identifying the host distribution. Strings consist of the + host distributor ID followed by the release, as reported by the + ``lsb_release`` tool or as read from ``/etc/lsb-release``. 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". + + This variable is used by default to isolate native shared state + packages for different distributions (e.g. to avoid problems with + ``glibc`` version incompatibilities). Additionally, the variable is + checked against + :term:`SANITY_TESTED_DISTROS` if that + variable is set. + + :term:`NM` + The minimal command and arguments to run ``nm``. + + :term:`NO_GENERIC_LICENSE` + Avoids QA errors when you use a non-common, non-CLOSED license in a + recipe. Packages exist, such as the linux-firmware package, with many + licenses that are not in any way common. Also, new licenses are added + occasionally to avoid introducing a lot of common license files, + which are only applicable to a specific package. + ``NO_GENERIC_LICENSE`` is used to allow copying a license that does + not exist in common licenses. + + The following example shows how to add ``NO_GENERIC_LICENSE`` to a + recipe: + :: + + NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source" + + The following is an example that + uses the ``LICENSE.Abilis.txt`` file as the license from the fetched + source: + :: + + NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" + + :term:`NO_RECOMMENDATIONS` + Prevents installation of all "recommended-only" packages. + Recommended-only packages are packages installed only through the + :term:`RRECOMMENDS` variable). Setting the + ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on: :: + + NO_RECOMMENDATIONS = "1" + + You can set this variable globally in your ``local.conf`` file or you + can attach it to a specific image recipe by using the recipe name + override: :: + + NO_RECOMMENDATIONS_pn-target_image = "1" + + 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 :term:`RDEPENDS` + 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 :term:`IMAGE_INSTALL` variable. + + Support for this variable exists only when using the IPK and RPM + packaging backend. Support does not exist for DEB. + + See the :term:`BAD_RECOMMENDATIONS` and + the :term:`PACKAGE_EXCLUDE` variables for + related information. + + :term:`NOAUTOPACKAGEDEBUG` + Disables auto package from splitting ``.debug`` files. If a recipe + requires ``FILES_${PN}-dbg`` to be set manually, the + ``NOAUTOPACKAGEDEBUG`` can be defined allowing you to define the + content of the debug package. For example: + :: + + NOAUTOPACKAGEDEBUG = "1" + FILES_${PN}-dev = "${includedir}/${QT_DIR_NAME}/Qt/*" + FILES_${PN}-dbg = "/usr/src/debug/" + FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch" + + :term:`OBJCOPY` + The minimal command and arguments to run ``objcopy``. + + :term:`OBJDUMP` + The minimal command and arguments to run ``objdump``. + + :term:`OE_BINCONFIG_EXTRA_MANGLE` + When inheriting the :ref:`binconfig ` 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 + ``sysroots/`` directory so that all builds that use the script will + use the correct directories for the cross compiling layout. + + See the ``meta/classes/binconfig.bbclass`` in the + :term:`Source Directory` for details on how this class + applies these additional sed command arguments. For general + information on the ``binconfig`` class, see the + ":ref:`binconfig.bbclass `" section. + + :term:`OE_IMPORTS` + An internal variable used to tell the OpenEmbedded build system what + Python modules to import for every Python function run by the system. + + .. note:: + + Do not set this variable. It is for internal use only. + + :term:`OE_INIT_ENV_SCRIPT` + 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". + + If you use a custom script to set up your build environment, set the + ``OE_INIT_ENV_SCRIPT`` variable to its name. + + :term:`OE_TERMINAL` + Controls how the OpenEmbedded build system spawns interactive + terminals on the host development system (e.g. using the BitBake + command with the ``-c devshell`` command-line option). For more + information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in + the Yocto Project Development Tasks Manual. + + You can use the following values for the ``OE_TERMINAL`` variable: + + - auto + - gnome + - xfce + - rxvt + - screen + - konsole + - none + + :term:`OEROOT` + The directory from which the top-level build environment setup script + is sourced. The Yocto Project provides a top-level build environment + setup script: :ref:`structure-core-script`. When you run this + script, the ``OEROOT`` variable resolves to the directory that + contains the script. + + For additional information on how this variable is used, see the + initialization script. + + :term:`OLDEST_KERNEL` + 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 (``glibc``). + + The default for this variable comes from the + ``meta/conf/bitbake.conf`` configuration file. You can override this + default by setting the variable in a custom distribution + configuration file. + + :term:`OVERRIDES` + A colon-separated list of overrides that currently apply. Overrides + are a BitBake mechanism that allows variables to be selectively + overridden at the end of parsing. The set of overrides in + ``OVERRIDES`` represents the "state" during building, which includes + the current recipe being built, the machine for which it is being + built, and so forth. + + As an example, if the string "an-override" appears as an element in + the colon-separated list in ``OVERRIDES``, then the following + assignment will override ``FOO`` with the value "overridden" at the + end of parsing: + :: + + FOO_an-override = "overridden" + + See the + ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" + section in the BitBake User Manual for more information on the + overrides mechanism. + + The default value of ``OVERRIDES`` includes the values of the + :term:`CLASSOVERRIDE`, + :term:`MACHINEOVERRIDES`, and + :term:`DISTROOVERRIDES` variables. Another + important override included by default is ``pn-${PN}``. This override + allows variables to be set for a single recipe within configuration + (``.conf``) files. Here is an example: + :: + + FOO_pn-myrecipe = "myrecipe-specific value" + + .. note:: + + An easy way to see what overrides apply is to search for ``OVERRIDES`` + in the output of the ``bitbake -e`` command. See the + ":ref:`dev-manual/common-tasks:viewing variable values`" section in the Yocto + Project Development Tasks Manual for more information. + + :term:`P` + The recipe name and version. ``P`` is comprised of the following: + :: + + ${PN}-${PV} + + :term:`PACKAGE_ADD_METADATA` + This variable defines additional metdata to add to packages. + + You may find you need to inject additional metadata into packages. + This variable allows you to do that by setting the injected data as + the value. Multiple fields can be added by splitting the content with + the literal separator "\n". + + The suffixes '_IPK', '_DEB', or '_RPM' can be applied to the variable + to do package type specific settings. It can also be made package + specific by using the package name as a suffix. + + You can find out more about applying this variable in the + ":ref:`dev-manual/common-tasks:adding custom metadata to packages`" + section in the Yocto Project Development Tasks Manual. + + :term:`PACKAGE_ARCH` + The architecture of the resulting package or packages. + + By default, the value of this variable is set to + :term:`TUNE_PKGARCH` when building for the + target, :term:`BUILD_ARCH` when building for the + build host, and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building for the + SDK. + + .. note:: + + See :term:`SDK_ARCH` for more information. + + However, if your recipe's output packages are built specific to the + target machine rather than generally for the architecture of the + machine, you should set ``PACKAGE_ARCH`` to the value of + :term:`MACHINE_ARCH` in the recipe as follows: + :: + + PACKAGE_ARCH = "${MACHINE_ARCH}" + + :term:`PACKAGE_ARCHS` + 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 ``PACKAGE_ARCHS`` is "all any + noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}". + + :term:`PACKAGE_BEFORE_PN` + Enables easily adding packages to ``PACKAGES`` before ``${PN}`` so + that those added packages can pick up files that would normally be + included in the default package. + + :term:`PACKAGE_CLASSES` + This variable, which is set in the ``local.conf`` configuration file + found in the ``conf`` folder of the + :term:`Build Directory`, specifies the package manager the + OpenEmbedded build system uses when packaging data. + + You can provide one or more of the following arguments for the + variable: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk + package_tar" + + .. note:: + + While it is a legal option, the ``package_tar`` + class has limited functionality due to no support for package + dependencies by that backend. Therefore, it is recommended that + you do not use it. + + 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 ``local.conf`` file: + :: + + PACKAGE_CLASSES ?= "package_ipk" + + The OpenEmbedded build system uses + the IPK package manager to create your image or SDK. + + For information on packaging and build performance effects as a + result of the package manager in use, see the + ":ref:`package.bbclass `" section. + + :term:`PACKAGE_DEBUG_SPLIT_STYLE` + Determines how to split up the binary and debug information when + creating ``*-dbg`` packages to be used with the GNU Project Debugger + (GDB). + + With the ``PACKAGE_DEBUG_SPLIT_STYLE`` variable, you can control + where debug information, which can include or exclude source files, + is stored: + + - ".debug": Debug symbol files are placed next to the binary in a + ``.debug`` directory on the target. For example, if a binary is + installed into ``/bin``, the corresponding debug symbol files are + installed in ``/bin/.debug``. Source files are placed in + ``/usr/src/debug``. + + - "debug-file-directory": Debug symbol files are placed under + ``/usr/lib/debug`` on the target, and separated by the path from + where the binary is installed. For example, if a binary is + installed in ``/bin``, the corresponding debug symbols are + installed in ``/usr/lib/debug/bin``. Source files are placed in + ``/usr/src/debug``. + + - "debug-without-src": The same behavior as ".debug" previously + described with the exception that no source files are installed. + + - "debug-with-srcpkg": The same behavior as ".debug" previously + described with the exception that all source files are placed in a + separate ``*-src`` pkg. This is the default behavior. + + You can find out more about debugging using GDB by reading the + ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section + in the Yocto Project Development Tasks Manual. + + :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` + Prevents specific packages from being installed when you are + installing complementary packages. + + You might find that you want to prevent installing certain packages + when you are installing complementary packages. For example, if you + are using :term:`IMAGE_FEATURES` to install + ``dev-pkgs``, you might not want to install all packages from a + particular multilib. If you find yourself in this situation, you can + use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular + expressions to match the packages you want to exclude. + + :term:`PACKAGE_EXCLUDE` + Lists packages that should not be installed into an image. For + example: + :: + + PACKAGE_EXCLUDE = "package_name package_name package_name ..." + + You can set this variable globally in your ``local.conf`` file or you + can attach it to a specific image recipe by using the recipe name + override: + :: + + PACKAGE_EXCLUDE_pn-target_image = "package_name" + + 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 + :term:`RDEPENDS` 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. + + Support for this variable exists only when using the IPK and RPM + packaging backend. Support does not exist for DEB. + + See the :term:`NO_RECOMMENDATIONS` and the + :term:`BAD_RECOMMENDATIONS` variables for + related information. + + :term:`PACKAGE_EXTRA_ARCHS` + 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. + + :term:`PACKAGE_FEED_ARCHS` + Optionally specifies the package architectures used as part of the + package feed URIs during the build. When used, the + ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed + URI, which is constructed using the + :term:`PACKAGE_FEED_URIS` and + :term:`PACKAGE_FEED_BASE_PATHS` + variables. + + .. note:: + + You can use the ``PACKAGE_FEED_ARCHS`` + variable to whitelist specific package architectures. If you do + not need to whitelist specific architectures, which is a common + case, you can omit this variable. Omitting the variable results in + all available architectures for the current machine being included + into remote package feeds. + + Consider the following example where the ``PACKAGE_FEED_URIS``, + ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are + defined in your ``local.conf`` file: + :: + + 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" + + Given these settings, the resulting package feeds are as follows: + + .. code-block:: none + + 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 + + :term:`PACKAGE_FEED_BASE_PATHS` + Specifies the base path used when constructing package feed URIs. The + ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a + package feed URI used by the OpenEmbedded build system. The base path + lies between the :term:`PACKAGE_FEED_URIS` + and :term:`PACKAGE_FEED_ARCHS` variables. + + Consider the following example where the ``PACKAGE_FEED_URIS``, + ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are + defined in your ``local.conf`` file: + :: + + 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" + + Given these settings, the resulting package feeds are as follows: + + .. code-block:: none + + 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 + + :term:`PACKAGE_FEED_URIS` + Specifies the front portion of the package feed URI used by the + OpenEmbedded build system. Each final package feed URI is comprised + of ``PACKAGE_FEED_URIS``, + :term:`PACKAGE_FEED_BASE_PATHS`, and + :term:`PACKAGE_FEED_ARCHS` variables. + + Consider the following example where the ``PACKAGE_FEED_URIS``, + ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are + defined in your ``local.conf`` file: + :: + + 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" + + Given these settings, the resulting package feeds are as follows: + + .. code-block:: none + + 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 + + :term:`PACKAGE_INSTALL` + The final list of packages passed to the package manager for + installation into the image. + + Because the package manager controls actual installation of all + packages, the list of packages passed using ``PACKAGE_INSTALL`` 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 + :term:`IMAGE_INSTALL` variable to specify + packages for installation. The exception to this is when working with + the :ref:`core-image-minimal-initramfs ` + image. When working with an initial RAM filesystem (initramfs) image, + use the ``PACKAGE_INSTALL`` variable. For information on creating an + initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section + in the Yocto Project Development Tasks Manual. + + :term:`PACKAGE_INSTALL_ATTEMPTONLY` + 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. + + :term:`PACKAGE_PREPROCESS_FUNCS` + Specifies a list of functions run to pre-process the + :term:`PKGD` directory prior to splitting the files out + to individual packages. + + :term:`PACKAGE_WRITE_DEPS` + Specifies a list of dependencies for post-installation and + pre-installation scripts on native/cross tools. If your + post-installation or pre-installation script can execute at rootfs + creation time rather than on the target but depends on a native tool + in order to execute, you need to list the tools in + ``PACKAGE_WRITE_DEPS``. + + For information on running post-installation scripts, see the + ":ref:`dev-manual/common-tasks:post-installation scripts`" + section in the Yocto Project Development Tasks Manual. + + :term:`PACKAGECONFIG` + This variable provides a means of enabling or disabling features of a + recipe on a per-recipe basis. ``PACKAGECONFIG`` blocks are defined in + recipes when you specify features and then arguments that define + feature behaviors. Here is the basic block structure (broken over + multiple lines for readability): + :: + + PACKAGECONFIG ??= "f1 f2 f3 ..." + PACKAGECONFIG[f1] = "\ + --with-f1, \ + --without-f1, \ + build-deps-for-f1, \ + runtime-deps-for-f1, \ + runtime-recommends-for-f1, \ + packageconfig-conflicts-for-f1" + PACKAGECONFIG[f2] = "\ + ... and so on and so on ... + + The ``PACKAGECONFIG`` 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 six + 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: + + 1. Extra arguments that should be added to the configure script + argument list (:term:`EXTRA_OECONF` or + :term:`PACKAGECONFIG_CONFARGS`) if + the feature is enabled. + + 2. Extra arguments that should be added to ``EXTRA_OECONF`` or + ``PACKAGECONFIG_CONFARGS`` if the feature is disabled. + + 3. Additional build dependencies (:term:`DEPENDS`) + that should be added if the feature is enabled. + + 4. Additional runtime dependencies (:term:`RDEPENDS`) + that should be added if the feature is enabled. + + 5. Additional runtime recommendations + (:term:`RRECOMMENDS`) that should be added if + the feature is enabled. + + 6. Any conflicting (that is, mutually exclusive) ``PACKAGECONFIG`` + settings for this feature. + + Consider the following ``PACKAGECONFIG`` block taken from the + ``librsvg`` recipe. In this example the feature is ``gtk``, which has + three arguments that determine the feature's behavior. + :: + + PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3" + + The + ``--with-gtk3`` and ``gtk+3`` arguments apply only if the feature is + enabled. In this case, ``--with-gtk3`` is added to the configure + script argument list and ``gtk+3`` is added to ``DEPENDS``. On the + other hand, if the feature is disabled say through a ``.bbappend`` + file in another layer, then the second argument ``--without-gtk3`` is + added to the configure script instead. + + The basic ``PACKAGECONFIG`` 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. + + If you want to change an existing ``PACKAGECONFIG`` block, you can do + so one of two ways: + + - *Append file:* Create an append file named + recipename\ ``.bbappend`` in your layer and override the value of + ``PACKAGECONFIG``. You can either completely override the + variable: + :: + + PACKAGECONFIG = "f4 f5" + + Or, you can just append the variable: + :: + + PACKAGECONFIG_append = " f4" + + - *Configuration file:* This method is identical to changing the + block through an append file except you edit your ``local.conf`` + or ``mydistro.conf`` file. As with append files previously + described, you can either completely override the variable: + :: + + PACKAGECONFIG_pn-recipename = "f4 f5" + + Or, you can just amend the variable: + :: + + PACKAGECONFIG_append_pn-recipename = " f4" + + :term:`PACKAGECONFIG_CONFARGS` + A space-separated list of configuration options generated from the + :term:`PACKAGECONFIG` setting. + + Classes such as :ref:`autotools ` and + :ref:`cmake ` use ``PACKAGECONFIG_CONFARGS`` to + pass ``PACKAGECONFIG`` options to ``configure`` and ``cmake``, + respectively. If you are using ``PACKAGECONFIG`` but not a class that + handles the ``do_configure`` task, then you need to use + ``PACKAGECONFIG_CONFARGS`` appropriately. + + :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY` + For recipes inheriting the + :ref:`packagegroup ` class, setting + ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the + normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth) + should not be automatically created by the ``packagegroup`` recipe, + which is the default behavior. + + :term:`PACKAGES` + The list of packages the recipe creates. The default value is the + following: + :: + + ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} + + During packaging, the :ref:`ref-tasks-package` task + goes through ``PACKAGES`` and uses the :term:`FILES` + variable corresponding to each package to assign files to the + package. If a file matches the ``FILES`` variable for more than one + package in ``PACKAGES``, it will be assigned to the earliest + (leftmost) package. + + Packages in the variable's list that are empty (i.e. where none of + the patterns in ``FILES_``\ pkg match any files installed by the + :ref:`ref-tasks-install` task) are not generated, + unless generation is forced through the + :term:`ALLOW_EMPTY` variable. + + :term:`PACKAGES_DYNAMIC` + A promise that your recipe satisfies runtime dependencies for + optional modules that are found in other recipes. + ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it + only states that they should be satisfied. For example, if a hard, + runtime dependency (:term:`RDEPENDS`) of another + package is satisfied at build time through the ``PACKAGES_DYNAMIC`` + 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 + :ref:`ref-tasks-rootfs` task. + + 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 :term:`RRECOMMENDS` + (a soft runtime dependency) instead of ``RDEPENDS``. + + For an example of how to use the ``PACKAGES_DYNAMIC`` variable when + you are splitting packages, see the + ":ref:`dev-manual/common-tasks:handling optional module packaging`" + section in the Yocto Project Development Tasks Manual. + + :term:`PACKAGESPLITFUNCS` + 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 ``populate_packages`` function in order to + perform additional package splitting. In either case, the function + should set :term:`PACKAGES`, + :term:`FILES`, :term:`RDEPENDS` and + other packaging variables appropriately in order to perform the + desired splitting. + + :term:`PARALLEL_MAKE` + Extra options passed to the ``make`` command during the + :ref:`ref-tasks-compile` task in order to specify + parallel compilation on the local build host. This variable is + usually in the form "-j x", where x represents the maximum number of + parallel threads ``make`` can run. + + .. note:: + + In order for ``PARALLEL_MAKE`` to be effective, ``make`` must be + called with ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure + this is to use the ``oe_runmake`` function. + + 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 ``do_compile`` task that result in race conditions, you can clear + the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For + information on addressing race conditions, see the + ":ref:`dev-manual/common-tasks:debugging parallel make races`" + section in the Yocto Project Development Tasks Manual. + + 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 ``PARALLEL_MAKE`` variable is + not set higher than "-j 20". + + For more information on speeding up builds, see the + ":ref:`dev-manual/common-tasks:speeding up a build`" + section in the Yocto Project Development Tasks Manual. + + :term:`PARALLEL_MAKEINST` + Extra options passed to the ``make install`` command during the + :ref:`ref-tasks-install` task in order to specify + parallel installation. This variable defaults to the value of + :term:`PARALLEL_MAKE`. + + .. note:: + + In order for ``PARALLEL_MAKEINST`` to be effective, ``make`` must + be called with + ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy + way to ensure this is to use the ``oe_runmake`` function. + + If the software being built experiences dependency issues during + the ``do_install`` task that result in race conditions, you can + clear the ``PARALLEL_MAKEINST`` variable within the recipe as a + workaround. For information on addressing race conditions, see the + ":ref:`dev-manual/common-tasks:debugging parallel make races`" + section in the Yocto Project Development Tasks Manual. + + :term:`PATCHRESOLVE` + Determines the action to take when a patch fails. You can set this + variable to one of two values: "noop" and "user". + + 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. + + Set this variable in your ``local.conf`` file. + + :term:`PATCHTOOL` + Specifies the utility used to apply patches for a recipe during the + :ref:`ref-tasks-patch` 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". + + If you wish to use an alternative patching tool, set the variable in + the recipe using one of the following: + :: + + PATCHTOOL = "patch" + PATCHTOOL = "quilt" + PATCHTOOL = "git" + + :term:`PE` + 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. + + ``PE`` is the default value of the :term:`PKGE` variable. + + :term:`PF` + Specifies the recipe or package name and includes all version and + revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and + ``bash-4.2-r1/``). This variable is comprised of the following: + ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} + + :term:`PIXBUF_PACKAGES` + When inheriting the :ref:`pixbufcache ` + class, this variable identifies packages that contain the pixbuf + loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` + class assumes that the loaders are in the recipe's main package (i.e. + ``${``\ :term:`PN`\ ``}``). Use this variable if the + loaders you need are in a package other than that main package. + + :term:`PKG` + The name of the resulting package created by the OpenEmbedded build + system. + + .. note:: + + When using the ``PKG`` variable, you must use a package name override. + + For example, when the :ref:`debian ` class + renames the output package, it does so by setting + ``PKG_packagename``. + + :term:`PKG_CONFIG_PATH` + The path to ``pkg-config`` files for the current build context. + ``pkg-config`` reads this variable from the environment. + + :term:`PKGD` + Points to the destination directory for files to be packaged before + they are split into individual packages. This directory defaults to + the following: + :: + + ${WORKDIR}/package + + Do not change this default. + + :term:`PKGDATA_DIR` + Points to a shared, global-state directory that holds data generated + during the packaging process. During the packaging process, the + :ref:`ref-tasks-packagedata` task packages data + for each recipe and installs it into this temporary, shared area. + This directory defaults to the following, which you should not + change: + :: + + ${STAGING_DIR_HOST}/pkgdata + + For examples of how this data is used, see the + ":ref:`overview-manual/concepts:automatically added runtime dependencies`" + section in the Yocto Project Overview and Concepts Manual and the + ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" + section in the Yocto Project Development Tasks Manual. For more + information on the shared, global-state directory, see + :term:`STAGING_DIR_HOST`. + + :term:`PKGDEST` + Points to the parent directory for files to be packaged after they + have been split into individual packages. This directory defaults to + the following: + :: + + ${WORKDIR}/packages-split + + Under this directory, the build system creates directories for each + package specified in :term:`PACKAGES`. Do not change + this default. + + :term:`PKGDESTWORK` + Points to a temporary work area where the + :ref:`ref-tasks-package` task saves package metadata. + The ``PKGDESTWORK`` location defaults to the following: + :: + + ${WORKDIR}/pkgdata + + Do not change this default. + + The :ref:`ref-tasks-packagedata` task copies the + package metadata from ``PKGDESTWORK`` to + :term:`PKGDATA_DIR` to make it available globally. + + :term:`PKGE` + The epoch of the package(s) built by the recipe. By default, ``PKGE`` + is set to :term:`PE`. + + :term:`PKGR` + The revision of the package(s) built by the recipe. By default, + ``PKGR`` is set to :term:`PR`. + + :term:`PKGV` + The version of the package(s) built by the recipe. By default, + ``PKGV`` is set to :term:`PV`. + + :term:`PN` + This variable can have two separate functions depending on the + context: a recipe name or a resulting package name. + + ``PN`` 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 ``expat_2.0.1.bb``, then the default value of ``PN`` + will be "expat". + + The variable refers to a package name in the context of a file + created or produced by the OpenEmbedded build system. + + If applicable, the ``PN`` variable also contains any special suffix + or prefix. For example, using ``bash`` to build packages for the + native machine, ``PN`` is ``bash-native``. Using ``bash`` to build + packages for the target and for Multilib, ``PN`` would be ``bash`` + and ``lib64-bash``, respectively. + + :term:`PNBLACKLIST` + Lists recipes you do not want the OpenEmbedded build system to build. + This variable works in conjunction with the + :ref:`blacklist ` class, which is inherited + globally. + + To prevent a recipe from being built, use the ``PNBLACKLIST`` + variable in your ``local.conf`` file. Here is an example that + prevents ``myrecipe`` from being built: + :: + + PNBLACKLIST[myrecipe] = "Not supported by our organization." + + :term:`POPULATE_SDK_POST_HOST_COMMAND` + 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: + :: + + POPULATE_SDK_POST_HOST_COMMAND += "function; ... " + + If you need to pass the SDK path to a command within a function, you + can use ``${SDK_DIR}``, which points to the parent directory used by + the OpenEmbedded build system when creating SDK output. See the + :term:`SDK_DIR` variable for more information. + + :term:`POPULATE_SDK_POST_TARGET_COMMAND` + 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: + :: + + POPULATE_SDK_POST_TARGET_COMMAND += "function; ... " + + If you need to pass the SDK path to a command within a function, you + can use ``${SDK_DIR}``, which points to the parent directory used by + the OpenEmbedded build system when creating SDK output. See the + :term:`SDK_DIR` variable for more information. + + :term:`PR` + The revision of the recipe. The default value for this variable is + "r0". Subsequent revisions of the recipe conventionally have the + values "r1", "r2", and so forth. When :term:`PV` increases, + ``PR`` is conventionally reset to "r0". + + .. note:: + + The OpenEmbedded build system does not need the aid of ``PR`` + to know when to rebuild a recipe. The build system uses the task + :ref:`input checksums ` along with the + :ref:`stamp ` and + :ref:`overview-manual/concepts:shared state cache` + mechanisms. + + The ``PR`` variable primarily becomes significant when a package + manager dynamically installs packages on an already built image. In + this case, ``PR``, which is the default value of + :term:`PKGR`, helps the package manager distinguish which + package is the most recent one in cases where many packages have the + same ``PV`` (i.e. ``PKGV``). A component having many packages with + the same ``PV`` usually means that the packages all install the same + upstream version, but with later (``PR``) version packages including + packaging fixes. + + .. note:: + + ``PR`` does not need to be increased for changes that do not change the + package contents or metadata. + + Because manually managing ``PR`` can be cumbersome and error-prone, + an automated solution exists. See the + ":ref:`dev-manual/common-tasks:working with a pr service`" section + in the Yocto Project Development Tasks Manual for more information. + + :term:`PREFERRED_PROVIDER` + If multiple recipes provide the same item, this variable determines + which recipe is preferred and thus provides the item (i.e. the + preferred provider). You should always suffix this variable with the + name of the provided item. And, you should define the variable using + the preferred recipe's name (:term:`PN`). Here is a common + example: + :: + + PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" + + In the previous example, multiple recipes are providing "virtual/kernel". + The ``PREFERRED_PROVIDER`` variable is set with the name (``PN``) of + the recipe you prefer to provide "virtual/kernel". + + Following are more examples: + :: + + PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" + PREFERRED_PROVIDER_virtual/libgl ?= "mesa" + + For more + information, see the ":ref:`dev-manual/common-tasks:using virtual providers`" + section in the Yocto Project Development Tasks Manual. + + .. note:: + + If you use a ``virtual/\*`` item with ``PREFERRED_PROVIDER``, then any + recipe that :term:`PROVIDES` that item but is not selected (defined) + by ``PREFERRED_PROVIDER`` is prevented from building, which is usually + desirable since this mechanism is designed to select between mutually + exclusive alternative providers. + + :term:`PREFERRED_VERSION` + If multiple versions of recipes exist, this variable determines which + version is given preference. You must always suffix the variable with + the :term:`PN` you want to select, and you should set the + :term:`PV` accordingly for precedence. + + The ``PREFERRED_VERSION`` variable supports limited wildcard use + through the "``%``" character. You can use the character to match any + number of characters, which can be useful when specifying versions + that contain long revision numbers that potentially change. Here are + two examples: + :: + + PREFERRED_VERSION_python = "3.4.0" + PREFERRED_VERSION_linux-yocto = "5.0%" + + .. note:: + + The use of the "%" character is limited in that it only works at the end of the + string. You cannot use the wildcard character in any other + location of the string. + + The specified version is matched against :term:`PV`, which + does not necessarily match the version part of the recipe's filename. + For example, consider two recipes ``foo_1.2.bb`` and ``foo_git.bb`` + where ``foo_git.bb`` contains the following assignment: + :: + + PV = "1.1+git${SRCPV}" + + In this case, the correct way to select + ``foo_git.bb`` is by using an assignment such as the following: + :: + + PREFERRED_VERSION_foo = "1.1+git%" + + Compare that previous example + against the following incorrect example, which does not work: + :: + + PREFERRED_VERSION_foo = "git" + + Sometimes the ``PREFERRED_VERSION`` variable can be set by + configuration files in a way that is hard to change. You can use + :term:`OVERRIDES` to set a machine-specific + override. Here is an example: + :: + + PREFERRED_VERSION_linux-yocto_qemux86 = "5.0%" + + Although not recommended, worst case, you can also use the + "forcevariable" override, which is the strongest override possible. + Here is an example: + :: + + PREFERRED_VERSION_linux-yocto_forcevariable = "5.0%" + + .. note:: + + The ``\_forcevariable`` override is not handled specially. This override + only works because the default value of ``OVERRIDES`` includes "forcevariable". + + :term:`PREMIRRORS` + 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 ``PREMIRRORS``, the upstream + source, and then locations specified by + :term:`MIRRORS` in that order. + + Assuming your distribution (:term:`DISTRO`) is "poky", + the default value for ``PREMIRRORS`` is defined in the + ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. + + Typically, you could add a specific server for the build system to + attempt before any others by adding something like the following to + the ``local.conf`` configuration file in the + :term:`Build Directory`: + :: + + 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" + + These changes cause the + build system to intercept Git, FTP, HTTP, and HTTPS requests and + direct them to the ``http://`` sources mirror. You can use + ``file://`` URLs to point to local directories or network shares as + well. + + :term:`PRIORITY` + Indicates the importance of a package. + + ``PRIORITY`` 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, ``PRIORITY`` is not + normally set within recipes. + + You can set ``PRIORITY`` to "required", "standard", "extra", and + "optional", which is the default. + + :term:`PRIVATE_LIBS` + 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. + + Libraries specified in this variable should be specified by their + file name. For example, from the Firefox recipe in meta-browser: + :: + + PRIVATE_LIBS = "libmozjs.so \ + libxpcom.so \ + libnspr4.so \ + libxul.so \ + libmozalloc.so \ + libplc4.so \ + libplds4.so" + + For more information, see the + ":ref:`overview-manual/concepts:automatically added runtime dependencies`" + section in the Yocto Project Overview and Concepts Manual. + + :term:`PROVIDES` + A list of aliases by which a particular recipe can be known. By + default, a recipe's own ``PN`` is implicitly already in its + ``PROVIDES`` list and therefore does not need to mention that it + provides itself. If a recipe uses ``PROVIDES``, the additional + aliases are synonyms for the recipe and can be useful for satisfying + dependencies of other recipes during the build as specified by + ``DEPENDS``. + + Consider the following example ``PROVIDES`` statement from the recipe + file ``eudev_3.2.9.bb``: + :: + + PROVIDES = "udev" + + The ``PROVIDES`` statement + results in the "eudev" recipe also being available as simply "udev". + + .. note:: + + Given that a recipe's own recipe name is already implicitly in its + own PROVIDES list, it is unnecessary to add aliases with the "+=" operator; + using a simple assignment will be sufficient. In other words, + while you could write: + :: + + PROVIDES += "udev" + + + in the above, the "+=" is overkill and unnecessary. + + In addition to providing recipes under alternate names, the + ``PROVIDES`` mechanism is also used to implement virtual targets. A + virtual target is a name that corresponds to some particular + functionality (e.g. a Linux kernel). Recipes that provide the + functionality in question list the virtual target in ``PROVIDES``. + Recipes that depend on the functionality in question can include the + virtual target in ``DEPENDS`` to leave the choice of provider open. + + Conventionally, virtual targets have names on the form + "virtual/function" (e.g. "virtual/kernel"). The slash is simply part + of the name and has no syntactical significance. + + The :term:`PREFERRED_PROVIDER` variable is + used to select which particular recipe provides a virtual target. + + .. note:: + + A corresponding mechanism for virtual runtime dependencies + (packages) exists. However, the mechanism does not depend on any + special functionality beyond ordinary variable assignments. For + example, ``VIRTUAL-RUNTIME_dev_manager`` refers to the package of + the component that manages the ``/dev`` directory. + + Setting the "preferred provider" for runtime dependencies is as + simple as using the following assignment in a configuration file: + :: + + VIRTUAL-RUNTIME_dev_manager = "udev" + + + :term:`PRSERV_HOST` + The network based :term:`PR` service host and port. + + The ``conf/local.conf.sample.extended`` configuration file in the + :term:`Source Directory` shows how the + ``PRSERV_HOST`` variable is set: + :: + + PRSERV_HOST = "localhost:0" + + You must + set the variable if you want to automatically start a local :ref:`PR + service `. You can + set ``PRSERV_HOST`` to other values to use a remote PR service. + + + :term:`PSEUDO_IGNORE_PATHS` + A comma-separated (without spaces) list of path prefixes that should be ignored + by pseudo when monitoring and recording file operations, in order to avoid + problems with files being written to outside of the pseudo context and + reduce pseudo's overhead. A path is ignored if it matches any prefix in the list + and can include partial directory (or file) names. + + + :term:`PTEST_ENABLED` + Specifies whether or not :ref:`Package + Test ` (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) :term:`DISTRO_FEATURES`. + + :term:`PV` + The version of the recipe. The version is normally extracted from the + recipe filename. For example, if the recipe is named + ``expat_2.0.1.bb``, then the default value of ``PV`` will be "2.0.1". + ``PV`` 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). + + ``PV`` is the default value of the :term:`PKGV` variable. + + :term:`PYTHON_ABI` + When used by recipes that inherit the + :ref:`distutils3 `, + :ref:`setuptools3 `, + :ref:`distutils `, or + :ref:`setuptools ` 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. + + The OpenEmbedded build system uses the ABI to construct directory + names used when installing the Python headers and libraries in + sysroot (e.g. ``.../python3.3m/...``). + + Recipes that inherit the ``distutils`` class during cross-builds also + use this variable to locate the headers and libraries of the + appropriate Python that the extension is targeting. + + :term:`PYTHON_PN` + When used by recipes that inherit the + `distutils3 `, + :ref:`setuptools3 `, + :ref:`distutils `, or + :ref:`setuptools ` classes, specifies the + major Python version being built. For Python 3.x, ``PYTHON_PN`` would + be "python3". You do not have to set this variable as the + OpenEmbedded build system automatically sets it for you. + + The variable allows recipes to use common infrastructure such as the + following: + :: + + DEPENDS += "${PYTHON_PN}-native" + + In the previous example, + the version of the dependency is ``PYTHON_PN``. + + :term:`RANLIB` + The minimal command and arguments to run ``ranlib``. + + :term:`RCONFLICTS` + The list of packages that conflict with packages. Note that packages + will not be installed if conflicting packages are not first removed. + + Like all package-controlling variables, you must always use them in + conjunction with a package name override. Here is an example: + :: + + RCONFLICTS_${PN} = "another_conflicting_package_name" + + 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 + ``RCONFLICTS`` variable: + :: + + RCONFLICTS_${PN} = "package (operator version)" + + For ``operator``, you can specify the following: + + - = + - < + - > + - <= + - >= + + For example, the following sets up a dependency on version 1.2 or + greater of the package ``foo``: + :: + + RCONFLICTS_${PN} = "foo (>= 1.2)" + + :term:`RDEPENDS` + Lists runtime dependencies of a package. These dependencies are other + packages that must be installed in order for the package to function + correctly. As an example, the following assignment declares that the + package ``foo`` needs the packages ``bar`` and ``baz`` to be + installed: + :: + + RDEPENDS_foo = "bar baz" + + The most common types of package + runtime dependencies are automatically detected and added. Therefore, + most recipes do not need to set ``RDEPENDS``. For more information, + see the + ":ref:`overview-manual/concepts:automatically added runtime dependencies`" + section in the Yocto Project Overview and Concepts Manual. + + The practical effect of the above ``RDEPENDS`` assignment is that + ``bar`` and ``baz`` will be declared as dependencies inside the + package ``foo`` when it is written out by one of the + :ref:`do_package_write_\* ` tasks. + Exactly how this is done depends on which package format is used, + which is determined by + :term:`PACKAGE_CLASSES`. When the + corresponding package manager installs the package, it will know to + also install the packages on which it depends. + + To ensure that the packages ``bar`` and ``baz`` get built, the + previous ``RDEPENDS`` assignment also causes a task dependency to be + added. This dependency is from the recipe's + :ref:`ref-tasks-build` (not to be confused with + :ref:`ref-tasks-compile`) task to the + ``do_package_write_*`` task of the recipes that build ``bar`` and + ``baz``. + + The names of the packages you list within ``RDEPENDS`` 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 ``RDEPENDS`` + variable. For an example of the default list of packages created from + a recipe, see the :term:`PACKAGES` variable. + + Because the ``RDEPENDS`` variable applies to packages being built, + you should always use the variable in a form with an attached package + name (remember that a single recipe can build multiple packages). For + example, suppose you are building a development package that depends + on the ``perl`` package. In this case, you would use the following + ``RDEPENDS`` statement: + :: + + RDEPENDS_${PN}-dev += "perl" + + In the example, + the development package depends on the ``perl`` package. Thus, the + ``RDEPENDS`` variable has the ``${PN}-dev`` package name as part of + the variable. + + .. note:: + + ``RDEPENDS_${PN}-dev`` includes ``${``\ :term:`PN`\ ``}`` + by default. This default is set in the BitBake configuration file + (``meta/conf/bitbake.conf``). Be careful not to accidentally remove + ``${PN}`` when modifying ``RDEPENDS_${PN}-dev``. Use the "+=" operator + rather than the "=" operator. + + The package names you use with ``RDEPENDS`` must appear as they would + in the ``PACKAGES`` variable. The :term:`PKG` variable + allows a different name to be used for the final package (e.g. the + :ref:`debian ` class uses this to rename + packages), but this final package name cannot be used with + ``RDEPENDS``, which makes sense as ``RDEPENDS`` is meant to be + independent of the package format used. + + 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 + ``RDEPENDS`` variable: + :: + + RDEPENDS_${PN} = "package (operator version)" + + For ``operator``, you can specify the following: + + - = + - < + - > + - <= + - >= + + For version, provide the version number. + + .. note:: + + You can use ``EXTENDPKGV`` to provide a full package version + specification. + + For example, the following sets up a dependency on version 1.2 or + greater of the package ``foo``: + :: + + RDEPENDS_${PN} = "foo (>= 1.2)" + + For information on build-time dependencies, see the + :term:`DEPENDS` variable. You can also see the + ":ref:`Tasks `" and + ":ref:`Dependencies `" sections in the + BitBake User Manual for additional information on tasks and + dependencies. + + :term:`REQUIRED_DISTRO_FEATURES` + When inheriting the + :ref:`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. In other words, if the + ``REQUIRED_DISTRO_FEATURES`` variable lists a feature that does not + appear in ``DISTRO_FEATURES`` within the current configuration, then + the recipe will be skipped, and if the build system attempts to build + the recipe then an error will be triggered. + + :term:`RM_WORK_EXCLUDE` + With ``rm_work`` enabled, this variable specifies a list of recipes + whose work directories should not be removed. See the + ":ref:`rm_work.bbclass `" section for more + details. + + :term:`ROOT_HOME` + Defines the root home directory. By default, this directory is set as + follows in the BitBake configuration file: + :: + + ROOT_HOME ??= "/home/root" + + .. 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. + + You can override the default by setting the variable in any layer or + in the ``local.conf`` file. Because the default is set using a "weak" + assignment (i.e. "??="), you can use either of the following forms to + define your override: + :: + + ROOT_HOME = "/root" + ROOT_HOME ?= "/root" + + These + override examples use ``/root``, which is probably the most commonly + used override. + + :term:`ROOTFS` + Indicates a filesystem image to include as the root filesystem. + + The ``ROOTFS`` variable is an optional variable used with the + :ref:`image-live ` class. + + :term:`ROOTFS_POSTINSTALL_COMMAND` + Specifies a list of functions to call after the OpenEmbedded build + system has installed packages. You can specify functions separated by + semicolons: + :: + + ROOTFS_POSTINSTALL_COMMAND += "function; ... " + + If you need to pass the root filesystem path to a command within a + function, you can use ``${IMAGE_ROOTFS}``, which points to the + directory that becomes the root filesystem image. See the + :term:`IMAGE_ROOTFS` variable for more + information. + + :term:`ROOTFS_POSTPROCESS_COMMAND` + Specifies a list of functions to call once the OpenEmbedded build + system has created the root filesystem. You can specify functions + separated by semicolons: + :: + + ROOTFS_POSTPROCESS_COMMAND += "function; ... " + + If you need to pass the root filesystem path to a command within a + function, you can use ``${IMAGE_ROOTFS}``, which points to the + directory that becomes the root filesystem image. See the + :term:`IMAGE_ROOTFS` variable for more + information. + + :term:`ROOTFS_POSTUNINSTALL_COMMAND` + 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 ``base-passwd``, ``shadow``, and ``update-alternatives``. + You can specify functions separated by semicolons: + :: + + ROOTFS_POSTUNINSTALL_COMMAND += "function; ... " + + If you need to pass the root filesystem path to a command within a + function, you can use ``${IMAGE_ROOTFS}``, which points to the + directory that becomes the root filesystem image. See the + :term:`IMAGE_ROOTFS` variable for more + information. + + :term:`ROOTFS_PREPROCESS_COMMAND` + Specifies a list of functions to call before the OpenEmbedded build + system has created the root filesystem. You can specify functions + separated by semicolons: + :: + + ROOTFS_PREPROCESS_COMMAND += "function; ... " + + If you need to pass the root filesystem path to a command within a + function, you can use ``${IMAGE_ROOTFS}``, which points to the + directory that becomes the root filesystem image. See the + :term:`IMAGE_ROOTFS` variable for more + information. + + :term:`RPROVIDES` + 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 + ``RDEPENDS``). + + .. note:: + + A package's own name is implicitly already in its ``RPROVIDES`` list. + + As with all package-controlling variables, you must always use the + variable in conjunction with a package name override. Here is an + example: + :: + + RPROVIDES_${PN} = "widget-abi-2" + + :term:`RRECOMMENDS` + 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 ``RDEPENDS`` variable. + + The package manager will automatically install the ``RRECOMMENDS`` + list of packages when installing the built package. However, you can + prevent listed packages from being installed by using the + :term:`BAD_RECOMMENDATIONS`, + :term:`NO_RECOMMENDATIONS`, and + :term:`PACKAGE_EXCLUDE` variables. + + Packages specified in ``RRECOMMENDS`` need not actually be produced. + However, a recipe must exist that provides each package, either + through the :term:`PACKAGES` or + :term:`PACKAGES_DYNAMIC` variables or the + :term:`RPROVIDES` 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. + + Because the ``RRECOMMENDS`` 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: + :: + + RRECOMMENDS_${PN}-dev += "wireless_package_name" + + In the + example, the package name (``${PN}-dev``) must appear as it would in + the ``PACKAGES`` namespace before any renaming of the output package + by classes such as ``debian.bbclass``. + + 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 + ``RRECOMMENDS`` variable: + :: + + RRECOMMENDS_${PN} = "package (operator version)" + + For ``operator``, you can specify the following: + + - = + - < + - > + - <= + - >= + + For example, the following sets up a recommend on version 1.2 or + greater of the package ``foo``: + :: + + RRECOMMENDS_${PN} = "foo (>= 1.2)" + + :term:`RREPLACES` + 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 ``RCONFLICTS`` variable. + + As with all package-controlling variables, you must use this variable + in conjunction with a package name override. Here is an example: + :: + + RREPLACES_${PN} = "other_package_being_replaced" + + 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 + ``RREPLACES`` variable: + :: + + RREPLACES_${PN} = "package (operator version)" + + For ``operator``, you can specify the following: + + - = + - < + - > + - <= + - >= + + For example, the following sets up a replacement using version 1.2 + or greater of the package ``foo``: + :: + + RREPLACES_${PN} = "foo (>= 1.2)" + + :term:`RSUGGESTS` + 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. + + As with all package-controlling variables, you must always use this + variable in conjunction with a package name override. Here is an + example: + :: + + RSUGGESTS_${PN} = "useful_package another_package" + + :term:`S` + The location in the :term:`Build Directory` where + unpacked recipe source code resides. By default, this directory is + ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, + where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe + version. If the source tarball extracts the code to a directory named + anything other than ``${BPN}-${PV}``, or if the source code is + fetched from an SCM such as Git or Subversion, then you must set + ``S`` in the recipe so that the OpenEmbedded build system knows where + to find the unpacked source. + + As an example, assume a :term:`Source Directory` + top-level folder named ``poky`` and a default Build Directory at + ``poky/build``. In this case, the work directory the build system + uses to keep the unpacked recipe for ``db`` is the following: + :: + + poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19 + + The unpacked source code resides in the ``db-5.1.19`` folder. + + This next example assumes a Git repository. By default, Git + repositories are cloned to ``${WORKDIR}/git`` during + :ref:`ref-tasks-fetch`. Since this path is different + from the default value of ``S``, you must set it specifically so the + source can be located: + :: + + SRC_URI = "git://path/to/repo.git" + S = "${WORKDIR}/git" + + :term:`SANITY_REQUIRED_UTILITIES` + 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. + + :term:`SANITY_TESTED_DISTROS` + 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 ``lsb_release`` tool or + as read from ``/etc/lsb-release``. Separate the list items with + explicit newline characters (``\n``). If ``SANITY_TESTED_DISTROS`` is + not empty and the current value of + :term:`NATIVELSBSTRING` 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. + + :term:`SDK_ARCH` + The target architecture for the SDK. Typically, you do not directly + set this variable. Instead, use :term:`SDKMACHINE`. + + :term:`SDK_DEPLOY` + The directory set up and used by the + :ref:`populate_sdk_base ` class to which + the SDK is deployed. The ``populate_sdk_base`` class defines + ``SDK_DEPLOY`` as follows: + :: + + SDK_DEPLOY = "${TMPDIR}/deploy/sdk" + + :term:`SDK_DIR` + The parent directory used by the OpenEmbedded build system when + creating SDK output. The + :ref:`populate_sdk_base ` class defines + the variable as follows: + :: + + SDK_DIR = "${WORKDIR}/sdk" + + .. note:: + + The ``SDK_DIR`` directory is a temporary directory as it is part of + ``WORKDIR``. The final output directory is :term:`SDK_DEPLOY`. + + :term:`SDK_EXT_TYPE` + 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 + :term:`SSTATE_MIRRORS` is set in the SDK's configuration to enable the + artifacts to be fetched as needed. + + :term:`SDK_HOST_MANIFEST` + 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. The + file contains package information on a line-per-package basis as + follows: + :: + + packagename packagearch version + + The :ref:`populate_sdk_base ` class + defines the manifest file as follows: + :: + + SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" + + The location is derived using the :term:`SDK_DEPLOY` and + :term:`TOOLCHAIN_OUTPUTNAME` variables. + + :term:`SDK_INCLUDE_PKGDATA` + 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 ``devtool search`` command to find these recipes in search + results, as well as allows the ``devtool add`` command to map + dependencies more effectively. + + .. note:: + + Enabling the ``SDK_INCLUDE_PKGDATA`` + 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. + + :term:`SDK_INCLUDE_TOOLCHAIN` + When set to "1", specifies to include the toolchain in the extensible + SDK. Including the toolchain is useful particularly when + :term:`SDK_EXT_TYPE` is set to "minimal" to keep + the SDK reasonably small but you still want to provide a usable + toolchain. For example, suppose you want to use the toolchain from an + IDE or from other tools and you do not want to perform additional + steps to install the toolchain. + + The ``SDK_INCLUDE_TOOLCHAIN`` variable defaults to "0" if + ``SDK_EXT_TYPE`` is set to "minimal", and defaults to "1" if + ``SDK_EXT_TYPE`` is set to "full". + + :term:`SDK_INHERIT_BLACKLIST` + A list of classes to remove from the :term:`INHERIT` + value globally within the extensible SDK configuration. The + :ref:`populate-sdk-ext ` class sets the + default value: + :: + + SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" + + Some classes are not generally applicable within the extensible SDK + context. You can use this variable to disable those classes. + + For additional information on how to customize the extensible SDK's + configuration, see the + ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + :term:`SDK_LOCAL_CONF_BLACKLIST` + A list of variables not allowed through from the OpenEmbedded 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. + + By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the + :ref:`populate-sdk-ext ` class and + excludes the following variables: + + - :term:`CONF_VERSION` + - :term:`BB_NUMBER_THREADS` + - :term:`bitbake:BB_NUMBER_PARSE_THREADS` + - :term:`PARALLEL_MAKE` + - :term:`PRSERV_HOST` + - :term:`SSTATE_MIRRORS` :term:`DL_DIR` + - :term:`SSTATE_DIR` :term:`TMPDIR` + - :term:`BB_SERVER_TIMEOUT` + + For additional information on how to customize the extensible SDK's + configuration, see the + ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + :term:`SDK_LOCAL_CONF_WHITELIST` + A list of variables allowed through from the OpenEmbedded build + system configuration into the extensible SDK configuration. By + default, the list of variables is empty and is set in the + :ref:`populate-sdk-ext ` class. + + This list overrides the variables specified using the + :term:`SDK_LOCAL_CONF_BLACKLIST` + 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. + + For additional information on how to customize the extensible SDK's + configuration, see the + ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + :term:`SDK_NAME` + The base name for SDK output files. The name is derived from the + :term:`DISTRO`, :term:`TCLIBC`, + :term:`SDK_ARCH`, + :term:`IMAGE_BASENAME`, and + :term:`TUNE_PKGARCH` variables: + :: + + SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" + + :term:`SDK_OS` + Specifies the operating system for which the SDK will be built. The + default value is the value of :term:`BUILD_OS`. + + :term:`SDK_OUTPUT` + The location used by the OpenEmbedded build system when creating SDK + output. The :ref:`populate_sdk_base ` + class defines the variable as follows: + :: + + SDK_DIR = "${WORKDIR}/sdk" + SDK_OUTPUT = "${SDK_DIR}/image" + SDK_DEPLOY = "${DEPLOY_DIR}/sdk" + + .. note:: + + The ``SDK_OUTPUT`` directory is a temporary directory as it is part of + :term:`WORKDIR` by way of :term:`SDK_DIR`. The final output directory is + :term:`SDK_DEPLOY`. + + :term:`SDK_PACKAGE_ARCHS` + 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 ``SDK_PACKAGE_ARCHS`` is "all any + noarch ${SDK_ARCH}-${SDKPKGSUFFIX}". + + :term:`SDK_POSTPROCESS_COMMAND` + Specifies a list of functions to call once the OpenEmbedded build + system creates the SDK. You can specify functions separated by + semicolons: SDK_POSTPROCESS_COMMAND += "function; ... " + + If you need to pass an SDK path to a command within a function, you + can use ``${SDK_DIR}``, which points to the parent directory used by + the OpenEmbedded build system when creating SDK output. See the + :term:`SDK_DIR` variable for more information. + + :term:`SDK_PREFIX` + The toolchain binary prefix used for ``nativesdk`` recipes. The + OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the + :term:`TARGET_PREFIX` when building + ``nativesdk`` recipes. The default value is "${SDK_SYS}-". + + :term:`SDK_RECRDEP_TASKS` + A list of shared state tasks added to the extensible SDK. By default, + the following tasks are added: + + - do_populate_lic + - do_package_qa + - do_populate_sysroot + - do_deploy + + Despite the default value of "" for the + ``SDK_RECRDEP_TASKS`` variable, the above four tasks are always added + to the SDK. To specify tasks beyond these four, you need to use the + ``SDK_RECRDEP_TASKS`` variable (e.g. you are defining additional + tasks that are needed in order to build + :term:`SDK_TARGETS`). + + :term:`SDK_SYS` + Specifies the system, including the architecture and the operating + system, for which the SDK will be built. + + The OpenEmbedded build system automatically sets this variable based + on :term:`SDK_ARCH`, + :term:`SDK_VENDOR`, and + :term:`SDK_OS`. You do not need to set the ``SDK_SYS`` + variable yourself. + + :term:`SDK_TARGET_MANIFEST` + 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: + :: + + packagename packagearch version + + The :ref:`populate_sdk_base ` class + defines the manifest file as follows: + :: + + SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" + + The location is derived using the :term:`SDK_DEPLOY` and + :term:`TOOLCHAIN_OUTPUTNAME` variables. + + :term:`SDK_TARGETS` + 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). + + The ``SDK_TARGETS`` variable is an internal variable and typically + would not be changed. + + :term:`SDK_TITLE` + The title to be printed when running the SDK installer. By default, + this title is based on the :term:`DISTRO_NAME` or + :term:`DISTRO` variable and is set in the + :ref:`populate_sdk_base ` class as + follows: + :: + + SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" + + For the default distribution "poky", + ``SDK_TITLE`` is set to "Poky (Yocto Project Reference Distro)". + + For information on how to change this default title, see the + ":ref:`sdk-manual/appendix-customizing:changing the extensible sdk installer title`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + :term:`SDK_UPDATE_URL` + An optional URL for an update server for the extensible SDK. If set, + the value is used as the default update server when running + ``devtool sdk-update`` within the extensible SDK. + + :term:`SDK_VENDOR` + Specifies the name of the SDK vendor. + + :term:`SDK_VERSION` + Specifies the version of the SDK. The distribution configuration file + (e.g. ``/meta-poky/conf/distro/poky.conf``) defines the + ``SDK_VERSION`` as follows: + :: + + SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${DATE}','snapshot')}" + + For additional information, see the + :term:`DISTRO_VERSION` and + :term:`DATE` variables. + + :term:`SDKEXTPATH` + The default installation directory for the Extensible SDK. By + default, this directory is based on the :term:`DISTRO` + variable and is set in the + :ref:`populate_sdk_base ` class as + follows: + :: + + SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" + + For the + default distribution "poky", the ``SDKEXTPATH`` is set to "poky_sdk". + + For information on how to change this default directory, see the + ":ref:`sdk-manual/appendix-customizing:changing the default sdk installation directory`" + section in the Yocto Project Application Development and the + Extensible Software Development Kit (eSDK) manual. + + :term:`SDKIMAGE_FEATURES` + Equivalent to ``IMAGE_FEATURES``. However, this variable applies to + the SDK generated from an image using the following command: + :: + + $ bitbake -c populate_sdk imagename + + :term:`SDKMACHINE` + 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 + ``SDKMACHINE`` value. The value points to a corresponding ``.conf`` + file under ``conf/machine-sdk/``. + + 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. + :: + + SDKMACHINE ?= "i686" + + .. note:: + + You cannot set the ``SDKMACHINE`` + variable in your distribution configuration file. If you do, the + configuration will not take affect. + + :term:`SDKPATH` + 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. + + :term:`SDKTARGETSYSROOT` + The full path to the sysroot used for cross-compilation within an SDK + as it will be when installed into the default + :term:`SDKPATH`. + + :term:`SECTION` + The section in which packages should be categorized. Package + management utilities can make use of this variable. + + :term:`SELECTED_OPTIMIZATION` + Specifies the optimization flags passed to the C compiler when + building for the target. The flags are passed through the default + value of the :term:`TARGET_CFLAGS` variable. + + The ``SELECTED_OPTIMIZATION`` variable takes the value of + ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the + case, the value of ``DEBUG_OPTIMIZATION`` is used. + + :term:`SERIAL_CONSOLE` + 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: + :: + + SERIAL_CONSOLE = "115200 ttyS0" + + .. note:: + + The ``SERIAL_CONSOLE`` variable is deprecated. Please use the + :term:`SERIAL_CONSOLES` variable. + + :term:`SERIAL_CONSOLES` + 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 semicolon. Use spaces to separate multiple devices: + :: + + SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1" + + :term:`SERIAL_CONSOLES_CHECK` + Specifies serial consoles, which must be listed in + :term:`SERIAL_CONSOLES`, to check against + ``/proc/console`` before enabling them using getty. This variable + allows aliasing in the format: :. If a device was + listed as "sclp_line0" in ``/dev/`` and "ttyS0" was listed in + ``/proc/console``, you would do the following: :: + + SERIAL_CONSOLES_CHECK = "slcp_line0:ttyS0" + + This variable is currently only supported with SysVinit (i.e. not + with systemd). + + :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` + 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: :: + + SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2" + + In the previous example, ``intone`` depends on ``mplayer2``. + + You can use the special token ``"*"`` on the left-hand side of the + dependency to match all recipes except the one on the right-hand + side. Here is an example: :: + + SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "*->quilt-native" + + In the previous example, all recipes except ``quilt-native`` ignore + task signatures from the ``quilt-native`` recipe when determining + their task signatures. + + Use of this variable is one mechanism to remove dependencies that + affect task signatures and thus force rebuilds when a recipe changes. + + .. note:: + + 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. + + :term:`SIGGEN_EXCLUDERECIPES_ABISAFE` + 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:: + + 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. + + :term:`SITEINFO_BITS` + Specifies the number of bits for the target system CPU. The value + should be either "32" or "64". + + :term:`SITEINFO_ENDIANNESS` + Specifies the endian byte order of the target system. The value + should be either "le" for little-endian or "be" for big-endian. + + :term:`SKIP_FILEDEPS` + 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 ``libstdc++`` and ``glibc``. + + To enable file removal, set the variable to "1" in your + ``conf/local.conf`` configuration file in your: + :term:`Build Directory`. + :: + + SKIP_FILEDEPS = "1" + + :term:`SOC_FAMILY` + 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. + + .. note:: + + You must include ``conf/machine/include/soc-family.inc`` for this + variable to appear in :term:`MACHINEOVERRIDES`. + + :term:`SOLIBS` + 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 ``meta/conf/bitbake.conf`` configuration file. + + You will see this variable referenced in the default values of + ``FILES_${PN}``. + + :term:`SOLIBSDEV` + 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 + ``meta/conf/bitbake.conf`` configuration file. + + You will see this variable referenced in the default values of + ``FILES_${PN}-dev``. + + :term:`SOURCE_MIRROR_FETCH` + When you are fetching files to create a mirror of sources (i.e. + creating a source mirror), setting ``SOURCE_MIRROR_FETCH`` to "1" in + your ``local.conf`` 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 :term:`COMPATIBLE_MACHINE` + variable and :term:`COMPATIBLE_HOST` variables + specify compatibility with a machine other than that of the current + machine or host. + + .. note:: + + Do not set the ``SOURCE_MIRROR_FETCH`` + variable unless you are creating a source mirror. In other words, + do not set the variable during a normal build. + + :term:`SOURCE_MIRROR_URL` + Defines your own :term:`PREMIRRORS` from which to + first fetch source before attempting to fetch from the upstream + specified in :term:`SRC_URI`. + + To use this variable, you must globally inherit the + :ref:`own-mirrors ` class and then provide + the URL to your mirrors. Here is the general syntax: + :: + + INHERIT += "own-mirrors" + SOURCE_MIRROR_URL = "http://example.com/my_source_mirror" + + .. note:: + + You can specify only a single URL in ``SOURCE_MIRROR_URL``. + + :term:`SPDXLICENSEMAP` + Maps commonly used license names to their SPDX counterparts found in + ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP`` + mappings, see the ``meta/conf/licenses.conf`` file. + + For additional information, see the :term:`LICENSE` + variable. + + :term:`SPECIAL_PKGSUFFIX` + A list of prefixes for :term:`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 :term:`BPN` variable. + + :term:`SPL_BINARY` + The file type for the Secondary Program Loader (SPL). Some devices + use an SPL from which to boot (e.g. the BeagleBone development + board). For such cases, you can declare the file type of the SPL + binary in the ``u-boot.inc`` include file, which is used in the + U-Boot recipe. + + The SPL file type is set to "null" by default in the ``u-boot.inc`` + file as follows: + :: + + # Some versions of u-boot build an SPL (Second Program Loader) image that + # should be packaged along with the u-boot binary as well as placed in the + # deploy directory. For those versions they can set the following variables + # to allow packaging the SPL. + SPL_BINARY ?= "" + SPL_BINARYNAME ?= "${@os.path.basename(d.getVar("SPL_BINARY"))}" + SPL_IMAGE ?= "${SPL_BINARYNAME}-${MACHINE}-${PV}-${PR}" + SPL_SYMLINK ?= "${SPL_BINARYNAME}-${MACHINE}" + + The ``SPL_BINARY`` variable helps form + various ``SPL_*`` variables used by the OpenEmbedded build system. + + See the BeagleBone machine configuration example in the + ":ref:`dev-manual/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" + section in the Yocto Project Board Support Package Developer's Guide + for additional information. + + :term:`SRC_URI` + 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 ``SRC_URI`` 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. + + 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 ":ref:`Fetchers `" section in the + BitBake User Manual. + + - ``file://`` - Fetches files, which are usually files shipped + with the :term:`Metadata`, from the local machine (e.g. + :ref:`patch ` files). + The path is relative to the :term:`FILESPATH` + 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 (``.bb``) or append file + (``.bbappend``) resides: + + - ``${BPN}`` - The base recipe name without any special suffix + or version numbers. + + - ``${BP}`` - ``${BPN}-${PV}``. The base recipe name and + version but without any special package name suffix. + + - *files -* Files within a directory, which is named ``files`` + and is also alongside the recipe or append file. + + .. note:: + + If you want the build system to pick up files specified through + a + SRC_URI + statement from your append file, you need to be sure to extend + the + FILESPATH + variable by also using the + FILESEXTRAPATHS + variable from within your append file. + + - ``bzr://`` - Fetches files from a Bazaar revision control + repository. + + - ``git://`` - Fetches files from a Git revision control + repository. + + - ``osc://`` - Fetches files from an OSC (OpenSUSE Build service) + revision control repository. + + - ``repo://`` - Fetches files from a repo (Git) repository. + + - ``ccrc://`` - Fetches files from a ClearCase repository. + + - ``http://`` - Fetches files from the Internet using ``http``. + + - ``https://`` - Fetches files from the Internet using ``https``. + + - ``ftp://`` - Fetches files from the Internet using ``ftp``. + + - ``cvs://`` - Fetches files from a CVS revision control + repository. + + - ``hg://`` - Fetches files from a Mercurial (``hg``) revision + control repository. + + - ``p4://`` - Fetches files from a Perforce (``p4``) revision + control repository. + + - ``ssh://`` - Fetches files from a secure shell. + + - ``svn://`` - Fetches files from a Subversion (``svn``) revision + control repository. + + - ``npm://`` - Fetches JavaScript modules from a registry. + + Standard and recipe-specific options for ``SRC_URI`` exist. Here are + standard options: + + - ``apply`` - Whether to apply the patch or not. The default + action is to apply the patch. + + - ``striplevel`` - Which striplevel to use when applying the + patch. The default level is 1. + + - ``patchdir`` - Specifies the directory in which the patch should + be applied. The default is ``${``\ :term:`S`\ ``}``. + + Here are options specific to recipes building code from a revision + control system: + + - ``mindate`` - Apply the patch only if + :term:`SRCDATE` is equal to or greater than + ``mindate``. + + - ``maxdate`` - Apply the patch only if ``SRCDATE`` is not later + than ``maxdate``. + + - ``minrev`` - Apply the patch only if ``SRCREV`` is equal to or + greater than ``minrev``. + + - ``maxrev`` - Apply the patch only if ``SRCREV`` is not later + than ``maxrev``. + + - ``rev`` - Apply the patch only if ``SRCREV`` is equal to + ``rev``. + + - ``notrev`` - Apply the patch only if ``SRCREV`` is not equal to + ``rev``. + + Here are some additional options worth mentioning: + + - ``unpack`` - Controls whether or not to unpack the file if it is + an archive. The default action is to unpack the file. + + - ``destsuffix`` - Places the file (or extracts its contents) into + the specified subdirectory of :term:`WORKDIR` when + the Git fetcher is used. + + - ``subdir`` - Places the file (or extracts its contents) into the + specified subdirectory of ``WORKDIR`` when the local (``file://``) + fetcher is used. + + - ``localdir`` - Places the file (or extracts its contents) into + the specified subdirectory of ``WORKDIR`` when the CVS fetcher is + used. + + - ``subpath`` - Limits the checkout to a specific subpath of the + tree when using the Git fetcher is used. + + - ``name`` - Specifies a name to be used for association with + ``SRC_URI`` checksums or :term:`SRCREV` when you have more than one + file or git repository specified in ``SRC_URI``. For example: + :: + + SRC_URI = "git://example.com/foo.git;name=first \ + git://example.com/bar.git;name=second \ + http://example.com/file.tar.gz;name=third" + + SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15" + SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f" + SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de" + + + - ``downloadfilename`` - Specifies the filename used when storing + the downloaded file. + + :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` + 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. + + :term:`SRCDATE` + 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). + + :term:`SRCPV` + Returns the version string of the current package. This string is + used to help define the value of :term:`PV`. + + The ``SRCPV`` variable is defined in the ``meta/conf/bitbake.conf`` + configuration file in the :term:`Source Directory` as + follows: + :: + + SRCPV = "${@bb.fetch2.get_srcrev(d)}" + + Recipes that need to define ``PV`` do so with the help of the + ``SRCPV``. For example, the ``ofono`` recipe (``ofono_git.bb``) + located in ``meta/recipes-connectivity`` in the Source Directory + defines ``PV`` as follows: + :: + + PV = "0.12-git${SRCPV}" + + :term:`SRCREV` + 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 ``SRCREV`` that is a full revision + identifier and not just a tag. + + .. note:: + + For information on limitations when inheriting the latest revision + of software using ``SRCREV``, see the :term:`AUTOREV` variable + description and the + ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" + section, which is in the Yocto Project Development Tasks Manual. + + :term:`SSTATE_DIR` + The directory for the shared state cache. + + :term:`SSTATE_MIRROR_ALLOW_NETWORK` + If set to "1", allows fetches from mirrors that are specified in + :term:`SSTATE_MIRRORS` to work even when + fetching from the network is disabled by setting ``BB_NO_NETWORK`` to + "1". Using the ``SSTATE_MIRROR_ALLOW_NETWORK`` variable is useful if + you have set ``SSTATE_MIRRORS`` to point to an internal server for + your shared state cache, but you want to disable any other fetching + from the network. + + :term:`SSTATE_MIRRORS` + 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 :term:`MIRRORS` + and :term:`PREMIRRORS` and points to the cache + locations to check for the shared state (sstate) objects. + + 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. + + When pointing to sstate build artifacts on another machine that uses + a different GCC version for native builds, you must configure + ``SSTATE_MIRRORS`` with a regular expression that maps local search + paths to server paths. The paths need to take into account + :term:`NATIVELSBSTRING` set by the + :ref:`uninative ` class. For example, the + following maps the local search path ``universal-4.9`` to the + server-provided path server_url_sstate_path: + :: + + SSTATE_MIRRORS ?= "file://universal-4.9/(.*) http://server_url_sstate_path/universal-4.8/\1 \n" + + If a mirror uses the same structure as + :term:`SSTATE_DIR`, 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. + :: + + SSTATE_MIRRORS ?= "\ + file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \ + file://.* file:///some-local-dir/sstate/PATH" + + :term:`SSTATE_SCAN_FILES` + Controls the list of files the OpenEmbedded build system scans for + hardcoded installation paths. The variable uses a space-separated + list of filenames (not paths) with standard wildcard characters + allowed. + + During a build, the OpenEmbedded build system creates a shared state + (sstate) object during the first stage of preparing the sysroots. + That object is scanned for hardcoded paths for original installation + locations. The list of files that are scanned for paths is controlled + by the ``SSTATE_SCAN_FILES`` variable. Typically, recipes add files + they want to be scanned to the value of ``SSTATE_SCAN_FILES`` rather + than the variable being comprehensively set. The + :ref:`sstate ` class specifies the default list + of files. + + For details on the process, see the + :ref:`staging ` class. + + :term:`STAGING_BASE_LIBDIR_NATIVE` + Specifies the path to the ``/lib`` subdirectory of the sysroot + directory for the build host. + + :term:`STAGING_BASELIBDIR` + Specifies the path to the ``/lib`` subdirectory of the sysroot + directory for the target for which the current recipe is being built + (:term:`STAGING_DIR_HOST`). + + :term:`STAGING_BINDIR` + Specifies the path to the ``/usr/bin`` subdirectory of the sysroot + directory for the target for which the current recipe is being built + (:term:`STAGING_DIR_HOST`). + + :term:`STAGING_BINDIR_CROSS` + 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 + ``pkg-config``. Consequently, if ``pkg-config`` is supported by the + library to which you are linking, it is recommended you use + ``pkg-config`` instead of a provided configuration script. + + :term:`STAGING_BINDIR_NATIVE` + Specifies the path to the ``/usr/bin`` subdirectory of the sysroot + directory for the build host. + + :term:`STAGING_DATADIR` + Specifies the path to the ``/usr/share`` subdirectory of the sysroot + directory for the target for which the current recipe is being built + (:term:`STAGING_DIR_HOST`). + + :term:`STAGING_DATADIR_NATIVE` + Specifies the path to the ``/usr/share`` subdirectory of the sysroot + directory for the build host. + + :term:`STAGING_DIR` + Helps construct the ``recipe-sysroots`` directory, which is used + during packaging. + + For information on how staging for recipe-specific sysroots occurs, + see the :ref:`ref-tasks-populate_sysroot` + task, the ":ref:`sdk-manual/extensible:sharing files between recipes`" + section in the Yocto Project Development Tasks Manual, the + ":ref:`overview-manual/concepts:configuration, compilation, and staging`" + section in the Yocto Project Overview and Concepts Manual, and the + :term:`SYSROOT_DIRS` variable. + + .. note:: + + Recipes should never write files directly under the ``STAGING_DIR`` + directory because the OpenEmbedded build system manages the + directory automatically. Instead, files should be installed to + ``${``\ :term:`D`\ ``}`` within your recipe's :ref:`ref-tasks-install` + task and then the OpenEmbedded build system will stage a subset of + those files into the sysroot. + + :term:`STAGING_DIR_HOST` + Specifies the path to the sysroot directory for the system on which + the component is built to run (the system that hosts the component). + For most recipes, this sysroot is the one in which that recipe's + :ref:`ref-tasks-populate_sysroot` task copies + files. Exceptions include ``-native`` recipes, where the + ``do_populate_sysroot`` task instead uses + :term:`STAGING_DIR_NATIVE`. Depending on + the type of recipe and the build target, ``STAGING_DIR_HOST`` can + have the following values: + + - For recipes building for the target machine, the value is + "${:term:`STAGING_DIR`}/${:term:`MACHINE`}". + + - 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. + + .. note:: + + ``-native`` recipes are not installed into host paths like such + as ``/usr``. Rather, these recipes are installed into + ``STAGING_DIR_NATIVE``. When compiling ``-native`` recipes, + standard build environment variables such as + :term:`CPPFLAGS` and + :term:`CFLAGS` are set up so that both host paths + and ``STAGING_DIR_NATIVE`` are searched for libraries and + headers using, for example, GCC's ``-isystem`` option. + + Thus, the emphasis is that the ``STAGING_DIR*`` variables + should be viewed as input variables by tasks such as + :ref:`ref-tasks-configure`, + :ref:`ref-tasks-compile`, and + :ref:`ref-tasks-install`. Having the real system + root correspond to ``STAGING_DIR_HOST`` makes conceptual sense + for ``-native`` recipes, as they make use of host headers and + libraries. + + :term:`STAGING_DIR_NATIVE` + Specifies the path to the sysroot directory used when building + components that run on the build host itself. + + :term:`STAGING_DIR_TARGET` + Specifies the path to the sysroot used for the system for which the + component generates code. For components that do not generate code, + which is the majority, ``STAGING_DIR_TARGET`` is set to match + :term:`STAGING_DIR_HOST`. + + 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 generate binaries for the "TARGET" + system. The ``STAGING_DIR_HOST`` variable points to the sysroot used + for the "HOST" system, while ``STAGING_DIR_TARGET`` points to the + sysroot used for the "TARGET" system. + + :term:`STAGING_ETCDIR_NATIVE` + Specifies the path to the ``/etc`` subdirectory of the sysroot + directory for the build host. + + :term:`STAGING_EXECPREFIXDIR` + Specifies the path to the ``/usr`` subdirectory of the sysroot + directory for the target for which the current recipe is being built + (:term:`STAGING_DIR_HOST`). + + :term:`STAGING_INCDIR` + Specifies the path to the ``/usr/include`` subdirectory of the + sysroot directory for the target for which the current recipe being + built (:term:`STAGING_DIR_HOST`). + + :term:`STAGING_INCDIR_NATIVE` + Specifies the path to the ``/usr/include`` subdirectory of the + sysroot directory for the build host. + + :term:`STAGING_KERNEL_BUILDDIR` + Points to the directory containing the kernel build artifacts. + Recipes building software that needs to access kernel build artifacts + (e.g. ``systemtap-uprobes``) can look in the directory specified with + the ``STAGING_KERNEL_BUILDDIR`` variable to find these artifacts + after the kernel has been built. + + :term:`STAGING_KERNEL_DIR` + The directory with kernel headers that are required to build + out-of-tree modules. + + :term:`STAGING_LIBDIR` + Specifies the path to the ``/usr/lib`` subdirectory of the sysroot + directory for the target for which the current recipe is being built + (:term:`STAGING_DIR_HOST`). + + :term:`STAGING_LIBDIR_NATIVE` + Specifies the path to the ``/usr/lib`` subdirectory of the sysroot + directory for the build host. + + :term:`STAMP` + 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 ``STAMP`` as set in the ``meta/conf/bitbake.conf`` + file is: + :: + + STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}" + + For information on how BitBake uses stamp files to determine if a + task should be rerun, see the + ":ref:`overview-manual/concepts:stamp files and the rerunning of tasks`" + section in the Yocto Project Overview and Concepts Manual. + + See :term:`STAMPS_DIR`, + :term:`MULTIMACH_TARGET_SYS`, + :term:`PN`, :term:`EXTENDPE`, + :term:`PV`, and :term:`PR` for related variable + information. + + :term:`STAMPS_DIR` + Specifies the base directory in which the OpenEmbedded build system + places stamps. The default directory is ``${TMPDIR}/stamps``. + + :term:`STRIP` + The minimal command and arguments to run ``strip``, which is used to + strip symbols. + + :term:`SUMMARY` + The short (72 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 + :term:`DESCRIPTION` variable if ``DESCRIPTION`` is + not set in the recipe. + + :term:`SVNDIR` + The directory in which files checked out of a Subversion system are + stored. + + :term:`SYSLINUX_DEFAULT_CONSOLE` + 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: + :: + + SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" + + The :ref:`syslinux ` class initially sets + this variable to null but then checks for a value later. + + :term:`SYSLINUX_OPTS` + 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 (``;``). + + The :ref:`syslinux ` class uses this variable + to create a set of options. + + :term:`SYSLINUX_SERIAL` + 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 + :ref:`syslinux ` class as follows: + :: + + SYSLINUX_SERIAL ?= "0 115200" + + The class checks for and uses the variable as needed. + + :term:`SYSLINUX_SERIAL_TTY` + Specifies the alternate console=tty... kernel boot argument. The + variable's default value is set in the + :ref:`syslinux ` class as follows: + :: + + SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" + + The class checks for and uses the variable as needed. + + :term:`SYSLINUX_SPLASH` + An ``.LSS`` file used as the background for the VGA boot menu when + you use the boot menu. You need to set this variable in your recipe. + + The :ref:`syslinux ` class checks for this + variable and if found, the OpenEmbedded build system installs the + splash screen. + + :term:`SYSROOT_DESTDIR` + Points to the temporary directory under the work directory (default + "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") + where the files populated into the sysroot are assembled during the + :ref:`ref-tasks-populate_sysroot` task. + + :term:`SYSROOT_DIRS` + Directories that are staged into the sysroot by the + :ref:`ref-tasks-populate_sysroot` task. By + default, the following directories are staged: + :: + + SYSROOT_DIRS = " \ + ${includedir} \ + ${libdir} \ + ${base_libdir} \ + ${nonarch_base_libdir} \ + ${datadir} \ + " + + :term:`SYSROOT_DIRS_BLACKLIST` + Directories that are not staged into the sysroot by the + :ref:`ref-tasks-populate_sysroot` task. You + can use this variable to exclude certain subdirectories of + directories listed in :term:`SYSROOT_DIRS` from + staging. By default, the following directories are not staged: + :: + + SYSROOT_DIRS_BLACKLIST = " \ + ${mandir} \ + ${docdir} \ + ${infodir} \ + ${datadir}/locale \ + ${datadir}/applications \ + ${datadir}/fonts \ + ${datadir}/pixmaps \ + " + + :term:`SYSROOT_DIRS_NATIVE` + Extra directories staged into the sysroot by the + :ref:`ref-tasks-populate_sysroot` task for + ``-native`` recipes, in addition to those specified in + :term:`SYSROOT_DIRS`. By default, the following + extra directories are staged: + :: + + SYSROOT_DIRS_NATIVE = " \ + ${bindir} \ + ${sbindir} \ + ${base_bindir} \ + ${base_sbindir} \ + ${libexecdir} \ + ${sysconfdir} \ + ${localstatedir} \ + " + + .. note:: + + Programs built by ``-native`` recipes run directly from the sysroot + (:term:`STAGING_DIR_NATIVE`), which is why additional directories + containing program executables and supporting files need to be staged. + + :term:`SYSROOT_PREPROCESS_FUNCS` + 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. + + :term:`SYSTEMD_AUTO_ENABLE` + When inheriting the :ref:`systemd ` class, + this variable specifies whether the specified service in + :term:`SYSTEMD_SERVICE` should start + automatically or not. By default, the service is enabled to + automatically start at boot time. The default setting is in the + :ref:`systemd ` class as follows: + :: + + SYSTEMD_AUTO_ENABLE ??= "enable" + + You can disable the service by setting the variable to "disable". + + :term:`SYSTEMD_BOOT_CFG` + When :term:`EFI_PROVIDER` is set to + "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the + configuration file that should be used. By default, the + :ref:`systemd-boot ` class sets the + ``SYSTEMD_BOOT_CFG`` as follows: + :: + + SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf" + + For information on Systemd-boot, see the `Systemd-boot + documentation `__. + + :term:`SYSTEMD_BOOT_ENTRIES` + When :term:`EFI_PROVIDER` is set to + "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a + list of entry files (``*.conf``) to install that contain one boot + entry per file. By default, the + :ref:`systemd-boot ` class sets the + ``SYSTEMD_BOOT_ENTRIES`` as follows: + :: + + SYSTEMD_BOOT_ENTRIES ?= "" + + For information on Systemd-boot, see the `Systemd-boot + documentation `__. + + :term:`SYSTEMD_BOOT_TIMEOUT` + When :term:`EFI_PROVIDER` is set to + "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the + boot menu timeout in seconds. By default, the + :ref:`systemd-boot ` class sets the + ``SYSTEMD_BOOT_TIMEOUT`` as follows: + :: + + SYSTEMD_BOOT_TIMEOUT ?= "10" + + For information on Systemd-boot, see the `Systemd-boot + documentation `__. + + :term:`SYSTEMD_PACKAGES` + When inheriting the :ref:`systemd ` class, + this variable locates the systemd unit files when they are not found + in the main recipe's package. By default, the ``SYSTEMD_PACKAGES`` + variable is set such that the systemd unit files are assumed to + reside in the recipes main package: + :: + + SYSTEMD_PACKAGES ?= "${PN}" + + If these unit files are not in this recipe's main package, you need + to use ``SYSTEMD_PACKAGES`` to list the package or packages in which + the build system can find the systemd unit files. + + :term:`SYSTEMD_SERVICE` + When inheriting the :ref:`systemd ` class, + this variable specifies the systemd service name for a package. + + 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: + :: + + SYSTEMD_SERVICE_${PN} = "connman.service" + + :term:`SYSVINIT_ENABLED_GETTYS` + When using + :ref:`SysVinit `, + specifies a space-separated list of the virtual terminals that should + run a `getty `__ + (allowing login), assuming :term:`USE_VT` is not set to + "0". + + The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only + run a getty on the first virtual terminal). + + :term:`T` + 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: + :: + + T = "${WORKDIR}/temp" + + The :term:`WORKDIR` is the directory into which + BitBake unpacks and builds the recipe. The default ``bitbake.conf`` + file sets this variable. + + The ``T`` variable is not to be confused with the + :term:`TMPDIR` variable, which points to the root of + the directory tree where BitBake places the output of an entire + build. + + :term:`TARGET_ARCH` + 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: + + - arm + - i586 + - x86_64 + - powerpc + - powerpc64 + - mips + - mipsel + + For additional information on machine architectures, see the + :term:`TUNE_ARCH` variable. + + :term:`TARGET_AS_ARCH` + Specifies architecture-specific assembler flags for the target + system. ``TARGET_AS_ARCH`` is initialized from + :term:`TUNE_ASARGS` by default in the BitBake + configuration file (``meta/conf/bitbake.conf``): + :: + + TARGET_AS_ARCH = "${TUNE_ASARGS}" + + :term:`TARGET_CC_ARCH` + Specifies architecture-specific C compiler flags for the target + system. ``TARGET_CC_ARCH`` is initialized from + :term:`TUNE_CCARGS` by default. + + .. note:: + + It is a common workaround to append :term:`LDFLAGS` to + ``TARGET_CC_ARCH`` in recipes that build software for the target that + would not otherwise respect the exported ``LDFLAGS`` variable. + + :term:`TARGET_CC_KERNEL_ARCH` + 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 :term:`TUNE_CCARGS` is not + compatible with the kernel compilation. The ``TARGET_CC_KERNEL_ARCH`` + variable allows the kernel (and associated modules) to use a + different configuration. See the + ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the + :term:`Source Directory` for an example. + + :term:`TARGET_CFLAGS` + Specifies the flags to pass to the C compiler when building for the + target. When building in the target context, + :term:`CFLAGS` is set to the value of this variable by + default. + + Additionally, the SDK's environment setup script sets the ``CFLAGS`` + variable in the environment to the ``TARGET_CFLAGS`` value so that + executables built using the SDK also have the flags applied. + + :term:`TARGET_CPPFLAGS` + 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, :term:`CPPFLAGS` is set to the + value of this variable by default. + + Additionally, the SDK's environment setup script sets the + ``CPPFLAGS`` variable in the environment to the ``TARGET_CPPFLAGS`` + value so that executables built using the SDK also have the flags + applied. + + :term:`TARGET_CXXFLAGS` + Specifies the flags to pass to the C++ compiler when building for the + target. When building in the target context, + :term:`CXXFLAGS` is set to the value of this variable + by default. + + Additionally, the SDK's environment setup script sets the + ``CXXFLAGS`` variable in the environment to the ``TARGET_CXXFLAGS`` + value so that executables built using the SDK also have the flags + applied. + + :term:`TARGET_FPU` + 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. + + :term:`TARGET_LD_ARCH` + Specifies architecture-specific linker flags for the target system. + ``TARGET_LD_ARCH`` is initialized from + :term:`TUNE_LDARGS` by default in the BitBake + configuration file (``meta/conf/bitbake.conf``): + :: + + TARGET_LD_ARCH = "${TUNE_LDARGS}" + + :term:`TARGET_LDFLAGS` + Specifies the flags to pass to the linker when building for the + target. When building in the target context, + :term:`LDFLAGS` is set to the value of this variable + by default. + + Additionally, the SDK's environment setup script sets the + :term:`LDFLAGS` variable in the environment to the + ``TARGET_LDFLAGS`` value so that executables built using the SDK also + have the flags applied. + + :term:`TARGET_OS` + Specifies the target's operating system. The variable can be set to + "linux" for glibc-based systems (GNU C Library) and to "linux-musl" + for musl libc. For ARM/EABI targets, "linux-gnueabi" and + "linux-musleabi" possible values exist. + + :term:`TARGET_PREFIX` + Specifies the prefix used for the toolchain binary target tools. + + Depending on the type of recipe and the build target, + ``TARGET_PREFIX`` is set as follows: + + - For recipes building for the target machine, the value is + "${:term:`TARGET_SYS`}-". + + - For native recipes, the build system sets the variable to the + value of ``BUILD_PREFIX``. + + - For native SDK recipes (``nativesdk``), the build system sets the + variable to the value of ``SDK_PREFIX``. + + :term:`TARGET_SYS` + Specifies the system, including the architecture and the operating + system, for which the build is occurring in the context of the + current recipe. + + The OpenEmbedded build system automatically sets this variable based + on :term:`TARGET_ARCH`, + :term:`TARGET_VENDOR`, and + :term:`TARGET_OS` variables. + + .. note:: + + You do not need to set the ``TARGET_SYS`` variable yourself. + + Consider these two examples: + + - Given a native recipe on a 32-bit, x86 machine running Linux, the + value is "i686-linux". + + - Given a recipe being built for a little-endian, MIPS target + running Linux, the value might be "mipsel-linux". + + :term:`TARGET_VENDOR` + Specifies the name of the target vendor. + + :term:`TCLIBC` + Specifies the GNU standard C library (``libc``) variant to use during + the build process. This variable replaces ``POKYLIBC``, which is no + longer supported. + + You can select "glibc", "musl", "newlib", or "baremetal" + + :term:`TCLIBCAPPEND` + Specifies a suffix to be appended onto the + :term:`TMPDIR` value. The suffix identifies the + ``libc`` variant for building. When you are building for multiple + variants with the same :term:`Build Directory`, this + mechanism ensures that output for different ``libc`` variants is kept + separate to avoid potential conflicts. + + In the ``defaultsetup.conf`` file, the default value of + ``TCLIBCAPPEND`` is "-${TCLIBC}". However, distros such as poky, + which normally only support one ``libc`` variant, set + ``TCLIBCAPPEND`` to "" in their distro configuration file resulting + in no suffix being applied. + + :term:`TCMODE` + Specifies the toolchain selector. ``TCMODE`` 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 ``TCMODE`` 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 Release Notes for + the Yocto Project release for the specific components with which + the toolchain must be compatible. To access the Release Notes, go + to the :yocto_home:`Downloads ` + page on the Yocto Project website and click on the "RELEASE + INFORMATION" link for the appropriate release. + + The ``TCMODE`` variable is similar to :term:`TCLIBC`, + which controls the variant of the GNU standard C library (``libc``) + used during the build process: ``glibc`` or ``musl``. + + 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 Mentor Graphics + ``meta-sourcery`` layer at + http://github.com/MentorEmbedded/meta-sourcery/. + + The layer's ``README`` 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 ``bblayers.conf`` file in front of + the ``meta`` layer and then set the ``EXTERNAL_TOOLCHAIN`` variable + in your ``local.conf`` file to the location in which you installed + the toolchain. + + The fundamentals used for this example apply to any external + toolchain. You can use ``meta-sourcery`` as a template for adding + support for other external toolchains. + + :term:`TEST_EXPORT_DIR` + The location the OpenEmbedded build system uses to export tests when + the :term:`TEST_EXPORT_ONLY` variable is set + to "1". + + The ``TEST_EXPORT_DIR`` variable defaults to + ``"${TMPDIR}/testimage/${PN}"``. + + :term:`TEST_EXPORT_ONLY` + 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. + + :term:`TEST_LOG_DIR` + Holds the SSH log and the boot log for QEMU machines. The + ``TEST_LOG_DIR`` variable defaults to ``"${WORKDIR}/testimage"``. + + .. note:: + + Actual test results reside in the task log (``log.do_testimage``), + which is in the ``${WORKDIR}/temp/`` directory. + + :term:`TEST_POWERCONTROL_CMD` + 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. + + :term:`TEST_POWERCONTROL_EXTRA_ARGS` + For automated hardware testing, specifies additional arguments to + pass through to the command specified in + :term:`TEST_POWERCONTROL_CMD`. Setting + ``TEST_POWERCONTROL_EXTRA_ARGS`` is optional. You can use it if you + wish, for example, to separate the machine-specific and + non-machine-specific parts of the arguments. + + :term:`TEST_QEMUBOOT_TIMEOUT` + 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 ``local.conf`` + file. + + For more information on testing images, see the + ":ref:`dev-manual/common-tasks:performing automated runtime testing`" + section in the Yocto Project Development Tasks Manual. + + :term:`TEST_SERIALCONTROL_CMD` + 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. + + For example, to use the Picocom terminal program on serial device + ``/dev/ttyUSB0`` at 115200bps, you would set the variable as follows: + :: + + TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" + + :term:`TEST_SERIALCONTROL_EXTRA_ARGS` + For automated hardware testing, specifies additional arguments to + pass through to the command specified in + :term:`TEST_SERIALCONTROL_CMD`. Setting + ``TEST_SERIALCONTROL_EXTRA_ARGS`` is optional. You can use it if you + wish, for example, to separate the machine-specific and + non-machine-specific parts of the command. + + :term:`TEST_SERVER_IP` + 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 ``TEST_SERVER_IP`` variable is only used for a small number of + tests such as the "dnf" test suite, which needs to download packages + from ``WORKDIR/oe-rootfs-repo``. + + :term:`TEST_SUITES` + An ordered list of tests (modules) to run against an image when + performing automated runtime testing. + + 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. + + Tests include ``ping``, ``ssh``, ``df`` among others. You can add + your own tests to the list of tests by appending ``TEST_SUITES`` as + follows: + :: + + TEST_SUITES_append = " mytest" + + Alternatively, you can + provide the "auto" option to have all applicable tests run against + the image. + :: + + TEST_SUITES_append = " auto" + + Using this option causes the + build system to automatically run tests that are applicable to the + image. Tests that are not applicable are skipped. + + 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 (``test_A`` and ``test_B``) where ``test_B`` is dependent on + ``test_A``, then you must order the tests as follows: + :: + + TEST_SUITES = "test_A test_B" + + For more information on testing images, see the + ":ref:`dev-manual/common-tasks:performing automated runtime testing`" + section in the Yocto Project Development Tasks Manual. + + :term:`TEST_TARGET` + Specifies the target controller to use when running tests against a + test image. The default controller to use is "qemu": + :: + + TEST_TARGET = "qemu" + + 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 + ``/lib/oeqa/controllers`` directory and by inheriting the + ``BaseTarget`` class, which is an abstract class that cannot be used + as a value of ``TEST_TARGET``. + + You can provide the following arguments with ``TEST_TARGET``: + + - *"qemu":* Boots a QEMU image and runs the tests. See the + ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section + in the Yocto Project Development Tasks Manual for more + information. + + - *"simpleremote":* 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 + :term:`TEST_TARGET_IP` when you use + "simpleremote". + + .. note:: + + This argument is defined in + ``meta/lib/oeqa/controllers/simpleremote.py``. + + For information on running tests on hardware, see the + ":ref:`dev-manual/common-tasks:enabling runtime tests on hardware`" + section in the Yocto Project Development Tasks Manual. + + :term:`TEST_TARGET_IP` + The IP address of your hardware under test. The ``TEST_TARGET_IP`` + variable has no effect when :term:`TEST_TARGET` is + set to "qemu". + + When you specify the IP address, you can also include a port. Here is + an example: + :: + + TEST_TARGET_IP = "192.168.1.4:2201" + + 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. + + :term:`TESTIMAGE_AUTO` + Automatically runs the series of automated tests for images when an + image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes + any image that successfully builds to automatically boot under QEMU. + Using the variable also adds in dependencies so that any SDK for + which testing is requested is automatically built first. + + These tests are written in Python making use of the ``unittest`` + module, and the majority of them run commands on the target system + over ``ssh``. You can set this variable to "1" in your ``local.conf`` + file in the :term:`Build Directory` to have the + OpenEmbedded build system automatically run these tests after an + image successfully builds: + + TESTIMAGE_AUTO = "1" + + For more information + on enabling, running, and writing these tests, see the + ":ref:`dev-manual/common-tasks:performing automated runtime testing`" + section in the Yocto Project Development Tasks Manual and the + ":ref:`testimage*.bbclass `" section. + + :term:`THISDIR` + The directory in which the file BitBake is currently parsing is + located. Do not manually set this variable. + + :term:`TIME` + 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). + + :term:`TMPDIR` + 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 ``TMPDIR`` variable points to + ``tmp`` within the :term:`Build Directory`. + + If you want to establish this directory in a location other than the + default, you can uncomment and edit the following statement in the + ``conf/local.conf`` file in the :term:`Source Directory`: + :: + + #TMPDIR = "${TOPDIR}/tmp" + + An example use for this scenario is to set ``TMPDIR`` to a local disk, + which does not use NFS, while having the Build Directory use NFS. + + The filesystem used by ``TMPDIR`` 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, ``TMPDIR`` cannot be on NFS. + + :term:`TOOLCHAIN_HOST_TASK` + 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 :term:`SDKMACHINE`, and each + package should usually have the prefix ``nativesdk-``. For example, + consider the following command when building an SDK: + :: + + $ bitbake -c populate_sdk imagename + + In this case, a default list of packages is + set in this variable, but you can add additional packages to the + list. See the + ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section + in the Yocto Project Application Development and the Extensible + Software Development Kit (eSDK) manual for more information. + + For background information on cross-development toolchains in the + Yocto Project development environment, see the + ":ref:`sdk-manual/intro:the cross-development toolchain`" + section in the Yocto Project Overview and Concepts Manual. For + information on setting up a cross-development environment, see the + :doc:`/sdk-manual/index` manual. + + :term:`TOOLCHAIN_OUTPUTNAME` + This variable defines the name used for the toolchain output. The + :ref:`populate_sdk_base ` class sets + the ``TOOLCHAIN_OUTPUTNAME`` variable as follows: + :: + + TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" + + See + the :term:`SDK_NAME` and + :term:`SDK_VERSION` variables for additional + information. + + :term:`TOOLCHAIN_TARGET_TASK` + 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. Use this + variable to add individual packages to the part of the SDK that runs + on the target. See the + ":ref:`sdk-manual/appendix-customizing-standard:adding individual packages to the standard sdk`" section + in the Yocto Project Application Development and the Extensible + Software Development Kit (eSDK) manual for more information. + + For background information on cross-development toolchains in the + Yocto Project development environment, see the + ":ref:`sdk-manual/intro:the cross-development toolchain`" + section in the Yocto Project Overview and Concepts Manual. For + information on setting up a cross-development environment, see the + :doc:`/sdk-manual/index` manual. + + :term:`TOPDIR` + The top-level :term:`Build Directory`. BitBake + automatically sets this variable when you initialize your build + environment using :ref:`structure-core-script`. + + :term:`TRANSLATED_TARGET_ARCH` + A sanitized version of :term:`TARGET_ARCH`. 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``. + + Do not edit this variable. + + :term:`TUNE_ARCH` + The GNU canonical architecture for a specific architecture (i.e. + ``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses + this value to setup configuration. + + ``TUNE_ARCH`` 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 ``README`` file. For example, the + ``meta/conf/machine/include/mips/README`` file in the + :term:`Source Directory` provides information for + ``TUNE_ARCH`` specific to the ``mips`` architecture. + + ``TUNE_ARCH`` is tied closely to + :term:`TARGET_ARCH`, which defines the target + machine's architecture. The BitBake configuration file + (``meta/conf/bitbake.conf``) sets ``TARGET_ARCH`` as follows: + :: + + TARGET_ARCH = "${TUNE_ARCH}" + + The following list, which is by no means complete since architectures + are configurable, shows supported machine architectures: + + - arm + - i586 + - x86_64 + - powerpc + - powerpc64 + - mips + - mipsel + + :term:`TUNE_ASARGS` + Specifies architecture-specific assembler flags for the target + system. The set of flags is based on the selected tune features. + ``TUNE_ASARGS`` is set using the tune include files, which are + typically under ``meta/conf/machine/include/`` and are influenced + through :term:`TUNE_FEATURES`. For example, the + ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags + for the x86 architecture as follows: + :: + + TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}" + + .. 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). + + :term:`TUNE_CCARGS` + Specifies architecture-specific C compiler flags for the target + system. The set of flags is based on the selected tune features. + ``TUNE_CCARGS`` is set using the tune include files, which are + typically under ``meta/conf/machine/include/`` and are influenced + through :term:`TUNE_FEATURES`. + + .. 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). + + :term:`TUNE_FEATURES` + 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. ``TUNE_*ARGS``) to be dynamically generated based on + the features. + + The OpenEmbedded build system verifies the features to be sure they + are not conflicting and that they are supported. + + The BitBake configuration file (``meta/conf/bitbake.conf``) defines + ``TUNE_FEATURES`` as follows: + :: + + TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" + + See the :term:`DEFAULTTUNE` variable for more information. + + :term:`TUNE_LDARGS` + Specifies architecture-specific linker flags for the target system. + The set of flags is based on the selected tune features. + ``TUNE_LDARGS`` is set using the tune include files, which are + typically under ``meta/conf/machine/include/`` and are influenced + through :term:`TUNE_FEATURES`. For example, the + ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags + for the x86 architecture as follows: + :: + + TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}" + + .. 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). + + :term:`TUNE_PKGARCH` + 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: + :: + + TUNE_PKGARCH_tune-tune = "tune" + + 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 ``meta/conf/machine/include/tune-core2.inc`` file: + :: + + TUNE_PKGARCH_tune-core2-32 = "core2-32" + + :term:`TUNEABI` + An underlying Application Binary Interface (ABI) used by a particular + tuning in a given toolchain layer. Providers that use prebuilt + libraries can use the ``TUNEABI``, + :term:`TUNEABI_OVERRIDE`, and + :term:`TUNEABI_WHITELIST` variables to check + compatibility of tunings against their selection of libraries. + + If ``TUNEABI`` is undefined, then every tuning is allowed. See the + :ref:`sanity ` class to see how the variable is + used. + + :term:`TUNEABI_OVERRIDE` + If set, the OpenEmbedded system ignores the + :term:`TUNEABI_WHITELIST` variable. + Providers that use prebuilt libraries can use the + ``TUNEABI_OVERRIDE``, ``TUNEABI_WHITELIST``, and + :term:`TUNEABI` variables to check compatibility of a + tuning against their selection of libraries. + + See the :ref:`sanity ` class to see how the + variable is used. + + :term:`TUNEABI_WHITELIST` + A whitelist of permissible :term:`TUNEABI` values. If + ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers + that use prebuilt libraries can use the ``TUNEABI_WHITELIST``, + :term:`TUNEABI_OVERRIDE`, and ``TUNEABI`` + variables to check compatibility of a tuning against their selection + of libraries. + + See the :ref:`sanity ` class to see how the + variable is used. + + :term:`TUNECONFLICTS[feature]` + Specifies CPU or Application Binary Interface (ABI) tuning features + that conflict with feature. + + Known tuning conflicts are specified in the machine include files in + the :term:`Source Directory`. Here is an example from + the ``meta/conf/machine/include/mips/arch-mips.inc`` include file + that lists the "o32" and "n64" features as conflicting with the "n32" + feature: + :: + + TUNECONFLICTS[n32] = "o32 n64" + + :term:`TUNEVALID[feature]` + 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. + ``meta/conf/machine/include/arm/arch-arm.inc``). Here is an example + from that file: + :: + + TUNEVALID[bigendian] = "Enable big-endian mode." + + See the machine include files in the :term:`Source Directory` + for these features. + + :term:`UBOOT_CONFIG` + Configures the :term:`UBOOT_MACHINE` and can + also define :term:`IMAGE_FSTYPES` for individual + cases. + + Following is an example from the ``meta-fsl-arm`` layer. :: + + 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" + + In this example, "sd" is selected as the configuration of the possible four for the + ``UBOOT_MACHINE``. The "sd" configuration defines + "mx6qsabreauto_config" as the value for ``UBOOT_MACHINE``, while the + "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-boot image. + + For more information on how the ``UBOOT_CONFIG`` is handled, see the + :ref:`uboot-config ` + class. + + :term:`UBOOT_DTB_LOADADDRESS` + Specifies the load address for the dtb image used by U-boot. During FIT + image creation, the ``UBOOT_DTB_LOADADDRESS`` variable is used in + :ref:`kernel-fitimage ` class to specify + the load address to be used in + creating the dtb sections of Image Tree Source for the FIT image. + + :term:`UBOOT_DTBO_LOADADDRESS` + Specifies the load address for the dtbo image used by U-boot. During FIT + image creation, the ``UBOOT_DTBO_LOADADDRESS`` variable is used in + :ref:`kernel-fitimage ` class to specify the load address to be used in + creating the dtbo sections of Image Tree Source for the FIT image. + + :term:`UBOOT_ENTRYPOINT` + Specifies the entry point for the U-Boot image. During U-Boot image + creation, the ``UBOOT_ENTRYPOINT`` variable is passed as a + command-line parameter to the ``uboot-mkimage`` utility. + + :term:`UBOOT_LOADADDRESS` + Specifies the load address for the U-Boot image. During U-Boot image + creation, the ``UBOOT_LOADADDRESS`` variable is passed as a + command-line parameter to the ``uboot-mkimage`` utility. + + :term:`UBOOT_LOCALVERSION` + 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: + :: + + UBOOT_LOCALVERSION = "-yocto" + + :term:`UBOOT_MACHINE` + Specifies the value passed on the ``make`` 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. ``conf/machine/machine_name.conf``). + + Please see the "Selection of Processor Architecture and Board Type" + section in the U-Boot README for valid values for this variable. + + :term:`UBOOT_MAKE_TARGET` + Specifies the target called in the ``Makefile``. The default target + is "all". + + :term:`UBOOT_MKIMAGE_DTCOPTS` + Options for the device tree compiler passed to mkimage '-D' + feature while creating FIT image in :ref:`kernel-fitimage ` class. + + :term:`UBOOT_RD_ENTRYPOINT` + Specifies the entrypoint for the RAM disk image. + During FIT image creation, the + ``UBOOT_RD_ENTRYPOINT`` variable is used + in :ref:`kernel-fitimage ` class to specify the + entrypoint to be used in creating the Image Tree Source for + the FIT image. + + :term:`UBOOT_RD_LOADADDRESS` + Specifies the load address for the RAM disk image. + During FIT image creation, the + ``UBOOT_RD_LOADADDRESS`` variable is used + in :ref:`kernel-fitimage ` class to specify the + load address to be used in creating the Image Tree Source for + the FIT image. + + :term:`UBOOT_SIGN_ENABLE` + Enable signing of FIT image. The default value is "0". + + :term:`UBOOT_SIGN_KEYDIR` + Location of the directory containing the RSA key and + certificate used for signing FIT image. + + :term:`UBOOT_SIGN_KEYNAME` + The name of keys used for signing U-boot FIT image stored in + :term:`UBOOT_SIGN_KEYDIR` directory. For e.g. dev.key key and dev.crt + certificate stored in :term:`UBOOT_SIGN_KEYDIR` directory will have + :term:`UBOOT_SIGN_KEYNAME` set to "dev". + + :term:`UBOOT_SUFFIX` + Points to the generated U-Boot extension. For example, ``u-boot.sb`` + has a ``.sb`` extension. + + The default U-Boot extension is ``.bin`` + + :term:`UBOOT_TARGET` + 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. + + :term:`UNKNOWN_CONFIGURE_WHITELIST` + Specifies a list of options that, if reported by the configure script + as being invalid, should not generate a warning during the + :ref:`ref-tasks-configure` task. Normally, invalid + configure options are simply not passed to the configure script (e.g. + should be removed from :term:`EXTRA_OECONF` or + :term:`PACKAGECONFIG_CONFARGS`). + 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 ``UNKNOWN_CONFIGURE_WHITELIST``. + + The configure arguments check that uses + ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the + :ref:`insane ` class and is only enabled if the + recipe inherits the :ref:`autotools ` class. + + :term:`UPDATERCPN` + For recipes inheriting the + :ref:`update-rc.d ` class, ``UPDATERCPN`` + specifies the package that contains the initscript that is enabled. + + 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. + + :term:`UPSTREAM_CHECK_GITTAGREGEX` + You can perform a per-recipe check for what the latest upstream + source code version is by calling ``bitbake -c checkpkg`` recipe. If + the recipe source code is provided from Git repositories, the + OpenEmbedded build system determines the latest upstream version by + picking the latest tag from the list of all repository tags. + + You can use the ``UPSTREAM_CHECK_GITTAGREGEX`` variable to provide a + regular expression to filter only the relevant tags should the + default filter not work correctly. + :: + + UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" + + :term:`UPSTREAM_CHECK_REGEX` + Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different + regular expression instead of the default one when the package + checking system is parsing the page found using + :term:`UPSTREAM_CHECK_URI`. + :: + + UPSTREAM_CHECK_REGEX = "package_regex" + + :term:`UPSTREAM_CHECK_URI` + You can perform a per-recipe check for what the latest upstream + source code version is by calling ``bitbake -c checkpkg`` recipe. If + the source code is provided from tarballs, the latest version is + determined by fetching the directory listing where the tarball is and + attempting to find a later tarball. When this approach does not work, + you can use ``UPSTREAM_CHECK_URI`` to provide a different URI that + contains the link to the latest tarball. + :: + + UPSTREAM_CHECK_URI = "recipe_url" + + :term:`USE_DEVFS` + Determines if ``devtmpfs`` is used for ``/dev`` population. The + default value used for ``USE_DEVFS`` is "1" when no value is + specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a + statically populated ``/dev`` directory. + + See the ":ref:`dev-manual/common-tasks:selecting a device manager`" section in + the Yocto Project Development Tasks Manual for information on how to + use this variable. + + :term:`USE_VT` + When using + :ref:`SysVinit `, + determines whether or not to run a + `getty `__ on any + virtual terminals in order to enable logging in through those + terminals. + + The default value used for ``USE_VT`` is "1" when no default value is + specifically set. Typically, you would set ``USE_VT`` 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. + + :term:`USER_CLASSES` + A list of classes to globally inherit. These classes are used by the + OpenEmbedded build system to enable extra features (e.g. + ``buildstats``, ``image-mklibs``, and so forth). + + The default list is set in your ``local.conf`` file: + :: + + USER_CLASSES ?= "buildstats image-mklibs image-prelink" + + For more information, see + ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`. + + :term:`USERADD_ERROR_DYNAMIC` + If set to ``error``, forces the OpenEmbedded build system to produce + an error if the user identification (``uid``) and group + identification (``gid``) values are not defined in any of the files + listed in :term:`USERADD_UID_TABLES` and + :term:`USERADD_GID_TABLES`. If set to + ``warn``, a warning will be issued instead. + + The default behavior for the build system is to dynamically apply + ``uid`` and ``gid`` values. Consequently, the + ``USERADD_ERROR_DYNAMIC`` variable is by default not set. If you plan + on using statically assigned ``gid`` and ``uid`` values, you should + set the ``USERADD_ERROR_DYNAMIC`` variable in your ``local.conf`` + file as follows: + :: + + USERADD_ERROR_DYNAMIC = "error" + + Overriding the + default behavior implies you are going to also take steps to set + static ``uid`` and ``gid`` values through use of the + :term:`USERADDEXTENSION`, + :term:`USERADD_UID_TABLES`, and + :term:`USERADD_GID_TABLES` variables. + + .. note:: + + There is a difference in behavior between setting + ``USERADD_ERROR_DYNAMIC`` to ``error`` and setting it to ``warn``. + When it is set to ``warn``, the build system will report a warning for + every undefined ``uid`` and ``gid`` in any recipe. But when it is set + to ``error``, it will only report errors for recipes that are actually + built. + This saves you from having to add static IDs for recipes that you + know will never be built. + + :term:`USERADD_GID_TABLES` + 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. + + When applying static group identification (``gid``) values, the + OpenEmbedded build system looks in :term:`BBPATH` for a + ``files/group`` file and then applies those ``uid`` values. Set the + variable as follows in your ``local.conf`` file: + :: + + + USERADD_GID_TABLES = "files/group" + + .. note:: + + Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids" + causes the build system to use static ``gid`` values. + + :term:`USERADD_PACKAGES` + When inheriting the :ref:`useradd ` class, + this variable specifies the individual packages within the recipe + that require users and/or groups to be added. + + 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: + :: + + USERADD_PACKAGES = "${PN}" + + .. note:: + + It follows that if you are going to use the ``USERADD_PACKAGES`` + variable, you need to set one or more of the :term:`USERADD_PARAM`, + :term:`GROUPADD_PARAM`, or :term:`GROUPMEMS_PARAM` variables. + + :term:`USERADD_PARAM` + When inheriting the :ref:`useradd ` class, + this variable specifies for a package what parameters should pass to + the ``useradd`` command if you add a user to the system when the + package is installed. + + Here is an example from the ``dbus`` recipe: + :: + + USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \ + --no-create-home --shell /bin/false \ + --user-group messagebus" + + For information on the + standard Linux shell command ``useradd``, see + http://linux.die.net/man/8/useradd. + + :term:`USERADD_UID_TABLES` + 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. + + When applying static user identification (``uid``) values, the + OpenEmbedded build system looks in :term:`BBPATH` for a + ``files/passwd`` file and then applies those ``uid`` values. Set the + variable as follows in your ``local.conf`` file: + :: + + USERADD_UID_TABLES = "files/passwd" + + .. note:: + + Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids" + causes the build system to use static ``uid`` values. + + :term:`USERADDEXTENSION` + 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 :term:`BBPATH`. + + To use static user identification (``uid``) and group identification + (``gid``) values, set the variable as follows in your ``local.conf`` + file: USERADDEXTENSION = "useradd-staticids" + + .. note:: + + Setting this variable to use static ``uid`` and ``gid`` + values causes the OpenEmbedded build system to employ the + :ref:`ref-classes-useradd` class. + + If you use static ``uid`` and ``gid`` information, you must also + specify the ``files/passwd`` and ``files/group`` files by setting the + :term:`USERADD_UID_TABLES` and + :term:`USERADD_GID_TABLES` variables. + Additionally, you should also set the + :term:`USERADD_ERROR_DYNAMIC` variable. + + :term:`VOLATILE_LOG_DIR` + Specifies the persistence of the target's ``/var/log`` directory, + which is used to house postinstall target log files. + + By default, ``VOLATILE_LOG_DIR`` is set to "yes", which means the + file is not persistent. You can override this setting by setting the + variable to "no" to make the log directory persistent. + + :term:`WARN_QA` + 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 + ":ref:`insane.bbclass `" section. + + :term:`WKS_FILE` + Specifies the location of the Wic kickstart file that is used by the + OpenEmbedded build system to create a partitioned image + (image\ ``.wic``). For information on how to create a partitioned + image, see the + ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" + section in the Yocto Project Development Tasks Manual. For details on + the kickstart file format, see the ":doc:`/ref-manual/kickstart`" Chapter. + + :term:`WKS_FILE_DEPENDS` + When placed in the recipe that builds your image, this variable lists + build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only + applicable when Wic images are active (i.e. when + :term:`IMAGE_FSTYPES` contains entries related + to Wic). If your recipe does not create Wic images, the variable has + no effect. + + The ``WKS_FILE_DEPENDS`` variable is similar to the + :term:`DEPENDS` variable. When you use the variable in + your recipe that builds the Wic image, dependencies you list in the + ``WIC_FILE_DEPENDS`` variable are added to the ``DEPENDS`` variable. + + With the ``WKS_FILE_DEPENDS`` variable, you have the possibility to + specify a list of additional dependencies (e.g. native tools, + bootloaders, and so forth), that are required to build Wic images. + Following is an example: + :: + + WKS_FILE_DEPENDS = "some-native-tool" + + In the + previous example, some-native-tool would be replaced with an actual + native tool on which the build would depend. + + :term:`WORKDIR` + The pathname of the work directory in which the OpenEmbedded build + system builds a recipe. This directory is located within the + :term:`TMPDIR` directory structure and is specific to + the recipe being built and the system for which it is being built. + + The ``WORKDIR`` directory is defined as follows: + :: + + ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} + + The actual directory depends on several things: + + - :term:`TMPDIR`: The top-level build output directory + - :term:`MULTIMACH_TARGET_SYS`: The target system identifier + - :term:`PN`: The recipe name + - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which + is usually the case for most recipes, then `EXTENDPE` is blank) + - :term:`PV`: The recipe version + - :term:`PR`: The recipe revision + + As an example, assume a Source Directory top-level folder name + ``poky``, a default Build Directory at ``poky/build``, and a + ``qemux86-poky-linux`` machine target system. Furthermore, suppose + your recipe is named ``foo_1.3.0-r0.bb``. In this case, the work + directory the build system uses to build the package would be as + follows: + :: + + poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 + + :term:`XSERVER` + Specifies the packages that should be installed to provide an X + server and drivers for the current machine, assuming your image + directly includes ``packagegroup-core-x11-xserver`` or, perhaps + indirectly, includes "x11-base" in + :term:`IMAGE_FEATURES`. + + The default value of ``XSERVER``, if not specified in the machine + configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". + diff --git a/documentation/ref-manual/varlocality.rst b/documentation/ref-manual/varlocality.rst new file mode 100644 index 0000000000..5f7dba8775 --- /dev/null +++ b/documentation/ref-manual/varlocality.rst @@ -0,0 +1,166 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +**************** +Variable Context +**************** + +While you can use most variables in almost any context such as +``.conf``, ``.bbclass``, ``.inc``, and ``.bb`` files, some variables are +often associated with a particular locality or context. This chapter +describes some common associations. + +.. _ref-varlocality-configuration: + +Configuration +============= + +The following subsections provide lists of variables whose context is +configuration: distribution, machine, and local. + +.. _ref-varlocality-config-distro: + +Distribution (Distro) +--------------------- + +This section lists variables whose configuration context is the +distribution, or distro. + +- :term:`DISTRO` + +- :term:`DISTRO_NAME` + +- :term:`DISTRO_VERSION` + +- :term:`MAINTAINER` + +- :term:`PACKAGE_CLASSES` + +- :term:`TARGET_OS` + +- :term:`TARGET_FPU` + +- :term:`TCMODE` + +- :term:`TCLIBC` + +.. _ref-varlocality-config-machine: + +Machine +------- + +This section lists variables whose configuration context is the machine. + +- :term:`TARGET_ARCH` + +- :term:`SERIAL_CONSOLES` + +- :term:`PACKAGE_EXTRA_ARCHS` + +- :term:`IMAGE_FSTYPES` + +- :term:`MACHINE_FEATURES` + +- :term:`MACHINE_EXTRA_RDEPENDS` + +- :term:`MACHINE_EXTRA_RRECOMMENDS` + +- :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS` + +- :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` + +.. _ref-varlocality-config-local: + +Local +----- + +This section lists variables whose configuration context is the local +configuration through the ``local.conf`` file. + +- :term:`DISTRO` + +- :term:`MACHINE` + +- :term:`DL_DIR` + +- :term:`BBFILES` + +- :term:`EXTRA_IMAGE_FEATURES` + +- :term:`PACKAGE_CLASSES` + +- :term:`BB_NUMBER_THREADS` + +- :term:`BBINCLUDELOGS` + +- :term:`ENABLE_BINARY_LOCALE_GENERATION` + +.. _ref-varlocality-recipes: + +Recipes +======= + +The following subsections provide lists of variables whose context is +recipes: required, dependencies, path, and extra build information. + +.. _ref-varlocality-recipe-required: + +Required +-------- + +This section lists variables that are required for recipes. + +- :term:`LICENSE` + +- :term:`LIC_FILES_CHKSUM` + +- :term:`SRC_URI` - used in recipes that fetch local or remote files. + +.. _ref-varlocality-recipe-dependencies: + +Dependencies +------------ + +This section lists variables that define recipe dependencies. + +- :term:`DEPENDS` + +- :term:`RDEPENDS` + +- :term:`RRECOMMENDS` + +- :term:`RCONFLICTS` + +- :term:`RREPLACES` + +.. _ref-varlocality-recipe-paths: + +Paths +----- + +This section lists variables that define recipe paths. + +- :term:`WORKDIR` + +- :term:`S` + +- :term:`FILES` + +.. _ref-varlocality-recipe-build: + +Extra Build Information +----------------------- + +This section lists variables that define extra build information for +recipes. + +- :term:`DEFAULT_PREFERENCE` + +- :term:`EXTRA_OECMAKE` + +- :term:`EXTRA_OECONF` + +- :term:`EXTRA_OEMAKE` + +- :term:`PACKAGECONFIG_CONFARGS` + +- :term:`PACKAGES` -- cgit v1.2.3-54-g00ecf