diff options
Diffstat (limited to 'documentation/ref-manual')
43 files changed, 21357 insertions, 36720 deletions
diff --git a/documentation/ref-manual/TODO b/documentation/ref-manual/TODO deleted file mode 100644 index ee0db977cc..0000000000 --- a/documentation/ref-manual/TODO +++ /dev/null @@ -1,11 +0,0 @@ -Handbook Todo List: - - * Document adding a new IMAGE_FEATURE to the customising images section - * Add instructions about using zaurus/openmoko emulation - * Add component overview/block diagrams - * Software Deevelopment intro should mention its software development for - intended target and could be a different arch etc and thus special case. - * Expand insane.bbclass documentation to cover tests - * Document remaining classes (see list in ref-classes) - * Document formfactor - diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst new file mode 100644 index 0000000000..9520d0bf7c --- /dev/null +++ b/documentation/ref-manual/classes.rst @@ -0,0 +1,3502 @@ +.. 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 one of a set of subdirectories +beneath the ``meta*/`` directory found in the :term:`Source Directory`: + + - ``classes-recipe/`` - classes intended to be inherited by recipes + individually + - ``classes-global/`` - classes intended to be inherited globally + - ``classes/`` - classes whose usage context is not clearly defined + +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*`` directories in the Source +Directory. You can reference the ``.bbclass`` files directly for more +information. + +.. _ref-classes-allarch: + +``allarch`` +=========== + +The :ref:`ref-classes-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 :ref:`ref-classes-allarch`. This is the case + even if the recipes do not produce architecture-specific output. + + Configuring such recipes for all architectures causes the + :ref:`do_package_write_* <ref-tasks-package_write_deb>` tasks to + have different signatures for the machines with different tunings. + Additionally, unnecessary rebuilds occur every time an image for a + different :term:`MACHINE` is built even when the recipe never changes. + +By default, all recipes inherit the :ref:`ref-classes-base` and +:ref:`ref-classes-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 :ref:`ref-classes-allarch` class. + +.. _ref-classes-archiver: + +``archiver`` +============ + +The :ref:`ref-classes-archiver` class supports releasing source code and other +materials with the binaries. + +For more details on the source :ref:`ref-classes-archiver`, see the +":ref:`dev-manual/licenses: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*`` +============== + +The :ref:`autotools* <ref-classes-autotools>` classes support packages built with the +:wikipedia:`GNU Autotools <GNU_Autotools>`. + +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/new-recipe:building an autotooled package`" section +in the Yocto Project Development Tasks Manual. + +By default, the :ref:`autotools* <ref-classes-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 +:ref:`autotools-brokensep <ref-classes-autotools>` class. The :ref:`autotools-brokensep <ref-classes-autotools>` class behaves +the same as the :ref:`ref-classes-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 +:ref:`autotools* <ref-classes-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 :term:`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 :term:`EXTRA_OEMAKE` variable. + +- :ref:`ref-tasks-install` --- runs ``make install`` and + passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``. + +.. _ref-classes-base: + +``base`` +======== + +The :ref:`ref-classes-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 tasks are often overridden or +extended by other classes such as the :ref:`ref-classes-autotools` class or the +:ref:`ref-classes-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`` +=================== + +Sets up packaging and dependencies appropriate for recipes that build +software that includes bash-completion data. + +.. _ref-classes-bin-package: + +``bin_package`` +=============== + +The :ref:`ref-classes-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 + :term:`S`:: + + SRC_URI = "git://example.com/downloads/somepackage.rpm;branch=main;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`` +============= + +The :ref:`ref-classes-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`` +====================== + +An alternative version of the :ref:`ref-classes-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-buildhistory: + +``buildhistory`` +================ + +The :ref:`ref-classes-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/build-quality:maintaining build output quality`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-buildstats: + +``buildstats`` +============== + +The :ref:`ref-classes-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 ":ref:`ref-classes-buildstats`" from the :term:`USER_CLASSES` list. + +.. _ref-classes-buildstats-summary: + +``buildstats-summary`` +====================== + +When inherited globally, prints statistics at the end of the build on +sstate re-use. In order to function, this class requires the +:ref:`ref-classes-buildstats` class be enabled. + +.. _ref-classes-cargo: + +``cargo`` +========= + +The :ref:`ref-classes-cargo` class allows to compile Rust language programs +using `Cargo <https://doc.rust-lang.org/cargo/>`__. Cargo is Rust's package +manager, allowing to fetch package dependencies and build your program. + +Using this class makes it very easy to build Rust programs. All you need +is to use the :term:`SRC_URI` variable to point to a source repository +which can be built by Cargo, typically one that was created by the +``cargo new`` command, containing a ``Cargo.toml`` file, a ``Cargo.lock`` file and a ``src`` +subdirectory. + +If you want to build and package tests of the program, inherit the +:ref:`ref-classes-ptest-cargo` class instead of :ref:`ref-classes-cargo`. + +You will find an example (that show also how to handle possible git source dependencies) in the +:oe_git:`zvariant_3.12.0.bb </openembedded-core/tree/meta-selftest/recipes-extended/zvariant/zvariant_3.12.0.bb>` +recipe. Another example, with only crate dependencies, is the +:oe_git:`uutils-coreutils </meta-openembedded/tree/meta-oe/recipes-core/uutils-coreutils>` +recipe, which was generated by the `cargo-bitbake <https://crates.io/crates/cargo-bitbake>`__ +tool. + +This class inherits the :ref:`ref-classes-cargo_common` class. + +.. _ref-classes-cargo_c: + +``cargo_c`` +=========== + +The :ref:`ref-classes-cargo_c` class can be inherited by a recipe to generate +a Rust library that can be called by C/C++ code. The recipe which inherits this +class has to only replace ``inherit cargo`` by ``inherit cargo_c``. + +See the :yocto_git:`rust-c-lib-example_git.bb +</poky/tree/meta-selftest/recipes-devtools/rust/rust-c-lib-example_git.bb>` +example recipe. + +.. _ref-classes-cargo_common: + +``cargo_common`` +================ + +The :ref:`ref-classes-cargo_common` class is an internal class +that is not intended to be used directly. + +An exception is the "rust" recipe, to build the Rust compiler and runtime +library, which is built by Cargo but cannot use the :ref:`ref-classes-cargo` +class. This is why this class was introduced. + +.. _ref-classes-cargo-update-recipe-crates: + +``cargo-update-recipe-crates`` +=============================== + +The :ref:`ref-classes-cargo-update-recipe-crates` class allows +recipe developers to update the list of Cargo crates in :term:`SRC_URI` +by reading the ``Cargo.lock`` file in the source tree. + +To do so, create a recipe for your program, for example using +:doc:`devtool </ref-manual/devtool-reference>`, +make it inherit the :ref:`ref-classes-cargo` and +:ref:`ref-classes-cargo-update-recipe-crates` and run:: + + bitbake -c update_crates recipe + +This creates a ``recipe-crates.inc`` file that you can include in your +recipe:: + + require ${BPN}-crates.inc + +That's also something you can achieve by using the +`cargo-bitbake <https://crates.io/crates/cargo-bitbake>`__ tool. + +.. _ref-classes-ccache: + +``ccache`` +========== + +The :ref:`ref-classes-ccache` class enables the C/C++ Compiler Cache for the build. +This class is used to give a minor performance boost during the build. + +See https://ccache.samba.org/ for information on the C/C++ Compiler +Cache, and the :oe_git:`ccache.bbclass </openembedded-core/tree/meta/classes/ccache.bbclass>` +file for details about how to enable this mechanism in your configuration +file, how to disable it for specific recipes, and how to share ``ccache`` +files between builds. + +However, using the class can lead to unexpected side-effects. Thus, using +this class is not recommended. + +.. _ref-classes-chrpath: + +``chrpath`` +=========== + +The :ref:`ref-classes-chrpath` class is a wrapper around the "chrpath" utility, which +is used during the build process for :ref:`ref-classes-nativesdk`, :ref:`ref-classes-cross`, and +:ref:`ref-classes-cross-canadian` recipes to change ``RPATH`` records within binaries +in order to make them relocatable. + +.. _ref-classes-cmake: + +``cmake`` +========= + +The :ref:`ref-classes-cmake` class allows recipes to build software using the +`CMake <https://cmake.org/overview/>`__ build system. You can use the +:term:`EXTRA_OECMAKE` variable to specify additional configuration options to +pass to the ``cmake`` command line. + +By default, the :ref:`ref-classes-cmake` class uses +`Ninja <https://ninja-build.org/>`__ instead of GNU make for building, which +offers better build performance. If a recipe is broken with Ninja, then the +recipe can set the :term:`OECMAKE_GENERATOR` variable to ``Unix Makefiles`` to +use GNU make instead. + +If you need to install custom CMake toolchain files supplied by the application +being built, you should install them (during :ref:`ref-tasks-install`) to the +preferred CMake Module directory: ``${D}${datadir}/cmake/modules/``. + +.. _ref-classes-cmake-qemu: + +``cmake-qemu`` +============== + +The :ref:`ref-classes-cmake-qemu` class might be used instead of the +:ref:`ref-classes-cmake` class. In addition to the features provided by the +:ref:`ref-classes-cmake` class, the :ref:`ref-classes-cmake-qemu` class passes +the ``CMAKE_CROSSCOMPILING_EMULATOR`` setting to ``cmake``. This allows to use +QEMU user-mode emulation for the execution of cross-compiled binaries on the +host machine. For more information about ``CMAKE_CROSSCOMPILING_EMULATOR`` +please refer to the `related section of the CMake documentation +<https://cmake.org/cmake/help/latest/variable/CMAKE_CROSSCOMPILING_EMULATOR.html>`__. + +Not all platforms are supported by QEMU. This class only works for machines with +``qemu-usermode`` in the :ref:`ref-features-machine`. Using QEMU user-mode therefore +involves a certain risk, which is also the reason why this feature is not part of +the main :ref:`ref-classes-cmake` class by default. + +One use case is the execution of cross-compiled unit tests with CTest on the build +machine. If ``CMAKE_CROSSCOMPILING_EMULATOR`` is configured:: + + cmake --build --target test + +works transparently with QEMU user-mode. + +If the CMake project is developed with this use case in mind this works very nicely. +This also applies to an IDE configured to use ``cmake-native`` for cross-compiling. + +.. _ref-classes-cml1: + +``cml1`` +======== + +The :ref:`ref-classes-cml1` class provides basic support for the Linux kernel style +build configuration system. "cml" stands for "Configuration Menu Language", which +originates from the Linux kernel but is also used in other projects such as U-Boot +and BusyBox. It could have been called "kconfig" too. + +.. _ref-classes-compress_doc: + +``compress_doc`` +================ + +Enables compression for manual 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`` +======================= + +The :ref:`ref-classes-copyleft_compliance` class preserves source code for the purposes +of license compliance. This class is an alternative to the :ref:`ref-classes-archiver` +class and is still used by some users even though it has been deprecated +in favor of the :ref:`ref-classes-archiver` class. + +.. _ref-classes-copyleft_filter: + +``copyleft_filter`` +=================== + +A class used by the :ref:`ref-classes-archiver` and +:ref:`ref-classes-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`` +============== + +The :ref:`ref-classes-core-image` class provides common definitions for the +``core-image-*`` image recipes, such as support for additional +:term:`IMAGE_FEATURES`. + +.. _ref-classes-cpan: + +``cpan*`` +========= + +The :ref:`cpan* <ref-classes-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 :ref:`cpan-base <ref-classes-cpan>` class for basic Perl +support. + +.. _ref-classes-create-spdx: + +``create-spdx`` +=============== + +The :ref:`ref-classes-create-spdx` class provides support for +automatically creating :term:`SPDX` :term:`SBOM` documents based upon image +and SDK contents. + +This class is meant to be inherited globally from a configuration file:: + + INHERIT += "create-spdx" + +The toplevel :term:`SPDX` output file is generated in JSON format as a +``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside the +:term:`Build Directory`. There are other related files in the same directory, +as well as in ``tmp/deploy/spdx``. + +The exact behaviour of this class, and the amount of output can be controlled +by the :term:`SPDX_PRETTY`, :term:`SPDX_ARCHIVE_PACKAGED`, +:term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables. + +See the description of these variables and the +":ref:`dev-manual/sbom:creating a software bill of materials`" +section in the Yocto Project Development Manual for more details. + +.. _ref-classes-cross: + +``cross`` +========= + +The :ref:`ref-classes-cross` class provides support for the recipes that build the +cross-compilation tools. + +.. _ref-classes-cross-canadian: + +``cross-canadian`` +================== + +The :ref:`ref-classes-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`` +============ + +The :ref:`ref-classes-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-cve-check: + +``cve-check`` +============= + +The :ref:`ref-classes-cve-check` class looks for known CVEs (Common Vulnerabilities +and Exposures) while building with BitBake. This class is meant to be +inherited globally from a configuration file:: + + INHERIT += "cve-check" + +To filter out obsolete CVE database entries which are known not to impact software from Poky and OE-Core, +add following line to the build configuration file:: + + include cve-extra-exclusions.inc + +You can also look for vulnerabilities in specific packages by passing +``-c cve_check`` to BitBake. + +After building the software with Bitbake, CVE check output reports are available in ``tmp/deploy/cve`` +and image specific summaries in ``tmp/deploy/images/*.cve`` or ``tmp/deploy/images/*.json`` files. + +When building, the CVE checker will emit build time warnings for any detected +issues which are in the state ``Unpatched``, meaning that CVE issue seems to affect the software component +and version being compiled and no patches to address the issue are applied. Other states +for detected CVE issues are: ``Patched`` meaning that a patch to address the issue is already +applied, and ``Ignored`` meaning that the issue can be ignored. + +The ``Patched`` state of a CVE issue is detected from patch files with the format +``CVE-ID.patch``, e.g. ``CVE-2019-20633.patch``, in the :term:`SRC_URI` and using +CVE metadata of format ``CVE: CVE-ID`` in the commit message of the patch file. + +.. note:: + + Commit message metadata (``CVE: CVE-ID`` in a patch header) will not be scanned + in any patches that are remote, i.e. that are anything other than local files + referenced via ``file://`` in SRC_URI. However, a ``CVE-ID`` in a remote patch + file name itself will be registered. + +If the recipe adds ``CVE-ID`` as flag of the :term:`CVE_STATUS` variable with status +mapped to ``Ignored``, then the CVE state is reported as ``Ignored``:: + + CVE_STATUS[CVE-2020-15523] = "not-applicable-platform: Issue only applies on Windows" + +If CVE check reports that a recipe contains false positives or false negatives, these may be +fixed in recipes by adjusting the CVE product name using :term:`CVE_PRODUCT` and :term:`CVE_VERSION` variables. +:term:`CVE_PRODUCT` defaults to the plain recipe name :term:`BPN` which can be adjusted to one or more CVE +database vendor and product pairs using the syntax:: + + CVE_PRODUCT = "flex_project:flex" + +where ``flex_project`` is the CVE database vendor name and ``flex`` is the product name. Similarly +if the default recipe version :term:`PV` does not match the version numbers of the software component +in upstream releases or the CVE database, then the :term:`CVE_VERSION` variable can be used to set the +CVE database compatible version number, for example:: + + CVE_VERSION = "2.39" + +Any bugs or missing or incomplete information in the CVE database entries should be fixed in the CVE database +via the `NVD feedback form <https://nvd.nist.gov/info/contact-form>`__. + +Users should note that security is a process, not a product, and thus also CVE checking, analyzing results, +patching and updating the software should be done as a regular process. The data and assumptions +required for CVE checker to reliably detect issues are frequently broken in various ways. +These can only be detected by reviewing the details of the issues and iterating over the generated reports, +and following what happens in other Linux distributions and in the greater open source community. + +You will find some more details in the +":ref:`dev-manual/vulnerabilities:checking for vulnerabilities`" +section in the Development Tasks Manual. + +.. _ref-classes-debian: + +``debian`` +========== + +The :ref:`ref-classes-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`` +========== + +The :ref:`ref-classes-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 :term:`DEPLOYDIR` to :term:`DEPLOY_DIR_IMAGE`. + +.. _ref-classes-devicetree: + +``devicetree`` +============== + +The :ref:`ref-classes-devicetree` class allows to build a recipe that compiles +device tree source files that are not in the kernel tree. + +The compilation of out-of-tree device tree sources is the same as the kernel +in-tree device tree compilation process. This includes the ability to include +sources from the kernel such as SoC ``dtsi`` files as well as C header files, +such as ``gpio.h``. + +The :ref:`ref-tasks-compile` task will compile two kinds of files: + +- Regular device tree sources with a ``.dts`` extension. + +- Device tree overlays, detected from the presence of the ``/plugin/;`` + string in the file contents. + +This class deploys the generated device tree binaries into +``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}/devicetree/``. This is similar to +what the :ref:`ref-classes-kernel-devicetree` class does, with the added +``devicetree`` subdirectory to avoid name clashes. Additionally, the device +trees are populated into the sysroot for access via the sysroot from within +other recipes. + +By default, all device tree sources located in :term:`DT_FILES_PATH` directory +are compiled. To select only particular sources, set :term:`DT_FILES` to +a space-separated list of files (relative to :term:`DT_FILES_PATH`). For +convenience, both ``.dts`` and ``.dtb`` extensions can be used. + +An extra padding is appended to non-overlay device trees binaries. This +can typically be used as extra space for adding extra properties at boot time. +The padding size can be modified by setting :term:`DT_PADDING_SIZE` +to the desired size, in bytes. + +See :oe_git:`devicetree.bbclass sources +</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>` +for further variables controlling this class. + +Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb`` +recipe inheriting this class:: + + inherit devicetree + COMPATIBLE_MACHINE = "^mymachine$" + SRC_URI:mymachine = "file://mymachine.dts" + +.. _ref-classes-devshell: + +``devshell`` +============ + +The :ref:`ref-classes-devshell` class adds the :ref:`ref-tasks-devshell` task. Distribution +policy dictates whether to include this class. See the ":ref:`dev-manual/development-shell:using a development shell`" +section in the Yocto Project Development Tasks Manual for more +information about using :ref:`ref-classes-devshell`. + +.. _ref-classes-devupstream: + +``devupstream`` +=============== + +The :ref:`ref-classes-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. Here is an example:: + + BBCLASSEXTEND = "devupstream:target" + SRC_URI:class-devupstream = "git://git.example.com/example;branch=main" + 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 :ref:`ref-classes-native` or :ref:`ref-classes-nativesdk` variants. + +The :term:`BBCLASSEXTEND` syntax (i.e. ``devupstream:target``) provides +support for :ref:`ref-classes-native` and :ref:`ref-classes-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-externalsrc: + +``externalsrc`` +=============== + +The :ref:`ref-classes-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 +:ref:`ref-classes-externalsrc` class, you use the +:term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD` variables to +ultimately define :term:`S` and :term:`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 :term:`B` directory is set to the +following, which is separate from the source directory (:term:`S`):: + + ${WORKDIR}/${BPN}-{PV}/ + +See these variables for more information: +:term:`WORKDIR`, :term:`BPN`, and +:term:`PV`, + +For more information on the :ref:`ref-classes-externalsrc` class, see the comments in +``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`. +For information on how to use the :ref:`ref-classes-externalsrc` class, see the +":ref:`dev-manual/building:building software from an external source`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-extrausers: + +``extrausers`` +============== + +The :ref:`ref-classes-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 :ref:`ref-classes-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 :ref:`ref-classes-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. First on host, create the (escaped) password hash:: + + printf "%q" $(mkpasswd -m sha256crypt tester01) + +The resulting hash is set to a variable and used in ``useradd`` command parameters:: + + inherit extrausers + PASSWD = "\$X\$ABC123\$A-Long-Hash" + EXTRA_USERS_PARAMS = "\ + useradd -p '${PASSWD}' tester-jim; \ + useradd -p '${PASSWD}' tester-sue; \ + " + +Finally, here is an example that sets the root password:: + + inherit extrausers + EXTRA_USERS_PARAMS = "\ + usermod -p '${PASSWD}' root; \ + " + +.. note:: + + From a security perspective, hardcoding a default password is not + generally a good idea or even legal in some jurisdictions. It is + recommended that you do not do this if you are building a production + image. + + +.. _ref-classes-features_check: + +``features_check`` +================== + +The :ref:`ref-classes-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`` +============= + +The :ref:`ref-classes-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`` +=========== + +The :ref:`ref-classes-fs-uuid` class extracts UUID from +``${``\ :term:`ROOTFS`\ ``}``, which must have been built +by the time that this function gets called. The :ref:`ref-classes-fs-uuid` class only +works on ``ext`` file systems and depends on ``tune2fs``. + +.. _ref-classes-gconf: + +``gconf`` +========= + +The :ref:`ref-classes-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`` +=========== + +The :ref:`ref-classes-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-github-releases: + +``github-releases`` +=================== + +For recipes that fetch release tarballs from github, the :ref:`ref-classes-github-releases` +class sets up a standard way for checking available upstream versions +(to support ``devtool upgrade`` and the Automated Upgrade Helper (AUH)). + +To use it, add ":ref:`ref-classes-github-releases`" to the inherit line in the recipe, +and if the default value of :term:`GITHUB_BASE_URI` is not suitable, +then set your own value in the recipe. You should then use ``${GITHUB_BASE_URI}`` +in the value you set for :term:`SRC_URI` within the recipe. + +.. _ref-classes-gnomebase: + +``gnomebase`` +============= + +The :ref:`ref-classes-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-go: + +``go`` +====== + +The :ref:`ref-classes-go` class supports building Go programs. The behavior of +this class is controlled by the mandatory :term:`GO_IMPORT` variable, and +by the optional :term:`GO_INSTALL` and :term:`GO_INSTALL_FILTEROUT` ones. + +To build a Go program with the Yocto Project, you can use the +:yocto_git:`go-helloworld_0.1.bb </poky/tree/meta/recipes-extended/go-examples/go-helloworld_0.1.bb>` +recipe as an example. + +.. _ref-classes-go-mod: + +``go-mod`` +========== + +The :ref:`ref-classes-go-mod` class allows to use Go modules, and inherits the +:ref:`ref-classes-go` class. + +See the associated :term:`GO_WORKDIR` variable. + +.. _ref-classes-go-vendor: + +``go-vendor`` +============= + +The :ref:`ref-classes-go-vendor` class implements support for offline builds, +also known as Go vendoring. In such a scenario, the module dependencias are +downloaded during the :ref:`ref-tasks-fetch` task rather than when modules are +imported, thus being coherent with Yocto's concept of fetching every source +beforehand. + +The dependencies are unpacked into the modules' ``vendor`` directory, where a +manifest file is generated. + +.. _ref-classes-gobject-introspection: + +``gobject-introspection`` +========================= + +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 :ref:`backfilled <ref-features-backfill>` by default + and, if not applicable, should be disabled through + :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` or + :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`, respectively. + +.. _ref-classes-grub-efi: + +``grub-efi`` +============ + +The :ref:`ref-classes-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`` +============= + +The :ref:`ref-classes-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`` +=========== + +The :ref:`ref-classes-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`` +================== + +The :ref:`ref-classes-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`` +======================= + +The :ref:`ref-classes-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`` +============== + +The :ref:`ref-classes-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`` +========= + +The :ref:`ref-classes-icecc` class supports +`Icecream <https://github.com/icecc/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 +``ICECC_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 :oe_git:`icecc-create-env_0.1.bb +</openembedded-core/tree/meta/recipes-devtools/icecc-create-env/icecc-create-env_0.1.bb>`. + +.. note:: + + This script is a modified version and not the one that comes with + ``icecream``. + +If you do not want the Icecream distributed compile support to apply to +specific recipes or classes, you can ask them to be ignored by Icecream +by listing the recipes and classes using the +:term:`ICECC_RECIPE_DISABLE` and +:term:`ICECC_CLASS_DISABLE` 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_RECIPE_ENABLE` variable in +your ``local.conf`` file to force ``icecc`` to be enabled for recipes +using an empty :term:`PARALLEL_MAKE` variable. + +Inheriting the :ref:`ref-classes-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 :term:`SSTATE_MIRRORS`, then all developers and the build +system need to either inherit the :ref:`ref-classes-icecc` class or nobody should. + +At the distribution level, you can inherit the :ref:`ref-classes-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`` +========= + +The :ref:`ref-classes-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 :term:`IMAGE_FSTYPES` variable controls the types of images to + generate. + +- The :term:`IMAGE_INSTALL` variable controls the list of packages to + install into the image. + +For information on customizing images, see the +":ref:`dev-manual/customizing-images: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 Concepts Manual. + +.. _ref-classes-image-buildinfo: + +``image-buildinfo`` +=================== + +The :ref:`ref-classes-image-buildinfo` class writes a plain text file containing +build information to the target filesystem at ``${sysconfdir}/buildinfo`` +by default (as specified by :term:`IMAGE_BUILDINFO_FILE`). +This can be useful for manually determining the origin of any given +image. It writes out two sections: + +#. `Build Configuration`: a list of variables and their values (specified + by :term:`IMAGE_BUILDINFO_VARS`, which defaults to :term:`DISTRO` and + :term:`DISTRO_VERSION`) + +#. `Layer Revisions`: the revisions of all of the layers used in the + build. + +Additionally, when building an SDK it will write the same contents +to ``/buildinfo`` by default (as specified by +:term:`SDK_BUILDINFO_FILE`). + +.. _ref-classes-image_types: + +``image_types`` +=============== + +The :ref:`ref-classes-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:`ref-classes-image` class automatically +enables the :ref:`ref-classes-image_types` class. The :ref:`ref-classes-image` class uses the +``IMGCLASSES`` variable as follows:: + + IMGCLASSES = "rootfs_${IMAGE_PKGTYPE} image_types ${IMAGE_CLASSES}" + # Only Linux SDKs support populate_sdk_ext, fall back to populate_sdk_base + # in the non-Linux SDK_OS case, such as mingw32 + inherit populate_sdk_base + IMGCLASSES += "${@['', '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" + IMGCLASSES += "overlayfs-etc" + inherit_defer ${IMGCLASSES} + +The :ref:`ref-classes-image_types` class also handles conversion and compression of images. + +.. note:: + + To build a VMware VMDK image, you need to add "wic.vmdk" to + :term:`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`` +============== + +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-insane: + +``insane`` +========== + +The :ref:`ref-classes-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 +are meant to detect real or potential problems in the packaged +output. So exercise caution when disabling these checks. + +The tests you can list with the :term:`WARN_QA` and +:term:`ERROR_QA` variables are: + +- ``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. Not only can these leak information about + the build environment, they also hinder binary reproducibility. + +- ``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:`ref-classes-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 + :term:`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. + +- ``configure-gettext:`` Checks that if a recipe is building something + that uses automake and the automake files contain an ``AM_GNU_GETTEXT`` + directive, that the recipe also inherits the :ref:`ref-classes-gettext` + class to ensure that gettext is available during the build. + +- ``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. + +- ``cve_status_not_in_db:`` Checks for each component if CVEs that are ignored + via :term:`CVE_STATUS`, that those are (still) reported for this component + in the NIST database. If not, a warning is printed. This check is disabled + by default. + +- ``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. In very rare + cases, such as dynamically loaded modules, these symlinks + are needed instead in the main package. + +- ``empty-dirs:`` Checks that packages are not installing files to + directories that are normally expected to be empty (such as ``/tmp``) + The list of directories that are checked is specified by the + :term:`QA_EMPTY_DIRS` variable. + +- ``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 :ref:`ref-tasks-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 + :ref:`ref-tasks-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 :term:`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 :term:`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``. + +- ``mime:`` Check that if a package contains mime type files (``.xml`` + files in ``${datadir}/mime/packages``) that the recipe also inherits + the :ref:`ref-classes-mime` class in order to ensure that these get + properly installed. + +- ``mime-xdg:`` Checks that if a package contains a .desktop file with a + 'MimeType' key present, that the recipe inherits the + :ref:`ref-classes-mime-xdg` class that is required in order for that + to be activated. + +- ``missing-update-alternatives:`` Check that if a recipe sets the + :term:`ALTERNATIVE` variable that the recipe also inherits + :ref:`ref-classes-update-alternatives` such that the alternative will + be correctly set up. + +- ``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. + +- ``patch-fuzz:`` Checks for fuzz in patch files that may allow + them to apply incorrectly if the underlying code changes. + +- ``patch-status-core:`` Checks that the Upstream-Status is specified + and valid in the headers of patches for recipes in the OE-Core layer. + +- ``patch-status-noncore:`` Checks that the Upstream-Status is specified + and valid in the headers of patches for recipes in layers other than + OE-Core. + +- ``perllocalpod:`` Checks for ``perllocal.pod`` being erroneously + installed and packaged by a recipe. + +- ``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 :term:`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 :term:`PN` value matches something already in :term:`OVERRIDES` (e.g. + :term:`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 :term:`TMPDIR`. If this test fails, bad ``-rpath`` + options are being passed to the linker commands and your binaries + have potential security issues. + +- ``shebang-size:`` Check that the shebang line (``#!`` in the first line) + in a packaged script is not longer than 128 characters, which can cause + an error at runtime depending on the operating system. + +- ``split-strip:`` Reports that splitting or stripping debug symbols + from binaries has failed. + +- ``staticdev:`` Checks for static library files (``*.a``) in + non-``staticdev`` packages. + +- ``src-uri-bad:`` Checks that the :term:`SRC_URI` value set by a recipe + does not contain a reference to ``${PN}`` (instead of the correct + ``${BPN}``) nor refers to unstable Github archive tarballs. + +- ``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. + +- ``unhandled-features-check:`` check that if one of the variables that + the :ref:`ref-classes-features_check` class supports (e.g. + :term:`REQUIRED_DISTRO_FEATURES`) is set by a recipe, then the recipe + also inherits :ref:`ref-classes-features_check` in order for the + requirement to actually work. + +- ``unimplemented-ptest:`` Checks that ptests are implemented for upstream + tests. + +- ``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. + +- ``usrmerge:`` If ``usrmerge`` is in :term:`DISTRO_FEATURES`, this + check will ensure that no package installs files to root (``/bin``, + ``/sbin``, ``/lib``, ``/lib64``) directories. + +- ``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 the :ref:`ref-classes-buildhistory` + class 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:: + + This is only relevant when you are using runtime package management + on your target system. + +- ``virtual-slash:`` Checks to see if ``virtual/`` is being used in + :term:`RDEPENDS` or :term:`RPROVIDES`, which is not good practice --- + ``virtual/`` is a convention intended for use in the build context + (i.e. :term:`PROVIDES` and :term:`DEPENDS`) rather than the runtime + context. + +- ``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-kernel: + +``kernel`` +========== + +The :ref:`ref-classes-kernel` class handles building Linux kernels. The class contains +code to build all kernel trees. All needed headers are staged into the +:term:`STAGING_KERNEL_DIR` directory to allow out-of-tree module builds +using the :ref:`ref-classes-module` class. + +If a file named ``defconfig`` is listed in :term:`SRC_URI`, then by default +:ref:`ref-tasks-configure` copies it as ``.config`` in the build directory, +so it is automatically used as the kernel configuration for the build. This +copy is not performed in case ``.config`` already exists there: this allows +recipes to produce a configuration by other means in +``do_configure:prepend``. + +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 :ref:`ref-classes-kernel` class contains logic that allows you to embed an initial +RAM filesystem (:term:`Initramfs`) image when you build the kernel image. For +information on how to build an :term:`Initramfs`, see the +":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section in +the Yocto Project Development Tasks Manual. + +Various other classes are used by the :ref:`ref-classes-kernel` and :ref:`ref-classes-module` classes +internally including the :ref:`ref-classes-kernel-arch`, :ref:`ref-classes-module-base`, and +:ref:`ref-classes-linux-kernel-base` classes. + +.. _ref-classes-kernel-arch: + +``kernel-arch`` +=============== + +The :ref:`ref-classes-kernel-arch` class sets the ``ARCH`` environment variable for +Linux kernel compilation (including modules). + +.. _ref-classes-kernel-devicetree: + +``kernel-devicetree`` +===================== + +The :ref:`ref-classes-kernel-devicetree` class, which is inherited by the +:ref:`ref-classes-kernel` class, supports device tree generation. + +Its behavior is mainly controlled by the following variables: + +- :term:`KERNEL_DEVICETREE_BUNDLE`: whether to bundle the kernel and device tree +- :term:`KERNEL_DTBDEST`: directory where to install DTB files +- :term:`KERNEL_DTBVENDORED`: whether to keep vendor subdirectories +- :term:`KERNEL_DTC_FLAGS`: flags for ``dtc``, the Device Tree Compiler +- :term:`KERNEL_PACKAGE_NAME`: base name of the kernel packages + +.. _ref-classes-kernel-fitimage: + +``kernel-fitimage`` +=================== + +The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image, +device trees, a U-boot script, an :term:`Initramfs` bundle and a RAM disk +into a single FIT image. In theory, a FIT image can support any number +of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees. +However, :ref:`ref-classes-kernel-fitimage` currently only supports +limited usecases: just one kernel image, an optional U-boot script, +an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of +device trees. + +To create a FIT image, it is required that :term:`KERNEL_CLASSES` +is set to include ":ref:`ref-classes-kernel-fitimage`" and one of :term:`KERNEL_IMAGETYPE`, +:term:`KERNEL_ALT_IMAGETYPE` or :term:`KERNEL_IMAGETYPES` to include "fitImage". + +The options for the device tree compiler passed to ``mkimage -D`` +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 +:ref:`ref-classes-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`. Setting :term:`FIT_ADDRESS_CELLS` to "2" +is necessary if such addresses are 64 bit ones. + +Multiple device trees can be added to the FIT image created by +:ref:`ref-classes-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 +:ref:`ref-classes-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 the FIT image when +:term:`INITRAMFS_IMAGE` is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` +is not set to 1. + +Only a single :term:`Initramfs` bundle can be added to the FIT image created by +:ref:`ref-classes-kernel-fitimage` and the :term:`Initramfs` bundle in FIT is optional. +In case of :term:`Initramfs`, the kernel is configured to be bundled with the root filesystem +in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin). +When the kernel is copied to RAM and executed, it unpacks the :term:`Initramfs` root filesystem. +The :term:`Initramfs` bundle can be enabled when :term:`INITRAMFS_IMAGE` +is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. +The address where the :term:`Initramfs` bundle is to be loaded by U-boot is specified +by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`. + +Only a single U-boot boot script can be added to the FIT image created by +:ref:`ref-classes-kernel-fitimage` and the boot script is optional. +The boot script is specified in the ITS file as a text file containing +U-boot commands. When using a boot script the user should configure the +U-boot :ref:`ref-tasks-install` task to copy the script to sysroot. +So the script can be included in the FIT image by the :ref:`ref-classes-kernel-fitimage` +class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to +load the boot script from the FIT image and execute it. + +The FIT image generated by the :ref:`ref-classes-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 :ref:`ref-classes-kernel-fitimage` are "sha256" and +"rsa2048" respectively. The keys for signing the FIT image can be generated using +the :ref:`ref-classes-kernel-fitimage` class when both :term:`FIT_GENERATE_KEYS` and +:term:`UBOOT_SIGN_ENABLE` are set to "1". + + +.. _ref-classes-kernel-grub: + +``kernel-grub`` +=============== + +The :ref:`ref-classes-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`` +======================= + +The :ref:`ref-classes-kernel-module-split` class provides common functionality for +splitting Linux kernel modules into separate packages. + +.. _ref-classes-kernel-uboot: + +``kernel-uboot`` +================ + +The :ref:`ref-classes-kernel-uboot` class provides support for building from +vmlinux-style kernel sources. + +.. _ref-classes-kernel-uimage: + +``kernel-uimage`` +================= + +The :ref:`ref-classes-kernel-uimage` class provides support to pack uImage. + +.. _ref-classes-kernel-yocto: + +``kernel-yocto`` +================ + +The :ref:`ref-classes-kernel-yocto` class provides common functionality for building +from linux-yocto style kernel source repositories. + +.. _ref-classes-kernelsrc: + +``kernelsrc`` +============= + +The :ref:`ref-classes-kernelsrc` class sets the Linux kernel source and version. + +.. _ref-classes-lib_package: + +``lib_package`` +=============== + +The :ref:`ref-classes-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*`` +========= + +The :ref:`ref-classes-libc*` classes support recipes that build packages with ``libc``: + +- The :ref:`libc-common <ref-classes-libc*>` class provides common support for building with + ``libc``. + +- The :ref:`libc-package <ref-classes-libc*>` class supports packaging up ``glibc`` and + ``eglibc``. + +.. _ref-classes-license: + +``license`` +=========== + +The :ref:`ref-classes-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`` +===================== + +The :ref:`ref-classes-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`` +=============== + +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`` +=========== + +The :ref:`ref-classes-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 :ref:`ref-classes-base` +class. + +.. _ref-classes-meson: + +``meson`` +========= + +The :ref:`ref-classes-meson` class allows to create recipes that build software +using the `Meson <https://mesonbuild.com/>`__ build system. You can use the +:term:`MESON_BUILDTYPE`, :term:`MESON_TARGET` and :term:`EXTRA_OEMESON` +variables to specify additional configuration options to be passed using the +``meson`` command line. + +.. _ref-classes-metadata_scm: + +``metadata_scm`` +================ + +The :ref:`ref-classes-metadata_scm` class provides functionality for querying the +branch and revision of a Source Code Manager (SCM) repository. + +The :ref:`ref-classes-base` class uses this class to print the revisions of +each layer before starting every build. The :ref:`ref-classes-metadata_scm` +class is enabled by default because it is inherited by the +:ref:`ref-classes-base` class. + +.. _ref-classes-migrate_localcount: + +``migrate_localcount`` +====================== + +The :ref:`ref-classes-migrate_localcount` class verifies a recipe's localcount data and +increments it appropriately. + +.. _ref-classes-mime: + +``mime`` +======== + +The :ref:`ref-classes-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-mime-xdg: + +``mime-xdg`` +============ + +The :ref:`ref-classes-mime-xdg` class generates the proper +post-install and post-remove (postinst/postrm) scriptlets for packages +that install ``.desktop`` files containing ``MimeType`` entries. +These scriptlets call ``update-desktop-database`` to add the MIME types +to the database of MIME types handled by desktop files. + +Thanks to this class, when users open a file through a file browser +on recently created images, they don't have to choose the application +to open the file from the pool of all known applications, even the ones +that cannot open the selected file. + +If you have recipes installing their ``.desktop`` files as absolute +symbolic links, the detection of such files cannot be done by the current +implementation of this class. In this case, you have to add the corresponding +package names to the :term:`MIME_XDG_PACKAGES` variable. + +.. _ref-classes-mirrors: + +``mirrors`` +=========== + +The :ref:`ref-classes-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:`ref-classes-base` class. + +.. _ref-classes-module: + +``module`` +========== + +The :ref:`ref-classes-module` class provides support for building out-of-tree Linux +kernel modules. The class inherits the :ref:`ref-classes-module-base` and +:ref:`ref-classes-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`` +=============== + +The :ref:`ref-classes-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:`ref-classes-module` +class. + +.. _ref-classes-multilib*: + +``multilib*`` +============= + +The :ref:`ref-classes-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/libraries:combining multiple versions of library files into one image`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-native: + +``native`` +========== + +The :ref:`ref-classes-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 :ref:`ref-classes-native` + class. If you use this method, you must order the inherit statement + in the recipe after all other inherit statements so that the + :ref:`ref-classes-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 :ref:`ref-classes-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`` +============= + +The :ref:`ref-classes-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 + :ref:`ref-classes-nativesdk` class. If you use this method, you must order the + inherit statement in the recipe after all other inherit statements so + that the :ref:`ref-classes-nativesdk` class is inherited last. + +- Create a :ref:`ref-classes-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 there is code that + depends on the naming convention. + +Although applied differently, the :ref:`ref-classes-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`` +============== + +Disables packaging tasks for those recipes and classes where packaging +is not needed. + +.. _ref-classes-npm: + +``npm`` +======= + +Provides support for building Node.js software fetched using the +:wikipedia:`node package manager (NPM) <Npm_(software)>`. + +.. 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/packages:creating node package manager (npm) packages`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-oelint: + +``oelint`` +========== + +The :ref:`ref-classes-oelint` class is an obsolete lint checking tool available in +``meta/classes`` in the :term:`Source Directory`. + +There are some classes that could be generally useful in OE-Core but +are never actually used within OE-Core itself. The :ref:`ref-classes-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-overlayfs: + +``overlayfs`` +============= + +It's often desired in Embedded System design to have a read-only root filesystem. +But a lot of different applications might want to have read-write access to +some parts of a filesystem. It can be especially useful when your update mechanism +overwrites the whole root filesystem, but you may want your application data to be preserved +between updates. The :ref:`ref-classes-overlayfs` class provides a way +to achieve that by means of ``overlayfs`` and at the same time keeping the base +root filesystem read-only. + +To use this class, set a mount point for a partition ``overlayfs`` is going to use as upper +layer in your machine configuration. The underlying file system can be anything that +is supported by ``overlayfs``. This has to be done in your machine configuration:: + + OVERLAYFS_MOUNT_POINT[data] = "/data" + +.. note:: + + * QA checks fail to catch file existence if you redefine this variable in your recipe! + * Only the existence of the systemd mount unit file is checked, not its contents. + * To get more details on ``overlayfs``, its internals and supported operations, please refer + to the official documentation of the `Linux kernel <https://www.kernel.org/doc/html/latest/filesystems/overlayfs.html>`__. + +The class assumes you have a ``data.mount`` systemd unit defined elsewhere in your BSP +(e.g. in ``systemd-machine-units`` recipe) and it's installed into the image. + +Then you can specify writable directories on a recipe basis (e.g. in my-application.bb):: + + OVERLAYFS_WRITABLE_PATHS[data] = "/usr/share/my-custom-application" + +To support several mount points you can use a different variable flag. Assuming we +want to have a writable location on the file system, but do not need that the data +survives a reboot, then we could have a ``mnt-overlay.mount`` unit for a ``tmpfs`` +file system. + +In your machine configuration:: + + OVERLAYFS_MOUNT_POINT[mnt-overlay] = "/mnt/overlay" + +and then in your recipe:: + + OVERLAYFS_WRITABLE_PATHS[mnt-overlay] = "/usr/share/another-application" + +On a practical note, your application recipe might require multiple +overlays to be mounted before running to avoid writing to the underlying +file system (which can be forbidden in case of read-only file system) +To achieve that :ref:`ref-classes-overlayfs` provides a ``systemd`` +helper service for mounting overlays. This helper service is named +``${PN}-overlays.service`` and can be depended on in your application recipe +(named ``application`` in the following example) ``systemd`` unit by adding +to the unit the following:: + + [Unit] + After=application-overlays.service + Requires=application-overlays.service + +.. note:: + + The class does not support the ``/etc`` directory itself, because ``systemd`` depends on it. + In order to get ``/etc`` in overlayfs, see :ref:`ref-classes-overlayfs-etc`. + +.. _ref-classes-overlayfs-etc: + +``overlayfs-etc`` +================= + +In order to have the ``/etc`` directory in overlayfs a special handling at early +boot stage is required. The idea is to supply a custom init script that mounts +``/etc`` before launching the actual init program, because the latter already +requires ``/etc`` to be mounted. + +Example usage in image recipe:: + + IMAGE_FEATURES += "overlayfs-etc" + +.. note:: + + This class must not be inherited directly. Use :term:`IMAGE_FEATURES` or :term:`EXTRA_IMAGE_FEATURES` + +Your machine configuration should define at least the device, mount point, and file system type +you are going to use for ``overlayfs``:: + + OVERLAYFS_ETC_MOUNT_POINT = "/data" + OVERLAYFS_ETC_DEVICE = "/dev/mmcblk0p2" + OVERLAYFS_ETC_FSTYPE ?= "ext4" + +To control more mount options you should consider setting mount options +(``defaults`` is used by default):: + + OVERLAYFS_ETC_MOUNT_OPTIONS = "wsync" + +The class provides two options for ``/sbin/init`` generation: + +- The default option is to rename the original ``/sbin/init`` to ``/sbin/init.orig`` + and place the generated init under original name, i.e. ``/sbin/init``. It has an advantage + that you won't need to change any kernel parameters in order to make it work, + but it poses a restriction that package-management can't be used, because updating + the init manager would remove the generated script. + +- If you wish to keep original init as is, you can set:: + + OVERLAYFS_ETC_USE_ORIG_INIT_NAME = "0" + + Then the generated init will be named ``/sbin/preinit`` and you would need to extend your + kernel parameters manually in your bootloader configuration. + +.. _ref-classes-own-mirrors: + +``own-mirrors`` +=============== + +The :ref:`ref-classes-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 :term:`SOURCE_MIRROR_URL`. + +.. _ref-classes-package: + +``package`` +=========== + +The :ref:`ref-classes-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:`ref-classes-package_deb`, +:ref:`ref-classes-package_rpm`, :ref:`ref-classes-package_ipk`. + +You can control the list of resulting package formats by using the +:term:`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/packages: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 :term:`PACKAGE_CLASSES` to +":ref:`ref-classes-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`` +=============== + +The :ref:`ref-classes-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:`ref-classes-package` class and +is enabled through the :term:`PACKAGE_CLASSES` +variable in the ``local.conf`` file. + +.. _ref-classes-package_ipk: + +``package_ipk`` +=============== + +The :ref:`ref-classes-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:`ref-classes-package` class and +is enabled through the :term:`PACKAGE_CLASSES` +variable in the ``local.conf`` file. + +.. _ref-classes-package_rpm: + +``package_rpm`` +=============== + +The :ref:`ref-classes-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:`ref-classes-package` class and +is enabled through the :term:`PACKAGE_CLASSES` +variable in the ``local.conf`` file. + +.. _ref-classes-packagedata: + +``packagedata`` +=============== + +The :ref:`ref-classes-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:`ref-classes-package` class. + +.. _ref-classes-packagegroup: + +``packagegroup`` +================ + +The :ref:`ref-classes-packagegroup` class sets default values appropriate for package +group recipes (e.g. :term:`PACKAGES`, :term:`PACKAGE_ARCH`, :term:`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/customizing-images: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`` +========= + +The :ref:`ref-classes-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:`ref-classes-base` class. + +.. _ref-classes-perlnative: + +``perlnative`` +============== + +When inherited by a recipe, the :ref:`ref-classes-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-pypi: + +``pypi`` +======== + +The :ref:`ref-classes-pypi` class sets variables appropriately for recipes that build +Python modules from `PyPI <https://pypi.org/>`__, the Python Package Index. +By default it determines the PyPI package name based upon :term:`BPN` +(stripping the "python-" or "python3-" prefix off if present), however in +some cases you may need to set it manually in the recipe by setting +:term:`PYPI_PACKAGE`. + +Variables set by the :ref:`ref-classes-pypi` class include :term:`SRC_URI`, :term:`SECTION`, +:term:`HOMEPAGE`, :term:`UPSTREAM_CHECK_URI`, :term:`UPSTREAM_CHECK_REGEX` +and :term:`CVE_PRODUCT`. + +.. _ref-classes-python_flit_core: + +``python_flit_core`` +==================== + +The :ref:`ref-classes-python_flit_core` class enables building Python modules which declare +the `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`__ compliant +``flit_core.buildapi`` ``build-backend`` in the ``[build-system]`` +section of ``pyproject.toml`` (See `PEP-518 <https://www.python.org/dev/peps/pep-0518/>`__). + +Python modules built with ``flit_core.buildapi`` are pure Python (no +``C`` or ``Rust`` extensions). + +Internally this uses the :ref:`ref-classes-python_pep517` class. + +.. _ref-classes-python_maturin: + +``python_maturin`` +================== + +The :ref:`ref-classes-python_maturin` class provides support for python-maturin, a replacement +for setuptools_rust and another "backend" for building Python Wheels. + +.. _ref-classes-python_mesonpy: + +``python_mesonpy`` +================== + +The :ref:`ref-classes-python_mesonpy` class enables building Python modules which use the +meson-python build system. + +Internally this uses the :ref:`ref-classes-python_pep517` class. + +.. _ref-classes-python_pep517: + +``python_pep517`` +================= + +The :ref:`ref-classes-python_pep517` class builds and installs a Python ``wheel`` binary +archive (see `PEP-517 <https://peps.python.org/pep-0517/>`__). + +Recipes wouldn't inherit this directly, instead typically another class will +inherit this and add the relevant native dependencies. + +Examples of classes which do this are :ref:`ref-classes-python_flit_core`, +:ref:`ref-classes-python_setuptools_build_meta`, and +:ref:`ref-classes-python_poetry_core`. + +.. _ref-classes-python_poetry_core: + +``python_poetry_core`` +====================== + +The :ref:`ref-classes-python_poetry_core` class enables building Python modules which use the +`Poetry Core <https://python-poetry.org>`__ build system. + +Internally this uses the :ref:`ref-classes-python_pep517` class. + +.. _ref-classes-python_pyo3: + +``python_pyo3`` +=============== + +The :ref:`ref-classes-python_pyo3` class helps make sure that Python extensions +written in Rust and built with `PyO3 <https://pyo3.rs/>`__, properly set up the +environment for cross compilation. + +This class is internal to the :ref:`ref-classes-python-setuptools3_rust` class +and is not meant to be used directly in recipes. + +.. _ref-classes-python-setuptools3_rust: + +``python-setuptools3_rust`` +=========================== + +The :ref:`ref-classes-python-setuptools3_rust` class enables building Python +extensions implemented in Rust with `PyO3 <https://pyo3.rs/>`__, which allows +to compile and distribute Python extensions written in Rust as easily +as if they were written in C. + +This class inherits the :ref:`ref-classes-setuptools3` and +:ref:`ref-classes-python_pyo3` classes. + +.. _ref-classes-pixbufcache: + +``pixbufcache`` +=============== + +The :ref:`ref-classes-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`` +============= + +The :ref:`ref-classes-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 :ref:`ref-classes-pkgconfig` class no longer has to manipulate the +files. + +.. _ref-classes-populate-sdk: + +``populate_sdk`` +================ + +The :ref:`ref-classes-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_*`` +================== + +The :ref:`ref-classes-populate-sdk-*` classes support SDK creation and consist of the +following classes: + +- :ref:`populate_sdk_base <ref-classes-populate-sdk-*>`: The base class supporting SDK creation under + all package managers (i.e. DEB, RPM, and opkg). + +- :ref:`populate_sdk_deb <ref-classes-populate-sdk-*>`: Supports creation of the SDK given the Debian + package manager. + +- :ref:`populate_sdk_rpm <ref-classes-populate-sdk-*>`: Supports creation of the SDK given the RPM + package manager. + +- :ref:`populate_sdk_ipk <ref-classes-populate-sdk-*>`: Supports creation of the SDK given the opkg + (IPK format) package manager. + +- :ref:`populate_sdk_ext <ref-classes-populate-sdk-*>`: Supports extensible SDK creation under all + package managers. + +The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` 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 +:ref:`populate_sdk_base <ref-classes-populate-sdk-*>` 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 :ref:`populate_sdk_deb <ref-classes-populate-sdk-*>`, :ref:`populate_sdk_rpm <ref-classes-populate-sdk-*>`, and +:ref:`populate_sdk_ipk <ref-classes-populate-sdk-*>` classes each support the specific type of SDK. +These classes are inherited by and used with the :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` +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`` +============ + +The :ref:`ref-classes-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`` +============ + +The :ref:`ref-classes-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`` +========== + +The :ref:`ref-classes-prserv` class provides functionality for using a :ref:`PR +service <dev-manual/packages:working with a 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:`ref-classes-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`` +========= + +The :ref:`ref-classes-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/packages:testing packages with ptest`" +section in the Yocto Project Development Tasks Manual for more information +on ptest. + +.. _ref-classes-ptest-cargo: + +``ptest-cargo`` +=============== + +The :ref:`ref-classes-ptest-cargo` class is a class which extends the +:ref:`ref-classes-cargo` class and adds ``compile_ptest_cargo`` and +``install_ptest_cargo`` steps to respectively build and install +test suites defined in the ``Cargo.toml`` file, into a dedicated +``-ptest`` package. + +.. _ref-classes-ptest-gnome: + +``ptest-gnome`` +=============== + +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/packages:testing packages with ptest`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-python3-dir: + +``python3-dir`` +=============== + +The :ref:`ref-classes-python3-dir` class provides the base version, location, and site +package location for Python 3. + +.. _ref-classes-python3native: + +``python3native`` +================= + +The :ref:`ref-classes-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-python3targetconfig: + +``python3targetconfig`` +======================= + +The :ref:`ref-classes-python3targetconfig` 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, except that the configuration for the target machine +is accessible (such as correct installation directories). This also adds a +dependency on target ``python3``, so should only be used where appropriate +in order to avoid unnecessarily lengthening builds. + +.. _ref-classes-qemu: + +``qemu`` +======== + +The :ref:`ref-classes-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`` +================= + +The :ref:`ref-classes-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`` +=============== + +The :ref:`ref-classes-relocatable` class enables relocation of binaries when they are +installed into the sysroot. + +This class makes use of the :ref:`ref-classes-chrpath` class and is used by +both the :ref:`ref-classes-cross` and :ref:`ref-classes-native` classes. + +.. _ref-classes-remove-libtool: + +``remove-libtool`` +================== + +The :ref:`ref-classes-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 :ref:`ref-classes-remove-libtool` class is not enabled by default. + +.. _ref-classes-report-error: + +``report-error`` +================ + +The :ref:`ref-classes-report-error` class supports enabling the :ref:`error reporting +tool <dev-manual/error-reporting-tool:using the 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`` +=========== + +The :ref:`ref-classes-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 :ref:`ref-classes-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 :ref:`ref-classes-rm-work` will potentially result in your +changes to the source being lost. To exclude some recipes from having their work +directories deleted by :ref:`ref-classes-rm-work`, you can add the names of the +recipe or recipes you are working on to the :term:`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*`` +=========== + +The :ref:`ref-classes-rootfs*` classes support creating the root filesystem for an +image and consist of the following classes: + +- The :ref:`rootfs-postcommands <ref-classes-rootfs*>` class, which defines filesystem + post-processing functions for image recipes. + +- The :ref:`rootfs_deb <ref-classes-rootfs*>` class, which supports creation of root filesystems + for images built using ``.deb`` packages. + +- The :ref:`rootfs_rpm <ref-classes-rootfs*>` class, which supports creation of root filesystems + for images built using ``.rpm`` packages. + +- The :ref:`rootfs_ipk <ref-classes-rootfs*>` class, which supports creation of root filesystems + for images built using ``.ipk`` packages. + +- The :ref:`rootfsdebugfiles <ref-classes-rootfs*>` 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 +:ref:`ref-classes-rootfs*` 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-rust: + +``rust`` +======== + +The :ref:`ref-classes-rust` class is an internal class which is just used +in the "rust" recipe, to build the Rust compiler and runtime +library. Except for this recipe, it is not intended to be used directly. + +.. _ref-classes-rust-common: + +``rust-common`` +=============== + +The :ref:`ref-classes-rust-common` class is an internal class to the +:ref:`ref-classes-cargo_common` and :ref:`ref-classes-rust` classes and is not +intended to be used directly. + +.. _ref-classes-sanity: + +``sanity`` +========== + +The :ref:`ref-classes-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`` +========= + +The :ref:`ref-classes-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`` +======= + +The :ref:`ref-classes-sdl` class supports recipes that need to build software that uses +the Simple DirectMedia Layer (SDL) library. + +.. _ref-classes-python_setuptools_build_meta: + +``python_setuptools_build_meta`` +================================ + +The :ref:`ref-classes-python_setuptools_build_meta` class enables building +Python modules which declare the +`PEP-517 <https://www.python.org/dev/peps/pep-0517/>`__ compliant +``setuptools.build_meta`` ``build-backend`` in the ``[build-system]`` +section of ``pyproject.toml`` (See `PEP-518 <https://www.python.org/dev/peps/pep-0518/>`__). + +Python modules built with ``setuptools.build_meta`` can be pure Python or +include ``C`` or ``Rust`` extensions). + +Internally this uses the :ref:`ref-classes-python_pep517` class. + +.. _ref-classes-setuptools3: + +``setuptools3`` +=============== + +The :ref:`ref-classes-setuptools3` class supports Python version 3.x extensions +that use build systems based on ``setuptools`` (e.g. only have a ``setup.py`` +and have not migrated to the official ``pyproject.toml`` format). If your recipe +uses these build systems, the recipe needs to inherit the +:ref:`ref-classes-setuptools3` class. + + .. note:: + + The :ref:`ref-classes-setuptools3` class :ref:`ref-tasks-compile` task now calls + ``setup.py bdist_wheel`` to build the ``wheel`` binary archive format + (See `PEP-427 <https://www.python.org/dev/peps/pep-0427/>`__). + + A consequence of this is that legacy software still using deprecated + ``distutils`` from the Python standard library cannot be packaged as + ``wheels``. A common solution is the replace + ``from distutils.core import setup`` with ``from setuptools import setup``. + + .. note:: + + The :ref:`ref-classes-setuptools3` class :ref:`ref-tasks-install` task now + installs the ``wheel`` binary archive. In current versions of + ``setuptools`` the legacy ``setup.py install`` method is deprecated. If + the ``setup.py`` cannot be used with wheels, for example it creates files + outside of the Python module or standard entry points, then + :ref:`ref-classes-setuptools3_legacy` should be used. + +.. _ref-classes-setuptools3_legacy: + +``setuptools3_legacy`` +====================== + +The :ref:`ref-classes-setuptools3_legacy` class supports +Python version 3.x extensions that use build systems based on ``setuptools`` +(e.g. only have a ``setup.py`` and have not migrated to the official +``pyproject.toml`` format). Unlike :ref:`ref-classes-setuptools3`, +this uses the traditional ``setup.py`` ``build`` and ``install`` commands and +not wheels. This use of ``setuptools`` like this is +`deprecated <https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v5830>`__ +but still relatively common. + +.. _ref-classes-setuptools3-base: + +``setuptools3-base`` +==================== + +The :ref:`ref-classes-setuptools3-base` class provides a reusable base for +other classes that support building Python version 3.x extensions. If you need +functionality that is not provided by the :ref:`ref-classes-setuptools3` class, +you may want to ``inherit setuptools3-base``. Some recipes do not need the tasks +in the :ref:`ref-classes-setuptools3` class and inherit this class instead. + +.. _ref-classes-sign_rpm: + +``sign_rpm`` +============ + +The :ref:`ref-classes-sign_rpm` class supports generating signed RPM packages. + +.. _ref-classes-siteconfig: + +``siteconfig`` +============== + +The :ref:`ref-classes-siteconfig` class provides functionality for handling site +configuration. The class is used by the :ref:`ref-classes-autotools` class to +accelerate the :ref:`ref-tasks-configure` task. + +.. _ref-classes-siteinfo: + +``siteinfo`` +============ + +The :ref:`ref-classes-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 :term:`CONFIG_SITE` variable that +Autotools automatically picks up. + +The class also provides variables like :term:`SITEINFO_ENDIANNESS` and +:term:`SITEINFO_BITS` that can be used elsewhere in the metadata. + +.. _ref-classes-sstate: + +``sstate`` +========== + +The :ref:`ref-classes-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`` +=========== + +The :ref:`ref-classes-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 :ref:`ref-classes-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 :ref:`ref-tasks-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_IGNORE` + variables. + + .. note:: + + Additionally, a recipe can customize the files further by + declaring a processing function in the :term:`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 :term:`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 + :term:`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:`ref-classes-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`` +============ + +The :ref:`ref-classes-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`` +=========== + +The :ref:`ref-classes-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 :ref:`ref-classes-systemd`, see the +":ref:`dev-manual/init-manager:selecting an initialization manager`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-systemd-boot: + +``systemd-boot`` +================ + +The :ref:`ref-classes-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 :ref:`ref-classes-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 ":ref:`ref-classes-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 <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__ +for more information. + +.. _ref-classes-terminal: + +``terminal`` +============ + +The :ref:`ref-classes-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 :ref:`ref-classes-terminal` class anywhere a separate +terminal session needs to be started. For example, the :ref:`ref-classes-patch` +class assuming :term:`PATCHRESOLVE` is set to "user", the +:ref:`ref-classes-cml1` class, and the :ref:`ref-classes-devshell` class all +use the :ref:`ref-classes-terminal` class. + +.. _ref-classes-testimage: + +``testimage`` +============= + +The :ref:`ref-classes-testimage` class supports 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. + +To enable this class, add the following to your configuration:: + + IMAGE_CLASSES += "testimage" + +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 :ref:`ref-classes-testimage` class runs tests on an image when called using the +following:: + + $ bitbake -c testimage image + +Alternatively, if you wish to have tests automatically run for each image +after it is built, you can set :term:`TESTIMAGE_AUTO`:: + + TESTIMAGE_AUTO = "1" + +For information on how to enable, run, and create new tests, see the +":ref:`dev-manual/runtime-testing:performing automated runtime testing`" +section in the Yocto Project Development Tasks Manual. + +.. _ref-classes-testsdk: + +``testsdk`` +=========== + +This class supports running automated tests against software development +kits (SDKs). The :ref:`ref-classes-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 :ref:`ref-classes-testsdk` class for automated SDK + testing. + +.. _ref-classes-texinfo: + +``texinfo`` +=========== + +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`` +=========== + +The :ref:`ref-classes-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`` +===================== + +The :ref:`ref-classes-toolchain-scripts` class provides the scripts used for setting up +the environment for installed SDKs. + +.. _ref-classes-typecheck: + +``typecheck`` +============= + +The :ref:`ref-classes-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`` +================ + +The :ref:`ref-classes-uboot-config` class provides support for U-Boot configuration for +a machine. Specify the machine in your recipe as follows:: + + UBOOT_CONFIG ??= <default> + UBOOT_CONFIG[foo] = "config,images,binary" + +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-uboot-sign: + +``uboot-sign`` +============== + +The :ref:`ref-classes-uboot-sign` class provides support for U-Boot verified boot. +It is intended to be inherited from U-Boot recipes. + +The variables used by this class are: + +- :term:`SPL_MKIMAGE_DTCOPTS`: DTC options for U-Boot ``mkimage`` when + building the FIT image. +- :term:`SPL_SIGN_ENABLE`: enable signing the FIT image. +- :term:`SPL_SIGN_KEYDIR`: directory containing the signing keys. +- :term:`SPL_SIGN_KEYNAME`: base filename of the signing keys. +- :term:`UBOOT_FIT_ADDRESS_CELLS`: ``#address-cells`` value for the FIT image. +- :term:`UBOOT_FIT_DESC`: description string encoded into the FIT image. +- :term:`UBOOT_FIT_GENERATE_KEYS`: generate the keys if they don't exist yet. +- :term:`UBOOT_FIT_HASH_ALG`: hash algorithm for the FIT image. +- :term:`UBOOT_FIT_KEY_GENRSA_ARGS`: ``openssl genrsa`` arguments. +- :term:`UBOOT_FIT_KEY_REQ_ARGS`: ``openssl req`` arguments. +- :term:`UBOOT_FIT_SIGN_ALG`: signature algorithm for the FIT image. +- :term:`UBOOT_FIT_SIGN_NUMBITS`: size of the private key for FIT image + signing. +- :term:`UBOOT_FIT_KEY_SIGN_PKCS`: algorithm for the public key certificate + for FIT image signing. +- :term:`UBOOT_FITIMAGE_ENABLE`: enable the generation of a U-Boot FIT image. +- :term:`UBOOT_MKIMAGE_DTCOPTS`: DTC options for U-Boot ``mkimage`` when + rebuilding the FIT image containing the kernel. + +See U-Boot's documentation for details about `verified boot +<https://source.denx.de/u-boot/u-boot/-/blob/master/doc/uImage.FIT/verified-boot.txt>`__ +and the `signature process +<https://source.denx.de/u-boot/u-boot/-/blob/master/doc/uImage.FIT/signature.txt>`__. + +See also the description of :ref:`ref-classes-kernel-fitimage` class, which this class +imitates. + +.. _ref-classes-uninative: + +``uninative`` +============= + +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 :ref:`ref-classes-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`` +======================= + +The :ref:`ref-classes-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 +:ref:`ref-classes-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 </poky/tree/meta/classes-recipe/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`` +=============== + +The :ref:`ref-classes-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: :term:`INITSCRIPT_PACKAGES`, +:term:`INITSCRIPT_NAME` and :term:`INITSCRIPT_PARAMS`. See the variable links +for details. + +.. _ref-classes-useradd: + +``useradd*`` +============ + +The :ref:`useradd* <ref-classes-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 :oe_git:`meta-skeleton/recipes-skeleton/useradd/useradd-example.bb +</openembedded-core/tree/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. + +The :ref:`useradd_base <ref-classes-useradd>` class provides basic functionality for user or +groups settings. + +The :ref:`useradd* <ref-classes-useradd>` classes support the +:term:`USERADD_PACKAGES`, +:term:`USERADD_PARAM`, +:term:`GROUPADD_PARAM`, and +:term:`GROUPMEMS_PARAM` variables. + +The :ref:`useradd-staticids <ref-classes-useradd>` 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:`ref-classes-useradd` class for additional +information. + +.. note:: + + You do not use the :ref:`useradd-staticids <ref-classes-useradd>` class directly. You either enable + or disable the class by setting the :term:`USERADDEXTENSION` variable. If you + enable or disable the class in a configured system, :term:`TMPDIR` might + contain incorrect ``uid`` and ``gid`` values. Deleting the :term:`TMPDIR` + directory will correct this condition. + +.. _ref-classes-utility-tasks: + +``utility-tasks`` +================= + +The :ref:`ref-classes-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:`ref-classes-base` class. + +.. _ref-classes-utils: + +``utils`` +========= + +The :ref:`ref-classes-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:`ref-classes-base` class. + +.. _ref-classes-vala: + +``vala`` +======== + +The :ref:`ref-classes-vala` class supports recipes that need to build software written +using the Vala programming language. + +.. _ref-classes-waf: + +``waf`` +======= + +The :ref:`ref-classes-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..9319addc3c --- /dev/null +++ b/documentation/ref-manual/devtool-reference.rst @@ -0,0 +1,620 @@ +.. 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] <subcommand> ... + + 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 <subcommand> --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 + :scale: 100% + +.. 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 +":ref:`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 <devtool-adding-a-new-recipe-to-the-workspace>` 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. + +.. _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 <devtool-modifying-a-recipe>` 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, you can use the +``devtool latest-version recipe`` command, which quickly shows the current +version and the latest version available upstream. To get a more global +picture, use the ``devtool check-upgrade-status`` command, which takes a +list of recipes as input, or no arguments, in which case it checks all +available recipes. This command will only print the recipes for which +a new upstream version is available. Each such recipe will have its current +version and latest upstream version, as well as the email of the maintainer +and any additional information such as the commit hash or reason for not +being able to upgrade it, displayed in a table. + +This upgrade checking mechanism relies on the optional :term:`UPSTREAM_CHECK_URI`, +:term:`UPSTREAM_CHECK_REGEX`, :term:`UPSTREAM_CHECK_GITTAGREGEX`, +:term:`UPSTREAM_CHECK_COMMITS` and :term:`UPSTREAM_VERSION_UNKNOWN` +variables in package recipes. + +.. note:: + + - Most of the time, the above variables are unnecessary. They are only + required when upstream does something unusual, and default + mechanisms cannot find the new upstream versions. + + - For the ``oe-core`` layer, recipe maintainers come from the + :yocto_git:`maintainers.inc </poky/tree/meta/conf/distro/include/maintainers.inc>` + file. + + - If the recipe is using the :ref:`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, or in the absence of suitable tags, + to the latest commit (when :term:`UPSTREAM_CHECK_COMMITS` set to ``1`` + in the recipe). + +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. + +Here is a partial example table that reports on all the recipes:: + + $ devtool check-upgrade-status + ... + INFO: bind 9.16.20 9.16.21 Armin Kuster <akuster808@gmail.com> + INFO: inetutils 2.1 2.2 Tom Rini <trini@konsulko.com> + INFO: iproute2 5.13.0 5.14.0 Changhyeok Bae <changhyeok.bae@gmail.com> + INFO: openssl 1.1.1l 3.0.0 Alexander Kanavin <alex.kanavin@gmail.com> + INFO: base-passwd 3.5.29 3.5.51 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility + ... + +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. Maintainers can explicit the reason that is shown by adding +the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. +See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb?h=kirkstone>` +for an example:: + + RECIPE_NO_UPDATE_REASON = "Version 3.5.38 requires cdebconf for update-passwd utility" + +Last but not least, you may set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` +in a recipe when there's currently no way to determine its latest upstream +version. + +.. _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. There are several ways of upgrading recipes. +You can read about them in the ":ref:`dev-manual/upgrading-recipes: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/upgrading-recipes: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 could prevent a deployed application from +behaving as expected. When both of the following conditions are met, 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 are met, 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 <ref-manual/devtool-reference:deploying your software on the target machine>`" +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 + +Here is sample output after using +:ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>` +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/examples/hello-autotools/hello_2.3.bb b/documentation/ref-manual/examples/hello-autotools/hello_2.3.bb deleted file mode 100644 index 5dfb0b30cf..0000000000 --- a/documentation/ref-manual/examples/hello-autotools/hello_2.3.bb +++ /dev/null @@ -1,8 +0,0 @@ -DESCRIPTION = "GNU Helloworld application" -SECTION = "examples" -LICENSE = "GPLv3" -LIC_FILES_CHKSUM = "file://COPYING;md5=adefda309052235aa5d1e99ce7557010" - -SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.bz2" - -inherit autotools diff --git a/documentation/ref-manual/examples/hello-single/files/helloworld.c b/documentation/ref-manual/examples/hello-single/files/helloworld.c deleted file mode 100644 index fc7169b7b8..0000000000 --- a/documentation/ref-manual/examples/hello-single/files/helloworld.c +++ /dev/null @@ -1,8 +0,0 @@ -#include <stdio.h> - -int main(void) -{ - printf("Hello world!\n"); - - return 0; -} diff --git a/documentation/ref-manual/examples/hello-single/hello.bb b/documentation/ref-manual/examples/hello-single/hello.bb deleted file mode 100644 index 0812743e39..0000000000 --- a/documentation/ref-manual/examples/hello-single/hello.bb +++ /dev/null @@ -1,17 +0,0 @@ -DESCRIPTION = "Simple helloworld application" -SECTION = "examples" -LICENSE = "MIT" -LIC_FILES_CHKSUM = "file://${COMMON_LICENSE_DIR}/MIT;md5=0835ade698e0bcf8506ecda2f7b4f302" - -SRC_URI = "file://helloworld.c" - -S = "${WORKDIR}" - -do_compile() { - ${CC} helloworld.c -o helloworld -} - -do_install() { - install -d ${D}${bindir} - install -m 0755 helloworld ${D}${bindir} -} diff --git a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb b/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb deleted file mode 100644 index b58d4d7bd1..0000000000 --- a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb +++ /dev/null @@ -1,14 +0,0 @@ -require xorg-lib-common.inc - -DESCRIPTION = "X11 Pixmap library" -LICENSE = "X-BSD" -LIC_FILES_CHKSUM = "file://COPYING;md5=3e07763d16963c3af12db271a31abaa5" -DEPENDS += "libxext" -PR = "r2" -PE = "1" - -XORG_PN = "libXpm" - -PACKAGES =+ "sxpm cxpm" -FILES_cxpm = "${bindir}/cxpm" -FILES_sxpm = "${bindir}/sxpm" diff --git a/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb b/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb deleted file mode 100644 index 5d05a437a4..0000000000 --- a/documentation/ref-manual/examples/mtd-makefile/mtd-utils_1.0.0.bb +++ /dev/null @@ -1,15 +0,0 @@ -DESCRIPTION = "Tools for managing memory technology devices." -SECTION = "base" -DEPENDS = "zlib" -HOMEPAGE = "http://www.linux-mtd.infradead.org/" -LICENSE = "GPLv2" -LIC_FILES_CHKSUM = "file://COPYING;md5=0636e73ff0215e8d672dc4c32c317bb3 \ - file://include/common.h;beginline=1;endline=17;md5=ba05b07912a44ea2bf81ce409380049c" - -SRC_URI = "ftp://ftp.infradead.org/pub/mtd-utils/mtd-utils-${PV}.tar.gz" - -CFLAGS_prepend = "-I ${S}/include " - -do_install() { - oe_runmake install DESTDIR=${D} -} diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst new file mode 100644 index 0000000000..bab284bbfd --- /dev/null +++ b/documentation/ref-manual/faq.rst @@ -0,0 +1,456 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +*** +FAQ +*** + +.. contents:: + +General questions +================= + +How does Poky differ from OpenEmbedded? +--------------------------------------- + +The term ``Poky`` refers to the specific reference build +system that the Yocto Project provides. Poky is based on +:term:`OpenEmbedded-Core (OE-Core)` and :term:`BitBake`. Thus, the +generic term used here for the build system is the "OpenEmbedded build +system." Development in the Yocto Project using Poky is closely tied to +OpenEmbedded, with changes always being merged to OE-Core or BitBake +first before being pulled back into Poky. This practice benefits both +projects immediately. + +How can you claim Poky / OpenEmbedded-Core is stable? +----------------------------------------------------- + +There are three areas that help with stability; + +- The Yocto Project team keeps :term:`OpenEmbedded-Core (OE-Core)` small and + focused, containing around 830 recipes as opposed to the thousands + available in other OpenEmbedded community layers. Keeping it small + makes it easy to test and maintain. + +- The Yocto Project team runs manual and automated tests using a small, + fixed set of reference hardware as well as emulated targets. + +- The Yocto Project uses an :yocto_ab:`autobuilder <>`, which provides + continuous build and integration tests. + +Are there any products built using the OpenEmbedded build system? +----------------------------------------------------------------- + +See :yocto_wiki:`Products that use the Yocto Project +</Project_Users#Products_that_use_the_Yocto_Project>` in the Yocto Project +Wiki. Don't hesitate to contribute to this page if you know other such +products. + +Building environment +==================== + +Missing dependencies on the development system? +----------------------------------------------- + +If your development system does not meet the required Git, tar, and +Python versions, you can get the required tools on your host development +system in different ways (i.e. building a tarball or downloading a +tarball). See the ":ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions`" +section for steps on how to update your build tools. + +How does OpenEmbedded fetch source code? Will it work through a firewall or proxy server? +----------------------------------------------------------------------------------------- + +The way the build system obtains source code is highly +configurable. You can setup the build system to get source code in most +environments if HTTP transport is available. + +When the build system searches for source code, it first tries the local +download directory. If that location fails, Poky tries +:term:`PREMIRRORS`, the upstream source, and then +:term:`MIRRORS` in that order. + +Assuming your distribution is "poky", the OpenEmbedded build system uses +the Yocto Project source :term:`PREMIRRORS` by default for SCM-based +sources, upstreams for normal tarballs, and then falls back to a number +of other mirrors including the Yocto Project source mirror if those +fail. + +As an example, you could add a specific server for the build system to +attempt before any others by adding something like the following to the +``local.conf`` configuration file:: + + PREMIRRORS:prepend = "\ + git://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ + ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ + http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ + https://.*/.* &YOCTO_DL_URL;/mirror/sources/" + +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. + +Another option is to set:: + + BB_NO_NETWORK = "1" + +This statement tells BitBake to issue an error +instead of trying to access the Internet. This technique is useful if +you want to ensure code builds only from local sources. + +Here is another technique:: + + BB_FETCH_PREMIRRORONLY = "1" + +This statement limits the build system to pulling source from the +:term:`PREMIRRORS` only. Again, this technique is useful for reproducing +builds. + +Here is yet another technique:: + + BB_GENERATE_MIRROR_TARBALLS = "1" + +This statement tells the build system to generate mirror tarballs. This +technique is useful if you want to create a mirror server. If not, +however, the technique can simply waste time during the build. + +Finally, consider an example where you are behind an HTTP-only firewall. +You could make the following changes to the ``local.conf`` configuration +file as long as the :term:`PREMIRRORS` server is current:: + + PREMIRRORS:prepend = "\ + git://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ + ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ + http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ + https://.*/.* &YOCTO_DL_URL;/mirror/sources/" + BB_FETCH_PREMIRRORONLY = "1" + +These changes would cause the build system to successfully fetch source +over HTTP and any network accesses to anything other than the +:term:`PREMIRRORS` would fail. + +Most source fetching by the OpenEmbedded build system is done by +``wget`` and you therefore need to specify the proxy settings in a +``.wgetrc`` file, which can be in your home directory if you are a +single user or can be in ``/usr/local/etc/wgetrc`` as a global user +file. + +Here is the applicable code for setting various proxy types in the +``.wgetrc`` file. By default, these settings are disabled with comments. +To use them, remove the comments:: + + # You can set the default proxies for Wget to use for http, https, and ftp. + # They will override the value in the environment. + #https_proxy = http://proxy.yoyodyne.com:18023/ + #http_proxy = http://proxy.yoyodyne.com:18023/ + #ftp_proxy = http://proxy.yoyodyne.com:18023/ + + # If you do not want to use proxy at all, set this to off. + #use_proxy = on + +The build system also accepts ``http_proxy``, ``ftp_proxy``, ``https_proxy``, +and ``all_proxy`` set as to standard shell environment variables to redirect +requests through proxy servers. + +The Yocto Project also includes a +``meta-poky/conf/templates/default/site.conf.sample`` file that shows +how to configure CVS and Git proxy servers if needed. + +.. note:: + + You can find more information on the + ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" + Wiki page. + +Using the OpenEmbedded Build system +=================================== + +How do I use an external toolchain? +----------------------------------- + +See the ":ref:`dev-manual/external-toolchain:optionally using an external toolchain`" +section in the Development Task manual. + +Why do I get chmod permission issues? +------------------------------------- + +If you see the error +``chmod: XXXXX new permissions are r-xrwxrwx, not r-xr-xr-x``, +you are probably running the build on an NTFS filesystem. Instead, +run the build system on a partition with a modern Linux filesystem such as +``ext4``, ``btrfs`` or ``xfs``. + +I see many 404 errors trying to download sources. Is anything wrong? +-------------------------------------------------------------------- + +Nothing is wrong. The OpenEmbedded build system checks any +configured source mirrors before downloading from the upstream sources. +The build system does this searching for both source archives and +pre-checked out versions of SCM-managed software. These checks help in +large installations because it can reduce load on the SCM servers +themselves. This can also allow builds to continue to work if an +upstream source disappears. + +Why do I get random build failures? +----------------------------------- + +If the same build is failing in totally different and random +ways, the most likely explanation is: + +- The hardware you are running the build on has some problem. + +- You are running the build under virtualization, in which case the + virtualization probably has bugs. + +The OpenEmbedded build system processes a massive amount of data that +causes lots of network, disk and CPU activity and is sensitive to even +single-bit failures in any of these areas. True random failures have +always been traced back to hardware or virtualization issues. + +Why does the build fail with ``iconv.h`` problems? +-------------------------------------------------- + +When you try to build a native recipe, you may get an error message that +indicates that GNU ``libiconv`` is not in use but ``iconv.h`` has been +included from ``libiconv``:: + + #error GNU libiconv not in use but included iconv.h is from libiconv + +When this happens, you need to check whether you have a previously +installed version of the header file in ``/usr/local/include/``. +If that's the case, you should either uninstall it or temporarily rename +it and try the build again. + +This issue is just a single manifestation of "system leakage" issues +caused when the OpenEmbedded build system finds and uses previously +installed files during a native build. This type of issue might not be +limited to ``iconv.h``. Make sure that leakage cannot occur from +``/usr/local/include`` and ``/opt`` locations. + +Why don't other recipes find the files provided by my ``*-native`` recipe? +-------------------------------------------------------------------------- + +Files provided by your native recipe could be missing from the native +sysroot, your recipe could also be installing to the wrong place, or you +could be getting permission errors during the :ref:`ref-tasks-install` +task in your recipe. + +This situation happens when the build system used by a package does not +recognize the environment variables supplied to it by :term:`BitBake`. The +incident that prompted this FAQ entry involved a Makefile that used an +environment variable named ``BINDIR`` instead of the more standard +variable ``bindir``. The makefile's hardcoded default value of +"/usr/bin" worked most of the time, but not for the recipe's ``-native`` +variant. For another example, permission errors might be caused by a +Makefile that ignores ``DESTDIR`` or uses a different name for that +environment variable. Check the build system of the package to see if +these kinds of issues exist. + +Can I get rid of build output so I can start over? +-------------------------------------------------- + +Yes --- you can easily do this. When you use BitBake to build an +image, all the build output goes into the directory created when you run +the build environment setup script (i.e. :ref:`structure-core-script`). +By default, this :term:`Build Directory` is named ``build`` but can be named +anything you want. + +Within the :term:`Build Directory`, is the ``tmp`` directory. To remove all the +build output yet preserve any source code or downloaded files from +previous builds, simply remove the ``tmp`` directory. + +Customizing generated images +============================ + +What does the OpenEmbedded build system produce as output? +---------------------------------------------------------- + +Because you can use the same set of recipes to create output of +various formats, the output of an OpenEmbedded build depends on how you +start it. Usually, the output is a flashable image ready for the target +device. + +How do I make the Yocto Project support my board? +------------------------------------------------- + +Support for an additional board is added by creating a Board +Support Package (BSP) layer for it. For more information on how to +create a BSP layer, see the +":ref:`dev-manual/layers:understanding and creating layers`" +section in the Yocto Project Development Tasks Manual and the +:doc:`/bsp-guide/index`. + +Usually, if the board is not completely exotic, adding support in the +Yocto Project is fairly straightforward. + +How do I make the Yocto Project support my package? +--------------------------------------------------- + +To add a package, you need to create a BitBake recipe. For +information on how to create a BitBake recipe, see the +":ref:`dev-manual/new-recipe:writing a new recipe`" +section in the Yocto Project Development Tasks Manual. + +What do I need to ship for license compliance? +---------------------------------------------- + +This is a difficult question and you need to consult your lawyer +for the answer for your specific case. It is worth bearing in mind that +for GPL compliance, there needs to be enough information shipped to +allow someone else to rebuild and produce the same end result you are +shipping. This means sharing the source code, any patches applied to it, +and also any configuration information about how that package was +configured and built. + +You can find more information on licensing in the +":ref:`overview-manual/development-environment:licensing`" +section in the Yocto Project Overview and Concepts Manual and also in the +":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" +section in the Yocto Project Development Tasks Manual. + +Do I have to make a full reflash after recompiling one package? +--------------------------------------------------------------- + +The OpenEmbedded build system can build packages in various +formats such as IPK for OPKG, Debian package (``.deb``), or RPM. You can +then upgrade only the modified packages using the package tools on the device, +much like on a desktop distribution such as Ubuntu or Fedora. However, +package management on the target is entirely optional. + +How to prevent my package from being marked as machine specific? +---------------------------------------------------------------- + +If you have machine-specific data in a package for one machine only +but the package is being marked as machine-specific in all cases, +you can set :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` = "0" in the ``.bb`` file. +However, but make sure the package is manually marked as machine-specific for the +case that needs it. The code that handles :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` +is in the ``meta/classes-global/base.bbclass`` file. + +What's the difference between ``target`` and ``target-native``? +--------------------------------------------------------------- + +The ``*-native`` targets are designed to run on the system being +used for the build. These are usually tools that are needed to assist +the build in some way such as ``quilt-native``, which is used to apply +patches. The non-native version is the one that runs on the target +device. + +Why do ``${bindir}`` and ``${libdir}`` have strange values for ``-native`` recipes? +----------------------------------------------------------------------------------- + +Executables and libraries might need to be used from a directory +other than the directory into which they were initially installed. +Complicating this situation is the fact that sometimes these executables +and libraries are compiled with the expectation of being run from that +initial installation target directory. If this is the case, moving them +causes problems. + +This scenario is a fundamental problem for package maintainers of +mainstream Linux distributions as well as for the OpenEmbedded build +system. As such, a well-established solution exists. Makefiles, +Autotools configuration scripts, and other build systems are expected to +respect environment variables such as ``bindir``, ``libdir``, and +``sysconfdir`` that indicate where executables, libraries, and data +reside when a program is actually run. They are also expected to respect +a ``DESTDIR`` environment variable, which is prepended to all the other +variables when the build system actually installs the files. It is +understood that the program does not actually run from within +``DESTDIR``. + +When the OpenEmbedded build system uses a recipe to build a +target-architecture program (i.e. one that is intended for inclusion on +the image being built), that program eventually runs from the root file +system of that image. Thus, the build system provides a value of +"/usr/bin" for ``bindir``, a value of "/usr/lib" for ``libdir``, and so +forth. + +Meanwhile, ``DESTDIR`` is a path within the :term:`Build Directory`. +However, when the recipe builds a native program (i.e. one that is +intended to run on the build machine), that program is never installed +directly to the build machine's root file system. Consequently, the build +system uses paths within the Build Directory for ``DESTDIR``, ``bindir`` +and related variables. To better understand this, consider the following +two paths (artificially broken across lines for readability) where the +first is relatively normal and the second is not:: + + /home/maxtothemax/poky-bootchart2/build/tmp/work/i586-poky-linux/zlib/ + 1.2.8-r0/sysroot-destdir/usr/bin + + /home/maxtothemax/poky-bootchart2/build/tmp/work/x86_64-linux/ + zlib-native/1.2.8-r0/sysroot-destdir/home/maxtothemax/poky-bootchart2/ + build/tmp/sysroots/x86_64-linux/usr/bin + +Even if the paths look unusual, they both are correct --- the first for +a target and the second for a native recipe. These paths are a consequence +of the ``DESTDIR`` mechanism and while they appear strange, they are correct +and in practice very effective. + +How do I create images with more free space? +-------------------------------------------- + +By default, the OpenEmbedded build system creates images that are +1.3 times the size of the populated root filesystem. To affect the image +size, you need to set various configurations: + +- *Image Size:* The OpenEmbedded build system uses the + :term:`IMAGE_ROOTFS_SIZE` variable to define + the size of the image in Kbytes. The build system determines the size + by taking into account the initial root filesystem size before any + modifications such as requested size for the image and any requested + additional free disk space to be added to the image. + +- *Overhead:* Use the + :term:`IMAGE_OVERHEAD_FACTOR` variable + to define the multiplier that the build system applies to the initial + image size, which is 1.3 by default. + +- *Additional Free Space:* Use the + :term:`IMAGE_ROOTFS_EXTRA_SPACE` + variable to add additional free space to the image. The build system + adds this space to the image after it determines its + :term:`IMAGE_ROOTFS_SIZE`. + +Why aren't spaces in path names supported? +------------------------------------------ + +The Yocto Project team has tried to do this before but too many +of the tools the OpenEmbedded build system depends on, such as +``autoconf``, break when they find spaces in pathnames. Until that +situation changes, the team will not support spaces in pathnames. + +I'm adding a binary in a recipe. Why is it different in the image? +------------------------------------------------------------------ + +The first most obvious change is the system stripping debug symbols from +it. Setting :term:`INHIBIT_PACKAGE_STRIP` to stop debug symbols being +stripped and/or :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` to stop debug symbols +being split into a separate file will ensure the binary is unchanged. + +Issues on the running system +============================ + +How do I disable the cursor on my touchscreen device? +----------------------------------------------------- + +You need to create a form factor file as described in the +":ref:`bsp-guide/bsp:miscellaneous bsp-specific recipe files`" section in +the Yocto Project Board Support Packages (BSP) Developer's Guide. Set +the ``HAVE_TOUCHSCREEN`` variable equal to one as follows:: + + HAVE_TOUCHSCREEN=1 + +How to always bring up connected network interfaces? +---------------------------------------------------- + +The default interfaces file provided by the netbase recipe does +not automatically bring up network interfaces. Therefore, you will need +to add a BSP-specific netbase that includes an interfaces file. See the +":ref:`bsp-guide/bsp:miscellaneous bsp-specific recipe files`" section in +the Yocto Project Board Support Packages (BSP) Developer's Guide for +information on creating these types of miscellaneous recipe files. + +For example, add the following files to your layer:: + + meta-MACHINE/recipes-bsp/netbase/netbase/MACHINE/interfaces + meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend diff --git a/documentation/ref-manual/faq.xml b/documentation/ref-manual/faq.xml deleted file mode 100644 index 49ff86261d..0000000000 --- a/documentation/ref-manual/faq.xml +++ /dev/null @@ -1,835 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='faq'> -<title>FAQ</title> -<qandaset> - <qandaentry> - <question> - <para> - How does Poky differ from <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>? - </para> - </question> - <answer> - <para> - The term "<link link='poky'>Poky</link>" - refers to the specific reference build system that - the Yocto Project provides. - Poky is based on <link linkend='oe-core'>OE-Core</link> - and <link linkend='bitbake-term'>BitBake</link>. - Thus, the generic term used here for the build system is - the "OpenEmbedded build system." - Development in the Yocto Project using Poky is closely tied to OpenEmbedded, with - changes always being merged to OE-Core or BitBake first before being pulled back - into Poky. - This practice benefits both projects immediately. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para id='faq-not-meeting-requirements'> - My development system does not meet the - required Git, tar, and Python versions. - In particular, I do not have Python 3.4.0 or greater. - Can I still use the Yocto Project? - </para> - </question> - <answer> - <para> - You can get the required tools on your host development - system a couple different ways (i.e. building a tarball or - downloading a tarball). - See the - "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" - section for steps on how to update your build tools. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How can you claim Poky / OpenEmbedded-Core is stable? - </para> - </question> - <answer> - <para> - There are three areas that help with stability; - <itemizedlist> - <listitem><para>The Yocto Project team keeps - <link linkend='oe-core'>OE-Core</link> small - and focused, containing around 830 recipes as opposed to the thousands - available in other OpenEmbedded community layers. - Keeping it small makes it easy to test and maintain.</para></listitem> - <listitem><para>The Yocto Project team runs manual and automated tests - using a small, fixed set of reference hardware as well as emulated - targets.</para></listitem> - <listitem><para>The Yocto Project uses an autobuilder, - which provides continuous build and integration tests.</para></listitem> - </itemizedlist> - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I get support for my board added to the Yocto Project? - </para> - </question> - <answer> - <para> - Support for an additional board is added by creating a - Board Support Package (BSP) layer for it. - For more information on how to create a BSP layer, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" - section in the Yocto Project Development Tasks Manual and the - <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. - </para> - <para> - Usually, if the board is not completely exotic, adding support in - the Yocto Project is fairly straightforward. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - Are there any products built using the OpenEmbedded build system? - </para> - </question> - <answer> - <para> - The software running on the <ulink url='http://vernier.com/labquest/'>Vernier LabQuest</ulink> - is built using the OpenEmbedded build system. - See the <ulink url='http://www.vernier.com/products/interfaces/labq/'>Vernier LabQuest</ulink> - website for more information. - There are a number of pre-production devices using the OpenEmbedded build system - and the Yocto Project team - announces them as soon as they are released. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - What does the OpenEmbedded build system produce as output? - </para> - </question> - <answer> - <para> - Because you can use the same set of recipes to create output of - various formats, the output of an OpenEmbedded build depends on - how you start it. - Usually, the output is a flashable image ready for the target - device. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I add my package to the Yocto Project? - </para> - </question> - <answer> - <para> - To add a package, you need to create a BitBake recipe. - For information on how to create a BitBake recipe, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-writing-a-new-recipe'>Writing a New Recipe</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - Do I have to reflash my entire board with a new Yocto Project image when recompiling - a package? - </para> - </question> - <answer> - <para> - The OpenEmbedded build system can build packages in various - formats such as IPK for OPKG, Debian package - (<filename>.deb</filename>), or RPM. - You can then upgrade the packages using the package tools on - the device, much like on a desktop distribution such as - Ubuntu or Fedora. - However, package management on the target is entirely optional. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - I see the error '<filename>chmod: XXXXX new permissions are r-xrwxrwx, not r-xr-xr-x</filename>'. - What is wrong? - </para> - </question> - <answer> - <para> - You are probably running the build on an NTFS filesystem. - Use <filename>ext2</filename>, <filename>ext3</filename>, or <filename>ext4</filename> instead. - </para> - </answer> - </qandaentry> - -<!-- <qandaentry> - <question> - <para> - How do I make the Yocto Project work in RHEL/CentOS? - </para> - </question> - <answer> - <para> - To get the Yocto Project working under RHEL/CentOS 5.1 you need to first - install some required packages. - The standard CentOS packages needed are: - <itemizedlist> - <listitem><para>"Development tools" (selected during installation)</para></listitem> - <listitem><para><filename>texi2html</filename></para></listitem> - <listitem><para><filename>compat-gcc-34</filename></para></listitem> - </itemizedlist> - On top of these, you need the following external packages: - <itemizedlist> - <listitem><para><filename>python-sqlite2</filename> from - <ulink url='http://dag.wieers.com/rpm/packages/python-sqlite2/'>DAG repository</ulink> - </para></listitem> - <listitem><para><filename>help2man</filename> from - <ulink url='http://centos.karan.org/el4/extras/stable/x86_64/RPMS/repodata/repoview/help2man-0-1.33.1-2.html'>Karan repository</ulink></para></listitem> - </itemizedlist> - </para> - - <para> - Once these packages are installed, the OpenEmbedded build system will be able - to build standard images. - However, there might be a problem with the QEMU emulator segfaulting. - You can either disable the generation of binary locales by setting - <filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>ENABLE_BINARY_LOCALE_GENERATION</link> - </filename> to "0" or by removing the <filename>linux-2.6-execshield.patch</filename> - from the kernel and rebuilding it since that is the patch that causes the problems with QEMU. - </para> - - <note> - <para>For information on distributions that the Yocto Project - uses during validation, see the - <ulink url='&YOCTO_WIKI_URL;/wiki/Distribution_Support'>Distribution Support</ulink> - Wiki page.</para> - <para>For notes about using the Yocto Project on a RHEL 4-based - host, see the - <ulink url='&YOCTO_WIKI_URL;/wiki/BuildingOnRHEL4'>Building on RHEL4</ulink> - Wiki page.</para> - </note> - </answer> - </qandaentry> --> - - <qandaentry> - <question> - <para> - I see lots of 404 responses for files when the OpenEmbedded - build system is trying to download sources. - Is something wrong? - </para> - </question> - <answer> - <para> - Nothing is wrong. - The OpenEmbedded build system checks any configured source mirrors before downloading - from the upstream sources. - The build system does this searching for both source archives and - pre-checked out versions of SCM-managed software. - These checks help in large installations because it can reduce load on the SCM servers - themselves. - The address above is one of the default mirrors configured into the - build system. - Consequently, if an upstream source disappears, the team - can place sources there so builds continue to work. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - I have machine-specific data in a package for one machine only but the package is - being marked as machine-specific in all cases, how do I prevent this? - </para> - </question> - <answer> - <para> - Set <filename><link linkend='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'>SRC_URI_OVERRIDES_PACKAGE_ARCH</link> - </filename> = "0" in the <filename>.bb</filename> file but make sure the package is - manually marked as - machine-specific for the case that needs it. - The code that handles - <filename>SRC_URI_OVERRIDES_PACKAGE_ARCH</filename> is in - the <filename>meta/classes/base.bbclass</filename> file. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para id='i-am-behind-a-firewall-and-need-to-use-a-proxy-server'> - I'm behind a firewall and need to use a proxy server. How do I do that? - </para> - </question> - <answer> - <para> - Most source fetching by the OpenEmbedded build system is done - by <filename>wget</filename> and you therefore need to specify - the proxy settings in a <filename>.wgetrc</filename> file, - which can be in your home directory if you are a single user - or can be in <filename>/usr/local/etc/wgetrc</filename> as - a global user file. - </para> - - <para> - Following is the applicable code for setting various proxy - types in the <filename>.wgetrc</filename> file. - By default, these settings are disabled with comments. - To use them, remove the comments: - <literallayout class='monospaced'> - # You can set the default proxies for Wget to use for http, https, and ftp. - # They will override the value in the environment. - #https_proxy = http://proxy.yoyodyne.com:18023/ - #http_proxy = http://proxy.yoyodyne.com:18023/ - #ftp_proxy = http://proxy.yoyodyne.com:18023/ - - # If you do not want to use proxy at all, set this to off. - #use_proxy = on - </literallayout> - The Yocto Project also includes a - <filename>meta-poky/conf/site.conf.sample</filename> file that - shows how to configure CVS and Git proxy servers if needed. - For more information on setting up various proxy types and - configuring proxy servers, see the - "<ulink url='&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>" - Wiki page. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - What’s the difference between <replaceable>target</replaceable> and <replaceable>target</replaceable><filename>-native</filename>? - </para> - </question> - <answer> - <para> - The <filename>*-native</filename> targets are designed to run on the system - being used for the build. - These are usually tools that are needed to assist the build in some way such as - <filename>quilt-native</filename>, which is used to apply patches. - The non-native version is the one that runs on the target device. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - I'm seeing random build failures. Help?! - </para> - </question> - <answer> - <para> - If the same build is failing in totally different and random - ways, the most likely explanation is: - <itemizedlist> - <listitem><para>The hardware you are running the build on - has some problem.</para></listitem> - <listitem><para>You are running the build under - virtualization, in which case the virtualization - probably has bugs.</para></listitem> - </itemizedlist> - The OpenEmbedded build system processes a massive amount of - data that causes lots of network, disk and CPU activity and - is sensitive to even single-bit failures in any of these areas. - True random failures have always been traced back to hardware - or virtualization issues. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - When I try to build a native recipe, the build fails with <filename>iconv.h</filename> problems. - </para> - </question> - <answer> - <para> - If you get an error message that indicates GNU - <filename>libiconv</filename> is not in use but - <filename>iconv.h</filename> has been included from - <filename>libiconv</filename>, you need to check to see if - you have a previously installed version of the header file - in <filename>/usr/local/include</filename>. - <literallayout class='monospaced'> - #error GNU libiconv not in use but included iconv.h is from libiconv - </literallayout> - If you find a previously installed file, you should either - uninstall it or temporarily rename it and try the build again. - </para> - - <para> - This issue is just a single manifestation of "system - leakage" issues caused when the OpenEmbedded build system - finds and uses previously installed files during a native - build. - This type of issue might not be limited to - <filename>iconv.h</filename>. - Be sure that leakage cannot occur from - <filename>/usr/local/include</filename> and - <filename>/opt</filename> locations. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - What do we need to ship for license compliance? - </para> - </question> - <answer> - <para> - This is a difficult question and you need to consult your lawyer - for the answer for your specific case. - It is worth bearing in mind that for GPL compliance, there needs - to be enough information shipped to allow someone else to - rebuild and produce the same end result you are shipping. - This means sharing the source code, any patches applied to it, - and also any configuration information about how that package - was configured and built. - </para> - - <para> - You can find more information on licensing in the - "<ulink url='&YOCTO_DOCS_OM_URL;#licensing'>Licensing</ulink>" - section in the Yocto Project Overview and Concepts Manual - and also in the - "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I disable the cursor on my touchscreen device? - </para> - </question> - <answer> - <para> - You need to create a form factor file as described in the - "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-misc-recipes'>Miscellaneous BSP-Specific Recipe Files</ulink>" - section in the Yocto Project Board Support Packages (BSP) - Developer's Guide. - Set the <filename>HAVE_TOUCHSCREEN</filename> variable equal to - one as follows: - <literallayout class='monospaced'> - HAVE_TOUCHSCREEN=1 - </literallayout> - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I make sure connected network interfaces are brought up by default? - </para> - </question> - <answer> - <para> - The default interfaces file provided by the netbase recipe does not - automatically bring up network interfaces. - Therefore, you will need to add a BSP-specific netbase that includes an interfaces - file. - See the "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-filelayout-misc-recipes'>Miscellaneous BSP-Specific Recipe Files</ulink>" - section in the Yocto Project Board Support Packages (BSP) - Developer's Guide for information on creating these types of - miscellaneous recipe files. - </para> - <para> - For example, add the following files to your layer: - <literallayout class='monospaced'> - meta-MACHINE/recipes-bsp/netbase/netbase/MACHINE/interfaces - meta-MACHINE/recipes-bsp/netbase/netbase_5.0.bbappend - </literallayout> - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I create images with more free space? - </para> - </question> - <answer> - <para> - By default, the OpenEmbedded build system creates images - that are 1.3 times the size of the populated root filesystem. - To affect the image size, you need to set various - configurations: - <itemizedlist> - <listitem><para><emphasis>Image Size:</emphasis> - The OpenEmbedded build system uses the - <link linkend='var-IMAGE_ROOTFS_SIZE'><filename>IMAGE_ROOTFS_SIZE</filename></link> - variable to define the size of the image in Kbytes. - The build system determines the size by taking into - account the initial root filesystem size before any - modifications such as requested size for the image and - any requested additional free disk space to be - added to the image.</para></listitem> - <listitem><para><emphasis>Overhead:</emphasis> - Use the - <link linkend='var-IMAGE_OVERHEAD_FACTOR'><filename>IMAGE_OVERHEAD_FACTOR</filename></link> - variable to define the multiplier that the build system - applies to the initial image size, which is 1.3 by - default.</para></listitem> - <listitem><para><emphasis>Additional Free Space:</emphasis> - Use the - <link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'><filename>IMAGE_ROOTFS_EXTRA_SPACE</filename></link> - variable to add additional free space to the image. - The build system adds this space to the image after - it determines its - <filename>IMAGE_ROOTFS_SIZE</filename>. - </para></listitem> - </itemizedlist> - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - Why don't you support directories with spaces in the pathnames? - </para> - </question> - <answer> - <para> - The Yocto Project team has tried to do this before but too - many of the tools the OpenEmbedded build system depends on, - such as <filename>autoconf</filename>, break when they find - spaces in pathnames. - Until that situation changes, the team will not support spaces - in pathnames. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - How do I use an external toolchain? - </para> - </question> - <answer> - <para> - The toolchain configuration is very flexible and customizable. - It is primarily controlled with the - <filename><link linkend='var-TCMODE'>TCMODE</link></filename> - variable. - This variable controls which <filename>tcmode-*.inc</filename> - file to include from the - <filename>meta/conf/distro/include</filename> directory within - the - <link linkend='source-directory'>Source Directory</link>. - </para> - - <para> - The default value of <filename>TCMODE</filename> is "default", - which tells the OpenEmbedded build system to use its internally - built toolchain (i.e. <filename>tcmode-default.inc</filename>). - However, other patterns are accepted. - In particular, "external-*" refers to external toolchains. - One example is the Sourcery G++ Toolchain. - The support for this toolchain resides in the separate - <filename>meta-sourcery</filename> layer at - <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>. - </para> - - <para> - In addition to the toolchain configuration, you also need a - corresponding toolchain recipe file. - This recipe file needs to package up any pre-built objects in - the toolchain such as <filename>libgcc</filename>, - <filename>libstdcc++</filename>, any locales, and - <filename>libc</filename>. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para id='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'> - How does the OpenEmbedded build system obtain source code and - will it work behind my firewall or proxy server? - </para> - </question> - <answer> - <para> - The way the build system obtains source code is highly - configurable. - You can setup the build system to get source code in most - environments if HTTP transport is available. - </para> - <para> - When the build system searches for source code, it first - tries the local download directory. - If that location fails, Poky tries - <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>, - the upstream source, and then - <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> - in that order. - </para> - <para> - Assuming your distribution is "poky", the OpenEmbedded build - system uses the Yocto Project source - <filename>PREMIRRORS</filename> by default for SCM-based - sources, upstreams for normal tarballs, and then falls back - to a number of other mirrors including the Yocto Project - source mirror if those fail. - </para> - <para> - As an example, you could add a specific server for the - build system to attempt before any others by adding something - like the following to the <filename>local.conf</filename> - configuration file: - <literallayout class='monospaced'> - PREMIRRORS_prepend = "\ - git://.*/.* http://www.yoctoproject.org/sources/ \n \ - ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ - http://.*/.* http://www.yoctoproject.org/sources/ \n \ - https://.*/.* http://www.yoctoproject.org/sources/ \n" - </literallayout> - </para> - <para> - These changes cause the build system to intercept Git, FTP, - HTTP, and HTTPS requests and direct them to the - <filename>http://</filename> sources mirror. - You can use <filename>file://</filename> URLs to point to - local directories or network shares as well. - </para> - <para> - Aside from the previous technique, these options also exist: - <literallayout class='monospaced'> - BB_NO_NETWORK = "1" - </literallayout> - This statement tells BitBake to issue an error instead of - trying to access the Internet. - This technique is useful if you want to ensure code builds - only from local sources. - </para> - <para> - Here is another technique: - <literallayout class='monospaced'> - BB_FETCH_PREMIRRORONLY = "1" - </literallayout> - This statement limits the build system to pulling source - from the <filename>PREMIRRORS</filename> only. - Again, this technique is useful for reproducing builds. - </para> - <para> - Here is another technique: - <literallayout class='monospaced'> - BB_GENERATE_MIRROR_TARBALLS = "1" - </literallayout> - This statement tells the build system to generate mirror - tarballs. - This technique is useful if you want to create a mirror server. - If not, however, the technique can simply waste time during - the build. - </para> - <para> - Finally, consider an example where you are behind an - HTTP-only firewall. - You could make the following changes to the - <filename>local.conf</filename> configuration file as long as - the <filename>PREMIRRORS</filename> server is current: - <literallayout class='monospaced'> - PREMIRRORS_prepend = "\ - ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ - http://.*/.* http://www.yoctoproject.org/sources/ \n \ - https://.*/.* http://www.yoctoproject.org/sources/ \n" - BB_FETCH_PREMIRRORONLY = "1" - </literallayout> - These changes would cause the build system to successfully - fetch source over HTTP and any network accesses to anything - other than the <filename>PREMIRRORS</filename> would fail. - </para> - <para> - The build system also honors the standard shell environment - variables <filename>http_proxy</filename>, - <filename>ftp_proxy</filename>, - <filename>https_proxy</filename>, and - <filename>all_proxy</filename> to redirect requests through - proxy servers. - </para> - <note> - You can find more information on the - "<ulink url='&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>" - Wiki page. - </note> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - Can I get rid of build output so I can start over? - </para> - </question> - <answer> - <para> - Yes - you can easily do this. - When you use BitBake to build an image, all the build output - goes into the directory created when you run the - build environment setup script (i.e. - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). - By default, this - <link linkend='build-directory'>Build Directory</link> - is named <filename>build</filename> but can be named - anything you want. - </para> - - <para> - Within the Build Directory, is the <filename>tmp</filename> - directory. - To remove all the build output yet preserve any source code or - downloaded files from previous builds, simply remove the - <filename>tmp</filename> directory. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - Why do <filename>${bindir}</filename> and <filename>${libdir}</filename> have strange values for <filename>-native</filename> recipes? - </para> - </question> - <answer> - <para> - Executables and libraries might need to be used from a - directory other than the directory into which they were - initially installed. - Complicating this situation is the fact that sometimes these - executables and libraries are compiled with the expectation - of being run from that initial installation target directory. - If this is the case, moving them causes problems. - </para> - - <para> - This scenario is a fundamental problem for package maintainers - of mainstream Linux distributions as well as for the - OpenEmbedded build system. - As such, a well-established solution exists. - Makefiles, Autotools configuration scripts, and other build - systems are expected to respect environment variables such as - <filename>bindir</filename>, <filename>libdir</filename>, - and <filename>sysconfdir</filename> that indicate where - executables, libraries, and data reside when a program is - actually run. - They are also expected to respect a - <filename>DESTDIR</filename> environment variable, which is - prepended to all the other variables when the build system - actually installs the files. - It is understood that the program does not actually run from - within <filename>DESTDIR</filename>. - </para> - - <para> - When the OpenEmbedded build system uses a recipe to build a - target-architecture program (i.e. one that is intended for - inclusion on the image being built), that program eventually - runs from the root file system of that image. - Thus, the build system provides a value of "/usr/bin" for - <filename>bindir</filename>, a value of "/usr/lib" for - <filename>libdir</filename>, and so forth. - </para> - - <para> - Meanwhile, <filename>DESTDIR</filename> is a path within the - <link linkend='build-directory'>Build Directory</link>. - However, when the recipe builds a native program (i.e. one - that is intended to run on the build machine), that program - is never installed directly to the build machine's root - file system. - Consequently, the build system uses paths within the Build - Directory for <filename>DESTDIR</filename>, - <filename>bindir</filename> and related variables. - To better understand this, consider the following two paths - where the first is relatively normal and the second is not: - <note> - Due to these lengthy examples, the paths are artificially - broken across lines for readability. - </note> - <literallayout class='monospaced'> - /home/maxtothemax/poky-bootchart2/build/tmp/work/i586-poky-linux/zlib/ - 1.2.8-r0/sysroot-destdir/usr/bin - - /home/maxtothemax/poky-bootchart2/build/tmp/work/x86_64-linux/ - zlib-native/1.2.8-r0/sysroot-destdir/home/maxtothemax/poky-bootchart2/ - build/tmp/sysroots/x86_64-linux/usr/bin - </literallayout> - Even if the paths look unusual, they both are correct - - the first for a target and the second for a native recipe. - These paths are a consequence of the - <filename>DESTDIR</filename> mechanism and while they - appear strange, they are correct and in practice very effective. - </para> - </answer> - </qandaentry> - - <qandaentry> - <question> - <para> - The files provided by my <filename>*-native</filename> recipe do - not appear to be available to other recipes. - Files are missing from the native sysroot, my recipe is - installing to the wrong place, or I am getting permissions - errors during the do_install task in my recipe! What is wrong? - </para> - </question> - <answer> - <para> - This situation results when a build system does - not recognize the environment variables supplied to it by - <link linkend='bitbake-term'>BitBake</link>. - The incident that prompted this FAQ entry involved a Makefile - that used an environment variable named - <filename>BINDIR</filename> instead of the more standard - variable <filename>bindir</filename>. - The makefile's hardcoded default value of "/usr/bin" worked - most of the time, but not for the recipe's - <filename>-native</filename> variant. - For another example, permissions errors might be caused - by a Makefile that ignores <filename>DESTDIR</filename> or uses - a different name for that environment variable. - Check the the build system to see if these kinds of - issues exist. - </para> - </answer> - </qandaentry> - -</qandaset> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst new file mode 100644 index 0000000000..2ea946b31d --- /dev/null +++ b/documentation/ref-manual/features.rst @@ -0,0 +1,470 @@ +.. 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 :ref:`ref-features-backfill`. + +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 :term:`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 :term:`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 + +- *bluetooth:* Hardware has integrated BT + +- *efi:* Support for booting through EFI + +- *ext2:* Hardware HDD or Microdrive + +- *keyboard:* Hardware has a keyboard + +- *numa:* Hardware has non-uniform memory access + +- *pcbios:* Support for booting through BIOS + +- *pci:* Hardware has a PCI bus + +- *pcmcia:* Hardware has PCMCIA or CompactFlash sockets + +- *phone:* Mobile phone (voice) support + +- *qemu-usermode:* QEMU can support user-mode emulation for this machine + +- *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. Appropriate options +must be supplied, and enabling/disabling :term:`PACKAGECONFIG` for the +concerned packages is one way of supplying such options. + +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. + +.. note:: + + :term:`DISTRO_FEATURES` is normally independent of kernel configuration, + so if a feature specified in :term:`DISTRO_FEATURES` also relies on + support in the kernel, you will also need to ensure that support is + enabled in the kernel configuration. + +This list only represents features as shipped with the Yocto Project +metadata, as extra layers can define their own: + +- *3g:* Include support for cellular data. + +- *acl:* Include :wikipedia:`Access Control List <Access-control_list>` support. + +- *alsa:* Include :wikipedia:`Advanced Linux Sound Architecture <Advanced_Linux_Sound_Architecture>` + 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. + +- *debuginfod:* Include support for getting ELF debugging information through + a :ref:`debuginfod <dev-manual/debugging:using the debuginfod server method>` + server. + +- *directfb:* Include DirectFB support. + +- *ext2:* Include tools for supporting for devices with internal + HDD/Microdrive for storing files (instead of Flash only devices). + +- *gobject-introspection-data:* Include data to support + `GObject Introspection <https://gi.readthedocs.io/en/latest/>`__. + +- *ipsec:* Include IPSec support. + +- *ipv4:* Include IPv4 support. + +- *ipv6:* Include IPv6 support. + +- *keyboard:* Include keyboard support (e.g. keymaps will be loaded + during boot). + +- *minidebuginfo:* Add minimal debug symbols :ref:`(minidebuginfo)<dev-manual/debugging:enabling minidebuginfo>` + to binary files containing, allowing ``coredumpctl`` and ``gdb`` to show symbolicated stack traces. + +- *multiarch:* Enable building applications with multiple architecture + support. + +- *ld-is-gold:* Use the :wikipedia:`gold <Gold_(linker)>` + linker instead of the standard GCC linker (bfd). + +- *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the + target. + +- *lto:* Enable `Link-Time Optimisation <https://gcc.gnu.org/wiki/LinkTimeOptimization>`__. + +- *nfc:* Include support for + `Near Field Communication <https://en.wikipedia.org/wiki/Near-field_communication>`__. + +- *nfs:* Include NFS client support (for mounting NFS exports on + device). + +- *nls:* Include National Language Support (NLS). + +- *opengl:* Include the Open Graphics Library, which is a + cross-language, multi-platform application programming interface used + for rendering two and three-dimensional graphics. + +- *overlayfs:* Include `OverlayFS <https://docs.kernel.org/filesystems/overlayfs.html>`__ + support. + +- *pam:* Include :wikipedia:`Pluggable Authentication Module (PAM) <Pluggable_authentication_module>` + support. + +- *pci:* Include PCI bus support. + +- *pcmcia:* Include PCMCIA/CompactFlash support. + +- *polkit:* Include :wikipedia:`Polkit <Polkit>` 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/packages:testing packages with ptest`" section + in the Yocto Project Development Tasks Manual. + +- *pulseaudio:* Include support for + `PulseAudio <https://www.freedesktop.org/wiki/Software/PulseAudio/>`__. + +- *selinux:* Include support for + :wikipedia:`Security-Enhanced Linux (SELinux) <Security-Enhanced_Linux>` + (requires `meta-selinux <https://layers.openembedded.org/layerindex/layer/meta-selinux/>`__). + +- *seccomp:* Enables building applications with + :wikipedia:`seccomp <Seccomp>` support, to + allow them to strictly restrict the system calls that they are allowed + to invoke. + +- *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. + +- *systemd-resolved:* Include support and use ``systemd-resolved`` as the + main DNS name resolver in ``glibc`` Name Service Switch. This is a DNS + resolver daemon from ``systemd``. + +- *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. + +- *vfat:* Include :wikipedia:`FAT filesystem <File_Allocation_Table>` + support. + +- *vulkan:* Include support for the :wikipedia:`Vulkan API <Vulkan>`. + +- *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. + +- *xattr:* Include support for + :wikipedia:`extended file attributes <Extended_file_attributes>`. + +- *zeroconf:* Include support for + `zero configuration networking <https://en.wikipedia.org/wiki/Zero-configuration_networking>`__. + +.. _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 image features available for all images are: + +- *allow-empty-password:* Allows Dropbear and OpenSSH to accept + logins from accounts having an empty password string. + +- *allow-root-login:* Allows Dropbear and OpenSSH to accept root logins. + +- *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, logins without passwords ---including root ones, and enables + post-installation logging). See the ``allow-empty-password``, + ``allow-root-login``, ``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:* This feature or ``debug-tweaks`` is required if + you want to allow root login with an empty password. If these features + are not present in :term:`IMAGE_FEATURES`, a non-empty password is + forced in ``/etc/passwd`` and ``/etc/shadow`` if such files exist. + + .. note:: + ``empty-root-password`` doesn't set an empty root password by itself. + You get an initial empty root password thanks to the + :oe_git:`base-passwd </openembedded-core/tree/meta/recipes-core/base-passwd/>` + and :oe_git:`shadow </openembedded-core/tree/meta/recipes-extended/shadow/>` + recipes, and the presence of ``empty-root-password`` or ``debug-tweaks`` + just disables the mechanism which forces an non-empty password for the + root user. + +- *lic-pkgs:* Installs license packages for all packages installed in a + given image. + +- *overlayfs-etc:* Configures the ``/etc`` directory to be in ``overlayfs``. + This allows to store device specific information elsewhere, especially + if the root filesystem is configured to be read-only. + +- *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/read-only-rootfs:creating a read-only root filesystem`" + section in the Yocto Project Development Tasks Manual for more + information. + +- *read-only-rootfs-delayed-postinsts:* when specified in conjunction + with ``read-only-rootfs``, specifies that post-install scripts are + still permitted (this assumes that the root filesystem will be made + writeable for the first boot; this feature does not do anything to + ensure that - it just disables the check for post-install scripts.) + +- *serial-autologin-root:* when specified in conjunction with + ``empty-root-password`` will automatically login as root on the + serial console. This of course opens up a security hole if the + serial console is potentially accessible to an attacker, so use + with caution. + +- *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 :term:`SPLASH` variable to a + different package name (or names) within the image recipe or at the + distro configuration level. + +- *stateless-rootfs:*: specifies that the image should be created as + stateless - when using ``systemd``, ``systemctl-native`` will not + be run on the image, leaving the image for population at runtime by + systemd. + +- *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:`ref-classes-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. + + .. note:: + + As of the 4.1 release, the ``ssh-server-dropbear`` feature also + recommends the ``openssh-sftp-server`` package, which by default + will be pulled into the image. This is because recent versions of + the OpenSSH ``scp`` client now use the SFTP protocol, and thus + require an SFTP server to be present to connect to. However, if + you wish to use the Dropbear ssh server `without` the SFTP server + installed, you can either remove ``ssh-server-dropbear`` from + ``IMAGE_FEATURES`` and add ``dropbear`` to :term:`IMAGE_INSTALL` + instead, or alternatively still use the feature but set + :term:`BAD_RECOMMENDATIONS` as follows:: + + BAD_RECOMMENDATIONS += "openssh-sftp-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 + :term:`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/debugging: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). + +- *weston:* Installs Weston (reference Wayland environment). + +- *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 +add new functionality to :term:`MACHINE_FEATURES` or +:term:`DISTRO_FEATURES`, but at the same time, allow existing +distributions or machine definitions to opt out of such new +features, to retain the same overall level of functionality. + +To make this possible, the OpenEmbedded build system has a mechanism to +automatically "backfill" features into existing distro or machine +configurations. You can see the list of features for which this is done +by checking the :term:`DISTRO_FEATURES_BACKFILL` and +:term:`MACHINE_FEATURES_BACKFILL` variables in the +``meta/conf/bitbake.conf`` file. + +These two variables are paired with the +:term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` +and :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` variables +which allow distro or machine configuration maintainers to `consider` any +added feature, and decide when they wish to keep or exclude such feature, +thus preventing the backfilling from happening. + +Here are two examples to 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 now backfilled and thus enabled for all distros through the + :term:`DISTRO_FEATURES_BACKFILL` variable in the ``meta/conf/bitbake.conf`` + file. However, if your distro needs to disable the feature, you can do so + without affecting other existing distro configurations that need PulseAudio + support. You do this by adding "pulseaudio" to + :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` in your distro's ``.conf`` + file. So, adding the feature to this variable when it also exists in the + :term:`DISTRO_FEATURES_BACKFILL` variable prevents the build system from + adding the feature to your configuration's :term:`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 + :term:`MACHINE_FEATURES_BACKFILL` variable in the ``meta/conf/bitbake.conf`` + file. However, if your target device does not have this capability, you can + disable RTC support for your device without affecting other machines + that need RTC support. You do this by adding the "rtc" feature to the + :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` list in your machine's ``.conf`` + file. So, adding the feature to this variable when it also exists in the + :term:`MACHINE_FEATURES_BACKFILL` variable prevents the build system from + adding the feature to your configuration's :term:`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..c45f9104a9 --- /dev/null +++ b/documentation/ref-manual/images.rst @@ -0,0 +1,135 @@ +.. 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 tested for core-image-minimal image. Furthermore, if you would like to + build an image and verify that it does not include GPLv3 and similarly licensed + components, you must make the following changes in the image recipe + file before using the BitBake command to build the image: + + INCOMPATIBLE_LICENSE = "GPL-3.0* LGPL-3.0*" + + Alternatively, you can adjust ``local.conf`` file, repeating and adjusting the line + for all images where the license restriction must apply: + + INCOMPATIBLE_LICENSE:pn-your-image-name = "GPL-3.0* LGPL-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 + +Here 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 <https://www.vmware.com/products/player/overview.html>`__ or + `VMware + Workstation <https://www.vmware.com/products/workstation/overview.html>`__. + For more information on this image, see the :yocto_home:`Build + Appliance </software-item/build-appliance>` page + on the Yocto Project website. + +- ``core-image-base``: A console-only image that fully supports the + target device hardware. + +- ``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 (:term:`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 :term:`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 "controller" 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/runtime-testing:performing automated runtime testing`" + section in the Yocto Project Development Tasks Manual. + +- ``core-image-testmaster-initramfs``: A RAM-based Initial Root + Filesystem (:term:`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/wayland: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 new file mode 100644 index 0000000000..a746dde492 --- /dev/null +++ b/documentation/ref-manual/index.rst @@ -0,0 +1,29 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +============================== +Yocto Project Reference Manual +============================== + +| + +.. toctree:: + :caption: Table of Contents + :numbered: + + system-requirements + terms + release-process + structure + classes + tasks + devtool-reference + kickstart + qa-checks + images + features + variables + varlocality + faq + resources + +.. include:: /boilerplate.rst diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst new file mode 100644 index 0000000000..297887805c --- /dev/null +++ b/documentation/ref-manual/kickstart.rst @@ -0,0 +1,234 @@ +.. 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: +https://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 default + configuration of BusyBox in OpenEmbedded supports this, but this may + be disabled in custom configurations. + +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. Specify as an integer value + optionally followed by one of the units "k" / "K" for kibibyte, + "M" for mebibyte and "G" for gibibyte. The default unit if none is + given is "M". You do not need this option if you use ``--source``. + +- ``--fixed-size``: The exact partition size. Specify as an integer + value optionally followed by one of the units "k" / "K" for kibibyte, + "M" for mebibyte and "G" for gibibyte. The default unit if none is + given is "M". Cannot be specify together 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/wic: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 root filesystem 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 root filesystem 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: + + - ``btrfs`` + + - ``erofs`` + + - ``ext2`` + + - ``ext3`` + + - ``ext4`` + + - ``squashfs`` + + - ``swap`` + + - ``vfat`` + +- ``--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``: 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. Specify as an integer value optionally followed by one of + the units "s" / "S" for 512 byte sector, "k" / "K" for kibibyte, "M" + for mebibyte and "G" for gibibyte. The default unit if none is given + is "k". + +- ``--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 10M. Specify as an integer value + optionally followed by one of the units "k" / "K" for kibibyte, "M" + for mebibyte and "G" for gibibyte. The default unit if none is given + is "M". + +- ``--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 + :wikipedia:`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. + +- ``--append``: Specifies kernel parameters. These parameters will be + added to the syslinux :term:`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 located in the ``canned-wks`` folder. This option overrides + all other bootloader options. + +- ``--ptable``: Specifies the partition table format. Valid values are: + + - ``msdos`` + + - ``gpt`` + +- ``--timeout``: Specifies the number of seconds before the + bootloader times out and boots the default option. + diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml deleted file mode 100644 index c648d8d442..0000000000 --- a/documentation/ref-manual/migration.xml +++ /dev/null @@ -1,6331 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='migration'> -<title>Migrating to a Newer Yocto Project Release</title> - - <para> - This chapter provides information you can use to migrate work to a - newer Yocto Project release. You can find the same information in the - release notes for a given release. - </para> - -<section id='general-migration-considerations'> - <title>General Migration Considerations</title> - - <para> - Some considerations are not tied to a specific Yocto Project - release. - This section presents information you should consider when - migrating to any new Yocto Project release. - <itemizedlist> - <listitem><para><emphasis>Dealing with Customized Recipes</emphasis>: - Issues could arise if you take older recipes that contain - customizations and simply copy them forward expecting them - to work after you migrate to new Yocto Project metadata. - For example, suppose you have a recipe in your layer that is - a customized version of a core recipe copied from the earlier - release, rather than through the use of an append file. - When you migrate to a newer version of Yocto Project, the - metadata (e.g. perhaps an include file used by the recipe) - could have changed in a way that would break the build. - Say, for example, a function is removed from an include file - and the customized recipe tries to call that function. - </para> - - <para>You could "forward-port" all your customizations in your - recipe so that everything works for the new release. - However, this is not the optimal solution as you would have - to repeat this process with each new release if changes - occur that give rise to problems.</para> - - <para>The better solution (where practical) is to use append - files (<filename>*.bbappend</filename>) to capture any - customizations you want to make to a recipe. - Doing so, isolates your changes from the main recipe making - them much more manageable. - However, sometimes it is not practical to use an append - file. - A good example of this is when introducing a newer or older - version of a recipe in another layer.</para> - </listitem> - <listitem><para><emphasis>Updating Append Files</emphasis>: - Since append files generally only contain your customizations, - they often do not need to be adjusted for new releases. - However, if the <filename>.bbappend</filename> file is - specific to a particular version of the recipe (i.e. its - name does not use the % wildcard) and the version of the - recipe to which it is appending has changed, then you will - at a minimum need to rename the append file to match the - name of the recipe file. - A mismatch between an append file and its corresponding - recipe file (<filename>.bb</filename>) will - trigger an error during parsing.</para> - <para>Depending on the type of customization the append file - applies, other incompatibilities might occur when you - upgrade. - For example, if your append file applies a patch and the - recipe to which it is appending is updated to a newer - version, the patch might no longer apply. - If this is the case and assuming the patch is still needed, - you must modify the patch file so that it does apply. - </para></listitem> - </itemizedlist> - </para> -</section> - -<section id='moving-to-the-yocto-project-1.3-release'> - <title>Moving to the Yocto Project 1.3 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 1.3 Release from the prior release. - </para> - - <section id='1.3-local-configuration'> - <title>Local Configuration</title> - - <para> - Differences include changes for - <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> - and <filename>bblayers.conf</filename>. - </para> - - <section id='migration-1.3-sstate-mirrors'> - <title>SSTATE_MIRRORS</title> - - <para> - The shared state cache (sstate-cache), as pointed to by - <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>, - by default now has two-character subdirectories to prevent - issues arising from too many files in the same directory. - Also, native sstate-cache packages, which are built to run - on the host system, will go into a subdirectory named using - the distro ID string. - If you copy the newly structured sstate-cache to a mirror - location (either local or remote) and then point to it in - <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link>, - you need to append "PATH" to the end of the mirror URL so that - the path used by BitBake before the mirror substitution is - appended to the path used to access the mirror. - Here is an example: - <literallayout class='monospaced'> - SSTATE_MIRRORS = "file://.* http://<replaceable>someserver</replaceable>.tld/share/sstate/PATH" - </literallayout> - </para> - </section> - - <section id='migration-1.3-bblayers-conf'> - <title>bblayers.conf</title> - - <para> - The <filename>meta-yocto</filename> layer consists of two parts - that correspond to the Poky reference distribution and the - reference hardware Board Support Packages (BSPs), respectively: - <filename>meta-yocto</filename> and - <filename>meta-yocto-bsp</filename>. - When running BitBake for the first time after upgrading, - your <filename>conf/bblayers.conf</filename> file will be - updated to handle this change and you will be asked to - re-run or restart for the changes to take effect. - </para> - </section> - </section> - - <section id='1.3-recipes'> - <title>Recipes</title> - - <para> - Differences include changes for the following: - <itemizedlist> - <listitem><para>Python function whitespace</para></listitem> - <listitem><para><filename>proto=</filename> in <filename>SRC_URI</filename></para></listitem> - <listitem><para><filename>nativesdk</filename></para></listitem> - <listitem><para>Task recipes</para></listitem> - <listitem><para><filename>IMAGE_FEATURES</filename></para></listitem> - <listitem><para>Removed recipes</para></listitem> - </itemizedlist> - </para> - - <section id='migration-1.3-python-function-whitespace'> - <title>Python Function Whitespace</title> - - <para> - All Python functions must now use four spaces for indentation. - Previously, an inconsistent mix of spaces and tabs existed, - which made extending these functions using - <filename>_append</filename> or <filename>_prepend</filename> - complicated given that Python treats whitespace as - syntactically significant. - If you are defining or extending any Python functions (e.g. - <filename>populate_packages</filename>, <filename>do_unpack</filename>, - <filename>do_patch</filename> and so forth) in custom recipes - or classes, you need to ensure you are using consistent - four-space indentation. - </para> - </section> - - <section id='migration-1.3-proto=-in-src-uri'> - <title>proto= in SRC_URI</title> - - <para> - Any use of <filename>proto=</filename> in - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - needs to be changed to <filename>protocol=</filename>. - In particular, this applies to the following URIs: - <itemizedlist> - <listitem><para><filename>svn://</filename></para></listitem> - <listitem><para><filename>bzr://</filename></para></listitem> - <listitem><para><filename>hg://</filename></para></listitem> - <listitem><para><filename>osc://</filename></para></listitem> - </itemizedlist> - Other URIs were already using <filename>protocol=</filename>. - This change improves consistency. - </para> - </section> - - <section id='migration-1.3-nativesdk'> - <title>nativesdk</title> - - <para> - The suffix <filename>nativesdk</filename> is now implemented - as a prefix, which simplifies a lot of the packaging code for - <filename>nativesdk</filename> recipes. - All custom <filename>nativesdk</filename> recipes, which are - relocatable packages that are native to - <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>, - and any references need to be updated to use - <filename>nativesdk-*</filename> instead of - <filename>*-nativesdk</filename>. - </para> - </section> - - <section id='migration-1.3-task-recipes'> - <title>Task Recipes</title> - - <para> - "Task" recipes are now known as "Package groups" and have - been renamed from <filename>task-*.bb</filename> to - <filename>packagegroup-*.bb</filename>. - Existing references to the previous <filename>task-*</filename> - names should work in most cases as there is an automatic - upgrade path for most packages. - However, you should update references in your own recipes and - configurations as they could be removed in future releases. - You should also rename any custom <filename>task-*</filename> - recipes to <filename>packagegroup-*</filename>, and change - them to inherit <filename>packagegroup</filename> instead of - <filename>task</filename>, as well as taking the opportunity - to remove anything now handled by - <filename>packagegroup.bbclass</filename>, such as providing - <filename>-dev</filename> and <filename>-dbg</filename> - packages, setting - <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link>, - and so forth. - See the - "<link linkend='ref-classes-packagegroup'><filename>packagegroup.bbclass</filename></link>" - section for further details. - </para> - </section> - - <section id='migration-1.3-image-features'> - <title>IMAGE_FEATURES</title> - - <para> - Image recipes that previously included "apps-console-core" - in <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> - should now include "splash" instead to enable the boot-up - splash screen. - Retaining "apps-console-core" will still include the splash - screen but generates a warning. - The "apps-x11-core" and "apps-x11-games" - <filename>IMAGE_FEATURES</filename> features have been removed. - </para> - </section> - - <section id='migration-1.3-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been removed. - For most of them, it is unlikely that you would have any - references to them in your own - <link linkend='metadata'>Metadata</link>. - However, you should check your metadata against this list to be sure: - <itemizedlist> - <listitem><para><emphasis><filename>libx11-trim</filename></emphasis>: - Replaced by <filename>libx11</filename>, which has a negligible - size difference with modern Xorg.</para></listitem> - <listitem><para><emphasis><filename>xserver-xorg-lite</filename></emphasis>: - Use <filename>xserver-xorg</filename>, which has a negligible - size difference when DRI and GLX modules are not installed.</para></listitem> - <listitem><para><emphasis><filename>xserver-kdrive</filename></emphasis>: - Effectively unmaintained for many years.</para></listitem> - <listitem><para><emphasis><filename>mesa-xlib</filename></emphasis>: - No longer serves any purpose.</para></listitem> - <listitem><para><emphasis><filename>galago</filename></emphasis>: - Replaced by telepathy.</para></listitem> - <listitem><para><emphasis><filename>gail</filename></emphasis>: - Functionality was integrated into GTK+ 2.13.</para></listitem> - <listitem><para><emphasis><filename>eggdbus</filename></emphasis>: - No longer needed.</para></listitem> - <listitem><para><emphasis><filename>gcc-*-intermediate</filename></emphasis>: - The build has been restructured to avoid the need for - this step.</para></listitem> - <listitem><para><emphasis><filename>libgsmd</filename></emphasis>: - Unmaintained for many years. - Functionality now provided by - <filename>ofono</filename> instead.</para></listitem> - <listitem><para><emphasis>contacts, dates, tasks, eds-tools</emphasis>: - Largely unmaintained PIM application suite. - It has been moved to <filename>meta-gnome</filename> - in <filename>meta-openembedded</filename>.</para></listitem> - </itemizedlist> - In addition to the previously listed changes, the - <filename>meta-demoapps</filename> directory has also been removed - because the recipes in it were not being maintained and many - had become obsolete or broken. - Additionally, these recipes were not parsed in the default configuration. - Many of these recipes are already provided in an updated and - maintained form within the OpenEmbedded community layers such as - <filename>meta-oe</filename> and <filename>meta-gnome</filename>. - For the remainder, you can now find them in the - <filename>meta-extras</filename> repository, which is in the - Yocto Project - <ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink>. - </para> - </section> - </section> - - <section id='1.3-linux-kernel-naming'> - <title>Linux Kernel Naming</title> - - <para> - The naming scheme for kernel output binaries has been changed to - now include - <link linkend='var-PE'><filename>PE</filename></link> as part of the - filename: - <literallayout class='monospaced'> - KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}" - </literallayout> - </para> - - <para> - Because the <filename>PE</filename> variable is not set by default, - these binary files could result with names that include two dash - characters. - Here is an example: - <literallayout class='monospaced'> - bzImage--3.10.9+git0+cd502a8814_7144bcc4b8-r0-qemux86-64-20130830085431.bin - </literallayout> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-1.4-release'> - <title>Moving to the Yocto Project 1.4 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 1.4 Release from the prior release. - </para> - - <section id='migration-1.4-bitbake'> - <title>BitBake</title> - - <para> - Differences include the following: - <itemizedlist> - <listitem><para><emphasis>Comment Continuation:</emphasis> - If a comment ends with a line continuation (\) character, - then the next line must also be a comment. - Any instance where this is not the case, now triggers - a warning. - You must either remove the continuation character, or be - sure the next line is a comment. - </para></listitem> - <listitem><para><emphasis>Package Name Overrides:</emphasis> - The runtime package specific variables - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, - <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, - <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, - <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>, - <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, - <link linkend='var-FILES'><filename>FILES</filename></link>, - <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>, - and the pre, post, install, and uninstall script functions - <filename>pkg_preinst</filename>, - <filename>pkg_postinst</filename>, - <filename>pkg_prerm</filename>, and - <filename>pkg_postrm</filename> should always have a - package name override. - For example, use <filename>RDEPENDS_${PN}</filename> for - the main package instead of <filename>RDEPENDS</filename>. - BitBake uses more strict checks when it parses recipes. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.4-build-behavior'> - <title>Build Behavior</title> - - <para> - Differences include the following: - <itemizedlist> - <listitem><para><emphasis>Shared State Code:</emphasis> - The shared state code has been optimized to avoid running - unnecessary tasks. - For example, the following no longer populates the target - sysroot since that is not necessary: - <literallayout class='monospaced'> - $ bitbake -c rootfs <replaceable>some-image</replaceable> - </literallayout> - Instead, the system just needs to extract the output - package contents, re-create the packages, and construct - the root filesystem. - This change is unlikely to cause any problems unless - you have missing declared dependencies. - </para></listitem> - <listitem><para><emphasis>Scanning Directory Names:</emphasis> - When scanning for files in - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>, - the build system now uses - <link linkend='var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></link> - instead of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> - for the directory names. - In general, the values previously in - <filename>OVERRIDES</filename> are now in - <filename>FILESOVERRIDES</filename> as well. - However, if you relied upon an additional value - you previously added to <filename>OVERRIDES</filename>, - you might now need to add it to - <filename>FILESOVERRIDES</filename> unless you are already - adding it through the - <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link> - or <link linkend='var-DISTROOVERRIDES'><filename>DISTROOVERRIDES</filename></link> - variables, as appropriate. - For more related changes, see the - "<link linkend='migration-1.4-variables'>Variables</link>" - section. - </para></listitem> - </itemizedlist> - </para> - </section> - - - <section id='migration-1.4-proxies-and-fetching-source'> - <title>Proxies and Fetching Source</title> - - <para> - A new <filename>oe-git-proxy</filename> script has been added to - replace previous methods of handling proxies and fetching source - from Git. - See the <filename>meta-yocto/conf/site.conf.sample</filename> file - for information on how to use this script. - </para> - </section> - - <section id='migration-1.4-custom-interfaces-file-netbase-change'> - <title>Custom Interfaces File (netbase change)</title> - - <para> - If you have created your own custom - <filename>etc/network/interfaces</filename> file by creating - an append file for the <filename>netbase</filename> recipe, - you now need to create an append file for the - <filename>init-ifupdown</filename> recipe instead, which you can - find in the - <link linkend='source-directory'>Source Directory</link> - at <filename>meta/recipes-core/init-ifupdown</filename>. - For information on how to use append files, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='migration-1.4-remote-debugging'> - <title>Remote Debugging</title> - - <para> - Support for remote debugging with the Eclipse IDE is now - separated into an image feature - (<filename>eclipse-debug</filename>) that corresponds to the - <filename>packagegroup-core-eclipse-debug</filename> package group. - Previously, the debugging feature was included through the - <filename>tools-debug</filename> image feature, which corresponds - to the <filename>packagegroup-core-tools-debug</filename> - package group. - </para> - </section> - - <section id='migration-1.4-variables'> - <title>Variables</title> - - <para> - The following variables have changed: - <itemizedlist> - <listitem><para><emphasis><filename>SANITY_TESTED_DISTROS</filename>:</emphasis> - This variable now uses a distribution ID, which is composed - of the host distributor ID followed by the release. - Previously, - <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link> - was composed of the description field. - For example, "Ubuntu 12.10" becomes "Ubuntu-12.10". - You do not need to worry about this change if you are not - specifically setting this variable, or if you are - specifically setting it to "". - </para></listitem> - <listitem><para><emphasis><filename>SRC_URI</filename>:</emphasis> - The <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>, - <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>, - <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename>, - and <filename>FILE_DIRNAME</filename> directories have been - dropped from the default value of the - <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> - variable, which is used as the search path for finding files - referred to in - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>. - If you have a recipe that relied upon these directories, - which would be unusual, then you will need to add the - appropriate paths within the recipe or, alternatively, - rearrange the files. - The most common locations are still covered by - <filename>${BP}</filename>, <filename>${BPN}</filename>, - and "files", which all remain in the default value of - <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-target-package-management-with-rpm'> - <title>Target Package Management with RPM</title> - - <para> - If runtime package management is enabled and the RPM backend - is selected, Smart is now installed for package download, dependency - resolution, and upgrades instead of Zypper. - For more information on how to use Smart, run the following command - on the target: - <literallayout class='monospaced'> - smart --help - </literallayout> - </para> - </section> - - <section id='migration-1.4-recipes-moved'> - <title>Recipes Moved</title> - - <para> - The following recipes were moved from their previous locations - because they are no longer used by anything in - the OpenEmbedded-Core: - <itemizedlist> - <listitem><para><emphasis><filename>clutter-box2d</filename>:</emphasis> - Now resides in the <filename>meta-oe</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>evolution-data-server</filename>:</emphasis> - Now resides in the <filename>meta-gnome</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>gthumb</filename>:</emphasis> - Now resides in the <filename>meta-gnome</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>gtkhtml2</filename>:</emphasis> - Now resides in the <filename>meta-oe</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>gupnp</filename>:</emphasis> - Now resides in the <filename>meta-multimedia</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>gypsy</filename>:</emphasis> - Now resides in the <filename>meta-oe</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>libcanberra</filename>:</emphasis> - Now resides in the <filename>meta-gnome</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>libgdata</filename>:</emphasis> - Now resides in the <filename>meta-gnome</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>libmusicbrainz</filename>:</emphasis> - Now resides in the <filename>meta-multimedia</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>metacity</filename>:</emphasis> - Now resides in the <filename>meta-gnome</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>polkit</filename>:</emphasis> - Now resides in the <filename>meta-oe</filename> layer. - </para></listitem> - <listitem><para><emphasis><filename>zeroconf</filename>:</emphasis> - Now resides in the <filename>meta-networking</filename> layer. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.4-removals-and-renames'> - <title>Removals and Renames</title> - - <para> - The following list shows what has been removed or renamed: - <itemizedlist> - <listitem><para><emphasis><filename>evieext</filename>:</emphasis> - Removed because it has been removed from - <filename>xserver</filename> since 2008. - </para></listitem> - <listitem><para><emphasis>Gtk+ DirectFB:</emphasis> - Removed support because upstream Gtk+ no longer supports it - as of version 2.18. - </para></listitem> - <listitem><para><emphasis><filename>libxfontcache / xfontcacheproto</filename>:</emphasis> - Removed because they were removed from the Xorg server in 2008. - </para></listitem> - <listitem><para><emphasis><filename>libxp / libxprintapputil / libxprintutil / printproto</filename>:</emphasis> - Removed because the XPrint server was removed from - Xorg in 2008. - </para></listitem> - <listitem><para><emphasis><filename>libxtrap / xtrapproto</filename>:</emphasis> - Removed because their functionality was broken upstream. - </para></listitem> - <listitem><para><emphasis>linux-yocto 3.0 kernel:</emphasis> - Removed with linux-yocto 3.8 kernel being added. - The linux-yocto 3.2 and linux-yocto 3.4 kernels remain - as part of the release. - </para></listitem> - <listitem><para><emphasis><filename>lsbsetup</filename>:</emphasis> - Removed with functionality now provided by - <filename>lsbtest</filename>. - </para></listitem> - <listitem><para><emphasis><filename>matchbox-stroke</filename>:</emphasis> - Removed because it was never more than a proof-of-concept. - </para></listitem> - <listitem><para><emphasis><filename>matchbox-wm-2 / matchbox-theme-sato-2</filename>:</emphasis> - Removed because they are not maintained. - However, <filename>matchbox-wm</filename> and - <filename>matchbox-theme-sato</filename> are still - provided. - </para></listitem> - <listitem><para><emphasis><filename>mesa-dri</filename>:</emphasis> - Renamed to <filename>mesa</filename>. - </para></listitem> - <listitem><para><emphasis><filename>mesa-xlib</filename>:</emphasis> - Removed because it was no longer useful. - </para></listitem> - <listitem><para><emphasis><filename>mutter</filename>:</emphasis> - Removed because nothing ever uses it and the recipe is - very old. - </para></listitem> - <listitem><para><emphasis><filename>orinoco-conf</filename>:</emphasis> - Removed because it has become obsolete. - </para></listitem> - <listitem><para><emphasis><filename>update-modules</filename>:</emphasis> - Removed because it is no longer used. - The kernel module <filename>postinstall</filename> and - <filename>postrm</filename> scripts can now do the same - task without the use of this script. - </para></listitem> - <listitem><para><emphasis><filename>web</filename>:</emphasis> - Removed because it is not maintained. Superseded by - <filename>web-webkit</filename>. - </para></listitem> - <listitem><para><emphasis><filename>xf86bigfontproto</filename>:</emphasis> - Removed because upstream it has been disabled by default - since 2007. - Nothing uses <filename>xf86bigfontproto</filename>. - </para></listitem> - <listitem><para><emphasis><filename>xf86rushproto</filename>:</emphasis> - Removed because its dependency in - <filename>xserver</filename> was spurious and it was - removed in 2005. - </para></listitem> - <listitem><para><emphasis><filename>zypper / libzypp / sat-solver</filename>:</emphasis> - Removed and been functionally replaced with Smart - (<filename>python-smartpm</filename>) when RPM packaging - is used and package management is enabled on the target. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-1.5-release'> - <title>Moving to the Yocto Project 1.5 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 1.5 Release from the prior release. - </para> - - <section id='migration-1.5-host-dependency-changes'> - <title>Host Dependency Changes</title> - - <para> - The OpenEmbedded build system now has some additional requirements - on the host system: - <itemizedlist> - <listitem><para>Python 2.7.3+</para></listitem> - <listitem><para>Tar 1.24+</para></listitem> - <listitem><para>Git 1.7.8+</para></listitem> - <listitem><para>Patched version of Make if you are using - 3.82. - Most distributions that provide Make 3.82 use the patched - version.</para></listitem> - </itemizedlist> - If the Linux distribution you are using on your build host - does not provide packages for these, you can install and use - the Buildtools tarball, which provides an SDK-like environment - containing them. - </para> - - <para> - For more information on this requirement, see the - "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" - section. - </para> - </section> - - <section id='migration-1.5-atom-pc-bsp'> - <title><filename>atom-pc</filename> Board Support Package (BSP)</title> - - <para> - The <filename>atom-pc</filename> hardware reference BSP has been - replaced by a <filename>genericx86</filename> BSP. - This BSP is not necessarily guaranteed to work on all x86 - hardware, but it will run on a wider range of systems than the - <filename>atom-pc</filename> did. - <note> - Additionally, a <filename>genericx86-64</filename> BSP has - been added for 64-bit Atom systems. - </note> - </para> - </section> - - <section id='migration-1.5-bitbake'> - <title>BitBake</title> - - <para> - The following changes have been made that relate to BitBake: - <itemizedlist> - <listitem><para> - BitBake now supports a <filename>_remove</filename> - operator. - The addition of this operator means you will have to - rename any items in recipe space (functions, variables) - whose names currently contain - <filename>_remove_</filename> or end with - <filename>_remove</filename> to avoid unexpected behavior. - </para></listitem> - <listitem><para> - BitBake's global method pool has been removed. - This method is not particularly useful and led to clashes - between recipes containing functions that had the - same name.</para></listitem> - <listitem><para> - The "none" server backend has been removed. - The "process" server backend has been serving well as the - default for a long time now.</para></listitem> - <listitem><para> - The <filename>bitbake-runtask</filename> script has been - removed.</para></listitem> - <listitem><para> - <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename> - and - <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename> - are no longer added to - <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> - by default in <filename>bitbake.conf</filename>. - These version-specific <filename>PROVIDES</filename> - items were seldom used. - Attempting to use them could result in two versions being - built simultaneously rather than just one version due to - the way BitBake resolves dependencies.</para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.5-qa-warnings'> - <title>QA Warnings</title> - - <para> - The following changes have been made to the package QA checks: - <itemizedlist> - <listitem><para> - If you have customized - <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link> - or <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> - values in your configuration, check that they contain all of - the issues that you wish to be reported. - Previous Yocto Project versions contained a bug that meant - that any item not mentioned in <filename>ERROR_QA</filename> - or <filename>WARN_QA</filename> would be treated as a - warning. - Consequently, several important items were not already in - the default value of <filename>WARN_QA</filename>. - All of the possible QA checks are now documented in the - "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" - section.</para></listitem> - <listitem><para> - An additional QA check has been added to check if - <filename>/usr/share/info/dir</filename> is being installed. - Your recipe should delete this file within - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - if "make install" is installing it. - </para></listitem> - <listitem><para> - If you are using the buildhistory class, the check for the - package version going backwards is now controlled using a - standard QA check. - Thus, if you have customized your - <filename>ERROR_QA</filename> or - <filename>WARN_QA</filename> values and still wish to have - this check performed, you should add - "version-going-backwards" to your value for one or the - other variables depending on how you wish it to be handled. - See the documented QA checks in the - "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" - section. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.5-directory-layout-changes'> - <title>Directory Layout Changes</title> - - <para> - The following directory changes exist: - <itemizedlist> - <listitem><para> - Output SDK installer files are now named to include the - image name and tuning architecture through the - <link linkend='var-SDK_NAME'><filename>SDK_NAME</filename></link> - variable.</para></listitem> - <listitem><para> - Images and related files are now installed into a directory - that is specific to the machine, instead of a parent - directory containing output files for multiple machines. - The - <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> - variable continues to point to the directory containing - images for the current - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - and should be used anywhere there is a need to refer to - this directory. - The <filename>runqemu</filename> script now uses this - variable to find images and kernel binaries and will use - BitBake to determine the directory. - Alternatively, you can set the - <filename>DEPLOY_DIR_IMAGE</filename> variable in the - external environment.</para></listitem> - <listitem><para> - When buildhistory is enabled, its output is now written - under the - <link linkend='build-directory'>Build Directory</link> - rather than - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>. - Doing so makes it easier to delete - <filename>TMPDIR</filename> and preserve the build history. - Additionally, data for produced SDKs is now split by - <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link>. - </para></listitem> - <listitem><para> - The <filename>pkgdata</filename> directory produced as - part of the packaging process has been collapsed into a - single machine-specific directory. - This directory is located under - <filename>sysroots</filename> and uses a machine-specific - name (i.e. - <filename>tmp/sysroots/<replaceable>machine</replaceable>/pkgdata</filename>). - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.5-shortened-git-srcrev-values'> - <title>Shortened Git <filename>SRCREV</filename> Values</title> - - <para> - BitBake will now shorten revisions from Git repositories from the - normal 40 characters down to 10 characters within - <link linkend='var-SRCPV'><filename>SRCPV</filename></link> - for improved usability in path and file names. - This change should be safe within contexts where these revisions - are used because the chances of spatially close collisions - is very low. - Distant collisions are not a major issue in the way - the values are used. - </para> - </section> - - <section id='migration-1.5-image-features'> - <title><filename>IMAGE_FEATURES</filename></title> - - <para> - The following changes have been made that relate to - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>: - <itemizedlist> - <listitem><para> - The value of <filename>IMAGE_FEATURES</filename> is now - validated to ensure invalid feature items are not added. - Some users mistakenly add package names to this variable - instead of using - <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link> - in order to have the package added to the image, which does - not work. - This change is intended to catch those kinds of situations. - Valid <filename>IMAGE_FEATURES</filename> are drawn from - <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link> - definitions, - <link linkend='var-COMPLEMENTARY_GLOB'><filename>COMPLEMENTARY_GLOB</filename></link> - and a new "validitems" varflag on - <filename>IMAGE_FEATURES</filename>. - The "validitems" varflag change allows additional features - to be added if they are not provided using the previous - two mechanisms. - </para></listitem> - <listitem><para> - The previously deprecated "apps-console-core" - <filename>IMAGE_FEATURES</filename> item is no longer - supported. - Add "splash" to <filename>IMAGE_FEATURES</filename> if you - wish to have the splash screen enabled, since this is - all that apps-console-core was doing.</para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.5-run'> - <title><filename>/run</filename></title> - - <para> - The <filename>/run</filename> directory from the Filesystem - Hierarchy Standard 3.0 has been introduced. - You can find some of the implications for this change - <ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873'>here</ulink>. - The change also means that recipes that install files to - <filename>/var/run</filename> must be changed. - You can find a guide on how to make these changes - <ulink url='http://permalink.gmane.org/gmane.comp.handhelds.openembedded/58530'>here</ulink>. - </para> - </section> - - <section id='migration-1.5-removal-of-package-manager-database-within-image-recipes'> - <title>Removal of Package Manager Database Within Image Recipes</title> - - <para> - The image <filename>core-image-minimal</filename> no longer adds - <filename>remove_packaging_data_files</filename> to - <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></link>. - This addition is now handled automatically when "package-management" - is not in - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. - If you have custom image recipes that make this addition, - you should remove the lines, as they are not needed and might - interfere with correct operation of postinstall scripts. - </para> - </section> - - <section id='migration-1.5-images-now-rebuild-only-on-changes-instead-of-every-time'> - <title>Images Now Rebuild Only on Changes Instead of Every Time</title> - - <para> - The - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> - and other related image - construction tasks are no longer marked as "nostamp". - Consequently, they will only be re-executed when their inputs have - changed. - Previous versions of the OpenEmbedded build system always rebuilt - the image when requested rather when necessary. - </para> - </section> - - <section id='migration-1.5-task-recipes'> - <title>Task Recipes</title> - - <para> - The previously deprecated <filename>task.bbclass</filename> has - now been dropped. - For recipes that previously inherited from this class, you should - rename them from <filename>task-*</filename> to - <filename>packagegroup-*</filename> and inherit packagegroup - instead. - </para> - - <para> - For more information, see the - "<link linkend='ref-classes-packagegroup'><filename>packagegroup.bbclass</filename></link>" - section. - </para> - </section> - - <section id='migration-1.5-busybox'> - <title>BusyBox</title> - - <para> - By default, we now split BusyBox into two binaries: - one that is suid root for those components that need it, and - another for the rest of the components. - Splitting BusyBox allows for optimization that eliminates the - <filename>tinylogin</filename> recipe as recommended by upstream. - You can disable this split by setting - <link linkend='var-BUSYBOX_SPLIT_SUID'><filename>BUSYBOX_SPLIT_SUID</filename></link> - to "0". - </para> - </section> - - <section id='migration-1.5-automated-image-testing'> - <title>Automated Image Testing</title> - - <para> - A new automated image testing framework has been added - through the - <link linkend='ref-classes-testimage*'><filename>testimage.bbclass</filename></link> - class. - This framework replaces the older - <filename>imagetest-qemu</filename> framework. - </para> - - <para> - You can learn more about performing automated image tests in the - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='migration-1.5-build-history'> - <title>Build History</title> - - <para> - Following are changes to Build History: - <itemizedlist> - <listitem><para> - Installed package sizes: - <filename>installed-package-sizes.txt</filename> for an - image now records the size of the files installed by each - package instead of the size of each compressed package - archive file.</para></listitem> - <listitem><para> - The dependency graphs (<filename>depends*.dot</filename>) - now use the actual package names instead of replacing - dashes, dots and plus signs with underscores. - </para></listitem> - <listitem><para> - The <filename>buildhistory-diff</filename> and - <filename>buildhistory-collect-srcrevs</filename> - utilities have improved command-line handling. - Use the <filename>--help</filename> option for - each utility for more information on the new syntax. - </para></listitem> - </itemizedlist> - For more information on Build History, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='migration-1.5-udev'> - <title><filename>udev</filename></title> - - <para> - Following are changes to <filename>udev</filename>: - <itemizedlist> - <listitem><para> - <filename>udev</filename> no longer brings in - <filename>udev-extraconf</filename> automatically - through - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, - since this was originally intended to be optional. - If you need the extra rules, then add - <filename>udev-extraconf</filename> to your image. - </para></listitem> - <listitem><para> - <filename>udev</filename> no longer brings in - <filename>pciutils-ids</filename> or - <filename>usbutils-ids</filename> through - <filename>RRECOMMENDS</filename>. - These are not needed by <filename>udev</filename> itself - and removing them saves around 350KB. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.5-removed-renamed-recipes'> - <title>Removed and Renamed Recipes</title> - - <itemizedlist> - <listitem><para> - The <filename>linux-yocto</filename> 3.2 kernel has been - removed.</para></listitem> - <listitem><para> - <filename>libtool-nativesdk</filename> has been renamed to - <filename>nativesdk-libtool</filename>.</para></listitem> - <listitem><para> - <filename>tinylogin</filename> has been removed. - It has been replaced by a suid portion of Busybox. - See the - "<link linkend='migration-1.5-busybox'>BusyBox</link>" section - for more information.</para></listitem> - <listitem><para> - <filename>external-python-tarball</filename> has been renamed - to <filename>buildtools-tarball</filename>. - </para></listitem> - <listitem><para> - <filename>web-webkit</filename> has been removed. - It has been functionally replaced by - <filename>midori</filename>.</para></listitem> - <listitem><para> - <filename>imake</filename> has been removed. - It is no longer needed by any other recipe. - </para></listitem> - <listitem><para> - <filename>transfig-native</filename> has been removed. - It is no longer needed by any other recipe. - </para></listitem> - <listitem><para> - <filename>anjuta-remote-run</filename> has been removed. - Anjuta IDE integration has not been officially supported for - several releases.</para></listitem> - </itemizedlist> - </section> - - <section id='migration-1.5-other-changes'> - <title>Other Changes</title> - - <para> - Following is a list of short entries describing other changes: - <itemizedlist> - <listitem><para> - <filename>run-postinsts</filename>: Make this generic. - </para></listitem> - <listitem><para> - <filename>base-files</filename>: Remove the unnecessary - <filename>media/</filename><replaceable>xxx</replaceable> directories. - </para></listitem> - <listitem><para> - <filename>alsa-state</filename>: Provide an empty - <filename>asound.conf</filename> by default. - </para></listitem> - <listitem><para> - <filename>classes/image</filename>: Ensure - <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link> - supports pre-renamed package names.</para></listitem> - <listitem><para> - <filename>classes/rootfs_rpm</filename>: Implement - <filename>BAD_RECOMMENDATIONS</filename> for RPM. - </para></listitem> - <listitem><para> - <filename>systemd</filename>: Remove - <filename>systemd_unitdir</filename> if - <filename>systemd</filename> is not in - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. - </para></listitem> - <listitem><para> - <filename>systemd</filename>: Remove - <filename>init.d</filename> dir if - <filename>systemd</filename> unit file is present and - <filename>sysvinit</filename> is not a distro feature. - </para></listitem> - <listitem><para> - <filename>libpam</filename>: Deny all services for the - <filename>OTHER</filename> entries. - </para></listitem> - <listitem><para> - <filename>image.bbclass</filename>: Move - <filename>runtime_mapping_rename</filename> to avoid - conflict with <filename>multilib</filename>. - See - <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993'><filename>YOCTO #4993</filename></ulink> - in Bugzilla for more information. - </para></listitem> - <listitem><para> - <filename>linux-dtb</filename>: Use kernel build system - to generate the <filename>dtb</filename> files. - </para></listitem> - <listitem><para> - <filename>kern-tools</filename>: Switch from guilt to - new <filename>kgit-s2q</filename> tool. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-1.6-release'> - <title>Moving to the Yocto Project 1.6 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 1.6 Release from the prior release. - </para> - - - <section id='migration-1.6-archiver-class'> - <title><filename>archiver</filename> Class</title> - - <para> - The - <link linkend='ref-classes-archiver'><filename>archiver</filename></link> - class has been rewritten and its configuration has been simplified. - For more details on the source archiver, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='migration-1.6-packaging-changes'> - <title>Packaging Changes</title> - - <para> - The following packaging changes have been made: - <itemizedlist> - <listitem><para> - The <filename>binutils</filename> recipe no longer produces - a <filename>binutils-symlinks</filename> package. - <filename>update-alternatives</filename> is now used to - handle the preferred <filename>binutils</filename> - variant on the target instead. - </para></listitem> - <listitem><para> - The tc (traffic control) utilities have been split out of - the main <filename>iproute2</filename> package and put - into the <filename>iproute2-tc</filename> package. - </para></listitem> - <listitem><para> - The <filename>gtk-engines</filename> schemas have been - moved to a dedicated - <filename>gtk-engines-schemas</filename> package. - </para></listitem> - <listitem><para> - The <filename>armv7a</filename> with thumb package - architecture suffix has changed. - The suffix for these packages with the thumb - optimization enabled is "t2" as it should be. - Use of this suffix was not the case in the 1.5 release. - Architecture names will change within package feeds as a - result. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.6-bitbake'> - <title>BitBake</title> - - <para> - The following changes have been made to - <link linkend='bitbake-term'>BitBake</link>. - </para> - - <section id='migration-1.6-matching-branch-requirement-for-git-fetching'> - <title>Matching Branch Requirement for Git Fetching</title> - - <para> - When fetching source from a Git repository using - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>, - BitBake will now validate the - <link linkend='var-SRCREV'><filename>SRCREV</filename></link> - value against the branch. - You can specify the branch using the following form: - <literallayout class='monospaced'> - SRC_URI = "git://server.name/repository;branch=<replaceable>branchname</replaceable>" - </literallayout> - If you do not specify a branch, BitBake looks - in the default "master" branch. - </para> - - <para> - Alternatively, if you need to bypass this check (e.g. - if you are fetching a revision corresponding to a tag that - is not on any branch), you can add ";nobranch=1" to - the end of the URL within <filename>SRC_URI</filename>. - </para> - </section> - - <section id='migration-1.6-bitbake-deps'> - <title>Python Definition substitutions</title> - - <para> - BitBake had some previously deprecated Python definitions - within its <filename>bb</filename> module removed. - You should use their sub-module counterparts instead: - <itemizedlist> - <listitem><para><filename>bb.MalformedUrl</filename>: - Use <filename>bb.fetch.MalformedUrl</filename>. - </para></listitem> - <listitem><para><filename>bb.encodeurl</filename>: - Use <filename>bb.fetch.encodeurl</filename>. - </para></listitem> - <listitem><para><filename>bb.decodeurl</filename>: - Use <filename>bb.fetch.decodeurl</filename> - </para></listitem> - <listitem><para><filename>bb.mkdirhier</filename>: - Use <filename>bb.utils.mkdirhier</filename>. - </para></listitem> - <listitem><para><filename>bb.movefile</filename>: - Use <filename>bb.utils.movefile</filename>. - </para></listitem> - <listitem><para><filename>bb.copyfile</filename>: - Use <filename>bb.utils.copyfile</filename>. - </para></listitem> - <listitem><para><filename>bb.which</filename>: - Use <filename>bb.utils.which</filename>. - </para></listitem> - <listitem><para><filename>bb.vercmp_string</filename>: - Use <filename>bb.utils.vercmp_string</filename>. - </para></listitem> - <listitem><para><filename>bb.vercmp</filename>: - Use <filename>bb.utils.vercmp</filename>. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.6-bitbake-fetcher'> - <title>SVK Fetcher</title> - - <para> - The SVK fetcher has been removed from BitBake. - </para> - </section> - - <section id='migration-1.6-bitbake-console-output'> - <title>Console Output Error Redirection</title> - - <para> - The BitBake console UI will now output errors to - <filename>stderr</filename> instead of - <filename>stdout</filename>. - Consequently, if you are piping or redirecting the output of - <filename>bitbake</filename> to somewhere else, and you wish - to retain the errors, you will need to add - <filename>2>&1</filename> (or something similar) to the - end of your <filename>bitbake</filename> command line. - </para> - </section> - - <section id='migration-1.6-task-taskname-overrides'> - <title><filename>task-</filename><replaceable>taskname</replaceable> Overrides</title> - - <para> - <filename>task-</filename><replaceable>taskname</replaceable> overrides have been - adjusted so that tasks whose names contain underscores have the - underscores replaced by hyphens for the override so that they - now function properly. - For example, the task override for - <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> - is <filename>task-populate-sdk</filename>. - </para> - </section> - </section> - - <section id='migration-1.6-variable-changes'> - <title>Changes to Variables</title> - - <para> - The following variables have changed. - For information on the OpenEmbedded build system variables, see the - "<link linkend='ref-variables-glos'>Variables Glossary</link>" Chapter. - </para> - - <section id='migration-1.6-variable-changes-TMPDIR'> - <title><filename>TMPDIR</filename></title> - - <para> - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - can no longer be on an NFS mount. - NFS does not offer full POSIX locking and inode consistency - and can cause unexpected issues if used to store - <filename>TMPDIR</filename>. - </para> - - <para> - The check for this occurs on startup. - If <filename>TMPDIR</filename> is detected on an NFS mount, - an error occurs. - </para> - </section> - - <section id='migration-1.6-variable-changes-PRINC'> - <title><filename>PRINC</filename></title> - - <para> - The <filename>PRINC</filename> - variable has been deprecated and triggers a warning if - detected during a build. - For - <link linkend='var-PR'><filename>PR</filename></link> - increments on changes, use the PR service instead. - You can find out more about this service in the - "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>Working With a PR Service</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='migration-1.6-variable-changes-IMAGE_TYPES'> - <title><filename>IMAGE_TYPES</filename></title> - - <para> - The "sum.jffs2" option for - <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link> - has been replaced by the "jffs2.sum" option, which fits the - processing order. - </para> - </section> - - <section id='migration-1.6-variable-changes-COPY_LIC_MANIFEST'> - <title><filename>COPY_LIC_MANIFEST</filename></title> - - <para> - The - <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> - variable must - now be set to "1" rather than any value in order to enable - it. - </para> - </section> - - <section id='migration-1.6-variable-changes-COPY_LIC_DIRS'> - <title><filename>COPY_LIC_DIRS</filename></title> - - <para> - The - <link linkend='var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></link> - variable must - now be set to "1" rather than any value in order to enable - it. - </para> - </section> - - <section id='migration-1.6-variable-changes-PACKAGE_GROUP'> - <title><filename>PACKAGE_GROUP</filename></title> - - <para> - The - <link linkend='var-PACKAGE_GROUP'><filename>PACKAGE_GROUP</filename></link> - variable has been renamed to - <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link> - to more accurately reflect its purpose. - You can still use <filename>PACKAGE_GROUP</filename> but - the OpenEmbedded build system produces a warning message when - it encounters the variable. - </para> - </section> - - <section id='migration-1.6-variable-changes-variable-entry-behavior'> - <title>Preprocess and Post Process Command Variable Behavior</title> - - <para> - The following variables now expect a semicolon separated - list of functions to call and not arbitrary shell commands: - <literallayout class='monospaced'> - <link linkend='var-ROOTFS_PREPROCESS_COMMAND'>ROOTFS_PREPROCESS_COMMAND</link> - <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'>ROOTFS_POSTPROCESS_COMMAND</link> - <link linkend='var-SDK_POSTPROCESS_COMMAND'>SDK_POSTPROCESS_COMMAND</link> - <link linkend='var-POPULATE_SDK_POST_TARGET_COMMAND'>POPULATE_SDK_POST_TARGET_COMMAND</link> - <link linkend='var-POPULATE_SDK_POST_HOST_COMMAND'>POPULATE_SDK_POST_HOST_COMMAND</link> - <link linkend='var-IMAGE_POSTPROCESS_COMMAND'>IMAGE_POSTPROCESS_COMMAND</link> - <link linkend='var-IMAGE_PREPROCESS_COMMAND'>IMAGE_PREPROCESS_COMMAND</link> - <link linkend='var-ROOTFS_POSTUNINSTALL_COMMAND'>ROOTFS_POSTUNINSTALL_COMMAND</link> - <link linkend='var-ROOTFS_POSTINSTALL_COMMAND'>ROOTFS_POSTINSTALL_COMMAND</link> - </literallayout> - For migration purposes, you can simply wrap shell commands in - a shell function and then call the function. - Here is an example: - <literallayout class='monospaced'> - my_postprocess_function() { - echo "hello" > ${IMAGE_ROOTFS}/hello.txt - } - ROOTFS_POSTPROCESS_COMMAND += "my_postprocess_function; " - </literallayout> - </para> - </section> - </section> - - <section id='migration-1.6-package-test-ptest'> - <title>Package Test (ptest)</title> - - <para> - Package Tests (ptest) are built but not installed by default. - For information on using Package Tests, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages with ptest</ulink>" - section in the Yocto Project Development Tasks Manual. - For information on the <filename>ptest</filename> class, see the - "<link linkend='ref-classes-ptest'><filename>ptest.bbclass</filename></link>" - section. - </para> - </section> - - <section id='migration-1.6-build-changes'> - <title>Build Changes</title> - - <para> - Separate build and source directories have been enabled - by default for selected recipes where it is known to work - (a whitelist) and for all recipes that inherit the - <link linkend='ref-classes-cmake'><filename>cmake</filename></link> - class. - In future releases the - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> - class will enable a separate build directory by default as - well. - Recipes building Autotools-based - software that fails to build with a separate build directory - should be changed to inherit from the - <link linkend='ref-classes-autotools'><filename>autotools-brokensep</filename></link> - class instead of the <filename>autotools</filename> or - <filename>autotools_stage</filename>classes. - </para> - </section> - - <section id='migration-1.6-building-qemu-native'> - <title><filename>qemu-native</filename></title> - - <para> - <filename>qemu-native</filename> now builds without - SDL-based graphical output support by default. - The following additional lines are needed in your - <filename>local.conf</filename> to enable it: - <literallayout class='monospaced'> - PACKAGECONFIG_pn-qemu-native = "sdl" - ASSUME_PROVIDED += "libsdl-native" - </literallayout> - <note> - The default <filename>local.conf</filename> - contains these statements. - Consequently, if you are building a headless system and using - a default <filename>local.conf</filename> file, you will need - comment these two lines out. - </note> - </para> - </section> - - <section id='migration-1.6-core-image-basic'> - <title><filename>core-image-basic</filename></title> - - <para> - <filename>core-image-basic</filename> has been renamed to - <filename>core-image-full-cmdline</filename>. - </para> - - <para> - In addition to <filename>core-image-basic</filename> being renamed, - <filename>packagegroup-core-basic</filename> has been renamed to - <filename>packagegroup-core-full-cmdline</filename> to match. - </para> - </section> - - <section id='migration-1.6-licensing'> - <title>Licensing</title> - - <para> - The top-level <filename>LICENSE</filename> file has been changed - to better describe the license of the various components of - <link linkend='oe-core'>OE-Core</link>. - However, the licensing itself remains unchanged. - </para> - - <para> - Normally, this change would not cause any side-effects. - However, some recipes point to this file within - <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link> - (as <filename>${COREBASE}/LICENSE</filename>) and thus the - accompanying checksum must be changed from - 3f40d7994397109285ec7b81fdeb3b58 to - 4d92cd373abda3937c2bc47fbc49d690. - A better alternative is to have - <filename>LIC_FILES_CHKSUM</filename> point to a file - describing the license that is distributed with the source - that the recipe is building, if possible, rather than pointing - to <filename>${COREBASE}/LICENSE</filename>. - </para> - </section> - - <section id='migration-1.6-cflags-options'> - <title><filename>CFLAGS</filename> Options</title> - - <para> - The "-fpermissive" option has been removed from the default - <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> - value. - You need to take action on individual recipes that fail when - building with this option. - You need to either patch the recipes to fix the issues reported by - the compiler, or you need to add "-fpermissive" to - <filename>CFLAGS</filename> in the recipes. - </para> - </section> - - <section id='migration-1.6-custom-images'> - <title>Custom Image Output Types</title> - - <para> - Custom image output types, as selected using - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>, - must declare their dependencies on other image types (if any) using - a new - <link linkend='var-IMAGE_TYPEDEP'><filename>IMAGE_TYPEDEP</filename></link> - variable. - </para> - </section> - - <section id='migration-1.6-do-package-write-task'> - <title>Tasks</title> - - <para> - The <filename>do_package_write</filename> task has been removed. - The task is no longer needed. - </para> - </section> - - <section id='migration-1.6-update-alternatives-provider'> - <title><filename>update-alternative</filename> Provider</title> - - <para> - The default <filename>update-alternatives</filename> provider has - been changed from <filename>opkg</filename> to - <filename>opkg-utils</filename>. - This change resolves some troublesome circular dependencies. - The runtime package has also been renamed from - <filename>update-alternatives-cworth</filename> - to <filename>update-alternatives-opkg</filename>. - </para> - </section> - - <section id='migration-1.6-virtclass-overrides'> - <title><filename>virtclass</filename> Overrides</title> - - <para> - The <filename>virtclass</filename> overrides are now deprecated. - Use the equivalent class overrides instead (e.g. - <filename>virtclass-native</filename> becomes - <filename>class-native</filename>.) - </para> - </section> - - <section id='migration-1.6-removed-renamed-recipes'> - <title>Removed and Renamed Recipes</title> - - <para> - The following recipes have been removed: - <itemizedlist> - <listitem><para><filename>packagegroup-toolset-native</filename> - - This recipe is largely unused. - </para></listitem> - <listitem><para><filename>linux-yocto-3.8</filename> - - Support for the Linux yocto 3.8 kernel has been dropped. - Support for the 3.10 and 3.14 kernels have been added - with the <filename>linux-yocto-3.10</filename> and - <filename>linux-yocto-3.14</filename> recipes. - </para></listitem> - <listitem><para><filename>ocf-linux</filename> - - This recipe has been functionally replaced using - <filename>cryptodev-linux</filename>. - </para></listitem> - <listitem><para><filename>genext2fs</filename> - - <filename>genext2fs</filename> is no longer used by the - build system and is unmaintained upstream. - </para></listitem> - <listitem><para><filename>js</filename> - - This provided an ancient version of Mozilla's javascript - engine that is no longer needed. - </para></listitem> - <listitem><para><filename>zaurusd</filename> - - The recipe has been moved to the - <filename>meta-handheld</filename> layer. - </para></listitem> - <listitem><para><filename>eglibc 2.17</filename> - - Replaced by the <filename>eglibc 2.19</filename> - recipe. - </para></listitem> - <listitem><para><filename>gcc 4.7.2</filename> - - Replaced by the now stable - <filename>gcc 4.8.2</filename>. - </para></listitem> - <listitem><para><filename>external-sourcery-toolchain</filename> - - this recipe is now maintained in the - <filename>meta-sourcery</filename> layer. - </para></listitem> - <listitem><para><filename>linux-libc-headers-yocto 3.4+git</filename> - - Now using version 3.10 of the - <filename>linux-libc-headers</filename> by default. - </para></listitem> - <listitem><para><filename>meta-toolchain-gmae</filename> - - This recipe is obsolete. - </para></listitem> - <listitem><para><filename>packagegroup-core-sdk-gmae</filename> - - This recipe is obsolete. - </para></listitem> - <listitem><para><filename>packagegroup-core-standalone-gmae-sdk-target</filename> - - This recipe is obsolete. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.6-removed-classes'> - <title>Removed Classes</title> - - <para> - The following classes have become obsolete and have been removed: - <itemizedlist> - <listitem><para><filename>module_strip</filename> - </para></listitem> - <listitem><para><filename>pkg_metainfo</filename> - </para></listitem> - <listitem><para><filename>pkg_distribute</filename> - </para></listitem> - <listitem><para><filename>image-empty</filename> - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.6-reference-bsps'> - <title>Reference Board Support Packages (BSPs)</title> - - <para> - The following reference BSPs changes occurred: - <itemizedlist> - <listitem><para>The BeagleBoard - (<filename>beagleboard</filename>) ARM reference hardware - has been replaced by the BeagleBone - (<filename>beaglebone</filename>) hardware. - </para></listitem> - <listitem><para>The RouterStation Pro - (<filename>routerstationpro</filename>) MIPS reference - hardware has been replaced by the EdgeRouter Lite - (<filename>edgerouter</filename>) hardware. - </para></listitem> - </itemizedlist> - The previous reference BSPs for the - <filename>beagleboard</filename> and - <filename>routerstationpro</filename> machines are still available - in a new <filename>meta-yocto-bsp-old</filename> layer in the - <ulink url='&YOCTO_GIT_URL;'>Source Repositories</ulink> - at - <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/'>http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/</ulink>. - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-1.7-release'> - <title>Moving to the Yocto Project 1.7 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 1.7 Release from the prior release. - </para> - - <section id='migration-1.7-changes-to-setting-qemu-packageconfig-options'> - <title>Changes to Setting QEMU <filename>PACKAGECONFIG</filename> Options in <filename>local.conf</filename></title> - - <para> - The QEMU recipe now uses a number of - <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> - options to enable various optional features. - The method used to set defaults for these options means that - existing - <filename>local.conf</filename> files will need to be be - modified to append to <filename>PACKAGECONFIG</filename> for - <filename>qemu-native</filename> and - <filename>nativesdk-qemu</filename> instead of setting it. - In other words, to enable graphical output for QEMU, you should - now have these lines in <filename>local.conf</filename>: - <literallayout class='monospaced'> - PACKAGECONFIG_append_pn-qemu-native = " sdl" - PACKAGECONFIG_append_pn-nativesdk-qemu = " sdl" - </literallayout> - </para> - </section> - - <section id='migration-1.7-minimum-git-version'> - <title>Minimum Git version</title> - - <para> - The minimum - <ulink url='&YOCTO_DOCS_OM_URL;#git'>Git</ulink> version - required on the build host is now 1.7.8 because the - <filename>--list</filename> option is now required by - BitBake's Git fetcher. - As always, if your host distribution does not provide a version of - Git that meets this requirement, you can use the - <filename>buildtools-tarball</filename> that does. - See the - "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" - section for more information. - </para> - </section> - - <section id='migration-1.7-autotools-class-changes'> - <title>Autotools Class Changes</title> - - <para> - The following - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> - class changes occurred: - <itemizedlist> - <listitem><para><emphasis> - A separate build directory is now used by default:</emphasis> - The <filename>autotools</filename> class has been changed - to use a directory for building - (<link linkend='var-B'><filename>B</filename></link>), - which is separate from the source directory - (<link linkend='var-S'><filename>S</filename></link>). - This is commonly referred to as - <filename>B != S</filename>, or an out-of-tree build.</para> - <para>If the software being built is already capable of - building in a directory separate from the source, you - do not need to do anything. - However, if the software is not capable of being built - in this manner, you will - need to either patch the software so that it can build - separately, or you will need to change the recipe to - inherit the - <link linkend='ref-classes-autotools'><filename>autotools-brokensep</filename></link> - class instead of the <filename>autotools</filename> or - <filename>autotools_stage</filename> classes. - </para></listitem> - <listitem><para><emphasis> - The <filename>--foreign</filename> option is - no longer passed to <filename>automake</filename> when - running <filename>autoconf</filename>:</emphasis> - This option tells <filename>automake</filename> that a - particular software package does not follow the GNU - standards and therefore should not be expected - to distribute certain files such as - <filename>ChangeLog</filename>, - <filename>AUTHORS</filename>, and so forth. - Because the majority of upstream software packages already - tell <filename>automake</filename> to enable foreign mode - themselves, the option is mostly superfluous. - However, some recipes will need patches for this change. - You can easily make the change by patching - <filename>configure.ac</filename> so that it passes - "foreign" to <filename>AM_INIT_AUTOMAKE()</filename>. - See - <ulink url='http://cgit.openembedded.org/openembedded-core/commit/?id=01943188f85ce6411717fb5bf702d609f55813f2'>this commit</ulink> - for an example showing how to make the patch. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.7-binary-configuration-scripts-disabled'> - <title>Binary Configuration Scripts Disabled</title> - - <para> - Some of the core recipes that package binary configuration scripts - now disable the scripts due to the - scripts previously requiring error-prone path substitution. - Software that links against these libraries using these scripts - should use the much more robust <filename>pkg-config</filename> - instead. - The list of recipes changed in this version (and their - configuration scripts) is as follows: - <literallayout class='monospaced'> - directfb (directfb-config) - freetype (freetype-config) - gpgme (gpgme-config) - libassuan (libassuan-config) - libcroco (croco-6.0-config) - libgcrypt (libgcrypt-config) - libgpg-error (gpg-error-config) - libksba (ksba-config) - libpcap (pcap-config) - libpcre (pcre-config) - libpng (libpng-config, libpng16-config) - libsdl (sdl-config) - libusb-compat (libusb-config) - libxml2 (xml2-config) - libxslt (xslt-config) - ncurses (ncurses-config) - neon (neon-config) - npth (npth-config) - pth (pth-config) - taglib (taglib-config) - </literallayout> - Additionally, support for <filename>pkg-config</filename> has been - added to some recipes in the previous list in the rare cases - where the upstream software package does not already provide - it. - </para> - </section> - - <section id='migration-1.7-glibc-replaces-eglibc'> - <title><filename>eglibc 2.19</filename> Replaced with <filename>glibc 2.20</filename></title> - - <para> - Because <filename>eglibc</filename> and - <filename>glibc</filename> were already fairly close, this - replacement should not require any significant changes to other - software that links to <filename>eglibc</filename>. - However, there were a number of minor changes in - <filename>glibc 2.20</filename> upstream that could require - patching some software (e.g. the removal of the - <filename>_BSD_SOURCE</filename> feature test macro). - </para> - - <para> - <filename>glibc 2.20</filename> requires version 2.6.32 or greater - of the Linux kernel. - Thus, older kernels will no longer be usable in conjunction with it. - </para> - - <para> - For full details on the changes in <filename>glibc 2.20</filename>, - see the upstream release notes - <ulink url='https://sourceware.org/ml/libc-alpha/2014-09/msg00088.html'>here</ulink>. - </para> - </section> - - <section id='migration-1.7-kernel-module-autoloading'> - <title>Kernel Module Autoloading</title> - - <para> - The - <link linkend='var-module_autoload'><filename>module_autoload_*</filename></link> - variable is now deprecated and a new - <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> - variable should be used instead. - Also, - <link linkend='var-module_conf'><filename>module_conf_*</filename></link> - must now be used in conjunction with a new - <link linkend='var-KERNEL_MODULE_PROBECONF'><filename>KERNEL_MODULE_PROBECONF</filename></link> - variable. - The new variables no longer require you to specify the module name - as part of the variable name. - This change not only simplifies usage but also allows the values - of these variables to be appropriately incorporated into task - signatures and thus trigger the appropriate tasks to re-execute - when changed. - You should replace any references to - <filename>module_autoload_*</filename> with - <filename>KERNEL_MODULE_AUTOLOAD</filename>, and add any modules - for which <filename>module_conf_*</filename> is specified to - <filename>KERNEL_MODULE_PROBECONF</filename>. - </para> - </section> - - <section id='migration-1.7-qa-check-changes'> - <title>QA Check Changes</title> - - <para> - The following changes have occurred to the QA check process: - <itemizedlist> - <listitem><para> - Additional QA checks <filename>file-rdeps</filename> - and <filename>build-deps</filename> have been added in - order to verify that file dependencies are satisfied - (e.g. package contains a script requiring - <filename>/bin/bash</filename>) and build-time dependencies - are declared, respectively. - For more information, please see the - "<link linkend='ref-qa-checks'>QA Error and Warning Messages</link>" - chapter. - </para></listitem> - <listitem><para> - Package QA checks are now performed during a new - <link linkend='ref-tasks-package_qa'><filename>do_package_qa</filename></link> - task rather than being part of the - <link linkend='ref-tasks-package'><filename>do_package</filename></link> - task. - This allows more parallel execution. - This change is unlikely to be an issue except for highly - customized recipes that disable packaging tasks themselves - by marking them as <filename>noexec</filename>. - For those packages, you will need to disable the - <filename>do_package_qa</filename> task as well. - </para></listitem> - <listitem><para> - Files being overwritten during the - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task now trigger an error instead of a warning. - Recipes should not be overwriting files written to the - sysroot by other recipes. - If you have these types of recipes, you need to alter them - so that they do not overwrite these files.</para> - <para>You might now receive this error after changes in - configuration or metadata resulting in orphaned files - being left in the sysroot. - If you do receive this error, the way to resolve the issue - is to delete your - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - or to move it out of the way and then re-start the build. - Anything that has been fully built up to that point and - does not need rebuilding will be restored from the shared - state cache and the rest of the build will be able to - proceed as normal. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.7-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been removed: - <itemizedlist> - <listitem><para> - <filename>x-load</filename>: - This recipe has been superseded by - U-boot SPL for all Cortex-based TI SoCs. - For legacy boards, the <filename>meta-ti</filename> - layer, which contains a maintained recipe, should be used - instead. - </para></listitem> - <listitem><para> - <filename>ubootchart</filename>: - This recipe is obsolete. - A <filename>bootchart2</filename> recipe has been added - to functionally replace it. - </para></listitem> - <listitem><para> - <filename>linux-yocto 3.4</filename>: - Support for the linux-yocto 3.4 kernel has been dropped. - Support for the 3.10 and 3.14 kernels remains, while - support for version 3.17 has been added. - </para></listitem> - <listitem><para> - <filename>eglibc</filename> has been removed in favor of - <filename>glibc</filename>. - See the - "<link linkend='migration-1.7-glibc-replaces-eglibc'><filename>eglibc 2.19</filename> Replaced with <filename>glibc 2.20</filename></link>" - section for more information. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.7-miscellaneous-changes'> - <title>Miscellaneous Changes</title> - - <para> - The following miscellaneous change occurred: - <itemizedlist> - <listitem><para> - The build history feature now writes - <filename>build-id.txt</filename> instead of - <filename>build-id</filename>. - Additionally, <filename>build-id.txt</filename> - now contains the full build header as printed by - BitBake upon starting the build. - You should manually remove old "build-id" files from your - existing build history repositories to avoid confusion. - For information on the build history feature, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" - section in the Yocto Project Development Tasks Manual. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-1.8-release'> - <title>Moving to the Yocto Project 1.8 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 1.8 Release from the prior release. - </para> - - <section id='migration-1.8-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been removed: - <itemizedlist> - <listitem><para><filename>owl-video</filename>: - Functionality replaced by <filename>gst-player</filename>. - </para></listitem> - <listitem><para><filename>gaku</filename>: - Functionality replaced by <filename>gst-player</filename>. - </para></listitem> - <listitem><para><filename>gnome-desktop</filename>: - This recipe is now available in - <filename>meta-gnome</filename> and is no longer needed. - </para></listitem> - <listitem><para><filename>gsettings-desktop-schemas</filename>: - This recipe is now available in - <filename>meta-gnome</filename> and is no longer needed. - </para></listitem> - <listitem><para><filename>python-argparse</filename>: - The <filename>argparse</filename> module is already - provided in the default Python distribution in a - package named <filename>python-argparse</filename>. - Consequently, the separate - <filename>python-argparse</filename> recipe is no - longer needed. - </para></listitem> - <listitem><para><filename>telepathy-python, libtelepathy, telepathy-glib, telepathy-idle, telepathy-mission-control</filename>: - All these recipes have moved to - <filename>meta-oe</filename> and are consequently no - longer needed by any recipes in OpenEmbedded-Core. - </para></listitem> - <listitem><para><filename>linux-yocto_3.10</filename> and <filename>linux-yocto_3.17</filename>: - Support for the linux-yocto 3.10 and 3.17 kernels has been - dropped. - Support for the 3.14 kernel remains, while support for - 3.19 kernel has been added. - </para></listitem> - <listitem><para><filename>poky-feed-config-opkg</filename>: - This recipe has become obsolete and is no longer needed. - Use <filename>distro-feed-config</filename> from - <filename>meta-oe</filename> instead. - </para></listitem> - <listitem><para><filename>libav 0.8.x</filename>: - <filename>libav 9.x</filename> is now used. - </para></listitem> - <listitem><para><filename>sed-native</filename>: - No longer needed. - A working version of <filename>sed</filename> is expected - to be provided by the host distribution. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.8-bluez'> - <title>BlueZ 4.x / 5.x Selection</title> - - <para> - Proper built-in support for selecting BlueZ 5.x in preference - to the default of 4.x now exists. - To use BlueZ 5.x, simply add "bluez5" to your - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - value. - If you had previously added append files - (<filename>*.bbappend</filename>) to make this selection, you can - now remove them. - </para> - - <para> - Additionally, a - <link linkend='ref-classes-bluetooth'><filename>bluetooth</filename></link> - class has been added to make selection of the appropriate bluetooth - support within a recipe a little easier. - If you wish to make use of this class in a recipe, add something - such as the following: - <literallayout class='monospaced'> - inherit bluetooth - PACKAGECONFIG ??= "${@bb.utils.contains('DISTRO_FEATURES', 'bluetooth', '${BLUEZ}', '', d)} - PACKAGECONFIG[bluez4] = "--enable-bluetooth,--disable-bluetooth,bluez4" - PACKAGECONFIG[bluez5] = "--enable-bluez5,--disable-bluez5,bluez5" - </literallayout> - </para> - </section> - - <section id='migration-1.8-kernel-build-changes'> - <title>Kernel Build Changes</title> - - <para> - The kernel build process was changed to place the source - in a common shared work area and to place build artifacts - separately in the source code tree. - In theory, migration paths have been provided for most common - usages in kernel recipes but this might not work in all cases. - In particular, users need to ensure that - <filename>${S}</filename> (source files) and - <filename>${B}</filename> (build artifacts) are used - correctly in functions such as - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - and - <link linkend='ref-tasks-install'><filename>do_install</filename></link>. - For kernel recipes that do not inherit from - <filename>kernel-yocto</filename> or include - <filename>linux-yocto.inc</filename>, you might wish to - refer to the <filename>linux.inc</filename> file in the - <filename>meta-oe</filename> layer for the kinds of changes you - need to make. - For reference, here is the - <ulink url='http://cgit.openembedded.org/meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee'>commit</ulink> - where the <filename>linux.inc</filename> file in - <filename>meta-oe</filename> was updated. - </para> - - <para> - Recipes that rely on the kernel source code and do not inherit - the module classes might need to add explicit dependencies on - the <filename>do_shared_workdir</filename> kernel task, for example: - <literallayout class='monospaced'> - do_configure[depends] += "virtual/kernel:do_shared_workdir" - </literallayout> - </para> - </section> - - <section id='migration-1.8-ssl'> - <title>SSL 3.0 is Now Disabled in OpenSSL</title> - - <para> - SSL 3.0 is now disabled when building OpenSSL. - Disabling SSL 3.0 avoids any lingering instances of the POODLE - vulnerability. - If you feel you must re-enable SSL 3.0, then you can add an - append file (<filename>*.bbappend</filename>) for the - <filename>openssl</filename> recipe to remove "-no-ssl3" - from - <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>. - </para> - </section> - - <section id='migration-1.8-default-sysroot-poisoning'> - <title>Default Sysroot Poisoning</title> - - <para> - <filename>gcc's</filename> default sysroot and include directories - are now "poisoned". - In other words, the sysroot and include directories are being - redirected to a non-existent location in order to catch when - host directories are being used due to the correct options not - being passed. - This poisoning applies both to the cross-compiler used within the - build and to the cross-compiler produced in the SDK. - </para> - - <para> - If this change causes something in the build to fail, it almost - certainly means the various compiler flags and commands are not - being passed correctly to the underlying piece of software. - In such cases, you need to take corrective steps. - </para> - </section> - - <section id='migration-1.8-rebuild-improvements'> - <title>Rebuild Improvements</title> - - <para> - Changes have been made to the - <link linkend='ref-classes-base'><filename>base</filename></link>, - <link linkend='ref-classes-autotools'><filename>autotools</filename></link>, - and - <link linkend='ref-classes-cmake'><filename>cmake</filename></link> - classes to clean out generated files when the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task needs to be re-executed. - </para> - - <para> - One of the improvements is to attempt to run "make clean" during - the <filename>do_configure</filename> task if a - <filename>Makefile</filename> exists. - Some software packages do not provide a working clean target - within their make files. - If you have such recipes, you need to set - <link linkend='var-CLEANBROKEN'><filename>CLEANBROKEN</filename></link> - to "1" within the recipe, for example: - <literallayout class='monospaced'> - CLEANBROKEN = "1" - </literallayout> - </para> - </section> - - <section id='migration-1.8-qa-check-and-validation-changes'> - <title>QA Check and Validation Changes</title> - - <para> - The following QA Check and Validation Changes have occurred: - <itemizedlist> - <listitem><para> - Usage of <filename>PRINC</filename> - previously triggered a warning. - It now triggers an error. - You should remove any remaining usage of - <filename>PRINC</filename> in any recipe or append file. - </para></listitem> - <listitem><para> - An additional QA check has been added to detect usage of - <filename>${D}</filename> in - <link linkend='var-FILES'><filename>FILES</filename></link> - values where - <link linkend='var-D'><filename>D</filename></link> values - should not be used at all. - The same check ensures that <filename>$D</filename> is used - in - <filename>pkg_preinst/pkg_postinst/pkg_prerm/pkg_postrm</filename> - functions instead of <filename>${D}</filename>. - </para></listitem> - <listitem><para> - <link linkend='var-S'><filename>S</filename></link> now - needs to be set to a valid value within a recipe. - If <filename>S</filename> is not set in the recipe, the - directory is not automatically created. - If <filename>S</filename> does not point to a directory - that exists at the time the - <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> - task finishes, a warning will be shown. - </para></listitem> - <listitem><para> - <link linkend='var-LICENSE'><filename>LICENSE</filename></link> - is now validated for correct formatting of multiple - licenses. - If the format is invalid (e.g. multiple licenses are - specified with no operators to specify how the multiple - licenses interact), then a warning will be shown. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-1.8-miscellaneous-changes'> - <title>Miscellaneous Changes</title> - - <para> - The following miscellaneous changes have occurred: - <itemizedlist> - <listitem><para> - The <filename>send-error-report</filename> script now - expects a "-s" option to be specified before the server - address. - This assumes a server address is being specified. - </para></listitem> - <listitem><para> - The <filename>oe-pkgdata-util</filename> script now - expects a "-p" option to be specified before the - <filename>pkgdata</filename> directory, which is now - optional. - If the <filename>pkgdata</filename> directory is not - specified, the script will run BitBake to query - <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> - from the build environment. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-2.0-release'> - <title>Moving to the Yocto Project 2.0 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 2.0 Release from the prior release. - </para> - - <section id='migration-2.0-gcc-5'> - <title>GCC 5</title> - - <para> - The default compiler is now GCC 5.2. - This change has required fixes for compilation errors in a number - of other recipes. - </para> - - <para> - One important example is a fix for when the Linux kernel freezes at - boot time on ARM when built with GCC 5. - If you are using your own kernel recipe or source tree and - building for ARM, you will likely need to apply this - <ulink url='https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit?id=a077224fd35b2f7fbc93f14cf67074fc792fbac2'>patch</ulink>. - The standard <filename>linux-yocto</filename> kernel source tree - already has a workaround for the same issue. - </para> - - <para> - For further details, see - <ulink url='https://gcc.gnu.org/gcc-5/changes.html'></ulink> and - the porting guide at - <ulink url='https://gcc.gnu.org/gcc-5/porting_to.html'></ulink>. - </para> - - <para> - Alternatively, you can switch back to GCC 4.9 or 4.8 by - setting <filename>GCCVERSION</filename> in your configuration, - as follows: - <literallayout class='monospaced'> - GCCVERSION = "4.9%" - </literallayout> - </para> - </section> - - <section id='migration-2.0-Gstreamer-0.10-removed'> - <title>Gstreamer 0.10 Removed</title> - - <para> - Gstreamer 0.10 has been removed in favor of Gstreamer 1.x. - As part of the change, recipes for Gstreamer 0.10 and related - software are now located - in <filename>meta-multimedia</filename>. - This change results in Qt4 having Phonon and Gstreamer - support in QtWebkit disabled by default. - </para> - </section> - - <section id='migration-2.0-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been moved or removed: - <itemizedlist> - <listitem><para> - <filename>bluez4</filename>: The recipe is obsolete and - has been moved due to <filename>bluez5</filename> - becoming fully integrated. - The <filename>bluez4</filename> recipe now resides in - <filename>meta-oe</filename>. - </para></listitem> - <listitem><para> - <filename>gamin</filename>: The recipe is obsolete and - has been removed. - </para></listitem> - <listitem><para> - <filename>gnome-icon-theme</filename>: The recipe's - functionally has been replaced by - <filename>adwaita-icon-theme</filename>. - </para></listitem> - <listitem><para> - Gstreamer 0.10 Recipes: Recipes for Gstreamer 0.10 have - been removed in favor of the recipes for Gstreamer 1.x. - </para></listitem> - <listitem><para> - <filename>insserv</filename>: The recipe is obsolete and - has been removed. - </para></listitem> - <listitem><para> - <filename>libunique</filename>: The recipe is no longer - used and has been moved to <filename>meta-oe</filename>. - </para></listitem> - <listitem><para> - <filename>midori</filename>: The recipe's functionally - has been replaced by <filename>epiphany</filename>. - </para></listitem> - <listitem><para> - <filename>python-gst</filename>: The recipe is obsolete - and has been removed since it only contains bindings for - Gstreamer 0.10. - </para></listitem> - <listitem><para> - <filename>qt-mobility</filename>: The recipe is obsolete and - has been removed since it requires - <filename>Gstreamer 0.10</filename>, which has been - replaced. - </para></listitem> - <listitem><para> - <filename>subversion</filename>: All 1.6.x versions of this - recipe have been removed. - </para></listitem> - <listitem><para> - <filename>webkit-gtk</filename>: The older 1.8.3 version - of this recipe has been removed in favor of - <filename>webkitgtk</filename>. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.0-bitbake-datastore-improvements'> - <title>BitBake datastore improvements</title> - - <para> - The method by which BitBake's datastore handles overrides has - changed. - Overrides are now applied dynamically and - <filename>bb.data.update_data()</filename> is now a no-op. - Thus, <filename>bb.data.update_data()</filename> is no longer - required in order to apply the correct overrides. - In practice, this change is unlikely to require any changes to - Metadata. - However, these minor changes in behavior exist: - <itemizedlist> - <listitem><para> - All potential overrides are now visible in the variable - history as seen when you run the following: - <literallayout class='monospaced'> - $ bitbake -e - </literallayout> - </para></listitem> - <listitem><para> - <filename>d.delVar('</filename><replaceable>VARNAME</replaceable><filename>')</filename> and - <filename>d.setVar('</filename><replaceable>VARNAME</replaceable><filename>', None)</filename> - result in the variable and all of its overrides being - cleared out. - Before the change, only the non-overridden values - were cleared. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.0-shell-message-function-changes'> - <title>Shell Message Function Changes</title> - - <para> - The shell versions of the BitBake message functions (i.e. - <filename>bbdebug</filename>, <filename>bbnote</filename>, - <filename>bbwarn</filename>, <filename>bbplain</filename>, - <filename>bberror</filename>, and <filename>bbfatal</filename>) - are now connected through to their BitBake equivalents - <filename>bb.debug()</filename>, <filename>bb.note()</filename>, - <filename>bb.warn()</filename>, <filename>bb.plain()</filename>, - <filename>bb.error()</filename>, and - <filename>bb.fatal()</filename>, respectively. - Thus, those message functions that you would expect to be printed - by the BitBake UI are now actually printed. - In practice, this change means two things: - <itemizedlist> - <listitem><para> - If you now see messages on the console that you did not - previously see as a result of this change, you might - need to clean up the calls to - <filename>bbwarn</filename>, <filename>bberror</filename>, - and so forth. - Or, you might want to simply remove the calls. - </para></listitem> - <listitem><para> - The <filename>bbfatal</filename> message function now - suppresses the full error log in the UI, which means any - calls to <filename>bbfatal</filename> where you still - wish to see the full error log should be replaced by - <filename>die</filename> or - <filename>bbfatal_log</filename>. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.0-extra-development-debug-package-cleanup'> - <title>Extra Development/Debug Package Cleanup</title> - - <para> - The following recipes have had extra - <filename>dev/dbg</filename> packages removed: - <itemizedlist> - <listitem><para> - <filename>acl</filename> - </para></listitem> - <listitem><para> - <filename>apmd</filename> - </para></listitem> - <listitem><para> - <filename>aspell</filename> - </para></listitem> - <listitem><para> - <filename>attr</filename> - </para></listitem> - <listitem><para> - <filename>augeas</filename> - </para></listitem> - <listitem><para> - <filename>bzip2</filename> - </para></listitem> - <listitem><para> - <filename>cogl</filename> - </para></listitem> - <listitem><para> - <filename>curl</filename> - </para></listitem> - <listitem><para> - <filename>elfutils</filename> - </para></listitem> - <listitem><para> - <filename>gcc-target</filename> - </para></listitem> - <listitem><para> - <filename>libgcc</filename> - </para></listitem> - <listitem><para> - <filename>libtool</filename> - </para></listitem> - <listitem><para> - <filename>libxmu</filename> - </para></listitem> - <listitem><para> - <filename>opkg</filename> - </para></listitem> - <listitem><para> - <filename>pciutils</filename> - </para></listitem> - <listitem><para> - <filename>rpm</filename> - </para></listitem> - <listitem><para> - <filename>sysfsutils</filename> - </para></listitem> - <listitem><para> - <filename>tiff</filename> - </para></listitem> - <listitem><para> - <filename>xz</filename> - </para></listitem> - </itemizedlist> - All of the above recipes now conform to the standard packaging - scheme where a single <filename>-dev</filename>, - <filename>-dbg</filename>, and <filename>-staticdev</filename> - package exists per recipe. - </para> - </section> - - <section id='migration-2.0-recipe-maintenance-tracking-data-moved-to-oe-core'> - <title>Recipe Maintenance Tracking Data Moved to OE-Core</title> - - <para> - Maintenance tracking data for recipes that was previously part - of <filename>meta-yocto</filename> has been moved to - <link linkend='oe-core'>OE-Core</link>. - The change includes <filename>package_regex.inc</filename> and - <filename>distro_alias.inc</filename>, which are typically enabled - when using the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class. - Additionally, the contents of - <filename>upstream_tracking.inc</filename> has now been split out - to the relevant recipes. - </para> - </section> - - <section id='migration-2.0-automatic-stale-sysroot-file-cleanup'> - <title>Automatic Stale Sysroot File Cleanup</title> - - <para> - Stale files from recipes that no longer exist in the current - configuration are now automatically removed from - sysroot as well as removed from - any other place managed by shared state. - This automatic cleanup means that the build system now properly - handles situations such as renaming the build system side of - recipes, removal of layers from - <filename>bblayers.conf</filename>, and - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - changes. - </para> - - <para> - Additionally, work directories for old versions of recipes are - now pruned. - If you wish to disable pruning old work directories, you can set - the following variable in your configuration: - <literallayout class='monospaced'> - SSTATE_PRUNE_OBSOLETEWORKDIR = "0" - </literallayout> - </para> - </section> - - <section id='migration-2.0-linux-yocto-kernel-metadata-repository-now-split-from-source'> - <title><filename>linux-yocto</filename> Kernel Metadata Repository Now Split from Source</title> - - <para> - The <filename>linux-yocto</filename> tree has up to now been a - combined set of kernel changes and configuration (meta) data - carried in a single tree. - While this format is effective at keeping kernel configuration and - source modifications synchronized, it is not always obvious to - developers how to manipulate the Metadata as compared to the - source. - </para> - - <para> - Metadata processing has now been removed from the - <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link> - class and the external Metadata repository - <filename>yocto-kernel-cache</filename>, which has always been used - to seed the <filename>linux-yocto</filename> "meta" branch. - This separate <filename>linux-yocto</filename> cache repository - is now the primary location for this data. - Due to this change, <filename>linux-yocto</filename> is no longer - able to process combined trees. - Thus, if you need to have your own combined kernel repository, - you must do the split there as well and update your recipes - accordingly. - See the <filename>meta/recipes-kernel/linux/linux-yocto_4.1.bb</filename> - recipe for an example. - </para> - </section> - - <section id='migration-2.0-additional-qa-checks'> - <title>Additional QA checks</title> - - <para> - The following QA checks have been added: - <itemizedlist> - <listitem><para> - Added a "host-user-contaminated" check for ownership - issues for packaged files outside of - <filename>/home</filename>. - The check looks for files that are incorrectly owned by the - user that ran BitBake instead of owned by a valid user in - the target system. - </para></listitem> - <listitem><para> - Added an "invalid-chars" check for invalid (non-UTF8) - characters in recipe metadata variable values - (i.e. - <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link>, - <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link>, - <link linkend='var-LICENSE'><filename>LICENSE</filename></link>, - and - <link linkend='var-SECTION'><filename>SECTION</filename></link>). - Some package managers do not support these characters. - </para></listitem> - <listitem><para> - Added an "invalid-packageconfig" check for any options - specified in - <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> - that do not match any <filename>PACKAGECONFIG</filename> - option defined for the recipe. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.0-miscellaneous'> - <title>Miscellaneous Changes</title> - - <para> - These additional changes exist: - <itemizedlist> - <listitem><para> - <filename>gtk-update-icon-cache</filename> has been - renamed to <filename>gtk-icon-utils</filename>. - </para></listitem> - <listitem><para> - The <filename>tools-profile</filename> - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> - item as well as its corresponding packagegroup and - <filename>packagegroup-core-tools-profile</filename> no - longer bring in <filename>oprofile</filename>. - Bringing in <filename>oprofile</filename> was originally - added to aid compilation on resource-constrained - targets. - However, this aid has not been widely used and is not - likely to be used going forward due to the more powerful - target platforms and the existence of better - cross-compilation tools. - </para></listitem> - <listitem><para> - The - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - variable's default value now specifies - <filename>ext4</filename> instead of - <filename>ext3</filename>. - </para></listitem> - <listitem><para> - All support for the <filename>PRINC</filename> - variable has been removed. - </para></listitem> - <listitem><para> - The <filename>packagegroup-core-full-cmdline</filename> - packagegroup no longer brings in - <filename>lighttpd</filename> due to the fact that - bringing in <filename>lighttpd</filename> is not really in - line with the packagegroup's purpose, which is to add full - versions of command-line tools that by default are - provided by <filename>busybox</filename>. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-2.1-release'> - <title>Moving to the Yocto Project 2.1 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 2.1 Release from the prior release. - </para> - - <section id='migration-2.1-variable-expansion-in-python-functions'> - <title>Variable Expansion in Python Functions</title> - - <para> - Variable expressions, such as - <filename>${</filename><replaceable>VARNAME</replaceable><filename>}</filename> - no longer expand automatically within Python functions. - Suppressing expansion was done to allow Python functions to - construct shell scripts or other code for situations in which you - do not want such expressions expanded. - For any existing code that relies on these expansions, you need to - change the expansions to expand the value of individual - variables through <filename>d.getVar()</filename>. - To alternatively expand more complex expressions, - use <filename>d.expand()</filename>. - </para> - </section> - - <section id='migration-2.1-overrides-must-now-be-lower-case'> - <title>Overrides Must Now be Lower-Case</title> - - <para> - The convention for overrides has always been for them to be - lower-case characters. - This practice is now a requirement as BitBake's datastore now - assumes lower-case characters in order to give a slight performance - boost during parsing. - In practical terms, this requirement means that anything that ends - up in - <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> - must now appear in lower-case characters (e.g. values for - <filename>MACHINE</filename>, <filename>TARGET_ARCH</filename>, - <filename>DISTRO</filename>, and also recipe names if - <filename>_pn-</filename><replaceable>recipename</replaceable> - overrides are to be effective). - </para> - </section> - - <section id='migration-2.1-expand-parameter-to-getvar-and-getvarflag-now-mandatory'> - <title>Expand Parameter to <filename>getVar()</filename> and - <filename>getVarFlag()</filename> is Now Mandatory</title> - - <para> - The expand parameter to <filename>getVar()</filename> and - <filename>getVarFlag()</filename> previously defaulted to - False if not specified. - Now, however, no default exists so one must be specified. - You must change any <filename>getVar()</filename> calls that - do not specify the final expand parameter to calls that do specify - the parameter. - You can run the following <filename>sed</filename> command at the - base of a layer to make this change: - <literallayout class='monospaced'> - sed -e 's:\(\.getVar([^,()]*\)):\1, False):g' -i `grep -ril getVar *` - sed -e 's:\(\.getVarFlag([^,()]*, [^,()]*\)):\1, False):g' -i `grep -ril getVarFlag *` - </literallayout> - <note> - The reason for this change is that it prepares the way for - changing the default to True in a future Yocto Project release. - This future change is a much more sensible default than False. - However, the change needs to be made gradually as a sudden - change of the default would potentially cause side-effects - that would be difficult to detect. - </note> - </para> - </section> - - <section id='migration-2.1-makefile-environment-changes'> - <title>Makefile Environment Changes</title> - - <para> - <link linkend='var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></link> - now defaults to "" instead of "-e MAKEFLAGS=". - Setting <filename>EXTRA_OEMAKE</filename> to "-e MAKEFLAGS=" by - default was a historical accident that has required many classes - (e.g. <filename>autotools</filename>, <filename>module</filename>) - and recipes to override this default in order to work with - sensible build systems. - When upgrading to the release, you must edit any recipe that - relies upon this old default by either setting - <filename>EXTRA_OEMAKE</filename> back to "-e MAKEFLAGS=" or by - explicitly setting any required variable value overrides using - <filename>EXTRA_OEMAKE</filename>, which is typically only needed - when a Makefile sets a default value for a variable that is - inappropriate for cross-compilation using the "=" operator rather - than the "?=" operator. - </para> - </section> - - <section id='migration-2.1-libexecdir-reverted-to-prefix-libexec'> - <title><filename>libexecdir</filename> Reverted to <filename>${prefix}/libexec</filename></title> - - <para> - The use of <filename>${libdir}/${BPN}</filename> as - <filename>libexecdir</filename> is different as compared to all - other mainstream distributions, which either uses - <filename>${prefix}/libexec</filename> or - <filename>${libdir}</filename>. - The use is also contrary to the GNU Coding Standards - (i.e. <ulink url='https://www.gnu.org/prep/standards/html_node/Directory-Variables.html'></ulink>) - that suggest <filename>${prefix}/libexec</filename> and also - notes that any package-specific nesting should be done by the - package itself. - Finally, having <filename>libexecdir</filename> change between - recipes makes it very difficult for different recipes to invoke - binaries that have been installed into - <filename>libexecdir</filename>. - The Filesystem Hierarchy Standard - (i.e. <ulink url='http://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html'></ulink>) - now recognizes the use of <filename>${prefix}/libexec/</filename>, - giving distributions the choice between - <filename>${prefix}/lib</filename> or - <filename>${prefix}/libexec</filename> without breaking FHS. - </para> - </section> - - <section id='migration-2.1-ac-cv-sizeof-off-t-no-longer-cached-in-site-files'> - <title><filename>ac_cv_sizeof_off_t</filename> is No Longer Cached in Site Files</title> - - <para> - For recipes inheriting the - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> - class, <filename>ac_cv_sizeof_off_t</filename> is no longer cached - in the site files for <filename>autoconf</filename>. - The reason for this change is because the - <filename>ac_cv_sizeof_off_t</filename> value is not necessarily - static per architecture as was previously assumed. - Rather, the value changes based on whether large file support is - enabled. - For most software that uses <filename>autoconf</filename>, this - change should not be a problem. - However, if you have a recipe that bypasses the standard - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task from the <filename>autotools</filename> class and the software - the recipe is building uses a very old version of - <filename>autoconf</filename>, the recipe might be incapable of - determining the correct size of <filename>off_t</filename> during - <filename>do_configure</filename>. - </para> - - <para> - The best course of action is to patch the software as necessary - to allow the default implementation from the - <filename>autotools</filename> class to work such that - <filename>autoreconf</filename> succeeds and produces a working - configure script, and to remove the - overridden <filename>do_configure</filename> task such that the - default implementation does get used. - </para> - </section> - - <section id='migration-2.1-image-generation-split-out-from-filesystem-generation'> - <title>Image Generation is Now Split Out from Filesystem Generation</title> - - <para> - Previously, for image recipes the - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> - task assembled the filesystem and then from that filesystem - generated images. - With this Yocto Project release, image generation is split into - separate - <link linkend='ref-tasks-image'><filename>do_image_*</filename></link> - tasks for clarity both in operation and in the code. - </para> - - <para> - For most cases, this change does not present any problems. - However, if you have made customizations that directly modify the - <filename>do_rootfs</filename> task or that mention - <filename>do_rootfs</filename>, you might need to update those - changes. - In particular, if you had added any tasks after - <filename>do_rootfs</filename>, you should make edits so that - those tasks are after the - <link linkend='ref-tasks-image-complete'><filename>do_image_complete</filename></link> - task rather than after <filename>do_rootfs</filename> - so that the your added tasks - run at the correct time. - </para> - - <para> - A minor part of this restructuring is that the post-processing - definitions and functions have been moved from the - <link linkend='ref-classes-image'><filename>image</filename></link> - class to the - <link linkend='ref-classes-rootfs*'><filename>rootfs-postcommands</filename></link> - class. - Functionally, however, they remain unchanged. - </para> - </section> - - <section id='migration-2.1-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been removed in the 2.1 release: - <itemizedlist> - <listitem><para><filename>gcc</filename> version 4.8: - Versions 4.9 and 5.3 remain. - </para></listitem> - <listitem><para><filename>qt4</filename>: - All support for Qt 4.x has been moved out to a separate - <filename>meta-qt4</filename> layer because Qt 4 is no - longer supported upstream. - </para></listitem> - <listitem><para><filename>x11vnc</filename>: - Moved to the <filename>meta-oe</filename> layer. - </para></listitem> - <listitem><para><filename>linux-yocto-3.14</filename>: - No longer supported. - </para></listitem> - <listitem><para><filename>linux-yocto-3.19</filename>: - No longer supported. - </para></listitem> - <listitem><para><filename>libjpeg</filename>: - Replaced by the <filename>libjpeg-turbo</filename> recipe. - </para></listitem> - <listitem><para><filename>pth</filename>: - Became obsolete. - </para></listitem> - <listitem><para><filename>liboil</filename>: - Recipe is no longer needed and has been moved to the - <filename>meta-multimedia</filename> layer. - </para></listitem> - <listitem><para><filename>gtk-theme-torturer</filename>: - Recipe is no longer needed and has been moved to the - <filename>meta-gnome</filename> layer. - </para></listitem> - <listitem><para><filename>gnome-mime-data</filename>: - Recipe is no longer needed and has been moved to the - <filename>meta-gnome</filename> layer. - </para></listitem> - <listitem><para><filename>udev</filename>: - Replaced by the <filename>eudev</filename> recipe for - compatibility when using <filename>sysvinit</filename> - with newer kernels. - </para></listitem> - <listitem><para><filename>python-pygtk</filename>: - Recipe became obsolete. - </para></listitem> - <listitem><para><filename>adt-installer</filename>: - Recipe became obsolete. - See the - "<link linkend='migration-2.1-adt-removed'>ADT Removed</link>" - section for more information. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.1-class-changes'> - <title>Class Changes</title> - - <para> - The following classes have changed: - <itemizedlist> - <listitem><para><filename>autotools_stage</filename>: - Removed because the - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> - class now provides its functionality. - Recipes that inherited from - <filename>autotools_stage</filename> should now inherit - from <filename>autotools</filename> instead. - </para></listitem> - <listitem><para><filename>boot-directdisk</filename>: - Merged into the <filename>image-vm</filename> - class. - The <filename>boot-directdisk</filename> class was rarely - directly used. - Consequently, this change should not cause any issues. - </para></listitem> - <listitem><para><filename>bootimg</filename>: - Merged into the - <link linkend='ref-classes-image-live'><filename>image-live</filename></link> - class. - The <filename>bootimg</filename> class was rarely - directly used. - Consequently, this change should not cause any issues. - </para></listitem> - <listitem><para><filename>packageinfo</filename>: - Removed due to its limited use by the Hob UI, which has - itself been removed. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.1-build-system-ui-changes'> - <title>Build System User Interface Changes</title> - - <para> - The following changes have been made to the build system user - interface: - <itemizedlist> - <listitem><para><emphasis>Hob GTK+-based UI</emphasis>: - Removed because it is unmaintained and based on the - outdated GTK+ 2 library. - The Toaster web-based UI is much more capable and is - actively maintained. - See the - "<ulink url='&YOCTO_DOCS_TOAST_URL;#using-the-toaster-web-interface'>Using the Toaster Web Interface</ulink>" - section in the Toaster User Manual for more - information on this interface. - </para></listitem> - <listitem><para><emphasis>"puccho" BitBake UI</emphasis>: - Removed because is unmaintained and no longer useful. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.1-adt-removed'> - <title>ADT Removed</title> - - <para> - The Application Development Toolkit (ADT) has been removed - because its functionality almost completely overlapped with the - <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-using-the-standard-sdk'>standard SDK</ulink> - and the - <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-extensible'>extensible SDK</ulink>. - For information on these SDKs and how to build and use them, see the - <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> - manual. - <note> - The Yocto Project Eclipse IDE Plug-in is still supported and - is not affected by this change. - </note> - </para> - </section> - - <section id='migration-2.1-poky-reference-distribution-changes'> - <title>Poky Reference Distribution Changes</title> - - <para> - The following changes have been made for the Poky distribution: - <itemizedlist> - <listitem><para> - The <filename>meta-yocto</filename> layer has been renamed - to <filename>meta-poky</filename> to better match its - purpose, which is to provide the Poky reference - distribution. - The <filename>meta-yocto-bsp</filename> layer retains its - original name since it provides reference machines for - the Yocto Project and it is otherwise unrelated to Poky. - References to <filename>meta-yocto</filename> in your - <filename>conf/bblayers.conf</filename> should - automatically be updated, so you should not need to change - anything unless you are relying on this naming elsewhere. - </para></listitem> - <listitem><para> - The - <link linkend='ref-classes-uninative'><filename>uninative</filename></link> - class is now enabled by default in Poky. - This class attempts to isolate the build system from the - host distribution's C library and makes re-use of native - shared state artifacts across different host distributions - practical. - With this class enabled, a tarball containing a pre-built - C library is downloaded at the start of the build.</para> - - <para>The <filename>uninative</filename> class is enabled - through the - <filename>meta/conf/distro/include/yocto-uninative.inc</filename> - file, which for those not using the Poky distribution, can - include to easily enable the same functionality.</para> - - <para>Alternatively, if you wish to build your own - <filename>uninative</filename> tarball, you can do so by - building the <filename>uninative-tarball</filename> recipe, - making it available to your build machines - (e.g. over HTTP/HTTPS) and setting a similar configuration - as the one set by <filename>yocto-uninative.inc</filename>. - </para></listitem> - <listitem><para> - Static library generation, for most cases, is now disabled - by default in the Poky distribution. - Disabling this generation saves some build time as well - as the size used for build output artifacts.</para> - - <para>Disabling this library generation is accomplished - through a - <filename>meta/conf/distro/include/no-static-libs.inc</filename>, - which for those not using the Poky distribution can - easily include to enable the same functionality.</para> - - <para>Any recipe that needs to opt-out of having the - "--disable-static" option specified on the configure - command line either because it is not a supported option - for the configure script or because static libraries are - needed should set the following variable: - <literallayout class='monospaced'> - DISABLE_STATIC = "" - </literallayout> - </para></listitem> - <listitem><para> - The separate <filename>poky-tiny</filename> distribution - now uses the musl C library instead of a heavily pared - down <filename>glibc</filename>. - Using musl results in a smaller - distribution and facilitates much greater maintainability - because musl is designed to have a small footprint.</para> - - <para>If you have used <filename>poky-tiny</filename> and - have customized the <filename>glibc</filename> - configuration you will need to redo those customizations - with musl when upgrading to the new release. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.1-packaging-changes'> - <title>Packaging Changes</title> - - <para> - The following changes have been made to packaging: - <itemizedlist> - <listitem><para> - The <filename>runuser</filename> and - <filename>mountpoint</filename> binaries, which were - previously in the main <filename>util-linux</filename> - package, have been split out into the - <filename>util-linux-runuser</filename> and - <filename>util-linux-mountpoint</filename> packages, - respectively. - </para></listitem> - <listitem><para> - The <filename>python-elementtree</filename> package has - been merged into the <filename>python-xml</filename> - package. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.1-tuning-file-changes'> - <title>Tuning File Changes</title> - - <para> - The following changes have been made to the tuning files: - <itemizedlist> - <listitem><para> - The "no-thumb-interwork" tuning feature has been dropped - from the ARM tune include files. - Because interworking is required for ARM EABI, attempting - to disable it through a tuning feature no longer makes - sense. - <note> - Support for ARM OABI was deprecated in gcc 4.7. - </note> - </para></listitem> - <listitem><para> - The <filename>tune-cortexm*.inc</filename> and - <filename>tune-cortexr4.inc</filename> files have been - removed because they are poorly tested. - Until the OpenEmbedded build system officially gains - support for CPUs without an MMU, these tuning files would - probably be better maintained in a separate layer - if needed. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.1-supporting-gobject-introspection'> - <title>Supporting GObject Introspection</title> - - <para> - This release supports generation of GLib Introspective - Repository (GIR) files through GObject introspection, which is - the standard mechanism for accessing GObject-based software from - runtime environments. - You can enable, disable, and test the generation of this data. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#enabling-gobject-introspection-support'>Enabling GObject Introspection Support</ulink>" - section in the Yocto Project Development Tasks Manual - for more information. - </para> - </section> - - <section id='migration-2.1-miscellaneous-changes'> - <title>Miscellaneous Changes</title> - - <para> - These additional changes exist: - <itemizedlist> - <listitem><para> - The minimum Git version has been increased to 1.8.3.1. - If your host distribution does not provide a sufficiently - recent version, you can install the buildtools, which - will provide it. - See the - "<link linkend='required-git-tar-and-python-versions'>Required Git, tar, and Python Versions</link>" - section for more information on the buildtools tarball. - </para></listitem> - <listitem><para> - The buggy and incomplete support for the RPM version 4 - package manager has been removed. - The well-tested and maintained support for RPM version 5 - remains. - </para></listitem> - <listitem><para> - Previously, the following list of packages were removed - if package-management was not in - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>, - regardless of any dependencies: - <literallayout class='monospaced'> - update-rc.d - base-passwd - shadow - update-alternatives - run-postinsts - </literallayout> - With the Yocto Project 2.1 release, these packages are only - removed if "read-only-rootfs" is in - <filename>IMAGE_FEATURES</filename>, since they might - still be needed for a read-write image even in the absence - of a package manager (e.g. if users need to be added, - modified, or removed at runtime). - </para></listitem> - <listitem><para> - The - <ulink url='&YOCTO_DOCS_SDK_URL;#sdk-devtool-use-devtool-modify-to-modify-the-source-of-an-existing-component'><filename>devtool modify</filename></ulink> - command now defaults to extracting the source since that - is most commonly expected. - The "-x" or "--extract" options are now no-ops. - If you wish to provide your own existing source tree, you - will now need to specify either the "-n" or - "--no-extract" options when running - <filename>devtool modify</filename>. - </para></listitem> - <listitem><para> - If the formfactor for a machine is either not supplied - or does not specify whether a keyboard is attached, then - the default is to assume a keyboard is attached rather - than assume no keyboard. - This change primarily affects the Sato UI. - </para></listitem> - <listitem><para> - The <filename>.debug</filename> directory packaging is - now automatic. - If your recipe builds software that installs binaries into - directories other than the standard ones, you no longer - need to take care of setting - <filename>FILES_${PN}-dbg</filename> to pick up the - resulting <filename>.debug</filename> directories as these - directories are automatically found and added. - </para></listitem> - <listitem><para> - Inaccurate disk and CPU percentage data has been dropped - from <filename>buildstats</filename> output. - This data has been replaced with - <filename>getrusage()</filename> data and corrected IO - statistics. - You will probably need to update any custom code that reads - the <filename>buildstats</filename> data. - </para></listitem> - <listitem><para> - The - <filename>meta/conf/distro/include/package_regex.inc</filename> - is now deprecated. - The contents of this file have been moved to individual - recipes. - <note><title>Tip</title> - Because this file will likely be removed in a future - Yocto Project release, it is suggested that you remove - any references to the file that might be in your - configuration. - </note> - </para></listitem> - <listitem><para> - The <filename>v86d/uvesafb</filename> has been removed from - the <filename>genericx86</filename> and - <filename>genericx86-64</filename> reference machines, - which are provided by the - <filename>meta-yocto-bsp</filename> layer. - Most modern x86 boards do not rely on this file and it only - adds kernel error messages during startup. - If you do still need to support - <filename>uvesafb</filename>, you can - simply add <filename>v86d</filename> to your image. - </para></listitem> - <listitem><para> - Build sysroot paths are now removed from debug symbol - files. - Removing these paths means that remote GDB using an - unstripped build system sysroot will no longer work - (although this was never documented to work). - The supported method to accomplish something similar is - to set <filename>IMAGE_GEN_DEBUGFS</filename> to "1", - which will generate a companion debug image - containing unstripped binaries and associated debug - sources alongside the image. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-2.2-release'> - <title>Moving to the Yocto Project 2.2 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 2.2 Release from the prior release. - </para> - - <section id='migration-2.2-minimum-kernel-version'> - <title>Minimum Kernel Version</title> - - <para> - The minimum kernel version for the target system and for SDK - is now 3.2.0, due to the upgrade - to <filename>glibc 2.24</filename>. - Specifically, for AArch64-based targets the version is - 3.14. - For Nios II-based targets, the minimum kernel version is 3.19. - <note> - For x86 and x86_64, you can reset - <link linkend='var-OLDEST_KERNEL'><filename>OLDEST_KERNEL</filename></link> - to anything down to 2.6.32 if desired. - </note> - </para> - </section> - - <section id='migration-2.2-staging-directories-in-sysroot-simplified'> - <title>Staging Directories in Sysroot Has Been Simplified</title> - - <para> - The way directories are staged in sysroot has been simplified and - introduces the new - <link linkend='var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></link>, - <link linkend='var-SYSROOT_DIRS_NATIVE'><filename>SYSROOT_DIRS_NATIVE</filename></link>, - and - <link linkend='var-SYSROOT_DIRS_BLACKLIST'><filename>SYSROOT_DIRS_BLACKLIST</filename></link>. - See the - <ulink url='http://lists.openembedded.org/pipermail/openembedded-core/2016-May/121365.html'>v2 patch series on the OE-Core Mailing List</ulink> - for additional information. - </para> - </section> - - <section id='migration-2.2-removal-of-old-images-from-tmp-deploy-now-enabled'> - <title>Removal of Old Images and Other Files in <filename>tmp/deploy</filename> Now Enabled</title> - - <para> - Removal of old images and other files in - <filename>tmp/deploy/</filename> is now enabled by default due - to a new staging method used for those files. - As a result of this change, the - <filename>RM_OLD_IMAGE</filename> variable is now redundant. - </para> - </section> - - <section id='migration-2.2-python-changes'> - <title>Python Changes</title> - - <para> - The following changes for Python occurred: - </para> - - <section id='migration-2.2-bitbake-now-requires-python-3.4'> - <title>BitBake Now Requires Python 3.4+</title> - - <para> - BitBake requires Python 3.4 or greater. - </para> - </section> - - <section id='migration-2.2-utf-8-locale-required-on-build-host'> - <title>UTF-8 Locale Required on Build Host</title> - - <para> - A UTF-8 locale is required on the build host due to Python 3. - Since C.UTF-8 is not a standard, the default is en_US.UTF-8. - </para> - </section> - - <section id='migration-2.2-metadata-now-must-use-python-3-syntax'> - <title>Metadata Must Now Use Python 3 Syntax</title> - - <para> - The metadata is now required to use Python 3 syntax. - For help preparing metadata, see any of the many Python 3 porting - guides available. - Alternatively, you can reference the conversion commits for Bitbake - and you can use - <link linkend='oe-core'>OE-Core</link> as a guide for changes. - Following are particular areas of interest: - <literallayout class='monospaced'> - * subprocess command-line pipes needing locale decoding - * the syntax for octal values changed - * the <filename>iter*()</filename> functions changed name - * iterators now return views, not lists - * changed names for Python modules - </literallayout> - </para> - </section> - - <section id='migration-2.2-target-python-recipes-switched-to-python-3'> - <title>Target Python Recipes Switched to Python 3</title> - - <para> - Most target Python recipes have now been switched to Python 3. - Unfortunately, systems using RPM as a package manager and - providing online package-manager support through SMART still - require Python 2. - <note> - Python 2 and recipes that use it can still be built for the - target as with previous versions. - </note> - </para> - </section> - - <section id='migration-2.2-buildtools-tarball-includes-python-3'> - <title><filename>buildtools-tarball</filename> Includes Python 3</title> - - <para> - <filename>buildtools-tarball</filename> now includes Python 3. - </para> - </section> - </section> - - <section id='migration-2.2-uclibc-replaced-by-musl'> - <title>uClibc Replaced by musl</title> - - <para> - uClibc has been removed in favor of musl. - Musl has matured, is better maintained, and is compatible with a - wider range of applications as compared to uClibc. - </para> - </section> - - <section id='migration-2.2-B-no-longer-default-working-directory-for-tasks'> - <title><filename>${B}</filename> No Longer Default Working Directory for Tasks</title> - - <para> - <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename> - is no longer the default working directory for tasks. - Consequently, any custom tasks you define now need to either - have the - <filename>[</filename><ulink url='&YOCTO_DOCS_BB_URL;#variable-flags'><filename>dirs</filename></ulink><filename>]</filename> flag set, or the task needs to change into the - appropriate working directory manually (e.g using - <filename>cd</filename> for a shell task). - <note> - The preferred method is to use the - <filename>[dirs]</filename> flag. - </note> - </para> - </section> - - <section id='migration-2.2-runqemu-ported-to-python'> - <title><filename>runqemu</filename> Ported to Python</title> - - <para> - <filename>runqemu</filename> has been ported to Python and has - changed behavior in some cases. - Previous usage patterns continue to be supported. - </para> - - <para> - The new <filename>runqemu</filename> is a Python script. - Machine knowledge is no longer hardcoded into - <filename>runqemu</filename>. - You can choose to use the <filename>qemuboot</filename> - configuration file to define the BSP's own arguments and to make - it bootable with <filename>runqemu</filename>. - If you use a configuration file, use the following form: - <literallayout class='monospaced'> - <replaceable>image-name</replaceable>-<replaceable>machine</replaceable>.qemuboot.conf - </literallayout> - The configuration file enables fine-grained tuning of options - passed to QEMU without the <filename>runqemu</filename> script - hard-coding any knowledge about different machines. - Using a configuration file is particularly convenient when trying - to use QEMU with machines other than the - <filename>qemu*</filename> machines in - <link linkend='oe-core'>OE-Core</link>. - The <filename>qemuboot.conf</filename> file is generated by the - <filename>qemuboot</filename> - class when the root filesystem is being build (i.e. - build rootfs). - QEMU boot arguments can be set in BSP's configuration file and - the <filename>qemuboot</filename> class will save them to - <filename>qemuboot.conf</filename>. - </para> - - - <para> - If you want to use <filename>runqemu</filename> without a - configuration file, use the following command form: - <literallayout class='monospaced'> - $ runqemu <replaceable>machine</replaceable> <replaceable>rootfs</replaceable> <replaceable>kernel</replaceable> [<replaceable>options</replaceable>] - </literallayout> - Supported <replaceable>machines</replaceable> are as follows: - <literallayout class='monospaced'> - qemuarm - qemuarm64 - qemux86 - qemux86-64 - qemuppc - qemumips - qemumips64 - qemumipsel - qemumips64el - </literallayout> - Consider the following example, which uses the - <filename>qemux86-64</filename> machine, - provides a root filesystem, provides an image, and uses - the <filename>nographic</filename> option: - <literallayout class='monospaced'> -$ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic - </literallayout> - </para> - - <para> - Following is a list of variables that can be set in configuration - files such as <filename>bsp.conf</filename> to enable the BSP - to be booted by <filename>runqemu</filename>: - <note> - "QB" means "QEMU Boot". - </note> - <literallayout class='monospaced'> - QB_SYSTEM_NAME: QEMU name (e.g. "qemu-system-i386") - QB_OPT_APPEND: Options to append to QEMU (e.g. "-show-cursor") - QB_DEFAULT_KERNEL: Default kernel to boot (e.g. "bzImage") - QB_DEFAULT_FSTYPE: Default FSTYPE to boot (e.g. "ext4") - QB_MEM: Memory (e.g. "-m 512") - QB_MACHINE: QEMU machine (e.g. "-machine virt") - QB_CPU: QEMU cpu (e.g. "-cpu qemu32") - QB_CPU_KVM: Similar to QB_CPU except used for kvm support (e.g. "-cpu kvm64") - QB_KERNEL_CMDLINE_APPEND: Options to append to the kernel's -append - option (e.g. "console=ttyS0 console=tty") - QB_DTB: QEMU dtb name - QB_AUDIO_DRV: QEMU audio driver (e.g. "alsa", set it when support audio) - QB_AUDIO_OPT: QEMU audio option (e.g. "-soundhw ac97,es1370"), which is used - when QB_AUDIO_DRV is set. - QB_KERNEL_ROOT: Kernel's root (e.g. /dev/vda) - QB_TAP_OPT: Network option for 'tap' mode (e.g. - "-netdev tap,id=net0,ifname=@TAP@,script=no,downscript=no -device virtio-net-device,netdev=net0"). - runqemu will replace "@TAP@" with the one that is used, such as tap0, tap1 ... - QB_SLIRP_OPT: Network option for SLIRP mode (e.g. "-netdev user,id=net0 -device virtio-net-device,netdev=net0") - QB_ROOTFS_OPT: Used as rootfs (e.g. - "-drive id=disk0,file=@ROOTFS@,if=none,format=raw -device virtio-blk-device,drive=disk0"). - runqemu will replace "@ROOTFS@" with the one which is used, such as - core-image-minimal-qemuarm64.ext4. - QB_SERIAL_OPT: Serial port (e.g. "-serial mon:stdio") - QB_TCPSERIAL_OPT: tcp serial port option (e.g. - " -device virtio-serial-device -chardev socket,id=virtcon,port=@PORT@,host=127.0.0.1 -device virtconsole,chardev=virtcon" - runqemu will replace "@PORT@" with the port number which is used. - </literallayout> - </para> - - <para> - To use <filename>runqemu</filename>, set - <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link> - as follows and run <filename>runqemu</filename>: - <note> - For command-line syntax, use - <filename>runqemu help</filename>. - </note> - <literallayout class='monospaced'> - IMAGE_CLASSES += "qemuboot" - </literallayout> - </para> - </section> - - <section id='migration-2.2-default-linker-hash-style-changed'> - <title>Default Linker Hash Style Changed</title> - - <para> - The default linker hash style for <filename>gcc-cross</filename> - is now "sysv" in order to catch recipes that are building software - without using the OpenEmbedded - <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link>. - This change could result in seeing some "No GNU_HASH in the elf - binary" QA issues when building such recipes. - You need to fix these recipes so that they use the expected - <filename>LDFLAGS</filename>. - Depending on how the software is built, the build system used by - the software (e.g. a Makefile) might need to be patched. - However, sometimes making this fix is as simple as adding the - following to the recipe: - <literallayout class='monospaced'> - TARGET_CC_ARCH += "${LDFLAGS}" - </literallayout> - </para> - </section> - - <section id='migration-2.2-kernel-image-base-name-no-longer-uses-kernel-imagetype'> - <title><filename>KERNEL_IMAGE_BASE_NAME</filename> no Longer Uses <filename>KERNEL_IMAGETYPE</filename></title> - - <para> - The - <filename>KERNEL_IMAGE_BASE_NAME</filename> - variable no longer uses the - <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> - variable to create the image's base name. - Because the OpenEmbedded build system can now build multiple kernel - image types, this part of the kernel image base name as been - removed leaving only the following: - <literallayout class='monospaced'> - KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME} - </literallayout> - If you have recipes or classes that use - <filename>KERNEL_IMAGE_BASE_NAME</filename> directly, you might - need to update the references to ensure they continue to work. - </para> - </section> - - <section id='migration-2.2-bitbake-changes'> - <title>BitBake Changes</title> - - <para> - The following changes took place for BitBake: - <itemizedlist> - <listitem><para> - The "goggle" UI and standalone image-writer tool have - been removed as they both require GTK+ 2.0 and - were not being maintained. - </para></listitem> - <listitem><para> - The Perforce fetcher now supports - <link linkend='var-SRCREV'><filename>SRCREV</filename></link> - for specifying the source revision to use, be it - <filename>${</filename><link linkend='var-AUTOREV'><filename>AUTOREV</filename></link><filename>}</filename>, - changelist number, p4date, or label, in preference to - separate - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - parameters to specify these. - This change is more in-line with how the other fetchers - work for source control systems. - Recipes that fetch from Perforce will need to be updated - to use <filename>SRCREV</filename> in place of specifying - the source revision within - <filename>SRC_URI</filename>. - </para></listitem> - <listitem><para> - Some of BitBake's internal code structures for accessing - the recipe cache needed to be changed to support the new - multi-configuration functionality. - These changes will affect external tools that use BitBake's - tinfoil module. - For information on these changes, see the changes made to - the scripts supplied with OpenEmbedded-Core: - <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=189371f8393971d00bca0fceffd67cc07784f6ee'>1</ulink> - and - <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=4a5aa7ea4d07c2c90a1654b174873abb018acc67'>2</ulink>. - </para></listitem> - <listitem><para> - The task management code has been rewritten to avoid using - ID indirection in order to improve performance. - This change is unlikely to cause any problems for most - users. - However, the setscene verification function as pointed to - by <filename>BB_SETSCENE_VERIFY_FUNCTION</filename> - needed to change signature. - Consequently, a new variable named - <filename>BB_SETSCENE_VERIFY_FUNCTION2</filename> - has been added allowing multiple versions of BitBake - to work with suitably written metadata, which includes - OpenEmbedded-Core and Poky. - Anyone with custom BitBake task scheduler code might also - need to update the code to handle the new structure. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.2-swabber-has-been-removed'> - <title>Swabber has Been Removed</title> - - <para> - Swabber, a tool that was intended to detect host contamination in - the build process, has been removed, as it has been unmaintained - and unused for some time and was never particularly effective. - The OpenEmbedded build system has since incorporated a number of - mechanisms including enhanced QA checks that mean that there is - less of a need for such a tool. - </para> - </section> - - <section id='migration-2.2-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been removed: - <itemizedlist> - <listitem><para> - <filename>augeas</filename>: - No longer needed and has been moved to - <filename>meta-oe</filename>. - </para></listitem> - <listitem><para> - <filename>directfb</filename>: - Unmaintained and has been moved to - <filename>meta-oe</filename>. - </para></listitem> - <listitem><para> - <filename>gcc</filename>: - Removed 4.9 version. - Versions 5.4 and 6.2 are still present. - </para></listitem> - <listitem><para> - <filename>gnome-doc-utils</filename>: - No longer needed. - </para></listitem> - <listitem><para> - <filename>gtk-doc-stub</filename>: - Replaced by <filename>gtk-doc</filename>. - </para></listitem> - <listitem><para> - <filename>gtk-engines</filename>: - No longer needed and has been moved to - <filename>meta-gnome</filename>. - </para></listitem> - <listitem><para> - <filename>gtk-sato-engine</filename>: - Became obsolete. - </para></listitem> - <listitem><para> - <filename>libglade</filename>: - No longer needed and has been moved to - <filename>meta-oe</filename>. - </para></listitem> - <listitem><para> - <filename>libmad</filename>: - Unmaintained and functionally replaced by - <filename>libmpg123</filename>. - <filename>libmad</filename> has been moved to - <filename>meta-oe</filename>. - </para></listitem> - <listitem><para> - <filename>libowl</filename>: - Became obsolete. - </para></listitem> - <listitem><para> - <filename>libxsettings-client</filename>: - No longer needed. - </para></listitem> - <listitem><para> - <filename>oh-puzzles</filename>: - Functionally replaced by - <filename>puzzles</filename>. - </para></listitem> - <listitem><para> - <filename>oprofileui</filename>: - Became obsolete. - OProfile has been largely supplanted by perf. - </para></listitem> - <listitem><para> - <filename>packagegroup-core-directfb.bb</filename>: - Removed. - </para></listitem> - <listitem><para> - <filename>core-image-directfb.bb</filename>: - Removed. - </para></listitem> - <listitem><para> - <filename>pointercal</filename>: - No longer needed and has been moved to - <filename>meta-oe</filename>. - </para></listitem> - <listitem><para> - <filename>python-imaging</filename>: - No longer needed and moved to - <filename>meta-python</filename> - </para></listitem> - <listitem><para> - <filename>python-pyrex</filename>: - No longer needed and moved to - <filename>meta-python</filename>. - </para></listitem> - <listitem><para> - <filename>sato-icon-theme</filename>: - Became obsolete. - </para></listitem> - <listitem><para> - <filename>swabber-native</filename>: - Swabber has been removed. - See the - <link linkend='migration-2.2-swabber-has-been-removed'>entry on Swabber</link>. - </para></listitem> - <listitem><para> - <filename>tslib</filename>: - No longer needed and has been moved to - <filename>meta-oe</filename>. - </para></listitem> - <listitem><para> - <filename>uclibc</filename>: - Removed in favor of musl. - </para></listitem> - <listitem><para> - <filename>xtscal</filename>: - No longer needed and moved to - <filename>meta-oe</filename> - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.2-removed-classes'> - <title>Removed Classes</title> - - <para> - The following classes have been removed: - <itemizedlist> - <listitem><para> - <filename>distutils-native-base</filename>: - No longer needed. - </para></listitem> - <listitem><para> - <filename>distutils3-native-base</filename>: - No longer needed. - </para></listitem> - <listitem><para> - <filename>sdl</filename>: - Only set - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> - and - <link linkend='var-SECTION'><filename>SECTION</filename></link>, - which are better set within the recipe instead. - </para></listitem> - <listitem><para> - <filename>sip</filename>: - Mostly unused. - </para></listitem> - <listitem><para> - <filename>swabber</filename>: - See the - <link linkend='migration-2.2-swabber-has-been-removed'>entry on Swabber</link>. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.2-minor-packaging-changes'> - <title>Minor Packaging Changes</title> - - <para> - The following minor packaging changes have occurred: - <itemizedlist> - <listitem><para> - <filename>grub</filename>: - Split <filename>grub-editenv</filename> into its own - package. - </para></listitem> - <listitem><para> - <filename>systemd</filename>: - Split container and vm related units into a new package, - systemd-container. - </para></listitem> - <listitem><para> - <filename>util-linux</filename>: - Moved <filename>prlimit</filename> to a separate - <filename>util-linux-prlimit</filename> package. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.2-miscellaneous-changes'> - <title>Miscellaneous Changes</title> - - <para> - The following miscellaneous changes have occurred: - <itemizedlist> - <listitem><para> - <filename>package_regex.inc</filename>: - Removed because the definitions - <filename>package_regex.inc</filename> previously contained - have been moved to their respective recipes. - </para></listitem> - <listitem><para> - Both <filename>devtool add</filename> and - <filename>recipetool create</filename> now use a fixed - <link linkend='var-SRCREV'><filename>SRCREV</filename></link> - by default when fetching from a Git repository. - You can override this in either case to use - <filename>${</filename><link linkend='var-AUTOREV'><filename>AUTOREV</filename></link><filename>}</filename> - instead by using the <filename>-a</filename> or - <filename>‐‐autorev</filename> command-line - option - </para></listitem> - <listitem><para> - <filename>distcc</filename>: - GTK+ UI is now disabled by default. - </para></listitem> - <listitem><para> - <filename>packagegroup-core-tools-testapps</filename>: - Removed Piglit. - </para></listitem> - <listitem><para> - <filename>image.bbclass</filename>: - Renamed COMPRESS(ION) to CONVERSION. - This change means that - <filename>COMPRESSIONTYPES</filename>, - <filename>COMPRESS_DEPENDS</filename> and - <filename>COMPRESS_CMD</filename> are deprecated in favor - of <filename>CONVERSIONTYPES</filename>, - <filename>CONVERSION_DEPENDS</filename> and - <filename>CONVERSION_CMD</filename>. - The <filename>COMPRESS*</filename> variable names will - still work in the 2.2 release but metadata that does not - need to be backwards-compatible should be changed to - use the new names as the <filename>COMPRESS*</filename> - ones will be removed in a future release. - </para></listitem> - <listitem><para> - <filename>gtk-doc</filename>: - A full version of <filename>gtk-doc</filename> is now - made available. - However, some old software might not be capable of using - the current version of <filename>gtk-doc</filename> - to build documentation. - You need to change recipes that build such software so that - they explicitly disable building documentation with - <filename>gtk-doc</filename>. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-2.3-release'> - <title>Moving to the Yocto Project 2.3 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 2.3 Release from the prior release. - </para> - - <section id='migration-2.3-recipe-specific-sysroots'> - <title>Recipe-specific Sysroots</title> - - <para> - The OpenEmbedded build system now uses one sysroot per - recipe to resolve long-standing issues with configuration - script auto-detection of undeclared dependencies. - Consequently, you might find that some of your previously - written custom recipes are missing declared dependencies, - particularly those dependencies that are incidentally built - earlier in a typical build process and thus are already likely - to be present in the shared sysroot in previous releases. - </para> - - <para> - Consider the following: - <itemizedlist> - <listitem><para> - <emphasis>Declare Build-Time Dependencies:</emphasis> - Because of this new feature, you must explicitly - declare all build-time dependencies for your recipe. - If you do not declare these dependencies, they are not - populated into the sysroot for the recipe. - </para></listitem> - <listitem><para> - <emphasis>Specify Pre-Installation and Post-Installation - Native Tool Dependencies:</emphasis> - You must specifically specify any special native tool - dependencies of <filename>pkg_preinst</filename> and - <filename>pkg_postinst</filename> scripts by using the - <link linkend='var-PACKAGE_WRITE_DEPS'><filename>PACKAGE_WRITE_DEPS</filename></link> - variable. - Specifying these dependencies ensures that these tools - are available if these scripts need to be run on the - build host during the - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> - task.</para> - - <para>As an example, see the <filename>dbus</filename> - recipe. - You will see that this recipe has a - <filename>pkg_postinst</filename> that calls - <filename>systemctl</filename> if "systemd" is in - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. - In the example, - <filename>systemd-systemctl-native</filename> is added to - <filename>PACKAGE_WRITE_DEPS</filename>, which is also - conditional on "systemd" being in - <filename>DISTRO_FEATURES</filename>. - </para></listitem> - <listitem><para> - <emphasis>Examine Recipes that Use - <filename>SSTATEPOSTINSTFUNCS</filename>:</emphasis> - You need to examine any recipe that uses - <filename>SSTATEPOSTINSTFUNCS</filename> and determine - steps to take.</para> - - <para>Functions added to - <filename>SSTATEPOSTINSTFUNCS</filename> are still - called as they were in previous Yocto Project releases. - However, since a separate sysroot is now being populated - for every recipe and if existing functions being called - through <filename>SSTATEPOSTINSTFUNCS</filename> are - doing relocation, then you will need to change these - to use a post-installation script that is installed by a - function added to - <link linkend='var-SYSROOT_PREPROCESS_FUNCS'><filename>SYSROOT_PREPROCESS_FUNCS</filename></link>. - </para> - - <para>For an example, see the - <filename>pixbufcache</filename> class in - <filename>meta/classes/</filename> in the Yocto Project - <ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink>. - <note> - The <filename>SSTATEPOSTINSTFUNCS</filename> variable - itself is now deprecated in favor of the - <filename>do_populate_sysroot[postfuncs]</filename> - task. - Consequently, if you do still have any function or - functions that need to be called after the sysroot - component is created for a recipe, then you would be - well advised to take steps to use a post installation - script as described previously. - Taking these steps prepares your code for when - <filename>SSTATEPOSTINSTFUNCS</filename> is - removed in a future Yocto Project release. - </note> - </para></listitem> - <listitem><para> - <emphasis>Specify the Sysroot when Using Certain - External Scripts:</emphasis> - Because the shared sysroot is now gone, the scripts - <filename>oe-find-native-sysroot</filename> and - <filename>oe-run-native</filename> have been changed such - that you need to specify which recipe's - <link linkend='var-STAGING_DIR_NATIVE'><filename>STAGING_DIR_NATIVE</filename></link> - is used. - </para></listitem> - </itemizedlist> - <note> - You can find more information on how recipe-specific sysroots - work in the - "<link linkend='ref-classes-staging'><filename>staging.bbclass</filename></link>" - section. - </note> - </para> - </section> - - <section id='migration-2.3-path-variable'> - <title><filename>PATH</filename> Variable</title> - - <para> - Within the environment used to run build tasks, the environment - variable <filename>PATH</filename> is now sanitized such that - the normal native binary paths - (<filename>/bin</filename>, <filename>/sbin</filename>, - <filename>/usr/bin</filename> and so forth) are - removed and a directory containing symbolic links linking only - to the binaries from the host mentioned in the - <link linkend='var-HOSTTOOLS'><filename>HOSTTOOLS</filename></link> - and - <link linkend='var-HOSTTOOLS_NONFATAL'><filename>HOSTTOOLS_NONFATAL</filename></link> - variables is added to <filename>PATH</filename>. - </para> - - <para> - Consequently, any native binaries provided by the host that you - need to call needs to be in one of these two variables at - the configuration level. - </para> - - <para> - Alternatively, you can add a native recipe (i.e. - <filename>-native</filename>) that provides the - binary to the recipe's - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> - value. - <note> - <filename>PATH</filename> is not sanitized in the same way - within <filename>devshell</filename>. - If it were, you would have difficulty running host tools for - development and debugging within the shell. - </note> - </para> - </section> - - <section id='migration-2.3-scripts'> - <title>Changes to Scripts</title> - - <para> - The following changes to scripts took place: - <itemizedlist> - <listitem><para> - <emphasis><filename>oe-find-native-sysroot</filename>:</emphasis> - The usage for the - <filename>oe-find-native-sysroot</filename> script has - changed to the following: - <literallayout class='monospaced'> - $ . oe-find-native-sysroot <replaceable>recipe</replaceable> - </literallayout> - You must now supply a recipe for - <replaceable>recipe</replaceable> as part of the command. - Prior to the Yocto Project &DISTRO; release, it was not - necessary to provide the script with the command. - </para></listitem> - <listitem><para> - <emphasis><filename>oe-run-native</filename>:</emphasis> - The usage for the - <filename>oe-run-native</filename> script has changed - to the following: - <literallayout class='monospaced'> - $ oe-run-native <replaceable>native_recipe</replaceable> <replaceable>tool</replaceable> - </literallayout> - You must supply the name of the native recipe and the tool - you want to run as part of the command. - Prior to the Yocto Project &DISTRO; release, it was not - necessary to provide the native recipe with the command. - </para></listitem> - <listitem><para> - <emphasis><filename>cleanup-workdir</filename>:</emphasis> - The <filename>cleanup-workdir</filename> script has been - removed because the script was found to be deleting - files it should not have, which lead to broken build - trees. - Rather than trying to delete portions of - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - and getting it wrong, it is recommended that you - delete <filename>TMPDIR</filename> and have it restored - from shared state (sstate) on subsequent builds. - </para></listitem> - <listitem><para> - <emphasis><filename>wipe-sysroot</filename>:</emphasis> - The <filename>wipe-sysroot</filename> script has been - removed as it is no longer needed with recipe-specific - sysroots. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.3-functions'> - <title>Changes to Functions</title> - - <para> - The previously deprecated - <filename>bb.data.getVar()</filename>, - <filename>bb.data.setVar()</filename>, and - related functions have been removed in favor of - <filename>d.getVar()</filename>, - <filename>d.setVar()</filename>, and so forth. - </para> - - <para> - You need to fix any references to these old functions. - </para> - </section> - - <section id='migration-2.3-bitbake-changes'> - <title>BitBake Changes</title> - - <para> - The following changes took place for BitBake: - <itemizedlist> - <listitem><para> - <emphasis>BitBake's Graphical Dependency Explorer UI Replaced:</emphasis> - BitBake's graphical dependency explorer UI - <filename>depexp</filename> was replaced by - <filename>taskexp</filename> ("Task Explorer"), which - provides a graphical way of exploring the - <filename>task-depends.dot</filename> file. - The data presented by Task Explorer is much more - accurate than the data that was presented by - <filename>depexp</filename>. - Being able to visualize the data is an often requested - feature as standard <filename>*.dot</filename> file - viewers cannot usual cope with the size of - the <filename>task-depends.dot</filename> file. - </para></listitem> - <listitem><para> - <emphasis>BitBake "-g" Output Changes:</emphasis> - The <filename>package-depends.dot</filename> and - <filename>pn-depends.dot</filename> files as previously - generated using the <filename>bitbake -g</filename> command - have been removed. - A <filename>recipe-depends.dot</filename> file - is now generated as a collapsed version of - <filename>task-depends.dot</filename> instead. - </para> - - <para>The reason for this change is because - <filename>package-depends.dot</filename> and - <filename>pn-depends.dot</filename> largely date back - to a time before task-based execution and do not take - into account task-level dependencies between recipes, - which could be misleading. - </para></listitem> - <listitem><para> - <emphasis>Mirror Variable Splitting Changes:</emphasis> - Mirror variables including - <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link>, - <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>, - and - <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> - can now separate values entirely with spaces. - Consequently, you no longer need "\\n". - BitBake looks for pairs of values, which simplifies usage. - There should be no change required to existing mirror - variable values themselves. - </para></listitem> - <listitem><para> - <emphasis>The Subversion (SVN) Fetcher Uses an "ssh" Parameter and Not an "rsh" Parameter:</emphasis> - The SVN fetcher now takes an "ssh" parameter instead of an - "rsh" parameter. - This new optional parameter is used when the "protocol" - parameter is set to "svn+ssh". - You can only use the new parameter to specify the - <filename>ssh</filename> program used by SVN. - The SVN fetcher passes the new parameter through the - <filename>SVN_SSH</filename> environment variable during - the - <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> - task.</para> - - <para>See the - "<ulink url='&YOCTO_DOCS_BB_URL;#svn-fetcher'>Subversion (SVN) Fetcher (svn://)</ulink>" - section in the BitBake User Manual for additional - information. - </para></listitem> - <listitem><para> - <emphasis><filename>BB_SETSCENE_VERIFY_FUNCTION</filename> - and <filename>BB_SETSCENE_VERIFY_FUNCTION2</filename> - Removed:</emphasis> - Because the mechanism they were part of is no longer - necessary with recipe-specific sysroots, the - <filename>BB_SETSCENE_VERIFY_FUNCTION</filename> and - <filename>BB_SETSCENE_VERIFY_FUNCTION2</filename> - variables have been removed. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.3-absolute-symlinks'> - <title>Absolute Symbolic Links</title> - - <para> - Absolute symbolic links (symlinks) within staged files are no - longer permitted and now trigger an error. - Any explicit creation of symlinks can use the - <filename>lnr</filename> script, which is a replacement for - <filename>ln -r</filename>. - </para> - - <para> - If the build scripts in the software that the recipe is building - are creating a number of absolute symlinks that need to be - corrected, you can inherit - <filename>relative_symlinks</filename> within the recipe to turn - those absolute symlinks into relative symlinks. - </para> - </section> - - <section id='migration-2.3-gplv2-and-gplv3-moves'> - <title>GPLv2 Versions of GPLv3 Recipes Moved</title> - - <para> - Older GPLv2 versions of GPLv3 recipes have moved to a - separate <filename>meta-gplv2</filename> layer. - </para> - - <para> - If you use - <link linkend='var-INCOMPATIBLE_LICENSE'><filename>INCOMPATIBLE_LICENSE</filename></link> - to exclude GPLv3 or set - <link linkend='var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></link> - to substitute a GPLv2 version of a GPLv3 recipe, then you must add - the <filename>meta-gplv2</filename> layer to your configuration. - <note> - You can find <filename>meta-gplv2</filename> layer in the - OpenEmbedded layer index at - <ulink url='https://layers.openembedded.org/layerindex/branch/master/layer/meta-gplv2/'></ulink>. - </note> - </para> - - <para> - These relocated GPLv2 recipes do not receive the same level of - maintenance as other core recipes. - The recipes do not get security fixes and upstream no longer - maintains them. - In fact, the upstream community is actively hostile towards people - that use the old versions of the recipes. - Moving these recipes into a separate layer both makes the different - needs of the recipes clearer and clearly identifies the number of - these recipes. - <note> - The long-term solution might be to move to BSD-licensed - replacements of the GPLv3 components for those that need to - exclude GPLv3-licensed components from the target system. - This solution will be investigated for future Yocto - Project releases. - </note> - </para> - </section> - - <section id='migration-2.3-package-management-changes'> - <title>Package Management Changes</title> - - <para> - The following package management changes took place: - <itemizedlist> - <listitem><para> - Smart package manager is replaced by DNF package manager. - Smart has become unmaintained upstream, is not ported - to Python 3.x. - Consequently, Smart needed to be replaced. - DNF is the only feasible candidate.</para> - <para>The change in functionality is that the on-target - runtime package management from remote package feeds is - now done with a different tool that has a - different set of command-line options. - If you have scripts that call the - tool directly, or use its API, they need to be fixed.</para> - <para>For more information, see the - <ulink url='http://dnf.readthedocs.io/en/latest/'>DNF Documentation</ulink>. - </para></listitem> - <listitem><para> - Rpm 5.x is replaced with Rpm 4.x. - This is done for two major reasons: - <itemizedlist> - <listitem><para> - DNF is API-incompatible with Rpm 5.x and porting - it and maintaining the port is non-trivial. - </para></listitem> - <listitem><para> - Rpm 5.x itself has limited maintenance upstream, - and the Yocto Project is one of the very few - remaining users. - </para></listitem> - </itemizedlist> - </para></listitem> - <listitem><para> - Berkeley DB 6.x is removed and Berkeley DB 5.x becomes - the default: - <itemizedlist> - <listitem><para> - Version 6.x of Berkeley DB has largely been - rejected by the open source community due to its - AGPLv3 license. - As a result, most mainstream open source projects - that require DB are still developed and tested with - DB 5.x. - </para></listitem> - <listitem><para> - In OE-core, the only thing that was requiring - DB 6.x was Rpm 5.x. - Thus, no reason exists to continue carrying DB 6.x - in OE-core. - </para></listitem> - </itemizedlist> - </para></listitem> - <listitem><para> - <filename>createrepo</filename> is replaced with - <filename>createrepo_c</filename>.</para> - <para><filename>createrepo_c</filename> is the current - incarnation of the tool that generates remote repository - metadata. - It is written in C as compared to - <filename>createrepo</filename>, which is written in - Python. - <filename>createrepo_c</filename> is faster and is - maintained. - </para></listitem> - <listitem><para> - Architecture-independent RPM packages are "noarch" - instead of "all".</para> - <para>This change was made because too many places in - DNF/RPM4 stack already make that assumption. - Only the filenames and the architecture tag has changed. - Nothing else has changed in OE-core system, particularly - in the - <link linkend='ref-classes-allarch'><filename>allarch.bbclass</filename></link> - class. - </para></listitem> - <listitem><para> - Signing of remote package feeds using - <filename>PACKAGE_FEED_SIGN</filename> - is not currently supported. - This issue will be fully addressed in a future - Yocto Project release. - See <ulink url='https://bugzilla.yoctoproject.org/show_bug.cgi?id=11209'>defect 11209</ulink> - for more information on a solution to package feed - signing with RPM in the Yocto Project 2.3 release. - </para></listitem> - <listitem><para> - OPKG now uses the libsolv backend for resolving package - dependencies by default. - This is vastly superior to OPKG's internal ad-hoc solver - that was previously used. - This change does have a small impact on disk (around - 500 KB) and memory footprint. - <note> - For further details on this change, see the - <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/? -id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message</ulink>. - </note> - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.3-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been removed: - <itemizedlist> - <listitem><para> - <emphasis><filename>linux-yocto 4.8:</filename></emphasis> - Version 4.8 has been removed. - Versions 4.1 (LTSI), 4.4 (LTS), 4.9 (LTS/LTSI) and 4.10 - are now present. - </para></listitem> - <listitem><para> - <emphasis><filename>python-smartpm:</filename></emphasis> - Functionally replaced by <filename>dnf</filename>. - </para></listitem> - <listitem><para> - <emphasis><filename>createrepo:</filename></emphasis> - Replaced by the <filename>createrepo-c</filename> recipe. - </para></listitem> - <listitem><para> - <emphasis><filename>rpmresolve:</filename></emphasis> - No longer needed with the move to RPM 4 as RPM itself is - used instead. - </para></listitem> - <listitem><para> - <emphasis><filename>gstreamer:</filename></emphasis> - Removed the GStreamer Git version recipes as they have - been stale. - <filename>1.10.</filename><replaceable>x</replaceable> - recipes are still present. - </para></listitem> - <listitem><para> - <emphasis><filename>alsa-conf-base:</filename></emphasis> - Merged into <filename>alsa-conf</filename> since - <filename>libasound</filename> depended on both. - Essentially, no way existed to install only one of these. - </para></listitem> - <listitem><para> - <emphasis><filename>tremor:</filename></emphasis> - Moved to <filename>meta-multimedia</filename>. - Fixed-integer Vorbis decoding is not - needed by current hardware. - Thus, GStreamer's ivorbis plugin has been disabled - by default eliminating the need for the - <filename>tremor</filename> recipe in - <link linkend='oe-core'>OE-Core</link>. - </para></listitem> - <listitem><para> - <emphasis><filename>gummiboot:</filename></emphasis> - Replaced by <filename>systemd-boot</filename>. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.3-wic-changes'> - <title>Wic Changes</title> - - <para> - The following changes have been made to Wic: - <note> - For more information on Wic, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-partitioned-images-using-wic'>Creating Partitioned Images Using Wic</ulink>" - section in the Yocto Project Development Tasks Manual. - </note> - <itemizedlist> - <listitem><para> - <emphasis>Default Output Directory Changed:</emphasis> - Wic's default output directory is now the current directory - by default instead of the unusual - <filename>/var/tmp/wic</filename>.</para> - - <para>The "-o" and "--outdir" options remain unchanged - and are used to specify your preferred output directory - if you do not want to use the default directory. - </para></listitem> - <listitem><para> - <emphasis>fsimage Plug-in Removed:</emphasis> - The Wic fsimage plug-in has been removed as it duplicates - functionality of the rawcopy plug-in. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.3-qa-changes'> - <title>QA Changes</title> - - <para> - The following QA checks have changed: - <itemizedlist> - <listitem><para> - <emphasis><filename>unsafe-references-in-binaries</filename>:</emphasis> - The <filename>unsafe-references-in-binaries</filename> - QA check, which was disabled by default, has now been - removed. - This check was intended to detect binaries in - <filename>/bin</filename> that link to libraries in - <filename>/usr/lib</filename> and have the case where - the user has <filename>/usr</filename> on a separate - filesystem to <filename>/</filename>.</para> - - <para>The removed QA check was buggy. - Additionally, <filename>/usr</filename> residing on a - separate partition from <filename>/</filename> is now - a rare configuration. - Consequently, - <filename>unsafe-references-in-binaries</filename> was - removed. - </para></listitem> - <listitem><para> - <emphasis><filename>file-rdeps</filename>:</emphasis> - The <filename>file-rdeps</filename> QA check is now an - error by default instead of a warning. - Because it is an error instead of a warning, you need to - address missing runtime dependencies.</para> - - <para>For additional information, see the - <link linkend='ref-classes-insane'><filename>insane</filename></link> - class and the - "<link linkend='qa-errors-and-warnings'>Errors and Warnings</link>" - section. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.3-miscellaneous-changes'> - <title>Miscellaneous Changes</title> - - <para> - The following miscellaneous changes have occurred: - <itemizedlist> - <listitem><para> - In this release, a number of recipes have been changed to - ignore the <filename>largefile</filename> - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - item, enabling large file support unconditionally. - This feature has always been enabled by default. - Disabling the feature has not been widely tested. - <note> - Future releases of the Yocto Project will remove - entirely the ability to disable the - <filename>largefile</filename> feature, - which would make it unconditionally enabled everywhere. - </note> - </para></listitem> - <listitem><para> - If the - <link linkend='var-DISTRO_VERSION'><filename>DISTRO_VERSION</filename></link> - value contains the value of the - <link linkend='var-DATE'><filename>DATE</filename></link> - variable, which is the default between Poky releases, - the <filename>DATE</filename> value is explicitly excluded - from <filename>/etc/issue</filename> and - <filename>/etc/issue.net</filename>, which is displayed at - the login prompt, in order to avoid conflicts with - Multilib enabled. - Regardless, the <filename>DATE</filename> value is - inaccurate if the <filename>base-files</filename> - recipe is restored from shared state (sstate) rather - than rebuilt.</para> - - <para>If you need the build date recorded in - <filename>/etc/issue*</filename> or anywhere else in your - image, a better method is to define a post-processing - function to do it and have the function called from - <link linkend='var-ROOTFS_POSTPROCESS_COMMAND'><filename>ROOTFS_POSTPROCESS_COMMAND</filename></link>. - Doing so ensures the value is always up-to-date with the - created image. - </para></listitem> - <listitem><para> - Dropbear's <filename>init</filename> script now disables - DSA host keys by default. - This change is in line with the systemd service - file, which supports RSA keys only, and with recent - versions of OpenSSH, which deprecates DSA host keys. - </para></listitem> - <listitem><para> - The - <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> - class now correctly uses tabs as separators between all - columns in <filename>installed-package-sizes.txt</filename> - in order to aid import into other tools. - </para></listitem> - <listitem><para> - The <filename>USE_LDCONFIG</filename> variable has been - replaced with the "ldconfig" - <filename>DISTRO_FEATURES</filename> feature. - Distributions that previously set: - <literallayout class='monospaced'> - USE_LDCONFIG = "0" - </literallayout> - should now instead use the following: - <literallayout class='monospaced'> - DISTRO_FEATURES_BACKFILL_CONSIDERED_append = " ldconfig" - </literallayout> - </para></listitem> - <listitem><para> - The default value of - <link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link> - now includes all versions of AGPL licenses in addition - to GPL and LGPL. - <note> - The default list is not intended to be guaranteed - as a complete safe list. - You should seek legal advice based on what you are - distributing if you are unsure. - </note> - </para></listitem> - <listitem><para> - Kernel module packages are now suffixed with the kernel - version in order to allow module packages from multiple - kernel versions to co-exist on a target system. - If you wish to return to the previous naming scheme - that does not include the version suffix, use the - following: - <literallayout class='monospaced'> - KERNEL_MODULE_PACKAGE_SUFFIX to "" - </literallayout> - </para></listitem> - <listitem><para> - Removal of <filename>libtool</filename> - <filename>*.la</filename> files is now enabled by default. - The <filename>*.la</filename> files are not actually - needed on Linux and relocating them is an unnecessary - burden.</para> - - <para>If you need to preserve these - <filename>.la</filename> files (e.g. in a custom - distribution), you must change - <link linkend='var-INHERIT_DISTRO'><filename>INHERIT_DISTRO</filename></link> - such that "remove-libtool" is not included in the value. - </para></listitem> - <listitem><para> - Extensible SDKs built for GCC 5+ now refuse to install on a - distribution where the host GCC version is 4.8 or 4.9. - This change resulted from the fact that the installation - is known to fail due to the way the - <filename>uninative</filename> shared state (sstate) - package is built. - See the - <link linkend='ref-classes-uninative'><filename>uninative</filename></link> - class for additional information. - </para></listitem> - <listitem><para> - All native and nativesdk recipes now use a separate - <filename>DISTRO_FEATURES</filename> value instead of - sharing the value used by recipes for the target, in order - to avoid unnecessary rebuilds.</para> - - <para>The <filename>DISTRO_FEATURES</filename> for - <filename>native</filename> recipes is - <link linkend='var-DISTRO_FEATURES_NATIVE'><filename>DISTRO_FEATURES_NATIVE</filename></link> - added to an intersection of - <filename>DISTRO_FEATURES</filename> and - <link linkend='var-DISTRO_FEATURES_FILTER_NATIVE'><filename>DISTRO_FEATURES_FILTER_NATIVE</filename></link>. - </para> - - <para>For nativesdk recipes, the - corresponding variables are - <link linkend='var-DISTRO_FEATURES_NATIVESDK'><filename>DISTRO_FEATURES_NATIVESDK</filename></link> - and - <link linkend='var-DISTRO_FEATURES_FILTER_NATIVESDK'><filename>DISTRO_FEATURES_FILTER_NATIVESDK</filename></link>. - </para></listitem> - <listitem><para> - The <filename>FILESDIR</filename> - variable, which was previously deprecated and rarely used, - has now been removed. - You should change any recipes that set - <filename>FILESDIR</filename> to set - <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> - instead. - </para></listitem> - <listitem><para> - The <filename>MULTIMACH_HOST_SYS</filename> - variable has been removed as it is no longer needed - with recipe-specific sysroots. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-2.4-release'> - <title>Moving to the Yocto Project 2.4 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 2.4 Release from the prior release. - </para> - - <section id='migration-2.4-memory-resident-mode'> - <title>Memory Resident Mode</title> - - <para> - A persistent mode is now available in BitBake's default operation, - replacing its previous "memory resident mode" (i.e. - <filename>oe-init-build-env-memres</filename>). - Now you only need to set - <link linkend='var-BB_SERVER_TIMEOUT'><filename>BB_SERVER_TIMEOUT</filename></link> - to a timeout (in seconds) and BitBake's server stays resident for - that amount of time between invocations. - The <filename>oe-init-build-env-memres</filename> script has been - removed since a separate environment setup script is no longer - needed. - </para> - </section> - - <section id='migration-2.4-packaging-changes'> - <title>Packaging Changes</title> - - <para> - This section provides information about packaging changes that have - ocurred: - <itemizedlist> - <listitem><para> - <emphasis><filename>python3</filename> Changes:</emphasis> - <itemizedlist> - <listitem><para> - The main "python3" package now brings in all of the - standard Python 3 distribution rather than a subset. - This behavior matches what is expected based on - traditional Linux distributions. - If you wish to install a subset of Python 3, specify - <filename>python-core</filename> plus one or more of - the individual packages that are still produced. - </para></listitem> - <listitem><para> - <emphasis><filename>python3</filename>:</emphasis> - The <filename>bz2.py</filename>, - <filename>lzma.py</filename>, and - <filename>_compression.py</filename> scripts have - been moved from the - <filename>python3-misc</filename> package to - the <filename>python3-compression</filename> package. - </para></listitem> - </itemizedlist> - </para></listitem> - <listitem><para> - <emphasis><filename>binutils</filename>:</emphasis> - The <filename>libbfd</filename> library is now packaged in - a separate "libbfd" package. - This packaging saves space when certain tools - (e.g. <filename>perf</filename>) are installed. - In such cases, the tools only need - <filename>libbfd</filename> rather than all the packages in - <filename>binutils</filename>. - </para></listitem> - <listitem><para> - <emphasis><filename>util-linux</filename> Changes:</emphasis> - <itemizedlist> - <listitem><para> - The <filename>su</filename> program is now packaged - in a separate "util-linux-su" package, which is only - built when "pam" is listed in the - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - variable. - <filename>util-linux</filename> should not be - installed unless it is needed because - <filename>su</filename> is normally provided through - the shadow file format. - The main <filename>util-linux</filename> package has - runtime dependencies (i.e. - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) - on the <filename>util-linux-su</filename> package - when "pam" is in - <filename>DISTRO_FEATURES</filename>. - </para></listitem> - <listitem><para> - The <filename>switch_root</filename> program is now - packaged in a separate "util-linux-switch-root" - package for small initramfs images that do not need - the whole <filename>util-linux</filename> package or - the busybox binary, which are both much larger than - <filename>switch_root</filename>. - The main <filename>util-linux</filename> package has - a recommended runtime dependency (i.e. - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>) - on the <filename>util-linux-switch-root</filename> package. - </para></listitem> - <listitem><para> - The <filename>ionice</filename> program is now - packaged in a separate "util-linux-ionice" package. - The main <filename>util-linux</filename> package has - a recommended runtime dependency (i.e. - <filename>RRECOMMENDS</filename>) - on the <filename>util-linux-ionice</filename> package. - </para></listitem> - </itemizedlist> - </para></listitem> - <listitem><para> - <emphasis><filename>initscripts</filename>:</emphasis> - The <filename>sushell</filename> program is now packaged in - a separate "initscripts-sushell" package. - This packaging change allows systems to pull - <filename>sushell</filename> in when - <filename>selinux</filename> is enabled. - The change also eliminates needing to pull in the entire - <filename>initscripts</filename> package. - The main <filename>initscripts</filename> package has a - runtime dependency (i.e. <filename>RDEPENDS</filename>) - on the <filename>sushell</filename> package when - "selinux" is in <filename>DISTRO_FEATURES</filename>. - </para></listitem> - <listitem><para> - <emphasis><filename>glib-2.0</filename>:</emphasis> - The <filename>glib-2.0</filename> package now has a - recommended runtime dependency (i.e. - <filename>RRECOMMENDS</filename>) on the - <filename>shared-mime-info</filename> package, since large - portions of GIO are not useful without the MIME database. - You can remove the dependency by using the - <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link> - variable if <filename>shared-mime-info</filename> is too - large and is not required. - </para></listitem> - <listitem><para> - <emphasis>Go Standard Runtime:</emphasis> - The Go standard runtime has been split out from the main - <filename>go</filename> recipe into a separate - <filename>go-runtime</filename> recipe. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.4-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been removed: - <itemizedlist> - <listitem><para> - <emphasis><filename>acpitests</filename>:</emphasis> - This recipe is not maintained. - </para></listitem> - <listitem><para> - <emphasis><filename>autogen-native</filename>:</emphasis> - No longer required by Grub, oe-core, or meta-oe. - </para></listitem> - <listitem><para> - <emphasis><filename>bdwgc</filename>:</emphasis> - Nothing in OpenEmbedded-Core requires this recipe. - It has moved to meta-oe. - </para></listitem> - <listitem><para> - <emphasis><filename>byacc</filename>:</emphasis> - This recipe was only needed by rpm 5.x and has moved to - meta-oe. - </para></listitem> - <listitem><para> - <emphasis><filename>gcc (5.4)</filename>:</emphasis> - The 5.4 series dropped the recipe in favor of 6.3 / 7.2. - </para></listitem> - <listitem><para> - <emphasis><filename>gnome-common</filename>:</emphasis> - Deprecated upstream and no longer needed. - </para></listitem> - <listitem><para> - <emphasis><filename>go-bootstrap-native</filename>:</emphasis> - Go 1.9 does its own bootstrapping so this recipe has been - removed. - </para></listitem> - <listitem><para> - <emphasis><filename>guile</filename>:</emphasis> - This recipe was only needed by - <filename>autogen-native</filename> and - <filename>remake</filename>. - The recipe is no longer needed by either of these programs. - </para></listitem> - <listitem><para> - <emphasis><filename>libclass-isa-perl</filename>:</emphasis> - This recipe was previously needed for LSB 4, no longer - needed. - </para></listitem> - <listitem><para> - <emphasis><filename>libdumpvalue-perl</filename>:</emphasis> - This recipe was previously needed for LSB 4, no longer - needed. - </para></listitem> - <listitem><para> - <emphasis><filename>libenv-perl</filename>:</emphasis> - This recipe was previously needed for LSB 4, no longer - needed. - </para></listitem> - <listitem><para> - <emphasis><filename>libfile-checktree-perl</filename>:</emphasis> - This recipe was previously needed for LSB 4, no longer - needed. - </para></listitem> - <listitem><para> - <emphasis><filename>libi18n-collate-perl</filename>:</emphasis> - This recipe was previously needed for LSB 4, no longer - needed. - </para></listitem> - <listitem><para> - <emphasis><filename>libiconv</filename>:</emphasis> - This recipe was only needed for <filename>uclibc</filename>, - which was removed in the previous release. - <filename>glibc</filename> and <filename>musl</filename> - have their own implementations. - <filename>meta-mingw</filename> still needs - <filename>libiconv</filename>, so it has - been moved to <filename>meta-mingw</filename>. - </para></listitem> - <listitem><para> - <emphasis><filename>libpng12</filename>:</emphasis> - This recipe was previously needed for LSB. The current - <filename>libpng</filename> is 1.6.x. - </para></listitem> - <listitem><para> - <emphasis><filename>libpod-plainer-perl</filename>:</emphasis> - This recipe was previously needed for LSB 4, no longer - needed. - </para></listitem> - <listitem><para> - <emphasis><filename>linux-yocto (4.1)</filename>:</emphasis> - This recipe was removed in favor of 4.4, 4.9, 4.10 and 4.12. - </para></listitem> - <listitem><para> - <emphasis><filename>mailx</filename>:</emphasis> - This recipe was previously only needed for LSB - compatibility, and upstream is defunct. - </para></listitem> - <listitem><para> - <emphasis><filename>mesa (git version only)</filename>:</emphasis> - The git version recipe was stale with respect to the release - version. - </para></listitem> - <listitem><para> - <emphasis><filename>ofono (git version only)</filename>:</emphasis> - The git version recipe was stale with respect to the release - version. - </para></listitem> - <listitem><para> - <emphasis><filename>portmap</filename>:</emphasis> - This recipe is obsolete and is superseded by - <filename>rpcbind</filename>. - </para></listitem> - <listitem><para> - <emphasis><filename>python3-pygpgme</filename>:</emphasis> - This recipe is old and unmaintained. It was previously - required by <filename>dnf</filename>, which has switched - to official <filename>gpgme</filename> Python bindings. - </para></listitem> - <listitem><para> - <emphasis><filename>python-async</filename>:</emphasis> - This recipe has been removed in favor of the Python 3 - version. - </para></listitem> - <listitem><para> - <emphasis><filename>python-gitdb</filename>:</emphasis> - This recipe has been removed in favor of the Python 3 - version. - </para></listitem> - <listitem><para> - <emphasis><filename>python-git</filename>:</emphasis> - This recipe was removed in favor of the Python 3 - version. - </para></listitem> - <listitem><para> - <emphasis><filename>python-mako</filename>:</emphasis> - This recipe was removed in favor of the Python 3 - version. - </para></listitem> - <listitem><para> - <emphasis><filename>python-pexpect</filename>:</emphasis> - This recipe was removed in favor of the Python 3 version. - </para></listitem> - <listitem><para> - <emphasis><filename>python-ptyprocess</filename>:</emphasis> - This recipe was removed in favor of Python the 3 version. - </para></listitem> - <listitem><para> - <emphasis><filename>python-pycurl</filename>:</emphasis> - Nothing is using this recipe in OpenEmbedded-Core - (i.e. <filename>meta-oe</filename>). - </para></listitem> - <listitem><para> - <emphasis><filename>python-six</filename>:</emphasis> - This recipe was removed in favor of the Python 3 version. - </para></listitem> - <listitem><para> - <emphasis><filename>python-smmap</filename>:</emphasis> - This recipe was removed in favor of the Python 3 version. - </para></listitem> - <listitem><para> - <emphasis><filename>remake</filename>:</emphasis> - Using <filename>remake</filename> as the provider of - <filename>virtual/make</filename> is broken. - Consequently, this recipe is not needed in OpenEmbedded-Core. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.4-kernel-device-tree-move'> - <title>Kernel Device Tree Move</title> - - <para> - Kernel Device Tree support is now easier to enable in a kernel - recipe. - The Device Tree code has moved to a - <link linkend='ref-classes-kernel-devicetree'><filename>kernel-devicetree</filename></link> - class. - Functionality is automatically enabled for any recipe that inherits - the - <link linkend='ref-classes-kernel'><filename>kernel</filename></link> - class and sets the - <link linkend='var-KERNEL_DEVICETREE'><filename>KERNEL_DEVICETREE</filename></link> - variable. - The previous mechanism for doing this, - <filename>meta/recipes-kernel/linux/linux-dtb.inc</filename>, - is still available to avoid breakage, but triggers a - deprecation warning. - Future releases of the Yocto Project will remove - <filename>meta/recipes-kernel/linux/linux-dtb.inc</filename>. - It is advisable to remove any <filename>require</filename> - statements that request - <filename>meta/recipes-kernel/linux/linux-dtb.inc</filename> - from any custom kernel recipes you might have. - This will avoid breakage in post 2.4 releases. - </para> - </section> - - <section id='migration-2.4-package-qa-changes'> - <title>Package QA Changes</title> - - <para> - The following package QA changes took place: - <itemizedlist> - <listitem><para> - The "unsafe-references-in-scripts" QA check has been - removed. - </para></listitem> - <listitem><para> - If you refer to <filename>${COREBASE}/LICENSE</filename> - within - <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link> - you receive a warning because this file is a description of - the license for OE-Core. - Use <filename>${COMMON_LICENSE_DIR}/MIT</filename> - if your recipe is MIT-licensed and you cannot use the - preferred method of referring to a file within the source - tree. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.4-readme-changes'> - <title><filename>README</filename> File Changes</title> - - <para> - The following are changes to <filename>README</filename> files: - <itemizedlist> - <listitem><para> - The main Poky <filename>README</filename> file has been - moved to the <filename>meta-poky</filename> layer and - has been renamed <filename>README.poky</filename>. - A symlink has been created so that references to the old - location work. - </para></listitem> - <listitem><para> - The <filename>README.hardware</filename> file has been moved - to <filename>meta-yocto-bsp</filename>. - A symlink has been created so that references to the old - location work. - </para></listitem> - <listitem><para> - A <filename>README.qemu</filename> file has been created - with coverage of the <filename>qemu*</filename> machines. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.4-miscellaneous-changes'> - <title>Miscellaneous Changes</title> - - <para> - The following are additional changes: - <itemizedlist> - <listitem><para> - The <filename>ROOTFS_PKGMANAGE_BOOTSTRAP</filename> - variable and any references to it have been removed. - You should remove this variable from any custom recipes. - </para></listitem> - <listitem><para> - The <filename>meta-yocto</filename> directory has been - removed. - <note> - In the Yocto Project 2.1 release - <filename>meta-yocto</filename> was renamed to - <filename>meta-poky</filename> and the - <filename>meta-yocto</filename> subdirectory remained - to avoid breaking existing configurations. - </note> - </para></listitem> - <listitem><para> - The <filename>maintainers.inc</filename> file, which tracks - maintainers by listing a primary person responsible for each - recipe in OE-Core, has been moved from - <filename>meta-poky</filename> to OE-Core (i.e. from - <filename>meta-poky/conf/distro/include</filename> to - <filename>meta/conf/distro/include</filename>). - </para></listitem> - <listitem><para> - The - <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> - class now makes a single commit per build rather than one - commit per subdirectory in the repository. - This behavior assumes the commits are enabled with - <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> - = "1", which is typical. - Previously, the <filename>buildhistory</filename> class made - one commit per subdirectory in the repository in order to - make it easier to see the changes for a particular - subdirectory. - To view a particular change, specify that subdirectory as - the last parameter on the <filename>git show</filename> - or <filename>git diff</filename> commands. - </para></listitem> - <listitem><para> - The <filename>x86-base.inc</filename> file, which is - included by all x86-based machine configurations, now sets - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - using <filename>?=</filename> to "live" rather than - appending with <filename>+=</filename>. - This change makes the default easier to override. - </para></listitem> - <listitem><para> - BitBake fires multiple "BuildStarted" events when - multiconfig is enabled (one per configuration). - For more information, see the - "<ulink url='&YOCTO_DOCS_BB_URL;#events'>Events</ulink>" - section in the BitBake User Manual. - </para></listitem> - <listitem><para> - By default, the <filename>security_flags.inc</filename> file - sets a - <link linkend='var-GCCPIE'><filename>GCCPIE</filename></link> - variable with an option to enable Position Independent - Executables (PIE) within <filename>gcc</filename>. - Enabling PIE in the GNU C Compiler (GCC), makes Return - Oriented Programming (ROP) attacks much more difficult to - execute. - </para></listitem> - <listitem><para> - OE-Core now provides a - <filename>bitbake-layers</filename> plugin that implements - a "create-layer" subcommand. - The implementation of this subcommand has resulted in the - <filename>yocto-layer</filename> script being deprecated and - will likely be removed in the next Yocto Project release. - </para></listitem> - <listitem><para> - The <filename>vmdk</filename>, <filename>vdi</filename>, - and <filename>qcow2</filename> image file types are now - used in conjunction with the "wic" image type through - <filename>CONVERSION_CMD</filename>. - Consequently, the equivalent image types are now - <filename>wic.vmdk</filename>, <filename>wic.vdi</filename>, - and <filename>wic.qcow2</filename>, respectively. - </para></listitem> - <listitem><para> - <filename>do_image_<type>[depends]</filename> has - replaced <filename>IMAGE_DEPENDS_<type></filename>. - If you have your own classes that implement custom image - types, then you need to update them. - </para></listitem> - <listitem><para> - OpenSSL 1.1 has been introduced. - However, the default is still 1.0.x through the - <link linkend='var-PREFERRED_VERSION'><filename>PREFERRED_VERSION</filename></link> - variable. - This preference is set is due to the remaining compatibility - issues with other software. - The - <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> - variable in the openssl 1.0 recipe now includes "openssl10" - as a marker that can be used in - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> - within recipes that build software that still depend on - OpenSSL 1.0. - </para></listitem> - <listitem><para> - To ensure consistent behavior, BitBake's "-r" and "-R" - options (i.e. prefile and postfile), which are used to - read or post-read additional configuration files from the - command line, now only affect the current BitBake command. - Before these BitBake changes, these options would "stick" - for future executions. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-2.5-release'> - <title>Moving to the Yocto Project 2.5 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 2.5 Release from the prior release. - </para> - - <section id='migration-2.5-packaging-changes'> - <title>Packaging Changes</title> - - <para> - This section provides information about packaging changes that have - occurred: - <itemizedlist> - <listitem><para> - <emphasis><filename>bind-libs</filename>:</emphasis> - The libraries packaged by the bind recipe are in a - separate <filename>bind-libs</filename> package. - </para></listitem> - <listitem><para> - <emphasis><filename>libfm-gtk</filename>:</emphasis> - The <filename>libfm</filename> GTK+ bindings are split into - a separate <filename>libfm-gtk</filename> package. - </para></listitem> - <listitem><para> - <emphasis><filename>flex-libfl</filename>:</emphasis> - The flex recipe splits out libfl into a separate - <filename>flex-libfl</filename> package to avoid too many - dependencies being pulled in where only the library is - needed. - </para></listitem> - <listitem><para> - <emphasis><filename>grub-efi</filename>:</emphasis> - The <filename>grub-efi</filename> configuration is split - into a separate <filename>grub-bootconf</filename> - recipe. - However, the dependency relationship from - <filename>grub-efi</filename> is through a - virtual/grub-bootconf provider making it possible to have - your own recipe provide the dependency. - Alternatively, you can use a BitBake append file to bring - the configuration back into the - <filename>grub-efi</filename> recipe. - </para></listitem> - <listitem><para> - <emphasis>armv7a Legacy Package Feed Support:</emphasis> - Legacy support is removed for transitioning from - <filename>armv7a</filename> to - <filename>armv7a-vfp-neon</filename> in package feeds, - which was previously enabled by setting - <filename>PKGARCHCOMPAT_ARMV7A</filename>. - This transition occurred in 2011 and active package feeds - should by now be updated to the new naming. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.5-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been removed: - <itemizedlist> - <listitem><para> - <emphasis><filename>gcc</filename>:</emphasis> - The version 6.4 recipes are replaced by 7.x. - </para></listitem> - <listitem><para> - <emphasis><filename>gst-player</filename>:</emphasis> - Renamed to <filename>gst-examples</filename> as per - upstream. - </para></listitem> - <listitem><para> - <emphasis><filename>hostap-utils</filename>:</emphasis> - This software package is obsolete. - </para></listitem> - <listitem><para> - <emphasis><filename>latencytop</filename>:</emphasis> - This recipe is no longer maintained upstream. - The last release was in 2009. - </para></listitem> - <listitem><para> - <emphasis><filename>libpfm4</filename>:</emphasis> - The only file that requires this recipe is - <filename>oprofile</filename>, which has been removed. - </para></listitem> - <listitem><para> - <emphasis><filename>linux-yocto</filename>:</emphasis> - The version 4.4, 4.9, and 4.10 recipes have been removed. - Versions 4.12, 4.14, and 4.15 remain. - </para></listitem> - <listitem><para> - <emphasis><filename>man</filename>:</emphasis> - This recipe has been replaced by modern - <filename>man-db</filename> - </para></listitem> - <listitem><para> - <emphasis><filename>mkelfimage</filename>:</emphasis> - This tool has been removed in the upstream coreboot project, - and is no longer needed with the removal of the ELF image - type. - </para></listitem> - <listitem><para> - <emphasis><filename>nativesdk-postinst-intercept</filename>:</emphasis> - This recipe is not maintained. - </para></listitem> - <listitem><para> - <emphasis><filename>neon</filename>:</emphasis> - This software package is no longer maintained upstream and - is no longer needed by anything in OpenEmbedded-Core. - </para></listitem> - <listitem><para> - <emphasis><filename>oprofile</filename>:</emphasis> - The functionality of this recipe is replaced by - <filename>perf</filename> and keeping compatibility on - an ongoing basis with <filename>musl</filename> is - difficult. - </para></listitem> - <listitem><para> - <emphasis><filename>pax</filename>:</emphasis> - This software package is obsolete. - </para></listitem> - <listitem><para> - <emphasis><filename>stat</filename>:</emphasis> - This software package is not maintained upstream. - <filename>coreutils</filename> provides a modern stat binary. - </para></listitem> - <listitem><para> - <emphasis><filename>zisofs-tools-native</filename>:</emphasis> - This recipe is no longer needed because the compressed - ISO image feature has been removed. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.5-scripts-and-tools-changes'> - <title>Scripts and Tools Changes</title> - - <para> - The following are changes to scripts and tools: - <itemizedlist> - <listitem><para> - <emphasis><filename>yocto-bsp</filename>, - <filename>yocto-kernel</filename>, and - <filename>yocto-layer</filename></emphasis>: - The <filename>yocto-bsp</filename>, - <filename>yocto-kernel</filename>, and - <filename>yocto-layer</filename> scripts previously shipped - with poky but not in OpenEmbedded-Core have been removed. - These scripts are not maintained and are outdated. - In many cases, they are also limited in scope. - The <filename>bitbake-layers create-layer</filename> command - is a direct replacement for <filename>yocto-layer</filename>. - See the documentation to create a BSP or kernel recipe in - the - "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-kernel-recipe-example'>BSP Kernel Recipe Example</ulink>" - section. - </para></listitem> - <listitem><para> - <emphasis><filename>devtool finish</filename>:</emphasis> - <filename>devtool finish</filename> now exits with an error - if there are uncommitted changes or a rebase/am in progress - in the recipe's source repository. - If this error occurs, there might be uncommitted changes - that will not be included in updates to the patches applied - by the recipe. - A -f/--force option is provided for situations that the - uncommitted changes are inconsequential and you want to - proceed regardless. - </para></listitem> - <listitem><para> - <emphasis><filename>scripts/oe-setup-rpmrepo</filename> script:</emphasis> - The functionality of - <filename>scripts/oe-setup-rpmrepo</filename> is replaced by - <filename>bitbake package-index</filename>. - </para></listitem> - <listitem><para> - <emphasis><filename>scripts/test-dependencies.sh</filename> script:</emphasis> - The script is largely made obsolete by the - recipe-specific sysroots functionality introduced in the - previous release. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.5-bitbake-changes'> - <title>BitBake Changes</title> - - <para> - The following are BitBake changes: - <itemizedlist> - <listitem><para> - The <filename>--runall</filename> option has changed. - There are two different behaviors people might want: - <itemizedlist> - <listitem><para> - <emphasis>Behavior A:</emphasis> - For a given target (or set of targets) look through - the task graph and run task X only if it is present - and will be built. - </para></listitem> - <listitem><para> - <emphasis>Behavior B:</emphasis> - For a given target (or set of targets) look through - the task graph and run task X if any recipe in the - taskgraph has such a target, even if it is not in - the original task graph. - </para></listitem> - </itemizedlist> - The <filename>--runall</filename> option now performs - "Behavior B". - Previously <filename>--runall</filename> behaved like - "Behavior A". - A <filename>--runonly</filename> option has been added to - retain the ability to perform "Behavior A". - </para></listitem> - <listitem><para> - Several explicit "run this task for all recipes in the - dependency tree" tasks have been removed (e.g. - <filename>fetchall</filename>, - <filename>checkuriall</filename>, and the - <filename>*all</filename> tasks provided by the - <filename>distrodata</filename> and - <filename>archiver</filename> classes). - There is a BitBake option to complete this for any arbitrary - task. For example: - <literallayout class='monospaced'> - bitbake <target> -c fetchall - </literallayout> - should now be replaced with: - <literallayout class='monospaced'> - bitbake <target> --runall=fetch - </literallayout> - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.5-python-and-python3-changes'> - <title>Python and Python 3 Changes</title> - - <para> - The following are auto-packaging changes to Python and Python 3: - </para> - <para> - The script-managed <filename>python-*-manifest.inc</filename> files - that were previously used to generate Python and Python 3 - packages have been replaced with a JSON-based file that is - easier to read and maintain. - A new task is available for maintainers of the Python recipes to - update the JSON file when upgrading to new Python versions. - You can now edit the file directly instead of having to edit a - script and run it to update the file. - </para> - <para> - One particular change to note is that the Python recipes no longer - have build-time provides for their packages. - This assumes <filename>python-foo</filename> is one of the packages - provided by the Python recipe. - You can no longer run <filename>bitbake python-foo</filename> or - have a <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPENDS'><filename>DEPENDS</filename></ulink> on - <filename>python-foo</filename>, but doing either of the following - causes the package to work as expected: - <literallayout class='monospaced'> - IMAGE_INSTALL_append = " python-foo" - </literallayout> - or - <literallayout class='monospaced'> - RDEPENDS_${PN} = "python-foo" - </literallayout> - The earlier build-time provides behavior was a quirk of the way the - Python manifest file was created. - For more information on this change please see - <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce'>this commit</ulink>. - </para> - </section> - - <section id='migration-2.5-miscellaneous-changes'> - <title>Miscellaneous Changes</title> - - <para> - The following are additional changes: - <itemizedlist> - <listitem><para> - The <filename>kernel</filename> class supports building - packages for multiple kernels. - If your kernel recipe or <filename>.bbappend</filename> file - mentions packaging at all, you should replace references to - the kernel in package names with - <filename>${KERNEL_PACKAGE_NAME}</filename>. - For example, if you disable automatic installation of the - kernel image using - <filename>RDEPENDS_kernel-base = ""</filename> you can avoid - warnings using - <filename>RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""</filename> - instead. - </para></listitem> - <listitem><para> - The <filename>buildhistory</filename> class commits changes - to the repository by default so you no longer need to set - <filename>BUILDHISTORY_COMMIT = "1"</filename>. - If you want to disable commits you need to set - <filename>BUILDHISTORY_COMMIT = "0"</filename> in your - configuration. - </para></listitem> - <listitem><para> - The <filename>beaglebone</filename> reference machine has - been renamed to <filename>beaglebone-yocto</filename>. - The <filename>beaglebone-yocto</filename> BSP is a reference - implementation using only mainline components available in - OpenEmbedded-Core and <filename>meta-yocto-bsp</filename>, - whereas Texas Instruments maintains a full-featured BSP in - the <filename>meta-ti</filename> layer. - This rename avoids the previous name clash that existed - between the two BSPs. - </para></listitem> - <listitem><para> - The <filename>update-alternatives</filename> class no longer - works with SysV <filename>init</filename> scripts because - this usage has been problematic. - Also, the <filename>sysklogd</filename> recipe no longer - uses <filename>update-alternatives</filename> because it is - incompatible with other implementations. - </para></listitem> - <listitem><para> - By default, the - <link linkend='ref-classes-cmake'><filename>cmake</filename></link> - class uses <filename>ninja</filename> instead of - <filename>make</filename> for building. - This improves build performance. - If a recipe is broken with <filename>ninja</filename>, then - the recipe can set - <filename>OECMAKE_GENERATOR = "Unix Makefiles"</filename> - to change back to <filename>make</filename>. - </para></listitem> - <listitem><para> - The previously deprecated <filename>base_*</filename> - functions have been removed in favor of their replacements - in <filename>meta/lib/oe</filename> and - <filename>bitbake/lib/bb</filename>. - These are typically used from recipes and classes. - Any references to the old functions must be updated. - The following table shows the removed functions and their - replacements: - - <literallayout class='monospaced'> - <emphasis>Removed</emphasis> <emphasis>Replacement</emphasis> - ============================ ============================ - base_path_join() oe.path.join() - base_path_relative() oe.path.relative() - base_path_out() oe.path.format_display() - base_read_file() oe.utils.read_file() - base_ifelse() oe.utils.ifelse() - base_conditional() oe.utils.conditional() - base_less_or_equal() oe.utils.less_or_equal() - base_version_less_or_equal() oe.utils.version_less_or_equal() - base_contains() bb.utils.contains() - base_both_contain() oe.utils.both_contain() - base_prune_suffix() oe.utils.prune_suffix() - oe_filter() oe.utils.str_filter() - oe_filter_out() oe.utils.str_filter_out() (or use the _remove operator). - </literallayout> - </para></listitem> - <listitem><para> - Using <filename>exit 1</filename> to explicitly defer a - postinstall script until first boot is now deprecated since - it is not an obvious mechanism and can mask actual errors. - If you want to explicitly defer a postinstall to first boot - on the target rather than at <filename>rootfs</filename> - creation time, use - <filename>pkg_postinst_ontarget()</filename> - or call - <filename>postinst-intercepts defer_to_first_boot</filename> - from <filename>pkg_postinst()</filename>. - Any failure of a <filename>pkg_postinst()</filename> - script (including <filename>exit 1</filename>) - will trigger a warning during - <filename>do_rootfs</filename>.</para> - - <para>For more information, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-post-installation-scripts'>Post-Installation Scripts</ulink>" - section in the Yocto Project Development Tasks Manual. - </para></listitem> - <listitem><para> - The <filename>elf</filename> image type has been removed. - This image type was removed because the - <filename>mkelfimage</filename> tool - that was required to create it is no longer provided by - coreboot upstream and required updating every time - <filename>binutils</filename> updated. - </para></listitem> - <listitem><para> - Support for .iso image compression (previously enabled - through <filename>COMPRESSISO = "1"</filename>) has been - removed. - The userspace tools (<filename>zisofs-tools</filename>) are - unmaintained and <filename>squashfs</filename> provides - better performance and compression. - In order to build a live image with squashfs+lz4 compression - enabled you should now set - <filename>LIVE_ROOTFS_TYPE = "squashfs-lz4"</filename> - and ensure that <filename>live</filename> - is in <filename>IMAGE_FSTYPES</filename>. - </para></listitem> - <listitem><para> - Recipes with an unconditional dependency on - <filename>libpam</filename> are only buildable with - <filename>pam</filename> in - <filename>DISTRO_FEATURES</filename>. - If the dependency is truly optional then it is recommended - that the dependency be conditional upon - <filename>pam</filename> being in - <filename>DISTRO_FEATURES</filename>. - </para></listitem> - <listitem><para> - For EFI-based machines, the bootloader - (<filename>grub-efi</filename> by default) is installed into - the image at /boot. - Wic can be used to split the bootloader into separate boot - and rootfs partitions if necessary. - </para></listitem> - <listitem><para> - Patches whose context does not match exactly (i.e. where - patch reports "fuzz" when applying) will generate a - warning. - For an example of this see - <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=cc97bc08125b63821ce3f616771830f77c456f57'>this commit</ulink>. - </para></listitem> - <listitem><para> - Layers are expected to set - <filename>LAYERSERIES_COMPAT_layername</filename> - to match the version(s) of OpenEmbedded-Core they are - compatible with. - This is specified as codenames using spaces to separate - multiple values (e.g. "rocko sumo"). - If a layer does not set - <filename>LAYERSERIES_COMPAT_layername</filename>, a warning - will is shown. - If a layer sets a value that does not include the current - version ("sumo" for the 2.5 release), then an error will be - produced. - </para></listitem> - <listitem><para> - The <filename>TZ</filename> environment variable is set to - "UTC" within the build environment in order to fix - reproducibility problems in some recipes. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> - -<section id='moving-to-the-yocto-project-2.6-release'> - <title>Moving to the Yocto Project 2.6 Release</title> - - <para> - This section provides migration information for moving to the - Yocto Project 2.6 Release from the prior release. - </para> - - <section id='migration-2.6-gcc-changes'> - <title>GCC 8.2 is Now Used by Default</title> - - <para> - The GNU Compiler Collection version 8.2 is now used by default - for compilation. - For more information on what has changed in the GCC 8.x release, - see - <ulink url='https://gcc.gnu.org/gcc-8/changes.html'></ulink>. - </para> - - <para> - If you still need to compile with version 7.x, GCC 7.3 is - also provided. - You can select this version by setting the - and can be selected by setting the - <link linkend='var-GCCVERSION'><filename>GCCVERSION</filename></link> - variable to "7.%" in your configuration. - </para> - </section> - - <section id='migration-2.6-removed-recipes'> - <title>Removed Recipes</title> - - <para> - The following recipes have been removed: - <literallayout class='monospaced'> - <emphasis><filename>beecrypt</filename>:</emphasis> No longer needed since moving to RPM 4. - <emphasis><filename>bigreqsproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>calibrateproto</filename>:</emphasis> Removed in favor of <filename>xinput</filename>. - <emphasis><filename>compositeproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>damageproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>dmxproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>dri2proto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>dri3proto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>eee-acpi-scripts</filename>:</emphasis> Became obsolete. - <emphasis><filename>fixesproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>fontsproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>fstests</filename>:</emphasis> Became obsolete. - <emphasis><filename>gccmakedep</filename>:</emphasis> No longer used. - <emphasis><filename>glproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>gnome-desktop3</filename>:</emphasis> No longer needed. This recipe has moved to <filename>meta-oe</filename>. - <emphasis><filename>icon-naming-utils</filename>:</emphasis> No longer used since the Sato theme was removed in 2016. - <emphasis><filename>inputproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>kbproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>libusb-compat</filename>:</emphasis> Became obsolete. - <emphasis><filename>libuser</filename>:</emphasis> Became obsolete. - <emphasis><filename>libnfsidmap</filename>:</emphasis> No longer an external requirement since <filename>nfs-utils</filename> 2.2.1. <filename>libnfsidmap</filename> is now integrated. - <emphasis><filename>libxcalibrate</filename>:</emphasis> No longer needed with <filename>xinput</filename> - <emphasis><filename>mktemp</filename>:</emphasis> Became obsolete. The <filename>mktemp</filename> command is provided by both <filename>busybox</filename> and <filename>coreutils</filename>. - <emphasis><filename>ossp-uuid</filename>:</emphasis> Is not being maintained and has mostly been replaced by <filename>uuid.h</filename> in <filename>util-linux</filename>. - <emphasis><filename>pax-utils</filename>:</emphasis> No longer needed. Previous QA tests that did use this recipe are now done at build time. - <emphasis><filename>pcmciautils</filename>:</emphasis> Became obsolete. - <emphasis><filename>pixz</filename>:</emphasis> No longer needed. <filename>xz</filename> now supports multi-threaded compression. - <emphasis><filename>presentproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>randrproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>recordproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>renderproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>resourceproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>scrnsaverproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>trace-cmd</filename>:</emphasis> Became obsolete. <filename>perf</filename> replaced this recipe's functionally. - <emphasis><filename>videoproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>wireless-tools</filename>:</emphasis> Became obsolete. Superseded by <filename>iw</filename>. - <emphasis><filename>xcmiscproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>xextproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>xf86dgaproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>xf86driproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>xf86miscproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>xf86-video-omapfb</filename>:</emphasis> Became obsolete. Use kernel modesetting driver instead. - <emphasis><filename>xf86-video-omap</filename>:</emphasis> Became obsolete. Use kernel modesetting driver instead. - <emphasis><filename>xf86vidmodeproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>xineramaproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>xproto</filename>:</emphasis> Replaced by <filename>xorgproto</filename>. - <emphasis><filename>yasm</filename>:</emphasis> No longer needed since previous usages are now satisfied by <filename>nasm</filename>. - </literallayout> - </para> - </section> - - <section id='migration-2.6-packaging-changes'> - <title>Packaging Changes</title> - - <para> - The following packaging changes have been made: - <itemizedlist> - <listitem><para> - <emphasis><filename>cmake</filename>:</emphasis> - <filename>cmake.m4</filename> and - <filename>toolchain</filename> files have been moved to the - main package. - </para></listitem> - <listitem><para> - <emphasis><filename>iptables</filename>:</emphasis> - The <filename>iptables</filename> modules have been split - into separate packages. - </para></listitem> - <listitem><para> - <emphasis><filename>alsa-lib</filename>:</emphasis> - <filename>libasound</filename> is now in the main - <filename>alsa-lib</filename> package instead of - <filename>libasound</filename>. - </para></listitem> - <listitem><para> - <emphasis><filename>glibc</filename>:</emphasis> - <filename>libnss-db</filename> is now in its own package - along with a <filename>/var/db/makedbs.sh</filename> - script to update databases. - </para></listitem> - <listitem><para> - <emphasis><filename>python</filename> and <filename>python3</filename>:</emphasis> - The main package has been removed from the recipe. - You must install specific packages or - <filename>python-modules</filename> / - <filename>python3-modules</filename> for everything. - </para></listitem> - <listitem><para> - <emphasis><filename>systemtap</filename>:</emphasis> - Moved <filename>systemtap-exporter</filename> into its own - package. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.6-xorg-protocol-dependencies'> - <title>XOrg Protocol dependencies</title> - - <para> - The "*proto" upstream repositories have been combined into one - "xorgproto" repository. - Thus, the corresponding recipes have also been combined into a - single <filename>xorgproto</filename> recipe. - Any recipes that depend upon the older <filename>*proto</filename> - recipes need to be changed to depend on the newer - <filename>xorgproto</filename> recipe instead. - </para> - - <para> - For names of recipes removed because of this repository change, - see the - <link linkend="migration-2.6-removed-recipes">Removed Recipes</link> - section. - </para> - </section> - - <section id='migration-2.6-distutils-distutils3-fetching-dependencies'> - <title><filename>distutils</filename> and <filename>distutils3</filename> Now Prevent Fetching Dependencies During the <filename>do_configure</filename> Task</title> - - <para> - Previously, it was possible for Python recipes that inherited - the - <link linkend='ref-classes-distutils'><filename>distutils</filename></link> - and - <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link> - classes to fetch code during the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task to satisfy dependencies mentioned in - <filename>setup.py</filename> if those dependencies were not - provided in the sysroot (i.e. recipes providing the dependencies - were missing from - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>). - <note> - This change affects classes beyond just the two mentioned - (i.e. <filename>distutils</filename> and - <filename>distutils3</filename>). - Any recipe that inherits <filename>distutils*</filename> - classes are affected. - For example, the <filename>setuptools</filename> and - <filename>setuptools3</filename> recipes are affected since - they inherit the <filename>distutils*</filename> classes. - </note> - </para> - - <para> - Fetching these types of dependencies that are not provided in the - sysroot negatively affects the ability to reproduce builds. - This type of fetching is now explicitly disabled. - Consequently, any missing dependencies in Python recipes that - use these classes now result in an error during the - <filename>do_configure</filename> task. - </para> - </section> - - <section id='migration-2.6-linux-yocto-configuration-audit-issues-now-correctly-reported'> - <title><filename>linux-yocto</filename> Configuration Audit Issues Now Correctly Reported</title> - - <para> - Due to a bug, the kernel configuration audit functionality was - not writing out any resulting warnings during the build. - This issue is now corrected. - You might notice these warnings now if you have a custom kernel - configuration with a <filename>linux-yocto</filename> style - kernel recipe. - </para> - </section> - - <section id='migration-2.6-image-kernel-artifact-naming-changes'> - <title>Image/Kernel Artifact Naming Changes</title> - - <para> - The following changes have been made: - <itemizedlist> - <listitem><para> - Name variables (e.g. - <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link>) - use a new <filename>IMAGE_VERSION_SUFFIX</filename> - variable instead of - <link linkend='var-DATETIME'><filename>DATETIME</filename></link>. - Using <filename>IMAGE_VERSION_SUFFIX</filename> allows - easier and more direct changes.</para> - - <para>The <filename>IMAGE_VERSION_SUFFIX</filename> - variable is set in the - <filename>bitbake.conf</filename> configuration file as - follows: - <literallayout class='monospaced'> - IMAGE_VERSION_SUFFIX = "-${DATETIME}" - </literallayout> - </para></listitem> - <listitem><para> - Several variables have changed names for consistency: - <literallayout class='monospaced'> - Old Variable Name New Variable Name - ======================================================== - KERNEL_IMAGE_BASE_NAME <link linkend='var-KERNEL_IMAGE_NAME'>KERNEL_IMAGE_NAME</link> - KERNEL_IMAGE_SYMLINK_NAME <link linkend='var-KERNEL_IMAGE_LINK_NAME'>KERNEL_IMAGE_LINK_NAME</link> - MODULE_TARBALL_BASE_NAME <link linkend='var-MODULE_TARBALL_NAME'>MODULE_TARBALL_NAME</link> - MODULE_TARBALL_SYMLINK_NAME <link linkend='var-MODULE_TARBALL_LINK_NAME'>MODULE_TARBALL_LINK_NAME</link> - INITRAMFS_BASE_NAME <link linkend='var-INITRAMFS_NAME'>INITRAMFS_NAME</link> - </literallayout> - </para></listitem> - <listitem><para> - The <filename>MODULE_IMAGE_BASE_NAME</filename> variable - has been removed. - The module tarball name is now controlled directly with the - <link linkend='var-MODULE_TARBALL_NAME'><filename>MODULE_TARBALL_NAME</filename></link> - variable. - </para></listitem> - <listitem><para> - The - <link linkend='var-KERNEL_DTB_NAME'><filename>KERNEL_DTB_NAME</filename></link> - and - <link linkend='var-KERNEL_DTB_LINK_NAME'><filename>KERNEL_DTB_LINK_NAME</filename></link> - variables have been introduced to control kernel Device - Tree Binary (DTB) artifact names instead of mangling - <filename>KERNEL_IMAGE_*</filename> variables. - </para></listitem> - <listitem><para> - The - <link linkend='var-KERNEL_FIT_NAME'><filename>KERNEL_FIT_NAME</filename></link> - and - <link linkend='var-KERNEL_FIT_LINK_NAME'><filename>KERNEL_FIT_LINK_NAME</filename></link> - variables have been introduced to specify the name of - flattened image tree (FIT) kernel images similar to other - deployed artifacts. - </para></listitem> - <listitem><para> - The - <link linkend='var-MODULE_TARBALL_NAME'><filename>MODULE_TARBALL_NAME</filename></link> - and - <link linkend='var-MODULE_TARBALL_LINK_NAME'><filename>MODULE_TARBALL_LINK_NAME</filename></link> - variable values no longer include the "module-" prefix or - ".tgz" suffix. - These parts are now hardcoded so that the values are - consistent with other artifact naming variables. - </para></listitem> - <listitem><para> - Added the - <link linkend='var-INITRAMFS_LINK_NAME'><filename>INITRAMFS_LINK_NAME</filename></link> - variable so that the symlink can be controlled similarly - to other artifact types. - </para></listitem> - <listitem><para> - <link linkend='var-INITRAMFS_NAME'><filename>INITRAMFS_NAME</filename></link> - now uses - "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - instead of - "${PV}-${PR}-${MACHINE}-${DATETIME}", which - makes it consistent with other variables. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.6-serial-console-deprecated'> - <title><filename>SERIAL_CONSOLE</filename> Deprecated</title> - - <para> - The - <link linkend='var-SERIAL_CONSOLE'><filename>SERIAL_CONSOLE</filename></link> - variable has been functionally replaced by the - <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link> - variable for some time. - With the Yocto Project 2.6 release, - <filename>SERIAL_CONSOLE</filename> has been officially deprecated. - </para> - - <para> - <filename>SERIAL_CONSOLE</filename> will continue to work as - before for the 2.6 release. - However, for the sake of future compatibility, it is recommended - that you replace all instances of - <filename>SERIAL_CONSOLE</filename> with - <filename>SERIAL_CONSOLES</filename>. - <note> - The only difference in usage is that - <filename>SERIAL_CONSOLES</filename> expects entries to be - separated using semicolons as compared to - <filename>SERIAL_CONSOLE</filename>, which expects spaces. - </note> - </para> - </section> - - <section id='migration-2.6-poky-sets-unknown-configure-option-to-qa-error'> - <title>Configure Script Reports Unknown Options as Errors</title> - - <para> - If the configure script reports an unknown option, this now - triggers a QA error instead of a warning. - Any recipes that previously got away with specifying such unknown - options now need to be fixed. - </para> - </section> - - <section id='migration-2.6-override-changes'> - <title>Override Changes</title> - - <para> - The following changes have occurred: - <itemizedlist> - <listitem><para> - <emphasis>The <filename>virtclass-native</filename> and - <filename>virtclass-nativesdk</filename> Overrides Have - Been Removed:</emphasis> - The <filename>virtclass-native</filename> and - <filename>virtclass-nativesdk</filename> overrides have - been deprecated since 2012 in favor of - <filename>class-native</filename> and - <filename>class-nativesdk</filename>, respectively. - Both <filename>virtclass-native</filename> and - <filename>virtclass-nativesdk</filename> are now dropped. - <note> - The <filename>virtclass-multilib-</filename> overrides - for multilib are still valid. - </note> - </para></listitem> - <listitem><para> - <emphasis>The <filename>forcevariable</filename> - Override Now Has a Higher Priority Than - <filename>libc</filename> Overrides:</emphasis> - The <filename>forcevariable</filename> override is - documented to be the highest priority override. - However, due to a long-standing quirk of how - <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> - is set, the <filename>libc</filename> overrides (e.g. - <filename>libc-glibc</filename>, - <filename>libc-musl</filename>, and so forth) erroneously - had a higher priority. - This issue is now corrected.</para> - - <para>It is likely this change will not cause any - problems. - However, it is possible with some unusual configurations - that you might see a change in behavior if you were - relying on the previous behavior. - Be sure to check how you use - <filename>forcevariable</filename> and - <filename>libc-*</filename> overrides in your custom - layers and configuration files to ensure they make sense. - </para></listitem> - <listitem><para> - <emphasis>The <filename>build-${BUILD_OS}</filename> - Override Has Been Removed:</emphasis> - The <filename>build-${BUILD_OS}</filename>, which is - typically <filename>build-linux</filename>, override has - been removed because building on a host operating system - other than a recent version of Linux is neither supported - nor recommended. - Dropping the override avoids giving the impression that - other host operating systems might be supported. - </para></listitem> - <listitem><para> - The "_remove" operator now preserves whitespace. - Consequently, when specifying list items to remove, be - aware that leading and trailing whitespace resulting from - the removal is retained.</para> - - <para>See the - "<ulink url='&YOCTO_DOCS_BB_URL;#removing-override-style-syntax'>Removal (Override Style Syntax)</ulink>" - section in the BitBake User Manual for a detailed example. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.6-systemd-configuration-now-split-out-to-system-conf'> - <title><filename>systemd</filename> Configuration is Now Split Into <filename>systemd-conf</filename></title> - - <para> - The configuration for the <filename>systemd</filename> recipe - has been moved into a <filename>system-conf</filename> recipe. - Moving this configuration to a separate recipe avoids the - <filename>systemd</filename> recipe from becoming machine-specific - for cases where machine-specific configurations need to be applied - (e.g. for <filename>qemu*</filename> machines). - </para> - - <para> - Currently, the new recipe packages the following files: - <literallayout class='monospaced'> - ${sysconfdir}/machine-id - ${sysconfdir}/systemd/coredump.conf - ${sysconfdir}/systemd/journald.conf - ${sysconfdir}/systemd/logind.conf - ${sysconfdir}/systemd/system.conf - ${sysconfdir}/systemd/user.conf - </literallayout> - If you previously used bbappend files to append the - <filename>systemd</filename> recipe to change any of the - listed files, you must do so for the - <filename>systemd-conf</filename> recipe instead. - </para> - </section> - - <section id='migration-2.6-automatic-testing-changes'> - <title>Automatic Testing Changes</title> - - <para> - This section provides information about automatic testing - changes: - <itemizedlist> - <listitem><para> - <emphasis><filename>TEST_IMAGE</filename> Variable Removed:</emphasis> - Prior to this release, you set the - <filename>TEST_IMAGE</filename> variable to "1" to - enable automatic testing for successfully built images. - The <filename>TEST_IMAGE</filename> variable no longer - exists and has been replaced by the - <link linkend='var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></link> - variable. - </para></listitem> - <listitem><para> - <emphasis>Inheriting the <filename>testimage</filename> and - <filename>testsdk</filename> Classes:</emphasis> - Best practices now dictate that you use the - <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link> - variable rather than the - <link linkend='var-INHERIT'><filename>INHERIT</filename></link> - variable when you inherit the - <link linkend='ref-classes-testimage*'><filename>testimage</filename></link> - and - <link linkend='ref-classes-testsdk'><filename>testsdk</filename></link> - classes used for automatic testing. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='migration-2.6-openssl-changes'> - <title>OpenSSL Changes</title> - - <para> - <ulink url='https://www.openssl.org/'>OpenSSL</ulink> has been - upgraded from 1.0 to 1.1. - By default, this upgrade could cause problems for recipes that - have both versions in their dependency chains. - The problem is that both versions cannot be installed together - at build time. - <note> - It is possible to have both versions of the library at runtime. - </note> - </para> - </section> - - <section id='migration-2.6-bitbake-changes'> - <title>BitBake Changes</title> - - <para> - The server logfile <filename>bitbake-cookerdaemon.log</filename> is - now always placed in the - <link linkend='build-directory'>Build Directory</link> - instead of the current directory. - </para> - </section> - - <section id='migration-2.6-security-changes'> - <title>Security Changes</title> - - <para> - The Poky distribution now uses security compiler flags by - default. - Inclusion of these flags could cause new failures due to stricter - checking for various potential security issues in code. - </para> - </section> - - <section id='migration-2.6-post-installation-changes'> - <title>Post Installation Changes</title> - - <para> - You must explicitly mark post installs to defer to the target. - If you want to explicitly defer a postinstall to first boot on - the target rather than at rootfs creation time, use - <filename>pkg_postinst_ontarget()</filename> or call - <filename>postinst-intercepts defer_to_first_boot</filename> from - <filename>pkg_postinst()</filename>. - Any failure of a <filename>pkg_postinst()</filename> script - (including exit 1) triggers an error during the - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> task. - </para> - - <para> - For more information on post-installation behavior, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-post-installation-scripts'>Post-Installation Scripts</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='migration-2.6-python-3-profile-guided-optimizations'> - <title>Python 3 Profile-Guided Optimization</title> - - <para> - The <filename>python3</filename> recipe now enables profile-guided - optimization. - Using this optimization requires a little extra build time in - exchange for improved performance on the target at runtime. - Additionally, the optimization is only enabled if the current - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - has support for user-mode emulation in QEMU (i.e. "qemu-usermode" - is in - <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>, - which it is by default). - </para> - - <para> - If you wish to disable Python profile-guided optimization - regardless of the value of - <filename>MACHINE_FEATURES</filename>, then ensure that - <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> - for the <filename>python3</filename> recipe does not contain "pgo". - You could accomplish the latter using the following at the - configuration level: - <literallayout class='monospaced'> - PACKAGECONFIG_remove_pn-python3 = "pgo" - </literallayout> - Alternatively, you can set - <filename>PACKAGECONFIG</filename> using an append file for the - <filename>python3</filename> recipe. - </para> - </section> - - <section id='migration-2.6-miscellaneous-changes'> - <title>Miscellaneous Changes</title> - - <para> - The following miscellaneous changes occurred: - <itemizedlist> - <listitem><para> - Default to using the Thumb-2 instruction set for armv7a - and above. - If you have any custom recipes that build software that - needs to be built with the ARM instruction set, change the - recipe to set the instruction set as follows: - <literallayout class='monospaced'> - ARM_INSTRUCTION_SET = "arm" - </literallayout> - </para></listitem> - <listitem><para> - <filename>run-postinsts</filename> no longer uses - <filename>/etc/*-postinsts</filename> for - <filename>dpkg/opkg</filename> in favor of built-in - postinst support. - RPM behavior remains unchanged. - </para></listitem> - <listitem><para> - The <filename>NOISO</filename> and - <filename>NOHDD</filename> variables are no longer used. - You now control building <filename>*.iso</filename> and - <filename>*.hddimg</filename> image types directly - by using the - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - variable. - </para></listitem> - <listitem><para> - The <filename>scripts/contrib/mkefidisk.sh</filename> - has been removed in favor of Wic. - </para></listitem> - <listitem><para> - <filename>kernel-modules</filename> has been removed from - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> - for <filename>qemumips</filename> and - <filename>qemumips64</filename> machines. - Removal also impacts the <filename>x86-base.inc</filename> - file. - <note> - <filename>genericx86</filename> and - <filename>genericx86-64</filename> retain - <filename>kernel-modules</filename> as part of the - <filename>RRECOMMENDS</filename> variable setting. - </note> - </para></listitem> - <listitem><para> - The <filename>LGPLv2_WHITELIST_GPL-3.0</filename> - variable has been removed. - If you are setting this variable in your configuration, - set or append it to the - <filename>WHITELIST_GPL-3.0</filename> variable instead. - </para></listitem> - <listitem><para> - <filename>${ASNEEDED}</filename> is now included in - the - <link linkend='var-TARGET_LDFLAGS'><filename>TARGET_LDFLAGS</filename></link> - variable directly. - The remaining definitions from - <filename>meta/conf/distro/include/as-needed.inc</filename> - have been moved to corresponding recipes. - </para></listitem> - <listitem><para> - Support for DSA host keys has been dropped from the - OpenSSH recipes. - If you are still using DSA keys, you must switch over to a - more secure algorithm as recommended by OpenSSH upstream. - </para></listitem> - <listitem><para> - The <filename>dhcp</filename> recipe now uses the - <filename>dhcpd6.conf</filename> configuration file in - <filename>dhcpd6.service</filename> for IPv6 DHCP rather - than re-using <filename>dhcpd.conf</filename>, which is - now reserved for IPv4. - </para></listitem> - </itemizedlist> - </para> - </section> -</section> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst new file mode 100644 index 0000000000..53b1836e74 --- /dev/null +++ b/documentation/ref-manual/qa-checks.rst @@ -0,0 +1,827 @@ +.. 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:`ref-classes-insane`" + 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: + +- ``<packagename>: <path> is using libexec please relocate to <libexecdir> [libexec]`` + + The specified package contains files in ``/usr/libexec`` when the + distro configuration uses a different path for ``<libexecdir>`` By + default, ``<libexecdir>`` is ``$prefix/libexec``. However, this + default can be changed (e.g. ``${libdir}``). + + +.. _qa-check-rpaths: + +- ``package <packagename> contains bad RPATH <rpath> in file <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: + +- ``<packagename>: <file> contains probably-redundant RPATH <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: + +- ``<packagename> requires <files>, 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 :term:`RDEPENDS` should be + declared in the recipe to ensure the packages providing them are + built. + + +.. _qa-check-build-deps: + +- ``<packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps]`` + + There is a runtime dependency 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 :term:`RDEPENDS` for the dependency. + + +.. _qa-check-dev-so: + +- ``non -dev/-dbg/nativesdk- package contains symlink .so: <packagename> path '<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: <packagename> path '<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: + +- ``<packagename>: 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: <packagename> path <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 :term:`FILES`. + +.. _qa-check-empty-dirs: + +- ``<packagename> installs files in <path>, but it is expected to be empty [empty-dirs]`` + + The specified package is installing files into a directory that is + normally expected to be empty (such as ``/tmp``). These files may + be more appropriately installed to a different location, or + perhaps alternatively not installed at all, usually by updating the + :ref:`ref-tasks-install` task/function. + +.. _qa-check-arch: + +- ``Architecture did not match (<file_arch>, expected <machine_arch>) in <file> [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 (<file_bits>, expected <machine_bits>) in <file> [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 (<file_endianness>, expected <machine_endianness>) in <file> [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 '<file>' 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 + https://www.akkadia.org/drepper/textrelocs.html. + + +.. _qa-check-ldflags: + +- ``File '<file>' in package '<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 :term:`LDFLAGS` + variable is being passed to the linker command. A common workaround + for this situation is to pass in :term:`LDFLAGS` using + :term:`TARGET_CC_ARCH` within the recipe as + follows:: + + TARGET_CC_ARCH += "${LDFLAGS}" + + +.. _qa-check-xorg-driver-abi: + +- ``Package <packagename> contains Xorg driver (<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 <path> in <packagename> 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: + +- ``<file> failed sanity test (workdir) in path <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: + +- ``<file> failed sanity test (tmpdir) in path <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: + +- ``<packagename> rdepends on <debug_packagename> [debug-deps]`` + + There is a dependency 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: + +- ``<packagename> rdepends on <dev_packagename> [dev-deps]`` + + There is a dependency 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: + +- ``<var>:<packagename> is invalid: <comparison> (<value>) 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: + +- ``<recipename>: The compile log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [compile-host-path]`` + + 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: + +- ``<recipename>: The install log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [install-host-path]`` + + 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: + +- ``<packagename> 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 :term:`PACKAGES`, + change the package name appropriately. + + +.. _qa-check-unknown-configure-option: + +- ``<recipe>: configure was passed unrecognized options: <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 <recipefile> has PN of "<recipename>" 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 :term:`PN` value matches something already in :term:`OVERRIDES` + (e.g. :term:`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 :term:`PN` is being set explicitly, change the + :term:`PN` value) so that the conflict does not occur. See + :term:`FILES` for additional information. + + +.. _qa-check-pkgvarcheck: + +- ``<recipefile>: Variable <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 :term:`DEPENDS` instead. + + +.. _qa-check-already-stripped: + +- ``File '<file>' from <recipename> 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: + +- ``<packagename> 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 :term:`PACKAGES` that is + already in the variable's value. + + +.. _qa-check-files-invalid: + +- ``FILES variable for package <packagename> 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: + +- ``<recipename>: 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 :term:`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 :ref:`ref-tasks-install` task if the + files are not needed in any package. + + + +- ``<oldpackage>-<oldpkgversion> was registered as shlib provider for <library>, changing it to <newpackage>-<newpkgversion> because it was built later`` + + This message means that both ``<oldpackage>`` and ``<newpackage>`` + 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`` filename to + :term:`PRIVATE_LIBS` in the recipe that provides + the private version of the library. + + +.. _qa-check-unlisted-pkg-lics: + +- ``LICENSE:<packagename> includes licenses (<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: <packagename> path '<file>' [mime]`` + + The specified package contains mime type files (``.xml`` files in + ``${datadir}/mime/packages``) and yet does not inherit the + :ref:`ref-classes-mime` class which will ensure that these get + properly installed. Either add ``inherit mime`` to the recipe or remove the + files at the :ref:`ref-tasks-install` step if they are not needed. + + +.. _qa-check-mime-xdg: + +- ``package contains desktop file with key 'MimeType' but does not inhert mime-xdg: <packagename> path '<file>' [mime-xdg]`` + + The specified package contains a .desktop file with a 'MimeType' key + present, but does not inherit the :ref:`ref-classes-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 + :ref:`ref-tasks-install` step if they are not needed. + + +.. _qa-check-src-uri-bad: + +- ``<recipename>: 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 :term:`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 :term:`SRC_URI` value --- change it to ``${BPN}`` instead. + + +.. _qa-check-unhandled-features-check: + +- ``<recipename>: recipe doesn't inherit features_check [unhandled-features-check]`` + + This check ensures that if one of the variables that the + :ref:`ref-classes-features_check` class supports (e.g. + :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe + inherits :ref:`ref-classes-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: + +- ``<recipename>: recipe defines ALTERNATIVE:<packagename> 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:`ref-classes-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: + +- ``<packagename>: <file> 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: + +- ``<packagename> contains perllocal.pod (<files>), 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:`ref-classes-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: + +- ``<packagename> package is not obeying usrmerge distro feature. /<path> 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 :ref:`ref-tasks-install` step (or perhaps the build process that + :ref:`ref-tasks-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 output> [patch-fuzz]`` + + This check looks for evidence of "fuzz" when applying patches within the :ref:`ref-tasks-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 <recipe> + + 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 <recipe> <layer_path> + + 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 ``<build_dir>/workspace/sources/<recipe>/`` + + 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. + + +.. _qa-check-patch-status: + +- ``Missing Upstream-Status in patch <patchfile> Please add according to <url> [patch-status-core/patch-status-noncore]`` + + The ``Upstream-Status`` value is missing in the specified patch file's header. + This value is intended to track whether or not the patch has been sent + upstream, whether or not it has been merged, etc. + + There are two options for this same check - ``patch-status-core`` (for + recipes in OE-Core) and ``patch-status-noncore`` (for recipes in any other + layer). + + For more information, see the + ":ref:`contributor-guide/recipe-style-guide:patch upstream status`" + section in the Yocto Project and OpenEmbedded Contributor Guide. + +- ``Malformed Upstream-Status in patch <patchfile> Please correct according to <url> [patch-status-core/patch-status-noncore]`` + + The ``Upstream-Status`` value in the specified patch file's header is invalid - + it must be a specific format. See the "Missing Upstream-Status" entry above + for more information. + + +.. _qa-check-buildpaths: + +- ``File <filename> in package <packagename> contains reference to TMPDIR [buildpaths]`` + + This check ensures that build system paths (including :term:`TMPDIR`) do not + appear in output files, which not only leaks build system configuration into + the target, but also hinders binary reproducibility as the output will change + if the build system configuration changes. + + Typically these paths will enter the output through some mechanism in the + configuration or compilation of the software being built by the recipe. To + resolve this issue you will need to determine how the detected path is + entering the output. Sometimes it may require adjusting scripts or code to + use a relative path rather than an absolute one, or to pick up the path from + runtime configuration or environment variables. + +.. _qa-check-unimplemented-ptest: + +- ``<tool> tests detected [unimplemented-ptest]`` + + This check will detect if the source of the package contains some + upstream-provided tests and, if so, that ptests are implemented for this + recipe. See the ":ref:`dev-manual/packages:testing packages with ptest`" + section in the Yocto Project Development Tasks Manual. See also the + ":ref:`ref-classes-ptest`" section. + +.. _qa-check-virtual-slash: + +- ``<variable> is set to <value> but the substring 'virtual/' holds no meaning in this context. It only works for build time dependencies, not runtime ones. It is suggested to use 'VIRTUAL-RUNTIME_' variables instead.`` + + ``virtual/`` is a convention intended for use in the build context + (i.e. :term:`PROVIDES` and :term:`DEPENDS`) rather than the runtime + context (i.e. :term:`RPROVIDES` and :term:`RDEPENDS`). Use + :term:`VIRTUAL-RUNTIME` variables instead for the latter. + + +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:`ref-classes-insane`" section. + +.. note:: + + Please keep in mind that the QA checks are meant 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.xml b/documentation/ref-manual/ref-classes.xml deleted file mode 100644 index d602851c54..0000000000 --- a/documentation/ref-manual/ref-classes.xml +++ /dev/null @@ -1,3964 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-classes'> -<title>Classes</title> - -<para> - Class files are used to abstract common functionality and share it amongst - multiple recipe (<filename>.bb</filename>) files. - To use a class file, you simply make sure the recipe inherits the class. - In most cases, when a recipe inherits a class it is enough to enable its - features. - There are cases, however, where in the recipe you might need to set - variables or override some default behavior. -</para> - -<para> - Any <link linkend='metadata'>Metadata</link> usually - found in a recipe can also be placed in a class file. - Class files are identified by the extension <filename>.bbclass</filename> - and are usually placed in a <filename>classes/</filename> directory beneath - the <filename>meta*/</filename> directory found in the - <link linkend='source-directory'>Source Directory</link>. - Class files can also be pointed to by - <link linkend='var-BUILDDIR'><filename>BUILDDIR</filename></link> - (e.g. <filename>build/</filename>) in the same way as - <filename>.conf</filename> files in the <filename>conf</filename> directory. - Class files are searched for in - <link linkend='var-BBPATH'><filename>BBPATH</filename></link> - using the same method by which <filename>.conf</filename> files are - searched. -</para> - -<para> - This chapter discusses only the most useful and important classes. - Other classes do exist within the <filename>meta/classes</filename> - directory in the Source Directory. - You can reference the <filename>.bbclass</filename> files directly - for more information. -</para> - -<section id='ref-classes-allarch'> - <title><filename>allarch.bbclass</filename></title> - - <para> - The <filename>allarch</filename> class is inherited - by recipes that do not produce architecture-specific output. - The class disables functionality that is normally needed for recipes - that produce executable binaries (such as building the cross-compiler - and a C library as pre-requisites, and splitting out of debug symbols - during packaging). - <note> - <para>Unlike some distro recipes (e.g. Debian), OpenEmbedded recipes - that produce packages that depend on tunings through use of the - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> - and - <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link> - variables, should never be configured for all architectures - using <filename>allarch</filename>. - This is the case even if the recipes do not produce - architecture-specific output.</para> - <para>Configuring such recipes for all architectures causes the - <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_*</filename></link> - tasks to have different signatures for the machines with different - tunings. - Additionally, unnecessary rebuilds occur every time an - image for a different <filename>MACHINE</filename> is built - even when the recipe never changes.</para> - </note> - </para> - - <para> - By default, all recipes inherit the - <link linkend='ref-classes-base'><filename>base</filename></link> and - <link linkend='ref-classes-package'><filename>package</filename></link> - classes, which enable functionality - needed for recipes that produce executable output. - If your recipe, for example, only produces packages that contain - configuration files, media files, or scripts (e.g. Python and Perl), - then it should inherit the <filename>allarch</filename> class. - </para> -</section> - -<section id='ref-classes-archiver'> - <title><filename>archiver.bbclass</filename></title> - - <para> - The <filename>archiver</filename> class supports releasing - source code and other materials with the binaries. - </para> - - <para> - For more details on the source archiver, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" - section in the Yocto Project Development Tasks Manual. - You can also see the - <link linkend='var-ARCHIVER_MODE'><filename>ARCHIVER_MODE</filename></link> - variable for information about the variable flags (varflags) - that help control archive creation. - </para> -</section> - -<section id='ref-classes-autotools'> - <title><filename>autotools*.bbclass</filename></title> - - <para> - The <filename>autotools*</filename> classes support Autotooled - packages. - </para> - - <para> - The <filename>autoconf</filename>, <filename>automake</filename>, - and <filename>libtool</filename> packages bring standardization. - This class defines a set of tasks (e.g. - <filename>configure</filename>, <filename>compile</filename> and - so forth) that - work for all Autotooled packages. - It should usually be enough to define a few standard variables - and then simply <filename>inherit autotools</filename>. - These classes can also work with software that emulates Autotools. - For more information, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-autotooled-package'>Autotooled Package</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - - <para> - By default, the <filename>autotools*</filename> classes - use out-of-tree builds (i.e. - <filename>autotools.bbclass</filename> building with - <filename>B != S</filename>). - </para> - - <para> - If the software being built by a recipe does not support - using out-of-tree builds, you should have the recipe inherit the - <filename>autotools-brokensep</filename> class. - The <filename>autotools-brokensep</filename> class behaves the same - as the <filename>autotools</filename> class but builds with - <link linkend='var-B'><filename>B</filename></link> == - <link linkend='var-S'><filename>S</filename></link>. - This method is useful when out-of-tree build support is either not - present or is broken. - <note> - It is recommended that out-of-tree support be fixed and used - if at all possible. - </note> - </para> - - <para> - It's useful to have some idea of how the tasks defined by - the <filename>autotools*</filename> classes work and what they do - behind the scenes. - <itemizedlist> - <listitem><para><link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - - Regenerates the - configure script (using <filename>autoreconf</filename>) and - then launches it with a standard set of arguments used during - cross-compilation. - You can pass additional parameters to - <filename>configure</filename> through the - <filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></filename> - or - <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link> - variables. - </para></listitem> - <listitem><para><link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - - Runs <filename>make</filename> with arguments that specify the - compiler and linker. - You can pass additional arguments through - the <filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></filename> - variable. - </para></listitem> - <listitem><para><link linkend='ref-tasks-install'><filename>do_install</filename></link> - - Runs <filename>make install</filename> and passes in - <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> - as <filename>DESTDIR</filename>. - </para></listitem> - </itemizedlist> - </para> -</section> - -<section id='ref-classes-base'> - <title><filename>base.bbclass</filename></title> - - <para> - The <filename>base</filename> class is special in that every - <filename>.bb</filename> file implicitly inherits the class. - This class contains definitions for standard basic - tasks such as fetching, unpacking, configuring (empty by default), - compiling (runs any <filename>Makefile</filename> present), installing - (empty by default) and packaging (empty by default). - These classes are often overridden or extended by other classes - such as the - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> - class or the - <link linkend='ref-classes-package'><filename>package</filename></link> - class. - </para> - - <para> - The class also contains some commonly used functions such as - <filename>oe_runmake</filename>, which runs - <filename>make</filename> with the arguments specified in - <link linkend='var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></link> - variable as well as the arguments passed directly to - <filename>oe_runmake</filename>. - </para> -</section> - -<section id='ref-classes-bash-completion'> - <title><filename>bash-completion.bbclass</filename></title> - - <para> - Sets up packaging and dependencies appropriate for recipes that - build software that includes bash-completion data. - </para> -</section> - -<section id='ref-classes-bin-package'> - <title><filename>bin_package.bbclass</filename></title> - - <para> - The <filename>bin_package</filename> class is a - helper class for recipes that extract the contents of a binary package - (e.g. an RPM) and install those contents rather than building the - binary from source. - The binary package is extracted and new packages in the configured - output package format are created. - Extraction and installation of proprietary binaries is a good example - use for this class. - <note> - For RPMs and other packages that do not contain a subdirectory, - you should specify an appropriate fetcher parameter to point to - the subdirectory. - For example, if BitBake is using the Git fetcher - (<filename>git://</filename>), the "subpath" parameter limits - the checkout to a specific subpath of the tree. - Here is an example where <filename>${BP}</filename> is used so that - the files are extracted into the subdirectory expected by the - default value of - <link linkend='var-S'><filename>S</filename></link>: - <literallayout class='monospaced'> - SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}" - </literallayout> - See the - "<ulink url='&YOCTO_DOCS_BB_URL;#bb-fetchers'>Fetchers</ulink>" - section in the BitBake User Manual for more information on - supported BitBake Fetchers. - </note> - </para> -</section> - -<section id='ref-classes-binconfig'> - <title><filename>binconfig.bbclass</filename></title> - - <para> - The <filename>binconfig</filename> class helps to correct paths in - shell scripts. - </para> - - <para> - Before <filename>pkg-config</filename> had become widespread, libraries - shipped shell scripts to give information about the libraries and - include paths needed to build software (usually named - <filename>LIBNAME-config</filename>). - This class assists any recipe using such scripts. - </para> - - <para> - During staging, the OpenEmbedded build system installs such scripts - into the <filename>sysroots/</filename> directory. - Inheriting this class results in all paths in these scripts being - changed to point into the <filename>sysroots/</filename> directory so - that all builds that use the script use the correct directories - for the cross compiling layout. - See the - <link linkend='var-BINCONFIG_GLOB'><filename>BINCONFIG_GLOB</filename></link> - variable for more information. - </para> -</section> - -<section id='ref-classes-binconfig-disabled'> - <title><filename>binconfig-disabled.bbclass</filename></title> - - <para> - An alternative version of the - <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> - class, which disables binary configuration scripts by making them - return an error in favor of using <filename>pkg-config</filename> - to query the information. - The scripts to be disabled should be specified using the - <link linkend='var-BINCONFIG'><filename>BINCONFIG</filename></link> - variable within the recipe inheriting the class. - </para> -</section> - -<section id='ref-classes-blacklist'> - <title><filename>blacklist.bbclass</filename></title> - - <para> - The <filename>blacklist</filename> class prevents - the OpenEmbedded build system from building specific recipes - (blacklists them). - To use this class, inherit the class globally and set - <link linkend='var-PNBLACKLIST'><filename>PNBLACKLIST</filename></link> - for each recipe you wish to blacklist. - Specify the <link linkend='var-PN'><filename>PN</filename></link> - value as a variable flag (varflag) and provide a reason, which is - reported, if the package is requested to be built as the value. - For example, if you want to blacklist a recipe called "exoticware", - you add the following to your <filename>local.conf</filename> - or distribution configuration: - <literallayout class='monospaced'> - INHERIT += "blacklist" - PNBLACKLIST[exoticware] = "Not supported by our organization." - </literallayout> - </para> -</section> - -<section id='ref-classes-bluetooth'> - <title><filename>bluetooth.bbclass</filename></title> - - <para> - The <filename>bluetooth</filename> class defines a variable that - expands to the recipe (package) providing core - bluetooth support on the platform. - </para> - - <para> - For details on how the class works, see the - <filename>meta/classes/bluetooth.bbclass</filename> file in the Yocto - Project - <link linkend='source-directory'>Source Directory</link>. - </para> -</section> - -<section id='ref-classes-bugzilla'> - <title><filename>bugzilla.bbclass</filename></title> - - <para> - The <filename>bugzilla</filename> class supports setting up an - instance of Bugzilla in which you can automatically files bug reports - in response to build failures. - For this class to work, you need to enable the XML-RPC interface in - the instance of Bugzilla. - </para> -</section> - -<section id='ref-classes-buildhistory'> - <title><filename>buildhistory.bbclass</filename></title> - - <para> - The <filename>buildhistory</filename> class records a - history of build output metadata, which can be used to detect possible - regressions as well as used for analysis of the build output. - For more information on using Build History, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> -</section> - -<section id='ref-classes-buildstats'> - <title><filename>buildstats.bbclass</filename></title> - - <para> - The <filename>buildstats</filename> class records - performance statistics about each task executed during the build - (e.g. elapsed time, CPU usage, and I/O usage). - </para> - - <para> - When you use this class, the output goes into the - <link linkend='var-BUILDSTATS_BASE'><filename>BUILDSTATS_BASE</filename></link> - directory, which defaults to <filename>${TMPDIR}/buildstats/</filename>. - You can analyze the elapsed time using - <filename>scripts/pybootchartgui/pybootchartgui.py</filename>, which - produces a cascading chart of the entire build process and can be - useful for highlighting bottlenecks. - </para> - - <para> - Collecting build statistics is enabled by default through the - <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> - variable from your <filename>local.conf</filename> file. - Consequently, you do not have to do anything to enable the class. - However, if you want to disable the class, simply remove "buildstats" - from the <filename>USER_CLASSES</filename> list. - </para> -</section> - -<section id='ref-classes-buildstats-summary'> - <title><filename>buildstats-summary.bbclass</filename></title> - - <para> - When inherited globally, prints statistics at the end of the build - on sstate re-use. - In order to function, this class requires the - <link linkend='ref-classes-buildstats'><filename>buildstats</filename></link> - class be enabled. - </para> -</section> - -<section id='ref-classes-ccache'> - <title><filename>ccache.bbclass</filename></title> - - <para> - The <filename>ccache</filename> class enables the 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 <ulink url='http://ccache.samba.org/'></ulink> for information on - the C/C++ Compiler Cache. - </para> -</section> - -<section id='ref-classes-chrpath'> - <title><filename>chrpath.bbclass</filename></title> - - <para> - The <filename>chrpath</filename> class - is a wrapper around the "chrpath" utility, which is used during the - build process for <filename>nativesdk</filename>, - <filename>cross</filename>, and - <filename>cross-canadian</filename> recipes to change - <filename>RPATH</filename> records within binaries in order to make - them relocatable. - </para> -</section> - -<section id='ref-classes-clutter'> - <title><filename>clutter.bbclass</filename></title> - - <para> - The <filename>clutter</filename> class consolidates the - major and minor version naming and other common items used by Clutter - and related recipes. - <note> - Unlike some other classes related to specific libraries, recipes - building other software that uses Clutter do not need to - inherit this class unless they use the same recipe versioning - scheme that the Clutter and related recipes do. - </note> - </para> -</section> - -<section id='ref-classes-cmake'> - <title><filename>cmake.bbclass</filename></title> - - <para> - The <filename>cmake</filename> class allows for recipes that need to - build software using the - <ulink url='https://cmake.org/overview/'>CMake</ulink> build system. - You can use the - <link linkend='var-EXTRA_OECMAKE'><filename>EXTRA_OECMAKE</filename></link> - variable to specify additional configuration options to be passed - using the <filename>cmake</filename> command line. - </para> -</section> - -<section id='ref-classes-cml1'> - <title><filename>cml1.bbclass</filename></title> - - <para> - The <filename>cml1</filename> class provides basic support for the - Linux kernel style build configuration system. - </para> -</section> - -<section id='ref-classes-compress_doc'> - <title><filename>compress_doc.bbclass</filename></title> - - <para> - Enables compression for man pages and info pages. - This class is intended to be inherited globally. - The default compression mechanism is gz (gzip) but you can - select an alternative mechanism by setting the - <link linkend='var-DOC_COMPRESS'><filename>DOC_COMPRESS</filename></link> - variable. - </para> -</section> - -<section id='ref-classes-copyleft_compliance'> - <title><filename>copyleft_compliance.bbclass</filename></title> - - <para> - The <filename>copyleft_compliance</filename> class - preserves source code for the purposes of license compliance. - This class is an alternative to the <filename>archiver</filename> - class and is still used by some users even though it has been - deprecated in favor of the - <link linkend='ref-classes-archiver'><filename>archiver</filename></link> - class. - </para> -</section> - -<section id='ref-classes-copyleft_filter'> - <title><filename>copyleft_filter.bbclass</filename></title> - - <para> - A class used by the - <link linkend='ref-classes-archiver'><filename>archiver</filename></link> - and - <link linkend='ref-classes-copyleft_compliance'><filename>copyleft_compliance</filename></link> - classes for filtering licenses. - The <filename>copyleft_filter</filename> class is an internal class - and is not intended to be used directly. - </para> -</section> - -<section id='ref-classes-core-image'> - <title><filename>core-image.bbclass</filename></title> - - <para> - The <filename>core-image</filename> class - provides common definitions for the - <filename>core-image-*</filename> image recipes, such as support for - additional - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. - </para> -</section> - -<section id='ref-classes-cpan'> - <title><filename>cpan*.bbclass</filename></title> - - <para> - The <filename>cpan*</filename> classes support Perl modules. - </para> - - <para> - Recipes for Perl modules are simple. - These recipes usually only need to point to the source's archive and - then inherit the proper class file. - Building is split into two methods depending on which method the module - authors used. - <itemizedlist> - <listitem><para>Modules that use old - <filename>Makefile.PL</filename>-based build system require - <filename>cpan.bbclass</filename> in their recipes. - </para></listitem> - <listitem><para>Modules that use - <filename>Build.PL</filename>-based build system require - using <filename>cpan_build.bbclass</filename> in their recipes. - </para></listitem> - </itemizedlist> - Both build methods inherit the <filename>cpan-base</filename> class - for basic Perl support. - </para> -</section> - -<section id='ref-classes-cross'> - <title><filename>cross.bbclass</filename></title> - - <para> - The <filename>cross</filename> class provides support for the recipes - that build the cross-compilation tools. - </para> -</section> - -<section id='ref-classes-cross-canadian'> - <title><filename>cross-canadian.bbclass</filename></title> - - <para> - The <filename>cross-canadian</filename> class - provides support for the recipes that build the Canadian - Cross-compilation tools for SDKs. - See the - "<ulink url='&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual for more - discussion on these cross-compilation tools. - </para> -</section> - -<section id='ref-classes-crosssdk'> - <title><filename>crosssdk.bbclass</filename></title> - - <para> - The <filename>crosssdk</filename> class - provides support for the recipes that build the cross-compilation - tools used for building SDKs. - See the - "<ulink url='&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual for more - discussion on these cross-compilation tools. - </para> -</section> - -<section id='ref-classes-debian'> - <title><filename>debian.bbclass</filename></title> - - <para> - The <filename>debian</filename> class renames output packages so that - they follow the Debian naming policy (i.e. <filename>glibc</filename> - becomes <filename>libc6</filename> and <filename>glibc-devel</filename> - becomes <filename>libc6-dev</filename>.) - Renaming includes the library name and version as part of the package - name. - </para> - - <para> - If a recipe creates packages for multiple libraries - (shared object files of <filename>.so</filename> type), use the - <link linkend='var-LEAD_SONAME'><filename>LEAD_SONAME</filename></link> - variable in the recipe to specify the library on which to apply the - naming scheme. - </para> -</section> - -<section id='ref-classes-deploy'> - <title><filename>deploy.bbclass</filename></title> - - <para> - The <filename>deploy</filename> class handles deploying files - to the - <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> - directory. - The main function of this class is to allow the deploy step to be - accelerated by shared state. - Recipes that inherit this class should define their own - <link linkend='ref-tasks-deploy'><filename>do_deploy</filename></link> - function to copy the files to be deployed to - <link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link>, - and use <filename>addtask</filename> to add the task at the appropriate - place, which is usually after - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - or - <link linkend='ref-tasks-install'><filename>do_install</filename></link>. - The class then takes care of staging the files from - <filename>DEPLOYDIR</filename> to - <filename>DEPLOY_DIR_IMAGE</filename>. - </para> -</section> - -<section id='ref-classes-devshell'> - <title><filename>devshell.bbclass</filename></title> - - <para> - The <filename>devshell</filename> class adds the - <filename>do_devshell</filename> task. - Distribution policy dictates whether to include this class. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section - in the Yocto Project Development Tasks Manual for more information about - using <filename>devshell</filename>. - </para> -</section> - -<section id='ref-classes-devupstream'> - <title><filename>devupstream.bbclass</filename></title> - - <para> - The <filename>devupstream</filename> class uses - <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> - to add a variant of the recipe that fetches from an alternative URI - (e.g. Git) instead of a tarball. - Following is an example: - <literallayout class='monospaced'> - BBCLASSEXTEND = "devupstream:target" - SRC_URI_class-devupstream = "git://git.example.com/example" - SRCREV_class-devupstream = "abcd1234" - </literallayout> - Adding the above statements to your recipe creates a variant that has - <link linkend='var-DEFAULT_PREFERENCE'><filename>DEFAULT_PREFERENCE</filename></link> - 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 - <filename>class-devupstream</filename> override. - Here is an example: - <literallayout class='monospaced'> - DEPENDS_append_class-devupstream = " gperf-native" - - do_configure_prepend_class-devupstream() { - touch ${S}/README - } - </literallayout> - The class currently only supports creating a development variant of - the target recipe, not <filename>native</filename> or - <filename>nativesdk</filename> variants. - </para> - - <para> - The <filename>BBCLASSEXTEND</filename> syntax - (i.e. <filename>devupstream:target</filename>) provides support for - <filename>native</filename> and <filename>nativesdk</filename> - variants. - Consequently, this functionality can be added in a future release. - </para> - - <para> - Support for other version control systems such as Subversion is - limited due to BitBake's automatic fetch dependencies (e.g. - <filename>subversion-native</filename>). - </para> -</section> - -<section id='ref-classes-distro_features_check'> - <title><filename>distro_features_check.bbclass</filename></title> - - <para> - The <filename>distro_features_check</filename> class - allows individual recipes to check for required and conflicting - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. - </para> - - <para> - This class provides support for the - <link linkend='var-REQUIRED_DISTRO_FEATURES'><filename>REQUIRED_DISTRO_FEATURES</filename></link> - and - <link linkend='var-CONFLICT_DISTRO_FEATURES'><filename>CONFLICT_DISTRO_FEATURES</filename></link> - variables. - If any conditions specified in the recipe using the above variables are - not met, the recipe will be skipped. - </para> -</section> - -<section id='ref-classes-distrodata'> - <title><filename>distrodata.bbclass</filename></title> - - <para> - The <filename>distrodata</filename> class - provides for automatic checking for upstream recipe updates. - The class creates a comma-separated value (CSV) spreadsheet that - contains information about the recipes. - The information provides the - <link linkend='ref-tasks-distrodata'><filename>do_distrodata</filename></link> - and - <filename>do_distro_check</filename> tasks, which do upstream checking - and also verify if a package is used in multiple major distributions. - </para> - - <para> - The class is not included by default. - To use it, you must set the - <link linkend='var-INHERIT'><filename>INHERIT</filename></link> - variable: - <literallayout class='monospaced'> - INHERIT+= "distrodata" - </literallayout> - </para> - - <para> - The <filename>distrodata</filename> class also provides the - <link linkend='ref-tasks-checkpkg'><filename>do_checkpkg</filename></link> - task, which can be used against a simple recipe or against an - image to get all its recipe information. - </para> -</section> - -<section id='ref-classes-distutils'> - <title><filename>distutils*.bbclass</filename></title> - - <para> - The <filename>distutils*</filename> classes support recipes for Python - version 2.x extensions, which are simple. - These recipes usually only need to point to the source's archive and - then inherit the proper class. - Building is split into two methods depending on which method the - module authors used. - <itemizedlist> - <listitem><para>Extensions that use an Autotools-based build system - require Autotools and the classes based on - <filename>distutils</filename> in their recipes. - </para></listitem> - <listitem><para>Extensions that use build systems based on - <filename>distutils</filename> require - the <filename>distutils</filename> class in their recipes. - </para></listitem> - <listitem><para>Extensions that use build systems based on - <filename>setuptools</filename> require the - <link linkend='ref-classes-setuptools'><filename>setuptools</filename></link> - class in their recipes. - </para></listitem> - </itemizedlist> - The <filename>distutils-common-base</filename> class is required by - some of the <filename>distutils*</filename> classes to provide common - Python2 support. - </para> - - <para> - The <filename>distutils-tools</filename> class supports recipes for - additional "distutils" tools. - </para> -</section> - -<section id='ref-classes-distutils3'> - <title><filename>distutils3*.bbclass</filename></title> - - <para> - The <filename>distutils3*</filename> classes support recipes for Python - version 3.x extensions, which are simple. - These recipes usually only need to point to the source's archive and - then inherit the proper class. - Building is split into three methods depending on which method the - module authors used. - <itemizedlist> - <listitem><para>Extensions that use an Autotools-based build system - require Autotools and - <filename>distutils</filename>-based classes in their recipes. - </para></listitem> - <listitem><para>Extensions that use - <filename>distutils</filename>-based build systems require - the <filename>distutils</filename> class in their recipes. - </para></listitem> - <listitem><para>Extensions that use build systems based on - <filename>setuptools3</filename> require the - <link linkend='ref-classes-setuptools'><filename>setuptools3</filename></link> - class in their recipes. - </para></listitem> - </itemizedlist> - The <filename>distutils3*</filename> classes either inherit their - corresponding <filename>distutils*</filename> class or replicate them - using a Python3 version instead (e.g. - <filename>distutils3-base</filename> inherits - <filename>distutils-common-base</filename>, which is the same as - <filename>distutils-base</filename> but inherits - <filename>python3native</filename> instead of - <filename>pythonnative</filename>). - </para> -</section> - -<section id='ref-classes-externalsrc'> - <title><filename>externalsrc.bbclass</filename></title> - - <para> - The <filename>externalsrc</filename> class supports building software - from source code that is external to the OpenEmbedded build system. - Building software from an external source tree means that the build - system's normal fetch, unpack, and patch process is not used. - </para> - - <para> - By default, the OpenEmbedded build system uses the - <link linkend='var-S'><filename>S</filename></link> and - <link linkend='var-B'><filename>B</filename></link> variables to - locate unpacked recipe source code and to build it, respectively. - When your recipe inherits the <filename>externalsrc</filename> class, - you use the - <link linkend='var-EXTERNALSRC'><filename>EXTERNALSRC</filename></link> - and - <link linkend='var-EXTERNALSRC_BUILD'><filename>EXTERNALSRC_BUILD</filename></link> - variables to ultimately define <filename>S</filename> and - <filename>B</filename>. - </para> - - <para> - By default, this class expects the source code to support recipe builds - that use the <link linkend='var-B'><filename>B</filename></link> - variable to point to the directory in which the OpenEmbedded build - system places the generated objects built from the recipes. - By default, the <filename>B</filename> directory is set to the - following, which is separate from the source directory - (<filename>S</filename>): - <literallayout class='monospaced'> - ${WORKDIR}/${BPN}/{PV}/ - </literallayout> - See these variables for more information: - <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>, - <link linkend='var-BPN'><filename>BPN</filename></link>, and - <link linkend='var-PV'><filename>PV</filename></link>, - </para> - - <para> - For more information on the - <filename>externalsrc</filename> class, see the comments in - <filename>meta/classes/externalsrc.bbclass</filename> in the - <link linkend='source-directory'>Source Directory</link>. - For information on how to use the <filename>externalsrc</filename> - class, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> -</section> - -<section id='ref-classes-extrausers'> - <title><filename>extrausers.bbclass</filename></title> - - <para> - The <filename>extrausers</filename> class allows - additional user and group configuration to be applied at the image - level. - Inheriting this class either globally or from an image recipe allows - additional user and group operations to be performed using the - <link linkend='var-EXTRA_USERS_PARAMS'><filename>EXTRA_USERS_PARAMS</filename></link> - variable. - <note> - The user and group operations added using the - <filename>extrausers</filename> class are not tied to a specific - recipe outside of the recipe for the image. - Thus, the operations can be performed across the image as a whole. - Use the - <link linkend='ref-classes-useradd'><filename>useradd</filename></link> - class to add user and group configuration to a specific recipe. - </note> - Here is an example that uses this class in an image recipe: - <literallayout class='monospaced'> - inherit extrausers - EXTRA_USERS_PARAMS = "\ - useradd -p '' tester; \ - groupadd developers; \ - userdel nobody; \ - groupdel -g video; \ - groupmod -g 1020 developers; \ - usermod -s /bin/sh tester; \ - " - </literallayout> - Here is an example that adds two users named "tester-jim" and - "tester-sue" and assigns passwords: - <literallayout class='monospaced'> - inherit extrausers - EXTRA_USERS_PARAMS = "\ - useradd -P tester01 tester-jim; \ - useradd -P tester01 tester-sue; \ - " - </literallayout> - Finally, here is an example that sets the root password to - "1876*18": - <literallayout class='monospaced'> - inherit extrausers - EXTRA_USERS_PARAMS = "\ - usermod -P 1876*18 root; \ - " - </literallayout> - </para> -</section> - -<section id='ref-classes-fontcache'> - <title><filename>fontcache.bbclass</filename></title> - - <para> - The <filename>fontcache</filename> class generates the - proper post-install and post-remove (postinst and postrm) - scriptlets for font packages. - These scriptlets call <filename>fc-cache</filename> (part of - <filename>Fontconfig</filename>) to add the fonts to the font - information cache. - Since the cache files are architecture-specific, - <filename>fc-cache</filename> runs using QEMU if the postinst - scriptlets need to be run on the build host during image creation. - </para> - - <para> - If the fonts being installed are in packages other than the main - package, set - <link linkend='var-FONT_PACKAGES'><filename>FONT_PACKAGES</filename></link> - to specify the packages containing the fonts. - </para> -</section> - -<section id='ref-classes-fs-uuid'> - <title><filename>fs-uuid.bbclass</filename></title> - - <para> - The <filename>fs-uuid</filename> class extracts UUID from - <filename>${</filename><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link><filename>}</filename>, - which must have been built by the time that this function gets called. - The <filename>fs-uuid</filename> class only works on - <filename>ext</filename> file systems and depends on - <filename>tune2fs</filename>. - </para> -</section> - -<section id='ref-classes-gconf'> - <title><filename>gconf.bbclass</filename></title> - - <para> - The <filename>gconf</filename> class provides common - functionality for recipes that need to install GConf schemas. - The schemas will be put into a separate package - (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-gconf</filename>) - that is created automatically when this class is inherited. - This package uses the appropriate post-install and post-remove - (postinst/postrm) scriptlets to register and unregister the schemas - in the target image. - </para> -</section> - -<section id='ref-classes-gettext'> - <title><filename>gettext.bbclass</filename></title> - - <para> - The <filename>gettext</filename> class provides support for - building software that uses the GNU <filename>gettext</filename> - internationalization and localization system. - All recipes building software that use - <filename>gettext</filename> should inherit this class. - </para> -</section> - -<section id='ref-classes-gnome'> - <title><filename>gnome.bbclass</filename></title> - - <para> - The <filename>gnome</filename> class supports recipes that - build software from the GNOME stack. - This class inherits the - <link linkend='ref-classes-gnomebase'><filename>gnomebase</filename></link>, - <link linkend='ref-classes-gtk-icon-cache'><filename>gtk-icon-cache</filename></link>, - <link linkend='ref-classes-gconf'><filename>gconf</filename></link> and - <link linkend='ref-classes-mime'><filename>mime</filename></link> classes. - The class also disables GObject introspection where applicable. - </para> -</section> - -<section id='ref-classes-gnomebase'> - <title><filename>gnomebase.bbclass</filename></title> - - <para> - The <filename>gnomebase</filename> class is the base - class for recipes that build software from the GNOME stack. - This class sets - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> to - download the source from the GNOME mirrors as well as extending - <link linkend='var-FILES'><filename>FILES</filename></link> - with the typical GNOME installation paths. - </para> -</section> - -<section id='ref-classes-gobject-introspection'> - <title><filename>gobject-introspection.bbclass</filename></title> - - <para> - Provides support for recipes building software that - supports GObject introspection. - This functionality is only enabled if the - "gobject-introspection-data" feature is in - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - as well as "qemu-usermode" being in - <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>. - <note> - This functionality is backfilled by default and, - if not applicable, should be disabled through - <link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename></link> - or - <link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename></link>, - respectively. - </note> - </para> -</section> - -<section id='ref-classes-grub-efi'> - <title><filename>grub-efi.bbclass</filename></title> - - <para> - The <filename>grub-efi</filename> - class provides <filename>grub-efi</filename>-specific functions for - building bootable images. - </para> - - <para> - This class supports several variables: - <itemizedlist> - <listitem><para> - <link linkend='var-INITRD'><filename>INITRD</filename></link>: - Indicates list of filesystem images to concatenate and use - as an initial RAM disk (initrd) (optional). - </para></listitem> - <listitem><para> - <link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>: - Indicates a filesystem image to include as the root filesystem - (optional).</para></listitem> - <listitem><para> - <link linkend='var-GRUB_GFXSERIAL'><filename>GRUB_GFXSERIAL</filename></link>: - Set this to "1" to have graphics and serial in the boot menu. - </para></listitem> - <listitem><para> - <link linkend='var-LABELS'><filename>LABELS</filename></link>: - A list of targets for the automatic configuration. - </para></listitem> - <listitem><para> - <link linkend='var-APPEND'><filename>APPEND</filename></link>: - An override list of append strings for each - <filename>LABEL</filename>. - </para></listitem> - <listitem><para> - <link linkend='var-GRUB_OPTS'><filename>GRUB_OPTS</filename></link>: - Additional options to add to the configuration (optional). - Options are delimited using semi-colon characters - (<filename>;</filename>).</para></listitem> - <listitem><para> - <link linkend='var-GRUB_TIMEOUT'><filename>GRUB_TIMEOUT</filename></link>: - Timeout before executing the default <filename>LABEL</filename> - (optional). - </para></listitem> - </itemizedlist> - </para> -</section> - -<section id='ref-classes-gsettings'> - <title><filename>gsettings.bbclass</filename></title> - - <para> - The <filename>gsettings</filename> class - provides common functionality for recipes that need to install - GSettings (glib) schemas. - The schemas are assumed to be part of the main package. - Appropriate post-install and post-remove (postinst/postrm) - scriptlets are added to register and unregister the schemas in the - target image. - </para> -</section> - -<section id='ref-classes-gtk-doc'> - <title><filename>gtk-doc.bbclass</filename></title> - - <para> - The <filename>gtk-doc</filename> class - is a helper class to pull in the appropriate - <filename>gtk-doc</filename> dependencies and disable - <filename>gtk-doc</filename>. - </para> -</section> - -<section id='ref-classes-gtk-icon-cache'> - <title><filename>gtk-icon-cache.bbclass</filename></title> - - <para> - The <filename>gtk-icon-cache</filename> class - generates the proper post-install and post-remove (postinst/postrm) - scriptlets for packages that use GTK+ and install icons. - These scriptlets call <filename>gtk-update-icon-cache</filename> to add - the fonts to GTK+'s icon cache. - Since the cache files are architecture-specific, - <filename>gtk-update-icon-cache</filename> is run using QEMU if the - postinst scriptlets need to be run on the build host during image - creation. - </para> -</section> - -<section id='ref-classes-gtk-immodules-cache'> - <title><filename>gtk-immodules-cache.bbclass</filename></title> - - <para> - The <filename>gtk-immodules-cache</filename> class - generates the proper post-install and post-remove (postinst/postrm) - scriptlets for packages that install GTK+ input method modules for - virtual keyboards. - These scriptlets call <filename>gtk-update-icon-cache</filename> to add - the input method modules to the cache. - Since the cache files are architecture-specific, - <filename>gtk-update-icon-cache</filename> is run using QEMU if the - postinst scriptlets need to be run on the build host during image - creation. - </para> - - <para> - If the input method modules being installed are in packages other than - the main package, set - <link linkend='var-GTKIMMODULES_PACKAGES'><filename>GTKIMMODULES_PACKAGES</filename></link> - to specify the packages containing the modules. - </para> -</section> - -<section id='ref-classes-gzipnative'> - <title><filename>gzipnative.bbclass</filename></title> - - <para> - The <filename>gzipnative</filename> class enables the use of - different native versions of <filename>gzip</filename> - and <filename>pigz</filename> rather than the versions of these tools - from the build host. - </para> -</section> - -<section id='ref-classes-icecc'> - <title><filename>icecc.bbclass</filename></title> - - <para> - The <filename>icecc</filename> class supports - <ulink url='https://github.com/icecc/icecream'>Icecream</ulink>, which - facilitates taking compile jobs and distributing them among remote - machines. - </para> - - <para> - The class stages directories with symlinks from <filename>gcc</filename> - and <filename>g++</filename> to <filename>icecc</filename>, for both - native and cross compilers. - Depending on each configure or compile, the OpenEmbedded build system - adds the directories at the head of the <filename>PATH</filename> list - and then sets the <filename>ICECC_CXX</filename> and - <filename>ICEC_CC</filename> variables, which are the paths to the - <filename>g++</filename> and <filename>gcc</filename> compilers, - respectively. - </para> - - <para> - For the cross compiler, the class creates a <filename>tar.gz</filename> - file that contains the Yocto Project toolchain and sets - <filename>ICECC_VERSION</filename>, which is the version of the - cross-compiler used in the cross-development toolchain, accordingly. - </para> - - <para> - The class handles all three different compile stages - (i.e native ,cross-kernel and target) and creates the necessary - environment <filename>tar.gz</filename> file to be used by the remote - machines. - The class also supports SDK generation. - </para> - - <para> - If <link linkend='var-ICECC_PATH'><filename>ICECC_PATH</filename></link> - is not set in your <filename>local.conf</filename> file, then the - class tries to locate the <filename>icecc</filename> binary - using <filename>which</filename>. - - If - <link linkend='var-ICECC_ENV_EXEC'><filename>ICECC_ENV_EXEC</filename></link> - is set in your <filename>local.conf</filename> file, the variable should - point to the <filename>icecc-create-env</filename> script - provided by the user. - If you do not point to a user-provided script, the build system - uses the default script provided by the recipe - <filename>icecc-create-env-native.bb</filename>. - <note> - This script is a modified version and not the one that comes with - <filename>icecc</filename>. - </note> - </para> - - <para> - If you do not want the Icecream distributed compile support to apply - to specific recipes or classes, you can effectively "blacklist" them - by listing the recipes and classes using the - <link linkend='var-ICECC_USER_PACKAGE_BL'><filename>ICECC_USER_PACKAGE_BL</filename></link> - and - <link linkend='var-ICECC_USER_CLASS_BL'><filename>ICECC_USER_CLASS_BL</filename></link>, - variables, respectively, in your <filename>local.conf</filename> file. - Doing so causes the OpenEmbedded build system to handle these - compilations locally. - </para> - - <para> - Additionally, you can list recipes using the - <link linkend='var-ICECC_USER_PACKAGE_WL'><filename>ICECC_USER_PACKAGE_WL</filename></link> - variable in your <filename>local.conf</filename> file to force - <filename>icecc</filename> to be enabled for recipes using an empty - <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> - variable. - </para> - - <para> - Inheriting the <filename>icecc</filename> class changes all sstate - signatures. - Consequently, if a development team has a dedicated build system - that populates - <link linkend='var-SSTATE_MIRRORS'><filename>STATE_MIRRORS</filename></link> - and they want to reuse sstate from - <filename>STATE_MIRRORS</filename>, then all developers and the - build system need to either inherit the <filename>icecc</filename> - class or nobody should. - </para> - - <para> - At the distribution level, you can inherit the - <filename>icecc</filename> class to be sure that all builders start - with the same sstate signatures. - After inheriting the class, you can then disable the feature by setting - the - <link linkend='var-ICECC_DISABLED'><filename>ICECC_DISABLED</filename></link> - variable to "1" as follows: - <literallayout class='monospaced'> - INHERIT_DISTRO_append = " icecc" - ICECC_DISABLED ??= "1" - </literallayout> - This practice makes sure everyone is using the same signatures but also - requires individuals that do want to use Icecream to enable the feature - individually as follows in your <filename>local.conf</filename> file: - <literallayout class='monospaced'> - ICECC_DISABLED = "" - </literallayout> - </para> -</section> - -<section id='ref-classes-image'> - <title><filename>image.bbclass</filename></title> - - <para> - The <filename>image</filename> class helps support creating images - in different formats. - First, the root filesystem is created from packages using - one of the <filename>rootfs*.bbclass</filename> - files (depending on the package format used) and then one or more image - files are created. - <itemizedlist> - <listitem><para>The - <filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></filename> - variable controls the types of images to generate. - </para></listitem> - <listitem><para>The - <filename><link linkend='var-IMAGE_INSTALL'>IMAGE_INSTALL</link></filename> - variable controls the list of packages to install into the - image.</para></listitem> - </itemizedlist> - For information on customizing images, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>" - section in the Yocto Project Development Tasks Manual. - For information on how images are created, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#images-dev-environment'>Images</ulink>" - section in the Yocto Project Overview and Concpets Manual. - </para> -</section> - -<section id='ref-classes-image-buildinfo'> - <title><filename>image-buildinfo.bbclass</filename></title> - - <para> - The <filename>image-buildinfo</filename> class writes information - to the target filesystem on <filename>/etc/build</filename>. - </para> -</section> - -<section id='ref-classes-image_types'> - <title><filename>image_types.bbclass</filename></title> - - <para> - The <filename>image_types</filename> class defines all of the - standard image output types that you can enable through the - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - variable. - You can use this class as a reference on how to add support for - custom image output types. - </para> - - <para> - By default, the - <link linkend='ref-classes-image'><filename>image</filename></link> - class automatically enables the <filename>image_types</filename> class. - The <filename>image</filename> class uses the - <filename>IMGCLASSES</filename> variable as follows: - <literallayout class='monospaced'> - 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} - </literallayout> - </para> - - <para> - The <filename>image_types</filename> class also handles conversion and - compression of images. - <note> - To build a VMware VMDK image, you need to add "wic.vmdk" to - <filename>IMAGE_FSTYPES</filename>. - This would also be similar for Virtual Box Virtual Disk Image - ("vdi") and QEMU Copy On Write Version 2 ("qcow2") images. - </note> - </para> -</section> - -<section id='ref-classes-image-live'> - <title><filename>image-live.bbclass</filename></title> - - <para> - 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 - <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> - if - <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> - contains "efi". - </para> - - <para> - Normally, you do not use this class directly. - Instead, you add "live" to - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>. - </para> -</section> - -<section id='ref-classes-image-mklibs'> - <title><filename>image-mklibs.bbclass</filename></title> - - <para> - The <filename>image-mklibs</filename> class - enables the use of the <filename>mklibs</filename> utility during the - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> - task, which optimizes the size of - libraries contained in the image. - </para> - - <para> - By default, the class is enabled in the - <filename>local.conf.template</filename> using the - <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> - variable as follows: - <literallayout class='monospaced'> - USER_CLASSES ?= "buildstats image-mklibs image-prelink" - </literallayout> - </para> -</section> - -<section id='ref-classes-image-prelink'> - <title><filename>image-prelink.bbclass</filename></title> - - <para> - The <filename>image-prelink</filename> class - enables the use of the <filename>prelink</filename> utility during - the - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> - task, which optimizes the dynamic - linking of shared libraries to reduce executable startup time. - </para> - - <para> - By default, the class is enabled in the - <filename>local.conf.template</filename> using the - <link linkend='var-USER_CLASSES'><filename>USER_CLASSES</filename></link> - variable as follows: - <literallayout class='monospaced'> - USER_CLASSES ?= "buildstats image-mklibs image-prelink" - </literallayout> - </para> -</section> - -<section id='ref-classes-insane'> - <title><filename>insane.bbclass</filename></title> - - <para> - The <filename>insane</filename> class adds a step to the package - generation process so that output quality assurance checks are - generated by the OpenEmbedded build system. - A range of checks are performed that check the build's output - for common problems that show up during runtime. - Distribution policy usually dictates whether to include this class. - </para> - - <para> - You can configure the sanity checks so that specific test failures - either raise a warning or an error message. - Typically, failures for new tests generate a warning. - Subsequent failures for the same test would then generate an error - message once the metadata is in a known and good condition. - See the - "<link linkend='ref-qa-checks'>QA Error and Warning Messages</link>" - Chapter for a list of all the warning and error messages - you might encounter using a default configuration. - </para> - - <para> - Use the - <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and - <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link> - variables to control the behavior of - these checks at the global level (i.e. in your custom distro - configuration). - However, to skip one or more checks in recipes, you should use - <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>. - For example, to skip the check for symbolic link - <filename>.so</filename> files in the main package of a recipe, - add the following to the recipe. - You need to realize that the package name override, in this example - <filename>${PN}</filename>, must be used: - <literallayout class='monospaced'> - INSANE_SKIP_${PN} += "dev-so" - </literallayout> - Please keep in mind that the QA checks exist in order to detect real - or potential problems in the packaged output. - So exercise caution when disabling these checks. - </para> - - <para> - The following list shows the tests you can list with the - <filename>WARN_QA</filename> and <filename>ERROR_QA</filename> - variables: - <itemizedlist> - <listitem><para><emphasis><filename>already-stripped:</filename></emphasis> - Checks that produced binaries have not already been - stripped prior to the build system extracting debug symbols. - It is common for upstream software projects to default to - stripping debug symbols for output binaries. - In order for debugging to work on the target using - <filename>-dbg</filename> packages, this stripping must be - disabled. - </para></listitem> - <listitem><para><emphasis><filename>arch:</filename></emphasis> - Checks the Executable and Linkable Format (ELF) type, bit size, - and endianness of any binaries to ensure they match the target - architecture. - This test fails if any binaries do not match the type since - there would be an incompatibility. - The test could indicate that the - wrong compiler or compiler options have been used. - Sometimes software, like bootloaders, might need to bypass - this check. - </para></listitem> - <listitem><para><emphasis><filename>buildpaths:</filename></emphasis> - Checks for paths to locations on the build host inside the - output files. - Currently, this test triggers too many false positives and - thus is not normally enabled. - </para></listitem> - <listitem><para><emphasis><filename>build-deps:</filename></emphasis> - Determines if a build-time dependency that is specified through - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>, - explicit - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, - or task-level dependencies exists to match any runtime - dependency. - This determination is particularly useful to discover where - runtime dependencies are detected and added during packaging. - If no explicit dependency has been specified within the - metadata, at the packaging stage it is too late to ensure that - the dependency is built, and thus you can end up with an - error when the package is installed into the image during the - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> - task because the auto-detected dependency was not satisfied. - An example of this would be where the - <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> - class automatically adds a dependency on the - <filename>initscripts-functions</filename> package to packages - that install an initscript that refers to - <filename>/etc/init.d/functions</filename>. - The recipe should really have an explicit - <filename>RDEPENDS</filename> for the package in question on - <filename>initscripts-functions</filename> so that the - OpenEmbedded build system is able to ensure that the - <filename>initscripts</filename> recipe is actually built and - thus the <filename>initscripts-functions</filename> package is - made available. - </para></listitem> - <listitem><para><emphasis><filename>compile-host-path:</filename></emphasis> - Checks the - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - log for indications - that paths to locations on the build host were used. - Using such paths might result in host contamination of the - build output. - </para></listitem> - <listitem><para><emphasis><filename>debug-deps:</filename></emphasis> - Checks that all packages except <filename>-dbg</filename> - packages do not depend on <filename>-dbg</filename> - packages, which would cause a packaging bug. - </para></listitem> - <listitem><para><emphasis><filename>debug-files:</filename></emphasis> - Checks for <filename>.debug</filename> directories in anything but the - <filename>-dbg</filename> package. - The debug files should all be in the <filename>-dbg</filename> package. - Thus, anything packaged elsewhere is incorrect packaging.</para></listitem> - <listitem><para><emphasis><filename>dep-cmp:</filename></emphasis> - Checks for invalid version comparison statements in runtime - dependency relationships between packages (i.e. in - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, - <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, - <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, - <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, - and - <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link> - variable values). - Any invalid comparisons might trigger failures or undesirable - behavior when passed to the package manager. - </para></listitem> - <listitem><para><emphasis><filename>desktop:</filename></emphasis> - Runs the <filename>desktop-file-validate</filename> program - against any <filename>.desktop</filename> files to validate - their contents against the specification for - <filename>.desktop</filename> files.</para></listitem> - <listitem><para><emphasis><filename>dev-deps:</filename></emphasis> - Checks that all packages except <filename>-dev</filename> - or <filename>-staticdev</filename> packages do not depend on - <filename>-dev</filename> packages, which would be a - packaging bug.</para></listitem> - <listitem><para><emphasis><filename>dev-so:</filename></emphasis> - Checks that the <filename>.so</filename> symbolic links are in the - <filename>-dev</filename> package and not in any of the other packages. - In general, these symlinks are only useful for development purposes. - Thus, the <filename>-dev</filename> package is the correct location for - them. - Some very rare cases do exist for dynamically loaded modules where - these symlinks are needed instead in the main package. - </para></listitem> - <listitem><para><emphasis><filename>file-rdeps:</filename></emphasis> - Checks that file-level dependencies identified by the - OpenEmbedded build system at packaging time are satisfied. - For example, a shell script might start with the line - <filename>#!/bin/bash</filename>. - This line would translate to a file dependency on - <filename>/bin/bash</filename>. - Of the three package managers that the OpenEmbedded build - system supports, only RPM directly handles file-level - dependencies, resolving them automatically to packages - providing the files. - However, the lack of that functionality in the other two - package managers does not mean the dependencies do not still - need resolving. - This QA check attempts to ensure that explicitly declared - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> - exist to handle any file-level dependency detected in - packaged files. - </para></listitem> - <listitem><para><emphasis><filename>files-invalid:</filename></emphasis> - Checks for - <link linkend='var-FILES'><filename>FILES</filename></link> - variable values that contain "//", which is invalid. - </para></listitem> - <listitem><para id='insane-host-user-contaminated'> - <emphasis><filename>host-user-contaminated:</filename></emphasis> - Checks that no package produced by the recipe contains any - files outside of <filename>/home</filename> 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 - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task. - </para></listitem> - <listitem><para><emphasis><filename>incompatible-license:</filename></emphasis> - Report when packages are excluded from being created due to - being marked with a license that is in - <link linkend='var-INCOMPATIBLE_LICENSE'><filename>INCOMPATIBLE_LICENSE</filename></link>. - </para></listitem> - <listitem><para><emphasis><filename>install-host-path:</filename></emphasis> - Checks the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - log for indications - that paths to locations on the build host were used. - Using such paths might result in host contamination of the - build output. - </para></listitem> - <listitem><para><emphasis><filename>installed-vs-shipped:</filename></emphasis> - Reports when files have been installed within - <filename>do_install</filename> but have not been included in - any package by way of the - <link linkend='var-FILES'><filename>FILES</filename></link> - variable. - Files that do not appear in any package cannot be present in - an image later on in the build process. - Ideally, all installed files should be packaged or not - installed at all. - These files can be deleted at the end of - <filename>do_install</filename> if the files are not - needed in any package. - </para></listitem> - <listitem><para><emphasis><filename>invalid-chars:</filename></emphasis> - Checks that the recipe metadata variables - <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link>, - <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link>, - <link linkend='var-LICENSE'><filename>LICENSE</filename></link>, - and - <link linkend='var-SECTION'><filename>SECTION</filename></link> - do not contain non-UTF-8 characters. - Some package managers do not support such characters. - </para></listitem> - <listitem><para><emphasis><filename>invalid-packageconfig:</filename></emphasis> - Checks that no undefined features are being added to - <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link>. - For example, any name "foo" for which the following form - does not exist: - <literallayout class='monospaced'> - PACKAGECONFIG[foo] = "..." - </literallayout> - </para></listitem> - <listitem><para><emphasis><filename>la:</filename></emphasis> - Checks <filename>.la</filename> files for any <filename>TMPDIR</filename> - paths. - Any <filename>.la</filename> file containing these paths is incorrect since - <filename>libtool</filename> adds the correct sysroot prefix when using the - files automatically itself.</para></listitem> - <listitem><para><emphasis><filename>ldflags:</filename></emphasis> - Ensures that the binaries were linked with the - <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> - options provided by the build system. - If this test fails, check that the <filename>LDFLAGS</filename> variable - is being passed to the linker command.</para></listitem> - <listitem><para><emphasis><filename>libdir:</filename></emphasis> - Checks for libraries being installed into incorrect - (possibly hardcoded) installation paths. - For example, this test will catch recipes that install - <filename>/lib/bar.so</filename> when - <filename>${base_libdir}</filename> is "lib32". - Another example is when recipes install - <filename>/usr/lib64/foo.so</filename> when - <filename>${libdir}</filename> is "/usr/lib". - </para></listitem> - <listitem><para><emphasis><filename>libexec:</filename></emphasis> - Checks if a package contains files in - <filename>/usr/libexec</filename>. - This check is not performed if the - <filename>libexecdir</filename> variable has been set - explicitly to <filename>/usr/libexec</filename>. - </para></listitem> - <listitem><para><emphasis><filename>packages-list:</filename></emphasis> - Checks for the same package being listed multiple times through - the <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> - variable value. - Installing the package in this manner can cause errors during - packaging. - </para></listitem> - <listitem><para><emphasis><filename>perm-config:</filename></emphasis> - Reports lines in <filename>fs-perms.txt</filename> that have - an invalid format. - </para></listitem> - <listitem><para><emphasis><filename>perm-line:</filename></emphasis> - Reports lines in <filename>fs-perms.txt</filename> that have - an invalid format. - </para></listitem> - <listitem><para><emphasis><filename>perm-link:</filename></emphasis> - Reports lines in <filename>fs-perms.txt</filename> that - specify 'link' where the specified target already exists. - </para></listitem> - <listitem><para><emphasis><filename>perms:</filename></emphasis> - Currently, this check is unused but reserved. - </para></listitem> - <listitem><para><emphasis><filename>pkgconfig:</filename></emphasis> - Checks <filename>.pc</filename> files for any - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>/<link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> - paths. - Any <filename>.pc</filename> file containing these paths is incorrect - since <filename>pkg-config</filename> itself adds the correct sysroot prefix - when the files are accessed.</para></listitem> - <listitem><para><emphasis><filename>pkgname:</filename></emphasis> - Checks that all packages in - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> - have names that do not contain invalid characters (i.e. - characters other than 0-9, a-z, ., +, and -). - </para></listitem> - <listitem><para><emphasis><filename>pkgv-undefined:</filename></emphasis> - Checks to see if the <filename>PKGV</filename> variable - is undefined during - <link linkend='ref-tasks-package'><filename>do_package</filename></link>. - </para></listitem> - <listitem><para><emphasis><filename>pkgvarcheck:</filename></emphasis> - Checks through the variables - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, - <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, - <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>, - <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, - <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, - <link linkend='var-FILES'><filename>FILES</filename></link>, - <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>, - <filename>pkg_preinst</filename>, - <filename>pkg_postinst</filename>, - <filename>pkg_prerm</filename> - and <filename>pkg_postrm</filename>, and reports if there are - variable sets that are not package-specific. - Using these variables without a package suffix is bad practice, - and might unnecessarily complicate dependencies of other packages - within the same recipe or have other unintended consequences. - </para></listitem> - <listitem><para><emphasis><filename>pn-overrides:</filename></emphasis> - Checks that a recipe does not have a name - (<link linkend='var-PN'><filename>PN</filename></link>) value - that appears in - <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>. - If a recipe is named such that its <filename>PN</filename> - value matches something already in - <filename>OVERRIDES</filename> (e.g. <filename>PN</filename> - happens to be the same as - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - or - <link linkend='var-DISTRO'><filename>DISTRO</filename></link>), - it can have unexpected consequences. - For example, assignments such as - <filename>FILES_${PN} = "xyz"</filename> effectively turn into - <filename>FILES = "xyz"</filename>. - </para></listitem> - <listitem><para><emphasis><filename>rpaths:</filename></emphasis> - Checks for rpaths in the binaries that contain build system paths such - as <filename>TMPDIR</filename>. - If this test fails, bad <filename>-rpath</filename> options are being - passed to the linker commands and your binaries have potential security - issues.</para></listitem> - <listitem><para><emphasis><filename>split-strip:</filename></emphasis> - Reports that splitting or stripping debug symbols from binaries - has failed. - </para></listitem> - <listitem><para><emphasis><filename>staticdev:</filename></emphasis> - Checks for static library files (<filename>*.a</filename>) in - non-<filename>staticdev</filename> packages. - </para></listitem> - <listitem><para><emphasis><filename>symlink-to-sysroot:</filename></emphasis> - Checks for symlinks in packages that point into - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - on the host. - Such symlinks will work on the host, but are clearly invalid - when running on the target. - </para></listitem> - <listitem><para><emphasis><filename>textrel:</filename></emphasis> - Checks for ELF binaries that contain relocations in their - <filename>.text</filename> sections, which can result in a - performance impact at runtime. - See the explanation for the - <link linkend='qa-issue-textrel'><filename>ELF binary</filename></link> - message for more information regarding runtime performance issues. - </para></listitem> -<!-- -This check was removed for YP 2.3 release - - <listitem><para><emphasis><filename>unsafe-references-in-binaries:</filename></emphasis> - Reports when a binary installed in - <filename>${base_libdir}</filename>, - <filename>${base_bindir}</filename>, or - <filename>${base_sbindir}</filename>, depends on another - binary installed under <filename>${exec_prefix}</filename>. - This dependency is a concern if you want the system to remain - basically operable if <filename>/usr</filename> is mounted - separately and is not mounted. - <note> - Defaults for binaries installed in - <filename>${base_libdir}</filename>, - <filename>${base_bindir}</filename>, and - <filename>${base_sbindir}</filename> are - <filename>/lib</filename>, <filename>/bin</filename>, and - <filename>/sbin</filename>, respectively. - The default for a binary installed - under <filename>${exec_prefix}</filename> is - <filename>/usr</filename>. - </note> - </para></listitem> ---> - <listitem><para><emphasis><filename>useless-rpaths:</filename></emphasis> - Checks for dynamic library load paths (rpaths) in the binaries that - by default on a standard system are searched by the linker (e.g. - <filename>/lib</filename> and <filename>/usr/lib</filename>). - While these paths will not cause any breakage, they do waste space and - are unnecessary.</para></listitem> - <listitem><para><emphasis><filename>var-undefined:</filename></emphasis> - Reports when variables fundamental to packaging (i.e. - <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>, - <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>, - <link linkend='var-D'><filename>D</filename></link>, - <link linkend='var-PN'><filename>PN</filename></link>, and - <link linkend='var-PKGD'><filename>PKGD</filename></link>) are - undefined during - <link linkend='ref-tasks-package'><filename>do_package</filename></link>. - </para></listitem> - <listitem><para><emphasis><filename>version-going-backwards:</filename></emphasis> - If Build History is enabled, reports when a package - being written out has a lower version than the previously - written package under the same name. - If you are placing output packages into a feed and - upgrading packages on a target system using that feed, the - version of a package going backwards can result in the target - system not correctly upgrading to the "new" version of the - package. - <note> - If you are not using runtime package management on your - target system, then you do not need to worry about - this situation. - </note> - </para></listitem> - <listitem><para><emphasis><filename>xorg-driver-abi:</filename></emphasis> - Checks that all packages containing Xorg drivers have ABI - dependencies. - The <filename>xserver-xorg</filename> recipe provides driver - ABI names. - All drivers should depend on the ABI versions that they have - been built against. - Driver recipes that include - <filename>xorg-driver-input.inc</filename> - or <filename>xorg-driver-video.inc</filename> will - automatically get these versions. - Consequently, you should only need to explicitly add - dependencies to binary driver recipes. - </para></listitem> - </itemizedlist> - </para> -</section> - -<section id='ref-classes-insserv'> - <title><filename>insserv.bbclass</filename></title> - - <para> - The <filename>insserv</filename> class - uses the <filename>insserv</filename> utility to update the order of - symbolic links in <filename>/etc/rc?.d/</filename> within an image - based on dependencies specified by LSB headers in the - <filename>init.d</filename> scripts themselves. - </para> -</section> - -<section id='ref-classes-kernel'> - <title><filename>kernel.bbclass</filename></title> - - <para> - The <filename>kernel</filename> class handles building Linux kernels. - The class contains code to build all kernel trees. - All needed headers are staged into the - <filename><link linkend='var-STAGING_KERNEL_DIR'>STAGING_KERNEL_DIR</link></filename> - directory to allow out-of-tree module builds using - the - <link linkend='ref-classes-module'><filename>module</filename></link> - class. - </para> - - <para> - This means that each built kernel module is packaged separately and - inter-module dependencies are created by parsing the - <filename>modinfo</filename> output. - If all modules are required, then installing the - <filename>kernel-modules</filename> package installs all packages with - modules and various other kernel packages such as - <filename>kernel-vmlinux</filename>. - </para> - - <para> - The <filename>kernel</filename> 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 - "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - - <para> - Various other classes are used by the <filename>kernel</filename> - and <filename>module</filename> classes internally including the - <link linkend='ref-classes-kernel-arch'><filename>kernel-arch</filename></link>, - <link linkend='ref-classes-module-base'><filename>module-base</filename></link>, - and - <link linkend='ref-classes-linux-kernel-base'><filename>linux-kernel-base</filename></link> - classes. - </para> -</section> - -<section id='ref-classes-kernel-arch'> - <title><filename>kernel-arch.bbclass</filename></title> - - <para> - The <filename>kernel-arch</filename> class - sets the <filename>ARCH</filename> environment variable for Linux - kernel compilation (including modules). - </para> -</section> - -<section id='ref-classes-kernel-devicetree'> - <title><filename>kernel-devicetree.bbclass</filename></title> - - <para> - The <filename>kernel-devicetree</filename> class, which is inherited by - the - <link linkend='ref-classes-kernel'><filename>kernel</filename></link> - class, supports device tree generation. - </para> -</section> - -<section id='ref-classes-kernel-fitimage'> - <title><filename>kernel-fitimage.bbclass</filename></title> - - <para> - The <filename>kernel-fitimage</filename> class provides support to - pack zImages. - </para> -</section> - -<section id='ref-classes-kernel-grub'> - <title><filename>kernel-grub.bbclass</filename></title> - - <para> - The <filename>kernel-grub</filename> class updates the boot area and - the boot menu with the kernel as the priority boot mechanism while - installing a RPM to update the kernel on a deployed target. - </para> -</section> - -<section id='ref-classes-kernel-module-split'> - <title><filename>kernel-module-split.bbclass</filename></title> - - <para> - The <filename>kernel-module-split</filename> class - provides common functionality for splitting Linux kernel modules into - separate packages. - </para> -</section> - -<section id='ref-classes-kernel-uboot'> - <title><filename>kernel-uboot.bbclass</filename></title> - - <para> - The <filename>kernel-uboot</filename> class provides support for - building from vmlinux-style kernel sources. - </para> -</section> - -<section id='ref-classes-kernel-uimage'> - <title><filename>kernel-uimage.bbclass</filename></title> - - <para> - The <filename>kernel-uimage</filename> class provides support to - pack uImage. - </para> -</section> - -<section id='ref-classes-kernel-yocto'> - <title><filename>kernel-yocto.bbclass</filename></title> - - <para> - The <filename>kernel-yocto</filename> class - provides common functionality for building from linux-yocto style - kernel source repositories. - </para> -</section> - -<section id='ref-classes-kernelsrc'> - <title><filename>kernelsrc.bbclass</filename></title> - - <para> - The <filename>kernelsrc</filename> class sets the Linux kernel - source and version. - </para> -</section> - -<section id='ref-classes-lib_package'> - <title><filename>lib_package.bbclass</filename></title> - - <para> - The <filename>lib_package</filename> class - supports recipes that build libraries and produce executable - binaries, where those binaries should not be installed by default - along with the library. - Instead, the binaries are added to a separate - <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-bin</filename> - package to make their installation optional. - </para> -</section> - -<section id='ref-classes-libc*'> - <title><filename>libc*.bbclass</filename></title> - - <para> - The <filename>libc*</filename> classes support recipes that build - packages with <filename>libc</filename>: - <itemizedlist> - <listitem><para>The <filename>libc-common</filename> class - provides common support for building with - <filename>libc</filename>. - </para></listitem> - <listitem><para>The <filename>libc-package</filename> class - supports packaging up <filename>glibc</filename> and - <filename>eglibc</filename>. - </para></listitem> - </itemizedlist> - </para> -</section> - -<section id='ref-classes-license'> - <title><filename>license.bbclass</filename></title> - - <para> - The <filename>license</filename> class provides license - manifest creation and license exclusion. - This class is enabled by default using the default value for the - <link linkend='var-INHERIT_DISTRO'><filename>INHERIT_DISTRO</filename></link> - variable. - </para> -</section> - -<section id='ref-classes-linux-kernel-base'> - <title><filename>linux-kernel-base.bbclass</filename></title> - - <para> - The <filename>linux-kernel-base</filename> class - provides common functionality for recipes that build out of the Linux - kernel source tree. - These builds goes beyond the kernel itself. - For example, the Perf recipe also inherits this class. - </para> -</section> - -<section id='ref-classes-linuxloader'> - <title><filename>linuxloader.bbclass</filename></title> - - <para> - Provides the function <filename>linuxloader()</filename>, which gives - the value of the dynamic loader/linker provided on the platform. - This value is used by a number of other classes. - </para> -</section> - -<section id='ref-classes-logging'> - <title><filename>logging.bbclass</filename></title> - - <para> - The <filename>logging</filename> class provides the standard - shell functions used to log messages for various BitBake severity levels - (i.e. <filename>bbplain</filename>, <filename>bbnote</filename>, - <filename>bbwarn</filename>, <filename>bberror</filename>, - <filename>bbfatal</filename>, and <filename>bbdebug</filename>). - </para> - - <para> - This class is enabled by default since it is inherited by - the <filename>base</filename> class. - </para> -</section> - -<section id='ref-classes-meta'> - <title><filename>meta.bbclass</filename></title> - - <para> - The <filename>meta</filename> class is inherited by recipes - that do not build any output packages themselves, but act as a "meta" - target for building other recipes. - </para> -</section> - -<section id='ref-classes-metadata_scm'> - <title><filename>metadata_scm.bbclass</filename></title> - - <para> - The <filename>metadata_scm</filename> class provides functionality for - querying the branch and revision of a Source Code Manager (SCM) - repository. - </para> - - <para> - The <link linkend='ref-classes-base'><filename>base</filename></link> - class uses this class to print the revisions of each layer before - starting every build. - The <filename>metadata_scm</filename> class is enabled by default - because it is inherited by the <filename>base</filename> class. - </para> -</section> - -<section id='ref-classes-migrate_localcount'> - <title><filename>migrate_localcount.bbclass</filename></title> - - <para> - The <filename>migrate_localcount</filename> class verifies a recipe's - localcount data and increments it appropriately. - </para> -</section> - -<section id='ref-classes-mime'> - <title><filename>mime.bbclass</filename></title> - - <para> - The <filename>mime</filename> class generates the proper - post-install and post-remove (postinst/postrm) scriptlets for packages - that install MIME type files. - These scriptlets call <filename>update-mime-database</filename> to add - the MIME types to the shared database. - </para> -</section> - -<section id='ref-classes-mirrors'> - <title><filename>mirrors.bbclass</filename></title> - - <para> - The <filename>mirrors</filename> class sets up some standard - <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> entries - for source code mirrors. - These mirrors provide a fall-back path in case the upstream source - specified in - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - within recipes is unavailable. - </para> - - <para> - This class is enabled by default since it is inherited by the - <link linkend='ref-classes-base'><filename>base</filename></link> class. - </para> -</section> - -<section id='ref-classes-module'> - <title><filename>module.bbclass</filename></title> - - <para> - The <filename>module</filename> class provides support for building - out-of-tree Linux kernel modules. - The class inherits the - <link linkend='ref-classes-module-base'><filename>module-base</filename></link> - and - <link linkend='ref-classes-kernel-module-split'><filename>kernel-module-split</filename></link> - classes, and implements the - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - and - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - tasks. - The class provides everything needed to build and package a kernel - module. - </para> - - <para> - For general information on out-of-tree Linux kernel modules, see the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>" - section in the Yocto Project Linux Kernel Development Manual. - </para> -</section> - -<section id='ref-classes-module-base'> - <title><filename>module-base.bbclass</filename></title> - - <para> - The <filename>module-base</filename> class provides the base - functionality for building Linux kernel modules. - Typically, a recipe that builds software that includes one or - more kernel modules and has its own means of building - the module inherits this class as opposed to inheriting the - <link linkend='ref-classes-module'><filename>module</filename></link> - class. - </para> -</section> - -<section id='ref-classes-multilib*'> - <title><filename>multilib*.bbclass</filename></title> - - <para> - The <filename>multilib*</filename> classes provide support - for building libraries with different target optimizations or target - architectures and installing them side-by-side in the same image. - </para> - - <para> - For more information on using the Multilib feature, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Combining Multiple Versions of Library Files into One Image</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> -</section> - -<section id='ref-classes-native'> - <title><filename>native.bbclass</filename></title> - - <para> - The <filename>native</filename> class provides common - functionality for recipes that build tools to run on the - <link linkend='hardware-build-system-term'>build host</link> - (i.e. tools that use the compiler or other tools from the - build host). - </para> - - <para> - You can create a recipe that builds tools that run natively on the - host a couple different ways: - <itemizedlist> - <listitem><para> - Create a - <replaceable>myrecipe</replaceable><filename>-native.bb</filename> - recipe that inherits the <filename>native</filename> class. - If you use this method, you must order the inherit statement - in the recipe after all other inherit statements so that the - <filename>native</filename> class is inherited last. - <note><title>Warning</title> - When creating a recipe this way, the recipe name must - follow this naming convention: - <literallayout class='monospaced'> - <replaceable>myrecipe</replaceable>-native.bb - </literallayout> - Not using this naming convention can lead to subtle - problems caused by existing code that depends on that - naming convention. - </note> - </para></listitem> - <listitem><para> - Create or modify a target recipe that contains the following: - <literallayout class='monospaced'> - <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> = "native" - </literallayout> - Inside the recipe, use <filename>_class-native</filename> and - <filename>_class-target</filename> overrides to specify any - functionality specific to the respective native or target - case. - </para></listitem> - </itemizedlist> - </para> - - <para> - Although applied differently, the <filename>native</filename> class is - used with both methods. - The advantage of the second method is that you do not need to have two - separate recipes (assuming you need both) for native and target. - All common parts of the recipe are automatically shared. - </para> -</section> - -<section id='ref-classes-nativesdk'> - <title><filename>nativesdk.bbclass</filename></title> - - <para> - The <filename>nativesdk</filename> class provides common - functionality for recipes that wish to build tools to run as part of - an SDK (i.e. tools that run on - <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>). - </para> - - <para> - You can create a recipe that builds tools that run on the SDK machine - a couple different ways: - <itemizedlist> - <listitem><para>Create a - <filename>nativesdk-</filename><replaceable>myrecipe</replaceable><filename>.bb</filename> - recipe that inherits the <filename>nativesdk</filename> class. - If you use this method, you must order the inherit statement - in the recipe after all other inherit statements so that the - <filename>nativesdk</filename> class is inherited last. - </para></listitem> - <listitem><para>Create a <filename>nativesdk</filename> variant - of any recipe by adding the following: - <literallayout class='monospaced'> - <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> = "nativesdk" - </literallayout> - Inside the recipe, use <filename>_class-nativesdk</filename> and - <filename>_class-target</filename> overrides to specify any - functionality specific to the respective SDK machine or target - case.</para></listitem> - </itemizedlist> - <note><title>Warning</title> - When creating a recipe, you must follow this naming convention: - <literallayout class='monospaced'> - nativesdk-<replaceable>myrecipe</replaceable>.bb - </literallayout> - Not doing so can lead to subtle problems because code exists - that depends on the naming convention. - </note> - </para> - - <para> - Although applied differently, the <filename>nativesdk</filename> class - is used with both methods. - The advantage of the second method is that you do not need to have two - separate recipes (assuming you need both) for the SDK machine and the - target. - All common parts of the recipe are automatically shared. - </para> -</section> - -<section id='ref-classes-nopackages'> - <title><filename>nopackages.bbclass</filename></title> - - <para> - Disables packaging tasks for those recipes and classes where - packaging is not needed. - </para> -</section> - -<section id='ref-classes-npm'> - <title><filename>npm.bbclass</filename></title> - - <para> - Provides support for building Node.js software fetched using the npm - package manager. - <note> - Currently, recipes inheriting this class must use the - <filename>npm://</filename> fetcher to have dependencies fetched - and packaged automatically. - </note> - </para> -</section> - -<section id='ref-classes-oelint'> - <title><filename>oelint.bbclass</filename></title> - - <para> - The <filename>oelint</filename> class is an - obsolete lint checking tool that exists in - <filename>meta/classes</filename> in the - <link linkend='source-directory'>Source Directory</link>. - </para> - - <para> - A number of classes exist that could be generally useful in - OE-Core but are never actually used within OE-Core itself. - The <filename>oelint</filename> class is one such example. - However, being aware of this class can reduce the proliferation of - different versions of similar classes across multiple layers. - </para> -</section> - -<section id='ref-classes-own-mirrors'> - <title><filename>own-mirrors.bbclass</filename></title> - - <para> - The <filename>own-mirrors</filename> class makes it - easier to set up your own - <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> - from which to first fetch source before attempting to fetch it from the - upstream specified in - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - within each recipe. - </para> - - <para> - To use this class, inherit it globally and specify - <link linkend='var-SOURCE_MIRROR_URL'><filename>SOURCE_MIRROR_URL</filename></link>. - Here is an example: - <literallayout class='monospaced'> - INHERIT += "own-mirrors" - SOURCE_MIRROR_URL = "http://example.com/my-source-mirror" - </literallayout> - You can specify only a single URL in - <filename>SOURCE_MIRROR_URL</filename>. - </para> -</section> - -<section id='ref-classes-package'> - <title><filename>package.bbclass</filename></title> - - <para> - The <filename>package</filename> class supports generating - packages from a build's output. - The core generic functionality is in - <filename>package.bbclass</filename>. - The code specific to particular package types resides in these - package-specific classes: - <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>, - <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>, - <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>, - and - <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link>. - <note><title>Warning</title> - The <filename>package_tar</filename> class is broken and not - supported. - It is recommended that you do not use this class. - </note> - </para> - - <para> - You can control the list of resulting package formats by using the - <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> - variable defined in your <filename>conf/local.conf</filename> - configuration file, which is located in the - <link linkend='build-directory'>Build Directory</link>. - When defining the variable, you can specify one or more package types. - Since images are generated from packages, a packaging class is - needed to enable image generation. - The first class listed in this variable is used for image generation. - </para> - - <para> - If you take the optional step to set up a repository (package feed) - on the development host that can be used by 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 - "<ulink url='&YOCTO_DOCS_DEV_URL;#using-runtime-package-management'>Using Runtime Package Management</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - - <para> - The package-specific class you choose can affect build-time performance - and has space ramifications. - In general, building a package with IPK takes about thirty percent less - time as compared to using RPM to build the same or similar package. - This comparison takes into account a complete build of the package with - all dependencies previously built. - The reason for this discrepancy is because the RPM package manager - creates and processes more - <link linkend='metadata'>Metadata</link> than the - IPK package manager. - Consequently, you might consider setting - <filename>PACKAGE_CLASSES</filename> to "package_ipk" if you are - building smaller systems. - </para> - - <para> - Before making your package manager decision, however, you should - consider some further things about using RPM: - <itemizedlist> - <listitem><para> - RPM starts to provide more abilities than IPK due to - the fact that it processes more Metadata. - For example, this information includes individual file types, - file checksum generation and evaluation on install, sparse file - support, conflict detection and resolution for Multilib systems, - ACID style upgrade, and repackaging abilities for rollbacks. - </para></listitem> - <listitem><para> - For smaller systems, the extra space used for the Berkeley - Database and the amount of metadata when using RPM can affect - your ability to perform on-device upgrades. - </para></listitem> - </itemizedlist> - </para> - - <para> - You can find additional information on the effects of the package - class at these two Yocto Project mailing list links: - <itemizedlist> - <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006362.html'> - https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html</ulink></para></listitem> - <listitem><para><ulink url='&YOCTO_LISTS_URL;/pipermail/poky/2011-May/006363.html'> - https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html</ulink></para></listitem> - </itemizedlist> - </para> -</section> - -<section id='ref-classes-package_deb'> - <title><filename>package_deb.bbclass</filename></title> - - <para> - The <filename>package_deb</filename> class - provides support for creating packages that use the Debian - (i.e. <filename>.deb</filename>) file format. - The class ensures the packages are written out in a - <filename>.deb</filename> file format to the - <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename> - directory. - </para> - - <para> - This class inherits the - <link linkend='ref-classes-package'><filename>package</filename></link> - class and is enabled through the - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - variable in the <filename>local.conf</filename> file. - </para> -</section> - -<section id='ref-classes-package_ipk'> - <title><filename>package_ipk.bbclass</filename></title> - - <para> - The <filename>package_ipk</filename> class - provides support for creating packages that use the IPK - (i.e. <filename>.ipk</filename>) file format. - The class ensures the packages are written out in a - <filename>.ipk</filename> file format to the - <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename> - directory. - </para> - - <para> - This class inherits the - <link linkend='ref-classes-package'><filename>package</filename></link> - class and is enabled through the - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - variable in the <filename>local.conf</filename> file. - </para> -</section> - -<section id='ref-classes-package_rpm'> - <title><filename>package_rpm.bbclass</filename></title> - - <para> - The <filename>package_rpm</filename> class - provides support for creating packages that use the RPM - (i.e. <filename>.rpm</filename>) file format. - The class ensures the packages are written out in a - <filename>.rpm</filename> file format to the - <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename> - directory. - </para> - - <para> - This class inherits the - <link linkend='ref-classes-package'><filename>package</filename></link> - class and is enabled through the - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - variable in the <filename>local.conf</filename> file. - </para> -</section> - -<section id='ref-classes-package_tar'> - <title><filename>package_tar.bbclass</filename></title> - - <para> - The <filename>package_tar</filename> class - provides support for creating tarballs. - The class ensures the packages are written out in a - tarball format to the - <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename> - directory. - </para> - - <para> - This class inherits the - <link linkend='ref-classes-package'><filename>package</filename></link> - class and is enabled through the - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - variable in the <filename>local.conf</filename> file. - <note> - You cannot specify the <filename>package_tar</filename> class - first using the <filename>PACKAGE_CLASSES</filename> variable. - You must use <filename>.deb</filename>, - <filename>.ipk</filename>, or <filename>.rpm</filename> file - formats for your image or SDK. - </note> - </para> -</section> - -<section id='ref-classes-packagedata'> - <title><filename>packagedata.bbclass</filename></title> - - <para> - The <filename>packagedata</filename> class provides - common functionality for reading <filename>pkgdata</filename> files - found in - <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link>. - These files contain information about each output package produced by - the OpenEmbedded build system. - </para> - - <para> - This class is enabled by default because it is inherited by the - <link linkend='ref-classes-package'><filename>package</filename></link> - class. - </para> -</section> - -<section id='ref-classes-packagegroup'> - <title><filename>packagegroup.bbclass</filename></title> - - <para> - The <filename>packagegroup</filename> class sets default values - appropriate for package group recipes (e.g. - <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename>, - <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>, - <filename><link linkend='var-ALLOW_EMPTY'>ALLOW_EMPTY</link></filename>, - and so forth). - It is highly recommended that all package group recipes inherit this class. - </para> - - <para> - For information on how to use this class, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-customtasks'>Customizing Images Using Custom Package Groups</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - - <para> - Previously, this class was called the <filename>task</filename> class. - </para> -</section> - -<section id='ref-classes-patch'> - <title><filename>patch.bbclass</filename></title> - - <para> - The <filename>patch</filename> class provides all functionality for - applying patches during the - <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> - task. - </para> - - <para> - This class is enabled by default because it is inherited by the - <link linkend='ref-classes-base'><filename>base</filename></link> - class. - </para> -</section> - -<section id='ref-classes-perlnative'> - <title><filename>perlnative.bbclass</filename></title> - - <para> - When inherited by a recipe, the <filename>perlnative</filename> class - supports using the native version of Perl built by the build system - rather than using the version provided by the build host. - </para> -</section> - -<section id='ref-classes-pixbufcache'> - <title><filename>pixbufcache.bbclass</filename></title> - - <para> - The <filename>pixbufcache</filename> class generates the proper - post-install and post-remove (postinst/postrm) scriptlets for packages - that install pixbuf loaders, which are used with - <filename>gdk-pixbuf</filename>. - These scriptlets call <filename>update_pixbuf_cache</filename> - to add the pixbuf loaders to the cache. - Since the cache files are architecture-specific, - <filename>update_pixbuf_cache</filename> is run using QEMU if the - postinst scriptlets need to be run on the build host during image - creation. - </para> - - <para> - If the pixbuf loaders being installed are in packages other - than the recipe's main package, set - <link linkend='var-PIXBUF_PACKAGES'><filename>PIXBUF_PACKAGES</filename></link> - to specify the packages containing the loaders. - </para> -</section> - -<section id='ref-classes-pkgconfig'> - <title><filename>pkgconfig.bbclass</filename></title> - - <para> - The <filename>pkgconfig</filename> class provides a standard way to get - header and library information by using <filename>pkg-config</filename>. - This class aims to smooth integration of - <filename>pkg-config</filename> into libraries that use it. - </para> - - <para> - During staging, BitBake installs <filename>pkg-config</filename> - data into the <filename>sysroots/</filename> directory. - By making use of sysroot functionality within - <filename>pkg-config</filename>, the <filename>pkgconfig</filename> - class no longer has to manipulate the files. - </para> -</section> - -<section id='ref-classes-populate-sdk'> - <title><filename>populate_sdk.bbclass</filename></title> - - <para> - The <filename>populate_sdk</filename> class provides support for - SDK-only recipes. - For information on advantages gained when building a cross-development - toolchain using the - <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> - task, see the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - </para> -</section> - -<section id='ref-classes-populate-sdk-*'> - <title><filename>populate_sdk_*.bbclass</filename></title> - - <para> - The <filename>populate_sdk_*</filename> classes support SDK creation - and consist of the following classes: - <itemizedlist> - <listitem><para><emphasis><filename>populate_sdk_base</filename>:</emphasis> - The base class supporting SDK creation under all package - managers (i.e. DEB, RPM, and opkg).</para></listitem> - <listitem><para><emphasis><filename>populate_sdk_deb</filename>:</emphasis> - Supports creation of the SDK given the Debian package manager. - </para></listitem> - <listitem><para><emphasis><filename>populate_sdk_rpm</filename>:</emphasis> - Supports creation of the SDK given the RPM package manager. - </para></listitem> - <listitem><para><emphasis><filename>populate_sdk_ipk</filename>:</emphasis> - Supports creation of the SDK given the opkg (IPK format) - package manager. - </para></listitem> - <listitem><para><emphasis><filename>populate_sdk_ext</filename>:</emphasis> - Supports extensible SDK creation under all package managers. - </para></listitem> - </itemizedlist> - </para> - - <para> - The <filename>populate_sdk_base</filename> class inherits the - appropriate <filename>populate_sdk_*</filename> (i.e. - <filename>deb</filename>, <filename>rpm</filename>, and - <filename>ipk</filename>) based on - <link linkend='var-IMAGE_PKGTYPE'><filename>IMAGE_PKGTYPE</filename></link>. - </para> - - <para> - The base class ensures all source and destination directories are - established and then populates the SDK. - After populating the SDK, the <filename>populate_sdk_base</filename> - class constructs two sysroots: - <filename>${</filename><link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link><filename>}-nativesdk</filename>, - which contains the cross-compiler and associated tooling, and the - target, which contains a target root filesystem that is configured for - the SDK usage. - These two images reside in - <link linkend='var-SDK_OUTPUT'><filename>SDK_OUTPUT</filename></link>, - which consists of the following: - <literallayout class='monospaced'> - ${SDK_OUTPUT}/${SDK_ARCH}<replaceable>-nativesdk-pkgs</replaceable> - ${SDK_OUTPUT}/${SDKTARGETSYSROOT}/<replaceable>target-pkgs</replaceable> - </literallayout> - </para> - - <para> - Finally, the base populate SDK class creates the toolchain - environment setup script, the tarball of the SDK, and the installer. - </para> - - <para> - The respective <filename>populate_sdk_deb</filename>, - <filename>populate_sdk_rpm</filename>, and - <filename>populate_sdk_ipk</filename> classes each support the - specific type of SDK. - These classes are inherited by and used with the - <filename>populate_sdk_base</filename> class. - </para> - - <para> - For more information on the cross-development toolchain - generation, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual. - For information on advantages gained when building a - cross-development toolchain using the - <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> - task, see the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - </para> -</section> - -<section id='ref-classes-prexport'> - <title><filename>prexport.bbclass</filename></title> - - <para> - The <filename>prexport</filename> class provides functionality for - exporting - <link linkend='var-PR'><filename>PR</filename></link> values. - <note> - This class is not intended to be used directly. - Rather, it is enabled when using - "<filename>bitbake-prserv-tool export</filename>". - </note> - </para> -</section> - -<section id='ref-classes-primport'> - <title><filename>primport.bbclass</filename></title> - - <para> - The <filename>primport</filename> class provides functionality for - importing - <link linkend='var-PR'><filename>PR</filename></link> values. - <note> - This class is not intended to be used directly. - Rather, it is enabled when using - "<filename>bitbake-prserv-tool import</filename>". - </note> - </para> -</section> - -<section id='ref-classes-prserv'> - <title><filename>prserv.bbclass</filename></title> - - <para> - The <filename>prserv</filename> class provides functionality for - using a - <ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>PR service</ulink> - in order to automatically manage the incrementing of the - <link linkend='var-PR'><filename>PR</filename></link> variable for - each recipe. - </para> - - <para> - This class is enabled by default because it is inherited by the - <link linkend='ref-classes-package'><filename>package</filename></link> - class. - However, the OpenEmbedded build system will not enable the - functionality of this class unless - <link linkend='var-PRSERV_HOST'><filename>PRSERV_HOST</filename></link> - has been set. - </para> -</section> - -<section id='ref-classes-ptest'> - <title><filename>ptest.bbclass</filename></title> - - <para> - The <filename>ptest</filename> class provides functionality for - packaging and installing runtime tests for recipes that build software - that provides these tests. - </para> - - <para> - This class is intended to be inherited by individual recipes. - However, the class' functionality is largely disabled unless "ptest" - appears in - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" - section in the Yocto Project Development Tasks Manual for more - information on ptest. - </para> -</section> - -<section id='ref-classes-ptest-gnome'> - <title><filename>ptest-gnome.bbclass</filename></title> - - <para> - Enables package tests (ptests) specifically for GNOME packages, - which have tests intended to be executed with - <filename>gnome-desktop-testing</filename>. - </para> - - <para> - For information on setting up and running ptests, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> -</section> - -<section id='ref-classes-python-dir'> - <title><filename>python-dir.bbclass</filename></title> - - <para> - The <filename>python-dir</filename> class provides the base version, - location, and site package location for Python. - </para> -</section> - -<section id='ref-classes-python3native'> - <title><filename>python3native.bbclass</filename></title> - - <para> - The <filename>python3native</filename> class supports using the - native version of Python 3 built by the build system rather than - support of the version provided by the build host. - </para> -</section> - -<section id='ref-classes-pythonnative'> - <title><filename>pythonnative.bbclass</filename></title> - - <para> - When inherited by a recipe, the <filename>pythonnative</filename> class - supports using the native version of Python built by the build system - rather than using the version provided by the build host. - </para> -</section> - -<section id='ref-classes-qemu'> - <title><filename>qemu.bbclass</filename></title> - - <para> - The <filename>qemu</filename> class provides functionality for recipes - that either need QEMU or test for the existence of QEMU. - Typically, this class is used to run programs for a target system on - the build host using QEMU's application emulation mode. - </para> -</section> - -<section id='ref-classes-recipe_sanity'> - <title><filename>recipe_sanity.bbclass</filename></title> - - <para> - The <filename>recipe_sanity</filename> class checks for the presence - of any host system recipe prerequisites that might affect the - build (e.g. variables that are set or software that is present). - </para> -</section> - -<section id='ref-classes-relocatable'> - <title><filename>relocatable.bbclass</filename></title> - - <para> - The <filename>relocatable</filename> class enables relocation of - binaries when they are installed into the sysroot. - </para> - - <para> - This class makes use of the - <link linkend='ref-classes-chrpath'><filename>chrpath</filename></link> - class and is used by both the - <link linkend='ref-classes-cross'><filename>cross</filename></link> - and - <link linkend='ref-classes-native'><filename>native</filename></link> - classes. - </para> -</section> - -<section id='ref-classes-remove-libtool'> - <title><filename>remove-libtool.bbclass</filename></title> - - <para> - The <filename>remove-libtool</filename> class adds a post function - to the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task to remove all <filename>.la</filename> files installed by - <filename>libtool</filename>. - Removing these files results in them being absent from both the - sysroot and target packages. - </para> - - <para> - If a recipe needs the <filename>.la</filename> files to be installed, - then the recipe can override the removal by setting - <filename>REMOVE_LIBTOOL_LA</filename> to "0" as follows: - <literallayout class='monospaced'> - REMOVE_LIBTOOL_LA = "0" - </literallayout> - <note> - The <filename>remove-libtool</filename> class is not enabled by - default. - </note> - </para> -</section> - -<section id='ref-classes-report-error'> - <title><filename>report-error.bbclass</filename></title> - - <para> - The <filename>report-error</filename> class supports enabling the - <ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>error reporting tool</ulink>, - which allows you to submit build error information to a central - database. - </para> - - <para> - The class collects debug information for recipe, recipe version, task, - machine, distro, build system, target system, host distro, branch, - commit, and log. - From the information, report files using a JSON format are created and - stored in - <filename>${</filename><link linkend='var-LOG_DIR'><filename>LOG_DIR</filename></link><filename>}/error-report</filename>. - </para> -</section> - -<section id='ref-classes-rm-work'> - <title><filename>rm_work.bbclass</filename></title> - - <para> - The <filename>rm_work</filename> class supports deletion of temporary - workspace, which can ease your hard drive demands during builds. - </para> - - <para> - The OpenEmbedded build system can use a substantial amount of disk - space during the build process. - A portion of this space is the work files under the - <filename>${TMPDIR}/work</filename> directory for each recipe. - Once the build system generates the packages for a recipe, the work - files for that recipe are no longer needed. - However, by default, the build system preserves these files - for inspection and possible debugging purposes. - If you would rather have these files deleted to save disk space - as the build progresses, you can enable <filename>rm_work</filename> - by adding the following to your <filename>local.conf</filename> file, - which is found in the - <link linkend='build-directory'>Build Directory</link>. - <literallayout class='monospaced'> - INHERIT += "rm_work" - </literallayout> - If you are modifying and building source code out of the work directory - for a recipe, enabling <filename>rm_work</filename> will potentially - result in your changes to the source being lost. - To exclude some recipes from having their work directories deleted by - <filename>rm_work</filename>, you can add the names of the recipe or - recipes you are working on to the <filename>RM_WORK_EXCLUDE</filename> - variable, which can also be set in your <filename>local.conf</filename> - file. - Here is an example: - <literallayout class='monospaced'> - RM_WORK_EXCLUDE += "busybox glibc" - </literallayout> - </para> -</section> - -<section id='ref-classes-rootfs*'> - <title><filename>rootfs*.bbclass</filename></title> - - <para> - The <filename>rootfs*</filename> classes support creating - the root filesystem for an image and consist of the following classes: - <itemizedlist> - <listitem><para> - The <filename>rootfs-postcommands</filename> class, which - defines filesystem post-processing functions for image recipes. - </para></listitem> - <listitem><para> - The <filename>rootfs_deb</filename> class, which supports - creation of root filesystems for images built using - <filename>.deb</filename> packages.</para></listitem> - <listitem><para> - The <filename>rootfs_rpm</filename> class, which supports - creation of root filesystems for images built using - <filename>.rpm</filename> packages.</para></listitem> - <listitem><para> - The <filename>rootfs_ipk</filename> class, which supports - creation of root filesystems for images built using - <filename>.ipk</filename> packages.</para></listitem> - <listitem><para> - The <filename>rootfsdebugfiles</filename> class, which installs - additional files found on the build host directly into the - root filesystem. - </para></listitem> - </itemizedlist> - </para> - - <para> - The root filesystem is created from packages using one of the - <filename>rootfs*.bbclass</filename> files as determined by the - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - variable. - </para> - - <para> - For information on how root filesystem images are created, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#image-generation-dev-environment'>Image Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> -</section> - -<section id='ref-classes-sanity'> - <title><filename>sanity.bbclass</filename></title> - - <para> - The <filename>sanity</filename> class checks to see if prerequisite - software is present on the host system so that users can be notified - of potential problems that might affect their build. - The class also performs basic user configuration checks from - the <filename>local.conf</filename> configuration file to - prevent common mistakes that cause build failures. - Distribution policy usually determines whether to include this class. - </para> -</section> - -<section id='ref-classes-scons'> - <title><filename>scons.bbclass</filename></title> - - <para> - The <filename>scons</filename> class supports recipes that need to - build software that uses the SCons build system. - You can use the - <link linkend='var-EXTRA_OESCONS'><filename>EXTRA_OESCONS</filename></link> - variable to specify additional configuration options you want to pass - SCons command line. - </para> -</section> - -<section id='ref-classes-sdl'> - <title><filename>sdl.bbclass</filename></title> - - <para> - The <filename>sdl</filename> class supports recipes that need to build - software that uses the Simple DirectMedia Layer (SDL) library. - </para> -</section> - -<section id='ref-classes-setuptools'> - <title><filename>setuptools.bbclass</filename></title> - - <para> - The <filename>setuptools</filename> class supports Python - version 2.x extensions that use build systems based on - <filename>setuptools</filename>. - If your recipe uses these build systems, the recipe needs to - inherit the <filename>setuptools</filename> class. - </para> -</section> - -<section id='ref-classes-setuptools3'> - <title><filename>setuptools3.bbclass</filename></title> - - <para> - The <filename>setuptools3</filename> class supports Python - version 3.x extensions that use build systems based on - <filename>setuptools3</filename>. - If your recipe uses these build systems, the recipe needs to - inherit the <filename>setuptools3</filename> class. - </para> -</section> - -<section id='ref-classes-sign_rpm'> - <title><filename>sign_rpm.bbclass</filename></title> - - <para> - The <filename>sign_rpm</filename> class supports generating signed - RPM packages. - </para> -</section> - -<section id='ref-classes-sip'> - <title><filename>sip.bbclass</filename></title> - - <para> - The <filename>sip</filename> class - supports recipes that build or package SIP-based Python bindings. - </para> -</section> - -<section id='ref-classes-siteconfig'> - <title><filename>siteconfig.bbclass</filename></title> - - <para> - The <filename>siteconfig</filename> class - provides functionality for handling site configuration. - The class is used by the - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> - class to accelerate the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task. - </para> -</section> - -<section id='ref-classes-siteinfo'> - <title><filename>siteinfo.bbclass</filename></title> - - <para> - The <filename>siteinfo</filename> class provides information about - the targets that might be needed by other classes or recipes. - </para> - - <para> - As an example, consider Autotools, which can require tests that must - execute on the target hardware. - Since this is not possible in general when cross compiling, site - information is used to provide cached test results so these tests can - be skipped over but still make the correct values available. - The - <filename><link linkend='structure-meta-site'>meta/site directory</link></filename> - contains test results sorted into different categories such as - architecture, endianness, and the <filename>libc</filename> used. - Site information provides a list of files containing data relevant to - the current build in the - <filename><link linkend='var-CONFIG_SITE'>CONFIG_SITE</link></filename> variable - that Autotools automatically picks up. - </para> - - <para> - The class also provides variables like - <filename><link linkend='var-SITEINFO_ENDIANNESS'>SITEINFO_ENDIANNESS</link></filename> - and <filename><link linkend='var-SITEINFO_BITS'>SITEINFO_BITS</link></filename> - that can be used elsewhere in the metadata. - </para> -</section> - -<section id='ref-classes-spdx'> - <title><filename>spdx.bbclass</filename></title> - - <para> - The <filename>spdx</filename> class integrates real-time license - scanning, generation of SPDX standard output, and verification - of license information during the build. - <note> - This class is currently at the prototype stage in the 1.6 - release. - </note> - </para> -</section> - -<section id='ref-classes-sstate'> - <title><filename>sstate.bbclass</filename></title> - - <para> - The <filename>sstate</filename> class provides support for Shared - State (sstate). - By default, the class is enabled through the - <link linkend='var-INHERIT_DISTRO'><filename>INHERIT_DISTRO</filename></link> - variable's default value. - </para> - - <para> - For more information on sstate, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>Shared State Cache</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> -</section> - -<section id='ref-classes-staging'> - <title><filename>staging.bbclass</filename></title> - - <para> - The <filename>staging</filename> class installs files into individual - recipe work directories for sysroots. - The class contains the following key tasks: - <itemizedlist> - <listitem><para> - The - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task, which is responsible for handing the files that end up - in the recipe sysroots. - </para></listitem> - <listitem><para> - The - <link linkend='ref-tasks-prepare_recipe_sysroot'><filename>do_prepare_recipe_sysroot</filename></link> - task (a "partner" task to the - <filename>populate_sysroot</filename> task), which installs - the files into the individual recipe work directories (i.e. - <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>). - </para></listitem> - </itemizedlist> - </para> - - <para> - The code in the <filename>staging</filename> class is complex and - basically works in two stages: - <itemizedlist> - <listitem><para> - <emphasis>Stage One:</emphasis> - 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 - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task into - <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename>. - The <filename>do_populate_sysroot</filename> task copies - a subset of these files into - <filename>${SYSROOT_DESTDIR}</filename>. - This subset of files is controlled by the - <link linkend='var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></link>, - <link linkend='var-SYSROOT_DIRS_NATIVE'><filename>SYSROOT_DIRS_NATIVE</filename></link>, - and - <link linkend='var-SYSROOT_DIRS_BLACKLIST'><filename>SYSROOT_DIRS_BLACKLIST</filename></link> - variables. - <note> - Additionally, a recipe can customize the files further by - declaring a processing function in the - <link linkend='var-SYSROOT_PREPROCESS_FUNCS'><filename>SYSROOT_PREPROCESS_FUNCS</filename></link> - variable. - </note> - </para> - - <para> - A shared state (sstate) object is built from these files - and the files are placed into a subdirectory of - <link linkend='structure-build-tmp-sysroots-components'><filename>tmp/sysroots-components/</filename></link>. - 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 - <link linkend='var-SSTATE_SCAN_FILES'><filename>SSTATE_SCAN_FILES</filename></link> - variable. - </para></listitem> - <listitem><para> - <emphasis>Stage Two:</emphasis> - The second stage addresses recipes that want to use something - from another recipe and declare a dependency on that recipe - through the - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> - variable. - The recipe will have a - <link linkend='ref-tasks-prepare_recipe_sysroot'><filename>do_prepare_recipe_sysroot</filename></link> - task and when - this task executes, it creates the - <filename>recipe-sysroot</filename> and - <filename>recipe-sysroot-native</filename> in the recipe - work directory (i.e. - <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>). - The OpenEmbedded build system creates hard links to copies of the - relevant files from <filename>sysroots-components</filename> - into the recipe work directory. - <note> - If hard links are not possible, the build system uses - actual copies. - </note> - The build system then addresses any "FIXMEs" to paths as - defined from the list created in the first stage. - </para> - - <para> - Finally, any files in <filename>${bindir}</filename> - within the sysroot that have the prefix - "<filename>postinst-</filename>" 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. - </note> - </para> - - <para> - Because recipes can have other dependencies outside of - <filename>DEPENDS</filename> (e.g. - <filename>do_unpack[depends] += "tar-native:do_populate_sysroot"</filename>), - the sysroot creation function - <filename>extend_recipe_sysroot</filename> is also added as - a pre-function for those tasks whose dependencies are not - through <filename>DEPENDS</filename> but operate similarly. - </para> - - <para> - 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 - <filename>setscene_depvalid()</filename> function in the - <link linkend='ref-classes-sstate'><filename>sstate</filename></link> - class. - </para> - - <para> - 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. - </para></listitem> - </itemizedlist> - </para> -</section> - -<section id='ref-classes-syslinux'> - <title><filename>syslinux.bbclass</filename></title> - - <para> - The <filename>syslinux</filename> class provides syslinux-specific - functions for building bootable images. - </para> - - <para> - The class supports the following variables: - <itemizedlist> - <listitem><para><link linkend='var-INITRD'><filename>INITRD</filename></link>: - Indicates list of filesystem images to concatenate and use as - an initial RAM disk (initrd). - This variable is optional.</para></listitem> - <listitem><para><link linkend='var-ROOTFS'><filename>ROOTFS</filename></link>: - Indicates a filesystem image to include as the root filesystem. - This variable is optional.</para></listitem> - <listitem><para><link linkend='var-AUTO_SYSLINUXMENU'><filename>AUTO_SYSLINUXMENU</filename></link>: - Enables creating an automatic menu when set to "1". - </para></listitem> - <listitem><para><link linkend='var-LABELS'><filename>LABELS</filename></link>: - Lists targets for automatic configuration. - </para></listitem> - <listitem><para><link linkend='var-APPEND'><filename>APPEND</filename></link>: - Lists append string overrides for each label. - </para></listitem> - <listitem><para><link linkend='var-SYSLINUX_OPTS'><filename>SYSLINUX_OPTS</filename></link>: - Lists additional options to add to the syslinux file. - Semicolon characters separate multiple options. - </para></listitem> - <listitem><para><link linkend='var-SYSLINUX_SPLASH'><filename>SYSLINUX_SPLASH</filename></link>: - Lists a background for the VGA boot menu when you are using the - boot menu.</para></listitem> - <listitem><para><link linkend='var-SYSLINUX_DEFAULT_CONSOLE'><filename>SYSLINUX_DEFAULT_CONSOLE</filename></link>: - Set to "console=ttyX" to change kernel boot default console. - </para></listitem> - <listitem><para><link linkend='var-SYSLINUX_SERIAL'><filename>SYSLINUX_SERIAL</filename></link>: - Sets an alternate serial port. - Or, turns off serial when the variable is set with an - empty string.</para></listitem> - <listitem><para><link linkend='var-SYSLINUX_SERIAL_TTY'><filename>SYSLINUX_SERIAL_TTY</filename></link>: - Sets an alternate "console=tty..." kernel boot argument. - </para></listitem> - </itemizedlist> - </para> -</section> - -<section id='ref-classes-systemd'> - <title><filename>systemd.bbclass</filename></title> - - <para> - The <filename>systemd</filename> class provides support for recipes - that install systemd unit files. - </para> - - <para> - The functionality for this class is disabled unless you have "systemd" - in - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. - </para> - - <para> - Under this class, the recipe or Makefile (i.e. whatever the recipe is - calling during the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task) installs unit files into - <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}${systemd_unitdir}/system</filename>. - If the unit files being installed go into packages other than the - main package, you need to set - <link linkend='var-SYSTEMD_PACKAGES'><filename>SYSTEMD_PACKAGES</filename></link> - in your recipe to identify the packages in which the files will be - installed. - </para> - - <para> - You should set - <link linkend='var-SYSTEMD_SERVICE'><filename>SYSTEMD_SERVICE</filename></link> - to the name of the service file. - You should also use a package name override to indicate the package - to which the value applies. - If the value applies to the recipe's main package, use - <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>. - Here is an example from the connman recipe: - <literallayout class='monospaced'> - SYSTEMD_SERVICE_${PN} = "connman.service" - </literallayout> - Services are set up to start on boot automatically unless - you have set - <link linkend='var-SYSTEMD_AUTO_ENABLE'><filename>SYSTEMD_AUTO_ENABLE</filename></link> - to "disable". - </para> - - <para> - For more information on <filename>systemd</filename>, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#selecting-an-initialization-manager'>Selecting an Initialization Manager</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> -</section> - -<section id='ref-classes-systemd-boot'> - <title><filename>systemd-boot.bbclass</filename></title> - - <para> - The <filename>systemd-boot</filename> 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 <filename>systemd-boot</filename> class is a result from - merging the <filename>gummiboot</filename> class used in previous - Yocto Project releases with the <filename>systemd</filename> - project. - </note> - Set the - <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> - variable to "systemd-boot" to use this class. - Doing so creates a standalone EFI bootloader that is not dependent - on systemd. - </para> - - <para> - For information on more variables used and supported in this class, - see the - <link linkend='var-SYSTEMD_BOOT_CFG'><filename>SYSTEMD_BOOT_CFG</filename></link>, - <link linkend='var-SYSTEMD_BOOT_ENTRIES'><filename>SYSTEMD_BOOT_ENTRIES</filename></link>, - and - <link linkend='var-SYSTEMD_BOOT_TIMEOUT'><filename>SYSTEMD_BOOT_TIMEOUT</filename></link> - variables. - </para> - - <para> - You can also see the - <ulink url='http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/'>Systemd-boot documentation</ulink> - for more information. - </para> -</section> - -<section id='ref-classes-terminal'> - <title><filename>terminal.bbclass</filename></title> - - <para> - The <filename>terminal</filename> class provides support for starting - a terminal session. - The - <link linkend='var-OE_TERMINAL'><filename>OE_TERMINAL</filename></link> - variable controls which terminal emulator is used for the session. - </para> - - <para> - Other classes use the <filename>terminal</filename> class anywhere a - separate terminal session needs to be started. - For example, the - <link linkend='ref-classes-patch'><filename>patch</filename></link> - class assuming - <link linkend='var-PATCHRESOLVE'><filename>PATCHRESOLVE</filename></link> - is set to "user", the - <link linkend='ref-classes-cml1'><filename>cml1</filename></link> - class, and the - <link linkend='ref-classes-devshell'><filename>devshell</filename></link> - class all use the <filename>terminal</filename> class. - </para> -</section> - -<section id='ref-classes-testimage*'> - <title><filename>testimage*.bbclass</filename></title> - - <para> - The <filename>testimage*</filename> classes support running - automated tests against images using QEMU and on actual hardware. - The classes handle loading the tests and starting the image. - To use the classes, you need to perform steps to set up the - environment. - <note><title>Tip</title> - Best practices include using - <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link> - rather than - <link linkend='var-INHERIT'><filename>INHERIT</filename></link> to - inherit the <filename>testimage</filename> class for automated - image testing. - </note> - </para> - - <para> - The tests are commands that run on the target system over - <filename>ssh</filename>. - Each test is written in Python and makes use of the - <filename>unittest</filename> module. - </para> - - <para> - The <filename>testimage.bbclass</filename> runs tests on an image - when called using the following: - <literallayout class='monospaced'> - $ bitbake -c testimage <replaceable>image</replaceable> - </literallayout> - The <filename>testimage-auto</filename> class runs tests on an image - after the image is constructed (i.e. - <link linkend='var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></link> - must be set to "1"). - </para> - - <para> - For information on how to enable, run, and create new tests, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> -</section> - -<section id='ref-classes-testsdk'> - <title><filename>testsdk.bbclass</filename></title> - - <para> - This class supports running automated tests against - software development kits (SDKs). - The <filename>testsdk</filename> class runs tests on an SDK when - called using the following: - <literallayout class='monospaced'> - $ bitbake -c testsdk image - </literallayout> - <note><title>Tip</title> - Best practices include using - <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link> - rather than - <link linkend='var-INHERIT'><filename>INHERIT</filename></link> to - inherit the <filename>testsdk</filename> class for automated - SDK testing. - </note> - </para> -</section> - -<section id='ref-classes-texinfo'> - <title><filename>texinfo.bbclass</filename></title> - - <para> - This class should be inherited by recipes whose upstream packages - invoke the <filename>texinfo</filename> utilities at build-time. - Native and cross recipes are made to use the dummy scripts provided - by <filename>texinfo-dummy-native</filename>, for improved performance. - Target architecture recipes use the genuine - Texinfo utilities. - By default, they use the Texinfo utilities on the host system. - <note> - If you want to use the Texinfo recipe shipped with the build - system, you can remove "texinfo-native" from - <link linkend='var-ASSUME_PROVIDED'><filename>ASSUME_PROVIDED</filename></link> - and makeinfo from - <link linkend='var-SANITY_REQUIRED_UTILITIES'><filename>SANITY_REQUIRED_UTILITIES</filename></link>. - </note> - </para> -</section> - -<section id='ref-classes-tinderclient'> - <title><filename>tinderclient.bbclass</filename></title> - - <para> - The <filename>tinderclient</filename> class submits build results to - an external Tinderbox instance. - <note> - This class is currently unmaintained. - </note> - </para> -</section> - -<section id='ref-classes-toaster'> - <title><filename>toaster.bbclass</filename></title> - - <para> - The <filename>toaster</filename> class collects information about - packages and images and sends them as events that the BitBake - user interface can receive. - The class is enabled when the Toaster user interface is running. - </para> - - <para> - This class is not intended to be used directly. - </para> -</section> - -<section id='ref-classes-toolchain-scripts'> - <title><filename>toolchain-scripts.bbclass</filename></title> - - <para> - The <filename>toolchain-scripts</filename> class provides the scripts - used for setting up the environment for installed SDKs. - </para> -</section> - -<section id='ref-classes-typecheck'> - <title><filename>typecheck.bbclass</filename></title> - - <para> - The <filename>typecheck</filename> class provides support for - validating the values of variables set at the configuration level - against their defined types. - The OpenEmbedded build system allows you to define the type of a - variable using the "type" varflag. - Here is an example: - <literallayout class='monospaced'> - IMAGE_FEATURES[type] = "list" - </literallayout> - </para> -</section> - -<section id='ref-classes-uboot-config'> - <title><filename>uboot-config.bbclass</filename></title> - - <para> - The <filename>uboot-config</filename> class provides support for - U-Boot configuration for a machine. - Specify the machine in your recipe as follows: - <literallayout class='monospaced'> - UBOOT_CONFIG ??= <default> - UBOOT_CONFIG[foo] = "config,images" - </literallayout> - You can also specify the machine using this method: - <literallayout class='monospaced'> - UBOOT_MACHINE = "config" - </literallayout> - See the - <link linkend='var-UBOOT_CONFIG'><filename>UBOOT_CONFIG</filename></link> - and - <link linkend='var-UBOOT_MACHINE'><filename>UBOOT_MACHINE</filename></link> - variables for additional information. - </para> -</section> - -<section id='ref-classes-uninative'> - <title><filename>uninative.bbclass</filename></title> - - <para> - Attempts to isolate the build system from the host - distribution's C library in order to make re-use of native shared state - artifacts across different host distributions practical. - With this class enabled, a tarball containing a pre-built C library - is downloaded at the start of the build. - In the Poky reference distribution this is enabled by default - through - <filename>meta/conf/distro/include/yocto-uninative.inc</filename>. - Other distributions that do not derive from poky can also - "<filename>require conf/distro/include/yocto-uninative.inc</filename>" - to use this. - Alternatively if you prefer, you can build the uninative-tarball recipe - yourself, publish the resulting tarball (e.g. via HTTP) and set - <filename>UNINATIVE_URL</filename> and - <filename>UNINATIVE_CHECKSUM</filename> appropriately. - For an example, see the - <filename>meta/conf/distro/include/yocto-uninative.inc</filename>. - </para> - - <para> - The <filename>uninative</filename> class is also used unconditionally - by the extensible SDK. - When building the extensible SDK, - <filename>uninative-tarball</filename> is built and the resulting - tarball is included within the SDK. - </para> -</section> - -<section id='ref-classes-update-alternatives'> - <title><filename>update-alternatives.bbclass</filename></title> - - <para> - The <filename>update-alternatives</filename> class helps the - alternatives system when multiple sources provide the same command. - This situation occurs when several programs that have the same or - similar function are installed with the same name. - For example, the <filename>ar</filename> command is available from the - <filename>busybox</filename>, <filename>binutils</filename> and - <filename>elfutils</filename> packages. - The <filename>update-alternatives</filename> class handles - renaming the binaries so that multiple packages can be installed - without conflicts. - The <filename>ar</filename> command still works regardless of which - packages are installed or subsequently removed. - The class renames the conflicting binary in each package and symlinks - the highest priority binary during installation or removal of packages. - </para> - - <para> - To use this class, you need to define a number of variables: - <itemizedlist> - <listitem><para><link linkend='var-ALTERNATIVE'><filename>ALTERNATIVE</filename></link> - </para></listitem> - <listitem><para><link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> - </para></listitem> - <listitem><para><link linkend='var-ALTERNATIVE_TARGET'><filename>ALTERNATIVE_TARGET</filename></link> - </para></listitem> - <listitem><para><link linkend='var-ALTERNATIVE_PRIORITY'><filename>ALTERNATIVE_PRIORITY</filename></link> - </para></listitem> - </itemizedlist> - These variables list alternative commands needed by a package, - provide pathnames for links, default links for targets, and - so forth. - For details on how to use this class, see the comments in the - <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink> - file. - </para> - - <note> - You can use the <filename>update-alternatives</filename> command - directly in your recipes. - However, this class simplifies things in most cases. - </note> -</section> - -<section id='ref-classes-update-rc.d'> - <title><filename>update-rc.d.bbclass</filename></title> - - <para> - The <filename>update-rc.d</filename> class uses - <filename>update-rc.d</filename> to safely install an - initialization script on behalf of the package. - The OpenEmbedded build system takes care of details such as making - sure the script is stopped before a package is removed and started when - the package is installed. - </para> - - <para> - Three variables control this class: - <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, - <filename><link linkend='var-INITSCRIPT_NAME'>INITSCRIPT_NAME</link></filename> and - <filename><link linkend='var-INITSCRIPT_PARAMS'>INITSCRIPT_PARAMS</link></filename>. - See the variable links for details. - </para> -</section> - -<section id='ref-classes-useradd'> - <title><filename>useradd*.bbclass</filename></title> - - <para> - The <filename>useradd*</filename> classes support the addition of users - or groups for usage by the package on the target. - For example, if you have packages that contain system services that - should be run under their own user or group, you can use these classes - to enable creation of the user or group. - The - <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename> - recipe in the <link linkend='source-directory'>Source Directory</link> - provides a simple example that shows how to add three - users and groups to two packages. - See the <filename>useradd-example.bb</filename> recipe for more - information on how to use these classes. - </para> - - <para> - The <filename>useradd_base</filename> class provides basic - functionality for user or groups settings. - </para> - - <para> - The <filename>useradd*</filename> classes support the - <link linkend='var-USERADD_PACKAGES'><filename>USERADD_PACKAGES</filename></link>, - <link linkend='var-USERADD_PARAM'><filename>USERADD_PARAM</filename></link>, - <link linkend='var-GROUPADD_PARAM'><filename>GROUPADD_PARAM</filename></link>, - and - <link linkend='var-GROUPMEMS_PARAM'><filename>GROUPMEMS_PARAM</filename></link> - variables. - </para> - - <para> - The <filename>useradd-staticids</filename> class supports the addition - of users or groups that have static user identification - (<filename>uid</filename>) and group identification - (<filename>gid</filename>) values. - </para> - - <para> - The default behavior of the OpenEmbedded build system for assigning - <filename>uid</filename> and <filename>gid</filename> values when - packages add users and groups during package install time is to - add them dynamically. - This works fine for programs that do not care what the values of the - resulting users and groups become. - In these cases, the order of the installation determines the final - <filename>uid</filename> and <filename>gid</filename> values. - However, if non-deterministic - <filename>uid</filename> and <filename>gid</filename> values are a - problem, you can override the default, dynamic application of these - values by setting static values. - When you set static values, the OpenEmbedded build system looks in - <link linkend='var-BBPATH'><filename>BBPATH</filename></link> for - <filename>files/passwd</filename> and <filename>files/group</filename> - files for the values. - </para> - - <para> - To use static <filename>uid</filename> and <filename>gid</filename> - values, you need to set some variables. - See the - <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>, - <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>, - <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link>, - and - <link linkend='var-USERADD_ERROR_DYNAMIC'><filename>USERADD_ERROR_DYNAMIC</filename></link> - variables. - You can also see the - <link linkend='ref-classes-useradd'><filename>useradd</filename></link> - class for additional information. - </para> - - <note><title>Notes</title> - You do not use the <filename>useradd-staticids</filename> - class directly. - You either enable or disable the class by setting the - <filename>USERADDEXTENSION</filename> variable. - If you enable or disable the class in a configured system, - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - might contain incorrect <filename>uid</filename> and - <filename>gid</filename> values. - Deleting the <filename>TMPDIR</filename> directory - will correct this condition. - </note> -</section> - -<section id='ref-classes-utility-tasks'> - <title><filename>utility-tasks.bbclass</filename></title> - - <para> - The <filename>utility-tasks</filename> class provides support for - various "utility" type tasks that are applicable to all recipes, - such as - <link linkend='ref-tasks-clean'><filename>do_clean</filename></link> and - <link linkend='ref-tasks-listtasks'><filename>do_listtasks</filename></link>. - </para> - - <para> - This class is enabled by default because it is inherited by - the - <link linkend='ref-classes-base'><filename>base</filename></link> - class. - </para> -</section> - -<section id='ref-classes-utils'> - <title><filename>utils.bbclass</filename></title> - - <para> - The <filename>utils</filename> class provides some useful Python - functions that are typically used in inline Python expressions - (e.g. <filename>${@...}</filename>). - One example use is for <filename>bb.utils.contains()</filename>. - </para> - - <para> - This class is enabled by default because it is inherited by the - <link linkend='ref-classes-base'><filename>base</filename></link> - class. - </para> -</section> - -<section id='ref-classes-vala'> - <title><filename>vala.bbclass</filename></title> - - <para> - The <filename>vala</filename> class supports recipes that need to - build software written using the Vala programming language. - </para> -</section> - -<section id='ref-classes-waf'> - <title><filename>waf.bbclass</filename></title> - - <para> - The <filename>waf</filename> class supports recipes that need to build - software that uses the Waf build system. - You can use the - <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> - or - <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link> - variables to specify additional configuration options to be passed on - the Waf command line. - </para> -</section> - -<!-- Undocumented classes are: - image-empty.bbclass (possibly being dropped) - migrate_localcount.bbclass (still need a description) ---> - - -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-devtool-reference.xml b/documentation/ref-manual/ref-devtool-reference.xml deleted file mode 100644 index b974d0f595..0000000000 --- a/documentation/ref-manual/ref-devtool-reference.xml +++ /dev/null @@ -1,734 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-devtool-reference'> - <title><filename>devtool</filename> Quick Reference</title> - - <para> - The <filename>devtool</filename> command-line tool provides a number - of features that help you build, test, and package software. - This command is available alongside the <filename>bitbake</filename> - command. - Additionally, the <filename>devtool</filename> command is a key - part of the extensible SDK. - </para> - - <para> - This chapter provides a Quick Reference for the - <filename>devtool</filename> command. - For more information on how to apply the command when using the - extensible SDK, see the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-extensible'>Using the Extensible SDK</ulink>" - chapter in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - </para> - - <section id='devtool-getting-help'> - <title>Getting Help</title> - - <para> - The <filename>devtool</filename> command line is organized - similarly to Git in that it has a number of sub-commands for - each function. - You can run <filename>devtool --help</filename> to see all - the commands: - <literallayout class='monospaced'> - $ devtool --help - NOTE: Starting bitbake server... - usage: devtool [--basepath BASEPATH] [--bbpath BBPATH] [-d] [-q] - [--color COLOR] [-h] - <subcommand> ... - - 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 - search Search available recipes - latest-version Report the latest version of an existing recipe - 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 - export Export workspace into a tar archive - import Import exported tar archive into workspace - extract Extract the source for an existing recipe - sync Synchronize the source tree for an existing recipe - Use devtool <subcommand> --help to get help on a specific command - </literallayout> - </para> - - <para> - As directed in the general help output, you can get more - syntax on a specific command by providing the command - name and using <filename>--help</filename>: - <literallayout class='monospaced'> - $ devtool add --help - NOTE: Starting bitbake server... - usage: devtool add [-h] [--same-dir | --no-same-dir] [--fetch URI] - [--fetch-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 - /home/scottrif/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) - --fetch-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 - </literallayout> - </para> - </section> - - <section id='devtool-the-workspace-layer-structure'> - <title>The Workspace Layer Structure</title> - - <para> - <filename>devtool</filename> uses a "Workspace" layer - in which to accomplish builds. - This layer is not specific to any single - <filename>devtool</filename> command but is rather a common - working area used across the tool. - </para> - - <para> - The following figure shows the workspace structure: - </para> - - <para> - <imagedata fileref="figures/build-workspace-directory.png" - width="6in" depth="5in" align="left" scale="70" /> - </para> - - <para> - <literallayout class='monospaced'> - 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 <replaceable>recipe</replaceable>.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. - </literallayout> - </para> - </section> - - <section id='devtool-adding-a-new-recipe-to-the-workspace'> - <title>Adding a New Recipe to the Workspace Layer</title> - - <para> - Use the <filename>devtool add</filename> command to add a new recipe - to the workspace layer. - The recipe you add should not exist - - <filename>devtool</filename> creates it for you. - The source files the recipe uses should exist in an external - area. - </para> - - <para> - The following example creates and adds a new recipe named - <filename>jackson</filename> to a workspace layer the tool creates. - The source code built by the recipes resides in - <filename>/home/<replaceable>user</replaceable>/sources/jackson</filename>: - <literallayout class='monospaced'> - $ devtool add jackson /home/<replaceable>user</replaceable>/sources/jackson - </literallayout> - </para> - - <para> - If you add a recipe and the workspace layer does not exist, - the command creates the layer and populates it as - described in - "<link linkend='devtool-the-workspace-layer-structure'>The Workspace Layer Structure</link>" - section. - </para> - - <para> - Running <filename>devtool add</filename> when the - workspace layer exists causes the tool to add the recipe, - append files, and source files into the existing workspace layer. - The <filename>.bbappend</filename> 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 - "<link linkend='devtool-deploying-your-software-on-the-target-machine'>Deploying Your Software on the Target Machine</link>" - section. - </note> - </para> - - <para> - By default, <filename>devtool add</filename> 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 <filename>devtool add</filename> command: - <itemizedlist> - <listitem><para> - To specify a source branch, use the - <filename>--srcbranch</filename> option: - <literallayout class='monospaced'> - $ devtool add --srcbranch &DISTRO_NAME_NO_CAP; jackson /home/<replaceable>user</replaceable>/sources/jackson - </literallayout> - In the previous example, you are checking out the - &DISTRO_NAME_NO_CAP; branch. - </para></listitem> - <listitem><para> - To specify a specific tag or commit hash, use the - <filename>--srcrev</filename> option: - <literallayout class='monospaced'> - $ devtool add --srcrev &DISTRO_REL_TAG; jackson /home/<replaceable>user</replaceable>/sources/jackson - $ devtool add --srcrev <replaceable>some_commit_hash</replaceable> /home/<replaceable>user</replaceable>/sources/jackson - </literallayout> - The previous examples check out the &DISTRO_REL_TAG; tag - and the commit associated with the - <replaceable>some_commit_hash</replaceable> hash. - </para></listitem> - </itemizedlist> - <note> - If you prefer to use the latest revision every time the recipe is - built, use the options <filename>--autorev</filename> - or <filename>-a</filename>. - </note> - </para> - </section> - - <section id='devtool-extracting-the-source-for-an-existing-recipe'> - <title>Extracting the Source for an Existing Recipe</title> - - <para> - Use the <filename>devtool extract</filename> 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. - </para> - - <para> - 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. - </para> - </section> - - <section id='devtool-synchronizing-a-recipes-extracted-source-tree'> - <title>Synchronizing a Recipe's Extracted Source Tree</title> - - <para> - Use the <filename>devtool sync</filename> 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. - </para> - - <para> - 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. - </para> - </section> - - <section id='devtool-modifying-a-recipe'> - <title>Modifying an Existing Recipe</title> - - <para> - Use the <filename>devtool modify</filename> command to begin - modifying the source of an existing recipe. - This command is very similar to the - <link linkend='devtool-adding-a-new-recipe-to-the-workspace'><filename>add</filename></link> - command except that it does not physically create the - recipe in the workspace layer because the recipe already - exists in an another layer. - </para> - - <para> - The <filename>devtool modify</filename> 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: - <literallayout class='monospaced'> - $ devtool modify <replaceable>recipe</replaceable> - </literallayout> - Using the above command form, <filename>devtool</filename> uses - the existing recipe's - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - statement to locate the upstream source, extracts the source - into the default sources location in the workspace. - The default development branch used is "devtool". - </para> - </section> - - <section id='devtool-edit-an-existing-recipe'> - <title>Edit an Existing Recipe</title> - - <para> - Use the <filename>devtool edit-recipe</filename> command - to run the default editor, which is identified using the - <filename>EDITOR</filename> variable, on the specified recipe. - </para> - - <para> - When you use the <filename>devtool edit-recipe</filename> - 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 <filename>devtool add</filename> or - <filename>devtool upgrade</filename> 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. - </para> - </section> - - <section id='devtool-updating-a-recipe'> - <title>Updating a Recipe</title> - - <para> - Use the <filename>devtool update-recipe</filename> 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 - <link linkend='devtool-modifying-a-recipe'><filename>devtool modify</filename></link> - command to extract the code and set up the workspace. - After which, you could modify, compile, and test the code. - </para> - - <para> - When you are satisfied with the results and you have committed - your changes to the Git repository, you can then - run the <filename>devtool update-recipe</filename> to create the - patches and update the recipe: - <literallayout class='monospaced'> - $ devtool update-recipe <replaceable>recipe</replaceable> - </literallayout> - If you run the <filename>devtool update-recipe</filename> - without committing your changes, the command ignores the - changes. - </para> - - <para> - 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 - <filename>-a</filename> or <filename>--append</filename> - option with the <filename>devtool update-recipe</filename> - command. - These options allow you to specify the layer into which to - write an append file: - <literallayout class='monospaced'> - $ devtool update-recipe <replaceable>recipe</replaceable> -a <replaceable>base-layer-directory</replaceable> - </literallayout> - The <filename>*.bbappend</filename> file is created at the - appropriate path within the specified layer directory, which - may or may not be in your <filename>bblayers.conf</filename> - file. - If an append file already exists, the command updates it - appropriately. - </para> - </section> - - <section id='devtool-upgrading-a-recipe'> - <title>Upgrading a Recipe</title> - - <para> - 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 - "<ulink url='&YOCTO_DOCS_DEV_URL;#gs-upgrading-recipes'>Upgrading Recipes</ulink>" - section of the Yocto Project Development Tasks Manual. - This section overviews the <filename>devtool upgrade</filename> - command. - </para> - - <para> - The <filename>devtool upgrade</filename> 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. - </para> - - <para> - When you use the <filename>devtool upgrade</filename> 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 - <link linkend='var-PV'><filename>PV</filename></link>), - the source revision to which you want to upgrade (i.e. the - <link linkend='var-SRCREV'><filename>SRCREV</filename></link>), - whether or not to apply patches, and so forth. - </para> - - <para> - You can read more on the <filename>devtool upgrade</filename> - workflow in the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-devtool-use-devtool-upgrade-to-create-a-version-of-the-recipe-that-supports-a-newer-version-of-the-software'>Use <filename>devtool upgrade</filename> to Create a Version of the Recipe that Supports a Newer Version of the Software</ulink>" - 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 - <filename>devtool upgrade</filename> in the - "<ulink url='&YOCTO_DOCS_DEV_URL;#gs-using-devtool-upgrade'>Using <filename>devtool upgrade</filename></ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='devtool-resetting-a-recipe'> - <title>Resetting a Recipe</title> - - <para> - Use the <filename>devtool reset</filename> command to remove a - recipe and its configuration (e.g. the corresponding - <filename>.bbappend</filename> 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 <filename>devtool reset</filename> - command. - </para> - - <para> - If the <filename>devtool reset</filename> 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. - </para> - - <para> - Here is an example that resets the workspace directory that - contains the <filename>mtr</filename> recipe: - <literallayout class='monospaced'> - $ 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 - $ - </literallayout> - </para> - </section> - - <section id='devtool-building-your-recipe'> - <title>Building Your Recipe</title> - - <para> - Use the <filename>devtool build</filename> command to cause the - OpenEmbedded build system to build your recipe. - The <filename>devtool build</filename> command is equivalent to - <filename>bitbake -c populate_sysroot</filename>. - </para> - - <para> - When you use the <filename>devtool build</filename> command, - you must supply the root name of the recipe (i.e. no version, - paths, or extensions). - You can use either the "-s" or the "--disable-parallel-make" - option to disable parallel makes during the build. - Here is an example: - <literallayout class='monospaced'> - $ devtool build <replaceable>recipe</replaceable> - </literallayout> - </para> - </section> - - <section id='devtool-building-your-image'> - <title>Building Your Image</title> - - <para> - Use the <filename>devtool build-image</filename> 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. - </para> - - <para> - When you use the <filename>devtool build-image</filename> - command, you must supply the name of the image. - This command has no command line options: - <literallayout class='monospaced'> - $ devtool build-image <replaceable>image</replaceable> - </literallayout> - </para> - </section> - - <section id='devtool-deploying-your-software-on-the-target-machine'> - <title>Deploying Your Software on the Target Machine</title> - - <para> - Use the <filename>devtool deploy-target</filename> command to - deploy the recipe's build output to the live target machine: - <literallayout class='monospaced'> - $ devtool deploy-target <replaceable>recipe</replaceable> <replaceable>target</replaceable> - </literallayout> - The <replaceable>target</replaceable> is the address of the - target machine, which must be running an SSH server (i.e. - <filename>user@hostname[:destdir]</filename>). - </para> - - <para> - This command deploys all files installed during the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task. - Furthermore, you do not need to have package management enabled - within the target machine. - If you do, the package manager is bypassed. - <note><title>Notes</title> - <para> - The <filename>deploy-target</filename> - functionality is for development only. - You should never use it to update an image that will be - used in production. - </para> - </note> - </para> - - <para> - 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: - <itemizedlist> - <listitem><para> - You are deploying a new application to the target and - the recipe you used to build the application had - correctly defined runtime dependencies. - </para></listitem> - <listitem><para> - The target does not physically have the packages on which - the application depends installed. - </para></listitem> - </itemizedlist> - If both of these conditions exist, your application will not - behave as expected. - The reason for this misbehavior is because the - <filename>devtool deploy-target</filename> 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. - </para> - - <para> - 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. - </para> - </section> - - <section id='devtool-removing-your-software-from-the-target-machine'> - <title>Removing Your Software from the Target Machine</title> - - <para> - Use the <filename>devtool undeploy-target</filename> command to - remove deployed build output from the target machine. - For the <filename>devtool undeploy-target</filename> command to - work, you must have previously used the - <link linkend='devtool-deploying-your-software-on-the-target-machine'><filename>devtool deploy-target</filename></link> - command. - <literallayout class='monospaced'> - $ devtool undeploy-target <replaceable>recipe</replaceable> <replaceable>target</replaceable> - </literallayout> - The <replaceable>target</replaceable> is the address of the - target machine, which must be running an SSH server (i.e. - <filename>user@hostname</filename>). - </para> - </section> - - <section id='devtool-creating-the-workspace'> - <title>Creating the Workspace Layer in an Alternative Location</title> - - <para> - Use the <filename>devtool create-workspace</filename> command to - create a new workspace layer in your - <link linkend='build-directory'>Build Directory</link>. - When you create a new workspace layer, it is populated with the - <filename>README</filename> file and the - <filename>conf</filename> directory only. - </para> - - <para> - The following example creates a new workspace layer in your - current working and by default names the workspace layer - "workspace": - <literallayout class='monospaced'> - $ devtool create-workspace - </literallayout> - </para> - - <para> - 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": - <literallayout class='monospaced'> - $ devtool create-workspace /home/scottrif/new-workspace - </literallayout> - </para> - </section> - - <section id='devtool-get-the-status-of-the-recipes-in-your-workspace'> - <title>Get the Status of the Recipes in Your Workspace</title> - - <para> - Use the <filename>devtool status</filename> command to - list the recipes currently in your workspace. - Information includes the paths to their respective - external source trees. - </para> - - <para> - The <filename>devtool status</filename> command has no - command-line options: - <literallayout class='monospaced'> - $ devtool status - </literallayout> - Following is sample output after using - <link linkend='devtool-adding-a-new-recipe-to-the-workspace'><filename>devtool add</filename></link> - to create and add the <filename>mtr_0.86.bb</filename> recipe - to the <filename>workspace</filename> directory: - <literallayout class='monospaced'> - $ devtool status - mtr: /home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb) - $ - </literallayout> - </para> - </section> - - <section id='devtool-search-for-available-target-recipes'> - <title>Search for Available Target Recipes</title> - - <para> - Use the <filename>devtool search</filename> 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. - </para> - - <para> - When you use the <filename>devtool search</filename> command, - you must supply a <replaceable>keyword</replaceable>. - The command uses the <replaceable>keyword</replaceable> when - searching for a match. - </para> - </section> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-features.xml b/documentation/ref-manual/ref-features.xml deleted file mode 100644 index cb74df6dad..0000000000 --- a/documentation/ref-manual/ref-features.xml +++ /dev/null @@ -1,482 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-features'> - <title>Features</title> - - <para> - This chapter provides a reference of shipped machine and distro features - you can include as part of your image, a reference on image features you can - select, and a reference on feature backfilling. - </para> - - <para> - Features provide a mechanism for working out which packages - should be included in the generated images. - Distributions can select which features they want to support through the - <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename> - variable, which is set or appended to in a distribution's configuration file such as - <filename>poky.conf</filename>, - <filename>poky-tiny.conf</filename>, - <filename>poky-lsb.conf</filename> and so forth. - Machine features are set in the - <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename> - variable, which is set in the machine configuration file and - specifies the hardware features for a given machine. - </para> - - <para> - These two variables combine to work out which kernel modules, - utilities, and other packages to include. - A given distribution can support a selected subset of features so some machine features might not - be included if the distribution itself does not support them. - </para> - - <para> - One method you can use to determine which recipes are checking to see if a - particular feature is contained or not is to <filename>grep</filename> through - the <link linkend='metadata'>Metadata</link> - for the feature. - Here is an example that discovers the recipes whose build is potentially - changed based on a given feature: - <literallayout class='monospaced'> - $ cd poky - $ git grep 'contains.*MACHINE_FEATURES.*<replaceable>feature</replaceable>' - </literallayout> - </para> - - <section id='ref-features-machine'> - <title>Machine Features</title> - - <para> - The items below are features you can use with - <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link>. - Features do not have a one-to-one correspondence to packages, and they can - go beyond simply controlling the installation of a package or packages. - Sometimes a feature can influence how certain recipes are built. - For example, a feature might determine whether a particular configure option - is specified within the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task for a particular recipe. - </para> - - <para> - This feature list only represents features as shipped with the Yocto Project metadata: - <itemizedlist> - <listitem><para><emphasis>acpi:</emphasis> Hardware has ACPI (x86/x86_64 only) - </para></listitem> - <listitem><para><emphasis>alsa:</emphasis> Hardware has ALSA audio drivers - </para></listitem> - <listitem><para><emphasis>apm:</emphasis> Hardware uses APM (or APM emulation) - </para></listitem> - <listitem><para><emphasis>bluetooth:</emphasis> Hardware has integrated BT - </para></listitem> - <listitem><para><emphasis>efi:</emphasis> Support for booting through EFI - </para></listitem> - <listitem><para><emphasis>ext2:</emphasis> Hardware HDD or Microdrive - </para></listitem> - <listitem><para><emphasis>irda:</emphasis> Hardware has IrDA support - </para></listitem> - <listitem><para><emphasis>keyboard:</emphasis> Hardware has a keyboard - </para></listitem> - <listitem><para><emphasis>pcbios:</emphasis> Support for booting through BIOS - </para></listitem> - <listitem><para><emphasis>pci:</emphasis> Hardware has a PCI bus - </para></listitem> - <listitem><para><emphasis>pcmcia:</emphasis> Hardware has PCMCIA or CompactFlash sockets - </para></listitem> - <listitem><para><emphasis>phone:</emphasis> Mobile phone (voice) support - </para></listitem> - <listitem><para><emphasis>qvga:</emphasis> Machine has a QVGA (320x240) display - </para></listitem> - <listitem><para><emphasis>rtc:</emphasis> Machine has a Real-Time Clock - </para></listitem> - <listitem><para><emphasis>screen:</emphasis> Hardware has a screen - </para></listitem> - <listitem><para><emphasis>serial:</emphasis> Hardware has serial support (usually RS232) - </para></listitem> - <listitem><para><emphasis>touchscreen:</emphasis> Hardware has a touchscreen - </para></listitem> - <listitem><para><emphasis>usbgadget:</emphasis> Hardware is USB gadget device capable - </para></listitem> - <listitem><para><emphasis>usbhost:</emphasis> Hardware is USB Host capable - </para></listitem> - <listitem><para><emphasis>vfat:</emphasis> FAT file system support - </para></listitem> - <listitem><para><emphasis>wifi:</emphasis> Hardware has integrated WiFi - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='ref-features-distro'> - <title>Distro Features</title> - - <para> - The items below are features you can use with - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - to enable features across your distribution. - Features do not have a one-to-one correspondence to packages, - and they can go beyond simply controlling the installation of a - package or packages. - In most cases, the presence or absence of a feature translates to - the appropriate option supplied to the configure script during the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task for the recipes that optionally - support the feature. - </para> - - <para> - Some distro features are also machine features. - These select features make sense to be controlled both at - the machine and distribution configuration level. - See the - <link linkend='var-COMBINED_FEATURES'><filename>COMBINED_FEATURES</filename></link> - variable for more information. - </para> - - <para> - This list only represents features as shipped with the Yocto Project metadata: - <itemizedlist> - <listitem><para><emphasis>alsa:</emphasis> Include ALSA support - (OSS compatibility kernel modules installed if available). - </para></listitem> - <listitem><para><emphasis>api-documentation:</emphasis> - Enables generation of API documentation during recipe - builds. - The resulting documentation is added to SDK tarballs - when the - <filename>bitbake -c populate_sdk</filename> command - is used. - See the - "<ulink url='&YOCTO_DOCS_SDK_URL;#adding-api-documentation-to-the-standard-sdk'>Adding API Documentation to the Standard SDK</ulink>" - section in the Yocto Project Application Development and - the Extensible Software Development Kit (eSDK) manual. - </para></listitem> - <listitem><para><emphasis>bluetooth:</emphasis> Include - bluetooth support (integrated BT only).</para></listitem> - <listitem><para><emphasis>bluez5:</emphasis> Include - BlueZ Version 5, which provides core Bluetooth layers and - protocols support. - <note> - The default value for the - <filename>DISTRO FEATURES</filename> variable includes - "bluetooth", which causes bluez5 to be backfilled in - for bluetooth support. - If you do not want bluez5 backfilled and would rather - use bluez4, you need to use the - <link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename></link> - variable as follows: - <literallayout class='monospaced'> - DISTRO_FEATURES_BACKFILL_CONSIDERED = "bluez5" - </literallayout> - Setting this variable tells the OpenEmbedded build - system that you have considered but ruled - out using the bluez5 feature and that bluez4 will be - used. - </note> - </para></listitem> - <listitem><para><emphasis>cramfs:</emphasis> Include CramFS - support.</para></listitem> - <listitem><para><emphasis>directfb:</emphasis> - Include DirectFB support. - </para></listitem> - <listitem><para><emphasis>ext2:</emphasis> Include tools for - supporting for devices with internal HDD/Microdrive for - storing files (instead of Flash only devices). - </para></listitem> - <listitem><para><emphasis>ipsec:</emphasis> Include IPSec - support.</para></listitem> - <listitem><para><emphasis>ipv6:</emphasis> Include IPv6 support. - </para></listitem> - <listitem><para><emphasis>irda:</emphasis> Include IrDA support. - </para></listitem> - <listitem><para><emphasis>keyboard:</emphasis> Include keyboard - support (e.g. keymaps will be loaded during boot). - </para></listitem> - <listitem><para><emphasis>ldconfig:</emphasis> - Include support for ldconfig and - <filename>ld.so.conf</filename> on the target. - </para></listitem> - <listitem><para><emphasis>nfs:</emphasis> Include NFS client - support (for mounting NFS exports on device). - </para></listitem> - <listitem><para><emphasis>opengl:</emphasis> - Include the Open Graphics Library, which is a - cross-language, multi-platform application programming - interface used for rendering two and three-dimensional - graphics.</para></listitem> - <listitem><para><emphasis>pci:</emphasis> Include PCI bus - support.</para></listitem> - <listitem><para><emphasis>pcmcia:</emphasis> Include - PCMCIA/CompactFlash support.</para></listitem> - <listitem><para><emphasis>ppp:</emphasis> Include PPP dialup - support.</para></listitem> - <listitem><para><emphasis>ptest:</emphasis> Enables building - the package tests where supported by individual recipes. - For more information on package tests, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" - section in the Yocto Project Development Tasks Manual. - </para></listitem> - <listitem><para><emphasis>smbfs:</emphasis> Include SMB networks - client support (for mounting Samba/Microsoft Windows shares - on device).</para></listitem> - <listitem><para><emphasis>systemd:</emphasis> Include support - for this <filename>init</filename> manager, which is a full - replacement of for <filename>init</filename> with parallel - starting of services, reduced shell overhead, and other - features. - This <filename>init</filename> manager is used by many - distributions.</para></listitem> - <listitem><para><emphasis>usbgadget:</emphasis> Include USB - Gadget Device support (for USB networking/serial/storage). - </para></listitem> - <listitem><para><emphasis>usbhost:</emphasis> Include USB Host - support (allows to connect external keyboard, mouse, - storage, network etc).</para></listitem> - <listitem><para><emphasis>wayland:</emphasis> Include the - Wayland display server protocol and the library that - supports it.</para></listitem> - <listitem><para><emphasis>wifi:</emphasis> Include WiFi support - (integrated only).</para></listitem> - <listitem><para><emphasis>x11:</emphasis> Include the X server - and libraries.</para></listitem> - </itemizedlist> - </para> - </section> - - <section id='ref-features-image'> - <title>Image Features</title> - - <para> - The contents of images generated by the OpenEmbedded build system - can be controlled by the - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> - and - <link linkend='var-EXTRA_IMAGE_FEATURES'><filename>EXTRA_IMAGE_FEATURES</filename></link> - variables that you typically configure in your image recipes. - Through these variables, you can add several different - predefined packages such as development utilities or packages with - debug information needed to investigate application problems or - profile applications. - </para> - - <para> - The following image features are available for all images: - <itemizedlist> - <listitem><para><emphasis>allow-empty-password:</emphasis> - Allows Dropbear and OpenSSH to accept root logins - and logins from accounts having an empty password string. - </para></listitem> - <listitem><para><emphasis>dbg-pkgs:</emphasis> - Installs debug symbol packages for all packages installed - in a given image. - </para></listitem> - <listitem><para><emphasis>debug-tweaks:</emphasis> - Makes an image suitable for development (e.g. - allows root logins without passwords and enables - post-installation logging). - See the 'allow-empty-password', 'empty-root-password', - and 'post-install-logging' features in this list for - additional information. - </para></listitem> - <listitem><para><emphasis>dev-pkgs:</emphasis> - Installs development packages (headers and extra library - links) for all packages installed in a given image. - </para></listitem> - <listitem><para><emphasis>doc-pkgs:</emphasis> Installs - documentation packages for all packages installed in a - given image. - </para></listitem> - <listitem><para><emphasis>empty-root-password:</emphasis> - Sets the root password to an empty string, which allows - logins with a blank password. - </para></listitem> - <listitem><para><emphasis>package-management:</emphasis> - Installs package management tools and preserves the package - manager database. - </para></listitem> - <listitem><para><emphasis>post-install-logging:</emphasis> - Enables logging postinstall script runs to - the <filename>/var/log/postinstall.log</filename> file - on first boot of the image on the target system. - <note> - To make the <filename>/var/log</filename> directory - on the target persistent, use the - <link linkend='var-VOLATILE_LOG_DIR'><filename>VOLATILE_LOG_DIR</filename></link> - variable by setting it to "no". - </note> - </para></listitem> - <listitem><para><emphasis>ptest-pkgs:</emphasis> - Installs ptest packages for all ptest-enabled recipes. - </para></listitem> - <listitem><para><emphasis>read-only-rootfs:</emphasis> - Creates an image whose root filesystem is read-only. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" - section in the Yocto Project Development Tasks Manual for - more information. - </para></listitem> - <listitem><para><emphasis>splash:</emphasis> - Enables showing a splash screen during boot. - By default, this screen is provided by - <filename>psplash</filename>, which does allow - customization. - If you prefer to use an alternative splash screen package, - you can do so by setting the <filename>SPLASH</filename> - variable to a different package name (or names) within the - image recipe or at the distro configuration level. - </para></listitem> - <listitem><para><emphasis>staticdev-pkgs:</emphasis> - Installs static development packages, which are - static libraries (i.e. <filename>*.a</filename> files), for - all packages installed in a given image. - </para></listitem> - </itemizedlist> - </para> - - <para> - Some image features are available only when you inherit the - <link linkend='ref-classes-core-image'><filename>core-image</filename></link> - class. - The current list of these valid features is as follows: - <itemizedlist> - <listitem><para><emphasis>eclipse-debug:</emphasis> Provides - Eclipse remote debugging support. - </para></listitem> - <listitem><para><emphasis>hwcodecs:</emphasis> Installs - hardware acceleration codecs. - </para></listitem> - <listitem><para><emphasis>nfs-server:</emphasis> - Installs an NFS server. - </para></listitem> - <listitem><para><emphasis>perf:</emphasis> - Installs profiling tools such as - <filename>perf</filename>, <filename>systemtap</filename>, - and <filename>LTTng</filename>. - For general information on user-space tools, see the - <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> - manual. - </para></listitem> - <listitem><para><emphasis>ssh-server-dropbear:</emphasis> - Installs the Dropbear minimal SSH server. - </para></listitem> - <listitem><para><emphasis>ssh-server-openssh:</emphasis> - Installs the OpenSSH SSH server, which is more - full-featured than Dropbear. - Note that if both the OpenSSH SSH server and the Dropbear - minimal SSH server are present in - <filename>IMAGE_FEATURES</filename>, then OpenSSH will take - precedence and Dropbear will not be installed. - </para></listitem> - <listitem><para><emphasis>tools-debug:</emphasis> - Installs debugging tools such as - <filename>strace</filename> and <filename>gdb</filename>. - For information on GDB, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" - section in the Yocto Project Development Tasks Manual. - For information on tracing and profiling, see the - <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>. - </para></listitem> - <listitem><para><emphasis>tools-sdk:</emphasis> - Installs a full SDK that runs on the device. - </para></listitem> - <listitem><para><emphasis>tools-testapps:</emphasis> - Installs device testing tools (e.g. touchscreen debugging). - </para></listitem> - <listitem><para><emphasis>x11:</emphasis> - Installs the X server. - </para></listitem> - <listitem><para><emphasis>x11-base:</emphasis> - Installs the X server with a minimal environment. - </para></listitem> - <listitem><para><emphasis>x11-sato:</emphasis> - Installs the OpenedHand Sato environment. - </para></listitem> - </itemizedlist> - </para> - - </section> - - <section id='ref-features-backfill'> - <title>Feature Backfilling</title> - - <para> - Sometimes it is necessary in the OpenEmbedded build system to extend - <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> - or <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - to control functionality that was previously enabled and not able - to be disabled. - For these cases, we need to add an - additional feature item to appear in one of these variables, - but we do not want to force developers who have existing values - of the variables in their configuration to add the new feature - in order to retain the same overall level of functionality. - Thus, the OpenEmbedded build system has a mechanism to - automatically "backfill" these added features into existing - distro or machine configurations. - You can see the list of features for which this is done by - finding the - <link linkend='var-DISTRO_FEATURES_BACKFILL'><filename>DISTRO_FEATURES_BACKFILL</filename></link> - and <link linkend='var-MACHINE_FEATURES_BACKFILL'><filename>MACHINE_FEATURES_BACKFILL</filename></link> - variables in the <filename>meta/conf/bitbake.conf</filename> file. - </para> - - <para> - Because such features are backfilled by default into all - configurations as described in the previous paragraph, developers - who wish to disable the new features need to be able to selectively - prevent the backfilling from occurring. - They can do this by adding the undesired feature or features to the - <link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename></link> - or <link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename></link> - variables for distro features and machine features respectively. - </para> - - <para> - Here are two examples to help illustrate feature backfilling: - <itemizedlist> - <listitem><para><emphasis>The "pulseaudio" distro feature option</emphasis>: - Previously, PulseAudio support was enabled within the Qt and - GStreamer frameworks. - Because of this, the feature is backfilled and thus - enabled for all distros through the - <filename>DISTRO_FEATURES_BACKFILL</filename> - variable in the <filename>meta/conf/bitbake.conf</filename> file. - However, your distro needs to disable the feature. - You can disable the feature without affecting - other existing distro configurations that need PulseAudio support - by adding "pulseaudio" to - <filename>DISTRO_FEATURES_BACKFILL_CONSIDERED</filename> - in your distro's <filename>.conf</filename> file. - Adding the feature to this variable when it also - exists in the <filename>DISTRO_FEATURES_BACKFILL</filename> - variable prevents the build system from adding the feature to - your configuration's <filename>DISTRO_FEATURES</filename>, effectively disabling - the feature for that particular distro.</para></listitem> - <listitem><para><emphasis>The "rtc" machine feature option</emphasis>: - Previously, real time clock (RTC) support was enabled for all - target devices. - Because of this, the feature is backfilled and thus enabled - for all machines through the <filename>MACHINE_FEATURES_BACKFILL</filename> - variable in the <filename>meta/conf/bitbake.conf</filename> file. - However, your target device does not have this capability. - You can disable RTC support for your device without - affecting other machines that need RTC support - by adding the feature to your machine's - <filename>MACHINE_FEATURES_BACKFILL_CONSIDERED</filename> - list in the machine's <filename>.conf</filename> file. - Adding the feature to this variable when it also - exists in the <filename>MACHINE_FEATURES_BACKFILL</filename> - variable prevents the build system from adding the feature to - your configuration's <filename>MACHINE_FEATURES</filename>, effectively - disabling RTC support for that particular machine.</para></listitem> - </itemizedlist> - </para> - </section> -</chapter> - -<!-- -vim: expandtab tw=80 ts=4 spell spelllang=en_gb ---> diff --git a/documentation/ref-manual/ref-images.xml b/documentation/ref-manual/ref-images.xml deleted file mode 100644 index 1f96186c6e..0000000000 --- a/documentation/ref-manual/ref-images.xml +++ /dev/null @@ -1,169 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-images'> - <title>Images</title> - - <para> - The OpenEmbedded build system provides several example - images to satisfy different needs. - When you issue the <filename>bitbake</filename> command you provide a “top-level” recipe - that essentially begins the build for the type of image you want. - </para> - - <note> - Building an image without GNU General Public License Version 3 (GPLv3), - GNU Lesser General Public License Version 3 (LGPLv3), and the - GNU Affero General Public License Version 3 (AGPL-3.0) components - is only supported for minimal and base images. - Furthermore, if you are going to build an image using non-GPLv3 and - similarly licensed components, you must make the following changes in - the <filename>local.conf</filename> file before using the BitBake - command to build the minimal or base image: - <literallayout class='monospaced'> - 1. Comment out the EXTRA_IMAGE_FEATURES line - 2. Set INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" - </literallayout> - </note> - - <para> - From within the <filename>poky</filename> Git repository, you can use - the following command to display the list of directories within the - <link linkend='source-directory'>Source Directory</link> - that contain image recipe files: - <literallayout class='monospaced'> - $ ls meta*/recipes*/images/*.bb - </literallayout> - </para> - - <para> - Following is a list of supported recipes: - <itemizedlist> - <listitem><para> - <filename>build-appliance-image</filename>: - An example virtual machine that contains all the pieces - required to run builds using the build system as well as the - build system itself. - You can boot and run the image using either the - <ulink url='http://www.vmware.com/products/player/overview.html'>VMware Player</ulink> - or - <ulink url='http://www.vmware.com/products/workstation/overview.html'>VMware Workstation</ulink>. - For more information on this image, see the - <ulink url='&YOCTO_HOME_URL;/software-item/build-appliance/'>Build Appliance</ulink> - page on the Yocto Project website. - </para></listitem> - <listitem><para><filename>core-image-base</filename>: - A console-only image that fully supports the target device hardware.</para></listitem> - <listitem><para><filename>core-image-clutter</filename>: - An image with support for the Open GL-based toolkit Clutter, which enables development of - rich and animated graphical user interfaces.</para></listitem> - <listitem><para><filename>core-image-full-cmdline</filename>: - A console-only image with more full-featured Linux system - functionality installed.</para></listitem> - <listitem><para><filename>core-image-lsb</filename>: - An image that conforms to the Linux Standard Base (LSB) - specification. - This image requires a distribution configuration that - enables LSB compliance (e.g. <filename>poky-lsb</filename>). - If you build <filename>core-image-lsb</filename> without that - configuration, the image will not be LSB-compliant. - </para></listitem> - <listitem><para><filename>core-image-lsb-dev</filename>: - A <filename>core-image-lsb</filename> image that is suitable for development work - using the host. - The image includes headers and libraries you can use in a host development - environment. - This image requires a distribution configuration that - enables LSB compliance (e.g. <filename>poky-lsb</filename>). - If you build <filename>core-image-lsb-dev</filename> without that - configuration, the image will not be LSB-compliant. - </para></listitem> - <listitem><para><filename>core-image-lsb-sdk</filename>: - A <filename>core-image-lsb</filename> that includes everything in - the cross-toolchain but also includes development headers and libraries - to form a complete standalone SDK. - This image requires a distribution configuration that - enables LSB compliance (e.g. <filename>poky-lsb</filename>). - If you build <filename>core-image-lsb-sdk</filename> without that - configuration, the image will not be LSB-compliant. - This image is suitable for development using the target.</para></listitem> - <listitem><para><filename>core-image-minimal</filename>: - A small image just capable of allowing a device to boot.</para></listitem> - <listitem><para><filename>core-image-minimal-dev</filename>: - A <filename>core-image-minimal</filename> image suitable for development work - using the host. - The image includes headers and libraries you can use in a host development - environment. - </para></listitem> - <listitem><para id='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename>: - A <filename>core-image-minimal</filename> image that has the Minimal RAM-based - Initial Root Filesystem (initramfs) as part of the kernel, - which allows the system to find the first “init” program more efficiently. - See the - <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link> - variable for additional information helpful when working with - initramfs images. - </para></listitem> - <listitem><para><filename>core-image-minimal-mtdutils</filename>: - A <filename>core-image-minimal</filename> image that has support - for the Minimal MTD Utilities, which let the user interact with the - MTD subsystem in the kernel to perform operations on flash devices. - </para></listitem> - <listitem><para><filename>core-image-rt</filename>: - A <filename>core-image-minimal</filename> image plus a real-time test suite and - tools appropriate for real-time use.</para></listitem> - <listitem><para><filename>core-image-rt-sdk</filename>: - A <filename>core-image-rt</filename> image that includes everything in - the cross-toolchain. - The image also includes development headers and libraries to form a complete - stand-alone SDK and is suitable for development using the target. - </para></listitem> - <listitem><para><filename>core-image-sato</filename>: - An image with Sato support, a mobile environment and visual style that works well - with mobile devices. - The image supports X11 with a Sato theme and applications such as - a terminal, editor, file manager, media player, and so forth. - </para></listitem> - <listitem><para><filename>core-image-sato-dev</filename>: - A <filename>core-image-sato</filename> image suitable for development - using the host. - The image includes libraries needed to build applications on the device itself, - testing and profiling tools, and debug symbols. - This image was formerly <filename>core-image-sdk</filename>. - </para></listitem> - <listitem><para><filename>core-image-sato-sdk</filename>: - A <filename>core-image-sato</filename> image that includes everything in - the cross-toolchain. - The image also includes development headers and libraries to form a complete standalone SDK - and is suitable for development using the target.</para></listitem> - <listitem><para><filename>core-image-testmaster</filename>: - A "master" image designed to be used for automated runtime testing. - Provides a "known good" image that is deployed to a separate - partition so that you can boot into it and use it to deploy a - second image to be tested. - You can find more information about runtime testing in the - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual. - </para></listitem> - <listitem><para><filename>core-image-testmaster-initramfs</filename>: - A RAM-based Initial Root Filesystem (initramfs) image tailored for - use with the <filename>core-image-testmaster</filename> image. - </para></listitem> - <listitem><para><filename>core-image-weston</filename>: - A very basic Wayland image with a terminal. - This image provides the Wayland protocol libraries and the - reference Weston compositor. - For more information, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-using-wayland-and-weston'>Using Wayland and Weston</ulink>" - section in the Yocto Project Development Tasks Manual. - </para></listitem> - <listitem><para><filename>core-image-x11</filename>: - A very basic X11 image with a terminal. - </para></listitem> - </itemizedlist> - </para> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-kickstart.xml b/documentation/ref-manual/ref-kickstart.xml deleted file mode 100644 index a58f9d7c96..0000000000 --- a/documentation/ref-manual/ref-kickstart.xml +++ /dev/null @@ -1,334 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-kickstart'> -<title>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</title> - - <section id='openembedded-kickstart-wks-reference'> - <title>Introduction</title> - - <para> - The current Wic implementation supports only the basic kickstart - partitioning commands: - <filename>partition</filename> (or <filename>part</filename> - for short) and <filename>bootloader</filename>. - <note> - Future updates will implement more commands and options. - If you use anything that is not specifically supported, results - can be unpredictable. - </note> - </para> - - <para> - 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: - <literallayout class='monospaced'> - <ulink url='http://pykickstart.readthedocs.io/en/latest/kickstart-docs.html'>http://pykickstart.readthedocs.io/en/latest/kickstart-docs.html</ulink> - </literallayout> - </para> - </section> - - <section id='command-part-or-partition'> - <title>Command: part or partition</title> - - <para> - Either of these commands creates a partition on the system and uses - the following syntax: - <literallayout class='monospaced'> - part [<replaceable>mntpoint</replaceable>] - partition [<replaceable>mntpoint</replaceable>] - </literallayout> - If you do not provide <replaceable>mntpoint</replaceable>, Wic - creates a partition but does not mount it. - </para> - - <para> - The <filename><replaceable>mntpoint</replaceable></filename> is - where the partition is mounted and must be in one of the - following forms: - <itemizedlist> - <listitem><para> - <filename>/<replaceable>path</replaceable></filename>: - For example, "/", "/usr", or "/home" - </para></listitem> - <listitem><para> - <filename>swap</filename>: - The created partition is used as swap space - </para></listitem> - </itemizedlist> - </para> - - <para> - Specifying a <replaceable>mntpoint</replaceable> 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 <filename>--ondrive</filename>, - <filename>--ondisk</filename>, or - <filename>--use-uuid</filename> partition options as part of the - command. - <note> - The mount program must understand the PARTUUID syntax you use - with <filename>--use-uuid</filename> and non-root - <replaceable>mountpoint</replaceable>, including swap. - The busybox versions of these application are currently - excluded. - </note> - Here is an example that uses "/" as the - <replaceable>mountpoint</replaceable>. - The command uses <filename>--ondisk</filename> to force the - partition onto the - <filename>sdb</filename> disk: - <literallayout class='monospaced'> - part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 - </literallayout> - </para> - - <para> - Here is a list that describes other supported options you can use - with the <filename>part</filename> and - <filename>partition</filename> commands: - <itemizedlist> - <listitem><para> - <emphasis><filename>--size</filename>:</emphasis> - 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 - <filename>--source</filename>. - </para></listitem> - <listitem><para> - <emphasis><filename>--fixed-size</filename>:</emphasis> - The exact partition size in MBytes. - You cannot specify with <filename>--size</filename>. - An error occurs when assembling the disk image if the - partition data is larger than - <filename>--fixed-size</filename>. - </para></listitem> - <listitem><para> - <emphasis><filename>--source</filename>:</emphasis> - 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 plug-in. - For information on the source plug-ins, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#wic-using-the-wic-plug-ins-interface'>Using the Wic Plug-Ins Interface</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - - <para>If you use <filename>--source rootfs</filename>, Wic - creates a partition as large as needed and fills it with - the contents of the root filesystem pointed to by the - <filename>-r</filename> command-line option or the - equivalent rootfs derived from the <filename>-e</filename> - command-line option. - The filesystem type used to create the partition is driven - by the value of the <filename>--fstype</filename> option - specified for the partition. - See the entry on <filename>--fstype</filename> that follows - for more information.</para> - - <para>If you use - <filename>--source <replaceable>plugin-name</replaceable></filename>, - Wic creates a partition as large as needed and fills it - with the contents of the partition that is generated by the - specified plug-in name using the data pointed to by the - <filename>-r</filename> command-line option or the - equivalent rootfs derived from the <filename>-e</filename> - command-line option. - Exactly what those contents are and filesystem type used are - dependent on the given plug-in implementation. - </para> - - <para>If you do not use the <filename>--source</filename> - option, the <filename>wic</filename> command creates an - empty partition. - Consequently, you must use the <filename>--size</filename> - option to specify the size of the empty partition. - </para></listitem> - <listitem><para> - <emphasis><filename>--ondisk</filename> or <filename>--ondrive</filename>:</emphasis> - Forces the partition to be created on a particular disk. - </para></listitem> - <listitem><para> - <emphasis><filename>--fstype</filename>:</emphasis> - Sets the file system type for the partition. - Valid values are: - <itemizedlist> - <listitem><para> - <filename>ext4</filename> - </para></listitem> - <listitem><para> - <filename>ext3</filename> - </para></listitem> - <listitem><para> - <filename>ext2</filename> - </para></listitem> - <listitem><para> - <filename>btrfs</filename> - </para></listitem> - <listitem><para> - <filename>squashfs</filename> - </para></listitem> - <listitem><para> - <filename>swap</filename> - </para></listitem> - </itemizedlist> - </para></listitem> - <listitem><para> - <emphasis><filename>--fsoptions</filename>:</emphasis> - Specifies a free-form string of options to be used when - mounting the filesystem. - This string is copied into the - <filename>/etc/fstab</filename> file of the installed - system and should be enclosed in quotes. - If not specified, the default string is "defaults". - </para></listitem> - <listitem><para> - <emphasis><filename>--label label</filename>:</emphasis> - 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. - </para></listitem> - <listitem><para> - <emphasis><filename>--active</filename>:</emphasis> - Marks the partition as active. - </para></listitem> - <listitem><para> - <emphasis><filename>--align (in KBytes)</filename>:</emphasis> - This option is a Wic-specific option that says to start - partitions on boundaries given - <replaceable>x</replaceable> KBytes. - </para></listitem> - <listitem><para> - <emphasis><filename>--no-table</filename>:</emphasis> - 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. - </para></listitem> - <listitem><para> - <emphasis><filename>--exclude-path</filename>:</emphasis> - 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 - plug-in. - </para></listitem> - <listitem><para> - <emphasis><filename>--extra-space</filename>:</emphasis> - 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 - <filename>--size</filename> option. - The default value is 10 Mbytes. - </para></listitem> - <listitem><para> - <emphasis><filename>--overhead-factor</filename>:</emphasis> - 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". - </para></listitem> - <listitem><para> - <emphasis><filename>--part-name</filename>:</emphasis> - This option is a Wic-specific option that specifies a name - for GPT partitions. - </para></listitem> - <listitem><para> - <emphasis><filename>--part-type</filename>:</emphasis> - 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 - <ulink url='http://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs'></ulink>. - </para></listitem> - <listitem><para> - <emphasis><filename>--use-uuid</filename>:</emphasis> - 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. - </para></listitem> - <listitem><para> - <emphasis><filename>--uuid</filename>:</emphasis> - This option is a Wic-specific option that specifies the - partition UUID. - </para></listitem> - <listitem><para> - <emphasis><filename>--fsuuid</filename>:</emphasis> - This option is a Wic-specific option that specifies the - filesystem UUID. - You can generate or modify - <link linkend='var-WKS_FILE'><filename>WKS_FILE</filename></link> - with this option if a preconfigured filesystem UUID is - added to the kernel command line in the bootloader - configuration before you run Wic. - </para></listitem> - <listitem><para> - <emphasis><filename>--system-id</filename>:</emphasis> - 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. - </para></listitem> - <listitem><para> - <emphasis><filename>--mkfs-extraopts</filename>:</emphasis> - This option specifies additional options to pass to the - <filename>mkfs</filename> utility. - Some default options for certain filesystems do not take - effect. - See Wic's help on kickstart - (i.e. <filename>wic help kickstart</filename>). - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='command-bootloader'> - <title>Command: bootloader</title> - - <para> - 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 <filename>--source</filename> plug-ins that - implement bootloader functionality. - The bootloader command essentially provides a means of - modifying bootloader configuration. - </note> - <itemizedlist> - <listitem><para> - <emphasis><filename>--timeout</filename>:</emphasis> - Specifies the number of seconds before the bootloader times - out and boots the default option. - </para></listitem> - <listitem><para> - <emphasis><filename>--append</filename>:</emphasis> - Specifies kernel parameters. - These parameters will be added to the syslinux - <filename>APPEND</filename> or <filename>grub</filename> - kernel command line. - </para></listitem> - <listitem><para> - <emphasis><filename>--configfile</filename>:</emphasis> - 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 <filename>canned-wks</filename> folder. - This option overrides all other bootloader options. - </para></listitem> - </itemizedlist> - </para> - </section> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-manual-customization.xsl b/documentation/ref-manual/ref-manual-customization.xsl deleted file mode 100644 index c58dd905b9..0000000000 --- a/documentation/ref-manual/ref-manual-customization.xsl +++ /dev/null @@ -1,29 +0,0 @@ -<?xml version='1.0'?> -<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns="http://www.w3.org/1999/xhtml" xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - - <xsl:import href="http://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-xsl-1.76.1/xhtml/docbook.xsl" /> - -<!-- - - <xsl:import href="../template/1.76.1/docbook-xsl-1.76.1/xhtml/docbook.xsl" /> - - <xsl:import href="http://docbook.sourceforge.net/release/xsl/1.76.1/xhtml/docbook.xsl" /> - ---> - - <xsl:include href="../template/permalinks.xsl"/> - <xsl:include href="../template/section.title.xsl"/> - <xsl:include href="../template/component.title.xsl"/> - <xsl:include href="../template/division.title.xsl"/> - <xsl:include href="../template/formal.object.heading.xsl"/> - <xsl:include href="../template/gloss-permalinks.xsl"/> - <xsl:include href="../template/qa-code-permalinks.xsl"/> - - <xsl:param name="html.stylesheet" select="'ref-style.css'" /> - <xsl:param name="chapter.autolabel" select="1" /> - <xsl:param name="appendix.autolabel" select="A" /> - <xsl:param name="section.autolabel" select="1" /> - <xsl:param name="section.label.includes.component.label" select="1" /> - <xsl:param name="generate.id.attributes" select="1" /> - -</xsl:stylesheet> diff --git a/documentation/ref-manual/ref-manual-eclipse-customization.xsl b/documentation/ref-manual/ref-manual-eclipse-customization.xsl deleted file mode 100644 index f3b7521552..0000000000 --- a/documentation/ref-manual/ref-manual-eclipse-customization.xsl +++ /dev/null @@ -1,35 +0,0 @@ -<?xml version='1.0'?> -<xsl:stylesheet - xmlns:xsl="http://www.w3.org/1999/XSL/Transform" - xmlns="http://www.w3.org/1999/xhtml" - xmlns:fo="http://www.w3.org/1999/XSL/Format" - version="1.0"> - - <xsl:import href="http://downloads.yoctoproject.org/mirror/docbook-mirror/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" /> - -<!-- - - <xsl:import href="../template/1.76.1/docbook-xsl-1.76.1/eclipse/eclipse3.xsl" /> - - <xsl:import - href="http://docbook.sourceforge.net/release/xsl/1.76.1/eclipse/eclipse3.xsl" /> - ---> - - <xsl:param name="chunker.output.indent" select="'yes'"/> - <xsl:param name="chunk.quietly" select="1"/> - <xsl:param name="chunk.first.sections" select="1"/> - <xsl:param name="chunk.section.depth" select="10"/> - <xsl:param name="use.id.as.filename" select="1"/> - <xsl:param name="ulink.target" select="'_self'" /> - <xsl:param name="base.dir" select="'html/ref-manual/'"/> - <xsl:param name="html.stylesheet" select="'../book.css'"/> - <xsl:param name="eclipse.manifest" select="0"/> - <xsl:param name="create.plugin.xml" select="0"/> - <xsl:param name="suppress.navigation" select="1"/> - <xsl:param name="generate.index" select="0"/> - <xsl:param name="chapter.autolabel" select="1" /> - <xsl:param name="appendix.autolabel">A</xsl:param> - <xsl:param name="section.autolabel" select="1" /> - <xsl:param name="section.label.includes.component.label" select="1" /> -</xsl:stylesheet> diff --git a/documentation/ref-manual/ref-manual.xml b/documentation/ref-manual/ref-manual.xml deleted file mode 100644 index 26295f02f6..0000000000 --- a/documentation/ref-manual/ref-manual.xml +++ /dev/null @@ -1,231 +0,0 @@ -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<book id='ref-manual' lang='en' - xmlns:xi="http://www.w3.org/2003/XInclude" - xmlns="http://docbook.org/ns/docbook" - > - <bookinfo> - - <mediaobject> - <imageobject> - <imagedata fileref='figures/poky-title.png' - format='SVG' - align='left' scalefit='1' width='100%'/> - </imageobject> - </mediaobject> - - <title> - Yocto Project Reference Manual - </title> - - <authorgroup> - <author> - <firstname>Scott</firstname> <surname>Rifenbark</surname> - <affiliation> - <orgname>Scotty's Documentation Services, INC</orgname> - </affiliation> - <email>srifenbark@gmail.com</email> - </author> - - </authorgroup> - - <revhistory> - <revision> - <revnumber>4.0+git</revnumber> - <date>24 November 2010</date> - <revremark>Released with the Yocto Project 0.9 Release</revremark> - </revision> - <revision> - <revnumber>1.0</revnumber> - <date>6 April 2011</date> - <revremark>Released with the Yocto Project 1.0 Release.</revremark> - </revision> - <revision> - <revnumber>1.0.1</revnumber> - <date>23 May 2011</date> - <revremark>Released with the Yocto Project 1.0.1 Release.</revremark> - </revision> - <revision> - <revnumber>1.1</revnumber> - <date>6 October 2011</date> - <revremark>Released with the Yocto Project 1.1 Release.</revremark> - </revision> - <revision> - <revnumber>1.2</revnumber> - <date>April 2012</date> - <revremark>Released with the Yocto Project 1.2 Release.</revremark> - </revision> - <revision> - <revnumber>1.3</revnumber> - <date>October 2012</date> - <revremark>Released with the Yocto Project 1.3 Release.</revremark> - </revision> - <revision> - <revnumber>1.4</revnumber> - <date>April 2013</date> - <revremark>Released with the Yocto Project 1.4 Release.</revremark> - </revision> - <revision> - <revnumber>1.5</revnumber> - <date>October 2013</date> - <revremark>Released with the Yocto Project 1.5 Release.</revremark> - </revision> - <revision> - <revnumber>1.5.1</revnumber> - <date>January 2014</date> - <revremark>Released with the Yocto Project 1.5.1 Release.</revremark> - </revision> - <revision> - <revnumber>1.6</revnumber> - <date>April 2014</date> - <revremark>Released with the Yocto Project 1.6 Release.</revremark> - </revision> - <revision> - <revnumber>1.7</revnumber> - <date>October 2014</date> - <revremark>Released with the Yocto Project 1.7 Release.</revremark> - </revision> - <revision> - <revnumber>1.8</revnumber> - <date>April 2015</date> - <revremark>Released with the Yocto Project 1.8 Release.</revremark> - </revision> - <revision> - <revnumber>2.0</revnumber> - <date>October 2015</date> - <revremark>Released with the Yocto Project 2.0 Release.</revremark> - </revision> - <revision> - <revnumber>2.1</revnumber> - <date>April 2016</date> - <revremark>Released with the Yocto Project 2.1 Release.</revremark> - </revision> - <revision> - <revnumber>2.2</revnumber> - <date>October 2016</date> - <revremark>Released with the Yocto Project 2.2 Release.</revremark> - </revision> - <revision> - <revnumber>2.3</revnumber> - <date>May 2017</date> - <revremark>Released with the Yocto Project 2.3 Release.</revremark> - </revision> - <revision> - <revnumber>2.4</revnumber> - <date>October 2017</date> - <revremark>Released with the Yocto Project 2.4 Release.</revremark> - </revision> - <revision> - <revnumber>2.5</revnumber> - <date>May 2018</date> - <revremark>Released with the Yocto Project 2.5 Release.</revremark> - </revision> - <revision> - <revnumber>2.6</revnumber> - <date>November 2018</date> - <revremark>Released with the Yocto Project 2.6 Release.</revremark> - </revision> - <revision> - <revnumber>2.7</revnumber> - <date>&REL_MONTH_YEAR;</date> - <revremark>Released with the Yocto Project 2.7 Release.</revremark> - </revision> - </revhistory> - - <copyright> - <year>©RIGHT_YEAR;</year> - <holder>Linux Foundation</holder> - </copyright> - - <legalnotice> - <para> - Permission is granted to copy, distribute and/or modify this document under - the terms of the <ulink type="http" url="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England & Wales</ulink> as published by Creative Commons. - </para> - <note><title>Manual Notes</title> - <itemizedlist> - <listitem><para> - This version of the - <emphasis>Yocto Project Reference Manual</emphasis> - is for the &YOCTO_DOC_VERSION; release of the - Yocto Project. - To be sure you have the latest version of the manual - for this release, go to the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> - and select the manual from that site. - Manuals from the site are more up-to-date than manuals - derived from the Yocto Project released TAR files. - </para></listitem> - <listitem><para> - If you located this manual through a web search, the - version of the manual might not be the one you want - (e.g. the search might have returned a manual much - older than the Yocto Project version with which you - are working). - You can see all Yocto Project major releases by - visiting the - <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink> - page. - If you need a version of this manual for a different - Yocto Project release, visit the - <ulink url='&YOCTO_HOME_URL;/documentation'>Yocto Project documentation page</ulink> - and select the manual set by using the - "ACTIVE RELEASES DOCUMENTATION" or "DOCUMENTS ARCHIVE" - pull-down menus. - </para></listitem> - <listitem><para> - To report any inaccuracies or problems with this - manual, send an email to the Yocto Project - discussion group at - <filename>yocto@yoctoproject.com</filename> or log into - the freenode <filename>#yocto</filename> channel. - </para></listitem> - </itemizedlist> - </note> - </legalnotice> - - </bookinfo> - - <xi:include href="ref-system-requirements.xml"/> - - <xi:include href="ref-terms.xml"/> - - <xi:include href="ref-release-process.xml"/> - - <xi:include href="migration.xml"/> - - <xi:include href="ref-structure.xml"/> - - <xi:include href="ref-classes.xml"/> - - <xi:include href="ref-tasks.xml"/> - - <xi:include href="ref-devtool-reference.xml"/> - - <xi:include href="ref-kickstart.xml"/> - - <xi:include href="ref-qa-checks.xml"/> - - <xi:include href="ref-images.xml"/> - - <xi:include href="ref-features.xml"/> - - <xi:include href="ref-variables.xml"/> - - <xi:include href="ref-varlocality.xml"/> - - <xi:include href="faq.xml"/> - - <xi:include href="resources.xml"/> - -<!-- <index id='index'> - <title>Index</title> - </index> ---> - -</book> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-qa-checks.xml b/documentation/ref-manual/ref-qa-checks.xml deleted file mode 100644 index 515106ae68..0000000000 --- a/documentation/ref-manual/ref-qa-checks.xml +++ /dev/null @@ -1,1199 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-qa-checks'> -<title>QA Error and Warning Messages</title> - -<section id='qa-introduction'> - <title>Introduction</title> - - <para> - When building a recipe, the OpenEmbedded build system performs - various QA checks on the output to ensure that common issues are - detected and reported. - Sometimes when you create a new recipe to build new software, - it will build with no problems. - When this is not the case, or when you have QA issues building any - software, it could take a little time to resolve them. - </para> - - <para> - While it is tempting to ignore a QA message or even to - disable QA checks, it is best to try and resolve any - reported QA issues. - This chapter provides a list of the QA messages and brief explanations - of the issues you could encounter so that you can properly resolve - problems. - </para> - - <para> - The next section provides a list of all QA error and warning - messages based on a default configuration. - Each entry provides the message or error form along with an - explanation. - <note> - <title>Notes</title> - <itemizedlist> - <listitem><para> - At the end of each message, the name of the associated - QA test (as listed in the - "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" - section) appears within square brackets. - </para></listitem> - <listitem><para> - As mentioned, this list of error and warning messages is for - QA checks only. - The list does not cover all possible build errors or - warnings you could encounter. - </para></listitem> - <listitem><para> - Because some QA checks are disabled by default, this list - does not include all possible QA check errors and warnings. - </para></listitem> - </itemizedlist> - </note> - </para> -</section> - -<section id='qa-errors-and-warnings'> - <title>Errors and Warnings</title> - -<!-- -This section uses the <para><code> construct to enable permalinks for the -various QA issue and warning messages. The file templates/qa-code-permalinks.xsl -is used to locate the construct and generate the permalink. This solution -leverages the fact that right now this section in the ref-manual is the only -place is all the YP docs that uses the <para><code> construct. If, in the -future, that construct were to appear in the ref-manual, a generic permalink -would be generated for the text between <code></code>. If a better solution -can be found then it should be implemented. I can't find one at the moment. ---> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-libexec'> - <code> - <packagename>: <path> is using libexec please relocate to <libexecdir> [libexec] - </code> - </para> - - <para> - The specified package contains files in - <filename>/usr/libexec</filename> when the distro - configuration uses a different path for - <filename><libexecdir></filename> - By default, <filename><libexecdir></filename> is - <filename>$prefix/libexec</filename>. - However, this default can be changed (e.g. - <filename>${libdir}</filename>). - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-rpaths'> - <code> - package <packagename> contains bad RPATH <rpath> in file <file> [rpaths] - </code> - </para> - - <para> - The specified binary produced by the recipe contains dynamic - library load paths (rpaths) that contain build system paths - such as - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>, - which are incorrect for the target and could potentially - be a security issue. - Check for bad <filename>-rpath</filename> options being - passed to the linker in your - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - log. - Depending on the build system used by the software being - built, there might be a configure option to disable rpath - usage completely within the build of the software. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-useless-rpaths'> - <code> - <packagename>: <file> contains probably-redundant RPATH <rpath> [useless-rpaths] - </code> - </para> - - <para> - The specified binary produced by the recipe contains dynamic - library load paths (rpaths) that on a standard system are - searched by default by the linker (e.g. - <filename>/lib</filename> and <filename>/usr/lib</filename>). - While these paths will not cause any breakage, they do waste - space and are unnecessary. - Depending on the build system used by the software being - built, there might be a configure option to disable rpath - usage completely within the build of the software. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-file-rdeps'> - <code> - <packagename> requires <files>, but no providers in its RDEPENDS [file-rdeps] - </code> - </para> - - <para> - A file-level dependency has been identified from the - specified package on the specified files, but there is - no explicit corresponding entry in - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>. - If particular files are required at runtime then - <filename>RDEPENDS</filename> should be declared in the - recipe to ensure the packages providing them are built. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-build-deps'> - <code> - <packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps] - </code> - </para> - - <para> - A runtime dependency exists between the two specified - packages, but there is nothing explicit within the recipe - to enable the OpenEmbedded build system to ensure that - dependency is satisfied. - This condition is usually triggered by an - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> - value being added at the packaging stage rather than up - front, which is usually automatic based on the contents of - the package. - In most cases, you should change the recipe to add an - explicit <filename>RDEPENDS</filename> for the dependency. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-dev-so'> - <code> - non -dev/-dbg/nativesdk- package contains symlink .so: <packagename> path '<path>' [dev-so] - </code> - </para> - - <para> - Symlink <filename>.so</filename> files are for development - only, and should therefore go into the - <filename>-dev</filename> package. - This situation might occur if you add - <filename>*.so*</filename> rather than - <filename>*.so.*</filename> to a non-dev package. - Change - <link linkend='var-FILES'><filename>FILES</filename></link> - (and possibly - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>) - such that the specified <filename>.so</filename> file goes - into an appropriate <filename>-dev</filename> package. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-staticdev'> - <code> - non -staticdev package contains static .a library: <packagename> path '<path>' [staticdev] - </code> - </para> - - <para> - Static <filename>.a</filename> library files should go into - a <filename>-staticdev</filename> package. - Change - <link linkend='var-FILES'><filename>FILES</filename></link> - (and possibly - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>) - such that the specified <filename>.a</filename> file goes - into an appropriate <filename>-staticdev</filename> package. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-libdir'> - <code> - <packagename>: found library in wrong location [libdir] - </code> - </para> - - <para> - The specified file may have been installed into an incorrect - (possibly hardcoded) installation path. - For example, this test will catch recipes that install - <filename>/lib/bar.so</filename> when - <filename>${base_libdir}</filename> is "lib32". - Another example is when recipes install - <filename>/usr/lib64/foo.so</filename> when - <filename>${libdir}</filename> is "/usr/lib". - False positives occasionally exist. - For these cases add "libdir" to - <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link> - for the package. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-debug-files'> - <code> - non debug package contains .debug directory: <packagename> path <path> [debug-files] - </code> - </para> - - <para> - The specified package contains a - <filename>.debug</filename> directory, which should not - appear in anything but the <filename>-dbg</filename> - package. - This situation might occur if you add a path which contains - a <filename>.debug</filename> directory and do not - explicitly add the <filename>.debug</filename> directory - to the <filename>-dbg</filename> package. - If this is the case, add the <filename>.debug</filename> - directory explicitly to - <filename>FILES_${PN}-dbg</filename>. - See - <link linkend='var-FILES'><filename>FILES</filename></link> - for additional information on <filename>FILES</filename>. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-arch'> - <code> - Architecture did not match (<machine_arch> to <file_arch>) on <file> [arch] - </code> - </para> - - <para> - By default, the OpenEmbedded build system checks the - Executable and Linkable Format (ELF) type, bit size, and - endianness of any binaries to ensure they match the - target architecture. - This test fails if any binaries do not match the type since - there would be an incompatibility. - The test could indicate that the wrong compiler or compiler - options have been used. - Sometimes software, like bootloaders, might need to - bypass this check. - If the file you receive the error for is firmware - that is not intended to be executed within the target - operating system or is intended to run on a separate - processor within the device, you can add "arch" to - <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link> - for the package. - Another option is to check the - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - log and verify that the compiler options being used - are correct. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-arch-bit-size-no-match'> - <code> - Bit size did not match (<machine_bits> to <file_bits>) <recipe> on <file> [arch] - </code> - </para> - - <para> - By default, the OpenEmbedded build system checks - the Executable and Linkable Format (ELF) type, - bit size, and endianness of any binaries to ensure - they match the target architecture. - This test fails if any binaries do not match the type since - there would be an incompatibility. - The test could indicate that the wrong compiler or compiler - options have been used. - Sometimes software, like bootloaders, might need to - bypass this check. - If the file you receive the error for is firmware that - is not intended to be executed within the target - operating system or is intended to run on a separate - processor within the device, you can add "arch" to - <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link> - for the package. - Another option is to check the - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - log and verify that the compiler options being used are - correct. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-arch-endianness-no-match'> - <code> - Endianness did not match (<machine_endianness> to <file_endianness>) on <file> [arch] - </code> - </para> - - <para> - By default, the OpenEmbedded build system checks - the Executable and Linkable Format (ELF) type, bit - size, and endianness of any binaries to ensure they - match the target architecture. - This test fails if any binaries do not match the type since - there would be an incompatibility. - The test could indicate that the wrong compiler or compiler - options have been used. - Sometimes software, like bootloaders, might need to - bypass this check. - If the file you receive the error for is firmware - that is not intended to be executed within the target - operating system or is intended to run on a separate - processor within the device, you can add "arch" to - <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link> - for the package. - Another option is to check the - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - log and verify that the compiler options being used - are correct. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-textrel'> - <code> - ELF binary '<file>' has relocations in .text [textrel] - </code> - </para> - - <para> - The specified ELF binary contains relocations in its - <filename>.text</filename> sections. - This situation can result in a performance impact - at runtime. - </para> - - <para> - Typically, the way to solve this performance issue is to - add "-fPIC" or "-fpic" to the compiler command-line - options. - For example, given software that reads - <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> - when you build it, you could add the following to your - recipe: - <literallayout class='monospaced'> - CFLAGS_append = " -fPIC " - </literallayout> - </para> - - <para> - For more information on text relocations at runtime, see - <ulink url='http://www.akkadia.org/drepper/textrelocs.html'></ulink>. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-ldflags'> - <code> - No GNU_HASH in the elf binary: '<file>' [ldflags] - </code> - </para> - - <para> - This indicates that binaries produced when building the - recipe have not been linked with the - <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> - options provided by the build system. - Check to be sure that the <filename>LDFLAGS</filename> - variable is being passed to the linker command. - A common workaround for this situation is to pass in - <filename>LDFLAGS</filename> using - <link linkend='var-TARGET_CC_ARCH'><filename>TARGET_CC_ARCH</filename></link> - within the recipe as follows: - <literallayout class='monospaced'> - TARGET_CC_ARCH += "${LDFLAGS}" - </literallayout> - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-xorg-driver-abi'> - <code> - Package <packagename> contains Xorg driver (<driver>) but no xorg-abi- dependencies [xorg-driver-abi] - </code> - </para> - - <para> - The specified package contains an Xorg driver, but does not - have a corresponding ABI package dependency. - The xserver-xorg recipe provides driver ABI names. - All drivers should depend on the ABI versions that they have - been built against. - Driver recipes that include - <filename>xorg-driver-input.inc</filename> or - <filename>xorg-driver-video.inc</filename> will - automatically get these versions. - Consequently, you should only need to explicitly add - dependencies to binary driver recipes. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-infodir'> - <code> - The /usr/share/info/dir file is not meant to be shipped in a particular package. [infodir] - </code> - </para> - - <para> - The <filename>/usr/share/info/dir</filename> should not be - packaged. - Add the following line to your - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task or to your <filename>do_install_append</filename> - within the recipe as follows: - <literallayout class='monospaced'> - rm ${D}${infodir}/dir - </literallayout> - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-symlink-to-sysroot'> - <code> - Symlink <path> in <packagename> points to TMPDIR [symlink-to-sysroot] - </code> - </para> - - <para> - The specified symlink points into - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - on the host. - Such symlinks will work on the host. - However, they are clearly invalid when running on - the target. - You should either correct the symlink to use a relative - path or remove the symlink. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-la'> - <code> - <file> failed sanity test (workdir) in path <path> [la] - </code> - </para> - - <para> - The specified <filename>.la</filename> file contains - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - paths. - Any <filename>.la</filename> file containing these paths - is incorrect since <filename>libtool</filename> adds the - correct sysroot prefix when using the files automatically - itself. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-pkgconfig'> - <code> - <file> failed sanity test (tmpdir) in path <path> [pkgconfig] - </code> - </para> - - <para> - The specified <filename>.pc</filename> file contains - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>/</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> - paths. - Any <filename>.pc</filename> file containing these paths is - incorrect since <filename>pkg-config</filename> itself adds - the correct sysroot prefix when the files are accessed. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-debug-deps'> - <code> - <packagename> rdepends on <debug_packagename> [debug-deps] - </code> - </para> - - <para> - A dependency exists between the specified non-dbg package - (i.e. a package whose name does not end in - <filename>-dbg</filename>) and a package that is a - <filename>dbg</filename> package. - The <filename>dbg</filename> packages contain - debug symbols and are brought in using several - different methods: - <itemizedlist> - <listitem><para> - Using the <filename>dbg-pkgs</filename> - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> - value. - </para></listitem> - <listitem><para> - Using - <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>. - </para></listitem> - <listitem><para> - As a dependency of another - <filename>dbg</filename> package that was brought - in using one of the above methods. - </para></listitem> - </itemizedlist> - The dependency might have been automatically added - because the <filename>dbg</filename> package erroneously - contains files that it should not contain (e.g. a - non-symlink <filename>.so</filename> file) or it might - have been added manually (e.g. by adding to - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>). - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-dev-deps'> - <code> - <packagename> rdepends on <dev_packagename> [dev-deps] - </code> - </para> - - <para> - A dependency exists between the specified non-dev package - (a package whose name does not end in - <filename>-dev</filename>) and a package that is a - <filename>dev</filename> package. - The <filename>dev</filename> packages contain development - headers and are usually brought in using several different - methods: - <itemizedlist> - <listitem><para> - Using the <filename>dev-pkgs</filename> - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> - value. - </para></listitem> - <listitem><para> - Using - <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link>. - </para></listitem> - <listitem><para> - As a dependency of another - <filename>dev</filename> package that was brought - in using one of the above methods. - </para></listitem> - </itemizedlist> - The dependency might have been automatically added (because - the <filename>dev</filename> package erroneously contains - files that it should not have (e.g. a non-symlink - <filename>.so</filename> file) or it might have been added - manually (e.g. by adding to - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>). - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-dep-cmp'> - <code> - <var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [dep-cmp] - </code> - </para> - - <para> - If you are adding a versioned dependency relationship to one - of the dependency variables - (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, - <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, - <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, - <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, - or - <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>), - you must only use the named comparison operators. - Change the versioned dependency values you are adding - to match those listed in the message. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-compile-host-path'> - <code> - <recipename>: The compile log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [compile-host-path] - </code> - </para> - - <para> - The log for the - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - task indicates that paths on the host were searched - for files, which is not appropriate when cross-compiling. - Look for "is unsafe for cross-compilation" or "CROSS COMPILE - Badness" in the specified log file. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-install-host-path'> - <code> - <recipename>: The install log indicates that host include and/or library paths were used. Please check the log '<logfile>' for more information. [install-host-path] - </code> - </para> - - <para> - The log for the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task indicates that paths on the host were searched - for files, which is not appropriate when cross-compiling. - Look for "is unsafe for cross-compilation" - or "CROSS COMPILE Badness" in the specified log file. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-autoconf-log'> - <code> - This autoconf log indicates errors, it looked at host include and/or library paths while determining system capabilities. Rerun configure task after fixing this. The path was '<path>' - </code> - </para> - - <para> - The log for the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task indicates that paths on the host were searched - for files, which is not appropriate when cross-compiling. - Look for "is unsafe for cross-compilation" or - "CROSS COMPILE Badness" in the specified log file. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-pkgname'> - <code> - <packagename> doesn't match the [a-z0-9.+-]+ regex [pkgname] - </code> - </para> - - <para> - The convention within the OpenEmbedded build system - (sometimes enforced by the package manager itself) is to - require that package names are all lower case - and to allow a restricted set of characters. - If your recipe name does not match this, or you add - packages to - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> - that do not conform to the convention, then you - will receive this error. - Rename your recipe. - Or, if you have added a non-conforming package name to - <filename>PACKAGES</filename>, change the package name - appropriately. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-unknown-configure-option'> - <code> - <recipe>: configure was passed unrecognized options: <options> [unknown-configure-option] - </code> - </para> - - <para> - The configure script is reporting that the specified - options are unrecognized. - This situation could be because the options - were previously valid but have been removed from the - configure script. - Or, there was a mistake when the options were added - and there is another option that should be used instead. - If you are unsure, consult the upstream build - documentation, the - <filename>./configure --help</filename> output, - and the upstream change log or release notes. - Once you have worked out what the appropriate - change is, you can update - <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link>, - <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>, - or the individual - <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> - option values accordingly. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-pn-overrides'> - <code> - Recipe <recipefile> has PN of "<recipename>" which is in OVERRIDES, this can result in unexpected behavior. [pn-overrides] - </code> - </para> - - <para> - The specified recipe has a name - (<link linkend='var-PN'><filename>PN</filename></link>) - value that appears in - <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>. - If a recipe is named such that its <filename>PN</filename> - value matches something already in - <filename>OVERRIDES</filename> (e.g. <filename>PN</filename> - happens to be the same as - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - or - <link linkend='var-DISTRO'><filename>DISTRO</filename></link>), - it can have unexpected consequences. - For example, assignments such as - <filename>FILES_${PN} = "xyz"</filename> effectively - turn into <filename>FILES = "xyz"</filename>. - Rename your recipe (or if <filename>PN</filename> is being - set explicitly, change the <filename>PN</filename> value) so - that the conflict does not occur. - See - <link linkend='var-FILES'><filename>FILES</filename></link> - for additional information. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-pkgvarcheck'> - <code> - <recipefile>: Variable <variable> is set as not being package specific, please fix this. [pkgvarcheck] - </code> - </para> - - <para> - Certain variables - (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>, - <link linkend='var-RSUGGESTS'><filename>RSUGGESTS</filename></link>, - <link linkend='var-RCONFLICTS'><filename>RCONFLICTS</filename></link>, - <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link>, - <link linkend='var-RREPLACES'><filename>RREPLACES</filename></link>, - <link linkend='var-FILES'><filename>FILES</filename></link>, - <filename>pkg_preinst</filename>, - <filename>pkg_postinst</filename>, - <filename>pkg_prerm</filename>, - <filename>pkg_postrm</filename>, and - <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link>) - should always be set specific to a package (i.e. they - should be set with a package name override such as - <filename>RDEPENDS_${PN} = "value"</filename> rather than - <filename>RDEPENDS = "value"</filename>). - If you receive this error, correct any assignments to these - variables within your recipe. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-already-stripped'> - <code> - File '<file>' from <recipename> was already stripped, this will prevent future debugging! [already-stripped] - </code> - </para> - - <para> - Produced binaries have already been stripped prior to the - build system extracting debug symbols. - It is common for upstream software projects to default to - stripping debug symbols for output binaries. - In order for debugging to work on the target using - <filename>-dbg</filename> packages, this stripping must be - disabled. - </para> - - <para> - Depending on the build system used by the software being - built, disabling this stripping could be as easy as - specifying an additional configure option. - If not, disabling stripping might involve patching - the build scripts. - In the latter case, look for references to "strip" or - "STRIP", or the "-s" or "-S" command-line options being - specified on the linker command line (possibly - through the compiler command line if preceded with "-Wl,"). - <note> - Disabling stripping here does not mean that the final - packaged binaries will be unstripped. - Once the OpenEmbedded build system splits out debug - symbols to the <filename>-dbg</filename> package, - it will then strip the symbols from the binaries. - </note> - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-packages-list'> - <code> - <packagename> is listed in PACKAGES multiple times, this leads to packaging errors. [packages-list] - </code> - </para> - - <para> - Package names must appear only once in the - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> - variable. - You might receive this error if you are attempting to add a - package to <filename>PACKAGES</filename> that is - already in the variable's value. - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-files-invalid'> - <code> - FILES variable for package <packagename> contains '//' which is invalid. Attempting to fix this but you should correct the metadata. [files-invalid] - </code> - </para> - - <para> - The string "//" is invalid in a Unix path. - Correct all occurrences where this string appears in a - <link linkend='var-FILES'><filename>FILES</filename></link> - variable so that there is only a single "/". - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-installed-vs-shipped'> - <code> - <recipename>: Files/directories were installed but not shipped in any package [installed-vs-shipped] - </code> - </para> - - <para> - Files have been installed within the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task but have not been included in any package by way of the - <link linkend='var-FILES'><filename>FILES</filename></link> - variable. - Files that do not appear in any package cannot be present in - an image later on in the build process. - You need to do one of the following: - <itemizedlist> - <listitem><para> - Add the files to <filename>FILES</filename> for the - package you want them to appear in (e.g. - <filename>FILES_${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename> for the main - package). - </para></listitem> - <listitem><para> - Delete the files at the end of the - <filename>do_install</filename> task if the files - are not needed in any package. - </para></listitem> - </itemizedlist> - </para> - - <para> - - </para> - </listitem> - </itemizedlist> - </para> - - <para> - <itemizedlist> - <listitem> - <para id='qa-issue-old-and-new-package-and-version-names'> - <code> - <oldpackage>-<oldpkgversion> was registered as shlib provider for <library>, changing it to <newpackage>-<newpkgversion> because it was built later - </code> - </para> - - <para> - This message means that both - <filename><oldpackage></filename> and - <filename><newpackage></filename> provide the specified - shared library. - You can expect this message when a recipe has been renamed. - However, if that is not the case, the message might indicate - that a private version of a library is being erroneously - picked up as the provider for a common library. - If that is the case, you should add the library's - <filename>.so</filename> file name to - <link linkend='var-PRIVATE_LIBS'><filename>PRIVATE_LIBS</filename></link> - in the recipe that provides - the private version of the library. - </para> - </listitem> - </itemizedlist> - </para> -</section> - -<section id='configuring-and-disabling-qa-checks'> - <title>Configuring and Disabling QA Checks</title> - - <para> - You can configure the QA checks globally so that specific check - failures either raise a warning or an error message, using the - <link linkend='var-WARN_QA'><filename>WARN_QA</filename></link> and - <link linkend='var-ERROR_QA'><filename>ERROR_QA</filename></link> - variables, respectively. - You can also disable checks within a particular recipe using - <link linkend='var-INSANE_SKIP'><filename>INSANE_SKIP</filename></link>. - For information on how to work with the QA checks, see the - "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" - section. - <note><title>Tip</title> - Please keep in mind that the QA checks exist in order to - detect real or potential problems in the packaged output. - So exercise caution when disabling these checks. - </note> - </para> -</section> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-release-process.xml b/documentation/ref-manual/ref-release-process.xml deleted file mode 100644 index 5efe17417a..0000000000 --- a/documentation/ref-manual/ref-release-process.xml +++ /dev/null @@ -1,255 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-release-process'> -<title>Yocto Project Releases and the Stable Release Process</title> - -<para> - 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. -</para> - -<section id='major-and-minor-release-cadence'> - <title>Major and Minor Release Cadence</title> - - <para> - 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 - "<link linkend='major-release-codenames'>Major Release Codenames</link>" - section for information on codenames used with major releases. - <literallayout class='monospaced'> - 2.2 (Morty) - 2.1 (Krogoth) - 2.0 (Jethro) - </literallayout> - 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. - </para> - - <para> - 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: - <literallayout class='monospaced'> - 2.1.1 - 2.1.2 - 2.2.1 - </literallayout> - 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. - </note> - </para> -</section> - -<section id='major-release-codenames'> - <title>Major Release Codenames</title> - - <para> - Each major release receives a codename that identifies the release in - the - <ulink url='&YOCTO_DOCS_OM_URL;#yocto-project-repositories'>Yocto Project Source Repositories</ulink>. - The concept is that branches of - <link linkend='metadata'>Metadata</link> - 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. - </note> - 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 - <ulink url='https://wiki.yoctoproject.org/wiki/Releases'></ulink>. - </para> -</section> - -<section id='stable-release-process'> - <title>Stable Release Process</title> - - <para> - 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. - </note> - </para> - - <para> - 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 - <ulink url='https://wiki.yoctoproject.org/wiki/Stable_branch_maintenance'></ulink>. - </para> -</section> - -<section id='testing-and-quality-assurance'> - <title>Testing and Quality Assurance</title> - - <para> - 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 - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - - <para> - 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: - <itemizedlist> - <listitem><para> - <filename>bitbake-selftest</filename>: - A standalone command that runs unit tests on key pieces of - BitBake and its fetchers. - </para></listitem> - <listitem><para> - <link linkend='ref-classes-sanity'><filename>sanity.bbclass</filename></link>: - This automatically included class checks the build environment - for missing tools (e.g. <filename>gcc</filename>) or common - misconfigurations such as - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - set incorrectly. - </para></listitem> - <listitem><para> - <link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>: - 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. - </para></listitem> - <listitem><para> - <link linkend='ref-classes-testimage*'><filename>testimage.bbclass</filename></link>: - This class performs runtime testing of images after they are - built. - The tests are usually used with - <ulink url='&YOCTO_DOCS_DEV_URL;#dev-manual-qemu'>QEMU</ulink> - 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. - </para></listitem> - <listitem><para> - <ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'><filename>ptest</filename></ulink>: - 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. - </para></listitem> - <listitem><para> - <filename>oe-selftest</filename>: - Tests combination BitBake invocations. - These tests operate outside the OpenEmbedded build system - itself. - The <filename>oe-selftest</filename> can run all tests by - default or can run selected tests or test suites. - <note> - Running <filename>oe-selftest</filename> requires - host packages beyond the "Essential" grouping. - See the - "<link linkend='required-packages-for-the-build-host'>Required Packages for the Build Host</link>" - section for more information. - </note> - </para></listitem> - </itemizedlist> - </para> - - <para> - 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. - </para> - - <para> - The Yocto Project's main Autobuilder - (<filename>autobuilder.yoctoproject.org</filename>) publicly tests - each Yocto Project release's code in the - <link linkend='oe-core'>OE-Core</link>, 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 <filename>poky-contrib</filename> repository - (i.e. the master-under-test branch) or in the "master-next" branch - in the <filename>poky</filename> repository. - <note> - You can find all these branches in the Yocto Project - <ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink>. - </note> - 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. - </para> - - <para> - Various features such as <filename>multilib</filename>, sub - architectures (e.g. <filename>x32</filename>, - <filename>poky-tiny</filename>, <filename>musl</filename>, - <filename>no-x11</filename> and and so forth), - <filename>bitbake-selftest</filename>, and - <filename>oe-selftest</filename> 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. - </note> - </para> - - <para> - 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. - </para> -</section> - -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml deleted file mode 100644 index 8e0c9f5b62..0000000000 --- a/documentation/ref-manual/ref-structure.xml +++ /dev/null @@ -1,1122 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-structure'> - -<title>Source Directory Structure</title> - -<para> - The <link linkend='source-directory'>Source Directory</link> - consists of several components. - Understanding them and knowing where they are located is key to using the - Yocto Project well. - This chapter describes the Source Directory and gives information about - the various files and directories. -</para> - -<para> - For information on how to establish a local Source Directory on your - development system, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#locating-yocto-project-source-files'>Locating Yocto Project Source Files</ulink>" - section in the Yocto Project Development Tasks Manual. -</para> - -<note> - The OpenEmbedded build system does not support file or directory names that - contain spaces. - Be sure that the Source Directory you use does not contain these types - of names. -</note> - -<section id='structure-core'> - <title>Top-Level Core Components</title> - - <para> - This section describes the top-level components of the - <link linkend='source-directory'>Source Directory</link>. - </para> - - <section id='structure-core-bitbake'> - <title><filename>bitbake/</filename></title> - - <para> - This directory includes a copy of BitBake for ease of use. - The copy usually matches the current stable BitBake release from - the BitBake project. - BitBake, a - <link linkend='metadata'>Metadata</link> - interpreter, reads the Yocto Project Metadata and runs the tasks - defined by that data. - Failures are usually from the Metadata and not from BitBake itself. - Consequently, most users do not need to worry about BitBake. - </para> - - <para> - When you run the <filename>bitbake</filename> command, the - main BitBake executable, which resides in the - <filename>bitbake/bin/</filename> directory, starts. - Sourcing the environment setup script (i.e. - <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link>) - places the <filename>scripts</filename> and - <filename>bitbake/bin</filename> directories (in that order) into - the shell's <filename>PATH</filename> environment variable. - </para> - - <para> - For more information on BitBake, see the - <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>. - </para> - </section> - - <section id='structure-core-build'> - <title><filename>build/</filename></title> - - <para> - This directory contains user configuration files and the output - generated by the OpenEmbedded build system in its standard configuration where - the source tree is combined with the output. - The - <link linkend='build-directory'>Build Directory</link> - is created initially when you <filename>source</filename> - the OpenEmbedded build environment setup script - (i.e. - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). - </para> - - <para> - It is also possible to place output and configuration - files in a directory separate from the - <link linkend='source-directory'>Source Directory</link> - by providing a directory name when you <filename>source</filename> - the setup script. - For information on separating output from your local - Source Directory files, see the - "<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>" - section. - </para> - </section> - - <section id='handbook'> - <title><filename>documentation/</filename></title> - - <para> - This directory holds the source for the Yocto Project documentation - as well as templates and tools that allow you to generate PDF and HTML - versions of the manuals. - Each manual is contained in a sub-folder. - For example, the files for this manual reside in - the <filename>ref-manual/</filename> directory. - </para> - </section> - - <section id='structure-core-meta'> - <title><filename>meta/</filename></title> - - <para> - This directory contains the OpenEmbedded-Core metadata. - The directory holds recipes, common classes, and machine - configuration for emulated targets (<filename>qemux86</filename>, - <filename>qemuarm</filename>, and so forth.) - </para> - </section> - - <section id='structure-core-meta-poky'> - <title><filename>meta-poky/</filename></title> - - <para> - This directory contains the configuration for the Poky - reference distribution. - </para> - </section> - - <section id='structure-core-meta-yocto-bsp'> - <title><filename>meta-yocto-bsp/</filename></title> - - <para> - This directory contains the Yocto Project reference - hardware Board Support Packages (BSPs). - For more information on BSPs, see the - <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. - </para> - </section> - - <section id='structure-meta-selftest'> - <title><filename>meta-selftest/</filename></title> - - <para> - This directory adds additional recipes and append files - used by the OpenEmbedded selftests to verify the behavior - of the build system. - </para> - - <para> - You do not have to add this layer to your - <filename>bblayers.conf</filename> file unless you want to run the - selftests. - </para> - </section> - - <section id='structure-meta-skeleton'> - <title><filename>meta-skeleton/</filename></title> - - <para> - This directory contains template recipes for BSP and kernel development. - </para> - </section> - - <section id='structure-core-scripts'> - <title><filename>scripts/</filename></title> - - <para> - This directory contains various integration scripts that implement - extra functionality in the Yocto Project environment (e.g. QEMU scripts). - The <link linkend="structure-core-script"><filename>&OE_INIT_FILE;</filename></link> - script appends this directory to the shell's - <filename>PATH</filename> environment variable. - </para> - - <para> - The <filename>scripts</filename> directory has useful scripts that assist in contributing - back to the Yocto Project, such as <filename>create-pull-request</filename> and - <filename>send-pull-request</filename>. - </para> - </section> - - <section id='structure-core-script'> - <title><filename>&OE_INIT_FILE;</filename></title> - - <para> - This script sets up the OpenEmbedded build environment. - Running this script with the <filename>source</filename> command in - a shell makes changes to <filename>PATH</filename> and sets other - core BitBake variables based on the current working directory. - You need to run an environment setup script before running BitBake - commands. - The script uses other scripts within the - <filename>scripts</filename> directory to do the bulk of the work. - </para> - - <para> - When you run this script, your Yocto Project environment is set - up, a - <link linkend='build-directory'>Build Directory</link> - is created, your working directory becomes the Build Directory, - and you are presented with a list of common BitBake targets. - Here is an example: - <literallayout class='monospaced'> - $ source oe-init-build-env - - ### Shell environment set up for builds. ### - - You can now run 'bitbake <target>' - - Common targets are: - core-image-minimal - core-image-sato - meta-toolchain - meta-ide-support - - You can also run generated qemu images with a command like 'runqemu qemux86' - </literallayout> - The script gets its default list of common targets from the - <filename>conf-notes.txt</filename> file, which is found in the - <filename>meta-poky</filename> directory within the - <link linkend='source-directory'>Source Directory</link>. - Should you have custom distributions, it is very easy to modify - this configuration file to include your targets for your - distribution. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" - section in the Yocto Project Development Tasks Manual for more - information. - </para> - - <para> - By default, running this script without a Build Directory - argument creates the <filename>build</filename> directory - in your current working directory. - If you provide a Build Directory argument when you - <filename>source</filename> the script, you direct the OpenEmbedded - build system to create a Build Directory of your choice. - For example, the following command creates a Build Directory named - <filename>mybuilds</filename> that is outside of the - <link linkend='source-directory'>Source Directory</link>: - <literallayout class='monospaced'> - $ source &OE_INIT_FILE; ~/mybuilds - </literallayout> - The OpenEmbedded build system uses the template configuration - files, which are found by default in the - <filename>meta-poky/conf</filename> directory in the - Source Directory. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-custom-template-configuration-directory'>Creating a Custom Template Configuration Directory</ulink>" - section in the Yocto Project Development 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 <filename>&OE_INIT_FILE;</filename> script - from a Source Directory that contains spaces in either the filenames - or directory names, the script returns an error indicating no such - file or directory. - Be sure to use a Source Directory free of names containing spaces. - </note> - </para> - </section> - - <section id='structure-basic-top-level'> - <title><filename>LICENSE, README, and README.hardware</filename></title> - - <para> - These files are standard top-level files. - </para> - </section> -</section> - -<section id='structure-build'> - <title>The Build Directory - <filename>build/</filename></title> - - <para> - The OpenEmbedded build system creates the - <link linkend='build-directory'>Build Directory</link> - when you run the build environment setup scripts (i.e. - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). - </para> - - <para> - If you do not give the Build Directory a specific name when you run - a setup script, the name defaults to <filename>build</filename>. - </para> - - <para> - The - <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link> variable - points to the Build Directory. - </para> - - <section id='structure-build-buildhistory'> - <title><filename>build/buildhistory</filename></title> - - <para> - The OpenEmbedded build system creates this directory when you - enable the build history feature. - The directory tracks build information into image, packages, and - SDK subdirectories. - For information on the build history feature, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='structure-build-conf-local.conf'> - <title><filename>build/conf/local.conf</filename></title> - - <para> - This configuration file contains all the local user configurations - for your build environment. - The <filename>local.conf</filename> file contains documentation on - the various configuration options. - Any variable set here overrides any variable set elsewhere within - the environment unless that variable is hard-coded within a file - (e.g. by using '=' instead of '?='). - Some variables are hard-coded for various reasons but these - variables are relatively rare. - </para> - - <para> - Edit this file to set the - <filename><link linkend='var-MACHINE'>MACHINE</link></filename> - for which you want to build, which package types you wish to use - (<link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>), - and the location from which you want to access downloaded files - (<filename><link linkend='var-DL_DIR'>DL_DIR</link></filename>). - </para> - - <para> - If <filename>local.conf</filename> is not present when you - start the build, the OpenEmbedded build system creates it from - <filename>local.conf.sample</filename> when - you <filename>source</filename> the top-level build environment - setup script (i.e. - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). - </para> - - <para> - The source <filename>local.conf.sample</filename> file used - depends on the <filename>$TEMPLATECONF</filename> script variable, - which defaults to <filename>meta-poky/conf</filename> - when you are building from the Yocto Project development - environment and defaults to <filename>meta/conf</filename> when - you are building from the OpenEmbedded-Core environment. - Because the script variable points to the source of the - <filename>local.conf.sample</filename> file, this implies that - you can configure your build environment from any layer by setting - the variable in the top-level build environment setup script as - follows: - <literallayout class='monospaced'> - TEMPLATECONF=<replaceable>your_layer</replaceable>/conf - </literallayout> - Once the build process gets the sample file, it uses - <filename>sed</filename> to substitute final - <filename>${</filename><link linkend='var-OEROOT'><filename>OEROOT</filename></link><filename>}</filename> - values for all <filename>##OEROOT##</filename> values. - <note> - You can see how the <filename>TEMPLATECONF</filename> variable - is used by looking at the - <filename>scripts/oe-setup-builddir</filename> script in the - <link linkend='source-directory'>Source Directory</link>. - You can find the Yocto Project version of the - <filename>local.conf.sample</filename> file in the - <filename>meta-poky/conf</filename> directory. - </note> - </para> - </section> - - <section id='structure-build-conf-bblayers.conf'> - <title><filename>build/conf/bblayers.conf</filename></title> - - <para> - This configuration file defines - <ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>layers</ulink>, - which are directory trees, traversed (or walked) by BitBake. - The <filename>bblayers.conf</filename> file uses the - <link linkend='var-BBLAYERS'><filename>BBLAYERS</filename></link> - variable to list the layers BitBake tries to find. - </para> - - <para> - If <filename>bblayers.conf</filename> is not present when you - start the build, the OpenEmbedded build system creates it from - <filename>bblayers.conf.sample</filename> when - you <filename>source</filename> the top-level build environment - setup script (i.e. - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). - </para> - - <para> - The source <filename>bblayers.conf.sample</filename> file used - depends on the <filename>$TEMPLATECONF</filename> script variable, - which defaults to <filename>meta-poky/conf</filename> - when you are building from the Yocto Project development - environment and defaults to <filename>meta/conf</filename> when - you are building from the OpenEmbedded-Core environment. - Because the script variable points to the source of the - <filename>bblayers.conf.sample</filename> file, this implies that - you can base your build from any layer by setting the variable in - the top-level build environment setup script as follows: - <literallayout class='monospaced'> - TEMPLATECONF=<replaceable>your_layer</replaceable>/conf - </literallayout> - Once the build process gets the sample file, it uses - <filename>sed</filename> to substitute final - <filename>${</filename><link linkend='var-OEROOT'><filename>OEROOT</filename></link><filename>}</filename> - values for all <filename>##OEROOT##</filename> values. - <note> - You can see how the <filename>TEMPLATECONF</filename> variable - <filename>scripts/oe-setup-builddir</filename> script in the - <link linkend='source-directory'>Source Directory</link>. - You can find the Yocto Project version of the - <filename>bblayers.conf.sample</filename> file in the - <filename>meta-poky/conf</filename> directory. - </note> - </para> - </section> - - <section id='structure-build-conf-sanity_info'> - <title><filename>build/conf/sanity_info</filename></title> - - <para> - This file indicates the state of the sanity checks and is created - during the build. - </para> - </section> - - <section id='structure-build-downloads'> - <title><filename>build/downloads/</filename></title> - - <para> - This directory contains downloaded upstream source tarballs. - You can reuse the directory for multiple builds or move - the directory to another location. - You can control the location of this directory through the - <filename><link linkend='var-DL_DIR'>DL_DIR</link></filename> variable. - </para> - </section> - - <section id='structure-build-sstate-cache'> - <title><filename>build/sstate-cache/</filename></title> - - <para> - This directory contains the shared state cache. - You can reuse the directory for multiple builds or move - the directory to another location. - You can control the location of this directory through the - <filename><link linkend='var-SSTATE_DIR'>SSTATE_DIR</link></filename> variable. - </para> - </section> - - <section id='structure-build-tmp'> - <title><filename>build/tmp/</filename></title> - - <para> - The OpenEmbedded build system creates and uses this directory - for all the build system's output. - The - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - variable points to this directory. - </para> - - <para> - BitBake creates this directory if it does not exist. - As a last resort, to clean up a build and start it from scratch - (other than the downloads), you can remove everything in the - <filename>tmp</filename> directory or get rid of the - directory completely. - If you do, you should also completely remove the - <filename>build/sstate-cache</filename> directory. - </para> - </section> - - <section id='structure-build-tmp-buildstats'> - <title><filename>build/tmp/buildstats/</filename></title> - - <para> - This directory stores the build statistics. - </para> - </section> - - <section id='structure-build-tmp-cache'> - <title><filename>build/tmp/cache/</filename></title> - - <para> - When BitBake parses the metadata (recipes and configuration files), - it caches the results in <filename>build/tmp/cache/</filename> - to speed up future builds. - The results are stored on a per-machine basis. - </para> - - <para> - 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. - </para> - </section> - - <section id='structure-build-tmp-deploy'> - <title><filename>build/tmp/deploy/</filename></title> - - <para> - This directory contains any "end result" output from the - OpenEmbedded build process. - The <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link> - variable points to this directory. - For more detail on the contents of the <filename>deploy</filename> - directory, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#images-dev-environment'>Images</ulink>" - and - "<ulink url='&YOCTO_DOCS_OM_URL;#sdk-dev-environment'>Application Development SDK</ulink>" - sections in the Yocto Project Overview and Concepts Manual. - </para> - </section> - - <section id='structure-build-tmp-deploy-deb'> - <title><filename>build/tmp/deploy/deb/</filename></title> - - <para> - This directory receives any <filename>.deb</filename> packages produced by - the build process. - The packages are sorted into feeds for different architecture types. - </para> - </section> - - <section id='structure-build-tmp-deploy-rpm'> - <title><filename>build/tmp/deploy/rpm/</filename></title> - - <para> - This directory receives any <filename>.rpm</filename> packages produced by - the build process. - The packages are sorted into feeds for different architecture types. - </para> - </section> - - <section id='structure-build-tmp-deploy-ipk'> - <title><filename>build/tmp/deploy/ipk/</filename></title> - - <para> - This directory receives <filename>.ipk</filename> packages produced by - the build process. - </para> - </section> - - <section id='structure-build-tmp-deploy-licenses'> - <title><filename>build/tmp/deploy/licenses/</filename></title> - - <para> - This directory receives package licensing information. - For example, the directory contains sub-directories for <filename>bash</filename>, - <filename>busybox</filename>, and <filename>glibc</filename> (among others) that in turn - contain appropriate <filename>COPYING</filename> license files with other licensing information. - For information on licensing, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='structure-build-tmp-deploy-images'> - <title><filename>build/tmp/deploy/images/</filename></title> - - <para> - This directory receives complete filesystem images. - If you want to flash the resulting image from a build onto a device, look here for the image. - </para> - - <para> - Be careful when deleting files in this directory. - You can safely delete old images from this directory (e.g. - <filename>core-image-*</filename>). - However, the kernel (<filename>*zImage*</filename>, <filename>*uImage*</filename>, etc.), - bootloader and other supplementary files might be deployed here prior to building an - image. - Because these files are not directly produced from the image, if you - delete them they will not be automatically re-created when you build the image again. - </para> - - <para> - If you do accidentally delete files here, you will need to force them to be - re-created. - In order to do that, you will need to know the target that produced them. - For example, these commands rebuild and re-create the kernel files: - <literallayout class='monospaced'> - $ bitbake -c clean virtual/kernel - $ bitbake virtual/kernel - </literallayout> - </para> - </section> - - <section id='structure-build-tmp-deploy-sdk'> - <title><filename>build/tmp/deploy/sdk/</filename></title> - - <para> - The OpenEmbedded build system creates this directory to hold - toolchain installer scripts, which when executed, install the - sysroot that matches your target hardware. - You can find out more about these installers in the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-building-an-sdk-installer'>Building an SDK Installer</ulink>" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - </para> - </section> - - <section id='structure-build-tmp-sstate-control'> - <title><filename>build/tmp/sstate-control/</filename></title> - - <para> - The OpenEmbedded build system uses this directory for the - shared state manifest files. - The shared state code uses these files to record the files - installed by each sstate task so that the files can be removed - when cleaning the recipe or when a newer version is about to - be installed. - The build system also uses the manifests to detect and produce - a warning when files from one task are overwriting those from - another. - </para> - </section> - - <section id='structure-build-tmp-sysroots-components'> - <title><filename>build/tmp/sysroots-components/</filename></title> - - <para> - This directory is the location of the sysroot contents that the - task - <link linkend='ref-tasks-prepare_recipe_sysroot'><filename>do_prepare_recipe_sysroot</filename></link> - links or copies into the recipe-specific sysroot for each - recipe listed in - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>. - Population of this directory is handled through shared state, while - the path is specified by the - <link linkend='var-COMPONENTS_DIR'><filename>COMPONENTS_DIR</filename></link> - variable. Apart from a few unusual circumstances, handling of the - <filename>sysroots-components</filename> directory should be - automatic, and recipes should not directly reference - <filename>build/tmp/sysroots-components</filename>. - </para> - </section> - - <section id='structure-build-tmp-sysroots'> - <title><filename>build/tmp/sysroots/</filename></title> - - <para> - Previous versions of the OpenEmbedded build system used to - create a global shared sysroot per machine along with a native - sysroot. - Beginning with the &DISTRO; version of the Yocto Project, - sysroots exist in recipe-specific - <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> - directories. - Thus, the <filename>build/tmp/sysroots/</filename> directory - is unused. - <note> - The <filename>build/tmp/sysroots/</filename> directory - can still be populated using the - <filename>bitbake build-sysroots</filename> 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. - </note> - </para> - </section> - - <section id='structure-build-tmp-stamps'> - <title><filename>build/tmp/stamps/</filename></title> - - <para> - This directory holds information that BitBake uses for - accounting purposes to track what tasks have run and when they - have run. - The directory is sub-divided by architecture, package name, and - version. - Following is an example: - <literallayout class='monospaced'> - stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do - </literallayout> - Although the files in the directory are empty of data, - BitBake uses the filenames and timestamps for tracking purposes. - </para> - - <para> - For information on how BitBake uses stamp files to determine if - a task should be rerun, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </section> - - <section id='structure-build-tmp-log'> - <title><filename>build/tmp/log/</filename></title> - - <para> - This directory contains general logs that are not otherwise placed using the - package's <filename><link linkend='var-WORKDIR'>WORKDIR</link></filename>. - Examples of logs are the output from the - <filename>do_check_pkg</filename> or - <filename>do_distro_check</filename> tasks. - Running a build does not necessarily mean this directory is created. - </para> - </section> - - <section id='structure-build-tmp-work'> - <title><filename>build/tmp/work/</filename></title> - - <para> - This directory contains architecture-specific work sub-directories - for packages built by BitBake. - All tasks execute from the appropriate work directory. - For example, the source for a particular package is unpacked, - patched, configured and compiled all within its own work directory. - Within the work directory, organization is based on the package group - and version for which the source is being compiled - as defined by the - <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>. - </para> - - <para> - It is worth considering the structure of a typical work directory. - As an example, consider <filename>linux-yocto-kernel-3.0</filename> - on the machine <filename>qemux86</filename> - built within the Yocto Project. - For this package, a work directory of - <filename>tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....></filename>, - referred to as the <filename>WORKDIR</filename>, is created. - Within this directory, the source is unpacked to - <filename>linux-qemux86-standard-build</filename> and then patched by Quilt. - (See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#using-a-quilt-workflow'>Using Quilt in Your Workflow</ulink>" - section in the Yocto Project Development Tasks Manual for more - information.) - Within the <filename>linux-qemux86-standard-build</filename> directory, - standard Quilt directories <filename>linux-3.0/patches</filename> - and <filename>linux-3.0/.pc</filename> are created, - and standard Quilt commands can be used. - </para> - - <para> - There are other directories generated within <filename>WORKDIR</filename>. - The most important directory is <filename>WORKDIR/temp/</filename>, - which has log files for each task (<filename>log.do_*.pid</filename>) - and contains the scripts BitBake runs for each task - (<filename>run.do_*.pid</filename>). - The <filename>WORKDIR/image/</filename> directory is where "make - install" places its output that is then split into sub-packages - within <filename>WORKDIR/packages-split/</filename>. - </para> - </section> - - <section id='structure-build-tmp-work-tunearch-recipename-version'> - <title><filename>build/tmp/work/<replaceable>tunearch</replaceable>/<replaceable>recipename</replaceable>/<replaceable>version</replaceable>/</filename></title> - - <para> - The recipe work directory - <filename>${WORKDIR}</filename>. - </para> - - <para> - As described earlier in the - "<link linkend='structure-build-tmp-sysroots'><filename>build/tmp/sysroots/</filename></link>" - section, beginning with the &DISTRO; release of the Yocto - Project, the OpenEmbedded build system builds each recipe in its - own work directory (i.e. - <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link>). - The path to the work directory is constructed using the - architecture of the given build (e.g. - <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>, - <link linkend='var-MACHINE_ARCH'><filename>MACHINE_ARCH</filename></link>, - or "allarch"), the recipe name, and the version of the recipe (i.e. - <link linkend='var-PE'><filename>PE</filename></link><filename>:</filename><link linkend='var-PV'><filename>PV</filename></link><filename>-</filename><link linkend='var-PR'><filename>PR</filename></link>). - </para> - - <para> - A number of key subdirectories exist within each recipe - work directory: - <itemizedlist> - <listitem><para> - <filename>${WORKDIR}/temp</filename>: - 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 - <filename>log.task_order</filename> file, which lists the - order in which tasks were executed. - </para></listitem> - <listitem><para> - <filename>${WORKDIR}/image</filename>: - Contains the output of the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task, which corresponds to the - <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> - variable in that task. - </para></listitem> - <listitem><para> - <filename>${WORKDIR}/pseudo</filename>: - Contains the pseudo database and log for any tasks executed - under pseudo for the recipe. - </para></listitem> - <listitem><para> - <filename>${WORKDIR}/sysroot-destdir</filename>: - Contains the output of the - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task. - </para></listitem> - <listitem><para> - <filename>${WORKDIR}/package</filename>: - Contains the output of the - <link linkend='ref-tasks-package'><filename>do_package</filename></link> - task before the output is split into individual packages. - </para></listitem> - <listitem><para> - <filename>${WORKDIR}/packages-split</filename>: - Contains the output of the <filename>do_package</filename> - task after the output has been split into individual - packages. - Subdirectories exist for each individual package created - by the recipe. - </para></listitem> - <listitem><para> - <filename>${WORKDIR}/recipe-sysroot</filename>: - 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). - </para></listitem> - <listitem><para> - <filename>${WORKDIR}/recipe-sysroot-native</filename>: - 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). - </para></listitem> - <listitem><para> - <filename>${WORKDIR}/build</filename>: - 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. - <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>). - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='structure-build-work-shared'> - <title><filename>build/tmp/work-shared/</filename></title> - - <para> - For efficiency, the OpenEmbedded build system creates and uses - this directory to hold recipes that share a work directory with - other recipes. - In practice, this is only used for <filename>gcc</filename> - and its variants (e.g. <filename>gcc-cross</filename>, - <filename>libgcc</filename>, <filename>gcc-runtime</filename>, - and so forth). - </para> - </section> -</section> - -<section id='structure-meta'> - <title>The Metadata - <filename>meta/</filename></title> - - <para> - As mentioned previously, - <link linkend='metadata'>Metadata</link> is the core - of the Yocto Project. - Metadata has several important subdivisions: - </para> - - <section id='structure-meta-classes'> - <title><filename>meta/classes/</filename></title> - - <para> - This directory contains the <filename>*.bbclass</filename> files. - Class files are used to abstract common code so it can be reused by multiple - packages. - Every package inherits the <filename>base.bbclass</filename> file. - Examples of other important classes are <filename>autotools.bbclass</filename>, which - in theory allows any Autotool-enabled package to work with the Yocto Project with minimal effort. - Another example is <filename>kernel.bbclass</filename> that contains common code and functions - for working with the Linux kernel. - Functions like image generation or packaging also have their specific class files - such as <filename>image.bbclass</filename>, <filename>rootfs_*.bbclass</filename> and - <filename>package*.bbclass</filename>. - </para> - - <para> - For reference information on classes, see the - "<link linkend='ref-classes'>Classes</link>" chapter. - </para> - </section> - - <section id='structure-meta-conf'> - <title><filename>meta/conf/</filename></title> - - <para> - This directory contains the core set of configuration files that start from - <filename>bitbake.conf</filename> and from which all other configuration - files are included. - See the include statements at the end of the - <filename>bitbake.conf</filename> file and you will note that even - <filename>local.conf</filename> is loaded from there. - While <filename>bitbake.conf</filename> sets up the defaults, you can often override - these by using the (<filename>local.conf</filename>) file, machine file or - the distribution configuration file. - </para> - </section> - - <section id='structure-meta-conf-machine'> - <title><filename>meta/conf/machine/</filename></title> - - <para> - This directory contains all the machine configuration files. - If you set <filename>MACHINE = "qemux86"</filename>, - the OpenEmbedded build system looks for a <filename>qemux86.conf</filename> file in this - directory. - The <filename>include</filename> directory contains various data common to multiple machines. - If you want to add support for a new machine to the Yocto Project, look in this directory. - </para> - </section> - - <section id='structure-meta-conf-distro'> - <title><filename>meta/conf/distro/</filename></title> - - <para> - The contents of this directory controls any distribution-specific - configurations. - For the Yocto Project, the <filename>defaultsetup.conf</filename> is the main file here. - This directory includes the versions and the - <filename>SRCDATE</filename> definitions for applications that are configured here. - An example of an alternative configuration might be <filename>poky-bleeding.conf</filename>. - Although this file mainly inherits its configuration from Poky. - </para> - </section> - - <section id='structure-meta-conf-machine-sdk'> - <title><filename>meta/conf/machine-sdk/</filename></title> - - <para> - The OpenEmbedded build system searches this directory for - configuration files that correspond to the value of - <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>. - By default, 32-bit and 64-bit x86 files ship with the Yocto - Project that support some SDK hosts. - However, it is possible to extend that support to other SDK hosts - by adding additional configuration files in this subdirectory - within another layer. - </para> - </section> - - <section id='structure-meta-files'> - <title><filename>meta/files/</filename></title> - - <para> - This directory contains common license files and several text files - used by the build system. - The text files contain minimal device information and - lists of files and directories with known permissions. - </para> - </section> - - <section id='structure-meta-lib'> - <title><filename>meta/lib/</filename></title> - - <para> - This directory contains OpenEmbedded Python library code - used during the build process. - </para> - </section> - - <section id='structure-meta-recipes-bsp'> - <title><filename>meta/recipes-bsp/</filename></title> - - <para> - This directory contains anything linking to specific hardware or hardware - configuration information such as "u-boot" and "grub". - </para> - </section> - - <section id='structure-meta-recipes-connectivity'> - <title><filename>meta/recipes-connectivity/</filename></title> - - <para> - This directory contains libraries and applications related to communication with other devices. - </para> - </section> - - <section id='structure-meta-recipes-core'> - <title><filename>meta/recipes-core/</filename></title> - - <para> - This directory contains what is needed to build a basic working Linux image - including commonly used dependencies. - </para> - </section> - - <section id='structure-meta-recipes-devtools'> - <title><filename>meta/recipes-devtools/</filename></title> - - <para> - This directory contains tools that are primarily used by the build system. - The tools, however, can also be used on targets. - </para> - </section> - - <section id='structure-meta-recipes-extended'> - <title><filename>meta/recipes-extended/</filename></title> - - <para> - This directory contains non-essential applications that add features compared to the - alternatives in core. - You might need this directory for full tool functionality or for Linux Standard Base (LSB) - compliance. - </para> - </section> - - <section id='structure-meta-recipes-gnome'> - <title><filename>meta/recipes-gnome/</filename></title> - - <para> - This directory contains all things related to the GTK+ application framework. - </para> - </section> - - <section id='structure-meta-recipes-graphics'> - <title><filename>meta/recipes-graphics/</filename></title> - - <para> - This directory contains X and other graphically related system libraries - </para> - </section> - - <section id='structure-meta-recipes-kernel'> - <title><filename>meta/recipes-kernel/</filename></title> - - <para> - This directory contains the kernel and generic applications and libraries that - have strong kernel dependencies. - </para> - </section> - - <section id='structure-meta-recipes-lsb4'> - <title><filename>meta/recipes-lsb4/</filename></title> - - <para> - This directory contains recipes specifically added to support - the Linux Standard Base (LSB) version 4.x. - </para> - </section> - - <section id='structure-meta-recipes-multimedia'> - <title><filename>meta/recipes-multimedia/</filename></title> - - <para> - This directory contains codecs and support utilities for audio, images and video. - </para> - </section> - - <section id='structure-meta-recipes-rt'> - <title><filename>meta/recipes-rt/</filename></title> - - <para> - This directory contains package and image recipes for using and testing - the <filename>PREEMPT_RT</filename> kernel. - </para> - </section> - - <section id='structure-meta-recipes-sato'> - <title><filename>meta/recipes-sato/</filename></title> - - <para> - This directory contains the Sato demo/reference UI/UX and its associated applications - and configuration data. - </para> - </section> - - <section id='structure-meta-recipes-support'> - <title><filename>meta/recipes-support/</filename></title> - - <para> - This directory contains recipes used by other recipes, but that are - not directly included in images (i.e. dependencies of other - recipes). - </para> - </section> - - <section id='structure-meta-site'> - <title><filename>meta/site/</filename></title> - - <para> - This directory contains a list of cached results for various architectures. - Because certain "autoconf" test results cannot be determined when cross-compiling due to - the tests not able to run on a live system, the information in this directory is - passed to "autoconf" for the various architectures. - </para> - </section> - - <section id='structure-meta-recipes-txt'> - <title><filename>meta/recipes.txt</filename></title> - - <para> - This file is a description of the contents of <filename>recipes-*</filename>. - </para> - </section> -</section> - -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-style.css b/documentation/ref-manual/ref-style.css deleted file mode 100644 index 7077e4b70d..0000000000 --- a/documentation/ref-manual/ref-style.css +++ /dev/null @@ -1,1032 +0,0 @@ -/* - Generic XHTML / DocBook XHTML CSS Stylesheet. - - Browser wrangling and typographic design by - Oyvind Kolas / pippin@gimp.org - - Customised for Poky by - Matthew Allum / mallum@o-hand.com - - Thanks to: - Liam R. E. Quin - William Skaggs - Jakub Steiner - - Structure - --------- - - The stylesheet is divided into the following sections: - - Positioning - Margins, paddings, width, font-size, clearing. - Decorations - Borders, style - Colors - Colors - Graphics - Graphical backgrounds - Nasty IE tweaks - Workarounds needed to make it work in internet explorer, - currently makes the stylesheet non validating, but up until - this point it is validating. - Mozilla extensions - Transparency for footer - Rounded corners on boxes - -*/ - - - /*************** / - / Positioning / -/ ***************/ - -body { - font-family: Verdana, Sans, sans-serif; - - min-width: 640px; - width: 80%; - margin: 0em auto; - padding: 2em 5em 5em 5em; - color: #333; -} - -h1,h2,h3,h4,h5,h6,h7 { - font-family: Arial, Sans; - color: #00557D; - clear: both; -} - -h1 { - font-size: 2em; - text-align: left; - padding: 0em 0em 0em 0em; - margin: 2em 0em 0em 0em; -} - -h2.subtitle { - margin: 0.10em 0em 3.0em 0em; - padding: 0em 0em 0em 0em; - font-size: 1.8em; - padding-left: 20%; - font-weight: normal; - font-style: italic; -} - -h2 { - margin: 2em 0em 0.66em 0em; - padding: 0.5em 0em 0em 0em; - font-size: 1.5em; - font-weight: bold; -} - -h3.subtitle { - margin: 0em 0em 1em 0em; - padding: 0em 0em 0em 0em; - font-size: 142.14%; - text-align: right; -} - -h3 { - margin: 1em 0em 0.5em 0em; - padding: 1em 0em 0em 0em; - font-size: 140%; - font-weight: bold; -} - -h4 { - margin: 1em 0em 0.5em 0em; - padding: 1em 0em 0em 0em; - font-size: 120%; - font-weight: bold; -} - -h5 { - margin: 1em 0em 0.5em 0em; - padding: 1em 0em 0em 0em; - font-size: 110%; - font-weight: bold; -} - -h6 { - margin: 1em 0em 0em 0em; - padding: 1em 0em 0em 0em; - font-size: 110%; - font-weight: bold; -} - -.authorgroup { - background-color: transparent; - background-repeat: no-repeat; - padding-top: 256px; - background-image: url("figures/poky-title.png"); - background-position: left top; - margin-top: -256px; - padding-right: 50px; - margin-left: 0px; - text-align: right; - width: 740px; -} - -h3.author { - margin: 0em 0me 0em 0em; - padding: 0em 0em 0em 0em; - font-weight: normal; - font-size: 100%; - color: #333; - clear: both; -} - -.author tt.email { - font-size: 66%; -} - -.titlepage hr { - width: 0em; - clear: both; -} - -.revhistory { - padding-top: 2em; - clear: both; -} - -.toc, -.list-of-tables, -.list-of-examples, -.list-of-figures { - padding: 1.33em 0em 2.5em 0em; - color: #00557D; -} - -.toc p, -.list-of-tables p, -.list-of-figures p, -.list-of-examples p { - padding: 0em 0em 0em 0em; - padding: 0em 0em 0.3em; - margin: 1.5em 0em 0em 0em; -} - -.toc p b, -.list-of-tables p b, -.list-of-figures p b, -.list-of-examples p b{ - font-size: 100.0%; - font-weight: bold; -} - -.toc dl, -.list-of-tables dl, -.list-of-figures dl, -.list-of-examples dl { - margin: 0em 0em 0.5em 0em; - padding: 0em 0em 0em 0em; -} - -.toc dt { - margin: 0em 0em 0em 0em; - padding: 0em 0em 0em 0em; -} - -.toc dd { - margin: 0em 0em 0em 2.6em; - padding: 0em 0em 0em 0em; -} - -/* Use this set when you decide to get the images in for variables. - -div.glossary dl, -div.variablelist dl { -} - -.glossary dl dt, -.variablelist dl dt, -.variablelist dl dt span.term { - font-weight: normal; - width: 0em; - text-align: right; -} - -.variablelist dl dt { - margin-top: 0.5em; -} - -.glossary dl dd, -.variablelist dl dd { - margin-top: 0em; - margin-left: 15.5em; - margin-bottom: 2em; -} - -.glossary dd p, -.variablelist dd p { - margin-top: 0em; - margin-bottom: 1em; -} - -.glossdeffirst { - text-indent: -70px; -} -*/ - -/* Start of non-image set */ - -div.glossary dl, -div.variablelist dl { -} - -.glossary dl dt, -.variablelist dl dt, -.variablelist dl dt span.term { - font-weight: normal; - width: 20em; - text-align: right; -} - -.variablelist dl dt { - margin-top: 0.5em; -} - -.glossary dl dd, -.variablelist dl dd { - margin-top: 0em; - margin-left: 25.5em; -} - -.glossary dd p, -.variablelist dd p { - margin-top: 0em; - margin-bottom: 1em; -} - -.glossdeffirst { - text-indent: 0px; -} - -/* End of non-image set */ - -div.calloutlist table td { - padding: 0em 0em 0em 0em; - margin: 0em 0em 0em 0em; -} - -div.calloutlist table td p { - margin-top: 0em; - margin-bottom: 1em; -} - -div p.copyright { - text-align: left; -} - -div.legalnotice p.legalnotice-title { - margin-bottom: 0em; -} - -p { - line-height: 1.5em; - margin-top: 0em; - -} - -dl { - padding-top: 0em; -} - -hr { - border: solid 1px; -} - - -.mediaobject, -.mediaobjectco { - text-align: center; -} - -img { - border: none; -} - -ul { - padding: 0em 0em 0em 1.5em; -} - -ul li { - padding: 0em 0em 0em 0em; -} - -ul li p { - text-align: left; -} - -table { - width :100%; -} - -th { - padding: 0.25em; - text-align: left; - font-weight: normal; - vertical-align: top; -} - -td { - padding: 0.25em; - vertical-align: top; -} - -p a[id] { - margin: 0px; - padding: 0px; - display: inline; - background-image: none; -} - -a { - text-decoration: underline; - color: #444; -} - -pre { - overflow: auto; -} - -a:hover { - text-decoration: underline; - /*font-weight: bold;*/ -} - -/* This style defines how the permalink character - appears by itself and when hovered over with - the mouse. */ - -[alt='Permalink'] { color: #eee; } -[alt='Permalink']:hover { color: black; } - - -div.informalfigure, -div.informalexample, -div.informaltable, -div.figure, -div.table, -div.example { - margin: 1em 0em; - padding: 1em; - page-break-inside: avoid; -} - - -div.informalfigure p.title b, -div.informalexample p.title b, -div.informaltable p.title b, -div.figure p.title b, -div.example p.title b, -div.table p.title b{ - padding-top: 0em; - margin-top: 0em; - font-size: 100%; - font-weight: normal; -} - -.mediaobject .caption, -.mediaobject .caption p { - text-align: center; - font-size: 80%; - padding-top: 0.5em; - padding-bottom: 0.5em; -} - -.epigraph { - padding-left: 55%; - margin-bottom: 1em; -} - -.epigraph p { - text-align: left; -} - -.epigraph .quote { - font-style: italic; -} -.epigraph .attribution { - font-style: normal; - text-align: right; -} - -span.application { - font-style: italic; -} - -.programlisting { - font-family: monospace; - font-size: 80%; - white-space: pre; - margin: 1.33em 0em; - padding: 1.33em; -} - -.tip, -.warning, -.caution, -.note { - margin-top: 1em; - margin-bottom: 1em; - -} - -/* force full width of table within div */ -.tip table, -.warning table, -.caution table, -.note table { - border: none; - width: 100%; -} - - -.tip table th, -.warning table th, -.caution table th, -.note table th { - padding: 0.8em 0.0em 0.0em 0.0em; - margin : 0em 0em 0em 0em; -} - -.tip p, -.warning p, -.caution p, -.note p { - margin-top: 0.5em; - margin-bottom: 0.5em; - padding-right: 1em; - text-align: left; -} - -.acronym { - text-transform: uppercase; -} - -b.keycap, -.keycap { - padding: 0.09em 0.3em; - margin: 0em; -} - -.itemizedlist li { - clear: none; -} - -.filename { - font-size: medium; - font-family: Courier, monospace; -} - - -div.navheader, div.heading{ - position: absolute; - left: 0em; - top: 0em; - width: 100%; - background-color: #cdf; - width: 100%; -} - -div.navfooter, div.footing{ - position: fixed; - left: 0em; - bottom: 0em; - background-color: #eee; - width: 100%; -} - - -div.navheader td, -div.navfooter td { - font-size: 66%; -} - -div.navheader table th { - /*font-family: Georgia, Times, serif;*/ - /*font-size: x-large;*/ - font-size: 80%; -} - -div.navheader table { - border-left: 0em; - border-right: 0em; - border-top: 0em; - width: 100%; -} - -div.navfooter table { - border-left: 0em; - border-right: 0em; - border-bottom: 0em; - width: 100%; -} - -div.navheader table td a, -div.navfooter table td a { - color: #777; - text-decoration: none; -} - -/* normal text in the footer */ -div.navfooter table td { - color: black; -} - -div.navheader table td a:visited, -div.navfooter table td a:visited { - color: #444; -} - - -/* links in header and footer */ -div.navheader table td a:hover, -div.navfooter table td a:hover { - text-decoration: underline; - background-color: transparent; - color: #33a; -} - -div.navheader hr, -div.navfooter hr { - display: none; -} - - -.qandaset tr.question td p { - margin: 0em 0em 1em 0em; - padding: 0em 0em 0em 0em; -} - -.qandaset tr.answer td p { - margin: 0em 0em 1em 0em; - padding: 0em 0em 0em 0em; -} -.answer td { - padding-bottom: 1.5em; -} - -.emphasis { - font-weight: bold; -} - - - /************* / - / decorations / -/ *************/ - -.titlepage { -} - -.part .title { -} - -.subtitle { - border: none; -} - -/* -h1 { - border: none; -} - -h2 { - border-top: solid 0.2em; - border-bottom: solid 0.06em; -} - -h3 { - border-top: 0em; - border-bottom: solid 0.06em; -} - -h4 { - border: 0em; - border-bottom: solid 0.06em; -} - -h5 { - border: 0em; -} -*/ - -.programlisting { - border: solid 1px; -} - -div.figure, -div.table, -div.informalfigure, -div.informaltable, -div.informalexample, -div.example { - border: 1px solid; -} - - - -.tip, -.warning, -.caution, -.note { - border: 1px solid; -} - -.tip table th, -.warning table th, -.caution table th, -.note table th { - border-bottom: 1px solid; -} - -.question td { - border-top: 1px solid black; -} - -.answer { -} - - -b.keycap, -.keycap { - border: 1px solid; -} - - -div.navheader, div.heading{ - border-bottom: 1px solid; -} - - -div.navfooter, div.footing{ - border-top: 1px solid; -} - - /********* / - / colors / -/ *********/ - -body { - color: #333; - background: white; -} - -a { - background: transparent; -} - -a:hover { - background-color: #dedede; -} - - -h1, -h2, -h3, -h4, -h5, -h6, -h7, -h8 { - background-color: transparent; -} - -hr { - border-color: #aaa; -} - - -.tip, .warning, .caution, .note { - border-color: #fff; -} - - -.tip table th, -.warning table th, -.caution table th, -.note table th { - border-bottom-color: #fff; -} - - -.warning { - background-color: #f0f0f2; -} - -.caution { - background-color: #f0f0f2; -} - -.tip { - background-color: #f0f0f2; -} - -.note { - background-color: #f0f0f2; -} - -.glossary dl dt, -.variablelist dl dt, -.variablelist dl dt span.term { - color: #044; -} - -div.figure, -div.table, -div.example, -div.informalfigure, -div.informaltable, -div.informalexample { - border-color: #aaa; -} - -pre.programlisting { - color: black; - background-color: #fff; - border-color: #aaa; - border-width: 2px; -} - -.guimenu, -.guilabel, -.guimenuitem { - background-color: #eee; -} - - -b.keycap, -.keycap { - background-color: #eee; - border-color: #999; -} - - -div.navheader { - border-color: black; -} - - -div.navfooter { - border-color: black; -} - -.writernotes { - color: red; -} - - - /*********** / - / graphics / -/ ***********/ - -/* -body { - background-image: url("images/body_bg.jpg"); - background-attachment: fixed; -} - -.navheader, -.note, -.tip { - background-image: url("images/note_bg.jpg"); - background-attachment: fixed; -} - -.warning, -.caution { - background-image: url("images/warning_bg.jpg"); - background-attachment: fixed; -} - -.figure, -.informalfigure, -.example, -.informalexample, -.table, -.informaltable { - background-image: url("images/figure_bg.jpg"); - background-attachment: fixed; -} - -*/ -h1, -h2, -h3, -h4, -h5, -h6, -h7{ -} - -/* -Example of how to stick an image as part of the title. - -div.article .titlepage .title -{ - background-image: url("figures/white-on-black.png"); - background-position: center; - background-repeat: repeat-x; -} -*/ - -div.preface .titlepage .title, -div.colophon .title, -div.chapter .titlepage .title, -div.article .titlepage .title -{ -} - -div.section div.section .titlepage .title, -div.sect2 .titlepage .title { - background: none; -} - - -h1.title { - background-color: transparent; - background-image: url("figures/poky-title.png"); - background-repeat: no-repeat; - height: 256px; - text-indent: -9000px; - overflow:hidden; -} - -h2.subtitle { - background-color: transparent; - text-indent: -9000px; - overflow:hidden; - width: 0px; - display: none; -} - - /*************************************** / - / pippin.gimp.org specific alterations / -/ ***************************************/ - -/* -div.heading, div.navheader { - color: #777; - font-size: 80%; - padding: 0; - margin: 0; - text-align: left; - position: absolute; - top: 0px; - left: 0px; - width: 100%; - height: 50px; - background: url('/gfx/heading_bg.png') transparent; - background-repeat: repeat-x; - background-attachment: fixed; - border: none; -} - -div.heading a { - color: #444; -} - -div.footing, div.navfooter { - border: none; - color: #ddd; - font-size: 80%; - text-align:right; - - width: 100%; - padding-top: 10px; - position: absolute; - bottom: 0px; - left: 0px; - - background: url('/gfx/footing_bg.png') transparent; -} -*/ - - - - /****************** / - / nasty ie tweaks / -/ ******************/ - -/* -div.heading, div.navheader { - width:expression(document.body.clientWidth + "px"); -} - -div.footing, div.navfooter { - width:expression(document.body.clientWidth + "px"); - margin-left:expression("-5em"); -} -body { - padding:expression("4em 5em 0em 5em"); -} -*/ - - /**************************************** / - / mozilla vendor specific css extensions / -/ ****************************************/ -/* -div.navfooter, div.footing{ - -moz-opacity: 0.8em; -} - -div.figure, -div.table, -div.informalfigure, -div.informaltable, -div.informalexample, -div.example, -.tip, -.warning, -.caution, -.note { - -moz-border-radius: 0.5em; -} - -b.keycap, -.keycap { - -moz-border-radius: 0.3em; -} -*/ - -table tr td table tr td { - display: none; -} - - -hr { - display: none; -} - -table { - border: 0em; -} - - .photo { - float: right; - margin-left: 1.5em; - margin-bottom: 1.5em; - margin-top: 0em; - max-width: 17em; - border: 1px solid gray; - padding: 3px; - background: white; -} - .seperator { - padding-top: 2em; - clear: both; - } - - #validators { - margin-top: 5em; - text-align: right; - color: #777; - } - @media print { - body { - font-size: 8pt; - } - .noprint { - display: none; - } - } - - -.tip, -.note { - background: #f0f0f2; - color: #333; - padding: 20px; - margin: 20px; -} - -.tip h3, -.note h3 { - padding: 0em; - margin: 0em; - font-size: 2em; - font-weight: bold; - color: #333; -} - -.tip a, -.note a { - color: #333; - text-decoration: underline; -} - -.footnote { - font-size: small; - color: #333; -} - -/* Changes the announcement text */ -.tip h3, -.warning h3, -.caution h3, -.note h3 { - font-size:large; - color: #00557D; -} diff --git a/documentation/ref-manual/ref-system-requirements.xml b/documentation/ref-manual/ref-system-requirements.xml deleted file mode 100644 index 5f2b9f6ce1..0000000000 --- a/documentation/ref-manual/ref-system-requirements.xml +++ /dev/null @@ -1,451 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-manual-system-requirements'> -<title>System Requirements</title> - - <para> - Welcome to the Yocto Project Reference Manual! - This manual provides reference information for the current release - of the Yocto Project. - The manual is best 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. - Use this manual to find variable definitions, class - descriptions, and so forth as needed during the course of using - the Yocto Project. - </para> - - <para> - For introductory information on the Yocto Project, see the - <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink> and the - "<ulink url='&YOCTO_DOCS_OM_URL;#overview-development-environment'>Yocto Project Development Environment</ulink>" - chapter in the Yocto Project Overview and Concepts Manual. - </para> - - <para> - If you want to use the Yocto Project to quickly build an image - without having to understand concepts, work through the - <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink> - document. - You can find "how-to" information in the - <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink>. - You can find Yocto Project overview and conceptual information in the - <ulink url='&YOCTO_DOCS_OM_URL;'>Yocto Project Overview and Concepts Manual</ulink>. - <note><title>Tip</title> - For more information about the Yocto Project Documentation set, - see the - "<link linkend='resources-links-and-related-documentation'>Links and Related Documentation</link>" - section. - </note> - </para> - - <section id='detailed-supported-distros'> - <title>Supported Linux Distributions</title> - - <para> - Currently, the Yocto Project is supported on the following - distributions: - <note><title>Notes</title> - <itemizedlist> - <listitem><para> - Yocto Project releases are tested against the stable - Linux distributions in the following list. - The Yocto Project should work on other distributions but - validation is not performed against them. - </para></listitem> - <listitem><para> - In particular, the Yocto Project does not support - and currently has no plans to support - rolling-releases or development distributions due to - their constantly changing nature. - We welcome patches and bug reports, but keep in mind - that our priority is on the supported platforms listed - below. - </para></listitem> - <listitem><para> - The Yocto Project is not compatible with the - <ulink url='https://en.wikipedia.org/wiki/Windows_Subsystem_for_Linux'>Windows Subsystem for Linux</ulink> - (WSL). - You cannot use a - <link linkend='hardware-build-system-term'>build host</link> - that is running WSL. - </para></listitem> - <listitem><para> - If you encounter problems, please go to - <ulink url='&YOCTO_BUGZILLA_URL;'>Yocto Project Bugzilla</ulink> - and submit a bug. - We are interested in hearing about your experience. - For information on how to submit a bug, see the - Yocto Project - <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>Bugzilla wiki page</ulink> - and the - "<ulink url='&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project'>Submitting a Defect Against the Yocto Project</ulink>" - section in the Yocto Project Development Tasks Manual. - </para></listitem> - </itemizedlist> - </note> - <itemizedlist> - <listitem><para>Ubuntu 16.04 (LTS)</para></listitem> - <listitem><para>Ubuntu 18.04</para></listitem> - <listitem><para>Fedora 28</para></listitem> - <listitem><para>CentOS 7.x</para></listitem> - <listitem><para>Debian GNU/Linux 8.x (Jessie)</para></listitem> - <listitem><para>Debian GNU/Linux 9.x (Stretch)</para></listitem> - <listitem><para>OpenSUSE 42.3</para></listitem> - </itemizedlist> - </para> - - -<!-- <listitem><para>Ubuntu 10.04</para></listitem> - <listitem><para>Ubuntu 11.10</para></listitem> - <listitem><para>Ubuntu 12.04 (LTS)</para></listitem> - <listitem><para>Ubuntu 13.10</para></listitem> - <listitem><para>Ubuntu 14.04 (LTS)</para></listitem> - <listitem><para>Ubuntu 14.10</para></listitem> - <listitem><para>Ubuntu 15.04</para></listitem> - <listitem><para>Ubuntu 15.10</para></listitem> - <listitem><para>Ubuntu 16.04 (LTS)</para></listitem> - <listitem><para>Ubuntu 16.10 (LTS)</para></listitem> - <listitem><para>Ubuntu 17.04</para></listitem> - <listitem><para>Fedora 16 (Verne)</para></listitem> - <listitem><para>Fedora 17 (Spherical)</para></listitem> - <listitem><para>Fedora 19 (Schrödinger's Cat)</para></listitem> - <listitem><para>Fedora release 20 (Heisenbug)</para></listitem> - <listitem><para>Fedora release 22</para></listitem> - <listitem><para>Fedora release 23</para></listitem> - <listitem><para>Fedora release 24</para></listitem> - <listitem><para>Fedora release 26</para></listitem> - <listitem><para>CentOS release 5.6 (Final)</para></listitem> - <listitem><para>CentOS release 5.7 (Final)</para></listitem> - <listitem><para>CentOS release 5.8 (Final)</para></listitem> - <listitem><para>CentOS release 6.3 (Final)</para></listitem> - <listitem><para>CentOS release 6.x</para></listitem> - <listitem><para>CentOS release 7.x</para></listitem> - <listitem><para>Debian GNU/Linux 6.0 (Squeeze)</para></listitem> - <listitem><para>Debian GNU/Linux 7.x (Wheezy)</para></listitem> - <listitem><para>Debian GNU/Linux 8.x (Jessie)</para></listitem> - <listitem><para>Debian GNU/Linux 9.x (Stretch)</para></listitem> - <listitem><para>Debian GNU/Linux 7.1 (Wheezy)</para></listitem> - <listitem><para>Debian GNU/Linux 7.2 (Wheezy)</para></listitem> - <listitem><para>Debian GNU/Linux 7.3 (Wheezy)</para></listitem> - <listitem><para>Debian GNU/Linux 7.4 (Wheezy)</para></listitem> - <listitem><para>Debian GNU/Linux 7.5 (Wheezy)</para></listitem> - <listitem><para>Debian GNU/Linux 7.6 (Wheezy)</para></listitem> - <listitem><para>openSUSE 11.4</para></listitem> - <listitem><para>openSUSE 12.1</para></listitem> - <listitem><para>openSUSE 12.2</para></listitem> - <listitem><para>openSUSE 12.3</para></listitem> - <listitem><para>openSUSE 13.1</para></listitem> - <listitem><para>openSUSE 13.2</para></listitem> - <listitem><para>openSUSE 42.1</para></listitem> - <listitem><para>openSUSE 42.2</para></listitem> - </itemizedlist> ---> - - - <note> - While the Yocto Project Team attempts to ensure all Yocto Project - releases are one hundred percent compatible with each officially - supported Linux distribution, instances might exist where you - encounter a problem while using the Yocto Project on a specific - distribution. - </note> - </section> - - <section id='required-packages-for-the-build-host'> - <title>Required Packages for the Build Host</title> - - <para> - The list of packages you need on the host development system can - be large when covering all build scenarios using the Yocto Project. - This section provides required packages according to - Linux distribution and function. - </para> - - <section id='ubuntu-packages'> - <title>Ubuntu and Debian</title> - - <para> - The following list shows the required packages by function - given a supported Ubuntu or Debian Linux distribution: - <note> - If your build system has the - <filename>oss4-dev</filename> package installed, you - might experience QEMU build failures due to the package - installing its own custom - <filename>/usr/include/linux/soundcard.h</filename> on - the Debian system. - If you run into this situation, either of the following - solutions exist: - <literallayout class='monospaced'> - $ sudo apt-get build-dep qemu - $ sudo apt-get remove oss4-dev - </literallayout> - </note> - <itemizedlist> - <listitem><para><emphasis>Essentials:</emphasis> - Packages needed to build an image on a headless - system: - <literallayout class='monospaced'> - $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; - </literallayout></para></listitem> - <listitem><para><emphasis>Documentation:</emphasis> - Packages needed if you are going to build out the - Yocto Project documentation manuals: - <literallayout class='monospaced'> - $ sudo apt-get install make xsltproc docbook-utils fop dblatex xmlto - </literallayout></para></listitem> - </itemizedlist> - </para> - </section> - - <section id='fedora-packages'> - <title>Fedora Packages</title> - - <para> - The following list shows the required packages by function - given a supported Fedora Linux distribution: - <itemizedlist> - <listitem><para><emphasis>Essentials:</emphasis> - Packages needed to build an image for a headless - system: - <literallayout class='monospaced'> - $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; - </literallayout></para></listitem> - <listitem><para><emphasis>Documentation:</emphasis> - Packages needed if you are going to build out the - Yocto Project documentation manuals: - <literallayout class='monospaced'> - $ sudo dnf install docbook-style-dsssl docbook-style-xsl \ - docbook-dtds docbook-utils fop libxslt dblatex xmlto - </literallayout></para></listitem> - </itemizedlist> - </para> - </section> - - <section id='opensuse-packages'> - <title>openSUSE Packages</title> - - <para> - The following list shows the required packages by function - given a supported openSUSE Linux distribution: - <itemizedlist> - <listitem><para><emphasis>Essentials:</emphasis> - Packages needed to build an image for a headless - system: - <literallayout class='monospaced'> - $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; - </literallayout></para></listitem> - <listitem><para><emphasis>Documentation:</emphasis> - Packages needed if you are going to build out the - Yocto Project documentation manuals: - <literallayout class='monospaced'> - $ sudo zypper install dblatex xmlto - </literallayout></para></listitem> - </itemizedlist> - </para> - </section> - - <section id='centos-packages'> - <title>CentOS Packages</title> - - <para> - The following list shows the required packages by function - given a supported CentOS Linux distribution: - <itemizedlist> - <listitem><para><emphasis>Essentials:</emphasis> - Packages needed to build an image for a headless - system: - <literallayout class='monospaced'> - $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL; - </literallayout> - <note><title>Notes</title> - <itemizedlist> - <listitem><para> - Extra Packages for Enterprise Linux - (i.e. <filename>epel-release</filename>) - 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. - </para></listitem> - <listitem><para> - The <filename>makecache</filename> command - consumes additional Metadata from - <filename>epel-release</filename>. - </para></listitem> - </itemizedlist> - </note> - </para></listitem> - <listitem><para><emphasis>Documentation:</emphasis> - Packages needed if you are going to build out the - Yocto Project documentation manuals: - <literallayout class='monospaced'> - $ sudo yum install docbook-style-dsssl docbook-style-xsl \ - docbook-dtds docbook-utils fop libxslt dblatex xmlto - </literallayout></para></listitem> - </itemizedlist> - </para> - </section> - </section> - - <section id='required-git-tar-and-python-versions'> - <title>Required Git, tar, and Python Versions</title> - - <para> - In order to use the build system, your host development system - must meet the following version requirements for Git, tar, and - Python: - <itemizedlist> - <listitem><para>Git 1.8.3.1 or greater</para></listitem> - <listitem><para>tar 1.27 or greater</para></listitem> - <listitem><para>Python 3.4.0 or greater</para></listitem> - </itemizedlist> - </para> - - <para> - If your host development system does not meet all these requirements, - you can resolve this by installing a <filename>buildtools</filename> - tarball that contains these tools. - You can get the tarball one of two ways: download a pre-built - tarball or use BitBake to build the tarball. - </para> - - <section id='downloading-a-pre-built-buildtools-tarball'> - <title>Downloading a Pre-Built <filename>buildtools</filename> Tarball</title> - - <para> - Downloading and running a pre-built buildtools installer is - the easiest of the two methods by which you can get these tools: - <orderedlist> - <listitem><para> - Locate and download the <filename>*.sh</filename> at - <ulink url='&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;/buildtools/'></ulink>. - </para></listitem> - <listitem><para> - Execute the installation script. - Here is an example: - <literallayout class='monospaced'> - $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh - </literallayout> - During execution, a prompt appears that allows you to - choose the installation directory. - For example, you could choose the following: - <literallayout class='monospaced'> - /home/<replaceable>your-username</replaceable>/buildtools - </literallayout> - </para></listitem> - <listitem><para> - Source the tools environment setup script by using a - command like the following: - <literallayout class='monospaced'> - $ source /home/<replaceable>your_username</replaceable>/buildtools/environment-setup-i586-poky-linux - </literallayout> - Of course, you need to supply your installation directory and be - sure to use the right file (i.e. i585 or x86-64). - </para> - <para> - After you have sourced the setup script, - the tools are added to <filename>PATH</filename> - and any other environment variables required to run the - tools are initialized. - The results are working versions versions of Git, tar, - Python and <filename>chrpath</filename>. - </para></listitem> - </orderedlist> - </para> - </section> - - <section id='building-your-own-buildtools-tarball'> - <title>Building Your Own <filename>buildtools</filename> Tarball</title> - - <para> - Building and running your own buildtools installer applies - only when you have a build host that can already run BitBake. - In this case, you use that machine to build the - <filename>.sh</filename> file and then - take steps to transfer and run it on a - machine that does not meet the minimal Git, tar, and Python - requirements. - </para> - - <para> - Here are the steps to take to build and run your own - buildtools installer: - <orderedlist> - <listitem><para> - On the machine that is able to run BitBake, - be sure you have set up your build environment with - the setup script - (<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). - </para></listitem> - <listitem><para> - Run the BitBake command to build the tarball: - <literallayout class='monospaced'> - $ bitbake buildtools-tarball - </literallayout> - <note> - The - <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link> - variable in your <filename>local.conf</filename> file - determines whether you build tools for a 32-bit - or 64-bit system. - </note> - Once the build completes, you can find the - <filename>.sh</filename> file that installs - the tools in the <filename>tmp/deploy/sdk</filename> - subdirectory of the - <link linkend='build-directory'>Build Directory</link>. - The installer file has the string "buildtools" - in the name. - </para></listitem> - <listitem><para> - Transfer the <filename>.sh</filename> file from the - build host to the machine that does not meet the - Git, tar, or Python requirements. - </para></listitem> - <listitem><para> - On the machine that does not meet the requirements, - run the <filename>.sh</filename> file - to install the tools. - Here is an example: - <literallayout class='monospaced'> - $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh - </literallayout> - During execution, a prompt appears that allows you to - choose the installation directory. - For example, you could choose the following: - <literallayout class='monospaced'> - /home/<replaceable>your_username</replaceable>/buildtools - </literallayout> - </para></listitem> - <listitem><para> - Source the tools environment setup script by using a - command like the following: - <literallayout class='monospaced'> - $ source /home/<replaceable>your_username</replaceable>/buildtools/environment-setup-i586-poky-linux - </literallayout> - Of course, you need to supply your installation directory and be - sure to use the right file (i.e. i585 or x86-64). - </para> - <para> - After you have sourced the setup script, - the tools are added to <filename>PATH</filename> - and any other environment variables required to run the - tools are initialized. - The results are working versions versions of Git, tar, - Python and <filename>chrpath</filename>. - </para></listitem> - </orderedlist> - </para> - </section> - </section> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml deleted file mode 100644 index 8f3ff26d24..0000000000 --- a/documentation/ref-manual/ref-tasks.xml +++ /dev/null @@ -1,1146 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-tasks'> -<title>Tasks</title> - -<para> - Tasks are units of execution for BitBake. - Recipes (<filename>.bb</filename> files) use tasks to complete - configuring, compiling, and packaging software. - This chapter provides a reference of the tasks defined in the - OpenEmbedded build system. -</para> - -<section id='normal-recipe-build-tasks'> - <title>Normal Recipe Build Tasks</title> - - <para> - The following sections describe normal tasks associated with building - a recipe. - For more information on tasks and dependencies, see the - "<ulink url='&YOCTO_DOCS_BB_URL;#tasks'>Tasks</ulink>" and - "<ulink url='&YOCTO_DOCS_BB_URL;#dependencies'>Dependencies</ulink>" - sections in the BitBake User Manual. - </para> - - <section id='ref-tasks-build'> - <title><filename>do_build</filename></title> - - <para> - The default task for all recipes. - This task depends on all other normal tasks - required to build a recipe. - </para> - </section> - - <section id='ref-tasks-compile'> - <title><filename>do_compile</filename></title> - - <para> - Compiles the source code. - This task runs with the current working directory set - to - <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>. - </para> - - <para> - The default behavior of this task is to run the - <filename>oe_runmake</filename> function if a makefile - (<filename>Makefile</filename>, <filename>makefile</filename>, - or <filename>GNUmakefile</filename>) is found. - If no such file is found, the <filename>do_compile</filename> - task does nothing. - </para> - </section> - - <section id='ref-tasks-compile_ptest_base'> - <title><filename>do_compile_ptest_base</filename></title> - - <para> - Compiles the runtime test suite included in the software being - built. - </para> - </section> - - <section id='ref-tasks-configure'> - <title><filename>do_configure</filename></title> - - <para> - Configures the source by enabling and disabling any build-time and - configuration options for the software being built. - The task runs with the current working directory set to - <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>. - </para> - - <para> - The default behavior of this task is to run - <filename>oe_runmake clean</filename> if a makefile - (<filename>Makefile</filename>, <filename>makefile</filename>, - or <filename>GNUmakefile</filename>) is found and - <link linkend='var-CLEANBROKEN'><filename>CLEANBROKEN</filename></link> - is not set to "1". - If no such file is found or the <filename>CLEANBROKEN</filename> - variable is set to "1", the <filename>do_configure</filename> - task does nothing. - </para> - </section> - - <section id='ref-tasks-configure_ptest_base'> - <title><filename>do_configure_ptest_base</filename></title> - - <para> - Configures the runtime test suite included in the software being - built. - </para> - </section> - - <section id='ref-tasks-deploy'> - <title><filename>do_deploy</filename></title> - - <para> - Writes output files that are to be deployed to - <filename>${</filename><link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link><filename>}</filename>. - The task runs with the current working directory set to - <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>. - </para> - - <para> - Recipes implementing this task should inherit the - <link linkend='ref-classes-deploy'><filename>deploy</filename></link> - class and should write the output to - <filename>${</filename><link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link><filename>}</filename>, - which is not to be confused with <filename>${DEPLOY_DIR}</filename>. - The <filename>deploy</filename> class sets up - <filename>do_deploy</filename> as a shared state (sstate) task that - can be accelerated through sstate use. - The sstate mechanism takes care of copying the output from - <filename>${DEPLOYDIR}</filename> to - <filename>${DEPLOY_DIR_IMAGE}</filename>. - <note> - <title>Caution</title> - Do not write the output directly to - <filename>${DEPLOY_DIR_IMAGE}</filename>, as this causes - the sstate mechanism to malfunction. - </note> - </para> - - <para> - The <filename>do_deploy</filename> task is not added as a task - by default and consequently needs to be added manually. - If you want the task to run after - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>, - you can add it by doing the following: - <literallayout class='monospaced'> - addtask deploy after do_compile - </literallayout> - Adding <filename>do_deploy</filename> after other tasks works the - same way. - <note> - You do not need to add <filename>before do_build</filename> - to the <filename>addtask</filename> command (though it is - harmless), because the - <link linkend='ref-classes-base'><filename>base</filename></link> - class contains the following: - <literallayout class='monospaced'> - do_build[recrdeptask] += "do_deploy" - </literallayout> - See the - "<ulink url='&YOCTO_DOCS_BB_URL;#dependencies'>Dependencies</ulink>" - section in the BitBake User Manual for more information. - </note> - </para> - - <para> - If the <filename>do_deploy</filename> task re-executes, any - previous output is removed (i.e. "cleaned"). - </para> - </section> - - <section id='ref-tasks-distrodata'> - <title><filename>do_distrodata</filename></title> - - <para> - Provides information about the recipe. - </para> - - <para> - The <filename>distrodata</filename> task is included as part of the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class. - </para> - - <para> - To build the <filename>distrodata</filename> task, use the - <filename>bitbake</filename> command with the "-c" option and - task name: - <literallayout class='monospaced'> - $ bitbake core-image-minimal -c distrodata - </literallayout> - By default, the results are stored in - <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link> - (e.g. <filename>$BUILD_DIR/tmp/log</filename>). - </para> - </section> - - <section id='ref-tasks-fetch'> - <title><filename>do_fetch</filename></title> - - <para> - Fetches the source code. - This task uses the - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - variable and the argument's prefix to determine the correct - fetcher module. - </para> - </section> - - <section id='ref-tasks-image'> - <title><filename>do_image</filename></title> - - <para> - Starts the image generation process. - The <filename>do_image</filename> task runs after the - OpenEmbedded build system has run the - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> - task during which packages are identified for installation into - the image and the root filesystem is created, complete with - post-processing. - </para> - - <para> - The <filename>do_image</filename> task performs pre-processing - on the image through the - <link linkend='var-IMAGE_PREPROCESS_COMMAND'><filename>IMAGE_PREPROCESS_COMMAND</filename></link> - and dynamically generates supporting - <filename>do_image_*</filename> tasks as needed. - </para> - - <para> - For more information on image creation, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#image-generation-dev-environment'>Image Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </section> - - <section id='ref-tasks-image-complete'> - <title><filename>do_image_complete</filename></title> - - <para> - Completes the image generation process. - The <filename>do_image_complete</filename> task runs after the - OpenEmbedded build system has run the - <link linkend='ref-tasks-image'><filename>do_image</filename></link> - task during which image pre-processing occurs and through - dynamically generated <filename>do_image_*</filename> tasks the - image is constructed. - </para> - - <para> - The <filename>do_image_complete</filename> task performs - post-processing on the image through the - <link linkend='var-IMAGE_POSTPROCESS_COMMAND'><filename>IMAGE_POSTPROCESS_COMMAND</filename></link>. - </para> - - <para> - For more information on image creation, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#image-generation-dev-environment'>Image Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </section> - - <section id='ref-tasks-install'> - <title><filename>do_install</filename></title> - - <para> - Copies files that are to be packaged into the holding area - <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename>. - This task runs with the current working directory set to - <filename>${</filename><link linkend='var-B'><filename>B</filename></link><filename>}</filename>, - which is the compilation directory. - The <filename>do_install</filename> task, as well as other tasks - that either directly or indirectly depend on the installed files - (e.g. - <link linkend='ref-tasks-package'><filename>do_package</filename></link>, - <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_*</filename></link>, - and - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link>), - run under - <ulink url='&YOCTO_DOCS_OM_URL;#fakeroot-and-pseudo'>fakeroot</ulink>. - <note> - <title>Caution</title> - - <para> - 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 <filename>cp</filename> command, can preserve the - UID and/or GID of the original file, which is usually not - what you want. - The - <link linkend='insane-host-user-contaminated'><filename>host-user-contaminated</filename></link> - QA check checks for files that probably have the wrong - ownership. - </para> - - <para> - Safe methods for installing files include the following: - <itemizedlist> - <listitem><para> - The <filename>install</filename> utility. - This utility is the preferred method. - </para></listitem> - <listitem><para> - The <filename>cp</filename> command with the - "--no-preserve=ownership" option. - </para></listitem> - <listitem><para> - The <filename>tar</filename> command with the - "--no-same-owner" option. - See the <filename>bin_package.bbclass</filename> - file in the <filename>meta/classes</filename> - directory of the - <link linkend='source-directory'>Source Directory</link> - for an example. - </para></listitem> - </itemizedlist> - </para> - </note> - </para> - </section> - - <section id='ref-tasks-install_ptest_base'> - <title><filename>do_install_ptest_base</filename></title> - - <para> - Copies the runtime test suite files from the compilation directory - to a holding area. - </para> - </section> - - <section id='ref-tasks-package'> - <title><filename>do_package</filename></title> - - <para> - Analyzes the content of the holding area - <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> - and splits the content into subsets based on available packages - and files. - This task makes use of the - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> - and - <link linkend='var-FILES'><filename>FILES</filename></link> - variables. - </para> - - <para> - The <filename>do_package</filename> task, in conjunction with the - <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link> - task, also saves some important package metadata. - For additional information, see the - <link linkend='var-PKGDESTWORK'><filename>PKGDESTWORK</filename></link> - variable and the - "<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </section> - - <section id='ref-tasks-package_qa'> - <title><filename>do_package_qa</filename></title> - - <para> - Runs QA checks on packaged files. - For more information on these checks, see the - <link linkend='ref-classes-insane'><filename>insane</filename></link> - class. - </para> - </section> - - <section id='ref-tasks-package_write_deb'> - <title><filename>do_package_write_deb</filename></title> - - <para> - Creates Debian packages (i.e. <filename>*.deb</filename> files) and - places them in the - <filename>${</filename><link linkend='var-DEPLOY_DIR_DEB'><filename>DEPLOY_DIR_DEB</filename></link><filename>}</filename> - directory in the package feeds area. - For more information, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </section> - - <section id='ref-tasks-package_write_ipk'> - <title><filename>do_package_write_ipk</filename></title> - - <para> - Creates IPK packages (i.e. <filename>*.ipk</filename> files) and - places them in the - <filename>${</filename><link linkend='var-DEPLOY_DIR_IPK'><filename>DEPLOY_DIR_IPK</filename></link><filename>}</filename> - directory in the package feeds area. - For more information, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </section> - - <section id='ref-tasks-package_write_rpm'> - <title><filename>do_package_write_rpm</filename></title> - - <para> - Creates RPM packages (i.e. <filename>*.rpm</filename> files) and - places them in the - <filename>${</filename><link linkend='var-DEPLOY_DIR_RPM'><filename>DEPLOY_DIR_RPM</filename></link><filename>}</filename> - directory in the package feeds area. - For more information, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </section> - - <section id='ref-tasks-package_write_tar'> - <title><filename>do_package_write_tar</filename></title> - - <para> - Creates tarballs and places them in the - <filename>${</filename><link linkend='var-DEPLOY_DIR_TAR'><filename>DEPLOY_DIR_TAR</filename></link><filename>}</filename> - directory in the package feeds area. - For more information, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </section> - - <section id='ref-tasks-packagedata'> - <title><filename>do_packagedata</filename></title> - - <para> - Saves package metadata generated by the - <link linkend='ref-tasks-package'><filename>do_package</filename></link> - task in - <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> - to make it available globally. - </para> - </section> - - <section id='ref-tasks-patch'> - <title><filename>do_patch</filename></title> - - <para> - Locates patch files and applies them to the source code. - </para> - - <para> - After fetching and unpacking source files, the build system - uses the recipe's - <ulink url='&YOCTO_DOCS_REF_URL;#var-SRC_URI'><filename>SRC_URI</filename></ulink> - statements to locate and apply patch files to the source code. - <note> - The build system uses the - <ulink url='&YOCTO_DOCS_REF_URL;#var-FILESPATH'><filename>FILESPATH</filename></ulink> - variable to determine the default set of directories when - searching for patches. - </note> - Patch files, by default, are <filename>*.patch</filename> and - <filename>*.diff</filename> files created and kept in a - subdirectory of the directory holding the recipe file. - For example, consider the - <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/recipes-connectivity/bluez5'><filename>bluez5</filename></ulink> - recipe from the OE-Core layer (i.e. - <filename>poky/meta</filename>): - <literallayout class='monospaced'> - poky/meta/recipes-connectivity/bluez5 - </literallayout> - This recipe has two patch files located here: - <literallayout class='monospaced'> - poky/meta/recipes-connectivity/bluez5/bluez5 - </literallayout> - </para> - - <para> - In the <filename>bluez5</filename> recipe, the - <filename>SRC_URI</filename> statements point to the source and - patch files needed to build the package. - <note> - In the case for the <filename>bluez5_5.48.bb</filename> - recipe, the <filename>SRC_URI</filename> statements are from an - include file <filename>bluez5.inc</filename>. - </note> - </para> - - <para> - As mentioned earlier, the build system treats files whose file - types are <filename>.patch</filename> and - <filename>.diff</filename> as patch files. - However, you can use the "apply=yes" parameter with the - <filename>SRC_URI</filename> statement to indicate any file as a - patch file: - <literallayout class='monospaced'> - SRC_URI = " \ - git://<replaceable>path_to_repo</replaceable>/<replaceable>some_package</replaceable> \ - file://<replaceable>file</replaceable>;apply=yes \ - " - </literallayout> - </para> - - <para> - Conversely, if you have a directory full of patch files and you - want to exclude some so that the <filename>do_patch</filename> - task does not apply them during the patch phase, you can use - the "apply=no" parameter with the <filename>SRC_URI</filename> - statement: - <literallayout class='monospaced'> - SRC_URI = " \ - git://<replaceable>path_to_repo</replaceable>/<replaceable>some_package</replaceable> \ - file://<replaceable>path_to_lots_of_patch_files</replaceable> \ - file://<replaceable>path_to_lots_of_patch_files</replaceable>/<replaceable>patch_file5</replaceable>;apply=no \ - " - </literallayout> - In the previous example, assuming all the files in the directory - holding the patch files end with either <filename>.patch</filename> - or <filename>.diff</filename>, every file would be applied as a - patch by default except for the - <replaceable>patch_file5</replaceable> patch. - </para> - - <para> - You can find out more about the patching process in the - "<ulink url='&YOCTO_DOCS_OM_URL;#patching-dev-environment'>Patching</ulink>" - section in the Yocto Project Overview and Concepts Manual and the - "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-patching-code'>Patching Code</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='ref-tasks-populate_lic'> - <title><filename>do_populate_lic</filename></title> - - <para> - Writes license information for the recipe that is collected later - when the image is constructed. - </para> - </section> - - <section id='ref-tasks-populate_sdk'> - <title><filename>do_populate_sdk</filename></title> - - <para> - Creates the file and directory structure for an installable SDK. - See the - "<ulink url='&YOCTO_DOCS_OM_URL;#sdk-generation-dev-environment'>SDK Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual for more - information. - </para> - </section> - - <section id='ref-tasks-populate_sysroot'> - <title><filename>do_populate_sysroot</filename></title> - - <para> - Stages (copies) a subset of the files installed by the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task into the appropriate sysroot. - For information on how to access these files from other recipes, - see the - <link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR*</filename></link> - variables. - Directories that would typically not be needed by other recipes at - build time (e.g. <filename>/etc</filename>) are not copied by - default. - </para> - - <para> - For information on what directories are copied by default, see the - <link linkend='var-SYSROOT_DIRS'><filename>SYSROOT_DIRS*</filename></link> - 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. - </para> - - <para> - The <filename>do_populate_sysroot</filename> task is a - shared state (sstate) task, which means that the task can - be accelerated through sstate use. - Realize also that if the task is re-executed, any previous output - is removed (i.e. "cleaned"). - </para> - </section> - - <section id='ref-tasks-prepare_recipe_sysroot'> - <title><filename>do_prepare_recipe_sysroot</filename></title> - - <para> - Installs the files into the individual recipe specific sysroots - (i.e. <filename>recipe-sysroot</filename> and - <filename>recipe-sysroot-native</filename> under - <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}</filename> - based upon the dependencies specified by - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>). - See the - "<link linkend='ref-classes-staging'><filename>staging</filename></link>" - class for more information. - </para> - </section> - - <section id='ref-tasks-rm_work'> - <title><filename>do_rm_work</filename></title> - - <para> - Removes work files after the OpenEmbedded build system has - finished with them. - You can learn more by looking at the - "<link linkend='ref-classes-rm-work'><filename>rm_work.bbclass</filename></link>" - section. - </para> - </section> - - <section id='ref-tasks-unpack'> - <title><filename>do_unpack</filename></title> - - <para> - Unpacks the source code into a working directory pointed to - by - <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}</filename>. - The - <link linkend='var-S'><filename>S</filename></link> variable also - plays a role in where unpacked source files ultimately reside. - For more information on how source files are unpacked, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#source-fetching-dev-environment'>Source Fetching</ulink>" - section in the Yocto Project Overview and Concepts Manual and also - see the <filename>WORKDIR</filename> and - <filename>S</filename> variable descriptions. - </para> - </section> -</section> - -<section id='manually-called-tasks'> - <title>Manually Called Tasks</title> - - <para> - These tasks are typically manually triggered (e.g. by using the - <filename>bitbake -c</filename> command-line option): - </para> - - <section id='ref-tasks-checkpkg'> - <title><filename>do_checkpkg</filename></title> - - <para> - Provides information about the recipe including its upstream - version and status. - The upstream version and status reveals whether or not a version - of the recipe exists upstream and a status of not updated, updated, - or unknown. - </para> - - <para> - The <filename>checkpkg</filename> task is included as part of the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class. - </para> - - <para> - To build the <filename>checkpkg</filename> task, use the - <filename>bitbake</filename> command with the "-c" option and - task name: - <literallayout class='monospaced'> - $ bitbake core-image-minimal -c checkpkg - </literallayout> - By default, the results are stored in - <link linkend='var-LOG_DIR'><filename>$LOG_DIR</filename></link> - (e.g. <filename>$BUILD_DIR/tmp/log</filename>). - </para> - </section> - - <section id='ref-tasks-checkuri'> - <title><filename>do_checkuri</filename></title> - - <para> - Validates the - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - value. - </para> - </section> - - <section id='ref-tasks-clean'> - <title><filename>do_clean</filename></title> - - <para> - Removes all output files for a target from the - <link linkend='ref-tasks-unpack'><filename>do_unpack</filename></link> - task forward (i.e. <filename>do_unpack</filename>, - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>, - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>, - <link linkend='ref-tasks-install'><filename>do_install</filename></link>, - and - <link linkend='ref-tasks-package'><filename>do_package</filename></link>). - </para> - - <para> - You can run this task using BitBake as follows: - <literallayout class='monospaced'> - $ bitbake -c clean <replaceable>recipe</replaceable> - </literallayout> - </para> - - <para> - Running this task does not remove the - <ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink> - cache files. - Consequently, if no changes have been made and the recipe is - rebuilt after cleaning, output files are simply restored from the - sstate cache. - If you want to remove the sstate cache files for the recipe, - you need to use the - <link linkend='ref-tasks-cleansstate'><filename>do_cleansstate</filename></link> - task instead (i.e. <filename>bitbake -c cleansstate</filename> <replaceable>recipe</replaceable>). - </para> - </section> - - <section id='ref-tasks-cleanall'> - <title><filename>do_cleanall</filename></title> - - <para> - Removes all output files, shared state - (<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink>) - cache, and downloaded source files for a target (i.e. the contents - of - <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>). - Essentially, the <filename>do_cleanall</filename> task is - identical to the - <link linkend='ref-tasks-cleansstate'><filename>do_cleansstate</filename></link> - task with the added removal of downloaded source files. - </para> - - <para> - You can run this task using BitBake as follows: - <literallayout class='monospaced'> - $ bitbake -c cleanall <replaceable>recipe</replaceable> - </literallayout> - </para> - - <para> - Typically, you would not normally use the - <filename>cleanall</filename> task. - Do so only if you want to start fresh with the - <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link> - task. - </para> - </section> - - <section id='ref-tasks-cleansstate'> - <title><filename>do_cleansstate</filename></title> - - <para> - Removes all output files and shared state - (<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink>) - cache for a target. - Essentially, the <filename>do_cleansstate</filename> task is - identical to the - <link linkend='ref-tasks-clean'><filename>do_clean</filename></link> - task with the added removal of shared state - (<ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>sstate</ulink>) - cache. - </para> - - <para> - You can run this task using BitBake as follows: - <literallayout class='monospaced'> - $ bitbake -c cleansstate <replaceable>recipe</replaceable> - </literallayout> - </para> - - <para> - When you run the <filename>do_cleansstate</filename> task, - the OpenEmbedded build system no longer uses any - sstate. - Consequently, building the recipe from scratch is guaranteed. - <note> - The <filename>do_cleansstate</filename> task cannot remove - sstate from a remote sstate mirror. - If you need to build a target from scratch using remote - mirrors, use the "-f" option as follows: - <literallayout class='monospaced'> - $ bitbake -f -c do_cleansstate <replaceable>target</replaceable> - </literallayout> - </note> - </para> - </section> - - <section id='ref-tasks-devpyshell'> - <title><filename>do_devpyshell</filename></title> - - <para> - 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 - "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devpyshell'>Using a Development Python Shell</ulink>" - section in the Yocto Project Development Tasks Manual for more - information about using <filename>devpyshell</filename>. - </para> - </section> - - <section id='ref-tasks-devshell'> - <title><filename>do_devshell</filename></title> - - <para> - Starts a shell whose environment is set up for - development, debugging, or both. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" - section in the Yocto Project Development Tasks Manual for more - information about using <filename>devshell</filename>. - </para> - </section> - - <section id='ref-tasks-listtasks'> - <title><filename>do_listtasks</filename></title> - - <para> - Lists all defined tasks for a target. - </para> - </section> - - <section id='ref-tasks-package_index'> - <title><filename>do_package_index</filename></title> - - <para> - Creates or updates the index in the - <ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink> - area. - <note> - This task is not triggered with the - <filename>bitbake -c</filename> command-line option as - are the other tasks in this section. - Because this task is specifically for the - <filename>package-index</filename> recipe, - you run it using - <filename>bitbake package-index</filename>. - </note> - </para> - </section> -</section> - -<section id='image-related-tasks'> - <title>Image-Related Tasks</title> - - <para> - The following tasks are applicable to image recipes. - </para> - - <section id='ref-tasks-bootimg'> - <title><filename>do_bootimg</filename></title> - - <para> - Creates a bootable live image. - See the - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - variable for additional information on live image types. - </para> - </section> - - <section id='ref-tasks-bundle_initramfs'> - <title><filename>do_bundle_initramfs</filename></title> - - <para> - Combines an initial RAM disk (initramfs) image and kernel - together to form a single image. - The - <link linkend='var-CONFIG_INITRAMFS_SOURCE'><filename>CONFIG_INITRAMFS_SOURCE</filename></link> - variable has some more information about these types of images. - </para> - </section> - - <section id='ref-tasks-rootfs'> - <title><filename>do_rootfs</filename></title> - - <para> - Creates the root filesystem (file and directory structure) for an - image. - See the - "<ulink url='&YOCTO_DOCS_OM_URL;#image-generation-dev-environment'>Image Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual for more - information on how the root filesystem is created. - </para> - </section> - - <section id='ref-tasks-testimage'> - <title><filename>do_testimage</filename></title> - - <para> - Boots an image and performs runtime tests within the image. - For information on automatically testing images, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> - - <section id='ref-tasks-testimage_auto'> - <title><filename>do_testimage_auto</filename></title> - - <para> - Boots an image and performs runtime tests within the image - immediately after it has been built. - This task is enabled when you set - <link linkend='var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></link> - equal to "1". - </para> - - <para> - For information on automatically testing images, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </section> -</section> - -<section id='kernel-related-tasks'> - <title>Kernel-Related Tasks</title> - - <para> - The following tasks are applicable to kernel recipes. - Some of these tasks (e.g. the - <link linkend='ref-tasks-menuconfig'><filename>do_menuconfig</filename></link> - task) are also applicable to recipes that use - Linux kernel style configuration such as the BusyBox recipe. - </para> - - <section id='ref-tasks-compile_kernelmodules'> - <title><filename>do_compile_kernelmodules</filename></title> - - <para> - Runs the step that builds the kernel modules (if needed). - Building a kernel consists of two steps: 1) the kernel - (<filename>vmlinux</filename>) is built, and 2) the modules - are built (i.e. <filename>make modules</filename>). - </para> - </section> - - <section id='ref-tasks-diffconfig'> - <title><filename>do_diffconfig</filename></title> - - <para> - When invoked by the user, this task creates a file containing the - differences between the original config as produced by - <link linkend='ref-tasks-kernel_configme'><filename>do_kernel_configme</filename></link> - task and the changes made by the user with other methods - (i.e. using - (<link linkend='ref-tasks-kernel_menuconfig'><filename>do_kernel_menuconfig</filename></link>). - 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: - <literallayout class='monospaced'> - $ bitbake linux-yocto -c diffconfig - </literallayout> - For more information, see the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#creating-config-fragments'>Creating Configuration Fragments</ulink>" - section in the Yocto Project Linux Kernel Development Manual. - </para> - </section> - - <section id='ref-tasks-kernel_checkout'> - <title><filename>do_kernel_checkout</filename></title> - - <para> - 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 <filename>do_kernel_checkout</filename> task makes sure that - subsequent tasks are given a clean working tree copy of the kernel - with the correct branches checked out. - </para> - </section> - - <section id='ref-tasks-kernel_configcheck'> - <title><filename>do_kernel_configcheck</filename></title> - - <para> - Validates the configuration produced by the - <link linkend='ref-tasks-kernel_menuconfig'><filename>do_kernel_menuconfig</filename></link> - task. - The <filename>do_kernel_configcheck</filename> task produces - warnings when a requested configuration does not appear in the - final <filename>.config</filename> 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: - <literallayout class='monospaced'> - $ bitbake linux-yocto -c kernel_configcheck -f - </literallayout> - For more information, see the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#validating-configuration'>Validating Configuration</ulink>" - section in the Yocto Project Linux Kernel Development Manual. - </para> - </section> - - <section id='ref-tasks-kernel_configme'> - <title><filename>do_kernel_configme</filename></title> - - <para> - After the kernel is patched by the - <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> - task, the <filename>do_kernel_configme</filename> 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 - <filename>--allnoconfig</filename> are applied. - </para> - </section> - - <section id='ref-tasks-kernel_menuconfig'> - <title><filename>do_kernel_menuconfig</filename></title> - - <para> - Invoked by the user to manipulate the - <filename>.config</filename> 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: - <literallayout class='monospaced'> - $ bitbake linux-yocto -c menuconfig - </literallayout> - </note> - See the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#using-menuconfig'>Using <filename>menuconfig</filename></ulink>" - section in the Yocto Project Linux Kernel Development Manual - for more information on this configuration tool. - </para> - </section> - - <section id='ref-tasks-kernel_metadata'> - <title><filename>do_kernel_metadata</filename></title> - - <para> - Collects all the features required for a given kernel build, - whether the features come from - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - or from Git repositories. - After collection, the <filename>do_kernel_metadata</filename> task - processes the features into a series of config fragments and - patches, which can then be applied by subsequent tasks such as - <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> - and - <link linkend='ref-tasks-kernel_configme'><filename>do_kernel_configme</filename></link>. - </para> - </section> - - <section id='ref-tasks-menuconfig'> - <title><filename>do_menuconfig</filename></title> - - <para> - Runs <filename>make menuconfig</filename> for the kernel. - For information on <filename>menuconfig</filename>, see the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#using-menuconfig'>Using <filename>menuconfig</filename></ulink>" - section in the Yocto Project Linux Kernel Development Manual. - </para> - </section> - - <section id='ref-tasks-savedefconfig'> - <title><filename>do_savedefconfig</filename></title> - - <para> - 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 - <link linkend='ref-tasks-kernel_menuconfig'><filename>do_kernel_menuconfig</filename></link> - task. - You can invoke the task using the following command: - <literallayout class='monospaced'> - $ bitbake linux-yocto -c savedefconfig - </literallayout> - </para> - </section> - - <section id='ref-tasks-shared_workdir'> - <title><filename>do_shared_workdir</filename></title> - - <para> - 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 - <link linkend='ref-tasks-compile_kernelmodules'><filename>do_compile_kernelmodules</filename></link> - task can successfully build the kernel modules in the next step - of the build. - </para> - </section> - - <section id='ref-tasks-sizecheck'> - <title><filename>do_sizecheck</filename></title> - - <para> - After the kernel has been built, this task checks the size of the - stripped kernel image against - <link linkend='var-KERNEL_IMAGE_MAXSIZE'><filename>KERNEL_IMAGE_MAXSIZE</filename></link>. - If that variable was set and the size of the stripped kernel - exceeds that size, the kernel build produces a warning to that - effect. - </para> - </section> - - <section id='ref-tasks-strip'> - <title><filename>do_strip</filename></title> - - <para> - If - <filename>KERNEL_IMAGE_STRIP_EXTRA_SECTIONS</filename> is defined, - this task strips the sections named in that variable from - <filename>vmlinux</filename>. - This stripping is typically used to remove nonessential sections - such as <filename>.comment</filename> sections from a - size-sensitive configuration. - </para> - </section> - - <section id='ref-tasks-validate_branches'> - <title><filename>do_validate_branches</filename></title> - - <para> - After the kernel is unpacked but before it is patched, this task - makes sure that the machine and metadata branches as specified - by the <link linkend='var-SRCREV'><filename>SRCREV</filename></link> - variables actually exist on the specified branches. - If these branches do not exist and - <link linkend='var-AUTOREV'><filename>AUTOREV</filename></link> - is not being used, the <filename>do_validate_branches</filename> - task fails during the build. - </para> - </section> -</section> - -<section id='miscellaneous-tasks'> - <title>Miscellaneous Tasks</title> - - <para> - The following sections describe miscellaneous tasks. - </para> - - <section id='ref-tasks-spdx'> - <title><filename>do_spdx</filename></title> - - <para> - A build stage that takes the source code and scans it on a remote - FOSSOLOGY server in order to produce an SPDX document. - This task applies only to the - <link linkend='ref-classes-spdx'><filename>spdx</filename></link> - class. - </para> - </section> -</section> - -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-terms.xml b/documentation/ref-manual/ref-terms.xml deleted file mode 100644 index c573a521a7..0000000000 --- a/documentation/ref-manual/ref-terms.xml +++ /dev/null @@ -1,527 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-terms'> -<title>Yocto Project Terms</title> - - <para> - 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: - <itemizedlist> - <listitem><para> - <emphasis>Append Files:</emphasis> - Files that append build information to a recipe file. - Append files are known as BitBake append files and - <filename>.bbappend</filename> files. - The OpenEmbedded build system expects every append file to have - a corresponding recipe (<filename>.bb</filename>) 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. - <filename>formfactor_0.0.bb</filename> and - <filename>formfactor_0.0.bbappend</filename>).</para> - - <para>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 - "<ulink url='&YOCTO_DOCS_DEV_URL;#using-bbappend-files'>Using .bbappend Files in Your Layer</ulink>" - section in the Yocto Project Development Tasks Manual.</para> - - <para>When you name an append file, you can use the - "<filename>%</filename>" wildcard character to allow for - matching recipe names. - For example, suppose you have an append file named as follows: - <literallayout class='monospaced'> - busybox_1.21.%.bbappend - </literallayout> - That append file would match any - <filename>busybox_1.21.</filename><replaceable>x</replaceable><filename>.bb</filename> - version of the recipe. - So, the append file would match the following recipe names: - <literallayout class='monospaced'> - busybox_1.21.1.bb - busybox_1.21.2.bb - busybox_1.21.3.bb - </literallayout> - <note><title>Important</title> - The use of the "<filename>%</filename>" character - is limited in that it only works directly in front of the - <filename>.bbappend</filename> portion of the append file's - name. - You cannot use the wildcard character in any other - location of the name. - </note> - </para></listitem> - <listitem><para id='bitbake-term'> - <emphasis>BitBake:</emphasis> - The task executor and scheduler used by the OpenEmbedded build - system to build images. - For more information on BitBake, see the - <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>. - </para></listitem> - <listitem><para id='board-support-package-bsp-term'> - <emphasis>Board Support Package (BSP):</emphasis> - A group of drivers, definitions, and other components that - provide support for a specific hardware configuration. - For more information on BSPs, see the - <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. - </para></listitem> - <listitem> - <para id='build-directory'> - <emphasis>Build Directory:</emphasis> - This term refers to the area used by the OpenEmbedded build - system for builds. - The area is created when you <filename>source</filename> the - setup environment script that is found in the Source Directory - (i.e. <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>). - The - <link linkend='var-TOPDIR'><filename>TOPDIR</filename></link> - variable points to the Build Directory.</para> - - <para>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 - <link linkend='source-directory'>Source Directory</link> is - named <filename>poky</filename>: - <itemizedlist> - <listitem><para>Create the Build Directory inside your - Source Directory and let the name of the Build - Directory default to <filename>build</filename>: - <literallayout class='monospaced'> - $ cd $HOME/poky - $ source &OE_INIT_FILE; - </literallayout> - </para></listitem> - <listitem><para>Create the Build Directory inside your - home directory and specifically name it - <filename>test-builds</filename>: - <literallayout class='monospaced'> - $ cd $HOME - $ source poky/&OE_INIT_FILE; test-builds - </literallayout> - </para></listitem> - <listitem><para> - 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 - <filename>YP-&POKYVERSION;</filename> - in your home directory within the existing - directory <filename>mybuilds</filename>: - <literallayout class='monospaced'> - $cd $HOME - $ source $HOME/poky/&OE_INIT_FILE; $HOME/mybuilds/YP-&POKYVERSION; - </literallayout> - </para></listitem> - </itemizedlist> - <note> - By default, the Build Directory contains - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link>, - which is a temporary directory the build system uses for - its work. - <filename>TMPDIR</filename> 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 <filename>TMPDIR</filename> - in your <filename>local.conf</filename> file - to use a local drive. - Doing so effectively separates <filename>TMPDIR</filename> - from <filename>TOPDIR</filename>, which is the Build - Directory. - </note> - </para></listitem> - <listitem><para id='hardware-build-system-term'> - <emphasis>Build Host:</emphasis> - The system used to build images in a Yocto Project - Development environment. - The build system is sometimes referred to as the - development host. - </para></listitem> - <listitem><para> - <emphasis>Classes:</emphasis> - 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 - "<link linkend='ref-classes'>Classes</link>" chapter. - Class files end with the <filename>.bbclass</filename> - filename extension. - </para></listitem> - <listitem><para> - <emphasis>Configuration File:</emphasis> - 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.</para> - - <para>Configuration files end with a <filename>.conf</filename> - filename extension. - The <filename>conf/local.conf</filename> configuration file in - the - <link linkend='build-directory'>Build Directory</link> - contains user-defined variables that affect every build. - The <filename>meta-poky/conf/distro/poky.conf</filename> - configuration file defines Yocto "distro" configuration - variables used only when building with this policy. - Machine configuration files, which - are located throughout the - <link linkend='source-directory'>Source Directory</link>, define - variables for specific hardware and are only used when building - for that target (e.g. the - <filename>machine/beaglebone.conf</filename> configuration - file defines variables for the Texas Instruments ARM Cortex-A8 - development board). - </para></listitem> - <listitem><para id='term-container-layer'> - <emphasis>Container Layer:</emphasis> - Layers that hold other layers. - An example of a container layer is the - <filename>meta-intel</filename> layer. - This layer contains BSP layers for the Intel-core2-32 - <trademark class='registered'>Intel</trademark> Common Core - (Intel-core2-32) and the Intel-corei7-64 - <trademark class='registered'>Intel</trademark> Common Core - (Intel-corei7-64). - the <filename>meta-intel</filename> layer also contains - the <filename>common/</filename> directory, which contains - common content across those layers. - </para></listitem> - <listitem><para id='cross-development-toolchain'> - <emphasis>Cross-Development Toolchain:</emphasis> - 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.</para> - - <para>The Yocto Project supports two different cross-development - toolchains: - <itemizedlist> - <listitem><para> - A toolchain only used by and within - BitBake when building an image for a target - architecture. - </para></listitem> - <listitem><para>A relocatable toolchain used outside of - BitBake by developers when developing applications - that will run on a targeted device. - </para></listitem> - </itemizedlist></para> - - <para>Creation of these toolchains is simple and automated. - For information on toolchain concepts as they apply to the - Yocto Project, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual. - You can also find more information on using the - relocatable toolchain in the - <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> - manual. - </para></listitem> - <listitem><para> - <emphasis>Extensible Software Development Kit (eSDK):</emphasis> - 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.</para> - - <para>For information on the eSDK, see the - <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> - manual. - </para></listitem> - <listitem><para> - <emphasis>Image:</emphasis> - 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 - "<link linkend='ref-images'>Images</link>" - chapter. - </para></listitem> - <listitem><para> - <emphasis>Layer:</emphasis> - 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.</para> - - <para>For introductory information on layers, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#the-yocto-project-layer-model'>The Yocto Project Layer Model</ulink>" - section in the Yocto Project Overview and Concepts Manual. - For more detailed information on layers, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#understanding-and-creating-layers'>Understanding and Creating Layers</ulink>" - section in the Yocto Project Development Tasks Manual. - For a discussion specifically on BSP Layers, see the - "<ulink url='&YOCTO_DOCS_BSP_URL;#bsp-layers'>BSP Layers</ulink>" - section in the Yocto Project Board Support Packages (BSP) - Developer's Guide. - </para></listitem> - <listitem><para id='metadata'> - <emphasis>Metadata:</emphasis> - 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 - <link linkend='build-system-term'>OpenEmbedded build system</link> - 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.</para> - - <para>In the context of the kernel ("kernel Metadata"), the - term refers to the kernel config fragments and features - contained in the - <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/yocto-kernel-cache'><filename>yocto-kernel-cache</filename></ulink> - Git repository. - </para></listitem> - <listitem><para id='oe-core'> - <emphasis>OpenEmbedded-Core (OE-Core):</emphasis> - 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.</para> - - <para>You can see the Metadata in the - <filename>meta</filename> directory of the Yocto Project - <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi'>Source Repositories</ulink>. - </para></listitem> - <listitem><para id='build-system-term'> - <emphasis>OpenEmbedded Build System:</emphasis> - The build system specific to the Yocto Project. - The OpenEmbedded build system is based on another project known - as "Poky", which uses - <link linkend='bitbake-term'>BitBake</link> 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 - <link linkend='poky'>Poky</link> term. - </note> - </para></listitem> - <listitem><para> - <emphasis>Package:</emphasis> - 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.</para> - - <para>It is worth noting that the term "package" can, - in general, have subtle meanings. - For example, the packages referred to in the - "<link linkend='required-packages-for-the-build-host'>Required Packages for the Build Host</link>" - section are compiled binaries that, when installed, add - functionality to your Linux distribution.</para> - - <para>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. <link linkend='var-PR'><filename>PR</filename></link>, - <link linkend='var-PV'><filename>PV</filename></link>, and - <link linkend='var-PE'><filename>PE</filename></link>). - </para></listitem> - <listitem><para> - <emphasis>Package Groups:</emphasis> - 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 - <filename>.bb</filename> filename extension. - </para></listitem> - <listitem><para id='poky'> - <emphasis>Poky:</emphasis> - Poky, which is pronounced <emphasis>Pock</emphasis>-ee, - is a reference embedded distribution and a reference - test configuration. - Poky provides the following: - <itemizedlist> - <listitem><para> - A base-level functional distro used to illustrate - how to customize a distribution. - </para></listitem> - <listitem><para> - A means by which to test the Yocto Project - components (i.e. Poky is used to validate - the Yocto Project). - </para></listitem> - <listitem><para> - A vehicle through which you can download - the Yocto Project. - </para></listitem> - </itemizedlist> - Poky is not a product level distro. - Rather, it is a good starting point for customization. - <note> - Poky began 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. - </note> - </para></listitem> - <listitem><para> - <emphasis>Recipe:</emphasis> - 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 - <filename>.bb</filename> file extension. - </para></listitem> - <listitem><para id='reference-kit-term'> - <emphasis>Reference Kit:</emphasis> - A working example of a system, which includes a - <link linkend='board-support-package-bsp-term'>BSP</link> - as well as a - <link linkend='hardware-build-system-term'>build host</link> - and other components, that can work on specific hardware. - </para></listitem> - <listitem> - <para id='source-directory'> - <emphasis>Source Directory:</emphasis> - This term refers to the directory structure created as a result - of creating a local copy of the <filename>poky</filename> Git - repository <filename>git://git.yoctoproject.org/poky</filename> - or expanding a released <filename>poky</filename> tarball. - <note> - Creating a local copy of the <filename>poky</filename> - Git repository is the recommended method for setting up - your Source Directory. - </note> - 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. - </note></para> - - <para>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.</para> - - <para>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 <filename>poky</filename> Git - repository results in a local Git repository whose top-level - folder is also named "poky".</para> - - <para>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 - <filename>&YOCTO_POKY_TARBALL;</filename> results in a - Source Directory whose root folder is named - <filename>&YOCTO_POKY;</filename>.</para> - - <para>It is important to understand the differences between the - Source Directory created by unpacking a released tarball as - compared to cloning - <filename>git://git.yoctoproject.org/poky</filename>. - 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 <filename>poky</filename> - 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 <filename>poky</filename> Git - repository.</para> - - <para>For more information on concepts related to Git - repositories, branches, and tags, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#repositories-tags-and-branches'>Repositories, Tags, and Branches</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para></listitem> - <listitem><para><emphasis>Task:</emphasis> - A unit of execution for BitBake (e.g. - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>, - <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link>, - <link linkend='ref-tasks-patch'><filename>do_patch</filename></link>, - and so forth). - </para></listitem> - <listitem><para id='toaster-term'><emphasis>Toaster:</emphasis> - A web interface to the Yocto Project's - <link linkend='build-system-term'>OpenEmbedded Build System</link>. - 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 - <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>. - </para></listitem> - <listitem><para> - <emphasis>Upstream:</emphasis> - 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. - </para></listitem> - </itemizedlist> - </para> - -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml deleted file mode 100644 index b49fb2535b..0000000000 --- a/documentation/ref-manual/ref-variables.xml +++ /dev/null @@ -1,17268 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<!-- Dummy chapter --> -<chapter id='ref-variables-glos'> - -<title>Variables Glossary</title> - -<para> - This chapter lists common variables used in the OpenEmbedded build system and gives an overview - of their function and contents. -</para> - -<glossary id='ref-variables-glossary'> - - - <para> - <link linkend='var-ABIEXTENSION'>A</link> - <link linkend='var-B'>B</link> - <link linkend='var-CACHE'>C</link> - <link linkend='var-D'>D</link> - <link linkend='var-EFI_PROVIDER'>E</link> - <link linkend='var-FEATURE_PACKAGES'>F</link> - <link linkend='var-GCCPIE'>G</link> - <link linkend='var-HOMEPAGE'>H</link> - <link linkend='var-ICECC_DISABLED'>I</link> -<!-- <link linkend='var-glossary-j'>J</link> --> - <link linkend='var-KARCH'>K</link> - <link linkend='var-LABELS'>L</link> - <link linkend='var-MACHINE'>M</link> - <link linkend='var-NATIVELSBSTRING'>N</link> - <link linkend='var-OBJCOPY'>O</link> - <link linkend='var-P'>P</link> -<!-- <link linkend='var-glossary-q'>Q</link> --> - <link linkend='var-RANLIB'>R</link> - <link linkend='var-S'>S</link> - <link linkend='var-T'>T</link> - <link linkend='var-UBOOT_CONFIG'>U</link> - <link linkend='var-VOLATILE_LOG_DIR'>V</link> - <link linkend='var-WARN_QA'>W</link> - <link linkend='var-XSERVER'>X</link> -<!-- <link linkend='var-glossary-y'>Y</link> --> -<!-- <link linkend='var-glossary-z'>Z</link>--> - </para> - - <glossdiv id='var-glossary-a'><title>A</title> - - <glossentry id='var-ABIEXTENSION'><glossterm>ABIEXTENSION</glossterm> - <info> - ABIEXTENSION[doc] = "Extension to the Application Binary Interface (ABI) field of the GNU canonical architecture name (e.g. "eabi")." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Extension to the Application Binary Interface (ABI) - field of the GNU canonical architecture name - (e.g. "eabi"). - </para> - - <para> - ABI extensions are set in the machine include files. - For example, the - <filename>meta/conf/machine/include/arm/arch-arm.inc</filename> - file sets the following extension: - <literallayout class='monospaced'> - ABIEXTENSION = "eabi" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ALLOW_EMPTY'><glossterm>ALLOW_EMPTY</glossterm> - <info> - ALLOW_EMPTY[doc] = "Specifies whether to produce an output package even if it is empty." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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 - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> or - some other hard runtime requirement on the existence of the package. - </para> - - <para> - Like all package-controlling variables, you must always use them in - conjunction with a package name override, as in: - <literallayout class='monospaced'> - ALLOW_EMPTY_${PN} = "1" - ALLOW_EMPTY_${PN}-dev = "1" - ALLOW_EMPTY_${PN}-staticdev = "1" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ALTERNATIVE'><glossterm>ALTERNATIVE</glossterm> - <info> - ALTERNATIVE[doc] = "Lists commands in a package that need an alternative binary naming scheme." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists commands in a package that need an alternative - binary naming scheme. - Sometimes the same command is provided in multiple packages. - When this occurs, the OpenEmbedded build system needs to - use the alternatives system to create a different binary - naming scheme so the commands can co-exist. - </para> - - <para> - To use the variable, list out the package's commands - that also exist as part of another package. - For example, if the <filename>busybox</filename> package - has four commands that also exist as part of another - package, you identify them as follows: - <literallayout class='monospaced'> - ALTERNATIVE_busybox = "sh sed test bracket" - </literallayout> - For more information on the alternatives system, see the - "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ALTERNATIVE_LINK_NAME'><glossterm>ALTERNATIVE_LINK_NAME</glossterm> - <info> - ALTERNATIVE_LINK_NAME[doc] = "Used by the alternatives system to map duplicated commands to actual locations." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Used by the alternatives system to map duplicated commands - to actual locations. - For example, if the <filename>bracket</filename> command - provided by the <filename>busybox</filename> package is - duplicated through another package, you must use the - <filename>ALTERNATIVE_LINK_NAME</filename> variable to - specify the actual location: - <literallayout class='monospaced'> - ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/[" - </literallayout> - </para> - - <para> - In this example, the binary for the - <filename>bracket</filename> command (i.e. - <filename>[</filename>) from the - <filename>busybox</filename> package resides in - <filename>/usr/bin/</filename>. - <note> - If <filename>ALTERNATIVE_LINK_NAME</filename> is not - defined, it defaults to - <filename>${bindir}/<replaceable>name</replaceable></filename>. - </note> - </para> - - <para> - For more information on the alternatives system, see the - "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ALTERNATIVE_PRIORITY'><glossterm>ALTERNATIVE_PRIORITY</glossterm> - <info> - ALTERNATIVE_PRIORITY[doc] = "Used by the alternatives system to create default priorities for duplicated commands." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Used by the alternatives system to create default - priorities for duplicated commands. - You can use the variable to create a single default - regardless of the command name or package, a default for - specific duplicated commands regardless of the package, or - a default for specific commands tied to particular packages. - Here are the available syntax forms: - <literallayout class='monospaced'> - ALTERNATIVE_PRIORITY = "<replaceable>priority</replaceable>" - ALTERNATIVE_PRIORITY[<replaceable>name</replaceable>] = "<replaceable>priority</replaceable>" - ALTERNATIVE_PRIORITY_<replaceable>pkg</replaceable>[<replaceable>name</replaceable>] = "<replaceable>priority</replaceable>" - </literallayout> - </para> - - <para> - For more information on the alternatives system, see the - "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ALTERNATIVE_TARGET'><glossterm>ALTERNATIVE_TARGET</glossterm> - <info> - ALTERNATIVE_TARGET[doc] = "Used by the alternatives system to create default link locations for duplicated commands." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Used by the alternatives system to create default link - locations for duplicated commands. - You can use the variable to create a single default - location for all duplicated commands regardless of the - command name or package, a default for - specific duplicated commands regardless of the package, or - a default for specific commands tied to particular packages. - Here are the available syntax forms: - <literallayout class='monospaced'> - ALTERNATIVE_TARGET = "<replaceable>target</replaceable>" - ALTERNATIVE_TARGET[<replaceable>name</replaceable>] = "<replaceable>target</replaceable>" - ALTERNATIVE_TARGET_<replaceable>pkg</replaceable>[<replaceable>name</replaceable>] = "<replaceable>target</replaceable>" - </literallayout> - <note> - <para> - If <filename>ALTERNATIVE_TARGET</filename> is not - defined, it inherits the value from the - <link linkend='var-ALTERNATIVE_LINK_NAME'><filename>ALTERNATIVE_LINK_NAME</filename></link> - variable. - </para> - - <para> - If <filename>ALTERNATIVE_LINK_NAME</filename> and - <filename>ALTERNATIVE_TARGET</filename> are the - same, the target for - <filename>ALTERNATIVE_TARGET</filename> - has "<filename>.{BPN}</filename>" appended to it. - </para> - - <para> - Finally, if the file referenced has not been - renamed, the alternatives system will rename it to - avoid the need to rename alternative files in the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task while - retaining support for the command if necessary. - </para> - </note> - </para> - - <para> - For more information on the alternatives system, see the - "<link linkend='ref-classes-update-alternatives'><filename>update-alternatives.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-APPEND'><glossterm>APPEND</glossterm> - <info> - APPEND[doc] = "An override list of append strings for target specified using LABELS." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - An override list of append strings for each target - specified with - <link linkend='var-LABELS'><filename>LABELS</filename></link>. - </para> - - <para> - See the - <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> - class for more information on how this variable is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-AR'><glossterm>AR</glossterm> - <info> - AR[doc] = "Minimal command and arguments to run 'ar'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments used to run - <filename>ar</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ARCHIVER_MODE'><glossterm>ARCHIVER_MODE</glossterm> - <info> - ARCHIVER_MODE[doc] = "Controls archive creation used when releasing source files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When used with the - <link linkend='ref-classes-archiver'><filename>archiver</filename></link> - class, determines the type of information used to create - a released archive. - You can use this variable to create archives of patched - source, original source, configured source, and so forth - by employing the following variable flags (varflags): - <literallayout class='monospaced'> - ARCHIVER_MODE[src] = "original" # Uses original (unpacked) source - # files. - - ARCHIVER_MODE[src] = "patched" # Uses patched source files. This is - # the default. - - ARCHIVER_MODE[src] = "configured" # Uses configured source files. - - ARCHIVER_MODE[diff] = "1" # Uses patches between do_unpack and - # do_patch. - - ARCHIVER_MODE[diff-exclude] ?= "<replaceable>file</replaceable> <replaceable>file</replaceable> ..." # Lists files and directories to - # exclude from diff. - - ARCHIVER_MODE[dumpdata] = "1" # Uses environment data. - - ARCHIVER_MODE[recipe] = "1" # Uses recipe and include files. - - ARCHIVER_MODE[srpm] = "1" # Uses RPM package files. - </literallayout> - For information on how the variable works, see the - <filename>meta/classes/archiver.bbclass</filename> file - in the - <link linkend='source-directory'>Source Directory</link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-AS'><glossterm>AS</glossterm> - <info> - AS[doc] = "Minimal command and arguments to run the assembler." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments used to run the - assembler. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm> - <info> - ASSUME_PROVIDED[doc] = "Lists recipe names (PN values) BitBake does not attempt to build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists recipe names - (<link linkend='var-PN'><filename>PN</filename></link> - values) BitBake does not attempt to build. - Instead, BitBake assumes these recipes have already been - built. - </para> - - <para> - In OpenEmbedded-Core, <filename>ASSUME_PROVIDED</filename> - mostly specifies native tools that should not be built. - An example is <filename>git-native</filename>, which when - specified, allows for the Git binary from the host to be - used rather than building <filename>git-native</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ASSUME_SHLIBS'><glossterm>ASSUME_SHLIBS</glossterm> - <info> - ASSUME_SHLIBS[doc] = Provides additional shlibs provider mapping information, which adds to or overwrites the information provided automatically by the system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Provides additional <filename>shlibs</filename> provider - mapping information, which adds to or overwrites the - information provided automatically by the system. - Separate multiple entries using spaces. - </para> - - <para> - As an example, use the following form to add an - <filename>shlib</filename> provider of - <replaceable>shlibname</replaceable> in - <replaceable>packagename</replaceable> with the optional - <replaceable>version</replaceable>: - <literallayout class='monospaced'> - <replaceable>shlibname:packagename</replaceable>[_<replaceable>version</replaceable>] - </literallayout> - </para> - - <para> - Here is an example that adds a shared library named - <filename>libEGL.so.1</filename> as being provided by - the <filename>libegl-implementation</filename> package: - <literallayout class='monospaced'> - ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-AUTHOR'><glossterm>AUTHOR</glossterm> - <info> - AUTHOR[doc] = "Email address used to contact the original author or authors in order to send patches and forward bugs." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The email address used to contact the original author - or authors in order to send patches and forward bugs. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-AUTO_LIBNAME_PKGS'><glossterm>AUTO_LIBNAME_PKGS</glossterm> - <info> - AUTO_LIBNAME_PKGS[doc] = "Specifies which packages should be checked for libraries and renamed according to Debian library package naming." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the - <link linkend='ref-classes-debian'><filename>debian</filename></link> - class is inherited, which is the default behavior, - <filename>AUTO_LIBNAME_PKGS</filename> specifies which - packages should be checked for libraries and renamed - according to Debian library package naming. - </para> - - <para> - The default value is "${PACKAGES}", which causes the - debian class to act on all packages that are - explicitly generated by the recipe. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-AUTO_SYSLINUXMENU'><glossterm>AUTO_SYSLINUXMENU</glossterm> - <info> - AUTO_SYSLINUXMENU[doc] = "Enables creating an automatic menu for the syslinux bootloader." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Enables creating an automatic menu for the syslinux - bootloader. - You must set this variable in your recipe. - The - <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> - class checks this variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-AUTOREV'><glossterm>AUTOREV</glossterm> - <info> - AUTOREV[doc] = "When SRCREV is set to the value of this variable, it specifies to use the latest source revision in the repository." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When - <filename><link linkend='var-SRCREV'>SRCREV</link></filename> - is set to the value of this variable, it specifies to use - the latest source revision in the repository. - Here is an example: - <literallayout class='monospaced'> - SRCREV = "${AUTOREV}" - </literallayout> - </para> - - <para> - If you use the previous statement to retrieve the latest - version of software, you need to be sure - <link linkend='var-PV'><filename>PV</filename></link> - contains - <filename>${</filename><link linkend='var-SRCPV'><filename>SRCPV</filename></link><filename>}</filename>. - For example, suppose you have a kernel recipe that - inherits the - <link linkend='ref-classes-kernel'>kernel</link> class - and you use the previous statement. - In this example, <filename>${SRCPV}</filename> does not - automatically get into <filename>PV</filename>. - Consequently, you need to change <filename>PV</filename> - in your recipe so that it does contain - <filename>${SRCPV}</filename>. - </para> - - <para> - For more information see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-AVAILTUNES'><glossterm>AVAILTUNES</glossterm> - <info> - AVAILTUNES[doc] = "The list of defined CPU and Application Binary Interface (ABI) tunings (i.e. "tunes") available for use by the OpenEmbedded build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The list of defined CPU and Application Binary Interface - (ABI) tunings (i.e. "tunes") available for use by the - OpenEmbedded build system. - </para> - - <para> - The list simply presents the tunes that are available. - Not all tunes may be compatible with a particular - machine configuration, or with each other in a - <ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Multilib</ulink> - configuration. - </para> - - <para> - To add a tune to the list, be sure to append it with - spaces using the "+=" BitBake operator. - Do not simply replace the list by using the "=" operator. - See the - "<ulink url='&YOCTO_DOCS_BB_URL;#basic-syntax'>Basic Syntax</ulink>" - section in the BitBake User Manual for more information. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-b'><title>B</title> - - <glossentry id='var-B'><glossterm>B</glossterm> - <info> - B[doc] = "The Build Directory. The OpenEmbedded build system places generated objects into the Build Directory during a recipe's build process." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The directory within the - <link linkend='build-directory'>Build Directory</link> - in which the OpenEmbedded build system places generated - objects during a recipe's build process. - By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> - directory, which is defined as: - <literallayout class='monospaced'> - S = "${WORKDIR}/${BP}" - </literallayout> - </para> - - <para> - You can separate the (<filename>S</filename>) directory - and the directory pointed to by the <filename>B</filename> - variable. - Most Autotools-based recipes support separating these - directories. - The build system defaults to using separate directories for - <filename>gcc</filename> and some kernel recipes. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BAD_RECOMMENDATIONS'><glossterm>BAD_RECOMMENDATIONS</glossterm> - <info> - BAD_RECOMMENDATIONS[doc] = "A list of packages not to install despite being recommended by a recipe. Support for this variable exists only when using the IPK packaging backend." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists "recommended-only" packages to not install. - Recommended-only packages are packages installed only - through the - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> - variable. - You can prevent any of these "recommended" packages from - being installed by listing them with the - <filename>BAD_RECOMMENDATIONS</filename> variable: - <literallayout class='monospaced'> - BAD_RECOMMENDATIONS = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..." - </literallayout> - </para> - - <para> - You can set this variable globally in your - <filename>local.conf</filename> file or you can attach it to - a specific image recipe by using the recipe name override: - <literallayout class='monospaced'> - BAD_RECOMMENDATIONS_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>" - </literallayout> - </para> - - <para> - It is important to realize that if you choose to not install - packages using this variable and some other packages are - dependent on them (i.e. listed in a recipe's - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> - variable), the OpenEmbedded build system ignores your - request and will install the packages to avoid dependency - errors. - </para> - - <para> - Support for this variable exists only when using the - IPK and RPM packaging backend. - Support does not exist for DEB. - </para> - - <para> - See the - <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link> - and the - <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link> - variables for related information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BASE_LIB'><glossterm>BASE_LIB</glossterm> - <info> - BASE_LIB[doc] = "The library directory name for the CPU or Application Binary Interface (ABI) tune." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The library directory name for the CPU or Application - Binary Interface (ABI) tune. - The <filename>BASE_LIB</filename> applies only in the - Multilib context. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Combining Multiple Versions of Library Files into One Image</ulink>" - section in the Yocto Project Development Tasks Manual for - information on Multilib. - </para> - - <para> - The <filename>BASE_LIB</filename> variable is defined in - the machine include files in the - <link linkend='source-directory'>Source Directory</link>. - If Multilib is not being used, the value defaults to "lib". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BASE_WORKDIR'><glossterm>BASE_WORKDIR</glossterm> - <info> - BASE_WORKDIR[doc] = "Points to the base of the work directory for all recipes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the base of the work directory for all recipes. - The default value is "${TMPDIR}/work". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BB_ALLOWED_NETWORKS'><glossterm>BB_ALLOWED_NETWORKS</glossterm> - <info> - BB_ALLOWED_NETWORKS[doc] = "A list of hosts that the fetcher is allowed to use to obtain the required source code." - </info> - <glossdef> - <para> - Specifies a space-delimited list of hosts that the fetcher - is allowed to use to obtain the required source code. - Following are considerations surrounding this variable: - <itemizedlist> - <listitem><para> - This host list is only used if - <filename>BB_NO_NETWORK</filename> is either not - set or set to "0". - </para></listitem> - <listitem><para> - Limited support for wildcard matching against the - beginning of host names exists. - For example, the following setting matches - <filename>git.gnu.org</filename>, - <filename>ftp.gnu.org</filename>, and - <filename>foo.git.gnu.org</filename>. - <literallayout class='monospaced'> - BB_ALLOWED_NETWORKS = "*.gnu.org" - </literallayout> - <note><title>Important</title> - <para>The use of the "<filename>*</filename>" - 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.</para> - - <para>For example, - <filename>*.foo.bar</filename> is supported, - while <filename>*aa.foo.bar</filename> is not. - </para> - </note> - </para></listitem> - <listitem><para> - Mirrors not in the host list are skipped and - logged in debug. - </para></listitem> - <listitem><para> - Attempts to access networks not in the host list - cause a failure. - </para></listitem> - </itemizedlist> - Using <filename>BB_ALLOWED_NETWORKS</filename> in - conjunction with - <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> - is very useful. - Adding the host you want to use to - <filename>PREMIRRORS</filename> results in the source code - being fetched from an allowed location and avoids raising - an error when a host that is not allowed is in a - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - statement. - This is because the fetcher does not attempt to use the - host listed in <filename>SRC_URI</filename> after a - successful fetch from the - <filename>PREMIRRORS</filename> occurs. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BB_DANGLINGAPPENDS_WARNONLY'><glossterm>BB_DANGLINGAPPENDS_WARNONLY</glossterm> - <info> - BB_DANGLINGAPPENDS_WARNONLY[doc] = "Defines how BitBake handles situations where an append file (.bbappend) has no corresponding recipe file (.bb)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines how BitBake handles situations where an append - file (<filename>.bbappend</filename>) has no - corresponding recipe file (<filename>.bb</filename>). - This condition often occurs when layers get out of sync - (e.g. <filename>oe-core</filename> bumps a - recipe version and the old recipe no longer exists and the - other layer has not been updated to the new version - of the recipe yet). - </para> - - <para> - The default fatal behavior is safest because it is - the sane reaction given something is out of sync. - It is important to realize when your changes are no longer - being applied. - </para> - - <para> - You can change the default behavior by setting this - variable to "1", "yes", or "true" - in your <filename>local.conf</filename> file, which is - located in the - <link linkend='build-directory'>Build Directory</link>: - Here is an example: - <literallayout class='monospaced'> - BB_DANGLINGAPPENDS_WARNONLY = "1" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BB_DISKMON_DIRS'><glossterm>BB_DISKMON_DIRS</glossterm> - <info> - BB_DISKMON_DIRS[doc] = "Monitors disk space and available inodes during the build and allows you to control the build based on these parameters." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Monitors disk space and available inodes during the build - and allows you to control the build based on these - parameters. - </para> - - <para> - Disk space monitoring is disabled by default. - To enable monitoring, add the <filename>BB_DISKMON_DIRS</filename> - variable to your <filename>conf/local.conf</filename> file found in the - <link linkend='build-directory'>Build Directory</link>. - Use the following form: - <literallayout class='monospaced'> - BB_DISKMON_DIRS = "<replaceable>action</replaceable>,<replaceable>dir</replaceable>,<replaceable>threshold</replaceable> [...]" - - where: - - <replaceable>action</replaceable> is: - ABORT: Immediately abort the build when - a threshold is broken. - STOPTASKS: Stop the build after the currently - executing tasks have finished when - a threshold is broken. - WARN: Issue a warning but continue the - build when a threshold is broken. - Subsequent warnings are issued as - defined by the BB_DISKMON_WARNINTERVAL - variable, which must be defined in - the conf/local.conf file. - - <replaceable>dir</replaceable> is: - Any directory you choose. You can specify one or - more directories to monitor by separating the - groupings with a space. If two directories are - on the same device, only the first directory - is monitored. - - <replaceable>threshold</replaceable> is: - Either the minimum available disk space, - the minimum number of free inodes, or - both. You must specify at least one. To - omit one or the other, simply omit the value. - Specify the threshold using G, M, K for Gbytes, - Mbytes, and Kbytes, respectively. If you do - not specify G, M, or K, Kbytes is assumed by - default. Do not use GB, MB, or KB. - </literallayout> - </para> - - <para> - Here are some examples: - <literallayout class='monospaced'> - BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" - BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" - BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" - </literallayout> - The first example works only if you also provide - the <link linkend='var-BB_DISKMON_WARNINTERVAL'><filename>BB_DISKMON_WARNINTERVAL</filename></link> variable - in the <filename>conf/local.conf</filename>. - This example causes the build system to immediately - abort when either the disk space in <filename>${TMPDIR}</filename> drops - below 1 Gbyte or the available free inodes drops below - 100 Kbytes. - Because two directories are provided with the variable, the - build system also issue a - warning when the disk space in the - <filename>${SSTATE_DIR}</filename> directory drops - below 1 Gbyte or the number of free inodes drops - below 100 Kbytes. - Subsequent warnings are issued during intervals as - defined by the <filename>BB_DISKMON_WARNINTERVAL</filename> - variable. - </para> - - <para> - The second example stops the build after all currently - executing tasks complete when the minimum disk space - in the <filename>${<link linkend='var-TMPDIR'>TMPDIR</link>}</filename> - directory drops below 1 Gbyte. - No disk monitoring occurs for the free inodes in this case. - </para> - - <para> - The final example immediately aborts the build when the - number of free inodes in the <filename>${TMPDIR}</filename> directory - drops below 100 Kbytes. - No disk space monitoring for the directory itself occurs - in this case. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BB_DISKMON_WARNINTERVAL'><glossterm>BB_DISKMON_WARNINTERVAL</glossterm> - <info> - BB_DISKMON_WARNINTERVAL[doc] = "Defines the disk space and free inode warning intervals. To set these intervals, define the variable in the conf/local.conf file in the Build Directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the disk space and free inode warning intervals. - To set these intervals, define the variable in your - <filename>conf/local.conf</filename> file in the - <link linkend='build-directory'>Build Directory</link>. - </para> - - <para> - If you are going to use the - <filename>BB_DISKMON_WARNINTERVAL</filename> variable, you must - also use the - <link linkend='var-BB_DISKMON_DIRS'><filename>BB_DISKMON_DIRS</filename></link> variable - and define its action as "WARN". - During the build, subsequent warnings are issued each time - disk space or number of free inodes further reduces by - the respective interval. - </para> - - <para> - If you do not provide a <filename>BB_DISKMON_WARNINTERVAL</filename> - variable and you do use <filename>BB_DISKMON_DIRS</filename> with - the "WARN" action, the disk monitoring interval defaults to - the following: - <literallayout class='monospaced'> - BB_DISKMON_WARNINTERVAL = "50M,5K" - </literallayout> - </para> - - <para> - When specifying the variable in your configuration file, - use the following form: - <literallayout class='monospaced'> - BB_DISKMON_WARNINTERVAL = "<replaceable>disk_space_interval</replaceable>,<replaceable>disk_inode_interval</replaceable>" - - where: - - <replaceable>disk_space_interval</replaceable> is: - An interval of memory expressed in either - G, M, or K for Gbytes, Mbytes, or Kbytes, - respectively. You cannot use GB, MB, or KB. - - <replaceable>disk_inode_interval</replaceable> is: - An interval of free inodes expressed in either - G, M, or K for Gbytes, Mbytes, or Kbytes, - respectively. You cannot use GB, MB, or KB. - </literallayout> - </para> - - <para> - Here is an example: - <literallayout class='monospaced'> - BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K" - BB_DISKMON_WARNINTERVAL = "50M,5K" - </literallayout> - These variables cause the OpenEmbedded build system to - issue subsequent warnings each time the available - disk space further reduces by 50 Mbytes or the number - of free inodes further reduces by 5 Kbytes in the - <filename>${SSTATE_DIR}</filename> directory. - Subsequent warnings based on the interval occur each time - a respective interval is reached beyond the initial warning - (i.e. 1 Gbytes and 100 Kbytes). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BB_GENERATE_MIRROR_TARBALLS'><glossterm>BB_GENERATE_MIRROR_TARBALLS</glossterm> - <info> - BB_GENERATE_MIRROR_TARBALLS[doc] = "Causes tarballs of the Git repositories to be placed in the DL_DIR directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Causes tarballs of the Git repositories, including the - Git metadata, to be placed in the - <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> - directory. - </para> - - <para> - For performance reasons, creating and placing tarballs of - the Git repositories is not the default action by the - OpenEmbedded build system. - <literallayout class='monospaced'> - BB_GENERATE_MIRROR_TARBALLS = "1" - </literallayout> - Set this variable in your <filename>local.conf</filename> - file in the - <link linkend='build-directory'>Build Directory</link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> - <info> - BB_NUMBER_THREADS[doc] = "The maximum number of tasks BitBake should run in parallel at any one time. This variable is automatically configured to be equal to the number of build system cores." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The maximum number of tasks BitBake should run in parallel - at any one time. - The OpenEmbedded build system automatically configures - this variable to be equal to the number of cores on the - build system. - For example, a system with a dual core processor that - also uses hyper-threading causes the - <filename>BB_NUMBER_THREADS</filename> variable to default - to "4". - </para> - - <para> - For single socket systems (i.e. one CPU), you should not - have to override this variable to gain optimal parallelism - during builds. - However, if you have very large systems that employ - multiple physical CPUs, you might want to make sure the - <filename>BB_NUMBER_THREADS</filename> variable is not - set higher than "20". - </para> - - <para> - For more information on speeding up builds, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#speeding-up-a-build'>Speeding Up a Build</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BB_SERVER_TIMEOUT'><glossterm>BB_SERVER_TIMEOUT</glossterm> - <info> - BB_SERVER_TIMEOUT [doc] = "Specifies the time (in seconds) after which to unload the BitBake server due to inactivity." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the time (in seconds) after which to unload the - BitBake server due to inactivity. - Set <filename>BB_SERVER_TIMEOUT</filename> to determine how - long the BitBake server stays resident between invocations. - </para> - - <para> - For example, the following statement in your - <filename>local.conf</filename> file instructs the server - to be unloaded after 20 seconds of inactivity: - <literallayout class='monospaced'> - BB_SERVER_TIMEOUT = "20" - </literallayout> - If you want the server to never be unloaded, set - <filename>BB_SERVER_TIMEOUT</filename> to "-1". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> - <info> - BBCLASSEXTEND[doc] = "Allows you to extend a recipe so that it builds variants of the software. Common variants for recipes are 'native', 'cross', 'nativesdk', and multilibs." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Allows you to extend a recipe so that it builds variants of the software. - Common variants for recipes exist such as "natives" like <filename>quilt-native</filename>, - which is a copy of Quilt built to run on the build system; - "crosses" such as <filename>gcc-cross</filename>, - which is a compiler built to run on the build machine but produces binaries - that run on the target <link linkend='var-MACHINE'><filename>MACHINE</filename></link>; - "nativesdk", which targets the SDK machine instead of <filename>MACHINE</filename>; - and "mulitlibs" in the form "<filename>multilib:</filename><replaceable>multilib_name</replaceable>". - </para> - - <para> - To build a different variant of the recipe with a minimal amount of code, it usually - is as simple as adding the following to your recipe: - <literallayout class='monospaced'> - BBCLASSEXTEND =+ "native nativesdk" - BBCLASSEXTEND =+ "multilib:<replaceable>multilib_name</replaceable>" - </literallayout> - <note> - <para> - Internally, the <filename>BBCLASSEXTEND</filename> - mechanism generates recipe variants by rewriting - variable values and applying overrides such as - <filename>_class-native</filename>. - For example, to generate a native version of a recipe, - a - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> - on "foo" is rewritten to a <filename>DEPENDS</filename> - on "foo-native". - </para> - - <para> - Even when using <filename>BBCLASSEXTEND</filename>, 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 <filename>include</filename> statements are - processed when the recipe is parsed. - </para> - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBFILE_COLLECTIONS'><glossterm>BBFILE_COLLECTIONS</glossterm> - <info> - BBFILE_COLLECTIONS[doc] = "Lists the names of configured layers. These names are used to find the other BBFILE_* variables." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists the names of configured layers. - These names are used to find the other <filename>BBFILE_*</filename> - variables. - Typically, each layer will append its name to this variable in its - <filename>conf/layer.conf</filename> file. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBFILE_PATTERN'><glossterm>BBFILE_PATTERN</glossterm> - <info> - BBFILE_PATTERN[doc] = "Variable that expands to match files from BBFILES in a particular layer. This variable is used in the layer.conf file and must be suffixed with the name of a layer." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Variable that expands to match files from - <link linkend='var-BBFILES'><filename>BBFILES</filename></link> - in a particular layer. - This variable is used in the <filename>conf/layer.conf</filename> file and must - be suffixed with the name of the specific layer (e.g. - <filename>BBFILE_PATTERN_emenlow</filename>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBFILE_PRIORITY'><glossterm>BBFILE_PRIORITY</glossterm> - <info> - BBFILE_PRIORITY[doc] = "Assigns the priority for recipe files in each layer. Setting this variable allows you to prioritize a layer against other layers that contain the same recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Assigns the priority for recipe files in each layer. - </para> - - <para> - This variable is useful in situations where the same recipe appears in - more than one layer. - Setting this variable allows you to prioritize a - layer against other layers that contain the same recipe - effectively - letting you control the precedence for the multiple layers. - The precedence established through this variable stands regardless of a - recipe's version - (<link linkend='var-PV'><filename>PV</filename></link> variable). - For example, a layer that has a recipe with a higher <filename>PV</filename> value but for - which the <filename>BBFILE_PRIORITY</filename> is set to have a lower precedence still has a - lower precedence. - </para> - - <para> - A larger value for the <filename>BBFILE_PRIORITY</filename> variable results in a higher - precedence. - For example, the value 6 has a higher precedence than the value 5. - If not specified, the <filename>BBFILE_PRIORITY</filename> variable is set based on layer - dependencies (see the - <filename><link linkend='var-LAYERDEPENDS'>LAYERDEPENDS</link></filename> variable for - more information. - The default priority, if unspecified - for a layer with no dependencies, is the lowest defined priority + 1 - (or 1 if no priorities are defined). - </para> - <tip> - You can use the command <filename>bitbake-layers show-layers</filename> to list - all configured layers along with their priorities. - </tip> - </glossdef> - </glossentry> - - <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm> - <info> - BBFILES[doc] = "A space-separated list of recipe files BitBake uses to build software." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A space-separated list of recipe files BitBake uses to - build software. - </para> - - <para> - When specifying recipe files, you can pattern match using - Python's - <ulink url='https://docs.python.org/3/library/glob.html'><filename>glob</filename></ulink> - syntax. - For details on the syntax, see the documentation by - following the previous link. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBFILES_DYNAMIC'><glossterm>BBFILES_DYNAMIC</glossterm> - <info> - BBFILES_DYNAMIC[doc] = "Activates content when identified layers are present." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Activates content when identified layers are present. - You identify the layers by the collections that the layers - define. - </para> - - <para> - Use the <filename>BBFILES_DYNAMIC</filename> variable to - avoid <filename>.bbappend</filename> files whose - corresponding <filename>.bb</filename> file is in a layer - that attempts to modify other layers through - <filename>.bbappend</filename> but does not want to - introduce a hard dependency on those other layers. - </para> - - <para> - Use the following form for - <filename>BBFILES_DYNAMIC</filename>: - <literallayout class='monospaced'> - <replaceable>collection_name</replaceable>:<replaceable>filename_pattern</replaceable> - </literallayout> - The following example identifies two collection names and - two filename patterns: - <literallayout class='monospaced'> - BBFILES_DYNAMIC += " \ - clang-layer:${LAYERDIR}/bbappends/meta-clang/*/*/*.bbappend \ - core:${LAYERDIR}/bbappends/openembedded-core/meta/*/*/*.bbappend \ - " - </literallayout> - This next example shows an error message that occurs - because invalid entries are found, which cause parsing to - abort: - <literallayout class='monospaced'> - ERROR: BBFILES_DYNAMIC entries must be of the form <collection name>:<filename pattern>, not: - /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend - /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBINCLUDELOGS'><glossterm>BBINCLUDELOGS</glossterm> - <info> - BBINCLUDELOGS[doc] = "Variable that controls how BitBake displays logs on build failure." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Variable that controls how BitBake displays logs on build failure. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBINCLUDELOGS_LINES'><glossterm>BBINCLUDELOGS_LINES</glossterm> - <info> - BBINCLUDELOGS_LINES[doc] = "Amount of log lines printed on failure." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If - <link linkend='var-BBINCLUDELOGS'><filename>BBINCLUDELOGS</filename></link> - is set, specifies the maximum number of lines from the - task log file to print when reporting a failed task. - If you do not set <filename>BBINCLUDELOGS_LINES</filename>, - the entire log is printed. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBLAYERS'><glossterm>BBLAYERS</glossterm> - <info> - BBLAYERS[doc] = "Lists the layers to enable during the build. This variable is defined in the bblayers.conf configuration file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists the layers to enable during the build. - This variable is defined in the <filename>bblayers.conf</filename> configuration - file in the - <link linkend='build-directory'>Build Directory</link>. - Here is an example: - <literallayout class='monospaced'> - BBLAYERS = " \ - /home/scottrif/poky/meta \ - /home/scottrif/poky/meta-poky \ - /home/scottrif/poky/meta-yocto-bsp \ - /home/scottrif/poky/meta-mykernel \ - " - </literallayout> - </para> - - <para> - This example enables four layers, one of which is a custom, user-defined layer - named <filename>meta-mykernel</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBMASK'><glossterm>BBMASK</glossterm> - <info> - BBMASK[doc] = "Prevents BitBake from processing specific recipes or recipe append files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Prevents BitBake from processing recipes and recipe - append files. - </para> - - <para> - You can use the <filename>BBMASK</filename> variable - to "hide" these <filename>.bb</filename> and - <filename>.bbappend</filename> files. - BitBake ignores any recipe or recipe append files that - match any of the expressions. - It is as if BitBake does not see them at all. - Consequently, matching files are not parsed or otherwise - used by BitBake. - </para> - - <para> - The values you provide are passed to Python's regular - expression compiler. - 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 - <ulink url='http://docs.python.org/3/library/re.html#re'></ulink>. - </para> - - <para> - The following example uses a complete regular expression - to tell BitBake to ignore all recipe and recipe append - files in the <filename>meta-ti/recipes-misc/</filename> - directory: - <literallayout class='monospaced'> - BBMASK = "meta-ti/recipes-misc/" - </literallayout> - If you want to mask out multiple directories or recipes, - you can specify multiple regular expression fragments. - This next example masks out multiple directories and - individual recipes: - <literallayout class='monospaced'> - BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/" - BBMASK += "/meta-oe/recipes-support/" - BBMASK += "/meta-foo/.*/openldap" - BBMASK += "opencv.*\.bbappend" - BBMASK += "lzma" - </literallayout> - <note> - When specifying a directory name, use the trailing - slash character to ensure you match just that directory - name. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBMULTICONFIG'><glossterm>BBMULTICONFIG</glossterm> - <info> - BBMULTICONFIG[doc] = "Specifies each separate configuration when you are building targets with multiple configurations." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies each separate configuration when you are - building targets with multiple configurations. - Use this variable in your - <filename>conf/local.conf</filename> configuration file. - Specify a <replaceable>multiconfigname</replaceable> for - each configuration file you are using. - For example, the following line specifies three - configuration files: - <literallayout class='monospaced'> - BBMULTIFONFIG = "configA configB configC" - </literallayout> - Each configuration file you use must reside in the - <link linkend='build-directory'>Build Directory</link> - <filename>conf/multiconfig</filename> directory - (e.g. - <replaceable>build_directory</replaceable><filename>/conf/multiconfig/configA.conf</filename>). - </para> - - <para> - For information on how to use - <filename>BBMULTICONFIG</filename> in an environment that - supports building targets with multiple configurations, - see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-building-images-for-multiple-targets-using-multiple-configurations'>Building Images for Multiple Targets Using Multiple Configurations</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> - <info> - BBPATH[doc] = "Used by BitBake to locate .bbclass and configuration files. This variable is analogous to the PATH variable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Used by BitBake to locate - <filename>.bbclass</filename> and configuration files. - This variable is analogous to the - <filename>PATH</filename> variable. - <note> - If you run BitBake from a directory outside of the - <link linkend='build-directory'>Build Directory</link>, - you must be sure to set - <filename>BBPATH</filename> to point to the - Build Directory. - Set the variable as you would any environment variable - and then run BitBake: - <literallayout class='monospaced'> - $ BBPATH = "<replaceable>build_directory</replaceable>" - $ export BBPATH - $ bitbake <replaceable>target</replaceable> - </literallayout> - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BBSERVER'><glossterm>BBSERVER</glossterm> - <info> - BBSERVER[doc] = "Points to the BitBake remote server." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If defined in the BitBake environment, - <filename>BBSERVER</filename> points to the BitBake - remote server. - </para> - - <para> - Use the following format to export the variable to the - BitBake environment: - <literallayout class='monospaced'> - export BBSERVER=localhost:$port" - </literallayout> - </para> - - <para> - By default, <filename>BBSERVER</filename> also appears in - <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_HASHBASE_WHITELIST'><filename>BB_HASHBASE_WHITELIST</filename></ulink>. - Consequently, <filename>BBSERVER</filename> is excluded - from checksum and dependency data. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BINCONFIG'><glossterm>BINCONFIG</glossterm> - <info> - BINCONFIG[doc] = "When inheriting the binconfig-disabled class, this variable specifies binary configuration scripts to disable in favor of using pkg-config to query the information." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-binconfig-disabled'><filename>binconfig-disabled</filename></link> - class, this variable specifies binary configuration - scripts to disable in favor of using - <filename>pkg-config</filename> to query the information. - The <filename>binconfig-disabled</filename> class will - modify the specified scripts to return an error so that - calls to them can be easily found and replaced. - </para> - - <para> - To add multiple scripts, separate them by spaces. - Here is an example from the <filename>libpng</filename> - recipe: - <literallayout class='monospaced'> - BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm> - <info> - BINCONFIG_GLOB[doc] = "When inheriting binconfig.bbclass from a recipe, this variable specifies a wildcard for configuration scripts that need editing." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> - class, this variable specifies a wildcard for - configuration scripts that need editing. - The scripts are edited to correct any paths that have been - set up during compilation so that they are correct for - use when installed into the sysroot and called by the - build processes of other recipes. - <note> - The <filename>BINCONFIG_GLOB</filename> variable - uses - <ulink url='http://tldp.org/LDP/abs/html/globbingref.html'>shell globbing</ulink>, - which is recognition and expansion of wildcards during - pattern matching. - Shell globbing is very similar to - <ulink url='https://docs.python.org/2/library/fnmatch.html#module-fnmatch'><filename>fnmatch</filename></ulink> - and - <ulink url='https://docs.python.org/2/library/glob.html'><filename>glob</filename></ulink>. - </note> - </para> - - <para> - For more information on how this variable works, see - <filename>meta/classes/binconfig.bbclass</filename> in the - <link linkend='source-directory'>Source Directory</link>. - You can also find general information on the class in the - "<link linkend='ref-classes-binconfig'><filename>binconfig.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BP'><glossterm>BP</glossterm> - <info> - BP[doc] = "The base recipe name and version but without any special recipe name suffix (i.e. -native, lib64-, and so forth). BP is comprised of ${BPN}-${PV}" - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The base recipe name and version but without any special - recipe name suffix (i.e. <filename>-native</filename>, <filename>lib64-</filename>, - and so forth). - <filename>BP</filename> is comprised of the following: - <literallayout class="monospaced"> - ${BPN}-${PV} - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BPN'><glossterm>BPN</glossterm> - <info> - BPN[doc] = "This variable is a version of the PN variable but removes common suffixes and prefixes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable is a version of the - <link linkend='var-PN'><filename>PN</filename></link> - variable with common prefixes and suffixes - removed, such as <filename>nativesdk-</filename>, - <filename>-cross</filename>, - <filename>-native</filename>, and multilib's - <filename>lib64-</filename> and - <filename>lib32-</filename>. - The exact lists of prefixes and suffixes removed are - specified by the - <link linkend='var-MLPREFIX'><filename>MLPREFIX</filename></link> - and - <link linkend='var-SPECIAL_PKGSUFFIX'><filename>SPECIAL_PKGSUFFIX</filename></link> - variables, respectively. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUGTRACKER'><glossterm>BUGTRACKER</glossterm> - <info> - BUGTRACKER[doc] = "Specifies a URL for an upstream bug tracking website for a recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a URL for an upstream bug tracking website for - a recipe. - The OpenEmbedded build system does not use this variable. - Rather, the variable is a useful pointer in case a bug - in the software being built needs to be manually reported. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_ARCH'><glossterm>BUILD_ARCH</glossterm> - <info> - BUILD_ARCH[doc] = "The name of the building architecture (e.g. i686)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the architecture of the build host - (e.g. <filename>i686</filename>). - The OpenEmbedded build system sets the value of - <filename>BUILD_ARCH</filename> from the machine name - reported by the <filename>uname</filename> command. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_AS_ARCH'><glossterm>BUILD_AS_ARCH</glossterm> - <info> - BUILD_AS_ARCH[doc] = "Specifies the architecture-specific assembler flags for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the architecture-specific assembler flags for - the build host. By default, the value of - <filename>BUILD_AS_ARCH</filename> is empty. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_CC_ARCH'><glossterm>BUILD_CC_ARCH</glossterm> - <info> - BUILD_CC_ARCH[doc] = "Specifies the architecture-specific C compiler flags for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the architecture-specific C compiler flags for - the build host. By default, the value of - <filename>BUILD_CC_ARCH</filename> is empty. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_CCLD'><glossterm>BUILD_CCLD</glossterm> - <info> - BUILD_CCLD[doc] = "Specifies the linker command to be used for the build host when the C compiler is being used as the linker." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the linker command to be used for the build host - when the C compiler is being used as the linker. By default, - <filename>BUILD_CCLD</filename> points to GCC and passes as - arguments the value of - <link linkend='var-BUILD_CC_ARCH'><filename>BUILD_CC_ARCH</filename></link>, - assuming <filename>BUILD_CC_ARCH</filename> is set. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_CFLAGS'><glossterm>BUILD_CFLAGS</glossterm> - <info> - BUILD_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C compiler when building - for the build host. - When building in the <filename>-native</filename> context, - <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> - is set to the value of this variable by default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_CPPFLAGS'><glossterm>BUILD_CPPFLAGS</glossterm> - <info> - BUILD_CPPFLAGS[doc] = "Specifies the flags to pass to the C preprocessor (i.e. to both the C and the C++ compilers) when building for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C preprocessor - (i.e. to both the C and the C++ compilers) when building - for the build host. - When building in the <filename>-native</filename> context, - <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link> - is set to the value of this variable by default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_CXXFLAGS'><glossterm>BUILD_CXXFLAGS</glossterm> - <info> - BUILD_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C++ compiler when - building for the build host. - When building in the <filename>-native</filename> context, - <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link> - is set to the value of this variable by default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_FC'><glossterm>BUILD_FC</glossterm> - <info> - BUILD_FC[doc] = "Specifies the Fortran compiler command for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the Fortran compiler command for the build host. - By default, <filename>BUILD_FC</filename> points to - Gfortran and passes as arguments the value of - <link linkend='var-BUILD_CC_ARCH'><filename>BUILD_CC_ARCH</filename></link>, - assuming <filename>BUILD_CC_ARCH</filename> is set. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_LD'><glossterm>BUILD_LD</glossterm> - <info> - BUILD_LD[doc] = "Specifies the linker command for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the linker command for the build host. By default, - <filename>BUILD_LD</filename> points to the GNU linker (ld) - and passes as arguments the value of - <link linkend='var-BUILD_LD_ARCH'><filename>BUILD_LD_ARCH</filename></link>, - assuming <filename>BUILD_LD_ARCH</filename> is set. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_LD_ARCH'><glossterm>BUILD_LD_ARCH</glossterm> - <info> - BUILD_LD_ARCH[doc] = "Specifies architecture-specific linker flags for the build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies architecture-specific linker flags for the build - host. By default, the value of - <filename>BUILD_LD_ARCH</filename> is empty. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_LDFLAGS'><glossterm>BUILD_LDFLAGS</glossterm> - <info> - BUILD_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the linker when building - for the build host. - When building in the <filename>-native</filename> context, - <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> - is set to the value of this variable by default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_OPTIMIZATION'><glossterm>BUILD_OPTIMIZATION</glossterm> - <info> - BUILD_OPTIMIZATION[doc] = "Specifies the optimization flags passed to the C compiler when building for the build host or the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the optimization flags passed to the C compiler - when building for the build host or the SDK. - The flags are passed through the - <link linkend='var-BUILD_CFLAGS'><filename>BUILD_CFLAGS</filename></link> - and - <link linkend='var-BUILDSDK_CFLAGS'><filename>BUILDSDK_CFLAGS</filename></link> - default values. - </para> - - <para> - The default value of the - <filename>BUILD_OPTIMIZATION</filename> variable is - "-O2 -pipe". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_OS'><glossterm>BUILD_OS</glossterm> - <info> - BUILD_OS[doc] = "The operating system (in lower case) of the building architecture (e.g. Linux)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the operating system in use on the build - host (e.g. "linux"). - The OpenEmbedded build system sets the value of - <filename>BUILD_OS</filename> from the OS reported by - the <filename>uname</filename> command - the first word, - converted to lower-case characters. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_PREFIX'><glossterm>BUILD_PREFIX</glossterm> - <info> - BUILD_PREFIX[doc] = "The toolchain binary prefix used for native recipes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The toolchain binary prefix used for native recipes. - The OpenEmbedded build system uses the - <filename>BUILD_PREFIX</filename> value to set the - <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> - when building for <filename>native</filename> recipes. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_STRIP'><glossterm>BUILD_STRIP</glossterm> - <info> - BUILD_STRIP[doc] = "Specifies the command to be used to strip debugging symbols from binaries produced for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the command to be used to strip debugging symbols - from binaries produced for the build host. By default, - <filename>BUILD_STRIP</filename> points to - <filename>${</filename><link linkend='var-BUILD_PREFIX'><filename>BUILD_PREFIX</filename></link><filename>}strip</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_SYS'><glossterm>BUILD_SYS</glossterm> - <info> - BUILD_SYS[doc] = "The toolchain binary prefix used for native recipes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the system, including the architecture and - the operating system, to use when building for the build - host (i.e. when building <filename>native</filename> - recipes). - </para> - - <para> - The OpenEmbedded build system automatically sets this - variable based on - <link linkend='var-BUILD_ARCH'><filename>BUILD_ARCH</filename></link>, - <link linkend='var-BUILD_VENDOR'><filename>BUILD_VENDOR</filename></link>, - and - <link linkend='var-BUILD_OS'><filename>BUILD_OS</filename></link>. - You do not need to set the <filename>BUILD_SYS</filename> - variable yourself. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILD_VENDOR'><glossterm>BUILD_VENDOR</glossterm> - <info> - BUILD_VENDOR[doc] = "The vendor name to use when building for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the vendor name to use when building for the - build host. - The default value is an empty string (""). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDDIR'><glossterm>BUILDDIR</glossterm> - <info> - BUILDDIR[doc] = "Points to the location of the Build Directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the location of the - <link linkend='build-directory'>Build Directory</link>. - You can define this directory indirectly through the - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> - 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 <filename>BUILDDIR</filename> defaults to - <filename>build</filename> in the current directory. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDHISTORY_COMMIT'><glossterm>BUILDHISTORY_COMMIT</glossterm> - <info> - BUILDHISTORY_COMMIT[doc] = "When inheriting the buildhistory class, this variable specifies whether or not to commit the build history output in a local Git repository." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> - class, this variable specifies whether or not to commit the - build history output in a local Git repository. - If set to "1", this local repository will be maintained - automatically by the - <filename>buildhistory</filename> - class and a commit will be created on every - build for changes to each top-level subdirectory of the - build history output (images, packages, and sdk). - If you want to track changes to build history over - time, you should set this value to "1". - </para> - - <para> - By default, the <filename>buildhistory</filename> class - does not commit the build history output in a local - Git repository: - <literallayout class='monospaced'> - BUILDHISTORY_COMMIT ?= "0" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDHISTORY_COMMIT_AUTHOR'><glossterm>BUILDHISTORY_COMMIT_AUTHOR</glossterm> - <info> - BUILDHISTORY_COMMIT_AUTHOR[doc] = "When inheriting the buildhistory class, this variable specifies the author to use for each Git commit." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> - class, this variable specifies the author to use for each - Git commit. - In order for the <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> - variable to work, the - <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> - variable must be set to "1". - </para> - - <para> - Git requires that the value you provide for the - <filename>BUILDHISTORY_COMMIT_AUTHOR</filename> variable - takes the form of "name <replaceable>email@host</replaceable>". - Providing an email address or host that is not valid does - not produce an error. - </para> - - <para> - By default, the <filename>buildhistory</filename> class - sets the variable as follows: - <literallayout class='monospaced'> - BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDHISTORY_DIR'><glossterm>BUILDHISTORY_DIR</glossterm> - <info> - BUILDHISTORY_DIR[doc] = "When inheriting the buildhistory class, this variable specifies the directory in which build history information is kept." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> - class, this variable specifies the directory in which - build history information is kept. - For more information on how the variable works, see the - <filename>buildhistory.class</filename>. - </para> - - <para> - By default, the <filename>buildhistory</filename> class - sets the directory as follows: - <literallayout class='monospaced'> - BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDHISTORY_FEATURES'><glossterm>BUILDHISTORY_FEATURES</glossterm> - <info> - BUILDHISTORY_FEATURES[doc] = "When inheriting the buildhistory class, this variable specifies the build history features to be enabled." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> - class, this variable specifies the build history features - to be enabled. - For more information on how build history works, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-build-output-quality'>Maintaining Build Output Quality</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - - <para> - You can specify these features in the form of a - space-separated list: - <itemizedlist> - <listitem><para><emphasis>image:</emphasis> - Analysis of the contents of images, which - includes the list of installed packages among other - things. - </para></listitem> - <listitem><para><emphasis>package:</emphasis> - Analysis of the contents of individual packages. - </para></listitem> - <listitem><para><emphasis>sdk:</emphasis> - Analysis of the contents of the software - development kit (SDK). - </para></listitem> - <listitem><para><emphasis>task:</emphasis> - Save output file signatures for - <ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>shared state</ulink> - (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). - </para></listitem> - </itemizedlist> - </para> - - <para> - By default, the <filename>buildhistory</filename> class - enables the following features: - <literallayout class='monospaced'> - BUILDHISTORY_FEATURES ?= "image package sdk" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDHISTORY_IMAGE_FILES'><glossterm>BUILDHISTORY_IMAGE_FILES</glossterm> - <info> - BUILDHISTORY_IMAGE_FILES[doc] = "When inheriting the buildhistory class, this variable specifies a list of paths to files copied from the image contents into the build history directory under an "image-files" directory in the directory for the image, so that you can track the contents of each file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> - class, this variable specifies a list of paths to files - copied from the - image contents into the build history directory under - an "image-files" directory in the directory for - the image, so that you can track the contents of each file. - The default is to copy <filename>/etc/passwd</filename> - and <filename>/etc/group</filename>, which allows you to - monitor for changes in user and group entries. - You can modify the list to include any file. - Specifying an invalid path does not produce an error. - Consequently, you can include files that might - not always be present. - </para> - - <para> - By default, the <filename>buildhistory</filename> class - provides paths to the following files: - <literallayout class='monospaced'> - BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDHISTORY_PUSH_REPO'><glossterm>BUILDHISTORY_PUSH_REPO</glossterm> - <info> - BUILDHISTORY_PUSH_REPO[doc] = "When inheriting the buildhistory class, this variable optionally specifies a remote repository to which build history pushes Git changes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-buildhistory'><filename>buildhistory</filename></link> - class, this variable optionally specifies a remote - repository to which build history pushes Git changes. - In order for <filename>BUILDHISTORY_PUSH_REPO</filename> - to work, - <link linkend='var-BUILDHISTORY_COMMIT'><filename>BUILDHISTORY_COMMIT</filename></link> - must be set to "1". - </para> - - <para> - The repository should correspond to a remote - address that specifies a repository as understood by - Git, or alternatively to a remote name that you have - set up manually using <filename>git remote</filename> - within the local repository. - </para> - - <para> - By default, the <filename>buildhistory</filename> class - sets the variable as follows: - <literallayout class='monospaced'> - BUILDHISTORY_PUSH_REPO ?= "" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDSDK_CFLAGS'><glossterm>BUILDSDK_CFLAGS</glossterm> - <info> - BUILDSDK_CFLAGS[doc] = "Specifies the flags to pass to the C compiler when building for the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C compiler when building - for the SDK. - When building in the <filename>nativesdk-</filename> - context, - <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> - is set to the value of this variable by default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDSDK_CPPFLAGS'><glossterm>BUILDSDK_CPPFLAGS</glossterm> - <info> - BUILDSDK_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C pre-processor - (i.e. to both the C and the C++ compilers) when building - for the SDK. - When building in the <filename>nativesdk-</filename> - context, - <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link> - is set to the value of this variable by default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDSDK_CXXFLAGS'><glossterm>BUILDSDK_CXXFLAGS</glossterm> - <info> - BUILDSDK_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C++ compiler when - building for the SDK. - When building in the <filename>nativesdk-</filename> - context, - <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link> - is set to the value of this variable by default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDSDK_LDFLAGS'><glossterm>BUILDSDK_LDFLAGS</glossterm> - <info> - BUILDSDK_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the linker when building - for the SDK. - When building in the <filename>nativesdk-</filename> - context, - <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> - is set to the value of this variable by default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUILDSTATS_BASE'><glossterm>BUILDSTATS_BASE</glossterm> - <info> - BUILDSTATS_BASE[doc] = "Points to the location of the directory that holds build statistics when you use and enable the buildstats class." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the location of the directory that holds build - statistics when you use and enable the - <link linkend='ref-classes-buildstats'><filename>buildstats</filename></link> - class. - The <filename>BUILDSTATS_BASE</filename> directory defaults - to - <filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/buildstats/</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-BUSYBOX_SPLIT_SUID'><glossterm>BUSYBOX_SPLIT_SUID</glossterm> - <info> - BUSYBOX_SPLIT_SUID[doc] = "For the BusyBox recipe, specifies whether to split the output executable file into two parts: one for features that require setuid root, and one for the remaining features." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - For the BusyBox recipe, specifies whether to split the - output executable file into two parts: one for features - that require <filename>setuid root</filename>, and one for - the remaining features (i.e. those that do not require - <filename>setuid root</filename>). - </para> - - <para> - The <filename>BUSYBOX_SPLIT_SUID</filename> variable - defaults to "1", which results in a single output - executable file. - Set the variable to "0" to split the output file. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-c'><title>C</title> - - <glossentry id='var-CACHE'><glossterm>CACHE</glossterm> - <info> - CACHE[doc] = "The directory BitBake uses to store a cache of the metadata." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the directory BitBake uses to store a cache - of the - <link linkend='metadata'>Metadata</link> - so it does not need to be parsed every time BitBake is - started. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CC'><glossterm>CC</glossterm> - <info> - CC[doc] = "Minimum command and arguments to run the C compiler." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments used to run the C - compiler. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CFLAGS'><glossterm>CFLAGS</glossterm> - <info> - CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as TARGET_CFLAGS." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C compiler. - This variable is exported to an environment - variable and thus made visible to the software being - built during the compilation step. - </para> - - <para> - Default initialization for <filename>CFLAGS</filename> - varies depending on what is being built: - <itemizedlist> - <listitem><para> - <link linkend='var-TARGET_CFLAGS'><filename>TARGET_CFLAGS</filename></link> - when building for the target - </para></listitem> - <listitem><para> - <link linkend='var-BUILD_CFLAGS'><filename>BUILD_CFLAGS</filename></link> - when building for the build host (i.e. - <filename>-native</filename>) - </para></listitem> - <listitem><para> - <link linkend='var-BUILDSDK_CFLAGS'><filename>BUILDSDK_CFLAGS</filename></link> - when building for an SDK (i.e. - <filename>nativesdk-</filename>) - </para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CLASSOVERRIDE'><glossterm>CLASSOVERRIDE</glossterm> - <info> - CLASSOVERRIDE[doc] = "An internal variable specifying the special class override that should currently apply (e.g. "class-target", "class-native", and so forth)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - An internal variable specifying the special class override - that should currently apply (e.g. "class-target", - "class-native", and so forth). - The classes that use this variable (e.g. - <link linkend='ref-classes-native'><filename>native</filename></link>, - <link linkend='ref-classes-nativesdk'><filename>nativesdk</filename></link>, - and so forth) set the variable to appropriate values. - <note> - <filename>CLASSOVERRIDE</filename> gets its default - "class-target" value from the - <filename>bitbake.conf</filename> file. - </note> - </para> - - <para> - As an example, the following override allows you to install - extra files, but only when building for the target: - <literallayout class='monospaced'> - do_install_append_class-target() { - install my-extra-file ${D}${sysconfdir} - } - </literallayout> - Here is an example where <filename>FOO</filename> - is set to "native" when building for the build host, and - to "other" when not building for the build host: - <literallayout class='monospaced'> - FOO_class-native = "native" - FOO = "other" - </literallayout> - The underlying mechanism behind - <filename>CLASSOVERRIDE</filename> is simply that it is - included in the default value of - <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CLEANBROKEN'><glossterm>CLEANBROKEN</glossterm> - <info> - CLEANBROKEN[doc] = "Prevents the build system from running 'make clean' during the do_configure task." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set to "1" within a recipe, - <filename>CLEANBROKEN</filename> specifies that - the <filename>make clean</filename> command does - not work for the software being built. - Consequently, the OpenEmbedded build system will not try - to run <filename>make clean</filename> during the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task, which is the default behavior. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COMBINED_FEATURES'><glossterm>COMBINED_FEATURES</glossterm> - <info> - COMBINED_FEATURES[doc] = "A set of features common between MACHINE_FEATURES and DISTRO_FEATURES." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Provides a list of hardware features that are enabled in - both - <link linkend='var-MACHINE_FEATURES'><filename>MACHINE_FEATURES</filename></link> - and - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. - This select list of features contains features that make - sense to be controlled both at the machine and distribution - configuration level. - For example, the "bluetooth" feature requires hardware - support but should also be optional at the distribution - level, in case the hardware supports Bluetooth but you - do not ever intend to use it. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COMMON_LICENSE_DIR'><glossterm>COMMON_LICENSE_DIR</glossterm> - <info> - COMMON_LICENSE_DIR[doc] = "Points to meta/files/common-licenses in the Source Directory, which is where generic license files reside." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to <filename>meta/files/common-licenses</filename> - in the - <link linkend='source-directory'>Source Directory</link>, - which is where generic license files reside. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm> - <info> - COMPATIBLE_HOST[doc] = "A regular expression that resolves to one or more hosts (when the recipe is native) or one or more targets (when the recipe is non-native) with which a recipe is compatible." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A regular expression that resolves to one or more hosts - (when the recipe is native) or one or more targets (when - the recipe is non-native) with which a recipe is compatible. - The regular expression is matched against - <link linkend="var-HOST_SYS"><filename>HOST_SYS</filename></link>. - You can use the variable to stop recipes from being built - for classes of systems with which the recipes are not - compatible. - Stopping these builds is particularly useful with kernels. - The variable also helps to increase parsing speed - since the build system skips parsing recipes not - compatible with the current system. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> - <info> - COMPATIBLE_MACHINE[doc] = "A regular expression that resolves to one or more target machines with which a recipe is compatible." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A regular expression that resolves to one or more - target machines with which a recipe is compatible. - The regular expression is matched against - <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link>. - You can use the variable to stop recipes from being built - for machines with which the recipes are not compatible. - Stopping these builds is particularly useful with kernels. - The variable also helps to increase parsing speed - since the build system skips parsing recipes not - compatible with the current machine. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COMPLEMENTARY_GLOB'><glossterm>COMPLEMENTARY_GLOB</glossterm> - <info> - COMPLEMENTARY_GLOB[doc] = "Defines wildcards to match when installing a list of complementary packages for all the packages installed in an image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines wildcards to match when installing a list of - complementary packages for all the packages explicitly - (or implicitly) installed in an image. - <note> - The <filename>COMPLEMENTARY_GLOB</filename> variable - uses Unix filename pattern matching - (<ulink url='https://docs.python.org/2/library/fnmatch.html#module-fnmatch'><filename>fnmatch</filename></ulink>), - which is similar to the Unix style pathname pattern - expansion - (<ulink url='https://docs.python.org/2/library/glob.html'><filename>glob</filename></ulink>). - </note> - The resulting list of complementary packages is associated - with an item that can be added to - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. - An example usage of this is the "dev-pkgs" item that when - added to <filename>IMAGE_FEATURES</filename> will - install -dev packages (containing headers and other - development files) for every package in the image. - </para> - - <para> - To add a new feature item pointing to a wildcard, use a - variable flag to specify the feature item name and - use the value to specify the wildcard. - Here is an example: - <literallayout class='monospaced'> - COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev' - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COMPONENTS_DIR'><glossterm>COMPONENTS_DIR</glossterm> - <info> - COMPONENTS_DIR[doc] = "Stores sysroot components for each recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Stores sysroot components for each recipe. - The OpenEmbedded build system uses - <filename>COMPONENTS_DIR</filename> when constructing - recipe-specific sysroots for other recipes. - </para> - - <para> - The default is - "<filename>${</filename><link linkend='var-STAGING_DIR'><filename>STAGING_DIR</filename></link><filename>}-components</filename>." - (i.e. "<filename>${</filename><link linkend='var-TMPDIR'><filename>TMPDIR</filename></link><filename>}/sysroots-components</filename>"). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CONF_VERSION'><glossterm>CONF_VERSION</glossterm> - <info> - CONF_VERSION[doc] = "Tracks the version of local.conf. Increased each time build/conf/ changes incompatibly." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Tracks the version of the local configuration file - (i.e. <filename>local.conf</filename>). - The value for <filename>CONF_VERSION</filename> - increments each time <filename>build/conf/</filename> - compatibility changes. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CONFFILES'><glossterm>CONFFILES</glossterm> - <info> - CONFFILES[doc] = "Identifies editable or configurable files that are part of a package." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Identifies editable or configurable files that are part of a package. - If the Package Management System (PMS) is being used to update - packages on the target system, it is possible that - configuration files you have changed after the original installation - and that you now want to remain unchanged are overwritten. - In other words, editable files might exist in the package that you do not - want reset as part of the package update process. - You can use the <filename>CONFFILES</filename> variable to list the files in the - package that you wish to prevent the PMS from overwriting during this update process. - </para> - - <para> - To use the <filename>CONFFILES</filename> variable, provide a package name - override that identifies the resulting package. - Then, provide a space-separated list of files. - Here is an example: - <literallayout class='monospaced'> - CONFFILES_${PN} += "${sysconfdir}/file1 \ - ${sysconfdir}/file2 ${sysconfdir}/file3" - </literallayout> - </para> - - <para> - A relationship exists between the <filename>CONFFILES</filename> and - <filename><link linkend='var-FILES'>FILES</link></filename> variables. - The files listed within <filename>CONFFILES</filename> must be a subset of - the files listed within <filename>FILES</filename>. - Because the configuration files you provide with <filename>CONFFILES</filename> - are simply being identified so that the PMS will not overwrite them, - it makes sense that - the files must already be included as part of the package through the - <filename>FILES</filename> variable. - </para> - - <note> - When specifying paths as part of the <filename>CONFFILES</filename> variable, - it is good practice to use appropriate path variables. - For example, <filename>${sysconfdir}</filename> rather than - <filename>/etc</filename> or <filename>${bindir}</filename> rather - than <filename>/usr/bin</filename>. - You can find a list of these variables at the top of the - <filename>meta/conf/bitbake.conf</filename> file in the - <link linkend='source-directory'>Source Directory</link>. - </note> - </glossdef> - </glossentry> - - <glossentry id='var-CONFIG_INITRAMFS_SOURCE'><glossterm>CONFIG_INITRAMFS_SOURCE</glossterm> - <info> - CONFIG_INITRAMFS_SOURCE[doc] = "Identifies the initial RAM filesystem (initramfs) source files. The OpenEmbedded build system receives and uses this kernel Kconfig variable as an environment variable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Identifies the initial RAM 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 (""). - </para> - - <para> - The <filename>CONFIG_INITRAMFS_SOURCE</filename> can be - either a single cpio archive with a - <filename>.cpio</filename> suffix or a - space-separated list of directories and files for building - the initramfs image. - A cpio archive should contain a filesystem archive - to be used as an initramfs image. - Directories should contain a filesystem layout to be - included in the initramfs image. - Files should contain entries according to the format - described by the - <filename>usr/gen_init_cpio</filename> program in the - kernel tree. - </para> - - <para> - If you specify multiple directories and files, the - initramfs image will be the aggregate of all of them. - </para> - - <para> - For information on creating an initramfs, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CONFIG_SITE'><glossterm>CONFIG_SITE</glossterm> - <info> - CONFIG_SITE[doc] = "A list of files that contains autoconf test results relevant to the current build. This variable is used by the Autotools utilities when running configure." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of files that contains <filename>autoconf</filename> test results relevant - to the current build. - This variable is used by the Autotools utilities when running - <filename>configure</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CONFIGURE_FLAGS'><glossterm>CONFIGURE_FLAGS</glossterm> - <info> - CONFIGURE_FLAGS[doc] = "The minimal arguments for GNU configure." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal arguments for GNU configure. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CONFLICT_DISTRO_FEATURES'><glossterm>CONFLICT_DISTRO_FEATURES</glossterm> - <info> - CONFLICT_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that would be in conflict should the recipe be built." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link> - class, this - variable identifies distribution features that would - be in conflict should the recipe - be built. - In other words, if the - <filename>CONFLICT_DISTRO_FEATURES</filename> variable - lists a feature that also appears in - <filename>DISTRO_FEATURES</filename> within the - current configuration, an error occurs and the - build stops. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COPYLEFT_LICENSE_EXCLUDE'><glossterm>COPYLEFT_LICENSE_EXCLUDE</glossterm> - <info> - COPYLEFT_LICENSE_EXCLUDE[doc] = "Licenses to exclude in the source archived by the archiver class." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A space-separated list of licenses to exclude from the - source archived by the - <link linkend='ref-classes-archiver'><filename>archiver</filename></link> - class. - In other words, if a license in a recipe's - <link linkend='var-LICENSE'><filename>LICENSE</filename></link> - value is in the value of - <filename>COPYLEFT_LICENSE_EXCLUDE</filename>, then its - source is not archived by the class. - <note> - The <filename>COPYLEFT_LICENSE_EXCLUDE</filename> - variable takes precedence over the - <link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link> - variable. - </note> - The default value, which is "CLOSED Proprietary", for - <filename>COPYLEFT_LICENSE_EXCLUDE</filename> is set - by the - <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link> - class, which is inherited by the - <filename>archiver</filename> class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COPYLEFT_LICENSE_INCLUDE'><glossterm>COPYLEFT_LICENSE_INCLUDE</glossterm> - <info> - COPYLEFT_LICENSE_INCLUDE[doc] = "Licenses to include in the source archived by the archiver class." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A space-separated list of licenses to include in the - source archived by the - <link linkend='ref-classes-archiver'><filename>archiver</filename></link> - class. - In other words, if a license in a recipe's - <link linkend='var-LICENSE'><filename>LICENSE</filename></link> - value is in the value of - <filename>COPYLEFT_LICENSE_INCLUDE</filename>, then its - source is archived by the class. - </para> - - <para> - The default value is set by the - <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link> - class, which is inherited by the - <filename>archiver</filename> class. - The default value includes "GPL*", "LGPL*", and "AGPL*". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COPYLEFT_PN_EXCLUDE'><glossterm>COPYLEFT_PN_EXCLUDE</glossterm> - <info> - COPYLEFT_PN_EXCLUDE[doc] = "Recipes to exclude in the source archived by the archiver class." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of recipes to exclude in the source archived - by the - <link linkend='ref-classes-archiver'><filename>archiver</filename></link> - class. - The <filename>COPYLEFT_PN_EXCLUDE</filename> variable - overrides the license inclusion and exclusion caused - through the - <link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link> - and - <link linkend='var-COPYLEFT_LICENSE_EXCLUDE'><filename>COPYLEFT_LICENSE_EXCLUDE</filename></link> - variables, respectively. - </para> - - <para> - The default value, which is "" indicating to not explicitly - exclude any recipes by name, for - <filename>COPYLEFT_PN_EXCLUDE</filename> is set - by the - <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link> - class, which is inherited by the - <filename>archiver</filename> class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COPYLEFT_PN_INCLUDE'><glossterm>COPYLEFT_PN_INCLUDE</glossterm> - <info> - COPYLEFT_PN_INCLUDE[doc] = "Recipes to include in the source archived by the archiver class." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of recipes to include in the source archived - by the - <link linkend='ref-classes-archiver'><filename>archiver</filename></link> - class. - The <filename>COPYLEFT_PN_INCLUDE</filename> variable - overrides the license inclusion and exclusion caused - through the - <link linkend='var-COPYLEFT_LICENSE_INCLUDE'><filename>COPYLEFT_LICENSE_INCLUDE</filename></link> - and - <link linkend='var-COPYLEFT_LICENSE_EXCLUDE'><filename>COPYLEFT_LICENSE_EXCLUDE</filename></link> - variables, respectively. - </para> - - <para> - The default value, which is "" indicating to not explicitly - include any recipes by name, for - <filename>COPYLEFT_PN_INCLUDE</filename> is set - by the - <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link> - class, which is inherited by the - <filename>archiver</filename> class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COPYLEFT_RECIPE_TYPES'><glossterm>COPYLEFT_RECIPE_TYPES</glossterm> - <info> - COPYLEFT_RECIPE_TYPES[doc] = "Recipe types to include in the source archived by the archiver class." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A space-separated list of recipe types to include - in the source archived by the - <link linkend='ref-classes-archiver'><filename>archiver</filename></link> - class. - Recipe types are <filename>target</filename>, - <filename>native</filename>, - <filename>nativesdk</filename>, - <filename>cross</filename>, - <filename>crosssdk</filename>, and - <filename>cross-canadian</filename>. - </para> - - <para> - The default value, which is "target*", for - <filename>COPYLEFT_RECIPE_TYPES</filename> is set - by the - <link linkend='ref-classes-copyleft_filter'><filename>copyleft_filter</filename></link> - class, which is inherited by the - <filename>archiver</filename> class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COPY_LIC_DIRS'><glossterm>COPY_LIC_DIRS</glossterm> - <info> - COPY_LIC_DIRS[doc] = "If set to "1" along with the COPY_LIC_MANIFEST variable, the OpenEmbedded build system copies into the image the license files, which are located in /usr/share/common-licenses, for each package." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set to "1" along with the - <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> - variable, the OpenEmbedded build system copies - into the image the license files, which are located in - <filename>/usr/share/common-licenses</filename>, - for each package. - The license files are placed - in directories within the image itself during build time. - <note> - The <filename>COPY_LIC_DIRS</filename> does not - offer a path for adding licenses for newly installed - packages to an image, which might be most suitable - for read-only filesystems that cannot be upgraded. - See the - <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link> - variable for additional information. - You can also reference the - "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" - section in the Yocto Project Development Tasks Manual - for information on providing license text. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COPY_LIC_MANIFEST'><glossterm>COPY_LIC_MANIFEST</glossterm> - <info> - COPY_LIC_MANIFEST[doc] = "If set to "1", the OpenEmbedded build system copies the license manifest for the image to /usr/share/common-licenses/license.manifest within the image itself." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set to "1", the OpenEmbedded build system copies - the license manifest for the image to - <filename>/usr/share/common-licenses/license.manifest</filename> - within the image itself during build time. - <note> - The <filename>COPY_LIC_MANIFEST</filename> does not - offer a path for adding licenses for newly installed - packages to an image, which might be most suitable - for read-only filesystems that cannot be upgraded. - See the - <link linkend='var-LICENSE_CREATE_PACKAGE'><filename>LICENSE_CREATE_PACKAGE</filename></link> - variable for additional information. - You can also reference the - "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" - section in the Yocto Project Development Tasks Manual - for information on providing license text. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CORE_IMAGE_EXTRA_INSTALL'><glossterm>CORE_IMAGE_EXTRA_INSTALL</glossterm> - <info> - CORE_IMAGE_EXTRA_INSTALL[doc] = "Specifies the list of packages to be added to the image. You should only set this variable in the conf/local.conf file in the Build Directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the list of packages to be added to the image. - You should only set this variable in the - <filename>local.conf</filename> configuration file found - in the - <link linkend='build-directory'>Build Directory</link>. - </para> - - <para> - This variable replaces <filename>POKY_EXTRA_INSTALL</filename>, which is no longer supported. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COREBASE'><glossterm>COREBASE</glossterm> - <info> - COREBASE[doc] = "Specifies the parent directory of the OpenEmbedded-Core Metadata layer (i.e. meta)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the parent directory of the OpenEmbedded-Core - Metadata layer (i.e. <filename>meta</filename>). - </para> - - <para> - It is an important distinction that - <filename>COREBASE</filename> points to the parent of this - layer and not the layer itself. - Consider an example where you have cloned the Poky Git - repository and retained the <filename>poky</filename> - name for your local copy of the repository. - In this case, <filename>COREBASE</filename> points to - the <filename>poky</filename> folder because it is the - parent directory of the <filename>poky/meta</filename> - layer. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-COREBASE_FILES'><glossterm>COREBASE_FILES</glossterm> - <info> - COREBASE_FILES[doc] = "Lists files from the COREBASE directory that should be copied other than the layers listed in the bblayers.conf file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists files from the - <link linkend='var-COREBASE'><filename>COREBASE</filename></link> - directory that should be copied other than the layers - listed in the <filename>bblayers.conf</filename> file. - The <filename>COREBASE_FILES</filename> variable exists - for the purpose of copying metadata from the - OpenEmbedded build system into the extensible - SDK. - </para> - - <para> - Explicitly listing files in <filename>COREBASE</filename> - is needed because it typically contains build - directories and other files that should not normally - be copied into the extensible SDK. - Consequently, the value of - <filename>COREBASE_FILES</filename> is used in order to - only copy the files that are actually needed. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CPP'><glossterm>CPP</glossterm> - <info> - CPP[doc] = "Minimum command and arguments to run the C preprocessor." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments used to run the C - preprocessor. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CPPFLAGS'><glossterm>CPPFLAGS</glossterm> - <info> - CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C pre-processor - (i.e. to both the C and the C++ compilers). - This variable is exported to an environment - variable and thus made visible to the software being - built during the compilation step. - </para> - - <para> - Default initialization for <filename>CPPFLAGS</filename> - varies depending on what is being built: - <itemizedlist> - <listitem><para> - <link linkend='var-TARGET_CPPFLAGS'><filename>TARGET_CPPFLAGS</filename></link> - when building for the target - </para></listitem> - <listitem><para> - <link linkend='var-BUILD_CPPFLAGS'><filename>BUILD_CPPFLAGS</filename></link> - when building for the build host (i.e. - <filename>-native</filename>) - </para></listitem> - <listitem><para> - <link linkend='var-BUILDSDK_CPPFLAGS'><filename>BUILDSDK_CPPFLAGS</filename></link> - when building for an SDK (i.e. - <filename>nativesdk-</filename>) - </para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CROSS_COMPILE'><glossterm>CROSS_COMPILE</glossterm> - <info> - CROSS_COMPILE[doc] = "The toolchain binary prefix for the target tools." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The toolchain binary prefix for the target tools. - The <filename>CROSS_COMPILE</filename> variable is the - same as the - <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> - variable. - <note> - The OpenEmbedded build system sets the - <filename>CROSS_COMPILE</filename> variable only in - certain contexts (e.g. when building for kernel - and kernel module recipes). - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CVSDIR'><glossterm>CVSDIR</glossterm> - <info> - CVSDIR[doc] = "The directory where cvs checkouts will be stored in." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The directory in which files checked out under the - CVS system are stored. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CXX'><glossterm>CXX</glossterm> - <info> - CXX[doc] = "Minimum command and arguments to run the C++ compiler." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments used to run the C++ - compiler. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-CXXFLAGS'><glossterm>CXXFLAGS</glossterm> - <info> - CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C++ compiler. - This variable is exported to an environment - variable and thus made visible to the software being - built during the compilation step. - </para> - - <para> - Default initialization for <filename>CXXFLAGS</filename> - varies depending on what is being built: - <itemizedlist> - <listitem><para> - <link linkend='var-TARGET_CXXFLAGS'><filename>TARGET_CXXFLAGS</filename></link> - when building for the target - </para></listitem> - <listitem><para> - <link linkend='var-BUILD_CXXFLAGS'><filename>BUILD_CXXFLAGS</filename></link> - when building for the build host (i.e. - <filename>-native</filename>) - </para></listitem> - <listitem><para> - <link linkend='var-BUILDSDK_CXXFLAGS'><filename>BUILDSDK_CXXFLAGS</filename></link> - when building for an SDK (i.e. - <filename>nativesdk-</filename>) - </para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-d'><title>D</title> - - <glossentry id='var-D'><glossterm>D</glossterm> - <info> - D[doc] = "The destination directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The destination directory. - The location in the - <link linkend='build-directory'>Build Directory</link> - where components are installed by the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task. - This location defaults to: - <literallayout class='monospaced'> - ${WORKDIR}/image - </literallayout> - <note><title>Caution</title> - Tasks that read from or write to this directory should - run under - <ulink url='&YOCTO_DOCS_OM_URL;#fakeroot-and-pseudo'>fakeroot</ulink>. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DATE'><glossterm>DATE</glossterm> - <info> - DATE[doc] = "The date the build was started using YMD format." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The date the build was started. - Dates appear using the year, month, and day (YMD) format - (e.g. "20150209" for February 9th, 2015). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DATETIME'><glossterm>DATETIME</glossterm> - <info> - DATETIME[doc] = "The date and time the build was started." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The date and time on which the current build started. - The format is suitable for timestamps. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEBIAN_NOAUTONAME'><glossterm>DEBIAN_NOAUTONAME</glossterm> - <info> - DEBIAN_NOAUTONAME[doc] = "Prevents a particular package from being renamed according to Debian package naming." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the - <link linkend='ref-classes-debian'><filename>debian</filename></link> - class is inherited, which is the default behavior, - <filename>DEBIAN_NOAUTONAME</filename> specifies a - particular package should not be renamed according to - Debian library package naming. - You must use the package name as an override when you - set this variable. - Here is an example from the <filename>fontconfig</filename> - recipe: - <literallayout class='monospaced'> - DEBIAN_NOAUTONAME_fontconfig-utils = "1" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEBIANNAME'><glossterm>DEBIANNAME</glossterm> - <info> - DEBIANNAME[doc] = "Allows you to override the library name for an individual package for Debian library package renaming." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the - <link linkend='ref-classes-debian'><filename>debian</filename></link> - class is inherited, which is the default behavior, - <filename>DEBIANNAME</filename> allows you to override the - library name for an individual package. - Overriding the library name in these cases is rare. - You must use the package name as an override when you - set this variable. - Here is an example from the <filename>dbus</filename> - recipe: - <literallayout class='monospaced'> - DEBIANNAME_${PN} = "dbus-1" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEBUG_BUILD'><glossterm>DEBUG_BUILD</glossterm> - <info> - DEBUG_BUILD[doc] = "Specifies to build packages with debugging information. This influences the value of the SELECTED_OPTIMIZATION variable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies to build packages with debugging information. - This influences the value of the - <filename><link linkend='var-SELECTED_OPTIMIZATION'>SELECTED_OPTIMIZATION</link></filename> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEBUG_OPTIMIZATION'><glossterm>DEBUG_OPTIMIZATION</glossterm> - <info> - DEBUG_OPTIMIZATION[doc] = "The options to pass in TARGET_CFLAGS and CFLAGS when compiling a system for debugging. This variable defaults to '-O -fno-omit-frame-pointer -g'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The options to pass in - <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> - and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> when compiling - a system for debugging. - This variable defaults to "-O -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEFAULT_PREFERENCE'><glossterm>DEFAULT_PREFERENCE</glossterm> - <info> - DEFAULT_PREFERENCE[doc] = "Specifies a weak bias for recipe selection priority." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a weak bias for recipe selection priority. - </para> - - <para> - The most common usage of this is variable is to set - it to "-1" within a recipe for a development version of a - piece of software. - Using the variable in this way causes the stable version - of the recipe to build by default in the absence of - <filename><link linkend='var-PREFERRED_VERSION'>PREFERRED_VERSION</link></filename> - being used to build the development version. - </para> - - <note> - The bias provided by <filename>DEFAULT_PREFERENCE</filename> - is weak and is overridden by - <filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename> - if that variable is different between two layers - that contain different versions of the same recipe. - </note> - </glossdef> - </glossentry> - - <glossentry id='var-DEFAULTTUNE'><glossterm>DEFAULTTUNE</glossterm> - <info> - DEFAULTTUNE[doc] = "The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The default CPU and Application Binary Interface (ABI) - tunings (i.e. the "tune") used by the OpenEmbedded build - system. - The <filename>DEFAULTTUNE</filename> helps define - <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. - </para> - - <para> - The default tune is either implicitly or explicitly set - by the machine - (<link linkend='var-MACHINE'><filename>MACHINE</filename></link>). - However, you can override the setting using available tunes - as defined with - <link linkend='var-AVAILTUNES'><filename>AVAILTUNES</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEPENDS'><glossterm>DEPENDS</glossterm> - <info> - DEPENDS[doc] = "Lists a recipe's build-time dependencies (i.e. other recipe files)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists a recipe's build-time dependencies. - These are dependencies on other recipes whose - contents (e.g. headers and shared libraries) are needed - by the recipe at build time. - </para> - - <para> - As an example, consider a recipe <filename>foo</filename> - that contains the following assignment: - <literallayout class='monospaced'> - DEPENDS = "bar" - </literallayout> - 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 - <link linkend='var-STAGING_DIR'><filename>STAGING_DIR*</filename></link> - variables, by the time the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task for <filename>foo</filename> runs. - This mechanism is implemented by having - <filename>do_configure</filename> depend on the - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task of each recipe listed in <filename>DEPENDS</filename>, - through a - <filename>[</filename><ulink url='&YOCTO_DOCS_BB_URL;#variable-flags'><filename>deptask</filename></ulink><filename>]</filename> - declaration in the - <link linkend='ref-classes-base'><filename>base</filename></link> - class. - <note> - It seldom is necessary to reference, for example, - <filename>STAGING_DIR_HOST</filename> explicitly. - The standard classes and build-related variables are - configured to automatically use the appropriate staging - sysroots. - </note> - As another example, <filename>DEPENDS</filename> 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 <filename>codegen</filename> might have - the following: - <literallayout class='monospaced'> - DEPENDS = "codegen-native" - </literallayout> - For more information, see the - <link linkend='ref-classes-native'><filename>native</filename></link> - class and the - <link linkend='var-EXTRANATIVEPATH'><filename>EXTRANATIVEPATH</filename></link> - variable. - <note> - <title>Notes</title> - <itemizedlist> - <listitem><para> - <filename>DEPENDS</filename> is a list of - recipe names. - Or, to be more precise, it is a list of - <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> - names, which usually match recipe names. - Putting a package name such as "foo-dev" in - <filename>DEPENDS</filename> does not make - sense. - Use "foo" instead, as this will put files - from all the packages that make up - <filename>foo</filename>, which includes - those from <filename>foo-dev</filename>, into - the sysroot. - </para></listitem> - <listitem><para> - One recipe having another recipe in - <filename>DEPENDS</filename> does not by itself - add any runtime dependencies between the - packages produced by the two recipes. - However, as explained in the - "<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" - section in the Yocto Project Overview and - Concepts Manual, runtime dependencies will - often be added automatically, meaning - <filename>DEPENDS</filename> alone is - sufficient for most recipes. - </para></listitem> - <listitem><para> - Counterintuitively, - <filename>DEPENDS</filename> is often necessary - even for recipes that install precompiled - components. - For example, if <filename>libfoo</filename> - is a precompiled library that links against - <filename>libbar</filename>, then - linking against <filename>libfoo</filename> - requires both <filename>libfoo</filename> - and <filename>libbar</filename> to be available - in the sysroot. - Without a <filename>DEPENDS</filename> from the - recipe that installs <filename>libfoo</filename> - to the recipe that installs - <filename>libbar</filename>, other recipes might - fail to link against - <filename>libfoo</filename>. - </para></listitem> - </itemizedlist> - </note> - </para> - - <para> - For information on runtime dependencies, see the - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> - variable. - You can also see the - "<ulink url='&YOCTO_DOCS_BB_URL;#tasks'>Tasks</ulink>" and - "<ulink url='&YOCTO_DOCS_BB_URL;#dependencies'>Dependencies</ulink>" - sections in the BitBake User Manual for additional - information on tasks and dependencies. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEPLOY_DIR'><glossterm>DEPLOY_DIR</glossterm> - <info> - DEPLOY_DIR[doc] = "Points to the general area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the general area that the OpenEmbedded build - system uses to place images, packages, SDKs, and other output - files that are ready to be used outside of the build system. - By default, this directory resides within the - <link linkend='build-directory'>Build Directory</link> - as <filename>${TMPDIR}/deploy</filename>. - </para> - - <para> - For more information on the structure of the Build - Directory, see - "<link linkend='structure-build'>The Build Directory - <filename>build/</filename></link>" - section. - For more detail on the contents of the - <filename>deploy</filename> directory, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#images-dev-environment'>Images</ulink>", - "<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>", - and - "<ulink url='&YOCTO_DOCS_OM_URL;#sdk-dev-environment'>Application Development SDK</ulink>" - sections all in the Yocto Project Overview and Concepts - Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEPLOY_DIR_DEB'><glossterm>DEPLOY_DIR_DEB</glossterm> - <info> - DEPLOY_DIR_DEB[doc] = "Points to a Debian-specific area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the area that the OpenEmbedded build system uses - to place Debian packages that are ready to be used outside - of the build system. - This variable applies only when - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - contains "package_deb". - </para> - - <para> - The BitBake configuration file initially defines the - <filename>DEPLOY_DIR_DEB</filename> variable as a - sub-folder of - <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: - <literallayout class='monospaced'> - DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" - </literallayout> - </para> - - <para> - The - <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link> - class uses the - <filename>DEPLOY_DIR_DEB</filename> variable to make sure - the - <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_deb</filename></link> - task writes Debian packages into the appropriate folder. - For more information on how packaging works, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEPLOY_DIR_IMAGE'><glossterm>DEPLOY_DIR_IMAGE</glossterm> - <info> - DEPLOY_DIR_IMAGE[doc] = "Points to the area that the OpenEmbedded build system uses to place images and other associated output files that are ready to be deployed onto the target machine." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the area that the OpenEmbedded build system uses - to place images and other associated output files that are - ready to be deployed onto the target machine. - The directory is machine-specific as it contains the - <filename>${MACHINE}</filename> name. - By default, this directory resides within the - <link linkend='build-directory'>Build Directory</link> - as <filename>${DEPLOY_DIR}/images/${MACHINE}/</filename>. - </para> - - <para> - For more information on the structure of the Build - Directory, see - "<link linkend='structure-build'>The Build Directory - <filename>build/</filename></link>" - section. - For more detail on the contents of the - <filename>deploy</filename> directory, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#images-dev-environment'>Images</ulink>" - and - "<ulink url='&YOCTO_DOCS_OM_URL;#sdk-dev-environment'>Application Development SDK</ulink>" - sections both in the Yocto Project Overview and Concepts - Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEPLOY_DIR_IPK'><glossterm>DEPLOY_DIR_IPK</glossterm> - <info> - DEPLOY_DIR_IPK[doc] = "Points to a IPK-specific area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the area that the OpenEmbedded build system uses - to place IPK packages that are ready to be used outside of - the build system. - This variable applies only when - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - contains "package_ipk". - </para> - - <para> - The BitBake configuration file initially defines this - variable as a sub-folder of - <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: - <literallayout class='monospaced'> - DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk" - </literallayout> - </para> - - <para> - The - <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link> - class uses the - <filename>DEPLOY_DIR_IPK</filename> variable to make sure - the - <link linkend='ref-tasks-package_write_ipk'><filename>do_package_write_ipk</filename></link> - task writes IPK packages into the appropriate folder. - For more information on how packaging works, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEPLOY_DIR_RPM'><glossterm>DEPLOY_DIR_RPM</glossterm> - <info> - DEPLOY_DIR_RPM[doc] = "Points to a RPM-specific area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the area that the OpenEmbedded build system uses - to place RPM packages that are ready to be used outside - of the build system. - This variable applies only when - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - contains "package_rpm". - </para> - - <para> - The BitBake configuration file initially defines this - variable as a sub-folder of - <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: - <literallayout class='monospaced'> - DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm" - </literallayout> - </para> - - <para> - The - <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link> - class uses the - <filename>DEPLOY_DIR_RPM</filename> variable to make sure - the - <link linkend='ref-tasks-package_write_rpm'><filename>do_package_write_rpm</filename></link> - task writes RPM packages into the appropriate folder. - For more information on how packaging works, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEPLOY_DIR_TAR'><glossterm>DEPLOY_DIR_TAR</glossterm> - <info> - DEPLOY_DIR_TAR[doc] = "Points to a tarball area that the OpenEmbedded build system uses to place images, packages, SDKs, and other output files that are ready to be used outside of the build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the area that the OpenEmbedded build system uses - to place tarballs that are ready to be used outside of - the build system. - This variable applies only when - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - contains "package_tar". - </para> - - <para> - The BitBake configuration file initially defines this - variable as a sub-folder of - <link linkend='var-DEPLOY_DIR'><filename>DEPLOY_DIR</filename></link>: - <literallayout class='monospaced'> - DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar" - </literallayout> - </para> - - <para> - The - <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link> - class uses the - <filename>DEPLOY_DIR_TAR</filename> variable to make sure - the - <link linkend='ref-tasks-package_write_tar'><filename>do_package_write_tar</filename></link> - task writes TAR packages into the appropriate folder. - For more information on how packaging works, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment'>Package Feeds</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DEPLOYDIR'><glossterm>DEPLOYDIR</glossterm> - <info> - DEPLOYDIR[doc] = "For recipes that inherit the deploy class, the DEPLOYDIR points to a temporary work area for deployed files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-deploy'><filename>deploy</filename></link> - class, the <filename>DEPLOYDIR</filename> points to a - temporary work area for deployed files that is set in the - <filename>deploy</filename> class as follows: - <literallayout class='monospaced'> - DEPLOYDIR = "${WORKDIR}/deploy-${<link linkend='var-PN'><filename>PN</filename></link>}" - </literallayout> - </para> - - <para> - Recipes inheriting the <filename>deploy</filename> class - should copy files to be deployed into - <filename>DEPLOYDIR</filename>, and the class will take - care of copying them into - <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> - afterwards. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DESCRIPTION'><glossterm>DESCRIPTION</glossterm> - <info> - DESCRIPTION[doc] = "The package description used by package managers. If not set, DESCRIPTION takes the value of the SUMMARY variable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The package description used by package managers. - If not set, <filename>DESCRIPTION</filename> takes - the value of the - <link linkend='var-SUMMARY'><filename>SUMMARY</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISK_SIGNATURE'><glossterm>DISK_SIGNATURE</glossterm> - <info> - DISK_SIGNATURE[doc] = "A 32-bit MBR disk signature used by directdisk images." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A 32-bit MBR disk signature used by - <filename>directdisk</filename> images. - </para> - - <para> - By default, the signature is set to an automatically - generated random value that allows the OpenEmbedded - build system to create a boot loader. - You can override the signature in the image recipe - by setting <filename>DISK_SIGNATURE</filename> to an - 8-digit hex string. - You might want to override - <filename>DISK_SIGNATURE</filename> if you want the disk - signature to remain constant between image builds. - </para> - - <para> - When using Linux 3.8 or later, you can use - <filename>DISK_SIGNATURE</filename> to specify the root - by UUID to allow the kernel to locate the root device - even if the device name changes due to differences in - hardware configuration. - By default, <filename>ROOT_VM</filename> is set - as follows: - <literallayout class='monospaced'> - ROOT_VM ?= "root=/dev/sda2" - </literallayout> - However, you can change this to locate the root device - using the disk signature instead: - <literallayout class='monospaced'> - ROOT_VM = "root=PARTUUID=${DISK_SIGNATURE}-02" - </literallayout> - </para> - - <para> - As previously mentioned, it is possible to set the - <filename>DISK_SIGNATURE</filename> variable in your - <filename>local.conf</filename> file to a fixed - value if you do not want <filename>syslinux.cfg</filename> - changing for each build. - You might find this useful when you want to upgrade the - root filesystem on a device without having to recreate or - modify the master boot record. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm> - <info> - DISTRO[doc] = "The short name of the distribution. If the variable is blank, meta/conf/distro/defaultsetup.conf will be used." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The short name of the distribution. - For information on the long name of the distribution, see - the - <link linkend='var-DISTRO_NAME'><filename>DISTRO_NAME</filename></link> - variable. - </para> - - <para> - The <filename>DISTRO</filename> variable corresponds to a - distribution configuration file whose root name is the - same as the variable's argument and whose filename - extension is <filename>.conf</filename>. - For example, the distribution configuration file for the - Poky distribution is named <filename>poky.conf</filename> - and resides in the - <filename>meta-poky/conf/distro</filename> directory of - the - <link linkend='source-directory'>Source Directory</link>. - </para> - - <para> - Within that <filename>poky.conf</filename> file, the - <filename>DISTRO</filename> variable is set as follows: - <literallayout class='monospaced'> - DISTRO = "poky" - </literallayout> - </para> - - <para> - Distribution configuration files are located in a - <filename>conf/distro</filename> directory within the - <link linkend='metadata'>Metadata</link> - that contains the distribution configuration. - The value for <filename>DISTRO</filename> must not contain - spaces, and is typically all lower-case. - <note> - If the <filename>DISTRO</filename> variable is blank, - a set of default configurations are used, which are - specified within - <filename>meta/conf/distro/defaultsetup.conf</filename> - also in the Source Directory. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_CODENAME'><glossterm>DISTRO_CODENAME</glossterm> - <info> - DISTRO_CODENAME[doc] = "Specifies a codename for the distribution being built." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a codename for the distribution being built. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_EXTRA_RDEPENDS'><glossterm>DISTRO_EXTRA_RDEPENDS</glossterm> - <info> - DISTRO_EXTRA_RDEPENDS[doc] = "Specifies a list of distro-specific packages to add to all images. The variable only applies to the images that include packagegroup-base." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of distro-specific packages to add to all images. - This variable takes affect through - <filename>packagegroup-base</filename> so the - variable only really applies to the more full-featured - images that include <filename>packagegroup-base</filename>. - You can use this variable to keep distro policy out of - generic images. - As with all other distro variables, you set this variable - in the distro <filename>.conf</filename> file. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_EXTRA_RRECOMMENDS'><glossterm>DISTRO_EXTRA_RRECOMMENDS</glossterm> - <info> - DISTRO_EXTRA_RRECOMMENDS[doc] = "Specifies a list of distro-specific packages to add to all images if the packages exist. The list of packages are automatically installed but you can remove them." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of distro-specific packages to add to all images - if the packages exist. - The packages might not exist or be empty (e.g. kernel modules). - The list of packages are automatically installed but you can - remove them. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_FEATURES'><glossterm>DISTRO_FEATURES</glossterm> - <info> - DISTRO_FEATURES[doc] = "The features enabled for the distribution." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The software support you want in your distribution for - various features. - You define your distribution features in the distribution - configuration file. - </para> - - <para> - In most cases, the presence or absence of a feature in - <filename>DISTRO_FEATURES</filename> is translated to the - appropriate option supplied to the configure script - during the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task for recipes that optionally support the feature. - For example, specifying "x11" in - <filename>DISTRO_FEATURES</filename>, causes - every piece of software built for the target that can - optionally support X11 to have its X11 support enabled. - </para> - - <para> - Two more examples are Bluetooth and NFS support. - For a more complete list of features that ships with the - Yocto Project and that you can provide with this variable, - see the - "<link linkend='ref-features-distro'>Distro Features</link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_FEATURES_BACKFILL'><glossterm>DISTRO_FEATURES_BACKFILL</glossterm> - <info> - DISTRO_FEATURES_BACKFILL[doc] = "Features to be added to DISTRO_FEATURES if not also present in DISTRO_FEATURES_BACKFILL_CONSIDERED. This variable is set in the meta/conf/bitbake.conf file and it is not intended to be user-configurable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Features to be added to - <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename> - if not also present in - <filename><link linkend='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'>DISTRO_FEATURES_BACKFILL_CONSIDERED</link></filename>. - </para> - - <para> - This variable is set in the <filename>meta/conf/bitbake.conf</filename> file. - It is not intended to be user-configurable. - It is best to just reference the variable to see which distro features are - being backfilled for all distro configurations. - See the <link linkend='ref-features-backfill'>Feature Backfilling</link> section for - more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_FEATURES_BACKFILL_CONSIDERED'><glossterm>DISTRO_FEATURES_BACKFILL_CONSIDERED</glossterm> - <info> - DISTRO_FEATURES_BACKFILL_CONSIDERED[doc] = "Features from DISTRO_FEATURES_BACKFILL that should not be backfilled (i.e. added to DISTRO_FEATURES) during the build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Features from - <filename><link linkend='var-DISTRO_FEATURES_BACKFILL'>DISTRO_FEATURES_BACKFILL</link></filename> - that should not be backfilled (i.e. added to - <filename><link linkend='var-DISTRO_FEATURES'>DISTRO_FEATURES</link></filename>) - during the build. - See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for - more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_FEATURES_DEFAULT'><glossterm>DISTRO_FEATURES_DEFAULT</glossterm> - <info> - DISTRO_FEATURES_DEFAULT[doc] = "Provides the default list of distro features with the exception of any libc-specific features." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A convenience variable that gives you the default - list of distro features with the exception of any - features specific to the C library - (<filename>libc</filename>). - </para> - - <para> - When creating a custom distribution, you might find it - useful to be able to reuse the default - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - options without the need to write out the full set. - Here is an example that uses - <filename>DISTRO_FEATURES_DEFAULT</filename> from a - custom distro configuration file: - <literallayout class='monospaced'> - DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_FEATURES_FILTER_NATIVE'><glossterm>DISTRO_FEATURES_FILTER_NATIVE</glossterm> - <info> - DISTRO_FEATURES_FILTER_NATIVE[doc] = "Specifies a list of features that if present in the target DISTRO_FEATURES value should be included in DISTRO_FEATURES when building native recipes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of features that if present in - the target - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - value should be included in - <filename>DISTRO_FEATURES</filename> when building native - recipes. - This variable is used in addition to the features - filtered using the - <link linkend='var-DISTRO_FEATURES_NATIVE'><filename>DISTRO_FEATURES_NATIVE</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_FEATURES_FILTER_NATIVESDK'><glossterm>DISTRO_FEATURES_FILTER_NATIVESDK</glossterm> - <info> - DISTRO_FEATURES_FILTER_NATIVESDK[doc] = "Specifies a list of features that if present in the target DISTRO_FEATURES value should be included in DISTRO_FEATURES when building nativesdk recipes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of features that if present in the target - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - value should be included in - <filename>DISTRO_FEATURES</filename> when building - nativesdk recipes. - This variable is used in addition to the features - filtered using the - <link linkend='var-DISTRO_FEATURES_NATIVESDK'><filename>DISTRO_FEATURES_NATIVESDK</filename></link> - variable. - </para> - </glossdef> - </glossentry> - -<!-- - <glossentry id='var-DISTRO_FEATURES_LIBC'><glossterm>DISTRO_FEATURES_LIBC</glossterm> - <info> - DISTRO_FEATURES_LIBC[doc] = "Specifies the list of distro features that are specific to the C library (libc)." - </info> - <glossdef> - <para role="glossdeffirst"> - <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> - A convenience variable that specifies the list of distro - features that are specific to the C library - (<filename>libc</filename>). - Typically, these features are prefixed with "libc-" and - control which features are enabled at during the build - within the C library itself. - </para> - </glossdef> - </glossentry> ---> - - <glossentry id='var-DISTRO_FEATURES_NATIVE'><glossterm>DISTRO_FEATURES_NATIVE</glossterm> - <info> - DISTRO_FEATURES_NATIVE[doc] = "Specifies a list of features that should be included in DISTRO_FEATURES when building native recipes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of features that should be included in - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - when building native recipes. - This variable is used in addition to the features - filtered using the - <link linkend='var-DISTRO_FEATURES_FILTER_NATIVE'><filename>DISTRO_FEATURES_FILTER_NATIVE</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_FEATURES_NATIVESDK'><glossterm>DISTRO_FEATURES_NATIVESDK</glossterm> - <info> - DISTRO_FEATURES_NATIVESDK[doc] = "Specifies a list of features that should be included in DISTRO_FEATURES when building nativesdk recipes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of features that should be included in - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link> - when building nativesdk recipes. - This variable is used in addition to the features - filtered using the - <link linkend='var-DISTRO_FEATURES_FILTER_NATIVESDK'><filename>DISTRO_FEATURES_FILTER_NATIVESDK</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_NAME'><glossterm>DISTRO_NAME</glossterm> - <info> - DISTRO_NAME[doc] = "The long name of the distribution." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The long name of the distribution. - For information on the short name of the distribution, see - the - <link linkend='var-DISTRO'><filename>DISTRO</filename></link> - variable. - </para> - - <para> - The <filename>DISTRO_NAME</filename> variable corresponds - to a distribution configuration file whose root name is the - same as the variable's argument and whose filename - extension is <filename>.conf</filename>. - For example, the distribution configuration file for the - Poky distribution is named <filename>poky.conf</filename> - and resides in the - <filename>meta-poky/conf/distro</filename> directory of - the - <link linkend='source-directory'>Source Directory</link>. - </para> - - <para> - Within that <filename>poky.conf</filename> file, the - <filename>DISTRO_NAME</filename> variable is set as - follows: - <literallayout class='monospaced'> - DISTRO_NAME = "Poky (Yocto Project Reference Distro)" - </literallayout> - </para> - - <para> - Distribution configuration files are located in a - <filename>conf/distro</filename> directory within the - <link linkend='metadata'>Metadata</link> - that contains the distribution configuration. - <note> - If the <filename>DISTRO_NAME</filename> variable is - blank, a set of default configurations are used, which - are specified within - <filename>meta/conf/distro/defaultsetup.conf</filename> - also in the Source Directory. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTRO_VERSION'><glossterm>DISTRO_VERSION</glossterm> - <info> - DISTRO_VERSION[doc] = "The version of the distribution." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The version of the distribution. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DISTROOVERRIDES'><glossterm>DISTROOVERRIDES</glossterm> - <info> - DISTROOVERRIDES[doc] = "A colon-separated list of overrides specific to the current distribution." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A colon-separated list of overrides specific to the - current distribution. - By default, this list includes the value of - <link linkend='var-DISTRO'><filename>DISTRO</filename></link>. - </para> - - <para> - You can extend <filename>DISTROOVERRIDES</filename> - to add extra overrides that should apply to - the distribution. - </para> - - <para> - The underlying mechanism behind - <filename>DISTROOVERRIDES</filename> is simply that it - is included in the default value of - <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> - <info> - DL_DIR[doc] = "The central download directory used by the build process to store downloads. By default, the directory is 'downloads' in the Build Directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The central download directory used by the build process to - store downloads. - By default, <filename>DL_DIR</filename> gets files - suitable for mirroring for everything except Git - repositories. - If you want tarballs of Git repositories, use the - <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> - variable. - </para> - - <para> - You can set this directory by defining the - <filename>DL_DIR</filename> variable in the - <filename>conf/local.conf</filename> file. - This directory is self-maintaining and you should not have - to touch it. - By default, the directory is <filename>downloads</filename> - in the - <link linkend='build-directory'>Build Directory</link>. - <literallayout class='monospaced'> - #DL_DIR ?= "${TOPDIR}/downloads" - </literallayout> - To specify a different download directory, simply remove - the comment from the line and provide your directory. - </para> - - <para> - During a first build, the system downloads many different - source code tarballs from various upstream projects. - Downloading can take a while, particularly if your network - connection is slow. - Tarballs are all stored in the directory defined by - <filename>DL_DIR</filename> and the build system looks there - first to find source tarballs. - <note> - When wiping and rebuilding, you can preserve this - directory to speed up this part of subsequent - builds. - </note> - </para> - - <para> - You can safely share this directory between multiple builds - on the same development machine. - For additional information on how the build process gets - source files when working behind a firewall or proxy server, - see this specific question in the - "<link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>FAQ</link>" - chapter. - You can also refer to the - "<ulink url='&YOCTO_WIKI_URL;/wiki/Working_Behind_a_Network_Proxy'>Working Behind a Network Proxy</ulink>" - Wiki page. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm> - <info> - DOC_COMPRESS[doc] = "When inheriting the compress_doc class, this variable sets the compression policy used when the OpenEmbedded build system compresses man pages and info pages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-compress_doc'><filename>compress_doc</filename></link> - class, this variable sets the compression policy used when - the OpenEmbedded build system compresses man pages and info - pages. - By default, the compression method used is gz (gzip). - Other policies available are xz and bz2. - </para> - - <para> - For information on policies and on how to use this - variable, see the comments in the - <filename>meta/classes/compress_doc.bbclass</filename> file. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-e'><title>E</title> - - <glossentry id='var-EFI_PROVIDER'><glossterm>EFI_PROVIDER</glossterm> - <info> - EFI_PROVIDER[doc] = "When building bootable images (i.e. where hddimg, iso, or wic.vmdk is in IMAGE_FSTYPES), the EFI_PROVIDER variable specifies the EFI bootloader to use." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When building bootable images (i.e. where - <filename>hddimg</filename>, <filename>iso</filename>, - or <filename>wic.vmdk</filename> is in - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>), - the <filename>EFI_PROVIDER</filename> variable specifies - the EFI bootloader to use. - The default is "grub-efi", but "systemd-boot" can be used - instead. - </para> - - <para> - See the - <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link> - and - <link linkend='ref-classes-image-live'><filename>image-live</filename></link> - classes for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ENABLE_BINARY_LOCALE_GENERATION'><glossterm>ENABLE_BINARY_LOCALE_GENERATION</glossterm> - <info> - ENABLE_BINARY_LOCALE_GENERATION[doc] = "Controls which locales for glibc are generated during the build. The variable is useful if the target device has 64Mbytes of RAM or less." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Variable that controls which locales for - <filename>glibc</filename> are generated during the - build (useful if the target device has 64Mbytes - of RAM or less). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ERR_REPORT_DIR'><glossterm>ERR_REPORT_DIR</glossterm> - <info> - ERR_REPORT_DIR[doc] = "When used with the report-error class, specifies the path used for storing the debug files created by the error reporting tool, which allows you to submit build errors you encounter to a central database." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When used with the - <link linkend='ref-classes-report-error'><filename>report-error</filename></link> - class, specifies the path used for storing the debug files - created by the - <ulink url='&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool'>error reporting tool</ulink>, - which allows you to submit build errors you encounter to a - central database. - By default, the value of this variable is - <filename>${</filename><link linkend='var-LOG_DIR'><filename>LOG_DIR</filename></link><filename>}/error-report</filename>. - </para> - - <para> - You can set <filename>ERR_REPORT_DIR</filename> to the path - you want the error reporting tool to store the debug files - as follows in your <filename>local.conf</filename> file: - <literallayout class='monospaced'> - ERR_REPORT_DIR = "<replaceable>path</replaceable>" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ERROR_QA'><glossterm>ERROR_QA</glossterm> - <info> - ERROR_QA[doc] = "Specifies the quality assurance checks whose failures are reported as errors by the OpenEmbedded build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the quality assurance checks whose failures are - reported as errors by the OpenEmbedded build system. - You set this variable in your distribution configuration - file. - For a list of the checks you can control with this variable, - see the - "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXCLUDE_FROM_SHLIBS'><glossterm>EXCLUDE_FROM_SHLIBS</glossterm> - <info> - EXCLUDE_FROM_SHLIBS[doc] = "Causes the OpenEmbedded build system's shared libraries resolver to exclude an entire package when scanning for shared libraries." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Triggers the OpenEmbedded build system's shared libraries - resolver to exclude an entire package when scanning for - shared libraries. - <note> - The shared libraries resolver's functionality results - in part from the internal function - <filename>package_do_shlibs</filename>, which is part of - the - <link linkend='ref-tasks-package'><filename>do_package</filename></link> - task. - You should be aware that the shared libraries resolver - might implicitly define some dependencies between - packages. - </note> - The <filename>EXCLUDE_FROM_SHLIBS</filename> variable is - similar to the - <link linkend='var-PRIVATE_LIBS'><filename>PRIVATE_LIBS</filename></link> - variable, which excludes a package's particular libraries - only and not the whole package. - </para> - - <para> - Use the - <filename>EXCLUDE_FROM_SHLIBS</filename> variable by - setting it to "1" for a particular package: - <literallayout class='monospaced'> - EXCLUDE_FROM_SHLIBS = "1" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm> - <info> - EXCLUDE_FROM_WORLD[doc] = "Directs BitBake to exclude a recipe from world builds (i.e. bitbake world)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Directs BitBake to exclude a recipe from world builds (i.e. - <filename>bitbake world</filename>). - During world builds, BitBake locates, parses and builds all - recipes found in every layer exposed in the - <filename>bblayers.conf</filename> configuration file. - </para> - - <para> - To exclude a recipe from a world build using this variable, - set the variable to "1" in the recipe. - </para> - - <note> - Recipes added to <filename>EXCLUDE_FROM_WORLD</filename> - may still be built during a world build in order to satisfy - dependencies of other recipes. - Adding a recipe to <filename>EXCLUDE_FROM_WORLD</filename> - only ensures that the recipe is not explicitly added - to the list of build targets in a world build. - </note> - </glossdef> - </glossentry> - - <glossentry id='var-EXTENDPE'><glossterm>EXTENDPE</glossterm> - <info> - EXTENDPE[doc] = "Used with file and pathnames to create a prefix for a recipe's version based on the recipe's PE value. If PE is set and greater than zero for a recipe, EXTENDPE becomes that value." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Used with file and pathnames to create a prefix for a recipe's - version based on the recipe's - <link linkend='var-PE'><filename>PE</filename></link> value. - If <filename>PE</filename> is set and greater than zero for a recipe, - <filename>EXTENDPE</filename> becomes that value (e.g if - <filename>PE</filename> is equal to "1" then <filename>EXTENDPE</filename> - becomes "1_"). - If a recipe's <filename>PE</filename> is not set (the default) or is equal to - zero, <filename>EXTENDPE</filename> becomes "".</para> - <para>See the <link linkend='var-STAMP'><filename>STAMP</filename></link> - variable for an example. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTENDPKGV'><glossterm>EXTENDPKGV</glossterm> - <info> - EXTENDPKGV[doc] = "The full package version specification as it appears on the final packages produced by a recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The full package version specification as it appears on the - final packages produced by a recipe. - The variable's value is normally used to fix a runtime - dependency to the exact same version of another package - in the same recipe: - <literallayout class='monospaced'> - RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})" - </literallayout> - </para> - - <para> - The dependency relationships are intended to force the - package manager to upgrade these types of packages in - lock-step. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTERNAL_KERNEL_TOOLS'><glossterm>EXTERNAL_KERNEL_TOOLS</glossterm> - <info> - EXTERNAL_KERNEL_TOOLS[doc] = "Indicates kernel tools are external to the source tree." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When set, the <filename>EXTERNAL_KERNEL_TOOLS</filename> - variable indicates that these tools are not in the - source tree. - </para> - - <para> - When kernel tools are available in the tree, they are - preferred over any externally installed tools. - Setting the <filename>EXTERNAL_KERNEL_TOOLS</filename> - variable tells the OpenEmbedded build system to prefer - the installed external tools. - See the - <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link> - class in <filename>meta/classes</filename> to see how - the variable is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm> - <info> - EXTERNALSRC[doc] = "If externalsrc.bbclass is inherited, this variable points to the source tree, which is outside of the OpenEmbedded build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> - class, this variable points to the source tree, which is - outside of the OpenEmbedded build system. - When set, this variable sets the - <link linkend='var-S'><filename>S</filename></link> - variable, which is what the OpenEmbedded build system uses - to locate unpacked recipe source code. - </para> - - <para> - For more information on - <filename>externalsrc.bbclass</filename>, see the - "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>" - section. - You can also find information on how to use this variable - in the - "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm> - <info> - EXTERNALSRC_BUILD[doc] = "If externalsrc.bbclass is inherited, this variable points to the directory in which the recipe's source code is built, which is outside of the OpenEmbedded build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-externalsrc'><filename>externalsrc</filename></link> - class, this variable points to the directory in which the - recipe's source code is built, which is outside of the - OpenEmbedded build system. - When set, this variable sets the - <link linkend='var-B'><filename>B</filename></link> - variable, which is what the OpenEmbedded build system uses - to locate the Build Directory. - </para> - - <para> - For more information on - <filename>externalsrc.bbclass</filename>, see the - "<link linkend='ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></link>" - section. - You can also find information on how to use this variable - in the - "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRA_AUTORECONF'><glossterm>EXTRA_AUTORECONF</glossterm> - <info> - EXTRA_AUTORECONF[doc] = "Extra options passed to the autoreconf command, which is executed during do_configure." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - For recipes inheriting the - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> - class, you can use <filename>EXTRA_AUTORECONF</filename> to - specify extra options to pass to the - <filename>autoreconf</filename> command that is - executed during the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task. - </para> - - <para> - The default value is "--exclude=autopoint". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRA_IMAGE_FEATURES'><glossterm>EXTRA_IMAGE_FEATURES</glossterm> - <info> - EXTRA_IMAGE_FEATURES[doc] = "The list of additional features to include in an image. Configure this variable in the conf/local.conf file in the Build Directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of additional features to include in an image. - When listing more than one feature, separate them with - a space. - </para> - - <para> - Typically, you configure this variable in your - <filename>local.conf</filename> file, which is found in the - <link linkend='build-directory'>Build Directory</link>. - Although you can use this variable from within a recipe, - best practices dictate that you do not. - <note> - To enable primary features from within the image - recipe, use the - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> - variable. - </note> - </para> - - <para> - Here are some examples of features you can add: - <literallayout class='monospaced'> -"dbg-pkgs" - Adds -dbg packages for all installed packages - including symbol information for debugging and - profiling. - -"debug-tweaks" - Makes an image suitable for debugging. - For example, allows root logins without - passwords and enables post-installation - logging. See the 'allow-empty-password' - and 'post-install-logging' features in - the "<link linkend='ref-features-image'>Image Features</link>" section for - more information. - -"dev-pkgs" - Adds -dev packages for all installed packages. - This is useful if you want to develop against - the libraries in the image. - -"read-only-rootfs" - Creates an image whose root - filesystem is read-only. See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem'>Creating a Read-Only Root Filesystem</ulink>" - section in the Yocto Project - Development 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. - - </literallayout> - </para> - - <para> - For a complete list of image features that ships with the - Yocto Project, see the - "<link linkend="ref-features-image">Image Features</link>" - section. - </para> - - <para> - For an example that shows how to customize your image by - using this variable, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRA_IMAGECMD'><glossterm>EXTRA_IMAGECMD</glossterm> - <info> - EXTRA_IMAGECMD[doc] = "Specifies additional options for the image creation command that has been specified in IMAGE_CMD. When setting this variable, you should use an override for the associated image type." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies additional options for the image - creation command that has been specified in - <link linkend='var-IMAGE_CMD'><filename>IMAGE_CMD</filename></link>. - When setting this variable, use an override for the - associated image type. - Here is an example: - <literallayout class='monospaced'> - EXTRA_IMAGECMD_ext3 ?= "-i 4096" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRA_IMAGEDEPENDS'><glossterm>EXTRA_IMAGEDEPENDS</glossterm> - <info> - EXTRA_IMAGEDEPENDS[doc] = "A list of recipes to build that do not provide packages for installing into the root filesystem. Use this variable to list recipes that are required to build the final image, but not needed in the root filesystem." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of recipes to build that do not provide packages - for installing into the root filesystem. - </para> - - <para> - Sometimes a recipe is required to build the final image but is not - needed in the root filesystem. - You can use the <filename>EXTRA_IMAGEDEPENDS</filename> variable to - list these recipes and thus specify the dependencies. - A typical example is a required bootloader in a machine configuration. - </para> - - <note> - To add packages to the root filesystem, see the various - <filename>*<link linkend='var-RDEPENDS'>RDEPENDS</link></filename> - and <filename>*<link linkend='var-RRECOMMENDS'>RRECOMMENDS</link></filename> - variables. - </note> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRANATIVEPATH'><glossterm>EXTRANATIVEPATH</glossterm> - <info> - EXTRANATIVEPATH[doc] = "A list of subdirectories of ${STAGING_BINDIR_NATIVE} added to the beginning of the environment variable PATH." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of subdirectories of - <filename>${</filename><link linkend='var-STAGING_BINDIR_NATIVE'><filename>STAGING_BINDIR_NATIVE</filename></link><filename>}</filename> - added to the beginning of the environment variable - <filename>PATH</filename>. - As an example, the following prepends - "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" - to <filename>PATH</filename>: - <literallayout class='monospaced'> - EXTRANATIVEPATH = "foo bar" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRA_OECMAKE'><glossterm>EXTRA_OECMAKE</glossterm> - <info> - EXTRA_OECMAKE[doc] = "Additional cmake options." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Additional - <ulink url='https://cmake.org/overview/'>CMake</ulink> - options. - See the - <link linkend='ref-classes-cmake'><filename>cmake</filename></link> - class for additional information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRA_OECONF'><glossterm>EXTRA_OECONF</glossterm> - <info> - EXTRA_OECONF[doc] = "Additional configure script options." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Additional <filename>configure</filename> script options. - See - <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link> - for additional information on passing configure script - options. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRA_OEMAKE'><glossterm>EXTRA_OEMAKE</glossterm> - <info> - EXTRA_OEMAKE[doc] = "Additional GNU make options." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Additional GNU <filename>make</filename> options. - </para> - - <para> - Because the <filename>EXTRA_OEMAKE</filename> defaults to - "", you need to set the variable to specify any required - GNU options. - </para> - - <para> - <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> - and - <link linkend='var-PARALLEL_MAKEINST'><filename>PARALLEL_MAKEINST</filename></link> - also make use of - <filename>EXTRA_OEMAKE</filename> to pass the required - flags. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRA_OESCONS'><glossterm>EXTRA_OESCONS</glossterm> - <info> - EXTRA_OESCONS[doc] = "When a recipe inherits the scons class, this variable specifies additional configuration options you want to pass to the scons command line." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-scons'><filename>scons</filename></link> - class, this variable specifies additional configuration - options you want to pass to the - <filename>scons</filename> command line. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-EXTRA_USERS_PARAMS'><glossterm>EXTRA_USERS_PARAMS</glossterm> - <info> - EXTRA_USERS_PARAMS[doc] = "When a recipe inherits the extrausers class, this variable provides image level user and group operations." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-extrausers'><filename>extrausers</filename></link> - class, this variable provides image level user and group - operations. - This is a more global method of providing user and group - configuration as compared to using the - <link linkend='ref-classes-useradd'><filename>useradd</filename></link> - class, which ties user and group configurations to a - specific recipe. - </para> - - <para> - The set list of commands you can configure using the - <filename>EXTRA_USERS_PARAMS</filename> is shown in the - <filename>extrausers</filename> class. - These commands map to the normal Unix commands of the same - names: - <literallayout class='monospaced'> - # EXTRA_USERS_PARAMS = "\ - # useradd -p '' tester; \ - # groupadd developers; \ - # userdel nobody; \ - # groupdel -g video; \ - # groupmod -g 1020 developers; \ - # usermod -s /bin/sh tester; \ - # " - </literallayout> - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-f'><title>F</title> - - <glossentry id='var-FEATURE_PACKAGES'><glossterm>FEATURE_PACKAGES</glossterm> - <info> - FEATURE_PACKAGES[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES. When setting the value, FEATURE_PACKAGES should have the name of the feature item as an override." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines one or more packages to include in an image when - a specific item is included in - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. - When setting the value, <filename>FEATURE_PACKAGES</filename> - should have the name of the feature item as an override. - Here is an example: - <literallayout class='monospaced'> - FEATURE_PACKAGES_widget = "<replaceable>package1</replaceable> <replaceable>package2</replaceable>" - </literallayout> - </para> - - <para> - In this example, if "widget" were added to - <filename>IMAGE_FEATURES</filename>, <replaceable>package1</replaceable> and - <replaceable>package2</replaceable> would be included in the image. - <note> - Packages installed by features defined through - <filename>FEATURE_PACKAGES</filename> are often package - groups. - While similarly named, you should not confuse the - <filename>FEATURE_PACKAGES</filename> variable with - package groups, which are discussed elsewhere in the - documentation. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FEED_DEPLOYDIR_BASE_URI'><glossterm>FEED_DEPLOYDIR_BASE_URI</glossterm> - <info> - FEED_DEPLOYDIR_BASE_URI[doc] = "Allow to serve ipk deploy directory as an ad hoc feed (bogofeed). Set to base URL of the directory as exported by HTTP. Set of ad hoc feed configs will be generated in the image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the base URL of the server and location within - the document-root that provides the metadata and - packages required by OPKG to support runtime package - management of IPK packages. - You set this variable in your - <filename>local.conf</filename> file. - </para> - - <para> - Consider the following example: - <literallayout class='monospaced'> - FEED_DEPLOYDIR_BASE_URI = "http://192.168.7.1/BOARD-dir" - </literallayout> - This example assumes you are serving your packages over - HTTP and your databases are located in a directory - named <filename>BOARD-dir</filename>, which is underneath - your HTTP server's document-root. - In this case, the OpenEmbedded build system generates a set - of configuration files for you in your target that work - with the feed. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FILES'><glossterm>FILES</glossterm> - <info> - FILES[doc] = "The list of directories or files that are placed in a package." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The list of files and directories that are placed in a - package. - The - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> - variable lists the packages generated by a recipe. - </para> - - <para> - To use the <filename>FILES</filename> variable, provide a - package name override that identifies the resulting package. - Then, provide a space-separated list of files or paths - that identify the files you want included as part of the - resulting package. - Here is an example: - <literallayout class='monospaced'> - FILES_${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile" - </literallayout> - <note><title>Notes</title> - <itemizedlist> - <listitem><para> - When specifying files or paths, you can pattern - match using Python's - <ulink url='https://docs.python.org/2/library/glob.html'><filename>glob</filename></ulink> - syntax. - For details on the syntax, see the - documentation by following the previous link. - </para></listitem> - <listitem><para> - When specifying paths as part of the - <filename>FILES</filename> variable, it is - good practice to use appropriate path - variables. - For example, use <filename>${sysconfdir}</filename> - rather than <filename>/etc</filename>, or - <filename>${bindir}</filename> rather than - <filename>/usr/bin</filename>. - You can find a list of these variables at the - top of the - <filename>meta/conf/bitbake.conf</filename> - file in the - <link linkend='source-directory'>Source Directory</link>. - You will also find the default values of the - various <filename>FILES_*</filename> variables - in this file. - </para></listitem> - </itemizedlist> - </note> - </para> - - <para> - If some of the files you provide with the - <filename>FILES</filename> variable are editable and you - know they should not be overwritten during the package - update process by the Package Management System (PMS), you - can identify these files so that the PMS will not - overwrite them. - See the - <link linkend='var-CONFFILES'><filename>CONFFILES</filename></link> - variable for information on how to identify these files to - the PMS. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FILES_SOLIBSDEV'><glossterm>FILES_SOLIBSDEV</glossterm> - <info> - FILES_SOLIBSDEV[doc] = "Defines the full path name of the development symbolic link (symlink) for shared libraries on the target platform." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the file specification to match - <link linkend='var-SOLIBSDEV'><filename>SOLIBSDEV</filename></link>. - In other words, <filename>FILES_SOLIBSDEV</filename> - defines the full path name of the development symbolic link - (symlink) for shared libraries on the target platform. - </para> - - <para> - The following statement from the - <filename>bitbake.conf</filename> shows how it is set: - <literallayout class='monospaced'> - FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FILESEXTRAPATHS'><glossterm>FILESEXTRAPATHS</glossterm> - <info> - FILESEXTRAPATHS[doc] = "Extends the search path the OpenEmbedded build system uses when looking for files and patches as it processes recipes and append files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Extends the search path the OpenEmbedded build system uses - when looking for files and patches as it processes recipes - and append files. - The default directories BitBake uses when it processes - recipes are initially defined by the - <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> - variable. - You can extend <filename>FILESPATH</filename> variable - by using <filename>FILESEXTRAPATHS</filename>. - </para> - - <para> - Best practices dictate that you accomplish this by using - <filename>FILESEXTRAPATHS</filename> from within a - <filename>.bbappend</filename> file and that you prepend - paths as follows: - <literallayout class='monospaced'> - FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" - </literallayout> - In the above example, the build system first looks for files - in a directory that has the same name as the corresponding - append file. - <note> - <para>When extending - <filename>FILESEXTRAPATHS</filename>, - be sure to use the immediate expansion - (<filename>:=</filename>) operator. - Immediate expansion makes sure that BitBake evaluates - <link linkend='var-THISDIR'><filename>THISDIR</filename></link> - at the time the directive is encountered rather than at - some later time when expansion might result in a - directory that does not contain the files you need. - </para> - - <para>Also, include the trailing separating colon - character if you are prepending. - The trailing colon character is necessary because you - are directing BitBake to extend the path by prepending - directories to the search path.</para> - </note> - Here is another common use: - <literallayout class='monospaced'> - FILESEXTRAPATHS_prepend := "${THISDIR}/files:" - </literallayout> - In this example, the build system extends the - <filename>FILESPATH</filename> variable to include a - directory named <filename>files</filename> that is in the - same directory as the corresponding append file. - </para> - - <para> - This next example specifically adds three paths: - <literallayout class='monospaced'> - FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" - </literallayout> - </para> - - <para> - A final example shows how you can extend the search path - and include a - <link linkend='var-MACHINE'><filename>MACHINE</filename></link>-specific - override, which is useful in a BSP layer: - <literallayout class='monospaced'> - FILESEXTRAPATHS_prepend_intel-x86-common := "${THISDIR}/${PN}:" - </literallayout> - The previous statement appears in the - <filename>linux-yocto-dev.bbappend</filename> file, which - is found in the Yocto Project - <ulink url='&YOCTO_DOCS_OM_URL;#source-repositories'>Source Repositories</ulink> - in - <filename>meta-intel/common/recipes-kernel/linux</filename>. - Here, the machine override is a special - <link linkend='var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></link> - definition for multiple <filename>meta-intel</filename> - machines. - <note> - For a layer that supports a single BSP, the override - could just be the value of <filename>MACHINE</filename>. - </note> - </para> - - <para> - By prepending paths in <filename>.bbappend</filename> - files, you allow multiple append files that reside in - different layers but are used for the same recipe to - correctly extend the path. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FILESOVERRIDES'><glossterm>FILESOVERRIDES</glossterm> - <info> - FILESOVERRIDES[doc] = "A subset of OVERRIDES used by the OpenEmbedded build system for creating FILESPATH." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A subset of <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> - used by the OpenEmbedded build system for creating - <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>. - The <filename>FILESOVERRIDES</filename> variable uses - overrides to automatically extend the - <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> - variable. - For an example of how that works, see the - <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> - variable description. - Additionally, you find more information on how overrides - are handled in the - "<ulink url='&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides'>Conditional Syntax (Overrides)</ulink>" - section of the BitBake User Manual. - </para> - - <para> - By default, the <filename>FILESOVERRIDES</filename> - variable is defined as: - <literallayout class='monospaced'> - FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}" - </literallayout> - - <note> - Do not hand-edit the <filename>FILESOVERRIDES</filename> - variable. - The values match up with expected overrides and are - used in an expected manner by the build system. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm> - <info> - FILESPATH[doc] = "The default set of directories the OpenEmbedded build system uses when searching for patches and files. It is defined in the base.bbclass class found in meta/classes in the Source Directory. Do not hand-edit the FILESPATH variable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The default set of directories the OpenEmbedded build - system uses when searching for patches and files. - </para> - - <para> - During the build process, BitBake searches each directory - in <filename>FILESPATH</filename> in the specified order - when looking for files and patches specified by each - <filename>file://</filename> URI in a recipe's - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link> - statements. - </para> - - <para> - The default value for the <filename>FILESPATH</filename> - variable is defined in the <filename>base.bbclass</filename> - class found in <filename>meta/classes</filename> in the - <link linkend='source-directory'>Source Directory</link>: - <literallayout class='monospaced'> - FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ - "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" - </literallayout> - The <filename>FILESPATH</filename> variable is automatically - extended using the overrides from the - <link linkend='var-FILESOVERRIDES'><filename>FILESOVERRIDES</filename></link> - variable. - <note><title>Notes</title> - <itemizedlist> - <listitem><para> - Do not hand-edit the - <filename>FILESPATH</filename> variable. - If you want the build system to look in - directories other than the defaults, extend the - <filename>FILESPATH</filename> variable by - using the - <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> - variable. - </para></listitem> - <listitem><para> - Be aware that the default - <filename>FILESPATH</filename> directories do - not map to directories in custom layers - where append files - (<filename>.bbappend</filename>) are used. - If you want the build system to find patches - or files that reside with your append files, - you need to extend the - <filename>FILESPATH</filename> variable by - using the <filename>FILESEXTRAPATHS</filename> - variable. - </para></listitem> - </itemizedlist> - </note> - </para> - - <para> - 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: - <literallayout class='monospaced'> - files/defconfig - files/MACHINEA/defconfig - files/MACHINEB/defconfig - </literallayout> - Also in the example, the <filename>SRC_URI</filename> - statement contains "file://defconfig". - Given this scenario, you can set - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - to "MACHINEA" and cause the build system to use files - from <filename>files/MACHINEA</filename>. - Set <filename>MACHINE</filename> to "MACHINEB" and the - build system uses files from - <filename>files/MACHINEB</filename>. - Finally, for any machine other than "MACHINEA" and - "MACHINEB", the build system uses files from - <filename>files/defconfig</filename>. - </para> - - <para> - You can find out more about the patching process in the - "<ulink url='&YOCTO_DOCS_OM_URL;#patching-dev-environment'>Patching</ulink>" - section in the Yocto Project Overview and Concepts Manual - and the - "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-patching-code'>Patching Code</ulink>" - section in the Yocto Project Development Tasks Manual. - See the - <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> - task as well. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FILESYSTEM_PERMS_TABLES'><glossterm>FILESYSTEM_PERMS_TABLES</glossterm> - <info> - FILESYSTEM_PERMS_TABLES[doc] = "Allows you to define your own file permissions settings table as part of your configuration for the packaging process." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Allows you to define your own file permissions settings table as part of - your configuration for the packaging process. - For example, suppose you need a consistent set of custom permissions for - a set of groups and users across an entire work project. - It is best to do this in the packages themselves but this is not always - possible. - </para> - - <para> - By default, the OpenEmbedded build system uses the <filename>fs-perms.txt</filename>, which - is located in the <filename>meta/files</filename> folder in the - <link linkend='source-directory'>Source Directory</link>. - If you create your own file permissions setting table, you should place it in your - layer or the distro's layer. - </para> - - <para> - You define the <filename>FILESYSTEM_PERMS_TABLES</filename> variable in the - <filename>conf/local.conf</filename> file, which is found in the - <link linkend='build-directory'>Build Directory</link>, to - point to your custom <filename>fs-perms.txt</filename>. - You can specify more than a single file permissions setting table. - The paths you specify to these files must be defined within the - <link linkend='var-BBPATH'><filename>BBPATH</filename></link> variable. - </para> - - <para> - For guidance on how to create your own file permissions settings table file, - examine the existing <filename>fs-perms.txt</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FONT_EXTRA_RDEPENDS'><glossterm>FONT_EXTRA_RDEPENDS</glossterm> - <info> - FONT_EXTRA_RDEPENDS[doc] = "When a recipe inherits the fontcache class, this variable specifies runtime dependencies for font packages. This variable defaults to 'fontconfig-utils'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link> - class, this variable specifies the runtime dependencies - for font packages. - By default, the <filename>FONT_EXTRA_RDEPENDS</filename> - is set to "fontconfig-utils". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FONT_PACKAGES'><glossterm>FONT_PACKAGES</glossterm> - <info> - FONT_PACKAGES[doc] = "When a recipe inherits the fontcache class, this variable identifies packages containing font files that need to be cached by Fontconfig." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-fontcache'><filename>fontcache</filename></link> - class, this variable identifies packages containing font - files that need to be cached by Fontconfig. - By default, the <filename>fontcache</filename> class assumes - that fonts are in the recipe's main package - (i.e. <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>). - Use this variable if fonts you need are in a package - other than that main package. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FORCE_RO_REMOVE'><glossterm>FORCE_RO_REMOVE</glossterm> - <info> - FORCE_RO_REMOVE[doc] = "Forces the removal of the packages listed in ROOTFS_RO_UNNEEDED during the generation of the root filesystem." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Forces the removal of the packages listed in - <filename>ROOTFS_RO_UNNEEDED</filename> during the - generation of the root filesystem. - </para> - - <para> - Set the variable to "1" to force the removal of these - packages. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-FULL_OPTIMIZATION'><glossterm>FULL_OPTIMIZATION</glossterm> - <info> - FULL_OPTIMIZATION[doc]= "The options to pass in TARGET_CFLAGS and CFLAGS when compiling an optimized system. This variable defaults to '-fexpensive-optimizations -fomit-frame-pointer -frename-registers -O2'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The options to pass in - <filename><link linkend='var-TARGET_CFLAGS'>TARGET_CFLAGS</link></filename> - and <filename><link linkend='var-CFLAGS'>CFLAGS</link></filename> - when compiling an optimized system. - This variable defaults to - "-O2 -pipe ${DEBUG_FLAGS}". - </para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id='var-glossary-g'><title>G</title> - - <glossentry id='var-GCCPIE'><glossterm>GCCPIE</glossterm> - <info> - GCCPIE[doc] = "Enables Position Independent Executables (PIE) within the GNU C Compiler (GCC)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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. - </para> - - <para> - By default the <filename>security_flags.inc</filename> - file enables PIE by setting the variable as follows: - <literallayout class='monospaced'> - GCCPIE ?= "--enable-default-pie" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GCCVERSION'><glossterm>GCCVERSION</glossterm> - <info> - GCCVERSION[doc] = "Specifies the default version of the GNU C Compiler (GCC) to use." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the default version of the GNU C Compiler (GCC) - used for compilation. - By default, <filename>GCCVERSION</filename> is set to - "8.x" in the - <filename>meta/conf/distro/include/tcmode-default.inc</filename> - include file: - <literallayout class='monospaced'> - GCCVERSION ?= "8.%" - </literallayout> - You can override this value by setting it in a configuration - file such as the <filename>local.conf</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GDB'><glossterm>GDB</glossterm> - <info> - GDB[doc] = "The minimal command and arguments to run the GNU Debugger." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments to run the GNU Debugger. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GITDIR'><glossterm>GITDIR</glossterm> - <info> - GITDIR[doc] = "The directory where Git clones will be stored." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The directory in which a local copy of a Git repository - is stored when it is cloned. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GLIBC_GENERATE_LOCALES'><glossterm>GLIBC_GENERATE_LOCALES</glossterm> - <info> - GLIBC_GENERATE_LOCALES[doc]= "Specifies the list of GLIBC locales to generate should you not wish to generate all LIBC locals, which can be time consuming." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the list of GLIBC locales to generate should you - not wish to generate all LIBC locals, which can be time - consuming. - <note> - If you specifically remove the locale - <filename>en_US.UTF-8</filename>, you must set - <link linkend='var-IMAGE_LINGUAS'><filename>IMAGE_LINGUAS</filename></link> - appropriately. - </note> - </para> - - <para> - You can set <filename>GLIBC_GENERATE_LOCALES</filename> - in your <filename>local.conf</filename> file. - By default, all locales are generated. - <literallayout class='monospaced'> - GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GROUPADD_PARAM'><glossterm>GROUPADD_PARAM</glossterm> - <info> - GROUPADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the groupadd command if you wish to add a group to the system when the package is installed." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-useradd'><filename>useradd</filename></link> - class, this variable - specifies for a package what parameters should be passed - to the <filename>groupadd</filename> command - if you wish to add a group to the system when the package - is installed. - </para> - - <para> - Here is an example from the <filename>dbus</filename> - recipe: - <literallayout class='monospaced'> - GROUPADD_PARAM_${PN} = "-r netdev" - </literallayout> - For information on the standard Linux shell command - <filename>groupadd</filename>, see - <ulink url='http://linux.die.net/man/8/groupadd'></ulink>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GROUPMEMS_PARAM'><glossterm>GROUPMEMS_PARAM</glossterm> - <info> - GROUPMEMS_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should be passed to the groupmems command if you wish to modify the members of a group when the package is installed." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-useradd'><filename>useradd</filename></link> - class, this variable - specifies for a package what parameters should be passed - to the <filename>groupmems</filename> command - if you wish to modify the members of a group when the - package is installed. - </para> - - <para> - For information on the standard Linux shell command - <filename>groupmems</filename>, see - <ulink url='http://linux.die.net/man/8/groupmems'></ulink>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GRUB_GFXSERIAL'><glossterm>GRUB_GFXSERIAL</glossterm> - <info> - GRUB_GFXSERIAL[doc] = "Configures the GNU GRand Unified Bootloader (GRUB) to have graphics and serial in the boot menu." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Configures the GNU GRand Unified Bootloader (GRUB) to have - graphics and serial in the boot menu. - Set this variable to "1" in your - <filename>local.conf</filename> or distribution - configuration file to enable graphics and serial - in the menu. - </para> - - <para> - See the - <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> - class for more information on how this variable is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GRUB_OPTS'><glossterm>GRUB_OPTS</glossterm> - <info> - GRUB_OPTS[doc] = "Additional options to add to the GNU GRand Unified Bootloader (GRUB) configuration." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Additional options to add to the GNU GRand Unified - Bootloader (GRUB) configuration. - Use a semi-colon character (<filename>;</filename>) to - separate multiple options. - </para> - - <para> - The <filename>GRUB_OPTS</filename> variable is optional. - See the - <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> - class for more information on how this variable is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GRUB_TIMEOUT'><glossterm>GRUB_TIMEOUT</glossterm> - <info> - GRUB_TIMEOUT[doc] = "Specifies the timeout before executing the default LABEL in the GNU GRand Unified Bootloader (GRUB)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the timeout before executing the default - <filename>LABEL</filename> in the GNU GRand Unified - Bootloader (GRUB). - </para> - - <para> - The <filename>GRUB_TIMEOUT</filename> variable is optional. - See the - <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> - class for more information on how this variable is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-GTKIMMODULES_PACKAGES'><glossterm>GTKIMMODULES_PACKAGES</glossterm> - <info> - GTKIMMODULES_PACKAGES[doc] = "For recipes that inherit the gtk-immodules-cache class, this variable specifies the packages that contain the GTK+ input method modules being installed when the modules are in packages other than the main package." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-gtk-immodules-cache'><filename>gtk-immodules-cache</filename></link> - class, this variable specifies the packages that contain the - GTK+ input method modules being installed when the modules - are in packages other than the main package. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-h'><title>H</title> - - <glossentry id='var-HOMEPAGE'><glossterm>HOMEPAGE</glossterm> - <info> - HOMEPAGE[doc] = "Website where more information about the software the recipe is building can be found." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Website where more information about the software the recipe is building - can be found. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-HOST_ARCH'><glossterm>HOST_ARCH</glossterm> - <info> - HOST_ARCH[doc] = "The name of the target architecture. Normally same as the TARGET_ARCH." - - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The name of the target architecture, which is normally - the same as - <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>. - The OpenEmbedded build system supports many - architectures. - Here is an example list of architectures supported. - This list is by no means complete as the architecture - is configurable: - <literallayout class='monospaced'> - arm - i586 - x86_64 - powerpc - powerpc64 - mips - mipsel - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-HOST_CC_ARCH'><glossterm>HOST_CC_ARCH</glossterm> - <info> - HOST_CC_ARCH[doc] = "The name of the host architecture. Normally same as the TARGET_CC_ARCH." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies architecture-specific compiler flags that are - passed to the C compiler. - </para> - - <para> - Default initialization for <filename>HOST_CC_ARCH</filename> - varies depending on what is being built: - <itemizedlist> - <listitem><para> - <link linkend='var-TARGET_CC_ARCH'><filename>TARGET_CC_ARCH</filename></link> - when building for the target - </para></listitem> - <listitem><para> - <filename>BUILD_CC_ARCH</filename> - when building for the build host (i.e. - <filename>-native</filename>) - </para></listitem> - <listitem><para> - <filename>BUILDSDK_CC_ARCH</filename> - when building for an SDK (i.e. - <filename>nativesdk-</filename>) - </para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-HOST_OS'><glossterm>HOST_OS</glossterm> - <info> - HOST_OS[doc] = "The name of the target operating system. Normally the same as the TARGET_OS." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the name of the target operating system, which - is normally the same as the - <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link>. - The variable can be set to "linux" for <filename>glibc</filename>-based systems and - to "linux-musl" for <filename>musl</filename>. - For ARM/EABI targets, there are also "linux-gnueabi" and - "linux-musleabi" values possible. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-HOST_PREFIX'><glossterm>HOST_PREFIX</glossterm> - <info> - HOST_PREFIX[doc] = "The prefix for the cross compile toolchain. Normally same as the TARGET_PREFIX." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the prefix for the cross-compile toolchain. - <filename>HOST_PREFIX</filename> is normally the same as - <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-HOST_SYS'><glossterm>HOST_SYS</glossterm> - <info> - HOST_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the build is occurring in the context of the current recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the system, including the architecture and the - operating system, for which the build is occurring - in the context of the current recipe. - </para> - - <para> - The OpenEmbedded build system automatically sets this - variable based on - <link linkend='var-HOST_ARCH'><filename>HOST_ARCH</filename></link>, - <link linkend='var-HOST_VENDOR'><filename>HOST_VENDOR</filename></link>, - and - <link linkend='var-HOST_OS'><filename>HOST_OS</filename></link> - variables. - <note> - You do not need to set the variable yourself. - </note> - </para> - - <para> - Consider these two examples: - <itemizedlist> - <listitem><para>Given a native recipe on a 32-bit - x86 machine running Linux, the value is - "i686-linux". - </para></listitem> - <listitem><para>Given a recipe being built for a - little-endian MIPS target running Linux, - the value might be "mipsel-linux". - </para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-HOSTTOOLS'><glossterm>HOSTTOOLS</glossterm> - <info> - HOSTTOOLS[doc] = "A space-separated list (filter) of tools on the build host that should be allowed to be called from within build tasks." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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 - <filename>HOSTTOOLS</filename> is not found on the - build host, the OpenEmbedded build system produces - an error and the build is not started. - </para> - - <para> - For additional information, see - <link linkend='var-HOSTTOOLS_NONFATAL'><filename>HOSTTOOLS_NONFATAL</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-HOSTTOOLS_NONFATAL'><glossterm>HOSTTOOLS_NONFATAL</glossterm> - <info> - HOSTTOOLS_NONFATAL[doc] = "A space-separated list (filter) of tools on the build host that should be allowed to be called from within build tasks." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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 - <link linkend='var-HOSTTOOLS'><filename>HOSTTOOLS</filename></link>, - the OpenEmbedded build system does not produce an error - if a tool specified in the value of - <filename>HOSTTOOLS_NONFATAL</filename> is not found on the - build host. - Thus, you can use <filename>HOSTTOOLS_NONFATAL</filename> - to filter optional host tools. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-HOST_VENDOR'><glossterm>HOST_VENDOR</glossterm> - <info> - HOST_VENDOR[doc] = "The name of the vendor. Normally same as the TARGET_VENDOR." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the name of the vendor. - <filename>HOST_VENDOR</filename> is normally the same as - <link linkend='var-TARGET_VENDOR'><filename>TARGET_VENDOR</filename></link>. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-i'><title>I</title> - - <glossentry id='var-ICECC_DISABLED'><glossterm>ICECC_DISABLED</glossterm> - <info> - ICECC_DISABLED[doc] = "Disables or enables the icecc (Icecream) function." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Disables or enables the <filename>icecc</filename> - (Icecream) function. - For more information on this function and best practices - for using this variable, see the - "<link linkend='ref-classes-icecc'><filename>icecc.bbclass</filename></link>" - section. - </para> - - <para> - Setting this variable to "1" in your - <filename>local.conf</filename> disables the function: - <literallayout class='monospaced'> - ICECC_DISABLED ??= "1" - </literallayout> - To enable the function, set the variable as follows: - <literallayout class='monospaced'> - ICECC_DISABLED = "" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ICECC_ENV_EXEC'><glossterm>ICECC_ENV_EXEC</glossterm> - <info> - ICECC_ENV_EXEC[doc] = "Points to the icecc-create-env script that you provide." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the <filename>icecc-create-env</filename> script - that you provide. - This variable is used by the - <link linkend='ref-classes-icecc'><filename>icecc</filename></link> - class. - You set this variable in your - <filename>local.conf</filename> file. - </para> - - <para> - If you do not point to a script that you provide, the - OpenEmbedded build system uses the default script provided - by the <filename>icecc-create-env.bb</filename> recipe, - which is a modified version and not the one that comes with - <filename>icecc</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ICECC_PARALLEL_MAKE'><glossterm>ICECC_PARALLEL_MAKE</glossterm> - <info> - ICECC_PARALLEL_MAKE[doc] = "Extra options passed to the make command during the do_compile task that specify parallel compilation." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Extra options passed to the <filename>make</filename> - command during the - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - task that specify parallel compilation. - This variable usually takes the form of - "-j <replaceable>x</replaceable>", where - <replaceable>x</replaceable> represents the maximum - number of parallel threads <filename>make</filename> can - run. - <note> - The options passed affect builds on all enabled - machines on the network, which are machines running the - <filename>iceccd</filename> daemon. - </note> - </para> - - <para> - If your enabled machines support multiple cores, - coming up with the maximum number of parallel threads - that gives you the best performance could take some - experimentation since machine speed, network lag, - available memory, and existing machine loads can all - affect build time. - Consequently, unlike the - <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> - variable, there is no rule-of-thumb for setting - <filename>ICECC_PARALLEL_MAKE</filename> to achieve - optimal performance. - </para> - - <para> - If you do not set <filename>ICECC_PARALLEL_MAKE</filename>, - the build system does not use it (i.e. the system does - not detect and assign the number of cores as is done with - <filename>PARALLEL_MAKE</filename>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ICECC_PATH'><glossterm>ICECC_PATH</glossterm> - <info> - ICECC_PATH[doc] = "The location of the icecc binary." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The location of the <filename>icecc</filename> binary. - You can set this variable in your - <filename>local.conf</filename> file. - If your <filename>local.conf</filename> file does not define - this variable, the - <link linkend='ref-classes-icecc'><filename>icecc</filename></link> - class attempts to define it by locating - <filename>icecc</filename> using <filename>which</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ICECC_USER_CLASS_BL'><glossterm>ICECC_USER_CLASS_BL</glossterm> - <info> - ICECC_USER_CLASS_BL[doc] = "Identifies user classes that you do not want the Icecream distributed compile support to consider." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Identifies user classes that you do not want the - Icecream distributed compile support to consider. - This variable is used by the - <link linkend='ref-classes-icecc'><filename>icecc</filename></link> - class. - You set this variable in your - <filename>local.conf</filename> file. - </para> - - <para> - When you list classes using this variable, you are - "blacklisting" them from distributed compilation across - remote hosts. - Any classes you list will be distributed and compiled - locally. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ICECC_USER_PACKAGE_BL'><glossterm>ICECC_USER_PACKAGE_BL</glossterm> - <info> - ICECC_USER_PACKAGE_BL[doc] = "Identifies user recipes that you do not want the Icecream distributed compile support to consider." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Identifies user recipes that you do not want the - Icecream distributed compile support to consider. - This variable is used by the - <link linkend='ref-classes-icecc'><filename>icecc</filename></link> - class. - You set this variable in your - <filename>local.conf</filename> file. - </para> - - <para> - When you list packages using this variable, you are - "blacklisting" them from distributed compilation across - remote hosts. - Any packages you list will be distributed and compiled - locally. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ICECC_USER_PACKAGE_WL'><glossterm>ICECC_USER_PACKAGE_WL</glossterm> - <info> - ICECC_USER_PACKAGE_WL[doc] = "Identifies user recipes that use an empty PARALLEL_MAKE variable that you want to force remote distributed compilation on using the Icecream distributed compile support." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Identifies user recipes that use an empty - <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link> - variable that you want to force remote distributed - compilation on using the Icecream distributed compile - support. - This variable is used by the - <link linkend='ref-classes-icecc'><filename>icecc</filename></link> - class. - You set this variable in your - <filename>local.conf</filename> file. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_BASENAME'><glossterm>IMAGE_BASENAME</glossterm> - <info> - IMAGE_BASENAME[doc] = "The base name of image output files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The base name of image output files. - This variable defaults to the recipe name - (<filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_BOOT_FILES'><glossterm>IMAGE_BOOT_FILES</glossterm> - <info> - IMAGE_BOOT_FILES[doc] = "A space-separated list of files from ${DEPLOY_DIR_IMAGE} to place in boot partition." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A space-separated list of files installed into the - boot partition when preparing an image using the Wic tool - with the <filename>bootimg-partition</filename> source - plugin. - By default, the files are installed under the same name as - the source files. - To change the installed name, separate it from the - original name with a semi-colon (;). - Source files need to be located in - <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link>. - Here are two examples: - - <literallayout class="monospaced"> - IMAGE_BOOT_FILES = "u-boot.img uImage;kernel" - IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}" - </literallayout> - </para> - - <para> - Alternatively, source files can be picked up using - a glob pattern. - In this case, the destination file 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: - <literallayout class="monospaced"> - IMAGE_BOOT_FILES = "bcm2835-bootfiles/*" - IMAGE_BOOT_FILES = "bcm2835-bootfiles/*;boot/" - </literallayout> - The first example installs all files from - <filename>${DEPLOY_DIR_IMAGE}/bcm2835-bootfiles</filename> - into the root of the target partition. - The second example installs the same files into a - <filename>boot</filename> directory within the - target partition. - </para> - - <para> - You can find information on how to use the Wic tool in the - "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-partitioned-images-using-wic'>Creating Partitioned Images Using Wic</ulink>" - section of the Yocto Project Development Tasks Manual. - Reference material for Wic is located in the - "<ulink url='&YOCTO_DOCS_REF_URL;#ref-kickstart'>OpenEmbedded Kickstart (.wks) Reference</ulink>" - chapter. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_CLASSES'><glossterm>IMAGE_CLASSES</glossterm> - <info> - IMAGE_CLASSES[doc] = "A list of classes that all images should inherit." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of classes that all images should inherit. - You typically use this variable to specify the list of - classes that register the different types of images - the OpenEmbedded build system creates. - </para> - - <para> - The default value for <filename>IMAGE_CLASSES</filename> is - <filename>image_types</filename>. - You can set this variable in your - <filename>local.conf</filename> or in a distribution - configuration file. - </para> - - <para> - For more information, see - <filename>meta/classes/image_types.bbclass</filename> in the - <link linkend='source-directory'>Source Directory</link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_CMD'><glossterm>IMAGE_CMD</glossterm> - <info> - IMAGE_CMD[doc] = "Specifies the command to create the image file for a specific image type, which corresponds to the value set set in IMAGE_FSTYPES, (e.g. ext3, btrfs, and so forth)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the command to create the image file for a - specific image type, which corresponds to the value set - set in - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>, - (e.g. <filename>ext3</filename>, - <filename>btrfs</filename>, and so forth). - When setting this variable, you should use - an override for the associated type. - Here is an example: - <literallayout class='monospaced'> - IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \ - --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \ - ${EXTRA_IMAGECMD}" - </literallayout> - </para> - - <para> - You typically do not need to set this variable unless - you are adding support for a new image type. - For more examples on how to set this variable, see the - <link linkend='ref-classes-image_types'><filename>image_types</filename></link> - class file, which is - <filename>meta/classes/image_types.bbclass</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_DEVICE_TABLES'><glossterm>IMAGE_DEVICE_TABLES</glossterm> - <info> - IMAGE_DEVICE_TABLES[doc] = "Specifies one or more files that contain custom device tables that are passed to the makedevs command as part of creating an image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies one or more files that contain custom device - tables that are passed to the - <filename>makedevs</filename> command as part of creating - an image. - These files list basic device nodes that should be - created under <filename>/dev</filename> within the image. - If <filename>IMAGE_DEVICE_TABLES</filename> is not set, - <filename>files/device_table-minimal.txt</filename> is - used, which is located by - <link linkend='var-BBPATH'><filename>BBPATH</filename></link>. - For details on how you should write device table files, - see <filename>meta/files/device_table-minimal.txt</filename> - as an example. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_FEATURES'><glossterm>IMAGE_FEATURES</glossterm> - <info> - IMAGE_FEATURES[doc] = "The primary list of features to include in an image. Configure this variable in an image recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The primary list of features to include in an image. - Typically, you configure this variable in an image recipe. - Although you can use this variable from your - <filename>local.conf</filename> file, which is found in the - <link linkend='build-directory'>Build Directory</link>, - best practices dictate that you do not. - <note> - To enable extra features from outside the image recipe, - use the - <filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES</link></filename> variable. - </note> - </para> - - <para> - For a list of image features that ships with the Yocto - Project, see the - "<link linkend="ref-features-image">Image Features</link>" - section. - </para> - - <para> - For an example that shows how to customize your image by - using this variable, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-imagefeatures'>Customizing Images Using Custom <filename>IMAGE_FEATURES</filename> and <filename>EXTRA_IMAGE_FEATURES</filename></ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_FSTYPES'><glossterm>IMAGE_FSTYPES</glossterm> - <info> - IMAGE_FSTYPES[doc] = "Formats of root filesystem images that you want to have created." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the formats the OpenEmbedded build system uses - during the build when creating the root filesystem. - For example, setting <filename>IMAGE_FSTYPES</filename> - as follows causes the build system to create root - filesystems using two formats: <filename>.ext3</filename> - and <filename>.tar.bz2</filename>: - <literallayout class='monospaced'> - IMAGE_FSTYPES = "ext3 tar.bz2" - </literallayout> - </para> - - <para> - For the complete list of supported image formats from which - you can choose, see - <link linkend='var-IMAGE_TYPES'><filename>IMAGE_TYPES</filename></link>. - </para> - - <note><title>Notes</title> - <itemizedlist> - <listitem><para> - If an image recipe uses the "inherit image" line - and you are setting - <filename>IMAGE_FSTYPES</filename> inside the - recipe, you must set - <filename>IMAGE_FSTYPES</filename> prior to - using the "inherit image" line. - </para></listitem> - <listitem><para> - Due to the way the OpenEmbedded build system - processes this variable, you cannot update its - contents by using <filename>_append</filename> or - <filename>_prepend</filename>. - You must use the <filename>+=</filename> - operator to add one or more options to the - <filename>IMAGE_FSTYPES</filename> variable. - </para></listitem> - </itemizedlist> - </note> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_INSTALL'><glossterm>IMAGE_INSTALL</glossterm> - <info> - IMAGE_INSTALL[doc] = "Used by recipes to specify the packages to install into an image through image.bbclass." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Used by recipes to specify the packages to install into an - image through the - <link linkend='ref-classes-image'><filename>image</filename></link> - class. - Use the <filename>IMAGE_INSTALL</filename> variable with - care to avoid ordering issues. - </para> - - <para> - Image recipes set <filename>IMAGE_INSTALL</filename> - to specify the packages to install into an image through - <filename>image.bbclass</filename>. - Additionally, "helper" classes such as the - <link linkend='ref-classes-core-image'><filename>core-image</filename></link> - class exist that can take lists used with - <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename> - and turn them into auto-generated entries in - <filename>IMAGE_INSTALL</filename> in addition to its - default contents. - </para> - - <para> - When you use this variable, it is best to use it as follows: - <literallayout class='monospaced'> - IMAGE_INSTALL_append = " <replaceable>package-name</replaceable>" - </literallayout> - Be sure to include the space between the quotation character - and the start of the package name or names. - <note><title>Caution</title> - <itemizedlist> - <listitem><para> - When working with a - <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link> - image, do not use the - <filename>IMAGE_INSTALL</filename> variable to - specify packages for installation. - Instead, use the - <link linkend='var-PACKAGE_INSTALL'><filename>PACKAGE_INSTALL</filename></link> - variable, which allows the initial RAM - filesystem (initramfs) recipe to use a fixed - set of packages and not be affected by - <filename>IMAGE_INSTALL</filename>. - For information on creating an initramfs, see - the - "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" - section in the Yocto Project Development Tasks - Manual. - </para></listitem> - <listitem><para> - Using <filename>IMAGE_INSTALL</filename> with - the - <ulink url='&YOCTO_DOCS_BB_URL;#appending-and-prepending'><filename>+=</filename></ulink> - BitBake operator within the - <filename>/conf/local.conf</filename> file or - from within an image recipe is not recommended. - Use of this operator in these ways can cause - ordering issues. - Since <filename>core-image.bbclass</filename> - sets <filename>IMAGE_INSTALL</filename> to a - default value using the - <ulink url='&YOCTO_DOCS_BB_URL;#setting-a-default-value'><filename>?=</filename></ulink> - operator, using a <filename>+=</filename> - operation against - <filename>IMAGE_INSTALL</filename> results in - unexpected behavior when used within - <filename>conf/local.conf</filename>. - Furthermore, the same operation from within - an image recipe may or may not succeed - depending on the specific situation. - In both these cases, the behavior is contrary - to how most users expect the - <filename>+=</filename> operator to work. - </para></listitem> - </itemizedlist> - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_LINGUAS'><glossterm>IMAGE_LINGUAS</glossterm> - <info> - IMAGE_LINGUAS[doc] = "Specifies the list of locales to install into the image during the root filesystem construction process." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the list of locales to install into the image - during the root filesystem construction process. - The OpenEmbedded build system automatically splits locale - files, which are used for localization, into separate - packages. - Setting the <filename>IMAGE_LINGUAS</filename> variable - ensures that any locale packages that correspond to packages - already selected for installation into the image are also - installed. - Here is an example: - <literallayout class='monospaced'> - IMAGE_LINGUAS = "pt-br de-de" - </literallayout> - </para> - - <para> - In this example, the build system ensures any Brazilian - Portuguese and German locale files that correspond to - packages in the image are installed (i.e. - <filename>*-locale-pt-br</filename> - and <filename>*-locale-de-de</filename> as well as - <filename>*-locale-pt</filename> - and <filename>*-locale-de</filename>, since some software - packages only provide locale files by language and not by - country-specific language). - </para> - - <para> - See the - <link linkend='var-GLIBC_GENERATE_LOCALES'><filename>GLIBC_GENERATE_LOCALES</filename></link> - variable for information on generating GLIBC locales. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_MANIFEST'><glossterm>IMAGE_MANIFEST</glossterm> - <info> - IMAGE_MANIFEST[doc] = "The manifest file for the image. This file lists all the installed packages that make up the image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The manifest file for the image. - This file lists all the installed packages that make up - the image. - The file contains package information on a line-per-package - basis as follows: - <literallayout class='monospaced'> - <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable> - </literallayout> - </para> - - <para> - The - <link linkend='ref-classes-image'><filename>image</filename></link> - class defines the manifest file as follows: - <literallayout class='monospaced'> - IMAGE_MANIFEST = "${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest" - </literallayout> - The location is derived using the - <link linkend='var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></link> - and - <link linkend='var-IMAGE_NAME'><filename>IMAGE_NAME</filename></link> - variables. - You can find information on how the image - is created in the - "<ulink url='&YOCTO_DOCS_OM_URL;#image-generation-dev-environment'>Image Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_NAME'><glossterm>IMAGE_NAME</glossterm> - <info> - IMAGE_NAME[doc] = "The name of the output image files minus the extension." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The name of the output image files minus the extension. - This variable is derived using the - <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>, - <link linkend='var-MACHINE'><filename>MACHINE</filename></link>, - and - <link linkend='var-DATETIME'><filename>DATETIME</filename></link> - variables: - <literallayout class='monospaced'> - IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_OVERHEAD_FACTOR'><glossterm>IMAGE_OVERHEAD_FACTOR</glossterm> - <info> - IMAGE_OVERHEAD_FACTOR[doc] = "Defines a multiplier that the build system applies to the initial image size for cases when the multiplier times the returned disk usage value for the image is greater than the sum of IMAGE_ROOTFS_SIZE and IMAGE_ROOTFS_EXTRA_SPACE." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines a multiplier that the build system applies to the initial image - size for cases when the multiplier times the returned disk usage value - for the image is greater than the sum of - <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename> - and - <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename>. - The result of the multiplier applied to the initial image size creates - free disk space in the image as overhead. - By default, the build process uses a multiplier of 1.3 for this variable. - This default value results in 30% free disk space added to the image when this - method is used to determine the final generated image size. - You should be aware that post install scripts and the package management - system uses disk space inside this overhead area. - Consequently, the multiplier does not produce an image with - all the theoretical free disk space. - See <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename> - for information on how the build system determines the overall image size. - </para> - - <para> - The default 30% free disk space typically gives the image enough room to boot - and allows for basic post installs while still leaving a small amount of - free disk space. - If 30% free space is inadequate, you can increase the default value. - For example, the following setting gives you 50% free space added to the image: - <literallayout class='monospaced'> - IMAGE_OVERHEAD_FACTOR = "1.5" - </literallayout> - </para> - - <para> - Alternatively, you can ensure a specific amount of free disk space is added - to the image by using the - <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_PKGTYPE'><glossterm>IMAGE_PKGTYPE</glossterm> - <info> - IMAGE_PKGTYPE[doc] = "Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the OpenEmbedded build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the package type (i.e. DEB, RPM, IPK, or TAR) used - by the OpenEmbedded build system. - The variable is defined appropriately by the - <link linkend='ref-classes-package_deb'><filename>package_deb</filename></link>, - <link linkend='ref-classes-package_rpm'><filename>package_rpm</filename></link>, - <link linkend='ref-classes-package_ipk'><filename>package_ipk</filename></link>, - or - <link linkend='ref-classes-package_tar'><filename>package_tar</filename></link> - class. - <note><title>Warning</title> - The <filename>package_tar</filename> class is broken - and is not supported. - It is recommended that you do not use it. - </note> - </para> - - <para> - The - <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_*</filename></link> - and - <link linkend='ref-classes-image'><filename>image</filename></link> - classes use the <filename>IMAGE_PKGTYPE</filename> for - packaging up images and SDKs. - </para> - - <para> - You should not set the <filename>IMAGE_PKGTYPE</filename> - manually. - Rather, the variable is set indirectly through the - appropriate - <link linkend='ref-classes-package'><filename>package_*</filename></link> - class using the - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link> - variable. - The OpenEmbedded build system uses the first package type - (e.g. DEB, RPM, or IPK) that appears with the variable - <note> - Files using the <filename>.tar</filename> format are - never used as a substitute packaging format for DEB, - RPM, and IPK formatted files for your image or SDK. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_POSTPROCESS_COMMAND'><glossterm>IMAGE_POSTPROCESS_COMMAND</glossterm> - <info> - IMAGE_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system creates the final image output files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions to call once the - OpenEmbedded build system creates the final image - output files. - You can specify functions separated by semicolons: - <literallayout class='monospaced'> - IMAGE_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " - </literallayout> - </para> - - <para> - If you need to pass the root filesystem path to a command - within the function, you can use - <filename>${IMAGE_ROOTFS}</filename>, which points to - the directory that becomes the root filesystem image. - See the - <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_PREPROCESS_COMMAND'><glossterm>IMAGE_PREPROCESS_COMMAND</glossterm> - <info> - IMAGE_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system creates the final image output files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions to call before the - OpenEmbedded build system creates the final image - output files. - You can specify functions separated by semicolons: - <literallayout class='monospaced'> - IMAGE_PREPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " - </literallayout> - </para> - - <para> - If you need to pass the root filesystem path to a command - within the function, you can use - <filename>${IMAGE_ROOTFS}</filename>, which points to - the directory that becomes the root filesystem image. - See the - <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_ROOTFS'><glossterm>IMAGE_ROOTFS</glossterm> - <info> - IMAGE_ROOTFS[doc] = "The location of the root filesystem while it is under construction (i.e. during do_rootfs)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The location of the root filesystem while it is under - construction (i.e. during the - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> - task). - This variable is not configurable. - Do not change it. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_ROOTFS_ALIGNMENT'><glossterm>IMAGE_ROOTFS_ALIGNMENT</glossterm> - <info> - IMAGE_ROOTFS_ALIGNMENT[doc] = "Specifies the alignment for the output image file in Kbytes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the alignment for the output image file in - Kbytes. - If the size of the image is not a multiple of - this value, then the size is rounded up to the nearest - multiple of the value. - The default value is "1". - See - <link linkend='var-IMAGE_ROOTFS_SIZE'><filename>IMAGE_ROOTFS_SIZE</filename></link> - for additional information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_ROOTFS_EXTRA_SPACE'><glossterm>IMAGE_ROOTFS_EXTRA_SPACE</glossterm> - <info> - IMAGE_ROOTFS_EXTRA_SPACE[doc] = "Defines additional free disk space created in the image in Kbytes. By default, this variable is set to '0'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines additional free disk space created in the image in Kbytes. - By default, this variable is set to "0". - This free disk space is added to the image after the build system determines - the image size as described in - <filename><link linkend='var-IMAGE_ROOTFS_SIZE'>IMAGE_ROOTFS_SIZE</link></filename>. - </para> - - <para> - This variable is particularly useful when you want to ensure that a - specific amount of free disk space is available on a device after an image - is installed and running. - For example, to be sure 5 Gbytes of free disk space is available, set the - variable as follows: - <literallayout class='monospaced'> - IMAGE_ROOTFS_EXTRA_SPACE = "5242880" - </literallayout> - </para> - - <para> - For example, the Yocto Project Build Appliance specifically requests 40 Gbytes - of extra space with the line: - <literallayout class='monospaced'> - IMAGE_ROOTFS_EXTRA_SPACE = "41943040" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_ROOTFS_SIZE'><glossterm>IMAGE_ROOTFS_SIZE</glossterm> - <info> - IMAGE_ROOTFS_SIZE[doc] = "Defines the size in Kbytes for the generated image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the size in Kbytes for the generated image. - The OpenEmbedded build system determines the final size for the generated - image using an algorithm that takes into account the initial disk space used - for the generated image, a requested size for the image, and requested - additional free disk space to be added to the image. - Programatically, the build system determines the final size of the - generated image as follows: - <literallayout class='monospaced'> - if (image-du * overhead) < rootfs-size: - internal-rootfs-size = rootfs-size + xspace - else: - internal-rootfs-size = (image-du * overhead) + xspace - - where: - - image-du = Returned value of the du command on - the image. - - overhead = IMAGE_OVERHEAD_FACTOR - - rootfs-size = IMAGE_ROOTFS_SIZE - - internal-rootfs-size = Initial root filesystem - size before any modifications. - - xspace = IMAGE_ROOTFS_EXTRA_SPACE - </literallayout> - </para> - - <para> - See the <link linkend='var-IMAGE_OVERHEAD_FACTOR'><filename>IMAGE_OVERHEAD_FACTOR</filename></link> - and <link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'><filename>IMAGE_ROOTFS_EXTRA_SPACE</filename></link> - variables for related information. -<!-- In the above example, <filename>overhead</filename> is defined by the - <filename><link linkend='var-IMAGE_OVERHEAD_FACTOR'>IMAGE_OVERHEAD_FACTOR</link></filename> - variable, <filename>xspace</filename> is defined by the - <filename><link linkend='var-IMAGE_ROOTFS_EXTRA_SPACE'>IMAGE_ROOTFS_EXTRA_SPACE</link></filename> - variable, and <filename>du</filename> is the results of the disk usage command - on the initially generated image. --> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_TYPEDEP'><glossterm>IMAGE_TYPEDEP</glossterm> - <info> - IMAGE_TYPEDEP[doc] = "Specifies a dependency from one image type on another." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a dependency from one image type on another. - Here is an example from the - <link linkend='ref-classes-image-live'><filename>image-live</filename></link> - class: - <literallayout class='monospaced'> - IMAGE_TYPEDEP_live = "ext3" - </literallayout> - </para> - - <para> - In the previous example, the variable ensures that when - "live" is listed with the - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - variable, the OpenEmbedded build system produces an - <filename>ext3</filename> image first since one of the - components of the live - image is an <filename>ext3</filename> - formatted partition containing the root - filesystem. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IMAGE_TYPES'><glossterm>IMAGE_TYPES</glossterm> - <info> - IMAGE_TYPES[doc] = "Specifies the complete list of supported image types by default." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the complete list of supported image types - by default: - <literallayout class='monospaced'> - btrfs - cpio - cpio.gz - cpio.lz4 - cpio.lzma - cpio.xz - cramfs - elf - ext2 - ext2.bz2 - ext2.gz - ext2.lzma - ext3 - ext3.gz - ext4 - ext4.gz - hdddirect - hddimg - iso - jffs2 - jffs2.sum - multiubi - squashfs - squashfs-lzo - squashfs-xz - tar - tar.bz2 - tar.gz - tar.lz4 - tar.xz - ubi - ubifs - wic - wic.bz2 - wic.gz - wic.lzma - </literallayout> - </para> - - <para> - For more information about these types of images, see - <filename>meta/classes/image_types*.bbclass</filename> - in the - <link linkend='source-directory'>Source Directory</link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INC_PR'><glossterm>INC_PR</glossterm> - <info> - INC_PR[doc] = "Helps define the recipe revision for recipes that share a common include file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Helps define the recipe revision for recipes that share - a common <filename>include</filename> file. - You can think of this variable as part of the recipe revision - as set from within an include file. - </para> - - <para> - Suppose, for example, you have a set of recipes that - are used across several projects. - And, within each of those recipes the revision - (its <link linkend='var-PR'><filename>PR</filename></link> - value) is set accordingly. - In this case, when the revision of those recipes changes, - the burden is on you to find all those recipes and - be sure that they get changed to reflect the updated - version of the recipe. - In this scenario, it can get complicated when recipes - that are used in many places and provide common functionality - are upgraded to a new revision. - </para> - - <para> - A more efficient way of dealing with this situation is - to set the <filename>INC_PR</filename> variable inside - the <filename>include</filename> files that the recipes - share and then expand the <filename>INC_PR</filename> - variable within the recipes to help - define the recipe revision. - </para> - - <para> - The following provides an example that shows how to use - the <filename>INC_PR</filename> variable - given a common <filename>include</filename> file that - defines the variable. - Once the variable is defined in the - <filename>include</filename> file, you can use the - variable to set the <filename>PR</filename> values in - each recipe. - You will notice that when you set a recipe's - <filename>PR</filename> you can provide more granular - revisioning by appending values to the - <filename>INC_PR</filename> variable: - <literallayout class='monospaced'> - recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" - recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1" - recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0" - recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" - </literallayout> - The first line of the example establishes the baseline - revision to be used for all recipes that use the - <filename>include</filename> file. - The remaining lines in the example are from individual - recipes and show how the <filename>PR</filename> value - is set. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INCOMPATIBLE_LICENSE'><glossterm>INCOMPATIBLE_LICENSE</glossterm> - <info> - INCOMPATIBLE_LICENSE[doc] = "Specifies a space-separated list of license names (as they would appear in LICENSE) that should be excluded from the build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a space-separated list of license names - (as they would appear in - <link linkend='var-LICENSE'><filename>LICENSE</filename></link>) - that should be excluded from the build. - Recipes that provide no alternatives to listed incompatible - licenses are not built. - Packages that are individually licensed with the specified - incompatible licenses will be deleted. - </para> - - <note> - This functionality is only regularly tested using - the following setting: - <literallayout class='monospaced'> - INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" - </literallayout> - Although you can use other settings, you might be required - to remove dependencies on or provide alternatives to - components that are required to produce a functional system - image. - </note> - </glossdef> - </glossentry> - - <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> - <info> - INHERIT[doc] = "Causes the named class or classes to be inherited globally." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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 - <filename>INHERIT</filename> in individual recipes. - </para> - - <para> - For more information on <filename>INHERIT</filename>, see - the - "<ulink url="&YOCTO_DOCS_BB_URL;#inherit-configuration-directive"><filename>INHERIT</filename> Configuration Directive</ulink>" - section in the Bitbake User Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INHERIT_DISTRO'><glossterm>INHERIT_DISTRO</glossterm> - <info> - INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists classes that will be inherited at the - distribution level. - It is unlikely that you want to edit this variable. - </para> - - <para> - The default value of the variable is set as follows in the - <filename>meta/conf/distro/defaultsetup.conf</filename> - file: - <literallayout class='monospaced'> - INHERIT_DISTRO ?= "debian devshell sstate license" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm> - <info> - INHIBIT_DEFAULT_DEPS[doc] = "Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to DEPENDS." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Prevents the default dependencies, namely the C compiler - and standard C library (libc), from being added to - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>. - This variable is usually used within recipes that do not - require any compilation using the C compiler. - </para> - - <para> - Set the variable to "1" to prevent the default dependencies - from being added. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INHIBIT_PACKAGE_DEBUG_SPLIT'><glossterm>INHIBIT_PACKAGE_DEBUG_SPLIT</glossterm> - <info> - INHIBIT_PACKAGE_DEBUG_SPLIT[doc] = "If set to "1", prevents the OpenEmbedded build system from splitting out debug information during packaging" - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Prevents the OpenEmbedded build system from splitting - out debug information during packaging. - By default, the build system splits out debugging - information during the - <link linkend='ref-tasks-package'><filename>do_package</filename></link> - task. - For more information on how debug information is split out, - see the - <link linkend='var-PACKAGE_DEBUG_SPLIT_STYLE'><filename>PACKAGE_DEBUG_SPLIT_STYLE</filename></link> - variable. - </para> - - <para> - To prevent the build system from splitting out - debug information during packaging, set the - <filename>INHIBIT_PACKAGE_DEBUG_SPLIT</filename> variable - as follows: - <literallayout class='monospaced'> - INHIBIT_PACKAGE_DEBUG_SPLIT = "1" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INHIBIT_PACKAGE_STRIP'><glossterm>INHIBIT_PACKAGE_STRIP</glossterm> - <info> - INHIBIT_PACKAGE_STRIP[doc] = "If set to "1", causes the build to not strip binaries in resulting packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set to "1", causes the build to not strip binaries in - resulting packages and prevents the - <filename>-dbg</filename> package from containing the - source files. - </para> - - <para> - By default, the OpenEmbedded build system strips - binaries and puts the debugging symbols into - <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-dbg</filename>. - Consequently, you should not set - <filename>INHIBIT_PACKAGE_STRIP</filename> when you plan - to debug in general. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INHIBIT_SYSROOT_STRIP'><glossterm>INHIBIT_SYSROOT_STRIP</glossterm> - <info> - INHIBIT_SYSROOT_STRIP[doc] = "If set to "1", causes the build to not strip binaries in the resulting sysroot." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set to "1", causes the build to not strip binaries in - the resulting sysroot. - </para> - - <para> - By default, the OpenEmbedded build system strips - binaries in the resulting sysroot. - When you specifically set the - <filename>INHIBIT_SYSROOT_STRIP</filename> variable to - "1" in your recipe, you inhibit this stripping. - </para> - - <para> - If you want to use this variable, include the - <link linkend='ref-classes-staging'><filename>staging</filename></link> - class. - This class uses a <filename>sys_strip()</filename> - function to test for the variable and acts accordingly. - <note> - Use of the <filename>INHIBIT_SYSROOT_STRIP</filename> - 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. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm> - <info> - INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM filesystem (initramfs), which is used during boot." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the format for the output image of an initial - RAM filesystem (initramfs), which is used during boot. - Supported formats are the same as those supported by the - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - variable. - </para> - - <para> - The default value of this variable, which is set in the - <filename>meta/conf/bitbake.conf</filename> configuration - file in the - <link linkend='source-directory'>Source Directory</link>, - is "cpio.gz". - The Linux kernel's initramfs mechanism, as opposed to the - initial RAM filesystem - <ulink url='https://en.wikipedia.org/wiki/Initrd'>initrd</ulink> - mechanism, expects an optionally compressed cpio - archive. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITRAMFS_IMAGE'><glossterm>INITRAMFS_IMAGE</glossterm> - <info> - INITRAMFS_IMAGE[doc] = "Specifies the PROVIDES name of an image recipe that is used to build an initial RAM filesystem (initramfs) image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the - <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> - name of an image recipe that is used to build an initial - RAM filesystem (initramfs) image. - In other words, the <filename>INITRAMFS_IMAGE</filename> - variable causes an additional recipe to be built as - a dependency to whatever root filesystem recipe you - might be using (e.g. <filename>core-image-sato</filename>). - The initramfs image recipe you provide should set - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - to - <link linkend='var-INITRAMFS_FSTYPES'><filename>INITRAMFS_FSTYPES</filename></link>. - </para> - - <para> - 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 <filename>meta/recipes-core/images/core-image-minimal-initramfs.bb</filename> - recipe in the - <link linkend='source-directory'>Source Directory</link> - for an example initramfs recipe. - To select this sample recipe as the one built - to provide the initramfs image, - set <filename>INITRAMFS_IMAGE</filename> to - "core-image-minimal-initramfs". - </note> - </para> - - <para> - You can also find more information by referencing the - <filename>meta-poky/conf/local.conf.sample.extended</filename> - configuration file in the Source Directory, - the - <link linkend='ref-classes-image'><filename>image</filename></link> - class, and the - <link linkend='ref-classes-kernel'><filename>kernel</filename></link> - class to see how to use the - <filename>INITRAMFS_IMAGE</filename> variable. - </para> - - <para> - If <filename>INITRAMFS_IMAGE</filename> is empty, which is - the default, then no initramfs image is built. - </para> - - <para> - For more information, you can also see the - <link linkend='var-INITRAMFS_IMAGE_BUNDLE'><filename>INITRAMFS_IMAGE_BUNDLE</filename></link> - variable, which allows the generated image to be bundled - inside the kernel image. - Additionally, for information on creating an initramfs - image, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITRAMFS_IMAGE_BUNDLE'><glossterm>INITRAMFS_IMAGE_BUNDLE</glossterm> - <info> - INITRAMFS_IMAGE_BUNDLE[doc] = "Controls whether or not the image recipe specified by INITRAMFS_IMAGE is run through an extra pass (do_bundle_initramfs) during kernel compilation in order to build a single binary that contains both the kernel image and the initial RAM filesystem (initramfs)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Controls whether or not the image recipe specified by - <link linkend='var-INITRAMFS_IMAGE'><filename>INITRAMFS_IMAGE</filename></link> - is run through an extra pass - (<link linkend='ref-tasks-bundle_initramfs'><filename>do_bundle_initramfs</filename></link>) - 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 - <link linkend='var-CONFIG_INITRAMFS_SOURCE'><filename>CONFIG_INITRAMFS_SOURCE</filename></link> - 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. - </note> - </para> - - <para> - The combined binary is deposited into the - <filename>tmp/deploy</filename> directory, which is part - of the - <link linkend='build-directory'>Build Directory</link>. - </para> - - <para> - Setting the variable to "1" in a configuration file causes the - OpenEmbedded build system to generate a kernel image with the - initramfs specified in <filename>INITRAMFS_IMAGE</filename> - bundled within: - <literallayout class='monospaced'> - INITRAMFS_IMAGE_BUNDLE = "1" - </literallayout> - By default, the - <link linkend='ref-classes-kernel'><filename>kernel</filename></link> - class sets this variable to a null string as follows: - <literallayout class='monospaced'> - INITRAMFS_IMAGE_BUNDLE ?= "" - </literallayout> - <note> - You must set the - <filename>INITRAMFS_IMAGE_BUNDLE</filename> variable in - a configuration file. - You cannot set the variable in a recipe file. - </note> - See the - <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended'><filename>local.conf.sample.extended</filename></ulink> - file for additional information. - Also, for information on creating an initramfs, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITRAMFS_LINK_NAME'><glossterm>INITRAMFS_LINK_NAME</glossterm> - <info> - INITRAMFS_LINK_NAME[doc] = "The link name of the initial RAM filesystem image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The link name of the initial RAM filesystem image. - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}" - </literallayout> - The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - </literallayout> - </para> - - <para> - See the - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - variable for additional information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITRAMFS_NAME'><glossterm>INITRAMFS_NAME</glossterm> - <info> - INITRAMFS_NAME[doc] = "The base name of the initial RAM filesystem image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The base name of the initial RAM filesystem image. - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" - </literallayout> - The value of the - <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITRD'><glossterm>INITRD</glossterm> - <info> - INITRD[doc] = "Indicates a list of filesystem images to concatenate and use as an initial RAM disk (initrd)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Indicates list of filesystem images to concatenate and use - as an initial RAM disk (<filename>initrd</filename>). - </para> - - <para> - The <filename>INITRD</filename> variable is an optional - variable used with the - <link linkend='ref-classes-image-live'><filename>image-live</filename></link> - class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITRD_IMAGE'><glossterm>INITRD_IMAGE</glossterm> - <info> - INITRD_IMAGE[doc] = "When building a "live" bootable image (i.e. when IMAGE_FSTYPES contains "live"), INITRD_IMAGE specifies the image recipe that should be built to provide the initial RAM disk image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When building a "live" bootable image (i.e. when - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - contains "live"), <filename>INITRD_IMAGE</filename> - specifies the image recipe that should be built - to provide the initial RAM disk image. - The default value is "core-image-minimal-initramfs". - </para> - - <para> - See the - <link linkend='ref-classes-image-live'><filename>image-live</filename></link> - class for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITSCRIPT_NAME'><glossterm>INITSCRIPT_NAME</glossterm> - <info> - INITSCRIPT_NAME[doc] = "The filename of the initialization script as installed to ${sysconfdir}/init.d." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The filename of the initialization script as installed to - <filename>${sysconfdir}/init.d</filename>. - </para> - - <para> - This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. - The variable is mandatory. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITSCRIPT_PACKAGES'><glossterm>INITSCRIPT_PACKAGES</glossterm> - <info> - INITSCRIPT_PACKAGES[doc] = "A list of the packages that contain initscripts. This variable is used in recipes when using update-rc.d.bbclass. The variable is optional and defaults to the PN variable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of the packages that contain initscripts. - If multiple packages are specified, you need to append the package name - to the other <filename>INITSCRIPT_*</filename> as an override. - </para> - - <para> - This variable is used in recipes when using <filename>update-rc.d.bbclass</filename>. - The variable is optional and defaults to the - <link linkend='var-PN'><filename>PN</filename></link> variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INITSCRIPT_PARAMS'><glossterm>INITSCRIPT_PARAMS</glossterm> - <info> - INITSCRIPT_PARAMS[doc] = "Specifies the options to pass to update-rc.d. The variable is mandatory and is used in recipes when using update-rc.d.bbclass." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the options to pass to <filename>update-rc.d</filename>. - Here is an example: - <literallayout class='monospaced'> - INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ." - </literallayout> - </para> - - <para> - In this example, the script has a runlevel of 99, - starts the script in initlevels 2 and 5, and - stops the script in levels 0, 1 and 6. - </para> - - <para> - The variable's default value is "defaults", which is - set in the - <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> - class. - </para> - - <para> - The value in - <filename>INITSCRIPT_PARAMS</filename> is passed through - to the <filename>update-rc.d</filename> command. - For more information on valid parameters, please see the - <filename>update-rc.d</filename> manual page at - <ulink url='http://www.tin.org/bin/man.cgi?section=8&topic=update-rc.d'></ulink>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INSANE_SKIP'><glossterm>INSANE_SKIP</glossterm> - <info> - INSANE_SKIP[doc] = "Specifies the QA checks to skip for a specific package within a recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the QA checks to skip for a specific package - within a recipe. - For example, to skip the check for symbolic link - <filename>.so</filename> files in the main package of a - recipe, add the following to the recipe. - The package name override must be used, which in this - example is <filename>${PN}</filename>: - <literallayout class='monospaced'> - INSANE_SKIP_${PN} += "dev-so" - </literallayout> - </para> - - <para> - See the "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" - section for a list of the valid QA checks you can - specify using this variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-INSTALL_TIMEZONE_FILE'><glossterm>INSTALL_TIMEZONE_FILE</glossterm> - <info> - INSTALL_TIMEZONE_FILE[doc] = "Enables installation of the /etc/timezone file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - By default, the <filename>tzdata</filename> recipe packages - an <filename>/etc/timezone</filename> file. - Set the <filename>INSTALL_TIMEZONE_FILE</filename> - variable to "0" at the configuration level to disable this - behavior. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-IPK_FEED_URIS'><glossterm>IPK_FEED_URIS</glossterm> - <info> - IPK_FEED_URIS[doc] = "List of ipkg feed records to put into generated image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the IPK backend is in use and package management - is enabled on the target, you can use this variable to - set up <filename>opkg</filename> in the target image - to point to package feeds on a nominated server. - Once the feed is established, you can perform - installations or upgrades using the package manager - at runtime. - </para> - </glossdef> - </glossentry> - -<!-- - <glossentry id='var-INTERCEPT_DIR'><glossterm>INTERCEPT_DIR</glossterm> - <glossdef> - <para> - An environment variable that defines the directory where - post installation hooks are installed for the - post install environment. - This variable is fixed as follows: - <literallayout class='monospaced'> - ${WORKDIR}/intercept_scripts - </literallayout> - </para> - - <para> - After installation of a target's root filesystem, - post installation scripts, which are essentially bash scripts, - are all executed just a single time. - Limiting execution of these scripts minimizes installation - time that would be lengthened due to certain packages - triggering redundant operations. - For example, consider the installation of font packages - as a common example. - Without limiting the execution of post installation scripts, - all font directories would be rescanned to create the - cache after each individual font package was installed. - </para> - - <para> - Do not edit the <filename>INTERCEPT_DIR</filename> - variable. - </para> - </glossdef> - </glossentry> ---> - - </glossdiv> - -<!-- <glossdiv id='var-glossary-j'><title>J</title>--> -<!-- </glossdiv>--> - - <glossdiv id='var-glossary-k'><title>K</title> - - <glossentry id='var-KARCH'><glossterm>KARCH</glossterm> - <info> - KARCH[doc] = "Defines the kernel architecture used when assembling the configuration. You define the KARCH variable in the BSP Descriptions." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the kernel architecture used when assembling - the configuration. - Architectures supported for this release are: - <literallayout class='monospaced'> - powerpc - i386 - x86_64 - arm - qemu - mips - </literallayout> - </para> - - <para> - You define the <filename>KARCH</filename> variable in the - <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions'>BSP Descriptions</ulink>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KBRANCH'><glossterm>KBRANCH</glossterm> - <info> - KBRANCH[doc] = "A regular expression used by the build process to explicitly identify the kernel branch that is validated, patched, and configured during a build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A regular expression used by the build process to explicitly - identify the kernel branch that is validated, patched, - and configured during a build. - You must set this variable to ensure the exact kernel - branch you want is being used by the build process. - </para> - - <para> - Values for this variable are set in the kernel's recipe - file and the kernel's append file. - For example, if you are using the - <filename>linux-yocto_4.12</filename> kernel, the kernel - recipe file is the - <filename>meta/recipes-kernel/linux/linux-yocto_4.12.bb</filename> - file. - <filename>KBRANCH</filename> is set as follows in that - kernel recipe file: - <literallayout class='monospaced'> - KBRANCH ?= "standard/base" - </literallayout> - </para> - - <para> - This variable is also used from the kernel's append file - to identify the kernel branch specific to a particular - machine or target hardware. - Continuing with the previous kernel example, the kernel's - append file (i.e. - <filename>linux-yocto_4.12.bbappend</filename>) 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 (<filename>meta-yocto-bsp</filename>) is named - <filename>meta-yocto-bsp/recipes-kernel/linux/linux-yocto_4.12.bbappend</filename>. - Here are the related statements from that append file: - <literallayout class='monospaced'> - KBRANCH_genericx86 = "standard/base" - KBRANCH_genericx86-64 = "standard/base" - KBRANCH_edgerouter = "standard/edgerouter" - KBRANCH_beaglebone = "standard/beaglebone" - KBRANCH_mpc8315e-rdb = "standard/fsl-mpc8315e-rdb" - </literallayout> - The <filename>KBRANCH</filename> statements identify - the kernel branch to use when building for each - supported BSP. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KBUILD_DEFCONFIG'><glossterm>KBUILD_DEFCONFIG</glossterm> - <info> - KBUILD_DEFCONFIG[doc] = "Specifies an "in-tree" kernel configuration file for use during a kernel build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When used with the - <link linkend='ref-classes-kernel-yocto'><filename>kernel-yocto</filename></link> - class, specifies an "in-tree" kernel configuration file - for use during a kernel build. - </para> - - <para> - Typically, when using a <filename>defconfig</filename> to - configure a kernel during a build, you place the - file in your layer in the same manner as you would - place patch files and configuration fragment files (i.e. - "out-of-tree"). - However, if you want to use a <filename>defconfig</filename> - file that is part of the kernel tree (i.e. "in-tree"), - you can use the - <filename>KBUILD_DEFCONFIG</filename> variable and append - the - <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link> - variable to point to the <filename>defconfig</filename> - file. - </para> - - <para> - To use the variable, set it in the append file for your - kernel recipe using the following form: - <literallayout class='monospaced'> - KBUILD_DEFCONFIG_<replaceable>KMACHINE</replaceable> ?= <replaceable>defconfig_file</replaceable> - </literallayout> - Here is an example from a "raspberrypi2" - <filename>KMACHINE</filename> build that uses a - <filename>defconfig</filename> file named - "bcm2709_defconfig": - <literallayout class='monospaced'> - KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig" - </literallayout> - As an alternative, you can use the following within your - append file: - <literallayout class='monospaced'> - KBUILD_DEFCONFIG_pn-linux-yocto ?= <replaceable>defconfig_file</replaceable> - </literallayout> - For more information on how to use the - <filename>KBUILD_DEFCONFIG</filename> variable, see the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#using-an-in-tree-defconfig-file'>Using an "In-Tree" <filename>defconfig</filename> File</ulink>" - section in the Yocto Project Linux Kernel Development - Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_ALT_IMAGETYPE'><glossterm>KERNEL_ALT_IMAGETYPE</glossterm> - <info> - KERNEL_ALT_IMAGETYPE[doc] = "Specifies an alternate kernel image type for creation." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies an alternate kernel image type for creation in - addition to the kernel image type specified using the - <link linkend='var-KERNEL_IMAGETYPE'><filename>KERNEL_IMAGETYPE</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_ARTIFACT_NAME'><glossterm>KERNEL_ARTIFACT_NAME</glossterm> - <info> - KERNEL_ARTIFACT_NAME[doc] = "Specifies the name of all of the build artifacts." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the name of all of the build artifacts. - You can change the name of the artifacts by changing the - <filename>KERNEL_ARTIFACT_NAME</filename> variable. - </para> - - <para> - The value of <filename>KERNEL_ARTIFACT_NAME</filename>, - which is set in the - <filename> meta/classes/kernel-artifact-names.bbclass</filename> - file, has the following default value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - </literallayout> - </para> - - <para> - See the - <link linkend='var-PKGE'><filename>PKGE</filename></link>, - <link linkend='var-PKGV'><filename>PKGV</filename></link>, - <link linkend='var-PKGR'><filename>PKGR</filename></link>, - and - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - variables for additional information. - <note> - The <filename>IMAGE_VERSION_SUFFIX</filename> variable - is set to - <link linkend='var-DATETIME'><filename>DATETIME</filename></link>. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_CLASSES'><glossterm>KERNEL_CLASSES</glossterm> - <info> - KERNEL_CLASSES[doc] = "A list of classes defining kernel image types that kernel class should inherit." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of classes defining kernel image types that the - <link linkend='ref-classes-kernel'><filename>kernel</filename></link> - class should inherit. - You typically append this variable to enable extended image - types. - An example is the "kernel-fitimage", which enables - fitImage support and resides in - <filename>meta/classes/kernel-fitimage.bbclass</filename>. - You can register custom kernel image types with the - <filename>kernel</filename> class using this variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_DEVICETREE'><glossterm>KERNEL_DEVICETREE</glossterm> - <info> - KERNEL_DEVICETREE[doc] = "Specifies the name of the generated Linux kernel device tree (i.e. the .dtb) file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the name of the generated Linux kernel device tree - (i.e. the <filename>.dtb</filename>) file. - <note> - Legacy support exists for specifying the full path - to the device tree. - However, providing just the <filename>.dtb</filename> - file is preferred. - </note> - In order to use this variable, you must have the include - files in your kernel recipe: - <literallayout class='monospaced'> - require recipes-kernel/linux/linux-dtb.inc - </literallayout> - or - <literallayout class='monospaced'> - require recipes-kernel/linux/linux-yocto.inc - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_DTB_LINK_NAME'><glossterm>KERNEL_DTB_LINK_NAME</glossterm> - <info> - KERNEL_DTB_LINK_NAME[doc] = "The link name of the kernel device tree binary (DTB)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The link name of the kernel device tree binary (DTB). - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" - </literallayout> - The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - </literallayout> - </para> - - <para> - See the - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - variable for additional information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_DTB_NAME'><glossterm>KERNEL_DTB_NAME</glossterm> - <info> - KERNEL_DTB_NAME[doc] = "The base name of the kernel device tree binary (DTB)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The base name of the kernel device tree binary (DTB). - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" - </literallayout> - The value of the - <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_EXTRA_ARGS'><glossterm>KERNEL_EXTRA_ARGS</glossterm> - <info> - KERNEL_EXTRA_ARGS[doc] = "Specifies additional make command-line arguments the OpenEmbedded build system passes on when compiling the kernel." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies additional <filename>make</filename> - command-line arguments the OpenEmbedded build system - passes on when compiling the kernel. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_FEATURES'><glossterm>KERNEL_FEATURES</glossterm> - <info> - KERNEL_FEATURES[doc] = "Includes additional kernel metadata. The metadata you add through this variable includes config fragments and features descriptions." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Includes additional kernel metadata. - In the OpenEmbedded build system, the default Board Support - Packages (BSPs) - <link linkend='metadata'>Metadata</link> - is provided through - the <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link> - and - <link linkend='var-KBRANCH'><filename>KBRANCH</filename></link> - variables. - You can use the <filename>KERNEL_FEATURES</filename> - variable from within the kernel recipe or kernel append - file to further add metadata for all BSPs or specific - BSPs. - </para> - - <para> - The metadata you add through this variable includes config - fragments and features descriptions, - which usually includes patches as well as config fragments. - You typically override the - <filename>KERNEL_FEATURES</filename> variable for a - specific machine. - In this way, you can provide validated, but optional, - sets of kernel configurations and features. - </para> - - <para> - For example, the following example from the - <filename>linux-yocto-rt_4.12</filename> 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: - <literallayout class='monospaced'> - 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" </literallayout></para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_FIT_LINK_NAME'><glossterm>KERNEL_FIT_LINK_NAME</glossterm> - <info> - KERNEL_FIT_LINK_NAME[doc] = "The link name of the kernel flattened image tree (FIT) image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The link name of the kernel flattened image tree (FIT) image. - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" - </literallayout> - The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - </literallayout> - </para> - - <para> - See the - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - variable for additional information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_FIT_NAME'><glossterm>KERNEL_FIT_NAME</glossterm> - <info> - KERNEL_FIT_NAME[doc] = "The base name of the kernel flattened image tree (FIT) image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The base name of the kernel flattened image tree (FIT) image. - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" - </literallayout> - The value of the - <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_IMAGE_LINK_NAME'><glossterm>KERNEL_IMAGE_LINK_NAME</glossterm> - <info> - KERNEL_IMAGE_LINK_NAME[doc] = "The link name for the kernel image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The link name for the kernel image. - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" - </literallayout> - The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - </literallayout> - </para> - - <para> - See the - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - variable for additional information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_IMAGE_MAXSIZE'><glossterm>KERNEL_IMAGE_MAXSIZE</glossterm> - <info> - KERNEL_IMAGE_MAXSIZE[doc] = "The maximum allowable size in kilobytes of the kernel image file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the maximum size of the kernel image file in - kilobytes. - If <filename>KERNEL_IMAGE_MAXSIZE</filename> is set, - the size of the kernel image file is checked against - the set value during the - <link linkend='ref-tasks-sizecheck'><filename>do_sizecheck</filename></link> - task. - The task fails if the kernel image file is larger than - the setting. - </para> - - <para> - <filename>KERNEL_IMAGE_MAXSIZE</filename> is useful for - target devices that have a limited amount of space in - which the kernel image must be stored. - </para> - - <para> - By default, this variable is not set, which means the - size of the kernel image is not checked. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_IMAGE_NAME'><glossterm>KERNEL_IMAGE_NAME</glossterm> - <info> - KERNEL_IMAGE_NAME[doc] = "The base name of the kernel image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The base name of the kernel image. - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" - </literallayout> - The value of the - <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_IMAGETYPE'><glossterm>KERNEL_IMAGETYPE</glossterm> - <info> - KERNEL_IMAGETYPE[doc] = "The type of kernel to build for a device, usually set by the machine configuration files and defaults to 'zImage'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The type of kernel to build for a device, usually set by the - machine configuration files and defaults to "zImage". - This variable is used - when building the kernel and is passed to <filename>make</filename> as the target to - build. - </para> - - <para> - If you want to build an alternate kernel image type, use the - <link linkend='var-KERNEL_ALT_IMAGETYPE'><filename>KERNEL_ALT_IMAGETYPE</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_MODULE_AUTOLOAD'><glossterm>KERNEL_MODULE_AUTOLOAD</glossterm> - <info> - KERNEL_MODULE_AUTOLOAD[doc] = "Lists kernel modules that need to be auto-loaded during boot" - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists kernel modules that need to be auto-loaded during - boot. - <note> - This variable replaces the deprecated - <link linkend='var-module_autoload'><filename>module_autoload</filename></link> - variable. - </note> - </para> - - <para> - You can use the <filename>KERNEL_MODULE_AUTOLOAD</filename> - variable anywhere that it can be - recognized by the kernel recipe or by an out-of-tree kernel - module recipe (e.g. a machine configuration file, a - distribution configuration file, an append file for the - recipe, or the recipe itself). - </para> - - <para> - Specify it as follows: - <literallayout class='monospaced'> - KERNEL_MODULE_AUTOLOAD += "<replaceable>module_name1</replaceable> <replaceable>module_name2</replaceable> <replaceable>module_name3</replaceable>" - </literallayout> - </para> - - <para> - Including <filename>KERNEL_MODULE_AUTOLOAD</filename> causes - the OpenEmbedded build system to populate the - <filename>/etc/modules-load.d/modname.conf</filename> - file with the list of modules to be auto-loaded on boot. - The modules appear one-per-line in the file. - Here is an example of the most common use case: - <literallayout class='monospaced'> - KERNEL_MODULE_AUTOLOAD += "<replaceable>module_name</replaceable>" - </literallayout> - </para> - - <para> - For information on how to populate the - <filename>modname.conf</filename> file with - <filename>modprobe.d</filename> syntax lines, see the - <link linkend='var-KERNEL_MODULE_PROBECONF'><filename>KERNEL_MODULE_PROBECONF</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_MODULE_PROBECONF'><glossterm>KERNEL_MODULE_PROBECONF</glossterm> - <info> - KERNEL_MODULE_PROBECONF[doc] = "Lists kernel modules for which the build system expects to find module_conf_* values that specify configuration for each of the modules." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Provides a list of modules for which the OpenEmbedded - build system expects to find - <filename>module_conf_</filename><replaceable>modname</replaceable> - values that specify configuration for each of the modules. - For information on how to provide those module - configurations, see the - <link linkend='var-module_conf'><filename>module_conf_*</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_PATH'><glossterm>KERNEL_PATH</glossterm> - <info> - KERNEL_PATH[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The location of the kernel sources. - This variable is set to the value of the - <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> - within the - <link linkend='ref-classes-module'><filename>module</filename></link> - class. - For information on how this variable is used, see the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>" - section in the Yocto Project Linux Kernel Development - Manual. - </para> - - <para> - To help maximize compatibility with out-of-tree drivers - used to build modules, the OpenEmbedded build system also - recognizes and uses the - <link linkend='var-KERNEL_SRC'><filename>KERNEL_SRC</filename></link> - variable, which is identical to the - <filename>KERNEL_PATH</filename> variable. - Both variables are common variables used by external - Makefiles to point to the kernel source directory. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_SRC'><glossterm>KERNEL_SRC</glossterm> - <info> - KERNEL_SRC[doc] = "The location of the kernel sources. This variable is set to the value of the STAGING_KERNEL_DIR within the module class (module.bbclass)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The location of the kernel sources. - This variable is set to the value of the - <link linkend='var-STAGING_KERNEL_DIR'><filename>STAGING_KERNEL_DIR</filename></link> - within the - <link linkend='ref-classes-module'><filename>module</filename></link> - class. - For information on how this variable is used, see the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules'>Incorporating Out-of-Tree Modules</ulink>" - section in the Yocto Project Linux Kernel Development - Manual. - </para> - - <para> - To help maximize compatibility with out-of-tree drivers - used to build modules, the OpenEmbedded build system also - recognizes and uses the - <link linkend='var-KERNEL_PATH'><filename>KERNEL_PATH</filename></link> - variable, which is identical to the - <filename>KERNEL_SRC</filename> variable. - Both variables are common variables used by external - Makefiles to point to the kernel source directory. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNEL_VERSION'><glossterm>KERNEL_VERSION</glossterm> - <info> - KERNEL_VERSION[doc] = "Specifies the version of the kernel as extracted from version.h or utsrelease.h within the kernel sources." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the version of the kernel as extracted from - <filename>version.h</filename> or - <filename>utsrelease.h</filename> within the kernel sources. - Effects of setting this variable do not take affect until - the kernel has been configured. - Consequently, attempting to refer to this variable in - contexts prior to configuration will not work. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KERNELDEPMODDEPEND'><glossterm>KERNELDEPMODDEPEND</glossterm> - <info> - KERNELDEPMODDEPEND[doc] = "Specifies whether or not to use the data referenced through the PKGDATA_DIR directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies whether the data referenced through - <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> - is needed or not. - The <filename>KERNELDEPMODDEPEND</filename> does not - control whether or not that data exists, - but simply whether or not it is used. - If you do not need to use the data, set the - <filename>KERNELDEPMODDEPEND</filename> variable in your - <filename>initramfs</filename> recipe. - Setting the variable there when the data is not needed - avoids a potential dependency loop. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KFEATURE_DESCRIPTION'><glossterm>KFEATURE_DESCRIPTION</glossterm> - <info> - KFEATURE_DESCRIPTION[doc] = "Provides a short description of a configuration fragment. You use this variable in the .scc file that describes a configuration fragment file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Provides a short description of a configuration fragment. - You use this variable in the <filename>.scc</filename> - file that describes a configuration fragment file. - Here is the variable used in a file named - <filename>smp.scc</filename> to describe SMP being - enabled: - <literallayout class='monospaced'> - define KFEATURE_DESCRIPTION "Enable SMP" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-KMACHINE'><glossterm>KMACHINE</glossterm> - <info> - KMACHINE[doc] = "The machine as known by the kernel." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The machine as known by the kernel. - Sometimes the machine name used by the kernel does not - match the machine name used by the OpenEmbedded build - system. - For example, the machine name that the OpenEmbedded build - system understands as - <filename>core2-32-intel-common</filename> goes by a - different name in the Linux Yocto kernel. - The kernel understands that machine as - <filename>intel-core2-32</filename>. - For cases like these, the <filename>KMACHINE</filename> - variable maps the kernel machine name to the OpenEmbedded - build system machine name. - </para> - - <para> - These mappings between different names occur in the - Yocto Linux Kernel's <filename>meta</filename> branch. - As an example take a look in the - <filename>common/recipes-kernel/linux/linux-yocto_3.19.bbappend</filename> - file: - <literallayout class='monospaced'> - LINUX_VERSION_core2-32-intel-common = "3.19.0" - COMPATIBLE_MACHINE_core2-32-intel-common = "${MACHINE}" - SRCREV_meta_core2-32-intel-common = "8897ef68b30e7426bc1d39895e71fb155d694974" - SRCREV_machine_core2-32-intel-common = "43b9eced9ba8a57add36af07736344dcc383f711" - KMACHINE_core2-32-intel-common = "intel-core2-32" - KBRANCH_core2-32-intel-common = "standard/base" - KERNEL_FEATURES_append_core2-32-intel-common = "${KERNEL_FEATURES_INTEL_COMMON}" - </literallayout> - The <filename>KMACHINE</filename> statement says that - the kernel understands the machine name as - "intel-core2-32". - However, the OpenEmbedded build system understands the - machine as "core2-32-intel-common". - </para> - - </glossdef> - </glossentry> - - <glossentry id='var-KTYPE'><glossterm>KTYPE</glossterm> - <info> - KTYPE[doc] = "Defines the kernel type to be used in assembling the configuration." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the kernel type to be used in assembling the - configuration. - The linux-yocto recipes define "standard", "tiny", - and "preempt-rt" kernel types. - See the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#kernel-types'>Kernel Types</ulink>" - section in the Yocto Project Linux Kernel Development - Manual for more information on kernel types. - </para> - - <para> - You define the <filename>KTYPE</filename> variable in the - <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions'>BSP Descriptions</ulink>. - The value you use must match the value used for the - <link linkend='var-LINUX_KERNEL_TYPE'><filename>LINUX_KERNEL_TYPE</filename></link> - value used by the kernel recipe. - </para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id='var-glossary-l'><title>L</title> - - <glossentry id='var-LABELS'><glossterm>LABELS</glossterm> - <info> - LABELS[doc] = "Provides a list of targets for automatic configuration." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Provides a list of targets for automatic configuration. - </para> - - <para> - See the - <link linkend='ref-classes-grub-efi'><filename>grub-efi</filename></link> - class for more information on how this variable is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> - <info> - LAYERDEPENDS[doc] = "Lists the layers, separated by spaces, on which this recipe depends. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists the layers, 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: - <literallayout class='monospaced'> - LAYERDEPENDS_mylayer = "anotherlayer (=3)" - </literallayout> - In this previous example, version 3 of "anotherlayer" - is compared against - <link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_anotherlayer</filename>. - </para> - - <para> - 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 - <filename>conf/layer.conf</filename> file and must be - suffixed with the name of the specific layer (e.g. - <filename>LAYERDEPENDS_mylayer</filename>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LAYERDIR'><glossterm>LAYERDIR</glossterm> - <info> - LAYERDIR[doc] = "When used inside the layer.conf configuration file, this variable provides the path of the current layer." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When used inside the <filename>layer.conf</filename> configuration - file, this variable provides the path of the current layer. - This variable is not available outside of <filename>layer.conf</filename> - and references are expanded immediately when parsing of the file completes. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LAYERRECOMMENDS'><glossterm>LAYERRECOMMENDS</glossterm> - <info> - LAYERRECOMMENDS[doc] = "Lists the layers, separated by spaces, recommended for use with this layer." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists the layers, separated by spaces, recommended for - use with this layer. - </para> - - <para> - 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: - <literallayout class='monospaced'> - LAYERRECOMMENDS_mylayer = "anotherlayer (=3)" - </literallayout> - In this previous example, version 3 of "anotherlayer" is - compared against - <filename>LAYERVERSION_anotherlayer</filename>. - </para> - - <para> - This variable is used in the - <filename>conf/layer.conf</filename> file and must be - suffixed with the name of the specific layer (e.g. - <filename>LAYERRECOMMENDS_mylayer</filename>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LAYERSERIES_COMPAT'><glossterm>LAYERSERIES_COMPAT</glossterm> - <info> - LAYERSERIES_COMPAT[doc] = "Lists the OpenEmbedded-Core versions for which a layer is compatible." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists the versions of the - <link linkend='oe-core'>OpenEmbedded-Core</link> for which - a layer is compatible. - Using the <filename>LAYERSERIES_COMPAT</filename> 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). - </para> - - <para> - To specify the OE-Core versions for which a layer is - compatible, use this variable in your layer's - <filename>conf/layer.conf</filename> configuration file. - For the list, use the Yocto Project - <ulink url='https://wiki.yoctoproject.org/wiki/Releases'>Release Name</ulink> - (e.g. &DISTRO_NAME_NO_CAP;). - To specify multiple OE-Core versions for the layer, - use a space-separated list: - <literallayout class='monospaced'> - LAYERSERIES_COMPAT_<replaceable>layer_root_name</replaceable> = "&DISTRO_NAME_NO_CAP; &DISTRO_NAME_NO_CAP_MINUS_ONE;" - </literallayout> - <note> - Setting <filename>LAYERSERIES_COMPAT</filename> 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. - </note> - </para> - - <para> - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-your-own-layer'>Creating Your Own Layer</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm> - <info> - LAYERVERSION[doc] = "Optionally specifies the version of a layer as a single number. This variable is used in the conf/layer.conf file and must be suffixed with the name of the specific layer." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Optionally specifies the version of a layer as a single number. - You can use this within - <link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link> - for another layer in order to depend on a specific version - of the layer. - This variable is used in the <filename>conf/layer.conf</filename> file - and must be suffixed with the name of the specific layer (e.g. - <filename>LAYERVERSION_mylayer</filename>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LD'><glossterm>LD</glossterm> - <info> - LD[doc] = "Minimal command and arguments to run the linker." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments used to run the - linker. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LDFLAGS'><glossterm>LDFLAGS</glossterm> - <info> - LDFLAGS[doc] = "Specifies the flags to pass to the linker." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the linker. - This variable is exported to an environment - variable and thus made visible to the software being - built during the compilation step. - </para> - - <para> - Default initialization for <filename>LDFLAGS</filename> - varies depending on what is being built: - <itemizedlist> - <listitem><para> - <link linkend='var-TARGET_LDFLAGS'><filename>TARGET_LDFLAGS</filename></link> - when building for the target - </para></listitem> - <listitem><para> - <link linkend='var-BUILD_LDFLAGS'><filename>BUILD_LDFLAGS</filename></link> - when building for the build host (i.e. - <filename>-native</filename>) - </para></listitem> - <listitem><para> - <link linkend='var-BUILDSDK_LDFLAGS'><filename>BUILDSDK_LDFLAGS</filename></link> - when building for an SDK (i.e. - <filename>nativesdk-</filename>) - </para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LEAD_SONAME'><glossterm>LEAD_SONAME</glossterm> - <info> - LEAD_SONAME[doc] = "Specifies the lead (or primary) compiled library file (i.e. .so) that the debian class applies its naming policy to given a recipe that packages multiple libraries." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the lead (or primary) compiled library file - (i.e. <filename>.so</filename>) that the - <link linkend='ref-classes-debian'><filename>debian</filename></link> - class applies its naming policy to given a recipe that - packages multiple libraries. - </para> - - <para> - This variable works in conjunction with the - <filename>debian</filename> class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm> - <info> - LIC_FILES_CHKSUM[doc] = "Checksums of the license text in the recipe source code." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Checksums of the license text in the recipe source code. - </para> - - <para> - This variable tracks changes in license text of the source - code files. - If the license text is changed, it will trigger a build - failure, which gives the developer an opportunity to review any - license change. - </para> - - <para> - This variable must be defined for all recipes (unless - <link linkend='var-LICENSE'><filename>LICENSE</filename></link> - is set to "CLOSED").</para> - <para>For more information, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-LIC_FILES_CHKSUM'>Tracking License Changes</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LICENSE'><glossterm>LICENSE</glossterm> - <info> - LICENSE[doc] = "The list of source licenses for the recipe. The logical operators &, '|', and parentheses can be used." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The list of source licenses for the recipe. - Follow these rules: - <itemizedlist> - <listitem><para>Do not use spaces within individual - license names.</para></listitem> - <listitem><para>Separate license names using - | (pipe) when there is a choice between licenses. - </para></listitem> - <listitem><para>Separate license names using - & (ampersand) when multiple licenses exist - that cover different parts of the source. - </para></listitem> - <listitem><para>You can use spaces between license - names.</para></listitem> - <listitem><para>For standard licenses, use the names - of the files in - <filename>meta/files/common-licenses/</filename> - or the - <link linkend='var-SPDXLICENSEMAP'><filename>SPDXLICENSEMAP</filename></link> - flag names defined in - <filename>meta/conf/licenses.conf</filename>. - </para></listitem> - </itemizedlist> - </para> - - <para> - Here are some examples: - <literallayout class='monospaced'> - LICENSE = "LGPLv2.1 | GPLv3" - LICENSE = "MPL-1 & LGPLv2.1" - LICENSE = "GPLv2+" - </literallayout> - The first example is from the recipes for Qt, which the user - may choose to distribute under either the LGPL version - 2.1 or GPL version 3. - The second example is from Cairo where two licenses cover - different parts of the source code. - The final example is from <filename>sysstat</filename>, - which presents a single license. - </para> - - <para> - You can also specify licenses on a per-package basis to - handle situations where components of the output have - different licenses. - For example, a piece of software whose code is - licensed under GPLv2 but has accompanying documentation - licensed under the GNU Free Documentation License 1.2 could - be specified as follows: - <literallayout class='monospaced'> - LICENSE = "GFDL-1.2 & GPLv2" - LICENSE_${PN} = "GPLv2" - LICENSE_${PN}-doc = "GFDL-1.2" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LICENSE_CREATE_PACKAGE'><glossterm>LICENSE_CREATE_PACKAGE</glossterm> - <info> - LICENSE_CREATE_PACKAGE[doc] = "Creates an extra package (i.e. ${PN}-lic) for each recipe and adds that package to the RRECOMMENDS+${PN}." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Setting <filename>LICENSE_CREATE_PACKAGE</filename> - to "1" causes the OpenEmbedded build system to create - an extra package (i.e. - <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}-lic</filename>) - for each recipe and to add those packages to the - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link><filename>_${PN}</filename>. - </para> - - <para> - The <filename>${PN}-lic</filename> package installs a - directory in <filename>/usr/share/licenses</filename> - named <filename>${PN}</filename>, which is the recipe's - base name, and installs files in that directory that - contain license and copyright information (i.e. copies of - the appropriate license files from - <filename>meta/common-licenses</filename> that match the - licenses specified in the - <link linkend='var-LICENSE'><filename>LICENSE</filename></link> - variable of the recipe metadata and copies of files marked - in - <link linkend='var-LIC_FILES_CHKSUM'><filename>LIC_FILES_CHKSUM</filename></link> - as containing license text). - </para> - - <para> - For related information on providing license text, see the - <link linkend='var-COPY_LIC_DIRS'><filename>COPY_LIC_DIRS</filename></link> - variable, the - <link linkend='var-COPY_LIC_MANIFEST'><filename>COPY_LIC_MANIFEST</filename></link> - variable, and the - "<ulink url='&YOCTO_DOCS_DEV_URL;#providing-license-text'>Providing License Text</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LICENSE_FLAGS'><glossterm>LICENSE_FLAGS</glossterm> - <info> - LICENSE_FLAGS[doc] = "Specifies additional flags for a recipe you must whitelist through LICENSE_FLAGS_WHITELIST in order to allow the recipe to be built." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies additional flags for a recipe you must - whitelist through - <link linkend='var-LICENSE_FLAGS_WHITELIST'><filename>LICENSE_FLAGS_WHITELIST</filename></link> - in order to allow the recipe to be built. - When providing multiple flags, separate them with - spaces. - </para> - - <para> - This value is independent of - <link linkend='var-LICENSE'><filename>LICENSE</filename></link> - and is typically used to mark recipes that might - require additional licenses in order to be used in a - commercial product. - For more information, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LICENSE_FLAGS_WHITELIST'><glossterm>LICENSE_FLAGS_WHITELIST</glossterm> - <info> - LICENSE_FLAGS_WHITELIST[doc] = "Lists license flags that when specified in LICENSE_FLAGS within a recipe should not prevent that recipe from being built." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists license flags that when specified in - <link linkend='var-LICENSE_FLAGS'><filename>LICENSE_FLAGS</filename></link> - within a recipe should not prevent that recipe from being - built. - This practice is otherwise known as "whitelisting" - license flags. - For more information, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#enabling-commercially-licensed-recipes'>Enabling Commercially Licensed Recipes</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LICENSE_PATH'><glossterm>LICENSE_PATH</glossterm> - <info> - LICENSE_PATH[doc] = "Path to additional licenses used during the build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Path to additional licenses used during the build. - By default, the OpenEmbedded build system uses <filename>COMMON_LICENSE_DIR</filename> - to define the directory that holds common license text used during the build. - The <filename>LICENSE_PATH</filename> variable allows you to extend that - location to other areas that have additional licenses: - <literallayout class='monospaced'> - LICENSE_PATH += "<replaceable>path-to-additional-common-licenses</replaceable>" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LINUX_KERNEL_TYPE'><glossterm>LINUX_KERNEL_TYPE</glossterm> - <info> - LINUX_KERNEL_TYPE[doc] = "Defines the kernel type to be used in assembling the configuration." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the kernel type to be used in assembling the - configuration. - The linux-yocto recipes define "standard", "tiny", and - "preempt-rt" kernel types. - See the - "<ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;#kernel-types'>Kernel Types</ulink>" - section in the Yocto Project Linux Kernel Development - Manual for more information on kernel types. - </para> - - <para> - If you do not specify a - <filename>LINUX_KERNEL_TYPE</filename>, it defaults to - "standard". - Together with - <link linkend='var-KMACHINE'><filename>KMACHINE</filename></link>, - the <filename>LINUX_KERNEL_TYPE</filename> variable - defines the search - arguments used by the kernel tools to find the appropriate - description within the kernel - <link linkend='metadata'>Metadata</link> - with which to build out the sources and configuration. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LINUX_VERSION'><glossterm>LINUX_VERSION</glossterm> - <info> - LINUX_VERSION[doc] = "The Linux version from kernel.org on which the Linux kernel image being built using the OpenEmbedded build system is based. You define this variable in the kernel recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The Linux version from <filename>kernel.org</filename> - on which the Linux kernel image being built using the - OpenEmbedded build system is based. - You define this variable in the kernel recipe. - For example, the <filename>linux-yocto-3.4.bb</filename> - kernel recipe found in - <filename>meta/recipes-kernel/linux</filename> - defines the variables as follows: - <literallayout class='monospaced'> - LINUX_VERSION ?= "3.4.24" - </literallayout> - </para> - - <para> - The <filename>LINUX_VERSION</filename> variable is used to - define <link linkend='var-PV'><filename>PV</filename></link> - for the recipe: - <literallayout class='monospaced'> - PV = "${LINUX_VERSION}+git${SRCPV}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LINUX_VERSION_EXTENSION'><glossterm>LINUX_VERSION_EXTENSION</glossterm> - <info> - LINUX_VERSION_EXTENSION[doc] = "A string extension compiled into the version string of the Linux kernel built with the OpenEmbedded build system. You define this variable in the kernel recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A string extension compiled into the version - string of the Linux kernel built with the OpenEmbedded - build system. - You define this variable in the kernel recipe. - For example, the linux-yocto kernel recipes all define - the variable as follows: - <literallayout class='monospaced'> - LINUX_VERSION_EXTENSION ?= "-yocto-${<link linkend='var-LINUX_KERNEL_TYPE'>LINUX_KERNEL_TYPE</link>}" - </literallayout> - </para> - - <para> - Defining this variable essentially sets the - Linux kernel configuration item - <filename>CONFIG_LOCALVERSION</filename>, which is visible - through the <filename>uname</filename> command. - Here is an example that shows the extension assuming it - was set as previously shown: - <literallayout class='monospaced'> - $ uname -r - 3.7.0-rc8-custom - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-LOG_DIR'><glossterm>LOG_DIR</glossterm> - <info> - LOG_DIR[doc] = "Specifies the directory to which the OpenEmbedded build system writes overall log files. The default directory is ${TMPDIR}/log" - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the directory to which the OpenEmbedded build - system writes overall log files. - The default directory is <filename>${TMPDIR}/log</filename>. - </para> - - <para> - For the directory containing logs specific to each task, - see the <link linkend='var-T'><filename>T</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-m'><title>M</title> - - <glossentry id='var-MACHINE'><glossterm>MACHINE</glossterm> - <info> - MACHINE[doc] = "Specifies the target device for which the image is built. You define MACHINE in the conf/local.conf file in the Build Directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the target device for which the image is built. - You define <filename>MACHINE</filename> in the - <filename>local.conf</filename> file found in the - <link linkend='build-directory'>Build Directory</link>. - By default, <filename>MACHINE</filename> is set to - "qemux86", which is an x86-based architecture machine to - be emulated using QEMU: - <literallayout class='monospaced'> - MACHINE ?= "qemux86" - </literallayout> - </para> - - <para> - The variable corresponds to a machine configuration file of the - same name, through which machine-specific configurations are set. - Thus, when <filename>MACHINE</filename> is set to "qemux86" there - exists the corresponding <filename>qemux86.conf</filename> machine - configuration file, which can be found in the - <link linkend='source-directory'>Source Directory</link> - in <filename>meta/conf/machine</filename>. - </para> - - <para> - The list of machines supported by the Yocto Project as - shipped include the following: - <literallayout class='monospaced'> - MACHINE ?= "qemuarm" - MACHINE ?= "qemuarm64" - MACHINE ?= "qemumips" - MACHINE ?= "qemumips64" - MACHINE ?= "qemuppc" - MACHINE ?= "qemux86" - MACHINE ?= "qemux86-64" - MACHINE ?= "genericx86" - MACHINE ?= "genericx86-64" - MACHINE ?= "beaglebone" - MACHINE ?= "mpc8315e-rdb" - MACHINE ?= "edgerouter" - </literallayout> - The last five are Yocto Project reference hardware boards, which - are provided in the <filename>meta-yocto-bsp</filename> layer. - <note>Adding additional Board Support Package (BSP) layers - to your configuration adds new possible settings for - <filename>MACHINE</filename>. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MACHINE_ARCH'><glossterm>MACHINE_ARCH</glossterm> - <info> - MACHINE_ARCH[doc] = "Specifies the name of the machine-specific architecture. This variable is set automatically from MACHINE or TUNE_PKGARCH." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the name of the machine-specific architecture. - This variable is set automatically from - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - or - <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link>. - You should not hand-edit the - <filename>MACHINE_ARCH</filename> variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</glossterm> - <info> - MACHINE_ESSENTIAL_EXTRA_RDEPENDS[doc] = "A list of required machine-specific packages to install as part of the image being built. Because this is a 'machine-essential' variable, the list of packages are essential for the machine to boot." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of required machine-specific packages to install as part of - the image being built. - The build process depends on these packages being present. - Furthermore, because this is a "machine-essential" variable, the list of - packages are essential for the machine to boot. - The impact of this variable affects images based on - <filename>packagegroup-core-boot</filename>, - including the <filename>core-image-minimal</filename> image. - </para> - - <para> - This variable is similar to the - <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename> - variable with the exception that the image being built has a build - dependency on the variable's list of packages. - In other words, the image will not build if a file in this list is not found. - </para> - - <para> - As an example, suppose the machine for which you are building requires - <filename>example-init</filename> to be run during boot to initialize the hardware. - In this case, you would use the following in the machine's - <filename>.conf</filename> configuration file: - <literallayout class='monospaced'> - MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><glossterm>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</glossterm> - <info> - MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS[doc] = "A list of recommended machine-specific packages to install as part of the image being built. Because this is a 'machine-essential' variable, the list of packages are essential for the machine to boot." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of recommended machine-specific packages to install as part of - the image being built. - The build process does not depend on these packages being present. - However, because this is a "machine-essential" variable, the list of - packages are essential for the machine to boot. - The impact of this variable affects images based on - <filename>packagegroup-core-boot</filename>, - including the <filename>core-image-minimal</filename> image. - </para> - - <para> - This variable is similar to the - <filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS</link></filename> - variable with the exception that the image being built does not have a build - dependency on the variable's list of packages. - In other words, the image will still build if a package in this list is not found. - Typically, this variable is used to handle essential kernel modules, whose - functionality may be selected to be built into the kernel rather than as a module, - in which case a package will not be produced. - </para> - - <para> - Consider an example where you have a custom kernel where a specific touchscreen - driver is required for the machine to be usable. - However, the driver can be built as a module or - into the kernel depending on the kernel configuration. - If the driver is built as a module, you want it to be installed. - But, when the driver is built into the kernel, you still want the - build to succeed. - This variable sets up a "recommends" relationship so that in the latter case, - the build will not fail due to the missing package. - To accomplish this, assuming the package for the module was called - <filename>kernel-module-ab123</filename>, you would use the - following in the machine's <filename>.conf</filename> configuration - file: - <literallayout class='monospaced'> - MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123" - </literallayout> - <note> - In this example, the - <filename>kernel-module-ab123</filename> recipe - needs to explicitly set its - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> - variable to ensure that BitBake does not use the - kernel recipe's - <link linkend='var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></link> - variable to satisfy the dependency. - </note> - </para> - - <para> - Some examples of these machine essentials are flash, screen, keyboard, mouse, - or touchscreen drivers (depending on the machine). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MACHINE_EXTRA_RDEPENDS'><glossterm>MACHINE_EXTRA_RDEPENDS</glossterm> - <info> - MACHINE_EXTRA_RDEPENDS[doc] = "A list of machine-specific packages to install as part of the image being built that are not essential for the machine to boot. However, the build process for more fully-featured images depends on the packages being present." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of machine-specific packages to install as part of the - image being built that are not essential for the machine to boot. - However, the build process for more fully-featured images - depends on the packages being present. - </para> - - <para> - This variable affects all images based on - <filename>packagegroup-base</filename>, which does not include the - <filename>core-image-minimal</filename> or <filename>core-image-full-cmdline</filename> - images. - </para> - - <para> - The variable is similar to the - <filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS</link></filename> - variable with the exception that the image being built has a build - dependency on the variable's list of packages. - In other words, the image will not build if a file in this list is not found. - </para> - - <para> - An example is a machine that has WiFi capability but is not - essential for the machine to boot the image. - However, if you are building a more fully-featured image, you want to enable - the WiFi. - The package containing the firmware for the WiFi hardware is always - expected to exist, so it is acceptable for the build process to depend upon - finding the package. - In this case, assuming the package for the firmware was called - <filename>wifidriver-firmware</filename>, you would use the following in the - <filename>.conf</filename> file for the machine: - <literallayout class='monospaced'> - MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MACHINE_EXTRA_RRECOMMENDS'><glossterm>MACHINE_EXTRA_RRECOMMENDS</glossterm> - <info> - MACHINE_EXTRA_RRECOMMENDS[doc] = "A list of machine-specific packages to install as part of the image being built that are not essential for booting the machine. The image being built has no build dependencies on the packages in this list." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of machine-specific packages to install as part of the - image being built that are not essential for booting the machine. - The image being built has no build dependency on this list of packages. - </para> - - <para> - This variable affects only images based on - <filename>packagegroup-base</filename>, which does not include the - <filename>core-image-minimal</filename> or <filename>core-image-full-cmdline</filename> - images. - </para> - - <para> - This variable is similar to the - <filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS</link></filename> - variable with the exception that the image being built does not have a build - dependency on the variable's list of packages. - In other words, the image will build if a file in this list is not found. - </para> - - <para> - An example is a machine that has WiFi capability but is not essential - For the machine to boot the image. - However, if you are building a more fully-featured image, you want to enable - WiFi. - In this case, the package containing the WiFi kernel module will not be produced - if the WiFi driver is built into the kernel, in which case you still want the - build to succeed instead of failing as a result of the package not being found. - To accomplish this, assuming the package for the module was called - <filename>kernel-module-examplewifi</filename>, you would use the - following in the <filename>.conf</filename> file for the machine: - <literallayout class='monospaced'> - MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MACHINE_FEATURES'><glossterm>MACHINE_FEATURES</glossterm> - <info> - MACHINE_FEATURES[doc] = "Specifies the list of hardware features the MACHINE supports." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the list of hardware features the - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> is capable - of supporting. - For related information on enabling features, see the - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>, - <link linkend='var-COMBINED_FEATURES'><filename>COMBINED_FEATURES</filename></link>, - and - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> - variables. - </para> - - <para> - For a list of hardware features supported by the Yocto - Project as shipped, see the - "<link linkend='ref-features-machine'>Machine Features</link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MACHINE_FEATURES_BACKFILL'><glossterm>MACHINE_FEATURES_BACKFILL</glossterm> - <info> - MACHINE_FEATURES_BACKFILL[doc] = "Features to be added to MACHINE_FEATURES if not also present in MACHINE_FEATURES_BACKFILL_CONSIDERED. This variable is set in the meta/conf/bitbake.conf file and is not intended to be user-configurable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Features to be added to - <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename> - if not also present in - <filename><link linkend='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'>MACHINE_FEATURES_BACKFILL_CONSIDERED</link></filename>. - </para> - - <para> - This variable is set in the <filename>meta/conf/bitbake.conf</filename> file. - It is not intended to be user-configurable. - It is best to just reference the variable to see which machine features are - being backfilled for all machine configurations. - See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for - more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MACHINE_FEATURES_BACKFILL_CONSIDERED'><glossterm>MACHINE_FEATURES_BACKFILL_CONSIDERED</glossterm> - <info> - MACHINE_FEATURES_BACKFILL_CONSIDERED[doc] = "Features from MACHINE_FEATURES_BACKFILL that should not be backfilled (i.e. added to MACHINE_FEATURES) during the build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Features from - <filename><link linkend='var-MACHINE_FEATURES_BACKFILL'>MACHINE_FEATURES_BACKFILL</link></filename> - that should not be backfilled (i.e. added to - <filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link></filename>) - during the build. - See the "<link linkend='ref-features-backfill'>Feature Backfilling</link>" section for - more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MACHINEOVERRIDES'><glossterm>MACHINEOVERRIDES</glossterm> - <info> - MACHINEOVERRIDES[doc] = "A colon-separated list of overrides that apply to the current machine." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A colon-separated list of overrides that apply to the - current machine. - By default, this list includes the value of - <link linkend='var-MACHINE'><filename>MACHINE</filename></link>. - </para> - - <para> - You can extend <filename>MACHINEOVERRIDES</filename> - to add extra overrides that should apply to a machine. - For example, all machines emulated in QEMU (e.g. - <filename>qemuarm</filename>, <filename>qemux86</filename>, - and so forth) include a file named - <filename>meta/conf/machine/include/qemu.inc</filename> - that prepends the following override to - <filename>MACHINEOVERRIDES</filename>: - <literallayout class='monospaced'> - MACHINEOVERRIDES =. "qemuall:" - </literallayout> - This override allows variables to be overriden for all - machines emulated in QEMU, like in the following example - from the <filename>connman-conf</filename> recipe: - <literallayout class='monospaced'> - SRC_URI_append_qemuall = "file://wired.config \ - file://wired-setup \ - " - </literallayout> - The underlying mechanism behind - <filename>MACHINEOVERRIDES</filename> is simply that it is - included in the default value of - <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MAINTAINER'><glossterm>MAINTAINER</glossterm> - <info> - MAINTAINER[doc] = "The email address of the distribution maintainer." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The email address of the distribution maintainer. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MIRRORS'><glossterm>MIRRORS</glossterm> - <info> - MIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies additional paths from which the OpenEmbedded - build system gets source code. - When the build system searches for source code, it first - tries the local download directory. - If that location fails, the build system tries locations - defined by - <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link>, - the upstream source, and then locations specified by - <filename>MIRRORS</filename> in that order. - </para> - - <para> - Assuming your distribution - (<link linkend='var-DISTRO'><filename>DISTRO</filename></link>) - is "poky", the default value for - <filename>MIRRORS</filename> is defined in the - <filename>conf/distro/poky.conf</filename> file in the - <filename>meta-poky</filename> Git repository. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MLPREFIX'><glossterm>MLPREFIX</glossterm> - <info> - MLPREFIX[doc] = "Specifies a prefix has been added to PN to create a special version of a recipe or package (i.e. a Multilib version)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a prefix has been added to - <link linkend='var-PN'><filename>PN</filename></link> to create a special version - of a recipe or package (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 - <link linkend='var-BPN'><filename>BPN</filename></link> variable). - <filename>MLPREFIX</filename> gets set when a prefix has been - added to <filename>PN</filename>. - <note> - The "ML" in <filename>MLPREFIX</filename> stands for - "MultiLib". - This representation is historical and comes from - a time when <filename>nativesdk</filename> was a suffix - rather than a prefix on the recipe name. - When <filename>nativesdk</filename> was turned into a - prefix, it made sense to set - <filename>MLPREFIX</filename> for it as well. - </note> - </para> - - <para> - To help understand when <filename>MLPREFIX</filename> - might be needed, consider when - <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> - is used to provide a <filename>nativesdk</filename> version - of a recipe in addition to the target version. - If that recipe declares build-time dependencies on tasks in - other recipes by using - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>, - 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: - <literallayout class='monospaced'> - do_foo[depends] += "<replaceable>recipe</replaceable>:do_foo" - </literallayout> - If you want such a dependency to also get transformed, - you can do the following: - <literallayout class='monospaced'> - do_foo[depends] += "${MLPREFIX}<replaceable>recipe</replaceable>:do_foo" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-module_autoload'><glossterm>module_autoload</glossterm> - <info> - module_autoload[doc] = "This variable has been replaced by the KERNEL_MODULE_AUTOLOAD variable. You should replace all occurrences of module_autoload with additions to KERNEL_MODULE_AUTOLOAD." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable has been replaced by the - <filename>KERNEL_MODULE_AUTOLOAD</filename> variable. - You should replace all occurrences of - <filename>module_autoload</filename> with additions to - <filename>KERNEL_MODULE_AUTOLOAD</filename>, for example: - <literallayout class='monospaced'> - module_autoload_rfcomm = "rfcomm" - </literallayout> - </para> - - <para> - should now be replaced with: - <literallayout class='monospaced'> - KERNEL_MODULE_AUTOLOAD += "rfcomm" - </literallayout> - See the - <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-module_conf'><glossterm>module_conf</glossterm> - <info> - module_conf[doc] = "Specifies modprobe.d syntax lines for inclusion in the /etc/modprobe.d/modname.conf file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies - <ulink url='http://linux.die.net/man/5/modprobe.d'><filename>modprobe.d</filename></ulink> - syntax lines for inclusion in the - <filename>/etc/modprobe.d/modname.conf</filename> file. - </para> - - <para> - You can use this variable anywhere that it can be - recognized by the kernel recipe or out-of-tree kernel - module recipe (e.g. a machine configuration file, a - distribution configuration file, an append file for the - recipe, or the recipe itself). - If you use this variable, you must also be sure to list - the module name in the - <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> - variable. - </para> - - <para> - Here is the general syntax: - <literallayout class='monospaced'> - module_conf_<replaceable>module_name</replaceable> = "<replaceable>modprobe.d-syntax</replaceable>" - </literallayout> - You must use the kernel module name override. - </para> - - <para> - Run <filename>man modprobe.d</filename> in the shell to - find out more information on the exact syntax - you want to provide with <filename>module_conf</filename>. - </para> - - <para> - Including <filename>module_conf</filename> causes the - OpenEmbedded build system to populate the - <filename>/etc/modprobe.d/modname.conf</filename> - file with <filename>modprobe.d</filename> syntax lines. - Here is an example that adds the options - <filename>arg1</filename> and <filename>arg2</filename> - to a module named <filename>mymodule</filename>: - <literallayout class='monospaced'> - module_conf_mymodule = "options mymodule arg1=val1 arg2=val2" - </literallayout> - </para> - - <para> - For information on how to specify kernel modules to - auto-load on boot, see the - <link linkend='var-KERNEL_MODULE_AUTOLOAD'><filename>KERNEL_MODULE_AUTOLOAD</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MODULE_TARBALL_DEPLOY'><glossterm>MODULE_TARBALL_DEPLOY</glossterm> - <info> - MODULE_TARBALL_DEPLOY[doc] = "Controls creation of the modules-*.tgz file. Set this variable to "0" to disable creation of this file, which contains all of the kernel modules resulting from a kernel build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Controls creation of the <filename>modules-*.tgz</filename> - file. - Set this variable to "0" to disable creation of this - file, which contains all of the kernel modules resulting - from a kernel build. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MODULE_TARBALL_LINK_NAME'><glossterm>MODULE_TARBALL_LINK_NAME</glossterm> - <info> - MODULE_TARBALL_LINK_NAME[doc] = "The link name of the kernel module tarball." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The link name of the kernel module tarball. - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" - </literallayout> - The value of the <filename>KERNEL_ARTIFACT_LINK_NAME</filename> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" - </literallayout> - </para> - - <para> - See the - <link linkend='var-MACHINE'><filename>MACHINE</filename></link> - variable for additional information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-MODULE_TARBALL_NAME'><glossterm>MODULE_TARBALL_NAME</glossterm> - <info> - MODULE_TARBALL_NAME[doc] = "The base name of the kernel module tarball." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The base name of the kernel module tarball. - This variable is set in the - <filename>meta/classes/kernel-artifact-names.bbclass</filename> - file as follows: - <literallayout class='monospaced'> - MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" - </literallayout> - The value of the - <link linkend='var-KERNEL_ARTIFACT_NAME'><filename>KERNEL_ARTIFACT_NAME</filename></link> - variable, which is set in the same file, has the following - value: - <literallayout class='monospaced'> - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" - </literallayout> - </para> - </glossdef> - </glossentry> - -<!-- - <glossentry id='var-MULTIMACH_HOST_SYS'><glossterm>MULTIMACH_HOST_SYS</glossterm> - <info> - MULTIMACH_HOST_SYS[doc] = "Separates files for different machines such that you can build for multiple host machines using the same output directories." - </info> - <glossdef> - <para role="glossdeffirst"> ---> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> -<!-- - Serves the same purpose as - <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>, - but for the "HOST" system, in situations that involve a - "HOST" and a "TARGET" system. - See the - <link linkend='var-STAGING_DIR_TARGET'><filename>STAGING_DIR_TARGET</filename></link> - variable for more information. - </para> - - <para> - The default value of this variable is: - <literallayout class='monospaced'> - ${PACKAGE_ARCH}${HOST_VENDOR}-${HOST_OS} - </literallayout> - </para> - </glossdef> - </glossentry> ---> - - <glossentry id='var-MULTIMACH_TARGET_SYS'><glossterm>MULTIMACH_TARGET_SYS</glossterm> - <info> - MULTIMACH_TARGET_SYS[doc] = "Separates files for different machines such that you can build for multiple target machines using the same output directories." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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. - </para> - - <para> - The default value of this variable is: - <literallayout class='monospaced'> - ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} - </literallayout> - Some classes (e.g. - <link linkend='ref-classes-cross-canadian'><filename>cross-canadian</filename></link>) - modify the <filename>MULTIMACH_TARGET_SYS</filename> value. - </para> - - <para> - See the - <link linkend='var-STAMP'><filename>STAMP</filename></link> - variable for an example. - See the - <link linkend='var-STAGING_DIR_TARGET'><filename>STAGING_DIR_TARGET</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-n'><title>N</title> - - <glossentry id='var-NATIVELSBSTRING'><glossterm>NATIVELSBSTRING</glossterm> - <info> - NATIVELSBSTRING[doc] = "A string identifying the host distribution." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A string identifying the host distribution. - Strings consist of the host distributor ID - followed by the release, as reported by the - <filename>lsb_release</filename> tool - or as read from <filename>/etc/lsb-release</filename>. - For example, when running a build on Ubuntu 12.10, the value - is "Ubuntu-12.10". - If this information is unable to be determined, the value - resolves to "Unknown". - </para> - - <para> - This variable is used by default to isolate native shared - state packages for different distributions (e.g. to avoid - problems with <filename>glibc</filename> version - incompatibilities). - Additionally, the variable is checked against - <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link> - if that variable is set. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-NM'><glossterm>NM</glossterm> - <info> - NM[doc] = "Minimal command and arguments to run 'nm'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments to run - <filename>nm</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-NO_GENERIC_LICENSE'><glossterm>NO_GENERIC_LICENSE</glossterm> - <info> - NO_GENERIC_LICENSE[doc] = "Used to allow copying a license that does not exist in common licenses." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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. - <filename>NO_GENERIC_LICENSE</filename> is used to allow - copying a license that does not exist in common licenses. - </para> - - <para> - The following example shows how to add - <filename>NO_GENERIC_LICENSE</filename> to a recipe: - <literallayout class='monospaced'> - NO_GENERIC_LICENSE[<replaceable>license_name</replaceable>] = "<replaceable>license_file_in_fetched_source</replaceable>" - </literallayout> - The following is an example that uses the - <filename>LICENSE.Abilis.txt</filename> file as the license - from the fetched source: - <literallayout class='monospaced'> - NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-NO_RECOMMENDATIONS'><glossterm>NO_RECOMMENDATIONS</glossterm> - <info> - NO_RECOMMENDATIONS[doc] = "When set to '1', no recommended packages will be installed. Some recommended packages might be required for certain system functionality, such as kernel-modules. It is up to the user to add packages to IMAGE_INSTALL as needed." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Prevents installation of all "recommended-only" packages. - Recommended-only packages are packages installed only - through the - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> - variable). - Setting the <filename>NO_RECOMMENDATIONS</filename> variable - to "1" turns this feature on: - <literallayout class='monospaced'> - NO_RECOMMENDATIONS = "1" - </literallayout> - </para> - - <para> - You can set this variable globally in your - <filename>local.conf</filename> file or you can attach it to - a specific image recipe by using the recipe name override: - <literallayout class='monospaced'> - NO_RECOMMENDATIONS_pn-<replaceable>target_image</replaceable> = "1" - </literallayout> - </para> - - <para> - It is important to realize that if you choose to not install - packages using this variable and some other packages are - dependent on them (i.e. listed in a recipe's - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> - variable), the OpenEmbedded build system ignores your - request and will install the packages to avoid dependency - errors. - <note> - Some recommended packages might be required for certain - system functionality, such as kernel modules. - It is up to you to add packages with the - <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link> - variable. - </note> - </para> - - <para> - Support for this variable exists only when using the - IPK and RPM packaging backend. - Support does not exist for DEB. - </para> - - <para> - See the - <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link> - and the - <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link> - variables for related information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-NOAUTOPACKAGEDEBUG'><glossterm>NOAUTOPACKAGEDEBUG</glossterm> - <info> - NOAUTOPACKAGEDEBUG[doc] = "Disables auto package from splitting .debug files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Disables auto package from splitting - <filename>.debug</filename> files. If a recipe requires - <filename>FILES_${PN}-dbg</filename> to be set manually, - the <filename>NOAUTOPACKAGEDEBUG</filename> can be defined - allowing you to define the content of the debug package. - For example: - <literallayout class='monospaced'> - 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" - </literallayout> - </para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id='var-glossary-o'><title>O</title> - - <glossentry id='var-OBJCOPY'><glossterm>OBJCOPY</glossterm> - <info> - OBJCOPY[doc] = "Minimal command and arguments to run 'objcopy'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments to run - <filename>objcopy</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-OBJDUMP'><glossterm>OBJDUMP</glossterm> - <info> - OBJDUMP[doc] = "Minimal command and arguments to run 'objdump'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments to run - <filename>objdump</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-OE_BINCONFIG_EXTRA_MANGLE'><glossterm>OE_BINCONFIG_EXTRA_MANGLE</glossterm> - <info> - OE_BINCONFIG_EXTRA_MANGLE[doc] = "When a recipe inherits the binconfig.bbclass class, this variable specifies additional arguments passed to the "sed" command." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-binconfig'><filename>binconfig</filename></link> - class, this variable - specifies additional arguments passed to the "sed" command. - The sed command alters any paths in configuration scripts - that have been set up during compilation. - Inheriting this class results in all paths in these scripts - being changed to point into the - <filename>sysroots/</filename> directory so that all builds - that use the script will use the correct directories - for the cross compiling layout. - </para> - - <para> - See the <filename>meta/classes/binconfig.bbclass</filename> - in the - <link linkend='source-directory'>Source Directory</link> - for details on how this class applies these additional - sed command arguments. - For general information on the - <filename>binconfig</filename> class, see the - "<link linkend='ref-classes-binconfig'><filename>binconfig.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-OE_IMPORTS'><glossterm>OE_IMPORTS</glossterm> - <info> - OE_IMPORTS[doc] = "An internal variable used to tell the OpenEmbedded build system what Python modules to import for every Python function run by the system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - An internal variable used to tell the OpenEmbedded build - system what Python modules to import for every Python - function run by the system. - </para> - - <note> - Do not set this variable. - It is for internal use only. - </note> - </glossdef> - </glossentry> - - <glossentry id='var-OE_INIT_ENV_SCRIPT'><glossterm>OE_INIT_ENV_SCRIPT</glossterm> - <info> - OE_INIT_ENV_SCRIPT[doc] = "The name of the build environment setup script for the purposes of setting up the environment within the extensible SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The name of the build environment setup script for the - purposes of setting up the environment within the - extensible SDK. - The default value is "oe-init-build-env". - </para> - - <para> - If you use a custom script to set up your build - environment, set the - <filename>OE_INIT_ENV_SCRIPT</filename> variable to its - name. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm> - <info> - OE_TERMINAL[doc] = "Controls how the OpenEmbedded build system spawns interactive terminals on the host development system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Controls how the OpenEmbedded build system spawns - interactive terminals on the host development system - (e.g. using the BitBake command with the - <filename>-c devshell</filename> command-line option). - For more information, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section - in the Yocto Project Development Tasks Manual. - </para> - - <para> - You can use the following values for the - <filename>OE_TERMINAL</filename> variable: - <literallayout class='monospaced'> - auto - gnome - xfce - rxvt - screen - konsole - none - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-OEROOT'><glossterm>OEROOT</glossterm> - <info> - OEROOT[doc] = "The directory from which the top-level build environment setup script is sourced." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The directory from which the top-level build environment - setup script is sourced. - The Yocto Project provides a top-level build environment - setup script: - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>. - When you run this script, the - <filename>OEROOT</filename> variable resolves to the - directory that contains the script. - </para> - - <para> - For additional information on how this variable is used, - see the initialization script. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-OLDEST_KERNEL'><glossterm>OLDEST_KERNEL</glossterm> - <info> - OLDEST_KERNEL[doc] = "Declares the oldest version of the Linux kernel that the produced binaries must support." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Declares the oldest version of the Linux kernel that the - produced binaries must support. - This variable is passed into the build of the Embedded - GNU C Library (<filename>glibc</filename>). - </para> - - <para> - The default for this variable comes from the - <filename>meta/conf/bitbake.conf</filename> configuration - file. - You can override this default by setting the variable - in a custom distribution configuration file. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-OVERRIDES'><glossterm>OVERRIDES</glossterm> - <info> - OVERRIDES[doc] = "A colon-separated list of overrides that currently apply." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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 <filename>OVERRIDES</filename> - represents the "state" during building, which includes - the current recipe being built, the machine for which - it is being built, and so forth. - </para> - - <para> - As an example, if the string "an-override" appears as an - element in the colon-separated list in - <filename>OVERRIDES</filename>, then the following - assignment will override <filename>FOO</filename> with the - value "overridden" at the end of parsing: - <literallayout class='monospaced'> - FOO_an-override = "overridden" - </literallayout> - See the - "<ulink url='&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides'>Conditional Syntax (Overrides)</ulink>" - section in the BitBake User Manual for more information on - the overrides mechanism. - </para> - - <para> - The default value of <filename>OVERRIDES</filename> - includes the values of the - <link linkend='var-CLASSOVERRIDE'><filename>CLASSOVERRIDE</filename></link>, - <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>, - and - <link linkend='var-DISTROOVERRIDES'><filename>DISTROOVERRIDES</filename></link> - variables. - Another important override included by default is - <filename>pn-${PN}</filename>. - This override allows variables to be set for a single - recipe within configuration (<filename>.conf</filename>) - files. - Here is an example: - <literallayout class='monospaced'> - FOO_pn-myrecipe = "myrecipe-specific value" - </literallayout> - <note><title>Tip</title> - An easy way to see what overrides apply is to search for - <filename>OVERRIDES</filename> in the output of the - <filename>bitbake -e</filename> command. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#dev-debugging-viewing-variable-values'>Viewing Variable Values</ulink>" - section in the Yocto Project Development Tasks - Manual for more information. - </note> - </para> - </glossdef> - </glossentry> - </glossdiv> - - <glossdiv id='var-glossary-p'><title>P</title> - - <glossentry id='var-P'><glossterm>P</glossterm> - <info> - P[doc] = "The recipe name and version. P is comprised of ${PN}-${PV}." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The recipe name and version. - <filename>P</filename> is comprised of the following: - <literallayout class='monospaced'> - ${PN}-${PV} - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_ARCH'><glossterm>PACKAGE_ARCH</glossterm> - <info> - PACKAGE_ARCH[doc] = "The architecture of the resulting package or packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The architecture of the resulting package or packages. - </para> - - <para> - By default, the value of this variable is set to - <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link> - when building for the target, - <link linkend='var-BUILD_ARCH'><filename>BUILD_ARCH</filename></link> - when building for the - build host, and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building - for the SDK. - <note> - See - <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link> - for more information. - </note> - 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 - <filename>PACKAGE_ARCH</filename> to the value of - <link linkend='var-MACHINE_ARCH'><filename>MACHINE_ARCH</filename></link> - in the recipe as follows: - <literallayout class='monospaced'> - PACKAGE_ARCH = "${MACHINE_ARCH}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_ARCHS'><glossterm>PACKAGE_ARCHS</glossterm> - <info> - PACKAGE_ARCHS[doc] = "A list of architectures compatible with the given target in order of priority." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of architectures compatible with - the target machine. - This variable is set automatically and should not - normally be hand-edited. - Entries are separated using spaces and listed in order - of priority. - The default value for - <filename>PACKAGE_ARCHS</filename> is "all any noarch - ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_BEFORE_PN'><glossterm>PACKAGE_BEFORE_PN</glossterm> - <info> - PACKAGE_BEFORE_PN[doc] = "Enables easily adding packages to PACKAGES before ${PN} so that the packages can pick up files that would normally be included in the default package." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Enables easily adding packages to - <filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> - before <filename>${<link linkend='var-PN'>PN</link>}</filename> - so that those added packages can pick up files that would normally be - included in the default package. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_CLASSES'><glossterm>PACKAGE_CLASSES</glossterm> - <info> - PACKAGE_CLASSES[doc] = "This variable specifies the package manager to use when packaging data. It is set in the conf/local.conf file in the Build Directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable, which is set in the - <filename>local.conf</filename> configuration file found in - the <filename>conf</filename> folder of the - <link linkend='build-directory'>Build Directory</link>, - specifies the package manager the OpenEmbedded build system - uses when packaging data. - </para> - - <para> - You can provide one or more of the following arguments for - the variable: - <literallayout class='monospaced'> - PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk package_tar" - </literallayout> - <note><title>Warning</title> - While it is a legal option, the - <filename>package_tar</filename> class has limited - functionality due to no support for package - dependencies by that backend. - Therefore, it is recommended that you do not use it. - </note> - The build system uses only the first argument in the list - as the package manager when creating your image or SDK. - However, packages will be created using any additional - packaging classes you specify. - For example, if you use the following in your - <filename>local.conf</filename> file: - <literallayout class='monospaced'> - PACKAGE_CLASSES ?= "package_ipk" - </literallayout> - The OpenEmbedded build system uses the IPK package manager - to create your image or SDK. - </para> - - <para> - For information on packaging and build performance effects - as a result of the package manager in use, see the - "<link linkend='ref-classes-package'><filename>package.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_DEBUG_SPLIT_STYLE'><glossterm>PACKAGE_DEBUG_SPLIT_STYLE</glossterm> - <info> - PACKAGE_DEBUG_SPLIT_STYLE[doc] = "Determines how to split up the binary and debug information when creating *-dbg packages to be used with the GNU Project Debugger (GDB)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Determines how to split up the binary and debug information - when creating <filename>*-dbg</filename> packages to be - used with the GNU Project Debugger (GDB). - </para> - - <para> - With the - <filename>PACKAGE_DEBUG_SPLIT_STYLE</filename> variable, - you can control where debug information, which can include - or exclude source files, is stored: - <itemizedlist> - <listitem><para> - ".debug": Debug symbol files are placed next - to the binary in a <filename>.debug</filename> - directory on the target. - For example, if a binary is installed into - <filename>/bin</filename>, the corresponding debug - symbol files are installed in - <filename>/bin/.debug</filename>. - Source files are placed in - <filename>/usr/src/debug</filename>. - </para></listitem> - <listitem><para> - "debug-file-directory": Debug symbol files are - placed under <filename>/usr/lib/debug</filename> - on the target, and separated by the path from where - the binary is installed. - For example, if a binary is installed in - <filename>/bin</filename>, the corresponding debug - symbols are installed in - <filename>/usr/lib/debug/bin</filename>. - Source files are placed in - <filename>/usr/src/debug</filename>. - </para></listitem> - <listitem><para> - "debug-without-src": The same behavior as - ".debug" previously described with the exception - that no source files are installed. - </para></listitem>. - <listitem><para> - "debug-with-srcpkg": The same behavior as - ".debug" previously described with the exception - that all source files are placed in a separate - <filename>*-src</filename> pkg. - This is the default behavior. - </para></listitem> - </itemizedlist> - </para> - - <para> - You can find out more about debugging using GDB by reading - the - "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug'>Debugging With the GNU Project Debugger (GDB) Remotely</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_EXCLUDE_COMPLEMENTARY'><glossterm>PACKAGE_EXCLUDE_COMPLEMENTARY</glossterm> - <info> - PACKAGE_EXCLUDE_COMPLEMENTARY[doc] = "Prevents specific packages from being installed when you are installing complementary packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Prevents specific packages from being installed when - you are installing complementary packages. - </para> - - <para> - You might find that you want to prevent installing certain - packages when you are installing complementary packages. - For example, if you are using - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link> - to install <filename>dev-pkgs</filename>, you might not want - to install all packages from a particular multilib. - If you find yourself in this situation, you can use the - <filename>PACKAGE_EXCLUDE_COMPLEMENTARY</filename> variable - to specify regular expressions to match the packages you - want to exclude. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_EXCLUDE'><glossterm>PACKAGE_EXCLUDE</glossterm> - <info> - PACKAGE_EXCLUDE[doc] = "Packages to exclude from the installation. If a listed package is required, an error is generated." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists packages that should not be installed into an image. - For example: - <literallayout class='monospaced'> - PACKAGE_EXCLUDE = "<replaceable>package_name</replaceable> <replaceable>package_name</replaceable> <replaceable>package_name</replaceable> ..." - </literallayout> - </para> - - <para> - You can set this variable globally in your - <filename>local.conf</filename> file or you can attach it to - a specific image recipe by using the recipe name override: - <literallayout class='monospaced'> - PACKAGE_EXCLUDE_pn-<replaceable>target_image</replaceable> = "<replaceable>package_name</replaceable>" - </literallayout> - </para> - - <para> - If you choose to not install - a package using this variable and some other package is - dependent on it (i.e. listed in a recipe's - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> - variable), the OpenEmbedded build system generates a fatal - installation error. - Because the build system halts the process with a fatal - error, you can use the variable with an iterative - development process to remove specific components from a - system. - </para> - - <para> - Support for this variable exists only when using the - IPK and RPM packaging backend. - Support does not exist for DEB. - </para> - - <para> - See the - <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link> - and the - <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link> - variables for related information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_EXTRA_ARCHS'><glossterm>PACKAGE_EXTRA_ARCHS</glossterm> - <info> - PACKAGE_EXTRA_ARCHS[doc] = "Specifies the list of architectures compatible with the device CPU. This variable is useful when you build for several different devices that use miscellaneous processors." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the list of architectures compatible with the device CPU. - This variable is useful when you build for several different devices that use - miscellaneous processors such as XScale and ARM926-EJS. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_FEED_ARCHS'><glossterm>PACKAGE_FEED_ARCHS</glossterm> - <info> - PACKAGE_FEED_ARCHS[doc] = "Optionally specifies user-defined package architectures when constructing package feed URIs." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Optionally specifies the package architectures used as - part of the package feed URIs during the build. - When used, the <filename>PACKAGE_FEED_ARCHS</filename> - variable is appended to the final package feed URI, which - is constructed using the - <link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link> - and - <link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link> - variables. - <note><title>Tip</title> - You can use the <filename>PACKAGE_FEEDS_ARCHS</filename> - 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. - </note> - </para> - - <para> - Consider the following example where the - <filename>PACKAGE_FEED_URIS</filename>, - <filename>PACKAGE_FEED_BASE_PATHS</filename>, and - <filename>PACKAGE_FEED_ARCHS</filename> variables are - defined in your <filename>local.conf</filename> file: - <literallayout class='monospaced'> - PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \ - https://example.com/packagerepos/updates" - PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev" - PACKAGE_FEED_ARCHS = "all core2-64" - </literallayout> - Given these settings, the resulting package feeds are - as follows: - <literallayout class='monospaced'> - https://example.com/packagerepos/release/rpm/all - https://example.com/packagerepos/release/rpm/core2-64 - https://example.com/packagerepos/release/rpm-dev/all - https://example.com/packagerepos/release/rpm-dev/core2-64 - https://example.com/packagerepos/updates/rpm/all - https://example.com/packagerepos/updates/rpm/core2-64 - https://example.com/packagerepos/updates/rpm-dev/all - https://example.com/packagerepos/updates/rpm-dev/core2-64 - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_FEED_BASE_PATHS'><glossterm>PACKAGE_FEED_BASE_PATHS</glossterm> - <info> - PACKAGE_FEED_BASE_PATHS[doc] = "Specifies base path used when constructing package feed URIs." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the base path used when constructing package feed - URIs. - The <filename>PACKAGE_FEED_BASE_PATHS</filename> variable - makes up the middle portion of a package feed URI used - by the OpenEmbedded build system. - The base path lies between the - <link linkend='var-PACKAGE_FEED_URIS'><filename>PACKAGE_FEED_URIS</filename></link> - and - <link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link> - variables. - </para> - - <para> - Consider the following example where the - <filename>PACKAGE_FEED_URIS</filename>, - <filename>PACKAGE_FEED_BASE_PATHS</filename>, and - <filename>PACKAGE_FEED_ARCHS</filename> variables are - defined in your <filename>local.conf</filename> file: - <literallayout class='monospaced'> - PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \ - https://example.com/packagerepos/updates" - PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev" - PACKAGE_FEED_ARCHS = "all core2-64" - </literallayout> - Given these settings, the resulting package feeds are - as follows: - <literallayout class='monospaced'> - https://example.com/packagerepos/release/rpm/all - https://example.com/packagerepos/release/rpm/core2-64 - https://example.com/packagerepos/release/rpm-dev/all - https://example.com/packagerepos/release/rpm-dev/core2-64 - https://example.com/packagerepos/updates/rpm/all - https://example.com/packagerepos/updates/rpm/core2-64 - https://example.com/packagerepos/updates/rpm-dev/all - https://example.com/packagerepos/updates/rpm-dev/core2-64 - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_FEED_URIS'><glossterm>PACKAGE_FEED_URIS</glossterm> - <info> - PACKAGE_FEED_URIS[doc] = "Specifies the front portion of the package feed URI used by the OpenEmbedded build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the front portion of the package feed URI - used by the OpenEmbedded build system. - Each final package feed URI is comprised of - <filename>PACKAGE_FEED_URIS</filename>, - <link linkend='var-PACKAGE_FEED_BASE_PATHS'><filename>PACKAGE_FEED_BASE_PATHS</filename></link>, - and - <link linkend='var-PACKAGE_FEED_ARCHS'><filename>PACKAGE_FEED_ARCHS</filename></link> - variables. - </para> - - <para> - Consider the following example where the - <filename>PACKAGE_FEED_URIS</filename>, - <filename>PACKAGE_FEED_BASE_PATHS</filename>, and - <filename>PACKAGE_FEED_ARCHS</filename> variables are - defined in your <filename>local.conf</filename> file: - <literallayout class='monospaced'> - PACKAGE_FEED_URIS = "https://example.com/packagerepos/release \ - https://example.com/packagerepos/updates" - PACKAGE_FEED_BASE_PATHS = "rpm rpm-dev" - PACKAGE_FEED_ARCHS = "all core2-64" - </literallayout> - Given these settings, the resulting package feeds are - as follows: - <literallayout class='monospaced'> - https://example.com/packagerepos/release/rpm/all - https://example.com/packagerepos/release/rpm/core2-64 - https://example.com/packagerepos/release/rpm-dev/all - https://example.com/packagerepos/release/rpm-dev/core2-64 - https://example.com/packagerepos/updates/rpm/all - https://example.com/packagerepos/updates/rpm/core2-64 - https://example.com/packagerepos/updates/rpm-dev/all - https://example.com/packagerepos/updates/rpm-dev/core2-64 - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_GROUP'><glossterm>PACKAGE_GROUP</glossterm> - <info> - PACKAGE_GROUP[doc] = "Defines one or more packages to include in an image when a specific item is included in IMAGE_FEATURES." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The <filename>PACKAGE_GROUP</filename> variable has been - renamed to - <link linkend='var-FEATURE_PACKAGES'><filename>FEATURE_PACKAGES</filename></link>. - See the variable description for - <filename>FEATURE_PACKAGES</filename> for information. - </para> - - <para> - If if you use the <filename>PACKAGE_GROUP</filename> - variable, the OpenEmbedded build system issues a warning - message. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_INSTALL'><glossterm>PACKAGE_INSTALL</glossterm> - <info> - PACKAGE_INSTALL[doc] = "List of the packages to be installed into the image. The variable is generally not user-defined and uses IMAGE_INSTALL as part of the list." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The final list of packages passed to the package manager - for installation into the image. - </para> - - <para> - Because the package manager controls actual installation - of all packages, the list of packages passed using - <filename>PACKAGE_INSTALL</filename> is not the final list - of packages that are actually installed. - This variable is internal to the image construction - code. - Consequently, in general, you should use the - <link linkend='var-IMAGE_INSTALL'><filename>IMAGE_INSTALL</filename></link> - variable to specify packages for installation. - The exception to this is when working with - the - <link linkend='images-core-image-minimal-initramfs'><filename>core-image-minimal-initramfs</filename></link> - image. - When working with an initial RAM filesystem (initramfs) - image, use the <filename>PACKAGE_INSTALL</filename> - variable. - For information on creating an initramfs, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_INSTALL_ATTEMPTONLY'><glossterm>PACKAGE_INSTALL_ATTEMPTONLY</glossterm> - <info> - PACKAGE_INSTALL_ATTEMPTONLY[doc] = "List of packages attempted to be installed when creating an image. If a listed package fails to install, the build system does not generate an error. This variable is generally not user-defined." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of packages the OpenEmbedded build - system attempts to install when creating an image. - If a listed package fails to install, the build system - does not generate an error. - This variable is generally not user-defined. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_PREPROCESS_FUNCS'><glossterm>PACKAGE_PREPROCESS_FUNCS</glossterm> - <info> - PACKAGE_PREPROCESS_FUNCS[doc] = "Specifies a list of functions run to pre-process the PKGD directory prior to splitting the files out to individual packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions run to pre-process the - <link linkend='var-PKGD'><filename>PKGD</filename></link> - directory prior to splitting the files out to individual - packages. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGE_WRITE_DEPS'><glossterm>PACKAGE_WRITE_DEPS</glossterm> - <info> - PACKAGE_WRITE_DEPS[doc] = "Specifies post-installation and pre-installation script dependencies on native/cross tools." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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 - <filename>PACKAGE_WRITE_DEPS</filename>. - </para> - - <para> - For information on running post-installation scripts, see - the - "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-post-installation-scripts'>Post-Installation Scripts</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGECONFIG'><glossterm>PACKAGECONFIG</glossterm> - <info> - PACKAGECONFIG[doc] = "This variable provides a means of enabling or disabling features of a recipe on a per-recipe basis." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable provides a means of enabling or disabling - features of a recipe on a per-recipe basis. - <filename>PACKAGECONFIG</filename> blocks are defined - in recipes when you specify features and then arguments - that define feature behaviors. - Here is the basic block structure: - <literallayout class='monospaced'> - PACKAGECONFIG ??= "f1 f2 f3 ..." - PACKAGECONFIG[f1] = "--with-f1,--without-f1,build-deps-f1,rt-deps-f1,rt-recs-f1" - PACKAGECONFIG[f2] = "--with-f2,--without-f2,build-deps-f2,rt-deps-f2,rt-recs-f2" - PACKAGECONFIG[f3] = "--with-f3,--without-f3,build-deps-f3,rt-deps-f3,rt-recs-f3" - </literallayout> - </para> - - <para> - The <filename>PACKAGECONFIG</filename> - variable itself specifies a space-separated list of the - features to enable. - Following the features, you can determine the behavior of - each feature by providing up to five order-dependent - arguments, which are separated by commas. - You can omit any argument you like but must retain the - separating commas. - The order is important and specifies the following: - <orderedlist> - <listitem><para>Extra arguments - that should be added to the configure script - argument list - (<link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> - or - <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>) - if the feature is enabled.</para></listitem> - <listitem><para>Extra arguments - that should be added to <filename>EXTRA_OECONF</filename> - or <filename>PACKAGECONFIG_CONFARGS</filename> - if the feature is disabled. - </para></listitem> - <listitem><para>Additional build dependencies - (<link linkend='var-DEPENDS'><filename>DEPENDS</filename></link>) - that should be added if the feature is enabled. - </para></listitem> - <listitem><para>Additional runtime dependencies - (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) - that should be added if the feature is enabled. - </para></listitem> - <listitem><para>Additional runtime recommendations - (<link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link>) - that should be added if the feature is enabled. - </para></listitem> - </orderedlist> - </para> - - <para> - Consider the following - <filename>PACKAGECONFIG</filename> block taken from the - <filename>librsvg</filename> recipe. - In this example the feature is <filename>croco</filename>, - which has three arguments that determine the feature's - behavior. - <literallayout class='monospaced'> - PACKAGECONFIG ??= "croco" - PACKAGECONFIG[croco] = "--with-croco,--without-croco,libcroco" - </literallayout> - The <filename>--with-croco</filename> and - <filename>libcroco</filename> arguments apply only if - the feature is enabled. - In this case, <filename>--with-croco</filename> is - added to the configure script argument list and - <filename>libcroco</filename> is added to - <filename>DEPENDS</filename>. - On the other hand, if the feature is disabled say through - a <filename>.bbappend</filename> file in another layer, then - the second argument <filename>--without-croco</filename> is - added to the configure script rather than - <filename>--with-croco</filename>. - </para> - - <para> - The basic <filename>PACKAGECONFIG</filename> structure - previously described holds true regardless of whether you - are creating a block or changing a block. - When creating a block, use the structure inside your - recipe. - </para> - - <para> - If you want to change an existing - <filename>PACKAGECONFIG</filename> block, you can do so - one of two ways: - <itemizedlist> - <listitem><para><emphasis>Append file:</emphasis> - Create an append file named - <replaceable>recipename</replaceable><filename>.bbappend</filename> - in your layer and override the value of - <filename>PACKAGECONFIG</filename>. - You can either completely override the variable: - <literallayout class='monospaced'> - PACKAGECONFIG = "f4 f5" - </literallayout> - Or, you can just append the variable: - <literallayout class='monospaced'> - PACKAGECONFIG_append = " f4" - </literallayout></para></listitem> - <listitem><para><emphasis>Configuration file:</emphasis> - This method is identical to changing the block - through an append file except you edit your - <filename>local.conf</filename> or - <filename><replaceable>mydistro</replaceable>.conf</filename> file. - As with append files previously described, - you can either completely override the variable: - <literallayout class='monospaced'> - PACKAGECONFIG_pn-<replaceable>recipename</replaceable> = "f4 f5" - </literallayout> - Or, you can just amend the variable: - <literallayout class='monospaced'> - PACKAGECONFIG_append_pn-<replaceable>recipename</replaceable> = " f4" - </literallayout></para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGECONFIG_CONFARGS'><glossterm>PACKAGECONFIG_CONFARGS</glossterm> - <info> - PACKAGECONFIG_CONFARGS[doc] = "A space-separated list of configuration options generated from the PACKAGECONFIG setting." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A space-separated list of configuration options generated - from the - <link linkend='var-PACKAGECONFIG'><filename>PACKAGECONFIG</filename></link> - setting. - </para> - - <para> - Classes such as - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> - and - <link linkend='ref-classes-cmake'><filename>cmake</filename></link> - use <filename>PACKAGECONFIG_CONFARGS</filename> to pass - <filename>PACKAGECONFIG</filename> options to - <filename>configure</filename> and - <filename>cmake</filename>, respectively. - If you are using - <filename>PACKAGECONFIG</filename> but not a class that - handles the <filename>do_configure</filename> task, then - you need to use - <filename>PACKAGECONFIG_CONFARGS</filename> appropriately. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGEGROUP_DISABLE_COMPLEMENTARY'><glossterm>PACKAGEGROUP_DISABLE_COMPLEMENTARY</glossterm> - <info> - PACKAGEGROUP_DISABLE_COMPLEMENTARY[doc] = "Prevents automatic creation of the normal complementary packages such as -dev and -dbg in a packagegroup recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - For recipes inheriting the - <link linkend='ref-classes-packagegroup'><filename>packagegroup</filename></link> - class, setting - <filename>PACKAGEGROUP_DISABLE_COMPLEMENTARY</filename> to - "1" specifies that the normal complementary packages - (i.e. <filename>-dev</filename>, - <filename>-dbg</filename>, and so forth) should not be - automatically created by the - <filename>packagegroup</filename> recipe, which is the - default behavior. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> - <info> - PACKAGES[doc] = "The list of packages the recipe creates." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The list of packages the recipe creates. - The default value is the following: - <literallayout class='monospaced'> - ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} - </literallayout> - </para> - - <para> - During packaging, the - <link linkend='ref-tasks-package'><filename>do_package</filename></link> - task goes through <filename>PACKAGES</filename> and uses - the - <link linkend='var-FILES'><filename>FILES</filename></link> - variable corresponding to each package to assign files to - the package. - If a file matches the <filename>FILES</filename> variable - for more than one package in <filename>PACKAGES</filename>, - it will be assigned to the earliest (leftmost) package. - </para> - - <para> - Packages in the variable's list that are empty (i.e. where - none of the patterns in - <filename>FILES_</filename><replaceable>pkg</replaceable> - match any files installed by the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task) are not generated, unless generation is forced through - the - <link linkend='var-ALLOW_EMPTY'><filename>ALLOW_EMPTY</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGES_DYNAMIC'><glossterm>PACKAGES_DYNAMIC</glossterm> - <info> - PACKAGES_DYNAMIC[doc] = "A promise that your recipe satisfies runtime dependencies for optional modules that are found in other recipes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A promise that your recipe satisfies runtime dependencies - for optional modules that are found in other recipes. - <filename>PACKAGES_DYNAMIC</filename> - does not actually satisfy the dependencies, it only states that - they should be satisfied. - For example, if a hard, runtime dependency - (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) - of another package is satisfied - at build time through the <filename>PACKAGES_DYNAMIC</filename> - variable, but a package with the module name is never actually - produced, then the other package will be broken. - Thus, if you attempt to include that package in an image, - you will get a dependency failure from the packaging system - during the - <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> - task. - </para> - - <para> - Typically, if there is a chance that such a situation can - occur and the package that is not created is valid - without the dependency being satisfied, then you should use - <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> - (a soft runtime dependency) instead of - <filename>RDEPENDS</filename>. - </para> - - <para> - For an example of how to use the <filename>PACKAGES_DYNAMIC</filename> - variable when you are splitting packages, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#handling-optional-module-packaging'>Handling Optional Module Packaging</ulink>" section - in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PACKAGESPLITFUNCS'><glossterm>PACKAGESPLITFUNCS</glossterm> - <info> - PACKAGESPLITFUNCS[doc] = "Specifies a list of functions run to perform additional splitting of files into individual packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions run to perform additional - splitting of files into individual packages. - Recipes can either prepend to this variable or prepend - to the <filename>populate_packages</filename> function - in order to perform additional package splitting. - In either case, the function should set - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>, - <link linkend='var-FILES'><filename>FILES</filename></link>, - <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> - and other packaging variables appropriately in order to - perform the desired splitting. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PARALLEL_MAKE'><glossterm>PARALLEL_MAKE</glossterm> - <info> - PARALLEL_MAKE[doc] = "Specifies extra options that are passed to the make command during the compile tasks. This variable is usually in the form -j x, where x represents the maximum number of parallel threads make can run." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Extra options passed to the <filename>make</filename> - command during the - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> - task in order to specify parallel compilation on the local - build host. - This variable is usually in the form "-j <replaceable>x</replaceable>", - where <replaceable>x</replaceable> represents the maximum - number of parallel threads <filename>make</filename> can - run. - <note><title>Caution</title> - In order for <filename>PARALLEL_MAKE</filename> to be - effective, <filename>make</filename> must be called - with - <filename>${</filename><link linkend='var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></link><filename>}</filename>. - An easy way to ensure this is to use the - <filename>oe_runmake</filename> function. - </note> - </para> - - <para> - By default, the OpenEmbedded build system automatically - sets this variable to be equal to the number of cores the - build system uses. - <note> - If the software being built experiences dependency - issues during the <filename>do_compile</filename> - task that result in race conditions, you can clear - the <filename>PARALLEL_MAKE</filename> variable within - the recipe as a workaround. - For information on addressing race conditions, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#debugging-parallel-make-races'>Debugging Parallel Make Races</ulink>" - section in the Yocto Project Development Tasks Manual. - </note> - For single socket systems (i.e. one CPU), you should not - have to override this variable to gain optimal parallelism - during builds. - However, if you have very large systems that employ - multiple physical CPUs, you might want to make sure the - <filename>PARALLEL_MAKE</filename> variable is not - set higher than "-j 20". - </para> - - <para> - For more information on speeding up builds, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#speeding-up-a-build'>Speeding Up a Build</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PARALLEL_MAKEINST'><glossterm>PARALLEL_MAKEINST</glossterm> - <info> - PARALLEL_MAKEINST[doc] = "Extra options passed to the make install command during the do_install task in order to specify parallel installation." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Extra options passed to the - <filename>make install</filename> command during the - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task in order to specify parallel installation. - This variable defaults to the value of - <link linkend='var-PARALLEL_MAKE'><filename>PARALLEL_MAKE</filename></link>. - <note><title>Notes and Cautions</title> - <para>In order for <filename>PARALLEL_MAKEINST</filename> - to be - effective, <filename>make</filename> must be called - with - <filename>${</filename><link linkend='var-EXTRA_OEMAKE'><filename>EXTRA_OEMAKE</filename></link><filename>}</filename>. - An easy way to ensure this is to use the - <filename>oe_runmake</filename> function.</para> - - <para>If the software being built experiences - dependency issues during the - <filename>do_install</filename> task that result in - race conditions, you can clear the - <filename>PARALLEL_MAKEINST</filename> variable within - the recipe as a workaround. - For information on addressing race conditions, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#debugging-parallel-make-races'>Debugging Parallel Make Races</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PATCHRESOLVE'><glossterm>PATCHRESOLVE</glossterm> - <info> - PATCHRESOLVE[doc] = "Enable or disable interactive patch resolution." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Determines the action to take when a patch fails. - You can set this variable to one of two values: "noop" and - "user". - </para> - - <para> - The default value of "noop" causes the build to simply fail - when the OpenEmbedded build system cannot successfully - apply a patch. - Setting the value to "user" causes the build system to - launch a shell and places you in the right location so that - you can manually resolve the conflicts. - </para> - - <para> - Set this variable in your - <filename>local.conf</filename> file. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PATCHTOOL'><glossterm>PATCHTOOL</glossterm> - <info> - PATCHTOOL[doc] = "Specifies the utility used to apply patches for a recipe during do_patch." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the utility used to apply patches for a recipe - during the - <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> - task. - You can specify one of three utilities: "patch", "quilt", or - "git". - The default utility used is "quilt" except for the - quilt-native recipe itself. - Because the quilt tool is not available at the - time quilt-native is being patched, it uses "patch". - </para> - - <para> - If you wish to use an alternative patching tool, set the - variable in the recipe using one of the following: - <literallayout class='monospaced'> - PATCHTOOL = "patch" - PATCHTOOL = "quilt" - PATCHTOOL = "git" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PE'><glossterm>PE</glossterm> - <info> - PE[doc] = "The epoch of the recipe. The default value is '0'. The field is used to make upgrades possible when the versioning scheme changes in some backwards incompatible way." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The epoch of the recipe. - By default, this variable is unset. - The variable is used to make upgrades possible when the - versioning scheme changes in some backwards incompatible - way. - </para> - - <para> - <filename>PE</filename> is the default value of the - <link linkend='var-PKGE'><filename>PKGE</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PF'><glossterm>PF</glossterm> - <info> - PF[doc] = "Specifies the recipe or package name and includes all version and revision numbers. This variable is comprised of ${PN}-${EXTENDPE}${PV}-${PR}." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the recipe or package name and includes all version and revision - numbers (i.e. <filename>glibc-2.13-r20+svnr15508/</filename> and - <filename>bash-4.2-r1/</filename>). - This variable is comprised of the following: - <literallayout class='monospaced'> - ${<link linkend='var-PN'>PN</link>}-${<link linkend='var-EXTENDPE'>EXTENDPE</link>}${<link linkend='var-PV'>PV</link>}-${<link linkend='var-PR'>PR</link>} - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PIXBUF_PACKAGES'><glossterm>PIXBUF_PACKAGES</glossterm> - <info> - PIXBUF_PACKAGES[doc] = "When a recipe inherits the pixbufcache class, this variable identifies packages that contain the pixbuf loaders used with gdk-pixbuf." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-pixbufcache'><filename>pixbufcache</filename></link> - class, this variable identifies packages that contain - the pixbuf loaders used with - <filename>gdk-pixbuf</filename>. - By default, the <filename>pixbufcache</filename> class - assumes that the loaders are in the recipe's main package - (i.e. <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>). - Use this variable if the loaders you need are in a package - other than that main package. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PKG'><glossterm>PKG</glossterm> - <info> - PKG[doc] = "The name of the resulting package created by the OpenEmbedded build system. When you use this variable, you must use a package name override." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The name of the resulting package created by the - OpenEmbedded build system. - <note> - When using the <filename>PKG</filename> variable, you - must use a package name override. - </note> - </para> - - <para> - For example, when the - <link linkend='ref-classes-debian'><filename>debian</filename></link> - class renames the output package, it does so by setting - <filename>PKG_<replaceable>packagename</replaceable></filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PKG_CONFIG_PATH'><glossterm>PKG_CONFIG_PATH</glossterm> - <info> - PKG_CONFIG_PATH[doc] = "Path to pkg-config files for the current build context." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The path to <filename>pkg-config</filename> files for the - current build context. - <filename>pkg-config</filename> reads this variable - from the environment. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PKGD'><glossterm>PKGD</glossterm> - <info> - PKGD[doc] = "Points to the destination directory for files to be packaged before they are split into individual packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the destination directory for files to be - packaged before they are split into individual packages. - This directory defaults to the following: - <literallayout class='monospaced'> - ${WORKDIR}/package - </literallayout> - </para> - - <para> - Do not change this default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PKGDATA_DIR'><glossterm>PKGDATA_DIR</glossterm> - <info> - PKGDATA_DIR[doc] = "Points to a shared, global-state directory that holds data generated during the packaging process." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to a shared, global-state directory that holds data - generated during the packaging process. - During the packaging process, the - <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link> - task packages data for each recipe and installs it into - this temporary, shared area. - This directory defaults to the following, which you should - not change: - <literallayout class='monospaced'> - ${STAGING_DIR_HOST}/pkgdata - </literallayout> - For examples of how this data is used, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" - section in the Yocto Project Overview and Concepts Manual - and the - "<ulink url='&YOCTO_DOCS_DEV_URL;#viewing-package-information-with-oe-pkgdata-util'>Viewing Package Information with <filename>oe-pkgdata-util</filename></ulink>" - section in the Yocto Project Development Tasks Manual. - For more information on the shared, global-state directory, - see - <link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PKGDEST'><glossterm>PKGDEST</glossterm> - <info> - PKGDEST[doc] = "Points to the parent directory for files to be packaged after they have been split into individual packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the parent directory for files to be packaged - after they have been split into individual packages. - This directory defaults to the following: - <literallayout class='monospaced'> - ${WORKDIR}/packages-split - </literallayout> - </para> - - <para> - Under this directory, the build system creates - directories for each package specified in - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>. - Do not change this default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PKGDESTWORK'><glossterm>PKGDESTWORK</glossterm> - <info> - PKGDESTWORK[doc] = "Points to a temporary work area where the do_package task saves package metadata." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to a temporary work area where the - <link linkend='ref-tasks-package'><filename>do_package</filename></link> - task saves package metadata. - The <filename>PKGDESTWORK</filename> location defaults to - the following: - <literallayout class='monospaced'> - ${WORKDIR}/pkgdata - </literallayout> - Do not change this default. - </para> - - <para> - The - <link linkend='ref-tasks-packagedata'><filename>do_packagedata</filename></link> - task copies the package metadata from - <filename>PKGDESTWORK</filename> to - <link linkend='var-PKGDATA_DIR'><filename>PKGDATA_DIR</filename></link> - to make it available globally. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PKGE'><glossterm>PKGE</glossterm> - <info> - PKGE[doc] = "The epoch of the package(s) built by the recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The epoch of the package(s) built by the recipe. - By default, <filename>PKGE</filename> is set to - <link linkend='var-PE'><filename>PE</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PKGR'><glossterm>PKGR</glossterm> - <info> - PKGR[doc] = "The revision of the package(s) built by the recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The revision of the package(s) built by the recipe. - By default, <filename>PKGR</filename> is set to - <link linkend='var-PR'><filename>PR</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PKGV'><glossterm>PKGV</glossterm> - <info> - PKGV[doc] = "The version of the package(s) built by the recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The version of the package(s) built by the - recipe. - By default, <filename>PKGV</filename> is set to - <link linkend='var-PV'><filename>PV</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PN'><glossterm>PN</glossterm> - <info> - PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable can have two separate functions depending on the context: a recipe - name or a resulting package name. - </para> - - <para> - <filename>PN</filename> refers to a recipe name in the context of a file used - by the OpenEmbedded build system as input to create a package. - The name is normally extracted from the recipe file name. - For example, if the recipe is named - <filename>expat_2.0.1.bb</filename>, then the default value of <filename>PN</filename> - will be "expat". - </para> - - <para> - The variable refers to a package name in the context of a file created or produced by the - OpenEmbedded build system. - </para> - - <para> - If applicable, the <filename>PN</filename> variable also contains any special - suffix or prefix. - For example, using <filename>bash</filename> to build packages for the native - machine, <filename>PN</filename> is <filename>bash-native</filename>. - Using <filename>bash</filename> to build packages for the target and for Multilib, - <filename>PN</filename> would be <filename>bash</filename> and - <filename>lib64-bash</filename>, respectively. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PNBLACKLIST'><glossterm>PNBLACKLIST</glossterm> - <info> - PNBLACKLIST[doc] = "Lists recipes you do not want the OpenEmbedded build system to build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists recipes you do not want the OpenEmbedded build system - to build. - This variable works in conjunction with the - <link linkend='ref-classes-blacklist'><filename>blacklist</filename></link> - class, which is inherited globally. - </para> - - <para> - To prevent a recipe from being built, use the - <filename>PNBLACKLIST</filename> variable in your - <filename>local.conf</filename> file. - Here is an example that prevents - <filename>myrecipe</filename> from being built: - <literallayout class='monospaced'> - PNBLACKLIST[myrecipe] = "Not supported by our organization." - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-POPULATE_SDK_POST_HOST_COMMAND'><glossterm>POPULATE_SDK_POST_HOST_COMMAND</glossterm> - <info> - POPULATE_SDK_POST_HOST_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created host part of the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions to call once the - OpenEmbedded build system has created the host part of - the SDK. - You can specify functions separated by semicolons: - <literallayout class='monospaced'> - POPULATE_SDK_POST_HOST_COMMAND += "<replaceable>function</replaceable>; ... " - </literallayout> - </para> - - <para> - If you need to pass the SDK path to a command - within a function, you can use - <filename>${SDK_DIR}</filename>, which points to - the parent directory used by the OpenEmbedded build - system when creating SDK output. - See the - <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-POPULATE_SDK_POST_TARGET_COMMAND'><glossterm>POPULATE_SDK_POST_TARGET_COMMAND</glossterm> - <info> - POPULATE_SDK_POST_TARGET_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created target part of the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions to call once the - OpenEmbedded build system has created the target part of - the SDK. - You can specify functions separated by semicolons: - <literallayout class='monospaced'> - POPULATE_SDK_POST_TARGET_COMMAND += "<replaceable>function</replaceable>; ... " - </literallayout> - </para> - - <para> - If you need to pass the SDK path to a command - within a function, you can use - <filename>${SDK_DIR}</filename>, which points to - the parent directory used by the OpenEmbedded build - system when creating SDK output. - See the - <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PR'><glossterm>PR</glossterm> - <info> - PR[doc] = "The revision of the recipe. The default value for this variable is 'r0'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The revision of the recipe. The default value for this - variable is "r0". - Subsequent revisions of the recipe conventionally have the - values "r1", "r2", and so forth. - When - <link linkend='var-PV'><filename>PV</filename></link> - increases, <filename>PR</filename> is conventionally reset - to "r0". - <note> - The OpenEmbedded build system does not need the aid of - <filename>PR</filename> to know when to rebuild a - recipe. - The build system uses the task - <ulink url='&YOCTO_DOCS_OM_URL;#overview-checksums'>input checksums</ulink> - along with the - <link linkend='structure-build-tmp-stamps'>stamp</link> - and - <ulink url='&YOCTO_DOCS_OM_URL;#shared-state-cache'>shared state cache</ulink> - mechanisms. - </note> - The <filename>PR</filename> variable primarily becomes - significant when a package manager dynamically installs - packages on an already built image. - In this case, <filename>PR</filename>, which is the default - value of - <link linkend='var-PKGR'><filename>PKGR</filename></link>, - helps the package manager distinguish which package is the - most recent one in cases where many packages have the same - <filename>PV</filename> (i.e. <filename>PKGV</filename>). - A component having many packages with the same - <filename>PV</filename> usually means that the packages all - install the same upstream version, but with later - (<filename>PR</filename>) version packages including - packaging fixes. - <note> - <filename>PR</filename> does not need to be increased - for changes that do not change the package contents or - metadata. - </note> - Because manually managing <filename>PR</filename> can be - cumbersome and error-prone, an automated solution exists. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>Working With a PR Service</ulink>" - section in the Yocto Project Development Tasks Manual - for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PREFERRED_PROVIDER'><glossterm>PREFERRED_PROVIDER</glossterm> - <info> - PREFERRED_PROVIDER[doc] = "If multiple recipes provide an item, this variable determines which recipe should be given preference." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If multiple recipes provide 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 - (<link linkend='var-PN'><filename>PN</filename></link>). - Here is a common example: - <literallayout class='monospaced'> - PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" - </literallayout> - In the previous example, multiple recipes are providing - "virtual/kernel". - The <filename>PREFERRED_PROVIDER</filename> variable is - set with the name (<filename>PN</filename>) of the recipe - you prefer to provide "virtual/kernel". - </para> - - <para> - Following are more examples: - <literallayout class='monospaced'> - PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" - PREFERRED_PROVIDER_virtual/libgl ?= "mesa" - </literallayout> - For more information, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#metadata-virtual-providers'>Using Virtual Providers</ulink>" - section in the Yocto Project Development Tasks Manual. - <note> - If you use a <filename>virtual/*</filename> item - with <filename>PREFERRED_PROVIDER</filename>, then any - recipe that - <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link> - that item but is not selected (defined) by - <filename>PREFERRED_PROVIDER</filename> is prevented - from building, which is usually desirable since this - mechanism is designed to select between mutually - exclusive alternative providers. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PREFERRED_VERSION'><glossterm>PREFERRED_VERSION</glossterm> - <info> - PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If multiple versions of recipes exist, this - variable determines which version is given preference. - You must always suffix the variable with the - <link linkend='var-PN'><filename>PN</filename></link> - you want to select, and you should set the - <link linkend='var-PV'><filename>PV</filename></link> - accordingly for precedence. - </para> - - <para> - The <filename>PREFERRED_VERSION</filename> variable - supports limited wildcard use through the - "<filename>%</filename>" 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: - <literallayout class='monospaced'> - PREFERRED_VERSION_python = "3.4.0" - PREFERRED_VERSION_linux-yocto = "4.12%" - </literallayout> - <note><title>Important</title> - The use of the "<filename>%</filename>" 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. - </note> - </para> - - <para> - The specified version is matched against - <link linkend='var-PV'><filename>PV</filename></link>, - which does not necessarily match the version part of - the recipe's filename. - For example, consider two recipes - <filename>foo_1.2.bb</filename> and - <filename>foo_git.bb</filename> where - <filename>foo_git.bb</filename> contains the following - assignment: - <literallayout class='monospaced'> - PV = "1.1+git${SRCPV}" - </literallayout> - In this case, the correct way to select - <filename>foo_git.bb</filename> is by using an - assignment such as the following: - <literallayout class='monospaced'> - PREFERRED_VERSION_foo = "1.1+git%" - </literallayout> - Compare that previous example against the following - incorrect example, which does not work: - <literallayout class='monospaced'> - PREFERRED_VERSION_foo = "git" - </literallayout> - </para> - - <para> - Sometimes the <filename>PREFERRED_VERSION</filename> - variable can be set by configuration files in a way that - is hard to change. - You can use - <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> - to set a machine-specific override. - Here is an example: - <literallayout class='monospaced'> - PREFERRED_VERSION_linux-yocto_qemux86 = "4.12%" - </literallayout> - Although not recommended, worst case, you can also use the - "forcevariable" override, which is the strongest override - possible. - Here is an example: - <literallayout class='monospaced'> - PREFERRED_VERSION_linux-yocto_forcevariable = "4.12%" - </literallayout> - <note> - The <filename>_forcevariable</filename> override is - not handled specially. - This override only works because the default value of - <filename>OVERRIDES</filename> includes - "forcevariable". - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PREMIRRORS'><glossterm>PREMIRRORS</glossterm> - <info> - PREMIRRORS[doc] = "Specifies additional paths from which the OpenEmbedded build system gets source code." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies additional paths from which the OpenEmbedded - build system gets source code. - When the build system searches for source code, it first - tries the local download directory. - If that location fails, the build system tries locations - defined by <filename>PREMIRRORS</filename>, the upstream - source, and then locations specified by - <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> - in that order. - </para> - - <para> - Assuming your distribution - (<link linkend='var-DISTRO'><filename>DISTRO</filename></link>) - is "poky", the default value for - <filename>PREMIRRORS</filename> is defined in the - <filename>conf/distro/poky.conf</filename> file in the - <filename>meta-poky</filename> Git repository. - </para> - - <para> - Typically, you could add a specific server for the - build system to attempt before any others by adding - something like the following to the - <filename>local.conf</filename> configuration file in the - <link linkend='build-directory'>Build Directory</link>: - <literallayout class='monospaced'> - PREMIRRORS_prepend = "\ - git://.*/.* http://www.yoctoproject.org/sources/ \n \ - ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ - http://.*/.* http://www.yoctoproject.org/sources/ \n \ - https://.*/.* http://www.yoctoproject.org/sources/ \n" - </literallayout> - These changes cause the build system to intercept - Git, FTP, HTTP, and HTTPS requests and direct them to - the <filename>http://</filename> sources mirror. - You can use <filename>file://</filename> URLs to point - to local directories or network shares as well. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PRIORITY'><glossterm>PRIORITY</glossterm> - <info> - PRIORITY[doc] = "Indicates the importance of a package. The default value is 'optional'. Other standard values are 'required', 'standard', and 'extra'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Indicates the importance of a package. - </para> - - <para> - <filename>PRIORITY</filename> is considered to be part of - the distribution policy because the importance of any given - recipe depends on the purpose for which the distribution - is being produced. - Thus, <filename>PRIORITY</filename> is not normally set - within recipes. - </para> - - <para> - You can set <filename>PRIORITY</filename> to "required", - "standard", "extra", and "optional", which is the default. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PRIVATE_LIBS'><glossterm>PRIVATE_LIBS</glossterm> - <info> - PRIVATE_LIBS[doc] = "Specifies libraries installed within a recipe that should be ignored by the OpenEmbedded build system's shared library resolver." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies libraries installed within a recipe that - should be ignored by the OpenEmbedded build system's - shared library resolver. - This variable is typically used when software being - built by a recipe has its own private versions of a - library normally provided by another recipe. - In this case, you would not want the package containing - the private libraries to be set as a dependency on other - unrelated packages that should instead depend on the - package providing the standard version of the library. - </para> - - <para> - Libraries specified in this variable should be specified - by their file name. - For example, from the Firefox recipe in meta-browser: - <literallayout class='monospaced'> - PRIVATE_LIBS = "libmozjs.so \ - libxpcom.so \ - libnspr4.so \ - libxul.so \ - libmozalloc.so \ - libplc4.so \ - libplds4.so" - </literallayout> - </para> - - <para> - For more information, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PROVIDES'><glossterm>PROVIDES</glossterm> - <info> - PROVIDES[doc] = "A list of aliases that a recipe also provides. These aliases are useful for satisfying dependencies of other recipes during the build as specified by DEPENDS." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of aliases by which a particular recipe can be - known. - By default, a recipe's own - <filename><link linkend='var-PN'>PN</link></filename> - is implicitly already in its <filename>PROVIDES</filename> - list. - If a recipe uses <filename>PROVIDES</filename>, the - additional aliases are synonyms for the recipe and can - be useful satisfying dependencies of other recipes during - the build as specified by - <filename><link linkend='var-DEPENDS'>DEPENDS</link></filename>. - </para> - - <para> - Consider the following example - <filename>PROVIDES</filename> statement from a recipe - file <filename>libav_0.8.11.bb</filename>: - <literallayout class='monospaced'> - PROVIDES += "libpostproc" - </literallayout> - The <filename>PROVIDES</filename> statement results in - the "libav" recipe also being known as "libpostproc". - </para> - - <para> - In addition to providing recipes under alternate names, - the <filename>PROVIDES</filename> 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 <filename>PROVIDES</filename>. - Recipes that depend on the functionality in question can - include the virtual target in <filename>DEPENDS</filename> - to leave the choice of provider open. - </para> - - <para> - 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. - </para> - - <para> - The - <link linkend='var-PREFERRED_PROVIDER'><filename>PREFERRED_PROVIDER</filename></link> - variable is used to select which particular recipe - provides a virtual target. - <note> - <para>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, - <filename>VIRTUAL-RUNTIME_dev_manager</filename> - refers to the package of the component that manages - the <filename>/dev</filename> directory.</para> - - <para>Setting the "preferred provider" for runtime - dependencies is as simple as using the following - assignment in a configuration file:</para> - <literallayout class='monospaced'> - VIRTUAL-RUNTIME_dev_manager = "udev" - </literallayout> - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PRSERV_HOST'><glossterm>PRSERV_HOST</glossterm> - <info> - PRSERV_HOST[doc] = "The network based PR service host and port." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The network based - <link linkend='var-PR'><filename>PR</filename></link> - service host and port. - </para> - - <para> - The <filename>conf/local.conf.sample.extended</filename> - configuration file in the - <link linkend='source-directory'>Source Directory</link> - shows how the <filename>PRSERV_HOST</filename> variable is - set: - <literallayout class='monospaced'> - PRSERV_HOST = "localhost:0" - </literallayout> - You must set the variable if you want to automatically - start a local - <ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>PR service</ulink>. - You can set <filename>PRSERV_HOST</filename> to other - values to use a remote PR service. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PTEST_ENABLED'><glossterm>PTEST_ENABLED</glossterm> - <info> - PRSERV_HOST[doc] = "Specifies whether or not Package Test (ptest) functionality is enabled when building a recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies whether or not - <ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Package Test</ulink> - (ptest) functionality is enabled when building a recipe. - You should not set this variable directly. - Enabling and disabling building Package Tests - at build time should be done by adding "ptest" to (or - removing it from) - <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PV'><glossterm>PV</glossterm> - <info> - PV[doc] = "The version of the recipe. The version is normally extracted from the recipe filename." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The version of the recipe. - The version is normally extracted from the recipe filename. - For example, if the recipe is named - <filename>expat_2.0.1.bb</filename>, then the default value - of <filename>PV</filename> will be "2.0.1". - <filename>PV</filename> is generally not overridden within - a recipe unless it is building an unstable (i.e. - development) version from a source code repository - (e.g. Git or Subversion). - </para> - - <para> - <filename>PV</filename> is the default value of the - <link linkend='var-PKGV'><filename>PKGV</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PYTHON_ABI'><glossterm>PYTHON_ABI</glossterm> - <info> - PYTHON_ABI[doc] = "When used by recipes that inherit the distutils3, setuptools3, distutils, or setuptools classes, denotes the Application Binary Interface (ABI) currently in use for Python." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When used by recipes that inherit the - <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>, - <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>, - <link linkend='ref-classes-distutils'><filename>distutils</filename></link>, - or - <link linkend='ref-classes-setuptools'><filename>setuptools</filename></link> - classes, denotes the Application Binary Interface (ABI) - currently in use for Python. - By default, the ABI is "m". - You do not have to set this variable as the OpenEmbedded - build system sets it for you. - </para> - - <para> - The OpenEmbedded build system uses the ABI to construct - directory names used when installing the Python headers - and libraries in sysroot - (e.g. <filename>.../python3.3m/...</filename>). - </para> - - <para> - Recipes that inherit the <filename>distutils</filename> - class during cross-builds also use this variable to - locate the headers and libraries of the appropriate Python - that the extension is targeting. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-PYTHON_PN'><glossterm>PYTHON_PN</glossterm> - <info> - PYTHON_PN[doc] = "When used by recipes that inherit the distutils3, setuptools3, distutils, or setuptools classes, specifies the major Python version being built." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When used by recipes that inherit the - <link linkend='ref-classes-distutils3'><filename>distutils3</filename></link>, - <link linkend='ref-classes-setuptools3'><filename>setuptools3</filename></link>, - <link linkend='ref-classes-distutils'><filename>distutils</filename></link>, - or - <link linkend='ref-classes-setuptools'><filename>setuptools</filename></link> - classes, specifies the major Python version being built. - For Python 2.x, <filename>PYTHON_PN</filename> would - be "python2". For Python 3.x, the variable would be - "python3". - You do not have to set this variable as the - OpenEmbedded build system automatically sets it for you. - </para> - - <para> - The variable allows recipes to use common infrastructure - such as the following: - <literallayout class='monospaced'> - DEPENDS += "${PYTHON_PN}-native" - </literallayout> - In the previous example, the version of the dependency - is <filename>PYTHON_PN</filename>. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-r'><title>R</title> - - <glossentry id='var-RANLIB'><glossterm>RANLIB</glossterm> - <info> - RANLIB[doc] = "Minimal command and arguments to run 'ranlib'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments to run - <filename>ranlib</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-RCONFLICTS'><glossterm>RCONFLICTS</glossterm> - <info> - RCONFLICTS[doc] = "The list of packages that conflict with another package. Note that the package will not be installed if the conflicting packages are not first removed." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The list of packages that conflict with packages. - Note that packages will not be installed if conflicting - packages are not first removed. - </para> - - <para> - Like all package-controlling variables, you must always use - them in conjunction with a package name override. - Here is an example: - <literallayout class='monospaced'> - RCONFLICTS_${PN} = "<replaceable>another_conflicting_package_name</replaceable>" - </literallayout> - </para> - - <para> - BitBake, which the OpenEmbedded build system uses, supports - specifying versioned dependencies. - Although the syntax varies depending on the packaging - format, BitBake hides these differences from you. - Here is the general syntax to specify versions with - the <filename>RCONFLICTS</filename> variable: - <literallayout class='monospaced'> - RCONFLICTS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" - </literallayout> - For <filename>operator</filename>, you can specify the - following: - <literallayout class='monospaced'> - = - < - > - <= - >= - </literallayout> - For example, the following sets up a dependency on version - 1.2 or greater of the package <filename>foo</filename>: - <literallayout class='monospaced'> - RCONFLICTS_${PN} = "foo (>= 1.2)" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-RDEPENDS'><glossterm>RDEPENDS</glossterm> - <info> - RDEPENDS[doc] = "Lists runtime dependencies of a package." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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 <filename>foo</filename> needs the packages - <filename>bar</filename> and <filename>baz</filename> to - be installed: - <literallayout class='monospaced'> - RDEPENDS_foo = "bar baz" - </literallayout> - The most common types of package runtime dependencies are - automatically detected and added. - Therefore, most recipes do not need to set - <filename>RDEPENDS</filename>. - For more information, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#automatically-added-runtime-dependencies'>Automatically Added Runtime Dependencies</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - - <para> - The practical effect of the above - <filename>RDEPENDS</filename> assignment is that - <filename>bar</filename> and <filename>baz</filename> - will be declared as dependencies inside the package - <filename>foo</filename> when it is written out by one of - the - <link linkend='ref-tasks-package_write_deb'><filename>do_package_write_*</filename></link> - tasks. - Exactly how this is done depends on which package format - is used, which is determined by - <link linkend='var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></link>. - When the corresponding package manager installs the - package, it will know to also install the packages on - which it depends. - </para> - - <para> - To ensure that the packages <filename>bar</filename> and - <filename>baz</filename> get built, the previous - <filename>RDEPENDS</filename> assignment also causes a task - dependency to be added. - This dependency is from the recipe's - <link linkend='ref-tasks-build'><filename>do_build</filename></link> - (not to be confused with - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>) - task to the <filename>do_package_write_*</filename> - task of the recipes that build <filename>bar</filename> and - <filename>baz</filename>. - </para> - - <para> - The names of the packages you list within - <filename>RDEPENDS</filename> must be the names of other - packages - they cannot be recipe names. - Although package names and recipe names usually match, - the important point here is that you are - providing package names within the - <filename>RDEPENDS</filename> variable. - For an example of the default list of packages created from - a recipe, see the - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> - variable. - </para> - - <para> - Because the <filename>RDEPENDS</filename> variable applies - to packages being built, you should always use the variable - in a form with an attached package name (remember that a - single recipe can build multiple packages). - For example, suppose you are building a development package - that depends on the <filename>perl</filename> package. - In this case, you would use the following - <filename>RDEPENDS</filename> statement: - <literallayout class='monospaced'> - RDEPENDS_${PN}-dev += "perl" - </literallayout> - In the example, the development package depends on - the <filename>perl</filename> package. - Thus, the <filename>RDEPENDS</filename> variable has the - <filename>${PN}-dev</filename> package name as part of the - variable. - <note> - <title>Caution</title> - <filename>RDEPENDS_${PN}-dev</filename> includes - <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename> - by default. - This default is set in the BitBake configuration file - (<filename>meta/conf/bitbake.conf</filename>). - Be careful not to accidentally remove - <filename>${PN}</filename> when modifying - <filename>RDEPENDS_${PN}-dev</filename>. - Use the "+=" operator rather than the "=" operator. - </note> - </para> - - <para> - The package names you use with - <filename>RDEPENDS</filename> must appear as they would in - the <filename>PACKAGES</filename> variable. - The - <link linkend='var-PKG'><filename>PKG</filename></link> - variable allows a different name to be used for - the final package (e.g. the - <link linkend='ref-classes-debian'><filename>debian</filename></link> - class uses this to rename packages), but this final package - name cannot be used with <filename>RDEPENDS</filename>, - which makes sense as <filename>RDEPENDS</filename> is meant - to be independent of the package format used. - </para> - - <para> - BitBake, which the OpenEmbedded build system uses, supports - specifying versioned dependencies. - Although the syntax varies depending on the packaging - format, BitBake hides these differences from you. - Here is the general syntax to specify versions with - the <filename>RDEPENDS</filename> variable: - <literallayout class='monospaced'> - RDEPENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" - </literallayout> - For <replaceable>operator</replaceable>, you can specify the - following: - <literallayout class='monospaced'> - = - < - > - <= - >= - </literallayout> - For <replaceable>version</replaceable>, provide the version - number. - <note><title>Tip</title> - You can use - <link linkend='var-EXTENDPKGV'><filename>EXTENDPKGV</filename></link> - to provide a full package version specification. - </note> - For example, the following sets up a dependency on version - 1.2 or greater of the package <filename>foo</filename>: - <literallayout class='monospaced'> - RDEPENDS_${PN} = "foo (>= 1.2)" - </literallayout> - </para> - - <para> - For information on build-time dependencies, see the - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> - variable. - You can also see the - "<ulink url='&YOCTO_DOCS_BB_URL;#tasks'>Tasks</ulink>" and - "<ulink url='&YOCTO_DOCS_BB_URL;#dependencies'>Dependencies</ulink>" - sections in the BitBake User Manual for additional - information on tasks and dependencies. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-REQUIRED_DISTRO_FEATURES'><glossterm>REQUIRED_DISTRO_FEATURES</glossterm> - <info> - REQUIRED_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-distro_features_check'><filename>distro_features_check</filename></link> - class, this - variable identifies distribution features that must - exist in the current configuration in order for the - OpenEmbedded build system to build the recipe. - In other words, if the - <filename>REQUIRED_DISTRO_FEATURES</filename> variable - lists a feature that does not appear in - <filename>DISTRO_FEATURES</filename> within the - current configuration, an error occurs and the - build stops. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-RM_WORK_EXCLUDE'><glossterm>RM_WORK_EXCLUDE</glossterm> - <info> - RM_WORK_EXCLUDE[doc] = "With rm_work enabled, this variable specifies a list of packages whose work directories should not be removed." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - With <filename>rm_work</filename> enabled, this - variable specifies a list of recipes whose work directories - should not be removed. - See the "<link linkend='ref-classes-rm-work'><filename>rm_work.bbclass</filename></link>" - section for more details. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ROOT_HOME'><glossterm>ROOT_HOME</glossterm> - <info> - ROOT_HOME[doc] = "Defines the root home directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the root home directory. - By default, this directory is set as follows in the - BitBake configuration file: - <literallayout class='monospaced'> - ROOT_HOME ??= "/home/root" - </literallayout> - <note> - This default value is likely used because some - embedded solutions prefer to have a read-only root - filesystem and prefer to keep writeable data in one - place. - </note> - </para> - - <para> - You can override the default by setting the variable - in any layer or in the <filename>local.conf</filename> file. - Because the default is set using a "weak" assignment - (i.e. "??="), you can use either of the following forms - to define your override: - <literallayout class='monospaced'> - ROOT_HOME = "/root" - ROOT_HOME ?= "/root" - </literallayout> - These override examples use <filename>/root</filename>, - which is probably the most commonly used override. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ROOTFS'><glossterm>ROOTFS</glossterm> - <info> - ROOTFS[doc] = "Indicates a filesystem image to include as the root filesystem." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Indicates a filesystem image to include as the root - filesystem. - </para> - - <para> - The <filename>ROOTFS</filename> variable is an optional - variable used with the - <link linkend='ref-classes-image-live'><filename>image-live</filename></link> - class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ROOTFS_POSTINSTALL_COMMAND'><glossterm>ROOTFS_POSTINSTALL_COMMAND</glossterm> - <info> - ROOTFS_POSTINSTALL_COMMAND[doc] = "Specifies a list of functions to call after installing packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions to call after the - OpenEmbedded build system has installed packages. - You can specify functions separated by semicolons: - <literallayout class='monospaced'> - ROOTFS_POSTINSTALL_COMMAND += "<replaceable>function</replaceable>; ... " - </literallayout> - </para> - - <para> - If you need to pass the root filesystem path to a command - within a function, you can use - <filename>${IMAGE_ROOTFS}</filename>, which points to - the directory that becomes the root filesystem image. - See the - <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ROOTFS_POSTPROCESS_COMMAND'><glossterm>ROOTFS_POSTPROCESS_COMMAND</glossterm> - <info> - ROOTFS_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system has created the root filesystem." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions to call once the - OpenEmbedded build system has created the root filesystem. - You can specify functions separated by semicolons: - <literallayout class='monospaced'> - ROOTFS_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " - </literallayout> - </para> - - <para> - If you need to pass the root filesystem path to a command - within a function, you can use - <filename>${IMAGE_ROOTFS}</filename>, which points to - the directory that becomes the root filesystem image. - See the - <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ROOTFS_POSTUNINSTALL_COMMAND'><glossterm>ROOTFS_POSTUNINSTALL_COMMAND</glossterm> - <info> - ROOTFS_POSTUNINSTALL_COMMAND[doc] = "Specifies a list of functions to call after removal of unneeded packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions to call after the - OpenEmbedded build system has removed unnecessary - packages. - When runtime package management is disabled in the - image, several packages are removed including - <filename>base-passwd</filename>, - <filename>shadow</filename>, and - <filename>update-alternatives</filename>. - You can specify functions separated by semicolons: - <literallayout class='monospaced'> - ROOTFS_POSTUNINSTALL_COMMAND += "<replaceable>function</replaceable>; ... " - </literallayout> - </para> - - <para> - If you need to pass the root filesystem path to a command - within a function, you can use - <filename>${IMAGE_ROOTFS}</filename>, which points to - the directory that becomes the root filesystem image. - See the - <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-ROOTFS_PREPROCESS_COMMAND'><glossterm>ROOTFS_PREPROCESS_COMMAND</glossterm> - <info> - ROOTFS_PREPROCESS_COMMAND[doc] = "Specifies a list of functions to call before the OpenEmbedded build system has created the root filesystem." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions to call before the - OpenEmbedded build system has created the root filesystem. - You can specify functions separated by semicolons: - <literallayout class='monospaced'> - ROOTFS_PREPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " - </literallayout> - </para> - - <para> - If you need to pass the root filesystem path to a command - within a function, you can use - <filename>${IMAGE_ROOTFS}</filename>, which points to - the directory that becomes the root filesystem image. - See the - <link linkend='var-IMAGE_ROOTFS'><filename>IMAGE_ROOTFS</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-RPROVIDES'><glossterm>RPROVIDES</glossterm> - <info> - RPROVIDES[doc] = "A list of package name aliases that a package also provides. These aliases are useful for satisfying runtime dependencies of other packages both during the build and on the target." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of package name aliases that a package also provides. - These aliases are useful for satisfying runtime dependencies - of other packages both during the build and on the target - (as specified by - <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename>). - <note> - A package's own name is implicitly already in its - <filename>RPROVIDES</filename> list. - </note> - </para> - - <para> - As with all package-controlling variables, you must always - use the variable in conjunction with a package name override. - Here is an example: - <literallayout class='monospaced'> - RPROVIDES_${PN} = "widget-abi-2" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-RRECOMMENDS'><glossterm>RRECOMMENDS</glossterm> - <info> - RRECOMMENDS[doc] = "A list of packages that extends the usability of a package being built. The package being built does not depend on this list of packages in order to successfully build, but needs them for the extended usability." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of packages that extends the usability of a package - being built. - The package being built does not depend on this list of - packages in order to successfully build, but rather - uses them for extended usability. - To specify runtime dependencies for packages, see the - <filename><link linkend='var-RDEPENDS'>RDEPENDS</link></filename> - variable. - </para> - - <para> - The package manager will automatically install the - <filename>RRECOMMENDS</filename> list of packages when - installing the built package. - However, you can prevent listed packages from being - installed by using the - <link linkend='var-BAD_RECOMMENDATIONS'><filename>BAD_RECOMMENDATIONS</filename></link>, - <link linkend='var-NO_RECOMMENDATIONS'><filename>NO_RECOMMENDATIONS</filename></link>, - and - <link linkend='var-PACKAGE_EXCLUDE'><filename>PACKAGE_EXCLUDE</filename></link> - variables. - </para> - - <para> - Packages specified in - <filename>RRECOMMENDS</filename> need not actually be - produced. - However, a recipe must exist that provides each package, - either through the - <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link> - or - <link linkend='var-PACKAGES_DYNAMIC'><filename>PACKAGES_DYNAMIC</filename></link> - variables or the - <link linkend='var-RPROVIDES'><filename>RPROVIDES</filename></link> - variable, or an error will occur during the build. - If such a recipe does exist and the package is not produced, - the build continues without error. - </para> - - <para> - Because the <filename>RRECOMMENDS</filename> variable - applies to packages being built, you should always attach - an override to the variable to specify the particular - package whose usability is being extended. - For example, suppose you are building a development package - that is extended to support wireless functionality. - In this case, you would use the following: - <literallayout class='monospaced'> - RRECOMMENDS_${PN}-dev += "<replaceable>wireless_package_name</replaceable>" - </literallayout> - In the example, the package name - (<filename>${<link linkend='var-PN'>PN</link>}-dev</filename>) - must appear as it would in the - <filename>PACKAGES</filename> namespace before any renaming - of the output package by classes such as - <filename>debian.bbclass</filename>. - </para> - - <para> - BitBake, which the OpenEmbedded build system uses, supports - specifying versioned recommends. - Although the syntax varies depending on the packaging - format, BitBake hides these differences from you. - Here is the general syntax to specify versions with - the <filename>RRECOMMENDS</filename> variable: - <literallayout class='monospaced'> - RRECOMMENDS_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" - </literallayout> - For <filename>operator</filename>, you can specify the - following: - <literallayout class='monospaced'> - = - < - > - <= - >= - </literallayout> - For example, the following sets up a recommend on version - 1.2 or greater of the package <filename>foo</filename>: - <literallayout class='monospaced'> - RRECOMMENDS_${PN} = "foo (>= 1.2)" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-RREPLACES'><glossterm>RREPLACES</glossterm> - <info> - RREPLACES[doc] = "A list of packages replaced by a package. The package manager uses this variable to determine which package should be installed to replace other package(s) during an upgrade." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of packages replaced by a package. - The package manager uses this variable to determine which - package should be installed to replace other package(s) - during an upgrade. - In order to also have the other package(s) removed at the - same time, you must add the name of the other - package to the - <filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link></filename> variable. - </para> - - <para> - As with all package-controlling variables, you must use - this variable in conjunction with a package name - override. - Here is an example: - <literallayout class='monospaced'> - RREPLACES_${PN} = "<replaceable>other_package_being_replaced</replaceable>" - </literallayout> - </para> - - <para> - BitBake, which the OpenEmbedded build system uses, supports - specifying versioned replacements. - Although the syntax varies depending on the packaging - format, BitBake hides these differences from you. - Here is the general syntax to specify versions with - the <filename>RREPLACES</filename> variable: - <literallayout class='monospaced'> - RREPLACES_${PN} = "<replaceable>package</replaceable> (<replaceable>operator</replaceable> <replaceable>version</replaceable>)" - </literallayout> - For <filename>operator</filename>, you can specify the - following: - <literallayout class='monospaced'> - = - < - > - <= - >= - </literallayout> - For example, the following sets up a replacement using - version 1.2 or greater of the package - <filename>foo</filename>: - <literallayout class='monospaced'> - RREPLACES_${PN} = "foo (>= 1.2)" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm> - <info> - RSUGGESTS[doc] = "A list of additional packages that you can suggest for installation by the package manager at the time a package is installed. Not all package managers support this functionality." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of additional packages that you can suggest for - installation by the package manager at the time a package - is installed. - Not all package managers support this functionality. - </para> - - <para> - As with all package-controlling variables, you must always - use this variable in conjunction with a package name - override. - Here is an example: - <literallayout class='monospaced'> - RSUGGESTS_${PN} = "<replaceable>useful_package</replaceable> <replaceable>another_package</replaceable>" - </literallayout> - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-s'><title>S</title> - - <glossentry id='var-S'><glossterm>S</glossterm> - <info> - S[doc] = "The location in the Build Directory where unpacked package source code resides." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The location in the - <link linkend='build-directory'>Build Directory</link> - where unpacked recipe source code resides. - By default, this directory is - <filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/${</filename><link linkend='var-BPN'><filename>BPN</filename></link><filename>}-${</filename><link linkend='var-PV'><filename>PV</filename></link><filename>}</filename>, - where <filename>${BPN}</filename> is the base recipe name - and <filename>${PV}</filename> is the recipe version. - If the source tarball extracts the code to a directory - named anything other than <filename>${BPN}-${PV}</filename>, - or if the source code is fetched from an SCM such as - Git or Subversion, then you must set <filename>S</filename> - in the recipe so that the OpenEmbedded build system - knows where to find the unpacked source. - </para> - - <para> - As an example, assume a - <link linkend='source-directory'>Source Directory</link> - top-level folder named <filename>poky</filename> and a - default Build Directory at <filename>poky/build</filename>. - In this case, the work directory the build system uses - to keep the unpacked recipe for <filename>db</filename> - is the following: - <literallayout class='monospaced'> - poky/build/tmp/work/qemux86-poky-linux/db/5.1.19-r3/db-5.1.19 - </literallayout> - The unpacked source code resides in the - <filename>db-5.1.19</filename> folder. - </para> - - <para> - This next example assumes a Git repository. - By default, Git repositories are cloned to - <filename>${WORKDIR}/git</filename> during - <link linkend='ref-tasks-fetch'><filename>do_fetch</filename></link>. - Since this path is different from the default value of - <filename>S</filename>, you must set it specifically - so the source can be located: - <literallayout class='monospaced'> - SRC_URI = "git://path/to/repo.git" - S = "${WORKDIR}/git" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SANITY_REQUIRED_UTILITIES'><glossterm>SANITY_REQUIRED_UTILITIES</glossterm> - <info> - SANITY_REQUIRED_UTILITIES[doc] = "Specifies a list of command-line utilities that should be checked for during the initial sanity checking process when running BitBake." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of command-line utilities that should be - checked for during the initial sanity checking process when - running BitBake. - If any of the utilities are not installed on the build host, - then BitBake immediately exits with an error. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SANITY_TESTED_DISTROS'><glossterm>SANITY_TESTED_DISTROS</glossterm> - <info> - SANITY_TESTED_DISTROS[doc] = "A list of the host distribution identifiers that the build system has been tested against." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of the host distribution identifiers that the - build system has been tested against. - Identifiers consist of the host distributor ID - followed by the release, - as reported by the <filename>lsb_release</filename> tool - or as read from <filename>/etc/lsb-release</filename>. - Separate the list items with explicit newline - characters (<filename>\n</filename>). - If <filename>SANITY_TESTED_DISTROS</filename> is not empty - and the current value of - <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link> - does not appear in the list, then the build system reports - a warning that indicates the current host distribution has - not been tested as a build host. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_ARCH'><glossterm>SDK_ARCH</glossterm> - <info> - SDK_ARCH[doc] = "The target architecture for the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The target architecture for the SDK. - Typically, you do not directly set this variable. - Instead, use - <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_DEPLOY'><glossterm>SDK_DEPLOY</glossterm> - <info> - SDK_DEPLOY[doc] = "The directory set up and used by the populate_sdk_base to which the SDK is deployed." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The directory set up and used by the - <link linkend='ref-classes-populate-sdk'><filename>populate_sdk_base</filename></link> - class to which the SDK is deployed. - The <filename>populate_sdk_base</filename> class defines - <filename>SDK_DEPLOY</filename> as follows: - <literallayout class='monospaced'> - SDK_DEPLOY = "${TMPDIR}/deploy/sdk" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_DIR'><glossterm>SDK_DIR</glossterm> - <info> - SDK_DIR[doc] = "The parent directory used by the OpenEmbedded build system when creating SDK output." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The parent directory used by the OpenEmbedded build system - when creating SDK output. - The - <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> - class defines the variable as follows: - <literallayout class='monospaced'> - SDK_DIR = "${WORKDIR}/sdk" - </literallayout> - <note> - The <filename>SDK_DIR</filename> directory is a - temporary directory as it is part of - <filename>WORKDIR</filename>. - The final output directory is - <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_EXT_TYPE'><glossterm>SDK_EXT_TYPE</glossterm> - <info> - SDK_EXT_TYPE[doc] = "Controls whether or not shared state artifacts are copied into the extensible SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Controls whether or not shared state artifacts are copied - into the extensible SDK. - The default value of "full" copies all of the required - shared state artifacts into the extensible SDK. - The value "minimal" leaves these artifacts out of the - SDK. - <note> - If you set the variable to "minimal", you need to - ensure - <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> - is set in the SDK's configuration to enable the - artifacts to be fetched as needed. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_HOST_MANIFEST'><glossterm>SDK_HOST_MANIFEST</glossterm> - <info> - SDK_HOST_MANIFEST[doc] = "The manifest file for the host part of the SDK. This file lists all the installed packages that make up the host part of the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The manifest file for the host part of the SDK. - This file lists all the installed packages that make up - the host part of the SDK. - The file contains package information on a line-per-package - basis as follows: - <literallayout class='monospaced'> - <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable> - </literallayout> - </para> - - <para> - The - <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> - class defines the manifest file as follows: - <literallayout class='monospaced'> - SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" - </literallayout> - The location is derived using the - <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link> - and - <link linkend='var-TOOLCHAIN_OUTPUTNAME'><filename>TOOLCHAIN_OUTPUTNAME</filename></link> - variables. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_INCLUDE_PKGDATA'><glossterm>SDK_INCLUDE_PKGDATA</glossterm> - <info> - SDK_INCLUDE_PKGDATA[doc] = "When set to "1", specifies to include the packagedata for all recipes in the "world" target in the extensible SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When set to "1", specifies to include the packagedata for - all recipes in the "world" target in the extensible SDK. - Including this data allows the - <filename>devtool search</filename> command to find these - recipes in search results, as well as allows the - <filename>devtool add</filename> command to map - dependencies more effectively. - <note> - Enabling the <filename>SDK_INCLUDE_PKGDATA</filename> - variable significantly increases build time because - all of world needs to be built. - Enabling the variable also slightly increases the size - of the extensible SDK. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_INCLUDE_TOOLCHAIN'><glossterm>SDK_INCLUDE_TOOLCHAIN</glossterm> - <info> - SDK_INCLUDE_TOOLCHAIN[doc] = "When set to "1", specifies to include the toolchain in the extensible SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When set to "1", specifies to include the toolchain in the - extensible SDK. - Including the toolchain is useful particularly when - <link linkend='var-SDK_EXT_TYPE'><filename>SDK_EXT_TYPE</filename></link> - 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 (e.g. Eclipse) or from other tools and you do not - want to perform additional steps to install the toolchain. - </para> - - <para> - The <filename>SDK_INCLUDE_TOOLCHAIN</filename> variable - defaults to "0" if <filename>SDK_EXT_TYPE</filename> - is set to "minimal", and defaults to "1" if - <filename>SDK_EXT_TYPE</filename> is set to "full". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_INHERIT_BLACKLIST'><glossterm>SDK_INHERIT_BLACKLIST</glossterm> - <info> - SDK_INHERIT_BLACKLIST[doc] = "A list of classes to remove from the INHERIT value globally within the extensible SDK configuration." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of classes to remove from the - <link linkend='var-INHERIT'><filename>INHERIT</filename></link> - value globally within the extensible SDK configuration. - The - <link linkend='ref-classes-populate-sdk-*'><filename>populate-sdk-ext</filename></link> - class sets the default value: - <literallayout class='monospaced'> - SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" - </literallayout> - </para> - - <para> - Some classes are not generally applicable within - the extensible SDK context. - You can use this variable to disable those classes. - </para> - - <para> - For additional information on how to customize the - extensible SDK's configuration, see the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-configuring-the-extensible-sdk'>Configuring the Extensible SDK</ulink>" - section in the Yocto Project Application Development and - the Extensible Software Development Kit (eSDK) manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_LOCAL_CONF_BLACKLIST'><glossterm>SDK_LOCAL_CONF_BLACKLIST</glossterm> - <info> - SDK_LOCAL_CONF_BLACKLIST[doc] = "A list of variables not allowed through from the build system configuration into the extensible SDK configuration." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of variables not allowed through from the - 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. - </para> - - <para>By default, - <filename>SDK_LOCAL_CONF_BLACKLIST</filename> is set in the - <link linkend='ref-classes-populate-sdk-*'><filename>populate-sdk-ext</filename></link> - class and excludes the following variables: - <literallayout class='monospaced'> - <link linkend='var-CONF_VERSION'>CONF_VERSION</link> - <link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link> - <ulink url='&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS'>BB_NUMBER_PARSE_THREADS</ulink> - <link linkend='var-PARALLEL_MAKE'>PARALLEL_MAKE</link> - <link linkend='var-PRSERV_HOST'>PRSERV_HOST</link> - <link linkend='var-SSTATE_MIRRORS'>SSTATE_MIRRORS</link> - <link linkend='var-DL_DIR'>DL_DIR</link> - <link linkend='var-SSTATE_DIR'>SSTATE_DIR</link> - <link linkend='var-TMPDIR'>TMPDIR</link> - <link linkend='var-BB_SERVER_TIMEOUT'>BB_SERVER_TIMEOUT</link> - </literallayout> - </para> - - <para> - For additional information on how to customize the - extensible SDK's configuration, see the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-configuring-the-extensible-sdk'>Configuring the Extensible SDK</ulink>" - section in the Yocto Project Application Development and - the Extensible Software Development Kit (eSDK) manual. - </para> - - </glossdef> - </glossentry> - - <glossentry id='var-SDK_LOCAL_CONF_WHITELIST'><glossterm>SDK_LOCAL_CONF_WHITELIST</glossterm> - <info> - SDK_LOCAL_CONF_WHITELIST[doc] = "A list of variables allowed through from the build system configuration into the extensible SDK configuration." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of variables allowed through from the OpenEmbedded - build system configuration into the extensible SDK - configuration. - By default, the list of variables is empty and is set in - the - <link linkend='ref-classes-populate-sdk-*'><filename>populate-sdk-ext</filename></link> - class. - </para> - - <para> - This list overrides the variables specified using the - <link linkend='var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></link> - variable as well as any variables identified by automatic - blacklisting due to the "/" character being found at the - start of the value, which is usually indicative of being a - path and thus might not be valid on the system where the - SDK is installed. - </para> - - <para> - For additional information on how to customize the - extensible SDK's configuration, see the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-configuring-the-extensible-sdk'>Configuring the Extensible SDK</ulink>" - section in the Yocto Project Application Development and - the Extensible Software Development Kit (eSDK) manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm> - <info> - SDK_NAME[doc] = "The base name for SDK output files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The base name for SDK output files. - The name is derived from the - <link linkend='var-DISTRO'><filename>DISTRO</filename></link>, - <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, - <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>, - <link linkend='var-IMAGE_BASENAME'><filename>IMAGE_BASENAME</filename></link>, - and - <link linkend='var-TUNE_PKGARCH'><filename>TUNE_PKGARCH</filename></link> - variables: - <literallayout class='monospaced'> - SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_OS'><glossterm>SDK_OS</glossterm> - <info> - SDK_OS[doc] = "The operating system for which the SDK will be built." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the operating system for which the SDK - will be built. - The default value is the value of - <link linkend='var-BUILD_OS'><filename>BUILD_OS</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_OUTPUT'><glossterm>SDK_OUTPUT</glossterm> - <info> - SDK_OUTPUT[doc] = "The location used by the OpenEmbedded build system when creating SDK output." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The location used by the OpenEmbedded build system when - creating SDK output. - The - <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> - class defines the variable as follows: - <literallayout class='monospaced'> - SDK_DIR = "${WORKDIR}/sdk" - SDK_OUTPUT = "${SDK_DIR}/image" - SDK_DEPLOY = "${DEPLOY_DIR}/sdk" - </literallayout> - <note> - The <filename>SDK_OUTPUT</filename> directory is a - temporary directory as it is part of - <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> - by way of - <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link>. - The final output directory is - <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link>. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_PACKAGE_ARCHS'><glossterm>SDK_PACKAGE_ARCHS</glossterm> - <info> - SDK_PACKAGE_ARCHS[doc] = "Specifies a list of architectures compatible with the SDK machine. This variable is set automatically and should not normally be hand-edited." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of architectures compatible with - the SDK machine. - This variable is set automatically and should not - normally be hand-edited. - Entries are separated using spaces and listed in order - of priority. - The default value for - <filename>SDK_PACKAGE_ARCHS</filename> is "all any noarch - ${SDK_ARCH}-${SDKPKGSUFFIX}". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_POSTPROCESS_COMMAND'><glossterm>SDK_POSTPROCESS_COMMAND</glossterm> - <info> - SDK_POSTPROCESS_COMMAND[doc] = "Specifies a list of functions to call once the OpenEmbedded build system creates the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of functions to call once the - OpenEmbedded build system creates the SDK. - You can specify functions separated by semicolons: - <literallayout class='monospaced'> - SDK_POSTPROCESS_COMMAND += "<replaceable>function</replaceable>; ... " - </literallayout> - </para> - - <para> - If you need to pass an SDK path to a command within a - function, you can use - <filename>${SDK_DIR}</filename>, which points to - the parent directory used by the OpenEmbedded build system - when creating SDK output. - See the - <link linkend='var-SDK_DIR'><filename>SDK_DIR</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_PREFIX'><glossterm>SDK_PREFIX</glossterm> - <info> - SDK_PREFIX[doc] = "The toolchain binary prefix used for nativesdk recipes." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The toolchain binary prefix used for - <filename>nativesdk</filename> recipes. - The OpenEmbedded build system uses the - <filename>SDK_PREFIX</filename> value to set the - <link linkend='var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></link> - when building <filename>nativesdk</filename> recipes. - The default value is "${SDK_SYS}-". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_RECRDEP_TASKS'><glossterm>SDK_RECRDEP_TASKS</glossterm> - <info> - SDK_RECRDEP_TASKS[doc] = "A list of shared state tasks added to the extensible SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of shared state tasks added to the extensible SDK. - By default, the following tasks are added: - <literallayout class='monospaced'> - do_populate_lic - do_package_qa - do_populate_sysroot - do_deploy - </literallayout> - Despite the default value of "" for the - <filename>SDK_RECRDEP_TASKS</filename> variable, the - above four tasks are always added to the SDK. - To specify tasks beyond these four, you need to use - the <filename>SDK_RECRDEP_TASKS</filename> variable (e.g. - you are defining additional tasks that are needed in - order to build - <link linkend='var-SDK_TARGETS'><filename>SDK_TARGETS</filename></link>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_SYS'><glossterm>SDK_SYS</glossterm> - <info> - SDK_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the SDK will be built." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the system, including the architecture and the - operating system, for which the SDK will be built. - </para> - - <para> - The OpenEmbedded build system automatically sets this - variable based on - <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>, - <link linkend='var-SDK_VENDOR'><filename>SDK_VENDOR</filename></link>, - and - <link linkend='var-SDK_OS'><filename>SDK_OS</filename></link>. - You do not need to set the <filename>SDK_SYS</filename> - variable yourself. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_TARGET_MANIFEST'><glossterm>SDK_TARGET_MANIFEST</glossterm> - <info> - SDK_TARGET_MANIFEST[doc] = "The manifest file for the target part of the SDK. This file lists all the installed packages that make up the target part of the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The manifest file for the target part of the SDK. - This file lists all the installed packages that make up - the target part of the SDK. - The file contains package information on a line-per-package - basis as follows: - <literallayout class='monospaced'> - <replaceable>packagename</replaceable> <replaceable>packagearch</replaceable> <replaceable>version</replaceable> - </literallayout> - </para> - - <para> - The - <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> - class defines the manifest file as follows: - <literallayout class='monospaced'> - SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" - </literallayout> - The location is derived using the - <link linkend='var-SDK_DEPLOY'><filename>SDK_DEPLOY</filename></link> - and - <link linkend='var-TOOLCHAIN_OUTPUTNAME'><filename>TOOLCHAIN_OUTPUTNAME</filename></link> - variables. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_TARGETS'><glossterm>SDK_TARGETS</glossterm> - <info> - SDK_TARGETS[doc] = "A list of targets to install from shared state as part of the standard or extensible SDK installation." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of targets to install from shared state as part of - the standard or extensible SDK installation. - The default value is "${PN}" (i.e. the image from which - the SDK is built). - </para> - - <para> - The <filename>SDK_TARGETS</filename> variable is an - internal variable and typically would not be changed. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_TITLE'><glossterm>SDK_TITLE</glossterm> - <info> - SDK_TITLE[doc] = "The title to be printed when running the SDK installer." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The title to be printed when running the SDK installer. - By default, this title is based on the - <link linkend='var-DISTRO_NAME'><filename>DISTRO_NAME</filename></link> - or - <link linkend='var-DISTRO'><filename>DISTRO</filename></link> - variable and is set in the - <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> - class as follows: - <literallayout class='monospaced'> - SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" - </literallayout> - For the default distribution "poky", - <filename>SDK_TITLE</filename> is set to - "Poky (Yocto Project Reference Distro)". - </para> - - <para> - For information on how to change this default title, - see the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-changing-the-sdk-installer-title'>Changing the Extensible SDK Installer Title</ulink>" - section in the Yocto Project Application Development and - the Extensible Software Development Kit (eSDK) manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_UPDATE_URL'><glossterm>SDK_UPDATE_URL</glossterm> - <info> - SDK_UPDATE_URL[doc] = "An optional URL for an update server for the extensible SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - An optional URL for an update server for the extensible - SDK. - If set, the value is used as the default update server when - running <filename>devtool sdk-update</filename> within the - extensible SDK. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm> - <info> - SDK_VENDOR[doc] = "Specifies the name of the SDK vendor." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the name of the SDK vendor. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDK_VERSION'><glossterm>SDK_VERSION</glossterm> - <info> - SDK_VERSION[doc] = "Specifies the version for the SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the version of the SDK. - The distribution configuration file (e.g. - <filename>/meta-poky/conf/distro/poky.conf</filename>) - defines the <filename>SDK_VERSION</filename> as follows: - <literallayout class='monospaced'> - SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${DATE}','snapshot')}" - </literallayout> - </para> - - <para> - For additional information, see the - <link linkend='var-DISTRO_VERSION'><filename>DISTRO_VERSION</filename></link> - and - <link linkend='var-DATE'><filename>DATE</filename></link> - variables. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDKEXTPATH'><glossterm>SDKEXTPATH</glossterm> - <info> - SDKEXTPATH[doc] = "The default installation directory for the extensible SDK." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The default installation directory for the Extensible SDK. - By default, this directory is based on the - <link linkend='var-DISTRO'><filename>DISTRO</filename></link> - variable and is set in the - <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> - class as follows: - <literallayout class='monospaced'> - SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" - </literallayout> - For the default distribution "poky", the - <filename>SDKEXTPATH</filename> is set to "poky_sdk". - </para> - - <para> - For information on how to change this default directory, - see the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-changing-the-default-sdk-installation-directory'>Changing the Default SDK Installation Directory</ulink>" - section in the Yocto Project Application Development and - the Extensible Software Development Kit (eSDK) manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm> - <info> - SDKIMAGE_FEATURES[doc] = "Equivalent to IMAGE_FEATURES. However, this variable applies to the SDK generated from an image using the command 'bitbake -c populate_sdk imagename'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Equivalent to - <filename><link linkend='var-IMAGE_FEATURES'>IMAGE_FEATURES</link></filename>. - However, this variable applies to the SDK generated from an - image using the following command: - <literallayout class='monospaced'> - $ bitbake -c populate_sdk <replaceable>imagename</replaceable> - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDKMACHINE'><glossterm>SDKMACHINE</glossterm> - <info> - SDKMACHINE[doc] = "Specifies the architecture (i.e. i686 or x86_64) for which to build SDK items." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The machine for which the SDK is built. - In other words, the SDK is built such that it - runs on the target you specify with the - <filename>SDKMACHINE</filename> value. - The value points to a corresponding - <filename>.conf</filename> file under - <filename>conf/machine-sdk/</filename>. - </para> - - <para> - You can use "i686" and "x86_64" as possible values - for this variable. The variable defaults to "i686" - and is set in the local.conf file in the Build Directory. - <literallayout class='monospaced'> - SDKMACHINE ?= "i686" - </literallayout> - <note> - You cannot set the <filename>SDKMACHINE</filename> - variable in your distribution configuration file. - If you do, the configuration will not take affect. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDKPATH'><glossterm>SDKPATH</glossterm> - <info> - SDKPATH[doc] = "Defines the path offered to the user for installation of the SDK that is generated by the OpenEmbedded build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the path offered to the user for installation - of the SDK that is generated by the OpenEmbedded build - system. - The path appears as the default location for installing - the SDK when you run the SDK's installation script. - You can override the offered path when you run the - script. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SDKTARGETSYSROOT'><glossterm>SDKTARGETSYSROOT</glossterm> - <info> - SDKTARGETSYSROOT[doc] = "Full path to the sysroot used for cross-compilation within an SDK as it will be when installed into the default SDKPATH." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The full path to the sysroot used for cross-compilation - within an SDK as it will be when installed into the - default - <link linkend='var-SDKPATH'><filename>SDKPATH</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SECTION'><glossterm>SECTION</glossterm> - <info> - SECTION[doc] = "The section in which packages should be categorized. Package management utilities can make use of this variable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The section in which packages should be categorized. - Package management utilities can make use of this variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SELECTED_OPTIMIZATION'><glossterm>SELECTED_OPTIMIZATION</glossterm> - <info> - SELECTED_OPTIMIZATION[doc] = "The variable takes the value of FULL_OPTIMIZATION unless DEBUG_BUILD = '1'. In this case, the value of DEBUG_OPTIMIZATION is used." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the optimization flags passed to the C compiler - when building for the target. - The flags are passed through the default value of the - <link linkend='var-TARGET_CFLAGS'><filename>TARGET_CFLAGS</filename></link> - variable. - </para> - - <para> - The <filename>SELECTED_OPTIMIZATION</filename> variable - takes the value of - <filename><link linkend='var-FULL_OPTIMIZATION'>FULL_OPTIMIZATION</link></filename> - unless <filename><link linkend='var-DEBUG_BUILD'>DEBUG_BUILD</link></filename> = "1". - If that is the case, the value of - <filename><link linkend='var-DEBUG_OPTIMIZATION'>DEBUG_OPTIMIZATION</link></filename> is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SERIAL_CONSOLE'><glossterm>SERIAL_CONSOLE</glossterm> - <info> - SERIAL_CONSOLE[doc] = "Defines the serial consoles (TTYs) to enable using getty." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines a serial console (TTY) to enable using - <ulink url='https://en.wikipedia.org/wiki/Getty_(Unix)'>getty</ulink>. - Provide a value that specifies the baud rate followed by - the TTY device name separated by a space. - You cannot specify more than one TTY device: - <literallayout class='monospaced'> - SERIAL_CONSOLE = "115200 ttyS0" - </literallayout> - <note> - The <filename>SERIAL_CONSOLE</filename> variable - is deprecated. - Please use the - <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link> - variable. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SERIAL_CONSOLES'><glossterm>SERIAL_CONSOLES</glossterm> - <info> - SERIAL_CONSOLES[doc] = "Defines the serial consoles (TTYs) to enable using getty." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines a serial console (TTY) to enable using - <ulink url='https://en.wikipedia.org/wiki/Getty_(Unix)'>getty</ulink>. - Provide a value that specifies the baud rate followed by - the TTY device name separated by a semicolon. - Use spaces to separate multiple devices: - <literallayout class='monospaced'> - SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SERIAL_CONSOLES_CHECK'><glossterm>SERIAL_CONSOLES_CHECK</glossterm> - <info> - SERIAL_CONSOLES_CHECK[doc] = "Selected SERIAL_CONSOLES to check against /proc/console before enabling using getty. Supported only by SysVinit." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies serial consoles, which must be listed in - <link linkend='var-SERIAL_CONSOLES'><filename>SERIAL_CONSOLES</filename></link>, - to check against <filename>/proc/console</filename> - before enabling them using getty. - This variable allows aliasing in the format: - <device>:<alias>. - If a device was listed as "sclp_line0" - in <filename>/dev/</filename> and "ttyS0" was listed - in <filename>/proc/console</filename>, you would do the - following: - <literallayout class='monospaced'> - SERIAL_CONSOLES_CHECK = "slcp_line0:ttyS0" - </literallayout> - This variable is currently only supported with SysVinit - (i.e. not with systemd). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS'><glossterm>SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS</glossterm> - <info> - SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS[doc] = "A list of recipe dependencies that should not be used to determine signatures of tasks from one recipe when they depend on tasks from another recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of recipe dependencies that should not be used to - determine signatures of tasks from one recipe when they - depend on tasks from another recipe. - For example: - <literallayout class='monospaced'> - SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2" - </literallayout> - </para> - - <para> - In the previous example, <filename>intone</filename> - depends on <filename>mplayer2</filename>. - </para> - - <para> - You can use the special token <filename>"*"</filename> on - the left-hand side of the dependency to match all - recipes except the one on the right-hand side. - Here is an example: - <literallayout class='monospaced'> - SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "*->quilt-native" - </literallayout> - </para> - - <para> - In the previous example, all recipes except - <filename>quilt-native</filename> ignore task - signatures from the <filename>quilt-native</filename> - recipe when determining their task signatures. - </para> - - <para> - Use of this variable is one mechanism to remove dependencies - that affect task signatures and thus force rebuilds when a - recipe changes. - <note><title>Caution</title> - If you add an inappropriate dependency for a recipe - relationship, the software might break during - runtime if the interface of the second recipe was - changed after the first recipe had been built. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SIGGEN_EXCLUDERECIPES_ABISAFE'><glossterm>SIGGEN_EXCLUDERECIPES_ABISAFE</glossterm> - <info> - SIGGEN_EXCLUDERECIPES_ABISAFE[doc] = "A list of recipes that are completely stable and will never change." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of recipes that are completely stable and will - never change. - The ABI for the recipes in the list are presented by - output from the tasks run to build the recipe. - Use of this variable is one way to remove dependencies from - one recipe on another that affect task signatures and - thus force rebuilds when the recipe changes. - <note><title>Caution</title> - If you add an inappropriate variable to this list, - the software might break at runtime if the - interface of the recipe was changed after the other - had been built. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SITEINFO_BITS'><glossterm>SITEINFO_BITS</glossterm> - <info> - SITEINFO_BITS[doc] = "Specifies the number of bits for the target system CPU." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the number of bits for the target system CPU. - The value should be either "32" or "64". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SITEINFO_ENDIANNESS'><glossterm>SITEINFO_ENDIANNESS</glossterm> - <info> - SITEINFO_ENDIANNESS[doc] = "Specifies the endian byte order of the target system. The value should be either 'le' for 'little-endian' or 'be' for 'big-endian'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the endian byte order of the target system. - The value should be either "le" for little-endian or "be" for big-endian. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SKIP_FILEDEPS'><glossterm>SKIP_FILEDEPS</glossterm> - <info> - SKIP_FILEDEPS[doc] = "Enables you to remove all files from - the "Provides" section of an RPM package." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Enables removal of all files from the "Provides" section of - an RPM package. - Removal of these files is required for packages containing - prebuilt binaries and libraries such as - <filename>libstdc++</filename> and - <filename>glibc</filename>. - </para> - - <para> - To enable file removal, set the variable to "1" in your - <filename>conf/local.conf</filename> configuration file - in your: - <link linkend='build-directory'>Build Directory</link>. - <literallayout class='monospaced'> - SKIP_FILEDEPS = "1" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SOC_FAMILY'><glossterm>SOC_FAMILY</glossterm> - <info> - SOC_FAMILY[doc] = "Groups together machines based upon the same family of SOC (System On Chip). You typically set this variable in a common .inc file that you include in the configuration files of all the machines." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Groups together machines based upon the same family - of SOC (System On Chip). - You typically set this variable in a common - <filename>.inc</filename> file that you include in the - configuration files of all the machines. - <note> - You must include - <filename>conf/machine/include/soc-family.inc</filename> - for this variable to appear in - <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SOLIBS'><glossterm>SOLIBS</glossterm> - <info> - SOLIBS[doc] = "Defines the suffix for shared libraries used on the target platform." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the suffix for shared libraries used on the - target platform. - By default, this suffix is ".so.*" for all Linux-based - systems and is defined in the - <filename>meta/conf/bitbake.conf</filename> configuration - file. - </para> - - <para> - You will see this variable referenced in the default values - of <filename>FILES_${PN}</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SOLIBSDEV'><glossterm>SOLIBSDEV</glossterm> - <info> - SOLIBSDEV[doc] = "Defines the suffix for the development symbolic link (symlink) for shared libraries on the target platform." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines the suffix for the development symbolic link - (symlink) for shared libraries on the target platform. - By default, this suffix is ".so" for Linux-based - systems and is defined in the - <filename>meta/conf/bitbake.conf</filename> configuration - file. - </para> - - <para> - You will see this variable referenced in the default values - of <filename>FILES_${PN}-dev</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SOURCE_MIRROR_FETCH'><glossterm>SOURCE_MIRROR_FETCH</glossterm> - <info> - SOURCE_MIRROR_FETCH[doc] = "Set as part of a source mirror generation script to skip COMPATIBLE_MACHINE and COMPATIBLE_HOST checks." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When you are fetching files to create a mirror of sources - (i.e. creating a source mirror), setting - <filename>SOURCE_MIRROR_FETCH</filename> to "1" in your - <filename>local.conf</filename> configuration file ensures - the source for all recipes are fetched regardless of - whether or not a recipe is compatible with the - configuration. - A recipe is considered incompatible with the currently - configured machine when either or both the - <link linkend='var-COMPATIBLE_MACHINE'><filename>COMPATIBLE_MACHINE</filename></link> - variable and - <link linkend='var-COMPATIBLE_HOST'><filename>COMPATIBLE_HOST</filename></link> - variables specify compatibility with a machine other - than that of the current machine or host. - <note><title>Warning</title> - Do not set the - <filename>SOURCE_MIRROR_FETCH</filename> variable - unless you are creating a source mirror. - In other words, do not set the variable during a - normal build. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SOURCE_MIRROR_URL'><glossterm>SOURCE_MIRROR_URL</glossterm> - <info> - SOURCE_MIRROR_URL[doc] = "URL to source mirror that will be used before fetching from original SRC_URI." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Defines your own - <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> - from which to first fetch source before attempting to fetch - from the upstream specified in - <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>. - </para> - - <para> - To use this variable, you must globally inherit the - <link linkend='ref-classes-own-mirrors'><filename>own-mirrors</filename></link> - class and then provide the URL to your mirrors. - Here is the general syntax: - <literallayout class='monospaced'> - INHERIT += "own-mirrors" - SOURCE_MIRROR_URL = "http://<replaceable>example</replaceable>.com/<replaceable>my_source_mirror</replaceable>" - </literallayout> - <note> - You can specify only a single URL in - <filename>SOURCE_MIRROR_URL</filename>. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SPDXLICENSEMAP'><glossterm>SPDXLICENSEMAP</glossterm> - <info> - SPDXLICENSEMAP[doc] = "Maps commonly used license names to their SPDX counterparts found in meta/files/common-licenses/." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Maps commonly used license names to their SPDX counterparts - found in <filename>meta/files/common-licenses/</filename>. - For the default <filename>SPDXLICENSEMAP</filename> - mappings, see the - <filename>meta/conf/licenses.conf</filename> file. - </para> - - <para> - For additional information, see the - <link linkend='var-LICENSE'><filename>LICENSE</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SPECIAL_PKGSUFFIX'><glossterm>SPECIAL_PKGSUFFIX</glossterm> - <info> - SPECIAL_PKGSUFFIX[doc] = "A list of prefixes for PN used by the OpenEmbedded build system to create variants of recipes or packages. The list specifies the prefixes to strip off during certain circumstances such as the generation of the BPN variable." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of prefixes for <link linkend='var-PN'><filename>PN</filename></link> used by the - OpenEmbedded build system to create variants of recipes or packages. - The list specifies the prefixes to strip off during certain circumstances - such as the generation of the <link linkend='var-BPN'><filename>BPN</filename></link> variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SPL_BINARY'><glossterm>SPL_BINARY</glossterm> - <info> - SPL_BINARY[doc] = "The file type of the Secondary Program Loader (SPL)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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 <filename>u-boot.inc</filename> include - file, which is used in the U-Boot recipe. - </para> - - <para> - The SPL file type is set to "null" by default in the - <filename>u-boot.inc</filename> file as follows: - <literallayout class='monospaced'> - # 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}" - </literallayout> - The <filename>SPL_BINARY</filename> variable helps form - various <filename>SPL_*</filename> variables used by - the OpenEmbedded build system. - </para> - - <para> - See the BeagleBone machine configuration example in the - "<ulink url='&YOCTO_DOCS_BSP_URL;#creating-a-new-bsp-layer-using-the-bitbake-layers-script'>Creating a new BSP Layer Using the <filename>bitbake-layers</filename> Script</ulink>" - section in the Yocto Project Board Support Package - Developer's Guide for additional information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> - <info> - SRC_URI[doc] = "The list of source files - local or remote. This variable tells the OpenEmbedded build system what bits to pull in for the build and how to pull them in." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The list of source files - local or remote. - This variable tells the OpenEmbedded build system which bits - to pull in for the build and how to pull them in. - For example, if the recipe or append file only needs to - fetch a tarball from the Internet, the recipe or - append file uses a single <filename>SRC_URI</filename> - entry. - On the other hand, if the recipe or append file needs to - fetch a tarball, apply two patches, and include a custom - file, the recipe or append file would include four - instances of the variable. - </para> - - <para> - The following list explains the available URI protocols. - URI protocols are highly dependent on particular BitBake - Fetcher submodules. - Depending on the fetcher BitBake uses, various URL - parameters are employed. - For specifics on the supported Fetchers, see the - "<ulink url='&YOCTO_DOCS_BB_URL;#bb-fetchers'>Fetchers</ulink>" - section in the BitBake User Manual. - <itemizedlist> - <listitem><para><emphasis><filename>file://</filename> -</emphasis> - Fetches files, which are usually files shipped with - the - <link linkend='metadata'>Metadata</link>, - from the local machine (e.g. - <ulink url='&YOCTO_DOCS_OM_URL;#patching-dev-environment'>patch</ulink> - files). - The path is relative to the - <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> - variable. - Thus, the build system searches, in order, from the - following directories, which are assumed to be a - subdirectories of the directory in which the - recipe file (<filename>.bb</filename>) or - append file (<filename>.bbappend</filename>) - resides: - <itemizedlist> - <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> - The base recipe name without any special - suffix or version numbers. - </para></listitem> - <listitem><para><emphasis><filename>${BP}</filename> -</emphasis> - <filename>${<link linkend='var-BPN'>BPN</link>}-${PV}</filename>. - The base recipe name and version but without - any special package name suffix. - </para></listitem> - <listitem><para><emphasis>files -</emphasis> - Files within a directory, which is named - <filename>files</filename> and is also - alongside the recipe or append file. - </para></listitem> - </itemizedlist> - <note> - If you want the build system to pick up files - specified through a - <filename>SRC_URI</filename> - statement from your append file, you need to be - sure to extend the - <filename>FILESPATH</filename> - variable by also using the - <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link> - variable from within your append file. - </note> - </para></listitem> - <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a - Bazaar revision control repository.</para></listitem> - <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a - Git revision control repository.</para></listitem> - <listitem><para><emphasis><filename>osc://</filename> -</emphasis> Fetches files from - an OSC (OpenSUSE Build service) revision control repository.</para></listitem> - <listitem><para><emphasis><filename>repo://</filename> -</emphasis> Fetches files from - a repo (Git) repository.</para></listitem> - <listitem><para><emphasis><filename>ccrc://</filename> -</emphasis> - Fetches files from a ClearCase repository. - </para></listitem> - <listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from - the Internet using <filename>http</filename>.</para></listitem> - <listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files - from the Internet using <filename>https</filename>.</para></listitem> - <listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files - from the Internet using <filename>ftp</filename>.</para></listitem> - <listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from - a CVS revision control repository.</para></listitem> - <listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from - a Mercurial (<filename>hg</filename>) revision control repository.</para></listitem> - <listitem><para><emphasis><filename>p4://</filename> -</emphasis> Fetches files from - a Perforce (<filename>p4</filename>) revision control repository.</para></listitem> - <listitem><para><emphasis><filename>ssh://</filename> -</emphasis> Fetches files from - a secure shell.</para></listitem> - <listitem><para><emphasis><filename>svn://</filename> -</emphasis> Fetches files from - a Subversion (<filename>svn</filename>) revision control repository.</para></listitem> - </itemizedlist> - </para> - - <para> - Standard and recipe-specific options for <filename>SRC_URI</filename> exist. - Here are standard options: - <itemizedlist> - <listitem><para><emphasis><filename>apply</filename> -</emphasis> Whether to apply - the patch or not. - The default action is to apply the patch.</para></listitem> - <listitem><para><emphasis><filename>striplevel</filename> -</emphasis> Which - striplevel to use when applying the patch. - The default level is 1.</para></listitem> - <listitem><para><emphasis><filename>patchdir</filename> -</emphasis> Specifies - the directory in which the patch should be applied. - The default is <filename>${</filename><link linkend='var-S'><filename>S</filename></link><filename>}</filename>. - </para></listitem> - </itemizedlist> - </para> - - <para> - Here are options specific to recipes building code from a revision control system: - <itemizedlist> - <listitem><para><emphasis><filename>mindate</filename> -</emphasis> - Apply the patch only if - <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link> - is equal to or greater than <filename>mindate</filename>. - </para></listitem> - <listitem><para><emphasis><filename>maxdate</filename> -</emphasis> - Apply the patch only if <filename>SRCDATE</filename> - is not later than <filename>maxdate</filename>. - </para></listitem> - <listitem><para><emphasis><filename>minrev</filename> -</emphasis> - Apply the patch only if <filename>SRCREV</filename> - is equal to or greater than <filename>minrev</filename>. - </para></listitem> - <listitem><para><emphasis><filename>maxrev</filename> -</emphasis> - Apply the patch only if <filename>SRCREV</filename> - is not later than <filename>maxrev</filename>. - </para></listitem> - <listitem><para><emphasis><filename>rev</filename> -</emphasis> - Apply the patch only if <filename>SRCREV</filename> - is equal to <filename>rev</filename>. - </para></listitem> - <listitem><para><emphasis><filename>notrev</filename> -</emphasis> - Apply the patch only if <filename>SRCREV</filename> - is not equal to <filename>rev</filename>. - </para></listitem> - </itemizedlist> - </para> - - <para> - Here are some additional options worth mentioning: - <itemizedlist> - <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls - whether or not to unpack the file if it is an archive. - The default action is to unpack the file.</para></listitem> - <listitem><para><emphasis><filename>destsuffix</filename> -</emphasis> Places the file - (or extracts its contents) into the specified - subdirectory of <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> - when the Git fetcher is used. - </para></listitem> - <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file - (or extracts its contents) into the specified - subdirectory of <filename>WORKDIR</filename> - when the local (<filename>file://</filename>) - fetcher is used. - </para></listitem> - <listitem><para><emphasis><filename>localdir</filename> -</emphasis> Places the file - (or extracts its contents) into the specified - subdirectory of <filename>WORKDIR</filename> when - the CVS fetcher is used. - </para></listitem> - <listitem><para><emphasis><filename>subpath</filename> -</emphasis> - Limits the checkout to a specific subpath of the - tree when using the Git fetcher is used. - </para></listitem> - <listitem><para><emphasis><filename>name</filename> -</emphasis> Specifies a - name to be used for association with <filename>SRC_URI</filename> checksums - when you have more than one file specified in <filename>SRC_URI</filename>. - </para></listitem> - <listitem><para><emphasis><filename>downloadfilename</filename> -</emphasis> Specifies - the filename used when storing the downloaded file.</para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SRC_URI_OVERRIDES_PACKAGE_ARCH'><glossterm>SRC_URI_OVERRIDES_PACKAGE_ARCH</glossterm> - <info> - SRC_URI_OVERRIDES_PACKAGE_ARCH[doc] = "By default, the OpenEmbedded build system automatically detects whether SRC_URI contains files that are machine-specific. If so, the build system automatically changes PACKAGE_ARCH. Setting this variable to '0' disables this behavior." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - By default, the OpenEmbedded build system automatically detects whether - <filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> - contains files that are machine-specific. - If so, the build system automatically changes - <filename><link linkend='var-PACKAGE_ARCH'>PACKAGE_ARCH</link></filename>. - Setting this variable to "0" disables this behavior. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SRCDATE'><glossterm>SRCDATE</glossterm> - <info> - SRCDATE[doc] = "The date of the source code used to build the package. This variable applies only if the source was fetched from a Source Code Manager (SCM)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The date of the source code used to build the package. - This variable applies only if the source was fetched from a Source Code Manager (SCM). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SRCPV'><glossterm>SRCPV</glossterm> - <info> - SRCPV[doc] = "Returns the version string of the current package. This string is used to help define the value of PV." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Returns the version string of the current package. - This string is used to help define the value of - <link linkend='var-PV'><filename>PV</filename></link>. - </para> - - <para> - The <filename>SRCPV</filename> variable is defined in the - <filename>meta/conf/bitbake.conf</filename> configuration - file in the - <link linkend='source-directory'>Source Directory</link> - as follows: - <literallayout class='monospaced'> - SRCPV = "${@bb.fetch2.get_srcrev(d)}" - </literallayout> - </para> - - <para> - Recipes that need to define <filename>PV</filename> do so - with the help of the <filename>SRCPV</filename>. - For example, the <filename>ofono</filename> recipe - (<filename>ofono_git.bb</filename>) located in - <filename>meta/recipes-connectivity</filename> in the - Source Directory defines <filename>PV</filename> as - follows: - <literallayout class='monospaced'> - PV = "0.12-git${SRCPV}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SRCREV'><glossterm>SRCREV</glossterm> - <info> - SRCREV[doc] = "The revision of the source code used to build the package. This variable applies to Subversion, Git, Mercurial, and Bazaar only." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The revision of the source code used to build the package. - This variable applies to Subversion, Git, Mercurial, and - Bazaar only. - Note that if you want to build a fixed revision and you - want to avoid performing a query on the remote repository - every time BitBake parses your recipe, you should specify - a <filename>SRCREV</filename> that is a - full revision identifier and not just a tag. - <note> - For information on limitations when inheriting the - latest revision of software using - <filename>SRCREV</filename>, see the - <link linkend='var-AUTOREV'><filename>AUTOREV</filename></link> - variable description and the - "<ulink url='&YOCTO_DOCS_DEV_URL;#automatically-incrementing-a-binary-package-revision-number'>Automatically Incrementing a Binary Package Revision Number</ulink>" - section, which is in the Yocto Project Development - Tasks Manual. - </note> - </para> - - </glossdef> - </glossentry> - - <glossentry id='var-SSTATE_DIR'><glossterm>SSTATE_DIR</glossterm> - <info> - SSTATE_DIR[doc] = "The directory for the shared state cache." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The directory for the shared state cache. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SSTATE_MIRROR_ALLOW_NETWORK'><glossterm>SSTATE_MIRROR_ALLOW_NETWORK</glossterm> - <info> - SSTATE_MIRROR_ALLOW_NETWORK[doc] = "If set to "1", allows fetches from mirrors that are specified in SSTATE_MIRRORS to work even when fetching from the network is disabled by setting BB_NO_NETWORK to "1"." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set to "1", allows fetches from - mirrors that are specified in - <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> - to work even when fetching from the network is - disabled by setting <filename>BB_NO_NETWORK</filename> - to "1". - Using the - <filename>SSTATE_MIRROR_ALLOW_NETWORK</filename> - variable is useful if you have set - <filename>SSTATE_MIRRORS</filename> to point to an - internal server for your shared state cache, but - you want to disable any other fetching from the network. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SSTATE_MIRRORS'><glossterm>SSTATE_MIRRORS</glossterm> - <info> - SSTATE_MIRRORS[doc] = "Configures the OpenEmbedded build system to search other mirror locations for prebuilt cache data objects before building out the data. You can specify a filesystem directory or a remote URL such as HTTP or FTP." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Configures the OpenEmbedded build system to search other - mirror locations for prebuilt cache data objects before - building out the data. - This variable works like fetcher - <link linkend='var-MIRRORS'><filename>MIRRORS</filename></link> - and <link linkend='var-PREMIRRORS'><filename>PREMIRRORS</filename></link> - and points to the cache locations to check for the shared - state (sstate) objects. - </para> - - <para> - You can specify a filesystem directory or a remote URL such - as HTTP or FTP. - The locations you specify need to contain the shared state - cache (sstate-cache) results from previous builds. - The sstate-cache you point to can also be from builds on - other machines. - </para> - - <para> - When pointing to sstate build artifacts on another machine - that uses a different GCC version for native builds, - you must configure <filename>SSTATE_MIRROR</filename> - with a regular expression that maps local search paths - to server paths. - The paths need to take into account - <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link> - set by the - <link linkend='ref-classes-uninative'><filename>uninative</filename></link> - class. - For example, the following maps the local search path - <filename>universal-4.9</filename> to the server-provided - path <replaceable>server_url_sstate_path</replaceable>: - <literallayout class='monospaced'> - SSTATE_MIRRORS ?= file://universal-4.9/(.*) http://<replaceable>server_url_sstate_path</replaceable>/universal-4.8/\1 \n - </literallayout> - </para> - - <para> - If a mirror uses the same structure as - <link linkend='var-SSTATE_DIR'><filename>SSTATE_DIR</filename></link>, - you need to add - "PATH" at the end as shown in the examples below. - The build system substitutes the correct path within the - directory structure. - <literallayout class='monospaced'> - SSTATE_MIRRORS ?= "\ - file://.* http://<replaceable>someserver</replaceable>.tld/share/sstate/PATH;downloadfilename=PATH \n \ - file://.* file:///<replaceable>some-local-dir</replaceable>/sstate/PATH" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SSTATE_SCAN_FILES'><glossterm>SSTATE_SCAN_FILES</glossterm> - <info> - SSTATE_SCAN_FILES[doc] = "Controls the list of files the OpenEmbedded build system scans for hardcoded installation paths." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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. - </para> - - <para> - 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 <filename>SSTATE_SCAN_FILES</filename> variable. - Typically, recipes add files they want to be scanned to the - value of <filename>SSTATE_SCAN_FILES</filename> rather than - the variable being comprehensively set. The - <link linkend='ref-classes-sstate'><filename>sstate</filename></link> - class specifies the default list of files. - </para> - - <para> - For details on the process, see the - <link linkend='ref-classes-staging'><filename>staging</filename></link> - class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_BASE_LIBDIR_NATIVE'><glossterm>STAGING_BASE_LIBDIR_NATIVE</glossterm> - <info> - STAGING_BASE_LIBDIR_NATIVE[doc] = "Specifies the path to the /lib subdirectory of the sysroot directory for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the <filename>/lib</filename> - subdirectory of the sysroot directory for the - build host. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_BASELIBDIR'><glossterm>STAGING_BASELIBDIR</glossterm> - <info> - STAGING_BASELIBDIR[doc] = "Specifies the path to the /lib subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the <filename>/lib</filename> - subdirectory of the sysroot directory for the target - for which the current recipe is being built - (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_BINDIR'><glossterm>STAGING_BINDIR</glossterm> - <info> - STAGING_BINDIR[doc] = "Specifies the path to the /usr/bin subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the - <filename>/usr/bin</filename> subdirectory of the - sysroot directory for the target for which the current - recipe is being built - (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_BINDIR_CROSS'><glossterm>STAGING_BINDIR_CROSS</glossterm> - <info> - STAGING_BINDIR_CROSS[doc] = "Specifies the path to the directory containing binary configuration scripts. These scripts provide configuration information for other software that wants to make use of libraries or include files provided by the software associated with the script." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the directory containing binary - configuration scripts. - These scripts provide configuration information for - other software that wants to make use of libraries or - include files provided by the software associated with - the script. - <note> - This style of build configuration has been largely - replaced by <filename>pkg-config</filename>. - Consequently, if <filename>pkg-config</filename> - is supported by the library to which you are linking, - it is recommended you use - <filename>pkg-config</filename> instead of a - provided configuration script. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_BINDIR_NATIVE'><glossterm>STAGING_BINDIR_NATIVE</glossterm> - <info> - STAGING_BINDIR_NATIVE[doc] = "Specifies the path to the /usr/bin subdirectory of the sysroot directory for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the - <filename>/usr/bin</filename> subdirectory of the - sysroot directory for the build host. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_DATADIR'><glossterm>STAGING_DATADIR</glossterm> - <info> - STAGING_DATADIR[doc] = "Specifies the path to the /usr/share subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the <filename>/usr/share</filename> - subdirectory of the sysroot directory for the target - for which the current recipe is being built - (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_DATADIR_NATIVE'><glossterm>STAGING_DATADIR_NATIVE</glossterm> - <info> - STAGING_DATADIR_NATIVE[doc] = "Specifies the path to the /usr/share subdirectory of the sysroot directory for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the <filename>/usr/share</filename> - subdirectory of the sysroot directory for the build host. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_DIR'><glossterm>STAGING_DIR</glossterm> - <info> - STAGING_DIR[doc] = "Helps construct the recipe-sysroots directory, which is used during packaging." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Helps construct the <filename>recipe-sysroots</filename> - directory, which is used during packaging. - </para> - - <para> - For information on how staging for recipe-specific - sysroots occurs, see the - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task, the - "<ulink url='&YOCTO_DOCS_DEV_URL;#new-sharing-files-between-recipes'>Sharing Files Between Recipes</ulink>" - section in the Yocto Project Development Tasks Manual, the - "<ulink url='&YOCTO_DOCS_OM_URL;#configuration-compilation-and-staging-dev-environment'>Configuration, Compilation, and Staging</ulink>" - section in the Yocto Project Overview and Concepts Manual, - and the - <link linkend='var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></link> - variable. - <note> - Recipes should never write files directly under - the <filename>STAGING_DIR</filename> directory because - the OpenEmbedded build system - manages the directory automatically. - Instead, files should be installed to - <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> - within your recipe's - <link linkend='ref-tasks-install'><filename>do_install</filename></link> - task and then the OpenEmbedded build system will - stage a subset of those files into the sysroot. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_DIR_HOST'><glossterm>STAGING_DIR_HOST</glossterm> - <info> - STAGING_DIR_HOST[doc] = "Specifies the path to the sysroot directory for the system that the component is built to run on." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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 - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task copies files. - Exceptions include <filename>-native</filename> recipes, - where the <filename>do_populate_sysroot</filename> task - instead uses - <link linkend='var-STAGING_DIR_NATIVE'><filename>STAGING_DIR_NATIVE</filename></link>. - Depending on the type of recipe and the build target, - <filename>STAGING_DIR_HOST</filename> can have the - following values: - <itemizedlist> - <listitem><para> - For recipes building for the target machine, the - value is - "${<link linkend='var-STAGING_DIR'>STAGING_DIR</link>}/${<link linkend='var-MACHINE'>MACHINE</link>}". - </para></listitem> - <listitem><para> - For native recipes building for the build host, the - value is empty given the assumption that when - building for the build host, the build host's own - directories should be used. - <note> - <para><filename>-native</filename> recipes are - not installed into host paths like such as - <filename>/usr</filename>. - Rather, these recipes are installed into - <filename>STAGING_DIR_NATIVE</filename>. - When compiling <filename>-native</filename> - recipes, standard build environment variables - such as - <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link> - and - <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> - are set up so that both host paths and - <filename>STAGING_DIR_NATIVE</filename> are - searched for libraries and headers using, for - example, GCC's <filename>-isystem</filename> - option.</para> - - <para>Thus, the emphasis is that the - <filename>STAGING_DIR*</filename> variables - should be viewed as input variables by tasks - such as - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link>, - <link linkend='ref-tasks-compile'><filename>do_compile</filename></link>, - and - <link linkend='ref-tasks-install'><filename>do_install</filename></link>. - Having the real system root correspond to - <filename>STAGING_DIR_HOST</filename> makes - conceptual sense for - <filename>-native</filename> recipes, as - they make use of host headers and libraries. - </para> - </note> - </para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_DIR_NATIVE'><glossterm>STAGING_DIR_NATIVE</glossterm> - <info> - STAGING_DIR_NATIVE[doc] = "Specifies the path to the sysroot directory used when building components that run on the build host itself." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the sysroot directory used when - building components that run on the build host itself. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_DIR_TARGET'><glossterm>STAGING_DIR_TARGET</glossterm> - <info> - STAGING_DIR_TARGET[doc] = "Specifies the path to the sysroot used for the system for which the component generates code." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - 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, <filename>STAGING_DIR_TARGET</filename> is set - to match - <link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>. - </para> - - <para> - Some recipes build binaries that can run on the target - system but those binaries in turn generate code for - another different system (e.g. cross-canadian recipes). - Using terminology from GNU, the primary system is referred - to as the "HOST" and the secondary, or different, system is - referred to as the "TARGET". - Thus, the binaries run on the "HOST" system - and generate binaries for the "TARGET" system. - The <filename>STAGING_DIR_HOST</filename> variable points - to the sysroot used for the "HOST" system, while - <filename>STAGING_DIR_TARGET</filename> - points to the sysroot used for the "TARGET" system. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_ETCDIR_NATIVE'><glossterm>STAGING_ETCDIR_NATIVE</glossterm> - <info> - STAGING_ETCDIR_NATIVE[doc] = "Specifies the path to the /etc subdirectory of the sysroot directory for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the <filename>/etc</filename> - subdirectory of the sysroot directory for the - build host. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_EXECPREFIXDIR'><glossterm>STAGING_EXECPREFIXDIR</glossterm> - <info> - STAGING_EXECPREFIXDIR[doc] = "Specifies the path to the /usr subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the <filename>/usr</filename> - subdirectory of the sysroot directory for the target - for which the current recipe is being built - (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_INCDIR'><glossterm>STAGING_INCDIR</glossterm> - <info> - STAGING_INCDIR[doc] = "Specifies the path to the /usr/include subdirectory of the sysroot directory for the target for which the current recipe being built (STAGING_DIR_HOST)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the - <filename>/usr/include</filename> subdirectory of the - sysroot directory for the target for which the current - recipe being built - (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_INCDIR_NATIVE'><glossterm>STAGING_INCDIR_NATIVE</glossterm> - <info> - STAGING_INCDIR_NATIVE[doc] = "Specifies the path to the /usr/include subdirectory of the sysroot directory for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the <filename>/usr/include</filename> - subdirectory of the sysroot directory for the build host. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_KERNEL_BUILDDIR'><glossterm>STAGING_KERNEL_BUILDDIR</glossterm> - <info> - STAGING_KERNEL_BUILDDIR[doc] = "Points to the directory containing the kernel build artifacts." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the directory containing the kernel build - artifacts. - Recipes building software that needs to access kernel - build artifacts - (e.g. <filename>systemtap-uprobes</filename>) can look in - the directory specified with the - <filename>STAGING_KERNEL_BUILDDIR</filename> variable to - find these artifacts after the kernel has been built. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_KERNEL_DIR'><glossterm>STAGING_KERNEL_DIR</glossterm> - <info> - STAGING_KERNEL_DIR[doc] = "The directory with kernel headers that are required to build out-of-tree modules." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The directory with kernel headers that are required to build out-of-tree - modules. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_LIBDIR'><glossterm>STAGING_LIBDIR</glossterm> - <info> - STAGING_LIBDIR[doc] = "Specifies the path to the /usr/lib subdirectory of the sysroot directory for the target for which the current recipe is being built (STAGING_DIR_HOST)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the <filename>/usr/lib</filename> - subdirectory of the sysroot directory for the target for - which the current recipe is being built - (<link linkend='var-STAGING_DIR_HOST'><filename>STAGING_DIR_HOST</filename></link>). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAGING_LIBDIR_NATIVE'><glossterm>STAGING_LIBDIR_NATIVE</glossterm> - <info> - STAGING_LIBDIR_NATIVE[doc] = "Specifies the path to the /usr/lib subdirectory of the sysroot directory for the build host." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the path to the <filename>/usr/lib</filename> - subdirectory of the sysroot directory for the build host. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAMP'><glossterm>STAMP</glossterm> - <info> - STAMP[doc] = "Specifies the base path used to create recipe stamp files. The path to an actual stamp file is constructed by evaluating this string and then appending additional information." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the base path used to create recipe stamp files. - The path to an actual stamp file is constructed by evaluating this - string and then appending additional information. - Currently, the default assignment for <filename>STAMP</filename> - as set in the <filename>meta/conf/bitbake.conf</filename> file - is: - <literallayout class='monospaced'> - STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}" - </literallayout> - </para> - - <para> - For information on how BitBake uses stamp files to determine - if a task should be rerun, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#stamp-files-and-the-rerunning-of-tasks'>Stamp Files and the Rerunning of Tasks</ulink>" - section in the Yocto Project Overview and Concepts Manual. - </para> - - <para> - See <link linkend='var-STAMPS_DIR'><filename>STAMPS_DIR</filename></link>, - <link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>, - <link linkend='var-PN'><filename>PN</filename></link>, - <link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>, - <link linkend='var-PV'><filename>PV</filename></link>, and - <link linkend='var-PR'><filename>PR</filename></link> for related variable - information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STAMPS_DIR'><glossterm>STAMPS_DIR</glossterm> - <info> - STAMPS_DIR[doc] = "Specifies the base directory in which the OpenEmbedded build system places stamps." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the base directory in which the OpenEmbedded - build system places stamps. - The default directory is - <filename>${TMPDIR}/stamps</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-STRIP'><glossterm>STRIP</glossterm> - <info> - STRIP[doc] = "Minimal command and arguments to run 'strip' (strip symbols)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The minimal command and arguments to run - <filename>strip</filename>, which is used to strip - symbols. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> - <info> - SUMMARY[doc] = "The short (80 characters or less) summary of the binary package for packaging systems such as opkg, rpm, or dpkg. By default, SUMMARY is used to define the DESCRIPTION variable if DESCRIPTION is not set in the recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The short (72 characters or less) summary of the binary package for packaging - systems such as <filename>opkg</filename>, <filename>rpm</filename>, or - <filename>dpkg</filename>. - By default, <filename>SUMMARY</filename> is used to define - the <link linkend='var-DESCRIPTION'><filename>DESCRIPTION</filename></link> - variable if <filename>DESCRIPTION</filename> is not set - in the recipe. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SVNDIR'><glossterm>SVNDIR</glossterm> - <info> - SVNDIR[doc] = "The directory where Subversion checkouts are stored." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The directory in which files checked out of a Subversion - system are stored. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSLINUX_DEFAULT_CONSOLE'><glossterm>SYSLINUX_DEFAULT_CONSOLE</glossterm> - <info> - SYSLINUX_DEFAULT_CONSOLE[doc] = "Specifies the kernel boot default console." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the kernel boot default console. - If you want to use a console other than the default, - set this variable in your recipe as follows where "X" is - the console number you want to use: - <literallayout class='monospaced'> - SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" - </literallayout> - </para> - - <para> - The - <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> - class initially sets this variable to null but then checks - for a value later. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSLINUX_OPTS'><glossterm>SYSLINUX_OPTS</glossterm> - <info> - SYSLINUX_OPTS[doc] = "Lists additional options to add to the syslinux file." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Lists additional options to add to the syslinux file. - You need to set this variable in your recipe. - If you want to list multiple options, separate the options - with a semicolon character (<filename>;</filename>). - </para> - - <para> - The - <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> - class uses this variable to create a set of options. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSLINUX_SERIAL'><glossterm>SYSLINUX_SERIAL</glossterm> - <info> - SYSLINUX_SERIAL[doc] = "Specifies the alternate serial port or turns it off." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the alternate serial port or turns it off. - To turn off serial, set this variable to an empty string - in your recipe. - The variable's default value is set in the - <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> - class as follows: - <literallayout class='monospaced'> - SYSLINUX_SERIAL ?= "0 115200" - </literallayout> - </para> - - <para> - The class checks for and uses the variable as needed. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSLINUX_SPLASH'><glossterm>SYSLINUX_SPLASH</glossterm> - <info> - SYSLINUX_SPLASH[doc] = "An .LSS file used as the background for the VGA boot menu when you use the boot menu." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - An <filename>.LSS</filename> file used as the background - for the VGA boot menu when you use the boot menu. - You need to set this variable in your recipe. - </para> - - <para> - The - <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> - class checks for this variable and if found, the - OpenEmbedded build system installs the splash screen. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSLINUX_SERIAL_TTY'><glossterm>SYSLINUX_SERIAL_TTY</glossterm> - <info> - SYSLINUX_SERIAL_TTY[doc] = "Specifies the alternate console=tty... kernel boot argument." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the alternate console=tty... kernel boot argument. - The variable's default value is set in the - <link linkend='ref-classes-syslinux'><filename>syslinux</filename></link> - class as follows: - <literallayout class='monospaced'> - SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" - </literallayout> - </para> - - <para> - The class checks for and uses the variable as needed. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSROOT_DESTDIR'><glossterm>SYSROOT_DESTDIR</glossterm> - <info> - SYSROOT_DESTDIR[doc] = "Points to the temporary work directory (default ${WORKDIR}/sysroot-destdir) where the files populated into the sysroot are assembled during the do_populate_sysroot task." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the temporary directory under the work directory - (default - "<filename>${</filename><link linkend='var-WORKDIR'><filename>WORKDIR</filename></link><filename>}/sysroot-destdir</filename>") - where the files populated into the sysroot are assembled - during the - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSROOT_DIRS'><glossterm>SYSROOT_DIRS</glossterm> - <info> - SYSROOT_DIRS[doc] = "Directories that are staged into the sysroot by the do_populate_sysroot task." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Directories that are staged into the sysroot by the - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task. - By default, the following directories are staged: - <literallayout class='monospaced'> - SYSROOT_DIRS = " \ - ${includedir} \ - ${libdir} \ - ${base_libdir} \ - ${nonarch_base_libdir} \ - ${datadir} \ - " - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSROOT_DIRS_BLACKLIST'><glossterm>SYSROOT_DIRS_BLACKLIST</glossterm> - <info> - SYSROOT_DIRS_BLACKLIST[doc] = "Directories that are not staged into the sysroot by the do_populate_sysroot task." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Directories that are not staged into the sysroot by the - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task. - You can use this variable to exclude certain subdirectories - of directories listed in - <link linkend='var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></link> - from staging. - By default, the following directories are not staged: - <literallayout class='monospaced'> - SYSROOT_DIRS_BLACKLIST = " \ - ${mandir} \ - ${docdir} \ - ${infodir} \ - ${datadir}/locale \ - ${datadir}/applications \ - ${datadir}/fonts \ - ${datadir}/pixmaps \ - " - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSROOT_DIRS_NATIVE'><glossterm>SYSROOT_DIRS_NATIVE</glossterm> - <info> - SYSROOT_DIRS_NATIVE[doc] = "Extra directories staged into the sysroot by the do_populate_sysroot task for -native recipes, in addition to those specified in SYSROOT_DIRS." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Extra directories staged into the sysroot by the - <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> - task for <filename>-native</filename> recipes, in addition - to those specified in - <link linkend='var-SYSROOT_DIRS'><filename>SYSROOT_DIRS</filename></link>. - By default, the following extra directories are staged: - <literallayout class='monospaced'> - SYSROOT_DIRS_NATIVE = " \ - ${bindir} \ - ${sbindir} \ - ${base_bindir} \ - ${base_sbindir} \ - ${libexecdir} \ - ${sysconfdir} \ - ${localstatedir} \ - " - </literallayout> - <note> - Programs built by <filename>-native</filename> recipes - run directly from the sysroot - (<link linkend='var-STAGING_DIR_NATIVE'><filename>STAGING_DIR_NATIVE</filename></link>), - which is why additional directories containing program - executables and supporting files need to be staged. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSROOT_PREPROCESS_FUNCS'><glossterm>SYSROOT_PREPROCESS_FUNCS</glossterm> - <info> - SYSROOT_PREPROCESS_FUNCS[doc] = "A list of functions to execute after files are staged into the sysroot. These functions are usually used to apply additional processing on the staged files, or to stage additional files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of functions to execute after files are staged into - the sysroot. - These functions are usually used to apply additional - processing on the staged files, or to stage additional - files. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSTEMD_AUTO_ENABLE'><glossterm>SYSTEMD_AUTO_ENABLE</glossterm> - <info> - SYSTEMD_AUTO_ENABLE[doc] = "For recipes that inherit the systemd class, this variable specifies whether the specified service in SYSTEMD_SERVICE should start automatically or not." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-systemd'><filename>systemd</filename></link> - class, this variable specifies whether the specified service - in - <link linkend='var-SYSTEMD_SERVICE'><filename>SYSTEMD_SERVICE</filename></link> - should start automatically or not. - By default, the service is enabled to automatically start - at boot time. - The default setting is in the - <link linkend='ref-classes-systemd'><filename>systemd</filename></link> - class as follows: - <literallayout class='monospaced'> - SYSTEMD_AUTO_ENABLE ??= "enable" - </literallayout> - </para> - - <para> - You can disable the service by setting the variable to - "disable". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSTEMD_BOOT_CFG'><glossterm>SYSTEMD_BOOT_CFG</glossterm> - <info> - SYSTEMD_BOOT_CFG[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_CFG variable specifies the configuration file that should be used." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When - <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> - is set to "systemd-boot", the - <filename>SYSTEMD_BOOT_CFG</filename> variable specifies the - configuration file that should be used. - By default, the - <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link> - class sets the <filename>SYSTEMD_BOOT_CFG</filename> as - follows: - <literallayout class='monospaced'> - SYSTEMD_BOOT_CFG ?= "${<link linkend='var-S'>S</link>}/loader.conf" - </literallayout> - </para> - - <para> - For information on Systemd-boot, see the - <ulink url='http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/'>Systemd-boot documentation</ulink>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSTEMD_BOOT_ENTRIES'><glossterm>SYSTEMD_BOOT_ENTRIES</glossterm> - <info> - SYSTEMD_BOOT_ENTRIES[doc] = "When 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." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When - <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> - is set to "systemd-boot", the - <filename>SYSTEMD_BOOT_ENTRIES</filename> variable specifies - a list of entry files - (<filename>*.conf</filename>) to install that contain - one boot entry per file. - By default, the - <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link> - class sets the <filename>SYSTEMD_BOOT_ENTRIES</filename> as - follows: - <literallayout class='monospaced'> - SYSTEMD_BOOT_ENTRIES ?= "" - </literallayout> - </para> - - <para> - For information on Systemd-boot, see the - <ulink url='http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/'>Systemd-boot documentation</ulink>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSTEMD_BOOT_TIMEOUT'><glossterm>SYSTEMD_BOOT_TIMEOUT</glossterm> - <info> - SYSTEMD_BOOT_TIMEOUT[doc] = "When EFI_PROVIDER is set to "systemd-boot", the SYSTEMD_BOOT_TIMEOUT variable specifies the boot menu timeout in seconds." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When - <link linkend='var-EFI_PROVIDER'><filename>EFI_PROVIDER</filename></link> - is set to "systemd-boot", the - <filename>SYSTEMD_BOOT_TIMEOUT</filename> variable specifies - the boot menu timeout in seconds. - By default, the - <link linkend='ref-classes-systemd-boot'><filename>systemd-boot</filename></link> - class sets the <filename>SYSTEMD_BOOT_TIMEOUT</filename> as - follows: - <literallayout class='monospaced'> - SYSTEMD_BOOT_TIMEOUT ?= "10" - </literallayout> - </para> - - <para> - For information on Systemd-boot, see the - <ulink url='http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/'>Systemd-boot documentation</ulink>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSTEMD_PACKAGES'><glossterm>SYSTEMD_PACKAGES</glossterm> - <info> - SYSTEMD_PACKAGES[doc] = "For recipes that inherit the systemd class, this variable locates the systemd unit files when they are not found in the main recipe's package." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-systemd'><filename>systemd</filename></link> - class, this variable locates the systemd unit files when - they are not found in the main recipe's package. - By default, the - <filename>SYSTEMD_PACKAGES</filename> variable is set - such that the systemd unit files are assumed to reside in - the recipes main package: - <literallayout class='monospaced'> - SYSTEMD_PACKAGES ?= "${PN}" - </literallayout> - </para> - - <para> - If these unit files are not in this recipe's main - package, you need to use - <filename>SYSTEMD_PACKAGES</filename> to list the package - or packages in which the build system can find the systemd - unit files. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSTEMD_SERVICE'><glossterm>SYSTEMD_SERVICE</glossterm> - <info> - SYSTEMD_SERVICE[doc] = "For recipes that inherit the systemd class, this variable specifies the systemd service name for a package." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-systemd'><filename>systemd</filename></link> - class, this variable specifies the systemd service name for - a package. - </para> - - <para> - When you specify this file in your recipe, use a package - name override to indicate the package to which the value - applies. - Here is an example from the connman recipe: - <literallayout class='monospaced'> - SYSTEMD_SERVICE_${PN} = "connman.service" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-SYSVINIT_ENABLED_GETTYS'><glossterm>SYSVINIT_ENABLED_GETTYS</glossterm> - <info> - SYSVINIT_ENABLED_GETTYS[doc] = "Specifies which virtual terminals should run a getty, the default is '1'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When using - <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>, - specifies a space-separated list of the virtual terminals - that should run a - <ulink url='http://en.wikipedia.org/wiki/Getty_%28Unix%29'>getty</ulink> - (allowing login), assuming - <link linkend='var-USE_VT'><filename>USE_VT</filename></link> - is not set to "0". - </para> - - <para> - The default value for - <filename>SYSVINIT_ENABLED_GETTYS</filename> is "1" - (i.e. only run a getty on the first virtual terminal). - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-t'><title>T</title> - - <glossentry id='var-T'><glossterm>T</glossterm> - <info> - T[doc] = "This variable points to a directory were BitBake places temporary files, which consist mostly of task logs and scripts, when building a particular recipe." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable points to a directory were BitBake places - temporary files, which consist mostly of task logs and - scripts, when building a particular recipe. - The variable is typically set as follows: - <literallayout class='monospaced'> - T = "${WORKDIR}/temp" - </literallayout> - </para> - - <para> - The <link linkend='var-WORKDIR'><filename>WORKDIR</filename></link> - is the directory into which BitBake unpacks and builds the - recipe. - The default <filename>bitbake.conf</filename> file sets this variable.</para> - <para>The <filename>T</filename> variable is not to be confused with - the <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> variable, - which points to the root of the directory tree where BitBake - places the output of an entire build. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_ARCH'><glossterm>TARGET_ARCH</glossterm> - <info> - TARGET_ARCH[doc] = "The architecture of the device being built. The OpenEmbedded build system supports the following architectures: arm, mips, ppc, x86, x86-64." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The target machine's architecture. - The OpenEmbedded build system supports many - architectures. - Here is an example list of architectures supported. - This list is by no means complete as the architecture - is configurable: - <literallayout class='monospaced'> - arm - i586 - x86_64 - powerpc - powerpc64 - mips - mipsel - </literallayout> - </para> - - <para> - For additional information on machine architectures, see - the - <link linkend='var-TUNE_ARCH'><filename>TUNE_ARCH</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_AS_ARCH'><glossterm>TARGET_AS_ARCH</glossterm> - <info> - TARGET_AS_ARCH[doc] = "Specifies architecture-specific assembler flags for the target system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies architecture-specific assembler flags for the - target system. - <filename>TARGET_AS_ARCH</filename> is initialized from - <link linkend='var-TUNE_ASARGS'><filename>TUNE_ASARGS</filename></link> - by default in the BitBake configuration file - (<filename>meta/conf/bitbake.conf</filename>): - <literallayout class='monospaced'> - TARGET_AS_ARCH = "${TUNE_ASARGS}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_CC_ARCH'><glossterm>TARGET_CC_ARCH</glossterm> - <info> - TARGET_CC_ARCH[doc] = "Specifies architecture-specific C compiler flags for the target system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies architecture-specific C compiler flags for the - target system. - <filename>TARGET_CC_ARCH</filename> is initialized from - <link linkend='var-TUNE_CCARGS'><filename>TUNE_CCARGS</filename></link> - by default. - <note> - It is a common workaround to append - <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> - to <filename>TARGET_CC_ARCH</filename> - in recipes that build software for the target that - would not otherwise respect the exported - <filename>LDFLAGS</filename> variable. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_CC_KERNEL_ARCH'><glossterm>TARGET_CC_KERNEL_ARCH</glossterm> - <info> - TARGET_CC_KERNEL_ARCH[doc] = "This is a specific kernel compiler flag for a CPU or Application Binary Interface (ABI) tune." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This is a specific kernel compiler flag for a CPU or - Application Binary Interface (ABI) tune. - The flag is used rarely and only for cases where a - userspace - <link linkend='var-TUNE_CCARGS'><filename>TUNE_CCARGS</filename></link> - is not compatible with the kernel compilation. - The <filename>TARGET_CC_KERNEL_ARCH</filename> variable - allows the kernel (and associated modules) to use a - different configuration. - See the - <filename>meta/conf/machine/include/arm/feature-arm-thumb.inc</filename> - file in the - <link linkend='source-directory'>Source Directory</link> - for an example. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_CFLAGS'><glossterm>TARGET_CFLAGS</glossterm> - <info> - TARGET_CFLAGS[doc] = "Flags passed to the C compiler for the target system. This variable evaluates to the same as CFLAGS." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C compiler when building - for the target. - When building in the target context, - <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link> - is set to the value of this variable by default. - </para> - - <para> - Additionally, the SDK's environment setup script sets - the <filename>CFLAGS</filename> variable in the environment - to the <filename>TARGET_CFLAGS</filename> value so that - executables built using the SDK also have the flags - applied. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_CPPFLAGS'><glossterm>TARGET_CPPFLAGS</glossterm> - <info> - TARGET_CPPFLAGS[doc] = "Specifies the flags to pass to the C pre-processor (i.e. to both the C and the C++ compilers) when building for the target." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C pre-processor - (i.e. to both the C and the C++ compilers) when building - for the target. - When building in the target context, - <link linkend='var-CPPFLAGS'><filename>CPPFLAGS</filename></link> - is set to the value of this variable by default. - </para> - - <para> - Additionally, the SDK's environment setup script sets - the <filename>CPPFLAGS</filename> variable in the - environment to the <filename>TARGET_CPPFLAGS</filename> - value so that executables built using the SDK also have - the flags applied. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_CXXFLAGS'><glossterm>TARGET_CXXFLAGS</glossterm> - <info> - TARGET_CXXFLAGS[doc] = "Specifies the flags to pass to the C++ compiler when building for the target." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the C++ compiler when - building for the target. - When building in the target context, - <link linkend='var-CXXFLAGS'><filename>CXXFLAGS</filename></link> - is set to the value of this variable by default. - </para> - - <para> - Additionally, the SDK's environment setup script sets - the <filename>CXXFLAGS</filename> variable in the - environment to the <filename>TARGET_CXXFLAGS</filename> - value so that executables built using the SDK also have - the flags applied. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_FPU'><glossterm>TARGET_FPU</glossterm> - <info> - TARGET_FPU[doc] = "Specifies the method for handling FPU code. For FPU-less targets, which include most ARM CPUs, the variable must be set to 'soft'. If not, the kernel emulation gets used, which results in a performance penalty." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the method for handling FPU code. - For FPU-less targets, which include most ARM CPUs, the variable must be - set to "soft". - If not, the kernel emulation gets used, which results in a performance penalty. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_LD_ARCH'><glossterm>TARGET_LD_ARCH</glossterm> - <info> - TARGET_LD_ARCH[doc] = "Specifies architecture-specific linker flags for the target system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies architecture-specific linker flags for the - target system. - <filename>TARGET_LD_ARCH</filename> is initialized from - <link linkend='var-TUNE_LDARGS'><filename>TUNE_LDARGS</filename></link> - by default in the BitBake configuration file - (<filename>meta/conf/bitbake.conf</filename>): - <literallayout class='monospaced'> - TARGET_LD_ARCH = "${TUNE_LDARGS}" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_LDFLAGS'><glossterm>TARGET_LDFLAGS</glossterm> - <info> - TARGET_LDFLAGS[doc] = "Specifies the flags to pass to the linker when building for the target." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the flags to pass to the linker when building - for the target. - When building in the target context, - <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> - is set to the value of this variable by default. - </para> - - <para> - Additionally, the SDK's environment setup script sets - the - <link linkend='var-LDFLAGS'><filename>LDFLAGS</filename></link> - variable in the environment to the - <filename>TARGET_LDFLAGS</filename> value so that - executables built using the SDK also have the flags - applied. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_OS'><glossterm>TARGET_OS</glossterm> - <info> - TARGET_OS[doc] = "Specifies the target's operating system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the target's operating system. - The variable can be set to "linux" for 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. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_PREFIX'><glossterm>TARGET_PREFIX</glossterm> - <info> - TARGET_PREFIX[doc] = "The prefix used for the toolchain binary target tools." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the prefix used for the toolchain binary target - tools. - </para> - - <para> - Depending on the type of recipe and the build target, - <filename>TARGET_PREFIX</filename> is set as follows: - <itemizedlist> - <listitem><para> - For recipes building for the target machine, - the value is - "${<link linkend='var-TARGET_SYS'>TARGET_SYS</link>}-". - </para></listitem> - <listitem><para> - For native recipes, the build system sets the - variable to the value of - <filename>BUILD_PREFIX</filename>. - </para></listitem> - <listitem><para> - For native SDK recipes - (<filename>nativesdk</filename>), the - build system sets the variable to the value of - <filename>SDK_PREFIX</filename>. - </para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_SYS'><glossterm>TARGET_SYS</glossterm> - <info> - TARGET_SYS[doc] = "The target system is comprised of TARGET_ARCH,TARGET_VENDOR and TARGET_OS." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the system, including the architecture and the - operating system, for which the build is occurring in - the context of the current recipe. - </para> - - <para> - The OpenEmbedded build system automatically sets this - variable based on - <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>, - <link linkend='var-TARGET_VENDOR'><filename>TARGET_VENDOR</filename></link>, - and - <link linkend='var-TARGET_OS'><filename>TARGET_OS</filename></link> - variables. - <note> - You do not need to set the - <filename>TARGET_SYS</filename> variable yourself. - </note> - </para> - - <para> - Consider these two examples: - <itemizedlist> - <listitem><para> - Given a native recipe on a 32-bit, x86 machine - running Linux, the value is "i686-linux". - </para></listitem> - <listitem><para> - Given a recipe being built for a little-endian, - MIPS target running Linux, the value might be - "mipsel-linux". - </para></listitem> - </itemizedlist> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TARGET_VENDOR'><glossterm>TARGET_VENDOR</glossterm> - <info> - TARGET_VENDOR[doc] = "The name of the target vendor." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the name of the target vendor. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TCLIBC'><glossterm>TCLIBC</glossterm> - <info> - TCLIBC[doc] = "Specifies GNU standard C library (libc) variant to use during the build process. You can select 'glibc', 'musl' or "newlib." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the GNU standard C library - (<filename>libc</filename>) variant to use during the - build process. - This variable replaces <filename>POKYLIBC</filename>, - which is no longer supported. - </para> - - <para> - You can select "glibc", "musl", "newlib", or "baremetal" - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TCLIBCAPPEND'><glossterm>TCLIBCAPPEND</glossterm> - <info> - TCLIBCAPPEND[doc] = "Specifies a suffix appended to TMPDIR that identifies the libc variant for the build." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a suffix to be appended onto the - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - value. - The suffix identifies the <filename>libc</filename> variant - for building. - When you are building for multiple variants with the same - <link linkend='build-directory'>Build Directory</link>, - this mechanism ensures that output for different - <filename>libc</filename> variants is kept separate to - avoid potential conflicts. - </para> - - <para> - In the <filename>defaultsetup.conf</filename> file, the - default value of <filename>TCLIBCAPPEND</filename> is - "-${TCLIBC}". - However, distros such as poky, which normally only support - one <filename>libc</filename> variant, set - <filename>TCLIBCAPPEND</filename> to "" in their distro - configuration file resulting in no suffix being applied. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TCMODE'><glossterm>TCMODE</glossterm> - <info> - TCMODE[doc] = "Enables an external toolchain (where provided by an additional layer) if set to a value other than 'default'." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the toolchain selector. - <filename>TCMODE</filename> controls the characteristics - of the generated packages and images by telling the - OpenEmbedded build system which toolchain profile to use. - By default, the OpenEmbedded build system builds its own - internal toolchain. - The variable's default value is "default", which uses - that internal toolchain. - <note> - If <filename>TCMODE</filename> is set to a value - other than "default", then it is your responsibility - to ensure that the toolchain is compatible with the - default toolchain. - Using older or newer versions of these components - might cause build problems. - See the 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 - <ulink url='&YOCTO_HOME_URL;/software-overview/downloads/'>Downloads</ulink> - page on the Yocto Project website and click on the - "RELEASE INFORMATION" link for the appropriate - release. - </note> - </para> - - <para> - The <filename>TCMODE</filename> variable is similar to - <link linkend='var-TCLIBC'><filename>TCLIBC</filename></link>, - which controls the variant of the GNU standard C library - (<filename>libc</filename>) used during the build process: - <filename>glibc</filename> or <filename>musl</filename>. - </para> - - <para> - With additional layers, it is possible to use a pre-compiled - external toolchain. - One example is the Sourcery G++ Toolchain. - The support for this toolchain resides in the separate - <trademark class='registered'>Mentor Graphics</trademark> - <filename>meta-sourcery</filename> layer at - <ulink url='http://github.com/MentorEmbedded/meta-sourcery/'></ulink>. - </para> - - <para> - The layer's <filename>README</filename> file contains - information on how to use the Sourcery G++ Toolchain as - an external toolchain. - In summary, you must be sure to add the layer to your - <filename>bblayers.conf</filename> file in front of the - <filename>meta</filename> layer and then set the - <filename>EXTERNAL_TOOLCHAIN</filename> - variable in your <filename>local.conf</filename> file - to the location in which you installed the toolchain. - </para> - - <para> - The fundamentals used for this example apply to any - external toolchain. - You can use <filename>meta-sourcery</filename> as a - template for adding support for other external toolchains. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_EXPORT_DIR'><glossterm>TEST_EXPORT_DIR</glossterm> - <info> - TEST_EXPORT_DIR[doc] = "The location the OpenEmbedded build system uses to export tests when the TEST_EXPORT_ONLY variable is set to "1"." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The location the OpenEmbedded build system uses to export - tests when the - <link linkend='var-TEST_EXPORT_ONLY'><filename>TEST_EXPORT_ONLY</filename></link> - variable is set to "1". - </para> - - <para> - The <filename>TEST_EXPORT_DIR</filename> variable defaults - to <filename>"${TMPDIR}/testimage/${PN}"</filename>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_EXPORT_ONLY'><glossterm>TEST_EXPORT_ONLY</glossterm> - <info> - TEST_EXPORT_ONLY[doc] = "Specifies to export the tests only. Set this variable to "1" if you do not want to run the tests but you want them to be exported in a manner that you to run them outside of the build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies to export the tests only. - Set this variable to "1" if you do not want to run the - tests but you want them to be exported in a manner that - you to run them outside of the build system. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm> - <info> - TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The TEST_LOG_DIR variable defaults to "${WORKDIR}/testimage"." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Holds the SSH log and the boot log for QEMU machines. - The <filename>TEST_LOG_DIR</filename> variable defaults - to <filename>"${WORKDIR}/testimage"</filename>. - <note> - Actual test results reside in the task log - (<filename>log.do_testimage</filename>), which is in - the <filename>${WORKDIR}/temp/</filename> directory. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_POWERCONTROL_CMD'><glossterm>TEST_POWERCONTROL_CMD</glossterm> - <info> - TEST_POWERCONTROL_CMD[doc] = "For automated hardware testing, specifies the command to use to control the power of the target machine under test" - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - For automated hardware testing, specifies the command to - use to control the power of the target machine under test. - Typically, this command would point to a script that - performs the appropriate action (e.g. interacting - with a web-enabled power strip). - The specified command should expect to receive as the last - argument "off", "on" or "cycle" specifying to power off, - on, or cycle (power off and then power on) the device, - respectively. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_POWERCONTROL_EXTRA_ARGS'><glossterm>TEST_POWERCONTROL_EXTRA_ARGS</glossterm> - <info> - TEST_POWERCONTROL_EXTRA_ARGS[doc] = "For automated hardware testing, specifies additional arguments to pass through to the command specified in TEST_POWERCONTROL_CMD" - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - For automated hardware testing, specifies additional - arguments to pass through to the command specified in - <link linkend='var-TEST_POWERCONTROL_CMD'><filename>TEST_POWERCONTROL_CMD</filename></link>. - Setting <filename>TEST_POWERCONTROL_EXTRA_ARGS</filename> - is optional. - You can use it if you wish, for example, to separate the - machine-specific and non-machine-specific parts of the - arguments. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_QEMUBOOT_TIMEOUT'><glossterm>TEST_QEMUBOOT_TIMEOUT</glossterm> - <info> - TEST_QEMUBOOT_TIMEOUT[doc] = "The time in seconds allowed for an image to boot before automated runtime tests begin to run against an image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The time in seconds allowed for an image to boot before - automated runtime tests begin to run against an - image. - The default timeout period to allow the boot process to - reach the login prompt is 500 seconds. - You can specify a different value in the - <filename>local.conf</filename> file. - </para> - - <para> - For more information on testing images, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_SERIALCONTROL_CMD'><glossterm>TEST_SERIALCONTROL_CMD</glossterm> - <info> - TEST_SERIALCONTROL_CMD[doc] = "For automated hardware testing, specifies the command to use to connect to the serial console of the target machine under test." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - For automated hardware testing, specifies the command - to use to connect to the serial console of the target - machine under test. - This command simply needs to connect to the serial console - and forward that connection to standard input and output - as any normal terminal program does. - </para> - - <para> - For example, to use the Picocom terminal program on - serial device <filename>/dev/ttyUSB0</filename> at - 115200bps, you would set the variable as follows: - <literallayout class='monospaced'> - TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_SERIALCONTROL_EXTRA_ARGS'><glossterm>TEST_SERIALCONTROL_EXTRA_ARGS</glossterm> - <info> - TEST_SERIALCONTROL_EXTRA_ARGS[doc] = "For automated hardware testing, specifies additional arguments to pass through to the command specified in TEST_SERIALCONTROL_CMD." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - For automated hardware testing, specifies additional - arguments to pass through to the command specified in - <link linkend='var-TEST_SERIALCONTROL_CMD'><filename>TEST_SERIALCONTROL_CMD</filename></link>. - Setting <filename>TEST_SERIALCONTROL_EXTRA_ARGS</filename> - is optional. - You can use it if you wish, for example, to separate the - machine-specific and non-machine-specific parts of the - command. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_SERVER_IP'><glossterm>TEST_SERVER_IP</glossterm> - <info> - TEST_SERVER_IP[doc] = "The IP address of the build machine (host machine). This IP address is usually automatically detected." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The IP address of the build machine (host machine). - This IP address is usually automatically detected. - However, if detection fails, this variable needs to be set - to the IP address of the build machine (i.e. where - the build is taking place). - <note> - The <filename>TEST_SERVER_IP</filename> variable - is only used for a small number of tests such as - the "dnf" test suite, which needs to download - packages from - <filename>WORKDIR/oe-rootfs-repo</filename>. - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_TARGET'><glossterm>TEST_TARGET</glossterm> - <info> - TEST_TARGET[doc] = "For automated runtime testing, specifies the method of deploying the image and running tests on the target machine." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the target controller to use when running tests - against a test image. - The default controller to use is "QemuTarget": - <literallayout class='monospaced'> - TEST_TARGET = "QemuTarget" - </literallayout> - </para> - - <para> - A target controller is a class that defines how an - image gets deployed on a target and how a target is started. - A layer can extend the controllers by adding a module - in the layer's <filename>/lib/oeqa/controllers</filename> - directory and by inheriting the - <filename>BaseTarget</filename> class, which is an abstract - class that cannot be used as a value of - <filename>TEST_TARGET</filename>. - </para> - - <para> - You can provide the following arguments with - <filename>TEST_TARGET</filename>: - <itemizedlist> - <listitem><para><emphasis>"QemuTarget":</emphasis> - Boots a QEMU image and runs the tests. - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-image-enabling-tests'>Enabling Runtime Tests on QEMU</ulink>" - section in the Yocto Project Development Tasks - Manual for more information. - </para></listitem> - <listitem><para><emphasis>"SimpleRemoteTarget":</emphasis> - Runs the tests on target hardware that is already - up and running. - The hardware can be on the network or it can be - a device running an image on QEMU. - You must also set - <link linkend='var-TEST_TARGET_IP'><filename>TEST_TARGET_IP</filename></link> - when you use "SimpleRemoteTarget". - <note> - This argument is defined in - <filename>meta/lib/oeqa/controllers/simpleremote.py</filename>. - </note> - </para></listitem> - </itemizedlist> - </para> - - <para> - For information on running tests on hardware, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#hardware-image-enabling-tests'>Enabling Runtime Tests on Hardware</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_TARGET_IP'><glossterm>TEST_TARGET_IP</glossterm> - <info> - TEST_TARGET_IP[doc] = "The IP address of your hardware under test." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The IP address of your hardware under test. - The <filename>TEST_TARGET_IP</filename> variable has no - effect when - <link linkend='var-TEST_TARGET'><filename>TEST_TARGET</filename></link> - is set to "qemu". - </para> - - <para> - When you specify the IP address, you can also include a - port. - Here is an example: - <literallayout class='monospaced'> - TEST_TARGET_IP = "192.168.1.4:2201" - </literallayout> - Specifying a port is useful when SSH is started on a - non-standard port or in cases when your hardware under test - is behind a firewall or network that is not directly - accessible from your host and you need to do port address - translation. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TEST_SUITES'><glossterm>TEST_SUITES</glossterm> - <info> - TEST_SUITES[doc] = "An ordered list of tests (modules) to run against an image when performing automated runtime testing." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - An ordered list of tests (modules) to run against - an image when performing automated runtime testing. - </para> - - <para> - The OpenEmbedded build system provides a core set of tests - that can be used against images. - <note> - Currently, there is only support for running these tests - under QEMU. - </note> - Tests include <filename>ping</filename>, - <filename>ssh</filename>, <filename>df</filename> among - others. - You can add your own tests to the list of tests by - appending <filename>TEST_SUITES</filename> as follows: - <literallayout class='monospaced'> - TEST_SUITES_append = " <replaceable>mytest</replaceable>" - </literallayout> - Alternatively, you can provide the "auto" option to - have all applicable tests run against the image. - <literallayout class='monospaced'> - TEST_SUITES_append = " auto" - </literallayout> - Using this option causes the build system to automatically - run tests that are applicable to the image. - Tests that are not applicable are skipped. - </para> - - <para> - The order in which tests are run is important. - Tests that depend on another test must appear later in the - list than the test on which they depend. - For example, if you append the list of tests with two - tests (<filename>test_A</filename> and - <filename>test_B</filename>) where - <filename>test_B</filename> is dependent on - <filename>test_A</filename>, then you must order the tests - as follows: - <literallayout class='monospaced'> - TEST_SUITES = " test_A test_B" - </literallayout> - </para> - - <para> - For more information on testing images, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TESTIMAGE_AUTO'><glossterm>TESTIMAGE_AUTO</glossterm> - <info> - TESTIMAGE_AUTO[doc] = "Enables automatic testing of an image once it is built." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Automatically runs the series of automated tests for - images when an image is successfully built. - Setting <filename>TESTIMAGE_AUTO</filename> 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. - </para> - - <para> - These tests are written in Python making use of the - <filename>unittest</filename> module, and the majority of - them run commands on the target system over - <filename>ssh</filename>. - You can set this variable to "1" in your - <filename>local.conf</filename> file in the - <link linkend='build-directory'>Build Directory</link> - to have the OpenEmbedded build system automatically run - these tests after an image successfully builds: - <literallayout class='monospaced'> - TESTIMAGE_AUTO = "1" - </literallayout> - For more information on enabling, running, and writing - these tests, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual and - the - "<link linkend='ref-classes-testimage*'><filename>testimage*.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-THISDIR'><glossterm>THISDIR</glossterm> - <info> - THISDIR[doc] = "The directory in which the file BitBake is currently parsing is located." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The directory in which the file BitBake is currently - parsing is located. - Do not manually set this variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TIME'><glossterm>TIME</glossterm> - <info> - TIME[doc] = "The time the build was started using HMS format." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The time the build was started. - Times appear using the hour, minute, and second (HMS) - format (e.g. "140159" for one minute and fifty-nine - seconds past 1400 hours). - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TMPDIR'><glossterm>TMPDIR</glossterm> - <info> - TMPDIR[doc] = "The temporary directory the OpenEmbedded build system uses when it does its work building images. By default, the TMPDIR variable is named tmp within the Build Directory." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable is the base directory the OpenEmbedded - build system uses for all build output and intermediate - files (other than the shared state cache). - By default, the <filename>TMPDIR</filename> variable points - to <filename>tmp</filename> within the - <link linkend='build-directory'>Build Directory</link>. - </para> - - <para> - If you want to establish this directory in a location other - than the default, you can uncomment and edit the following - statement in the - <filename>conf/local.conf</filename> file in the - <link linkend='source-directory'>Source Directory</link>: - <literallayout class='monospaced'> - #TMPDIR = "${TOPDIR}/tmp" - </literallayout> - An example use for this scenario is to set - <filename>TMPDIR</filename> to a local disk, which does - not use NFS, while having the Build Directory use NFS. - </para> - - <para> - The filesystem used by <filename>TMPDIR</filename> must - have standard filesystem semantics (i.e. mixed-case files - are unique, POSIX file locking, and persistent inodes). - Due to various issues with NFS and bugs in some - implementations, NFS does not meet this minimum - requirement. - Consequently, <filename>TMPDIR</filename> cannot be on - NFS. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TOOLCHAIN_HOST_TASK'><glossterm>TOOLCHAIN_HOST_TASK</glossterm> - <info> - TOOLCHAIN_HOST_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when building an SDK, which contains a cross-development environment." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable lists packages the OpenEmbedded build system - uses when building an SDK, which contains a - cross-development environment. - The packages specified by this variable are part of the - toolchain set that runs on the - <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>, - and each package should usually have the prefix - <filename>nativesdk-</filename>. - For example, consider the following command when - building an SDK: - <literallayout class='monospaced'> - $ bitbake -c populate_sdk <replaceable>imagename</replaceable> - </literallayout> - In this case, a default list of packages is set in this - variable, but you can add additional packages to the list. - See the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-adding-individual-packages'>Adding Individual Packages to the Standard SDK</ulink>" - section in the Yocto Project Application Development and - the Extensible Software Development Kit (eSDK) manual - for more information. - </para> - - <para> - For background information on cross-development toolchains - in the Yocto Project development environment, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual. - For information on setting up a cross-development - environment, see the - <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> - manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TOOLCHAIN_OUTPUTNAME'><glossterm>TOOLCHAIN_OUTPUTNAME</glossterm> - <info> - TOOLCHAIN_OUTPUTNAME[doc] = "Defines the name used for the toolchain output." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable defines the name used for the toolchain - output. - The - <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> - class sets the - <filename>TOOLCHAIN_OUTPUTNAME</filename> variable as - follows: - <literallayout class='monospaced'> - TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" - </literallayout> - See the - <link linkend='var-SDK_NAME'><filename>SDK_NAME</filename></link> - and - <link linkend='var-SDK_VERSION'><filename>SDK_VERSION</filename></link> - variables for additional information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TOOLCHAIN_TARGET_TASK'><glossterm>TOOLCHAIN_TARGET_TASK</glossterm> - <info> - TOOLCHAIN_TARGET_TASK[doc] = "This variable lists packages the OpenEmbedded build system uses when it creates the target part of an SDK, which includes libraries and headers." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - This variable lists packages the OpenEmbedded build system - uses when it creates the target part of an SDK - (i.e. the part built for the target hardware), which - includes libraries and headers. - Use this variable to add individual packages to the - part of the SDK that runs on the target. - See the - "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-adding-individual-packages'>Adding Individual Packages to the Standard SDK</ulink>" - section in the Yocto Project Application Development and - the Extensible Software Development Kit (eSDK) manual for - more information. - </para> - - <para> - For background information on cross-development toolchains - in the Yocto Project development environment, see the - "<ulink url='&YOCTO_DOCS_OM_URL;#cross-development-toolchain-generation'>Cross-Development Toolchain Generation</ulink>" - section in the Yocto Project Overview and Concepts Manual. - For information on setting up a cross-development - environment, see the - <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> - manual. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm> - <info> - TOPDIR[doc] = "The Build Directory. BitBake automatically sets this variable. The OpenEmbedded build system uses the Build Directory when building images." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The top-level - <link linkend='build-directory'>Build Directory</link>. - BitBake automatically sets this variable when you - initialize your build environment using - <link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TRANSLATED_TARGET_ARCH'><glossterm>TRANSLATED_TARGET_ARCH</glossterm> - <info> - TRANSLATED_TARGET_ARCH[doc] = "A sanitized version of TARGET_ARCH. This variable is used where the architecture is needed in a value where underscores are not allowed." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A sanitized version of - <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>. - This variable is used where the architecture is needed in - a value where underscores are not allowed, for example - within package filenames. - In this case, dash characters replace any underscore - characters used in <filename>TARGET_ARCH</filename>. - </para> - - <para> - Do not edit this variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNE_ARCH'><glossterm>TUNE_ARCH</glossterm> - <info> - TUNE_ARCH[doc] = "The GNU canonical architecture for a specific architecture (i.e. arm, armeb, mips, mips64, and so forth)." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The GNU canonical architecture for a specific architecture - (i.e. <filename>arm</filename>, - <filename>armeb</filename>, - <filename>mips</filename>, - <filename>mips64</filename>, and so forth). - BitBake uses this value to setup configuration. - </para> - - <para> - <filename>TUNE_ARCH</filename> definitions are specific to - a given architecture. - The definitions can be a single static definition, or - can be dynamically adjusted. - You can see details for a given CPU family by looking at - the architecture's <filename>README</filename> file. - For example, the - <filename>meta/conf/machine/include/mips/README</filename> - file in the - <link linkend='source-directory'>Source Directory</link> - provides information for <filename>TUNE_ARCH</filename> - specific to the <filename>mips</filename> architecture. - </para> - - <para> - <filename>TUNE_ARCH</filename> is tied closely to - <link linkend='var-TARGET_ARCH'><filename>TARGET_ARCH</filename></link>, - which defines the target machine's architecture. - The BitBake configuration file - (<filename>meta/conf/bitbake.conf</filename>) sets - <filename>TARGET_ARCH</filename> as follows: - <literallayout class='monospaced'> - TARGET_ARCH = "${TUNE_ARCH}" - </literallayout> - </para> - - <para> - The following list, which is by no means complete since - architectures are configurable, shows supported machine - architectures: - <literallayout class='monospaced'> - arm - i586 - x86_64 - powerpc - powerpc64 - mips - mipsel - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNE_ASARGS'><glossterm>TUNE_ASARGS</glossterm> - <info> - TUNE_ASARGS[doc] = "Specifies architecture-specific assembler flags for the target system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies architecture-specific assembler flags for - the target system. - The set of flags is based on the selected tune features. - <filename>TUNE_ASARGS</filename> is set using - the tune include files, which are typically under - <filename>meta/conf/machine/include/</filename> and are - influenced through - <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. - For example, the - <filename>meta/conf/machine/include/x86/arch-x86.inc</filename> - file defines the flags for the x86 architecture as follows: - <literallayout class='monospaced'> - TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}" - </literallayout> - <note> - Board Support Packages (BSPs) select the tune. - The selected tune, in turn, affects the tune variables - themselves (i.e. the tune can supply its own - set of flags). - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNE_CCARGS'><glossterm>TUNE_CCARGS</glossterm> - <info> - TUNE_CCARGS[doc] = "Specifies architecture-specific C compiler flags for the target system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies architecture-specific C compiler flags for - the target system. - The set of flags is based on the selected tune features. - <filename>TUNE_CCARGS</filename> is set using - the tune include files, which are typically under - <filename>meta/conf/machine/include/</filename> and are - influenced through - <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. - <note> - Board Support Packages (BSPs) select the tune. - The selected tune, in turn, affects the tune variables - themselves (i.e. the tune can supply its own - set of flags). - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNE_LDARGS'><glossterm>TUNE_LDARGS</glossterm> - <info> - TUNE_LDARGS[doc] = "Specifies architecture-specific linker flags for the target system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies architecture-specific linker flags for - the target system. - The set of flags is based on the selected tune features. - <filename>TUNE_LDARGS</filename> is set using - the tune include files, which are typically under - <filename>meta/conf/machine/include/</filename> and are - influenced through - <link linkend='var-TUNE_FEATURES'><filename>TUNE_FEATURES</filename></link>. - For example, the - <filename>meta/conf/machine/include/x86/arch-x86.inc</filename> - file defines the flags for the x86 architecture as follows: - <literallayout class='monospaced'> - TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}" - </literallayout> - <note> - Board Support Packages (BSPs) select the tune. - The selected tune, in turn, affects the tune variables - themselves (i.e. the tune can supply its own - set of flags). - </note> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNE_FEATURES'><glossterm>TUNE_FEATURES</glossterm> - <info> - TUNE_FEATURES[doc] = "Features used to "tune" a compiler for optimal use given a specific processor." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Features used to "tune" a compiler for optimal use - given a specific processor. - The features are defined within the tune files and allow - arguments (i.e. <filename>TUNE_*ARGS</filename>) to be - dynamically generated based on the features. - </para> - - <para> - The OpenEmbedded build system verifies the features - to be sure they are not conflicting and that they are - supported. - </para> - - <para> - The BitBake configuration file - (<filename>meta/conf/bitbake.conf</filename>) defines - <filename>TUNE_FEATURES</filename> as follows: - <literallayout class='monospaced'> - TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" - </literallayout> - See the - <link linkend='var-DEFAULTTUNE'><filename>DEFAULTTUNE</filename></link> - variable for more information. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNE_PKGARCH'><glossterm>TUNE_PKGARCH</glossterm> - <info> - TUNE_PKGARCH[doc] = "The package architecture understood by the packaging system to define the architecture, ABI, and tuning of output packages." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The package architecture understood by the packaging - system to define the architecture, ABI, and tuning of - output packages. - The specific tune is defined using the "_tune" override - as follows: - <literallayout class='monospaced'> - TUNE_PKGARCH_tune-<replaceable>tune</replaceable> = "<replaceable>tune</replaceable>" - </literallayout> - </para> - - <para> - These tune-specific package architectures are defined in - the machine include files. - Here is an example of the "core2-32" tuning as used - in the - <filename>meta/conf/machine/include/tune-core2.inc</filename> - file: - <literallayout class='monospaced'> - TUNE_PKGARCH_tune-core2-32 = "core2-32" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNEABI'><glossterm>TUNEABI</glossterm> - <info> - TUNEABI[doc] = "An underlying ABI used by a particular tuning in a given toolchain layer. This feature allows providers using prebuilt libraries to check compatibility of a tuning against their selection of libraries." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - An underlying Application Binary Interface (ABI) used by - a particular tuning in a given toolchain layer. - Providers that use prebuilt libraries can use the - <filename>TUNEABI</filename>, - <link linkend='var-TUNEABI_OVERRIDE'><filename>TUNEABI_OVERRIDE</filename></link>, - and - <link linkend='var-TUNEABI_WHITELIST'><filename>TUNEABI_WHITELIST</filename></link> - variables to check compatibility of tunings against their - selection of libraries. - </para> - - <para> - If <filename>TUNEABI</filename> is undefined, then every - tuning is allowed. - See the - <link linkend='ref-classes-sanity'><filename>sanity</filename></link> - class to see how the variable is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNEABI_OVERRIDE'><glossterm>TUNEABI_OVERRIDE</glossterm> - <info> - TUNEABI_OVERRIDE[doc] = "If set, ignores TUNEABI_WHITELIST." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set, the OpenEmbedded system ignores the - <link linkend='var-TUNEABI_WHITELIST'><filename>TUNEABI_WHITELIST</filename></link> - variable. - Providers that use prebuilt libraries can use the - <filename>TUNEABI_OVERRIDE</filename>, - <filename>TUNEABI_WHITELIST</filename>, - and - <link linkend='var-TUNEABI'><filename>TUNEABI</filename></link> - variables to check compatibility of a tuning against their - selection of libraries. - </para> - - <para> - See the - <link linkend='ref-classes-sanity'><filename>sanity</filename></link> - class to see how the variable is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNEABI_WHITELIST'><glossterm>TUNEABI_WHITELIST</glossterm> - <info> - TUNEABI_WHITELIST[doc] = "A whitelist of permissible TUNEABI values. If the variable is not set, all values are allowed." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A whitelist of permissible - <link linkend='var-TUNEABI'><filename>TUNEABI</filename></link> - values. - If <filename>TUNEABI_WHITELIST</filename> is not set, - all tunes are allowed. - Providers that use prebuilt libraries can use the - <filename>TUNEABI_WHITELIST</filename>, - <link linkend='var-TUNEABI_OVERRIDE'><filename>TUNEABI_OVERRIDE</filename></link>, - and <filename>TUNEABI</filename> variables to check - compatibility of a tuning against their selection of - libraries. - </para> - - <para> - See the - <link linkend='ref-classes-sanity'><filename>sanity</filename></link> - class to see how the variable is used. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNECONFLICTS'><glossterm>TUNECONFLICTS[<replaceable>feature</replaceable>]</glossterm> - <info> - TUNECONFLICTS[doc] = "Specifies CPU or Application Binary Interface (ABI) tuning features that conflict with specified feature." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies CPU or Application Binary Interface (ABI) - tuning features that conflict with <replaceable>feature</replaceable>. - </para> - - <para> - Known tuning conflicts are specified in the machine include - files in the - <link linkend='source-directory'>Source Directory</link>. - Here is an example from the - <filename>meta/conf/machine/include/mips/arch-mips.inc</filename> - include file that lists the "o32" and "n64" features as - conflicting with the "n32" feature: - <literallayout class='monospaced'> - TUNECONFLICTS[n32] = "o32 n64" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-TUNEVALID'><glossterm>TUNEVALID[<replaceable>feature</replaceable>]</glossterm> - <info> - TUNEVALID[doc] = "Descriptions, stored as flags, of valid tuning features." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a valid CPU or Application Binary Interface (ABI) - tuning feature. - The specified feature is stored as a flag. - Valid features are specified in the machine include files - (e.g. <filename>meta/conf/machine/include/arm/arch-arm.inc</filename>). - Here is an example from that file: - <literallayout class='monospaced'> - TUNEVALID[bigendian] = "Enable big-endian mode." - </literallayout> - </para> - - <para> - See the machine include files in the - <link linkend='source-directory'>Source Directory</link> - for these features. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-u'><title>U</title> - - <glossentry id='var-UBOOT_CONFIG'><glossterm>UBOOT_CONFIG</glossterm> - <info> - UBOOT_CONFIG[doc] = "Configures the UBOOT_MACHINE and can also define IMAGE_FSTYPES for individual cases." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Configures the - <link linkend='var-UBOOT_MACHINE'><filename>UBOOT_MACHINE</filename></link> - and can also define - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - for individual cases. - </para> - - <para> - Following is an example from the - <filename>meta-fsl-arm</filename> layer. - <literallayout class='monospaced'> - UBOOT_CONFIG ??= "sd" - UBOOT_CONFIG[sd] = "mx6qsabreauto_config,sdcard" - UBOOT_CONFIG[eimnor] = "mx6qsabreauto_eimnor_config" - UBOOT_CONFIG[nand] = "mx6qsabreauto_nand_config,ubifs" - UBOOT_CONFIG[spinor] = "mx6qsabreauto_spinor_config" - </literallayout> - In this example, "sd" is selected as the configuration - of the possible four for the - <filename>UBOOT_MACHINE</filename>. - The "sd" configuration defines "mx6qsabreauto_config" - as the value for <filename>UBOOT_MACHINE</filename>, while - the "sdcard" specifies the - <filename>IMAGE_FSTYPES</filename> to use for the U-boot - image. - </para> - - <para> - For more information on how the - <filename>UBOOT_CONFIG</filename> is handled, see the - <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/classes/uboot-config.bbclass'><filename>uboot-config</filename></ulink> - class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UBOOT_ENTRYPOINT'><glossterm>UBOOT_ENTRYPOINT</glossterm> - <info> - UBOOT_ENTRYPOINT[doc] = "Specifies the entry point for the U-Boot image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the entry point for the U-Boot image. - During U-Boot image creation, the - <filename>UBOOT_ENTRYPOINT</filename> variable is passed - as a command-line parameter to the - <filename>uboot-mkimage</filename> utility. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UBOOT_LOADADDRESS'><glossterm>UBOOT_LOADADDRESS</glossterm> - <info> - UBOOT_LOADADDRESS[doc] = "Specifies the load address for the U-Boot image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the load address for the U-Boot image. - During U-Boot image creation, the - <filename>UBOOT_LOADADDRESS</filename> variable is passed - as a command-line parameter to the - <filename>uboot-mkimage</filename> utility. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UBOOT_LOCALVERSION'><glossterm>UBOOT_LOCALVERSION</glossterm> - <info> - UBOOT_LOCALVERSION[doc] = "Appends a string to the name of the local version of the U-Boot image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Appends a string to the name of the local version of the - U-Boot image. - For example, assuming the version of the U-Boot image - built was "2013.10, the full version string reported by - U-Boot would be "2013.10-yocto" given the following - statement: - <literallayout class='monospaced'> - UBOOT_LOCALVERSION = "-yocto" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UBOOT_MACHINE'><glossterm>UBOOT_MACHINE</glossterm> - <info> - UBOOT_MACHINE[doc] = "Specifies the value passed on the make command line when building a U-Boot image." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the value passed on the - <filename>make</filename> command line when building - a U-Boot image. - The value indicates the target platform configuration. - You typically set this variable from the machine - configuration file (i.e. - <filename>conf/machine/<replaceable>machine_name</replaceable>.conf</filename>). - </para> - - <para> - Please see the "Selection of Processor Architecture and - Board Type" section in the U-Boot README for valid values - for this variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UBOOT_MAKE_TARGET'><glossterm>UBOOT_MAKE_TARGET</glossterm> - <info> - UBOOT_MAKE_TARGET[doc] = "Specifies the target called in the Makefile." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the target called in the - <filename>Makefile</filename>. - The default target is "all". - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UBOOT_SUFFIX'><glossterm>UBOOT_SUFFIX</glossterm> - <info> - UBOOT_SUFFIX[doc] = "Points to the generated U-Boot extension." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Points to the generated U-Boot extension. - For example, <filename>u-boot.sb</filename> has a - <filename>.sb</filename> extension. - </para> - - <para> - The default U-Boot extension is - <filename>.bin</filename> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UBOOT_TARGET'><glossterm>UBOOT_TARGET</glossterm> - <info> - UBOOT_TARGET[doc] = "Specifies the target used for building U-Boot." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the target used for building U-Boot. - The target is passed directly as part of the "make" command - (e.g. SPL and AIS). - If you do not specifically set this variable, the - OpenEmbedded build process passes and uses "all" for the - target during the U-Boot building process. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UNKNOWN_CONFIGURE_WHITELIST'><glossterm>UNKNOWN_CONFIGURE_WHITELIST</glossterm> - <info> - UNKNOWN_CONFIGURE_WHITELIST[doc] = "Specifies a list of options that, if reported by the configure script as being invalid, should not generate a warning during the do_configure task." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a list of options that, if reported by the - configure script as being invalid, should not generate a - warning during the - <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> - task. - Normally, invalid configure options are simply not passed - to the configure script (e.g. should be removed from - <link linkend='var-EXTRA_OECONF'><filename>EXTRA_OECONF</filename></link> - or - <link linkend='var-PACKAGECONFIG_CONFARGS'><filename>PACKAGECONFIG_CONFARGS</filename></link>). - However, common options, for example, exist that are passed - to all configure scripts at a class level that might not - be valid for some configure scripts. - It follows that no benefit exists in seeing a warning about - these options. - For these cases, the options are added to - <filename>UNKNOWN_CONFIGURE_WHITELIST</filename>. - </para> - - <para> - The configure arguments check that uses - <filename>UNKNOWN_CONFIGURE_WHITELIST</filename> is part - of the - <link linkend='ref-classes-insane'><filename>insane</filename></link> - class and is only enabled if the recipe inherits the - <link linkend='ref-classes-autotools'><filename>autotools</filename></link> - class. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UPDATERCPN'><glossterm>UPDATERCPN</glossterm> - <info> - UPDATERCPN[doc] = "Specifies the package that contains the initscript that is enabled." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - For recipes inheriting the - <link linkend='ref-classes-update-rc.d'><filename>update-rc.d</filename></link> - class, <filename>UPDATERCPN</filename> specifies - the package that contains the initscript that is - enabled. - </para> - - <para> - The default value is "${PN}". - Given that almost all recipes that install initscripts - package them in the main package for the recipe, you - rarely need to set this variable in individual recipes. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UPSTREAM_CHECK_GITTAGREGEX'><glossterm>UPSTREAM_CHECK_GITTAGREGEX</glossterm> - <info> - UPSTREAM_CHECK_GITTAGREGEX[doc] = "Filters relevant Git tags when fetching source from an upstream Git repository." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class is enabled globally, you can perform a per-recipe - check for what the latest upstream source code version is - by calling - <filename>bitbake -c checkpkg</filename> <replaceable>recipe</replaceable>. - 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 - <filename>UPSTREAM_CHECK_GITTAGREGEX</filename> - variable to provide a regular expression to filter only the - relevant tags should the default filter not work - correctly. - <literallayout class='monospaced'> - UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UPSTREAM_CHECK_REGEX'><glossterm>UPSTREAM_CHECK_REGEX</glossterm> - <info> - UPSTREAM_CHECK_REGEX[doc] = "The regular expression the package checking system uses to parse the page pointed to by UPSTREAM_CHECK_URI." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class is enabled globally, use the - <filename>UPSTREAM_CHECK_REGEX</filename> variable to - specify a different regular expression instead of the - default one when the package checking system is parsing - the page found using - <link linkend='var-UPSTREAM_CHECK_URI'><filename>UPSTREAM_CHECK_URI</filename></link>. - <literallayout class='monospaced'> - UPSTREAM_CHECK_REGEX = "package_regex" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-UPSTREAM_CHECK_URI'><glossterm>UPSTREAM_CHECK_URI</glossterm> - <info> - UPSTREAM_CHECK_URI[doc] = "The URL used by the package checking system to get the latest version of the package when source files are fetched from an upstream Git repository." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When the - <link linkend='ref-classes-distrodata'><filename>distrodata</filename></link> - class is enabled globally, you can perform a per-recipe - check for what the latest upstream source code version is - by calling <filename>bitbake -c checkpkg</filename> - <replaceable>recipe</replaceable>. - 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 - <filename>UPSTREAM_CHECK_URI</filename> to - provide a different URI that contains the link to the - latest tarball. - <literallayout class='monospaced'> - UPSTREAM_CHECK_URI = "recipe_url" - </literallayout> - </para> - </glossdef> - </glossentry> - - <glossentry id='var-USE_DEVFS'><glossterm>USE_DEVFS</glossterm> - <info> - USE_DEVFS[doc] = "Determines if devtmpfs is used for /dev population." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Determines if <filename>devtmpfs</filename> is used for - <filename>/dev</filename> population. - The default value used for <filename>USE_DEVFS</filename> - is "1" when no value is specifically set. - Typically, you would set <filename>USE_DEVFS</filename> - to "0" for a statically populated <filename>/dev</filename> - directory. - </para> - - <para> - See the - "<ulink url='&YOCTO_DOCS_DEV_URL;#selecting-dev-manager'>Selecting a Device Manager</ulink>" - section in the Yocto Project Development Tasks Manual for - information on how to use this variable. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-USE_VT'><glossterm>USE_VT</glossterm> - <info> - USE_VT[doc] = "When using SysVinit, determines whether or not to run a getty on any virtual terminals in order to enable logging in through those terminals." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When using - <ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services'>SysVinit</ulink>, - determines whether or not to run a - <ulink url='http://en.wikipedia.org/wiki/Getty_%28Unix%29'>getty</ulink> - on any virtual terminals in order to enable logging in - through those terminals. - </para> - - <para> - The default value used for <filename>USE_VT</filename> - is "1" when no default value is specifically set. - Typically, you would set <filename>USE_VT</filename> - to "0" in the machine configuration file for machines - that do not have a graphical display attached and - therefore do not need virtual terminal functionality. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-USER_CLASSES'><glossterm>USER_CLASSES</glossterm> - <info> - USER_CLASSES[doc] = "List of additional classes to use when building images that enable extra features." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - A list of classes to globally inherit. - These classes are used by the OpenEmbedded build system - to enable extra features (e.g. - <filename>buildstats</filename>, - <filename>image-mklibs</filename>, and so forth). - </para> - - <para> - The default list is set in your - <filename>local.conf</filename> file: - <literallayout class='monospaced'> - USER_CLASSES ?= "buildstats image-mklibs image-prelink" - </literallayout> - For more information, see - <filename>meta-poky/conf/local.conf.sample</filename> in - the - <link linkend='source-directory'>Source Directory</link>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-USERADD_ERROR_DYNAMIC'><glossterm>USERADD_ERROR_DYNAMIC</glossterm> - <info> - USERADD_ERROR_DYNAMIC[doc] = "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 files/passwd and files/group files. If set to 'warn', a warning will be issued instead." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - If set to "error", forces the OpenEmbedded build system to - produce an error if the user identification - (<filename>uid</filename>) and group identification - (<filename>gid</filename>) values are not defined - in <filename>files/passwd</filename> - and <filename>files/group</filename> files. - If set to "warn", a warning will be issued instead. - </para> - - <para> - The default behavior for the build system is to dynamically - apply <filename>uid</filename> and - <filename>gid</filename> values. - Consequently, the <filename>USERADD_ERROR_DYNAMIC</filename> - variable is by default not set. - If you plan on using statically assigned - <filename>gid</filename> and <filename>uid</filename> - values, you should set - the <filename>USERADD_ERROR_DYNAMIC</filename> variable in - your <filename>local.conf</filename> file as - follows: - <literallayout class='monospaced'> - USERADD_ERROR_DYNAMIC = "error" - </literallayout> - Overriding the default behavior implies you are going to - also take steps to set static <filename>uid</filename> and - <filename>gid</filename> values through use of the - <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link>, - <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link>, - and - <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link> - variables. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-USERADD_GID_TABLES'><glossterm>USERADD_GID_TABLES</glossterm> - <info> - USERADD_GID_TABLES[doc] = "Specifies a password file to use for obtaining static group identification (gid) values when the OpenEmbedded build system adds a group to the system during package installation." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a password file to use for obtaining static - group identification (<filename>gid</filename>) values - when the OpenEmbedded build system adds a group to the - system during package installation. - </para> - - <para> - When applying static group identification - (<filename>gid</filename>) values, the OpenEmbedded build - system looks in - <link linkend='var-BBPATH'><filename>BBPATH</filename></link> - for a <filename>files/group</filename> file and then applies - those <filename>uid</filename> values. - Set the variable as follows in your - <filename>local.conf</filename> file: - <literallayout class='monospaced'> - USERADD_GID_TABLES = "files/group" - </literallayout> - </para> - - <note> - Setting the - <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link> - variable to "useradd-staticids" causes the build system - to use static <filename>gid</filename> values. - </note> - </glossdef> - </glossentry> - - <glossentry id='var-USERADD_PACKAGES'><glossterm>USERADD_PACKAGES</glossterm> - <info> - USERADD_PACKAGES[doc] = "When a recipe inherits the useradd class, this variable specifies the individual packages within the recipe that require users and/or groups to be added." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-useradd'><filename>useradd</filename></link> - class, this variable - specifies the individual packages within the recipe that - require users and/or groups to be added. - </para> - - <para> - You must set this variable if the recipe inherits the - class. - For example, the following enables adding a user for the - main package in a recipe: - <literallayout class='monospaced'> - USERADD_PACKAGES = "${PN}" - </literallayout> - <note> - It follows that if you are going to use the - <filename>USERADD_PACKAGES</filename> variable, - you need to set one or more of the - <link linkend='var-USERADD_PARAM'><filename>USERADD_PARAM</filename></link>, - <link linkend='var-GROUPADD_PARAM'><filename>GROUPADD_PARAM</filename></link>, - or - <link linkend='var-GROUPMEMS_PARAM'><filename>GROUPMEMS_PARAM</filename></link> - variables. - </note> - </para> - - </glossdef> - </glossentry> - - <glossentry id='var-USERADD_PARAM'><glossterm>USERADD_PARAM</glossterm> - <info> - USERADD_PARAM[doc] = "When a recipe inherits the useradd class, this variable specifies for a package what parameters should pass to the useradd command if you add a user to the system when the package is installed." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When inheriting the - <link linkend='ref-classes-useradd'><filename>useradd</filename></link> - class, this variable - specifies for a package what parameters should pass - to the <filename>useradd</filename> command - if you add a user to the system when the package - is installed. - </para> - - <para> - Here is an example from the <filename>dbus</filename> - recipe: - <literallayout class='monospaced'> - USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \ - --no-create-home --shell /bin/false \ - --user-group messagebus" - </literallayout> - For information on the standard Linux shell command - <filename>useradd</filename>, see - <ulink url='http://linux.die.net/man/8/useradd'></ulink>. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-USERADD_UID_TABLES'><glossterm>USERADD_UID_TABLES</glossterm> - <info> - USERADD_UID_TABLES[doc] = "Specifies a password file to use for obtaining static user identification (uid) values when the OpenEmbedded build system adds a user to the system during package installation." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies a password file to use for obtaining static - user identification (<filename>uid</filename>) values - when the OpenEmbedded build system adds a user to the - system during package installation. - </para> - - <para> - When applying static user identification - (<filename>uid</filename>) values, the OpenEmbedded build - system looks in - <link linkend='var-BBPATH'><filename>BBPATH</filename></link> - for a <filename>files/passwd</filename> file and then applies - those <filename>uid</filename> values. - Set the variable as follows in your - <filename>local.conf</filename> file: - <literallayout class='monospaced'> - USERADD_UID_TABLES = "files/passwd" - </literallayout> - </para> - - <note> - Setting the - <link linkend='var-USERADDEXTENSION'><filename>USERADDEXTENSION</filename></link> - variable to "useradd-staticids" causes the build system - to use static <filename>uid</filename> values. - </note> - </glossdef> - </glossentry> - - <glossentry id='var-USERADDEXTENSION'><glossterm>USERADDEXTENSION</glossterm> - <info> - USERADDEXTENSION[doc] = "When set to 'useradd-staticids', causes the OpenEmbedded build system to base all user and group additions on a static passwd and group files found in BBPATH." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - When set to "useradd-staticids", causes the - OpenEmbedded build system to base all user and group - additions on a static - <filename>passwd</filename> and - <filename>group</filename> files found in - <link linkend='var-BBPATH'><filename>BBPATH</filename></link>. - </para> - - <para> - To use static user identification (<filename>uid</filename>) - and group identification (<filename>gid</filename>) - values, set the variable - as follows in your <filename>local.conf</filename> file: - <literallayout class='monospaced'> - USERADDEXTENSION = "useradd-staticids" - </literallayout> - <note> - Setting this variable to use static - <filename>uid</filename> and <filename>gid</filename> - values causes the OpenEmbedded build system to employ - the - <link linkend='ref-classes-useradd'><filename>useradd-staticids</filename></link> - class. - </note> - </para> - - <para> - If you use static <filename>uid</filename> and - <filename>gid</filename> information, you must also - specify the <filename>files/passwd</filename> and - <filename>files/group</filename> files by setting the - <link linkend='var-USERADD_UID_TABLES'><filename>USERADD_UID_TABLES</filename></link> - and - <link linkend='var-USERADD_GID_TABLES'><filename>USERADD_GID_TABLES</filename></link> - variables. - Additionally, you should also set the - <link linkend='var-USERADD_ERROR_DYNAMIC'><filename>USERADD_ERROR_DYNAMIC</filename></link> - variable. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-v'><title>V</title> - - <glossentry id='var-VOLATILE_LOG_DIR'><glossterm>VOLATILE_LOG_DIR</glossterm> - <info> - VOLATILE_LOG_DIR[doc] = "Specifies the persistence of the target's /var/log directory, which is used to house postinstall target log files." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the persistence of the target's - <filename>/var/log</filename> directory, which is used to - house postinstall target log files. - </para> - - <para> - By default, <filename>VOLATILE_LOG_DIR</filename> 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. - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-w'><title>W</title> - - <glossentry id='var-WARN_QA'><glossterm>WARN_QA</glossterm> - <info> - WARN_QA[doc] = "Specifies the quality assurance checks whose failures are reported as warnings by the OpenEmbedded build system." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the quality assurance checks whose failures are - reported as warnings by the OpenEmbedded build system. - You set this variable in your distribution configuration - file. - For a list of the checks you can control with this variable, - see the - "<link linkend='ref-classes-insane'><filename>insane.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-WKS_FILE_DEPENDS'><glossterm>WKS_FILE_DEPENDS</glossterm> - <info> - WKS_FILE_DEPENDS[doc] = "Lists a recipe's build-time dependencies specific to Wic." - </info> - <glossdef> - <para role="glossdeffirst"> - When placed in the recipe that builds your image, this - variable lists build-time dependencies. - The <filename>WKS_FILE_DEPENDS</filename> variable is only - applicable when Wic images are active (i.e. when - <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link> - contains entries related to Wic). - If your recipe does not create Wic images, the variable - has no effect. - </para> - - <para> - The <filename>WKS_FILE_DEPENDS</filename> variable is - similar to the - <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> - variable. - When you use the variable in your recipe that builds the - Wic image, dependencies you list in the - <filename>WIC_FILE_DEPENDS</filename> variable are added to - the <filename>DEPENDS</filename> variable. - </para> - - <para> - With the <filename>WKS_FILE_DEPENDS</filename> 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: - <literallayout class='monospaced'> - WKS_FILE_DEPENDS = "<replaceable>some-native-tool</replaceable>" - </literallayout> - In the previous example, - <replaceable>some-native-tool</replaceable> would be - replaced with an actual native tool on which the build - would depend. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-WKS_FILE'><glossterm>WKS_FILE</glossterm> - <info> - WKS_FILE[doc] = "Specifies the name of the wic kickstart file." - </info> - <glossdef> - <para role="glossdeffirst"> - Specifies the location of the Wic - kickstart file that is used by the OpenEmbedded build - system to create a partitioned image - (<replaceable>image</replaceable><filename>.wic</filename>). - For information on how to create a partitioned image, see - the - "<ulink url='&YOCTO_DOCS_DEV_URL;#creating-partitioned-images-using-wic'>Creating Partitioned Images Using Wic</ulink>" - section in the Yocto Project Development Tasks Manual. - For details on the kickstart file format, see the - "<link linkend='ref-kickstart'>OpenEmbedded Kickstart (<filename>.wks</filename>) Reference</link> - Chapter. - </para> - </glossdef> - </glossentry> - - <glossentry id='var-WORKDIR'><glossterm>WORKDIR</glossterm> - <info> - WORKDIR[doc] = "The pathname of the working directory in which the OpenEmbedded build system builds a recipe. This directory is located within the TMPDIR directory structure and changes as different packages are built." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - The pathname of the work directory in which the OpenEmbedded - build system builds a recipe. - This directory is located within the - <link linkend='var-TMPDIR'><filename>TMPDIR</filename></link> - directory structure and is specific to the recipe being - built and the system for which it is being built. - </para> - - <para> - The <filename>WORKDIR</filename> directory is defined as - follows: - <literallayout class='monospaced'> - ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} - </literallayout> - The actual directory depends on several things: - <itemizedlist> - <listitem><filename>TMPDIR</filename>: - The top-level build output directory</listitem> - <listitem><link linkend='var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></link>: - The target system identifier</listitem> - <listitem><link linkend='var-PN'><filename>PN</filename></link>: - The recipe name</listitem> - <listitem><link linkend='var-EXTENDPE'><filename>EXTENDPE</filename></link>: - The epoch - (if - <link linkend='var-PE'><filename>PE</filename></link> - is not specified, which is usually the case for most - recipes, then <filename>EXTENDPE</filename> is blank)</listitem> - <listitem><link linkend='var-PV'><filename>PV</filename></link>: - The recipe version</listitem> - <listitem><link linkend='var-PR'><filename>PR</filename></link>: - The recipe revision</listitem> - </itemizedlist> - </para> - - <para> - As an example, assume a Source Directory top-level folder - name <filename>poky</filename>, a default Build Directory at - <filename>poky/build</filename>, and a - <filename>qemux86-poky-linux</filename> machine target - system. - Furthermore, suppose your recipe is named - <filename>foo_1.3.0-r0.bb</filename>. - In this case, the work directory the build system uses to - build the package would be as follows: - <literallayout class='monospaced'> - poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 - </literallayout> - </para> - </glossdef> - </glossentry> - - </glossdiv> - - <glossdiv id='var-glossary-x'><title>X</title> - - <glossentry id='var-XSERVER'><glossterm>XSERVER</glossterm> - <info> - XSERVER[doc] = "Specifies the packages that should be installed - to provide an X server and drivers for the current machine." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Specifies the packages that should be installed to - provide an X server and drivers for the current machine, - assuming your image directly includes - <filename>packagegroup-core-x11-xserver</filename> or, - perhaps indirectly, includes "x11-base" in - <link linkend='var-IMAGE_FEATURES'><filename>IMAGE_FEATURES</filename></link>. - </para> - - <para> - The default value of <filename>XSERVER</filename>, if not - specified in the machine configuration, is - "xserver-xorg xf86-video-fbdev xf86-input-evdev". - </para> - </glossdef> - </glossentry> - - </glossdiv> - -<!-- <glossdiv id='var-glossary-y'><title>Y</title>--> -<!-- </glossdiv>--> - -<!-- <glossdiv id='var-glossary-z'><title>Z</title>--> -<!-- </glossdiv>--> - -</glossary> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/ref-varlocality.xml b/documentation/ref-manual/ref-varlocality.xml deleted file mode 100644 index 54524d5b60..0000000000 --- a/documentation/ref-manual/ref-varlocality.xml +++ /dev/null @@ -1,198 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='ref-varlocality'> - <title>Variable Context</title> - - <para> - While you can use most variables in almost any context such as - <filename>.conf</filename>, <filename>.bbclass</filename>, - <filename>.inc</filename>, and <filename>.bb</filename> files, - some variables are often associated with a particular locality or context. - This chapter describes some common associations. - </para> - - <section id='ref-varlocality-configuration'> - <title>Configuration</title> - - <para> - The following subsections provide lists of variables whose context is - configuration: distribution, machine, and local. - </para> - - <section id='ref-varlocality-config-distro'> - <title>Distribution (Distro)</title> - - <para> - This section lists variables whose configuration context is the - distribution, or distro. - <itemizedlist> - <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename></para></listitem> - <listitem><para><filename><link linkend='var-DISTRO_NAME'>DISTRO_NAME</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-DISTRO_VERSION'>DISTRO_VERSION</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-MAINTAINER'>MAINTAINER</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-TARGET_OS'>TARGET_OS</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-TARGET_FPU'>TARGET_FPU</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-TCMODE'>TCMODE</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-TCLIBC'>TCLIBC</link></filename> - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='ref-varlocality-config-machine'> - <title>Machine</title> - - <para> - This section lists variables whose configuration context is the - machine. - <itemizedlist> - <listitem><para><filename><link linkend='var-TARGET_ARCH'>TARGET_ARCH</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-SERIAL_CONSOLES'>SERIAL_CONSOLES</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-PACKAGE_EXTRA_ARCHS'>PACKAGE_EXTRA_ARCHS</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-MACHINE_FEATURES'>MACHINE_FEATURES</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RDEPENDS'>MACHINE_EXTRA_RDEPENDS - </link></filename></para></listitem> - <listitem><para><filename><link linkend='var-MACHINE_EXTRA_RRECOMMENDS'>MACHINE_EXTRA_RRECOMMENDS - </link></filename></para></listitem> - <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RDEPENDS'>MACHINE_ESSENTIAL_EXTRA_RDEPENDS - </link></filename></para></listitem> - <listitem><para><filename><link linkend='var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'> - MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</link></filename></para></listitem> - </itemizedlist> - </para> - </section> - - <section id='ref-varlocality-config-local'> - <title>Local</title> - - <para> - This section lists variables whose configuration context is the - local configuration through the <filename>local.conf</filename> - file. - <itemizedlist> - <listitem><para><filename><link linkend='var-DISTRO'>DISTRO</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-MACHINE'>MACHINE</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-DL_DIR'>DL_DIR</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-BBFILES'>BBFILES</link></filename> - </para></listitem> - <listitem><para><filename><link linkend='var-EXTRA_IMAGE_FEATURES'>EXTRA_IMAGE_FEATURES - </link></filename></para></listitem> - <listitem><para><filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-BBINCLUDELOGS'>BBINCLUDELOGS</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'> - ENABLE_BINARY_LOCALE_GENERATION</link></filename></para></listitem> - </itemizedlist> - </para> - </section> - </section> - - <section id='ref-varlocality-recipes'> - <title>Recipes</title> - - <para> - The following subsections provide lists of variables whose context is - recipes: required, dependencies, path, and extra build information. - </para> - - <section id='ref-varlocality-recipe-required'> - <title>Required</title> - - <para> - This section lists variables that are required for recipes. - <itemizedlist> - <listitem><para><filename><link linkend='var-LICENSE'>LICENSE</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-LIC_FILES_CHKSUM'>LIC_FILES_CHKSUM</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-SRC_URI'>SRC_URI</link></filename> - used - in recipes that fetch local or remote files. - </para></listitem> - </itemizedlist> - </para> - </section> - - <section id='ref-varlocality-recipe-dependencies'> - <title>Dependencies</title> - - <para> - This section lists variables that define recipe dependencies. - <itemizedlist> - <listitem><para><filename><link linkend='var-DEPENDS'>DEPENDS</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-RDEPENDS'>RDEPENDS</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-RRECOMMENDS'>RRECOMMENDS</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-RCONFLICTS'>RCONFLICTS</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-RREPLACES'>RREPLACES</link> - </filename></para></listitem> - </itemizedlist> - </para> - </section> - - <section id='ref-varlocality-recipe-paths'> - <title>Paths</title> - - <para> - This section lists variables that define recipe paths. - <itemizedlist> - <listitem><para><filename><link linkend='var-WORKDIR'>WORKDIR</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-S'>S</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-FILES'>FILES</link> - </filename></para></listitem> - </itemizedlist> - </para> - </section> - - <section id='ref-varlocality-recipe-build'> - <title>Extra Build Information</title> - - <para> - This section lists variables that define extra build information for recipes. - <itemizedlist> - <listitem><para><filename><link linkend='var-DEFAULT_PREFERENCE'>DEFAULT_PREFERENCE - </link></filename></para></listitem> - <listitem><para><filename><link linkend='var-EXTRA_OECMAKE'>EXTRA_OECMAKE</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-PACKAGECONFIG_CONFARGS'>PACKAGECONFIG_CONFARGS</link> - </filename></para></listitem> - <listitem><para><filename><link linkend='var-PACKAGES'>PACKAGES</link></filename> - </para></listitem> - </itemizedlist> - </para> - </section> - </section> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 spell spelllang=en_gb ---> diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst new file mode 100644 index 0000000000..920794679d --- /dev/null +++ b/documentation/ref-manual/release-process.rst @@ -0,0 +1,219 @@ +.. 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. +Here are examples of some major YP releases with their codenames +also shown. See the ":ref:`ref-manual/release-process:major release codenames`" +section for information on codenames used with major releases. + + - 4.1 ("Langdale") + - 4.0 ("Kirkstone") + - 3.4 ("Honister") + +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. +Some example past point releases are: + + - 4.1.3 + - 4.0.8 + - 3.4.4 + +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`. + +Our :doc:`/migration-guides/index` detail how to migrate from one release of +the Yocto Project to the next. + +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 there is a strong reason such as + the fix happens to also be the preferred upstream approach. + +.. _ref-long-term-support-releases: + +Long Term Support Releases +========================== + +While stable releases are supported for a duration of seven months, +some specific ones are now supported for a longer period by the Yocto +Project, and are called Long Term Support (:term:`LTS`) releases. + +When significant issues are found, :term:`LTS` releases allow to publish +fixes not only for the current stable release, but also to the +:term:`LTS` releases that are still supported. Older stable releases which +have reached their End of Life (EOL) won't receive such updates. + +This started with version 3.1 ("Dunfell"), released in April 2020, which +the project initially committed to supporting for two years, but this duration +was later extended to four years. Similarly, the following :term:`LTS` release, +version 4.0 ("Kirkstone"), was released two years later in May 2022 and the +project committed to supporting it for four years too. + +Therefore, a new :term:`LTS` release is made every two years and is supported +for four years. This offers more stability to project users and leaves more +time to upgrade to the following :term:`LTS` release. + +See :yocto_wiki:`/Stable_Release_and_LTS` for details about the management +of stable and :term:`LTS` releases. + +.. image:: svg/releases.* + :width: 100% + +.. note:: + + In some circumstances, a layer can be created by the community in order to + add a specific feature or support a new version of some package for an :term:`LTS` + release. This is called a :term:`Mixin` layer. These are thin and specific + purpose layers which can be stacked with an :term:`LTS` release to "mix" a specific + feature into that build. These are created on an as-needed basis and + maintained by the people who need them. + + Policies on testing these layers depend on how widespread their usage is and + determined on a case-by-case basis. You can find some :term:`Mixin` layers in the + :yocto_git:`meta-lts-mixins </meta-lts-mixins>` repository. While the Yocto + Project provides hosting for those repositories, it does not provides + testing on them. Other :term:`Mixin` layers may be released elsewhere by the wider + community. + +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/runtime-testing: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:`ref-classes-sanity`: This automatically + included class checks the build environment for missing tools (e.g. + ``gcc``) or common misconfigurations such as + :term:`MACHINE` set incorrectly. + +- :ref:`ref-classes-insane`: 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:`ref-classes-testimage`: This class + performs runtime testing of images after they are built. The tests + are usually used with :doc:`QEMU </dev-manual/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 <dev-manual/packages:testing packages with ptest>`: + Runs tests against packages produced during the build for a given + piece of software. The test allows the packages to be run within a + target image. + +- ``oe-selftest``: Tests combinations of 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. + +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 :oe_git:`openembedded-core </openembedded-core>`, +:yocto_git:`poky </poky>` and :oe_git:`bitbake </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 +in the "master-next" branch in the :yocto_git:`poky </poky>` repository. + +.. note:: + + You can find all these branches in the + :ref:`overview-manual/development-environment: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/resources.rst b/documentation/ref-manual/resources.rst new file mode 100644 index 0000000000..4eaaca942e --- /dev/null +++ b/documentation/ref-manual/resources.rst @@ -0,0 +1,203 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +**************************************** +Contributions and Additional Information +**************************************** + +.. _resources-intro: + +Introduction +============ + +The Yocto Project team is happy for people to experiment with the Yocto +Project. There is a number of places where you can find help if you run into +difficulties or find bugs. This presents information about contributing +and participating in the Yocto Project. + +.. _resources-contributions: + +Contributions +============= + +The Yocto Project gladly accepts contributions. You can submit changes +to the project either by creating and sending pull requests, or by +submitting patches through email. For information on how to do both as +well as information on how to identify the maintainer for each area of +code, see the :doc:`../contributor-guide/index`. + +.. _resources-bugtracker: + +Yocto Project Bugzilla +====================== + +The Yocto Project uses its own implementation of +:yocto_bugs:`Bugzilla <>` to track defects (bugs). +Implementations of Bugzilla work well for group development because they +track bugs and code changes, can be used to communicate changes and +problems with developers, can be used to submit and review patches, and +can be used to manage quality assurance. + +Sometimes it is helpful to submit, investigate, or track a bug against +the Yocto Project itself (e.g. when discovering an issue with some +component of the build system that acts contrary to the documentation or +your expectations). + +For a general procedure and guidelines on how to use Bugzilla to submit a bug +against the Yocto Project, see the following: + +- The ":doc:`../contributor-guide/report-defect`" + section in the Yocto Project and OpenEmbedded Contributor Guide. + +- The Yocto Project :yocto_wiki:`Bugzilla wiki page </Bugzilla_Configuration_and_Bug_Tracking>` + +For information on Bugzilla in general, see https://www.bugzilla.org/about/. + +.. _resources-mailinglist: + +Mailing lists +============= + +There are multiple mailing lists maintained by the Yocto Project as well +as related OpenEmbedded mailing lists for discussion, patch submission +and announcements. To subscribe to one of the following mailing lists, +click on the appropriate URL in the following list and follow the +instructions: + +- :yocto_lists:`/g/yocto` --- general Yocto Project + discussion mailing list. + +- :yocto_lists:`/g/yocto-patches` --- patch contribution mailing list for Yocto + Project-related layers which do not have their own mailing list. + +- :oe_lists:`/g/openembedded-core` --- discussion mailing + list about OpenEmbedded-Core (the core metadata). + +- :oe_lists:`/g/openembedded-devel` --- discussion + mailing list about OpenEmbedded. + +- :oe_lists:`/g/bitbake-devel` --- discussion mailing + list about the :term:`BitBake` build tool. + +- :yocto_lists:`/g/poky` --- discussion mailing list + about :term:`Poky`. + +- :yocto_lists:`/g/yocto-announce` --- mailing list to + receive official Yocto Project release and milestone announcements. + +- :yocto_lists:`/g/docs` --- discussion mailing list about the Yocto Project + documentation. + +See also :yocto_home:`the description of all mailing lists </community/mailing-lists/>`. + +.. _resources-irc: + +Internet Relay Chat (IRC) +========================= + +Two IRC channels on `Libera Chat <https://libera.chat/>`__ +are available for the Yocto Project and OpenEmbedded discussions: + +- ``#yocto`` + +- ``#oe`` + +.. _resources-links-and-related-documentation: + +Links and Related Documentation +=============================== + +Here is a list of resources you might find helpful: + +- :yocto_home:`The Yocto Project Website <>`: The home site + for the Yocto Project. + +- :yocto_wiki:`The Yocto Project Main Wiki Page <>`: The main wiki page for + the Yocto Project. This page contains information about project + planning, release engineering, QA & automation, a reference site map, + and other resources related to the Yocto Project. + +- :oe_home:`OpenEmbedded <>`: The build system used by the + Yocto Project. This project is the upstream, generic, embedded + distribution from which the Yocto Project derives its build system + (Poky) and to which it contributes. + +- :oe_wiki:`BitBake </BitBake>`: The tool used to process metadata. + +- :doc:`BitBake User Manual <bitbake:index>`: A comprehensive + guide to the BitBake tool. If you want information on BitBake, see + this manual. + +- :doc:`/brief-yoctoprojectqs/index`: This + short document lets you experience building an image using the Yocto + Project without having to understand any concepts or details. + +- :doc:`/overview-manual/index`: This manual provides overview + and conceptual information about the Yocto Project. + +- :doc:`/dev-manual/index`: This manual is a "how-to" guide + that presents procedures useful to both application and system + developers who use the Yocto Project. + +- :doc:`/sdk-manual/index` manual: This + guide provides information that lets you get going with the standard + or extensible SDK. An SDK, with its cross-development toolchains, + allows you to develop projects inside or outside of the Yocto Project + environment. + +- :doc:`/bsp-guide/bsp`: This guide defines the structure + for BSP components. Having a commonly understood structure encourages + standardization. + +- :doc:`/kernel-dev/index`: This manual describes + how to work with Linux Yocto kernels as well as provides a bit of + conceptual information on the construction of the Yocto Linux kernel + tree. + +- :doc:`/ref-manual/index`: This + manual provides reference material such as variable, task, and class + descriptions. + +- :yocto_docs:`Yocto Project Mega-Manual </singleindex.html>`: This manual + is simply a single HTML file comprised of the bulk of the Yocto + Project manuals. It makes it easy to search for phrases and terms used + in the Yocto Project documentation set. + +- :doc:`/profile-manual/index`: This manual presents a set of + common and generally useful tracing and profiling schemes along with + their applications (as appropriate) to each tool. + +- :doc:`/toaster-manual/index`: This manual + introduces and describes how to set up and use Toaster. Toaster is an + Application Programming Interface (API) and web-based interface to + the :term:`OpenEmbedded Build System`, which uses + BitBake, that reports build information. + +- `Yocto Project BitBake extension for VSCode + <https://marketplace.visualstudio.com/items?itemName=yocto-project.yocto-bitbake>`__: + This extension provides a rich feature set when working with BitBake recipes + within the Visual Studio Code IDE. + +- :yocto_wiki:`FAQ </FAQ>`: A list of commonly asked + questions and their answers. + +- :doc:`Release Information </migration-guides/index>`: + Migration guides, release notes, new features, updates and known issues + for the current and past releases of the Yocto Project. + +- :yocto_bugs:`Bugzilla <>`: The bug tracking application + the Yocto Project uses. If you find problems with the Yocto Project, + you should report them using this application. + +- :yocto_wiki:`Bugzilla Configuration and Bug Tracking Wiki Page + </Bugzilla_Configuration_and_Bug_Tracking>`: + Information on how to get set up and use the Yocto Project + implementation of Bugzilla for logging and tracking Yocto Project + defects. + +- Internet Relay Chat (IRC): Two IRC channels on + `Libera Chat <https://libera.chat/>`__ are + available for Yocto Project and OpenEmbeddded discussions: ``#yocto`` and + ``#oe``, respectively. + +- `Quick EMUlator (QEMU) <https://wiki.qemu.org/Index.html>`__: An + open-source machine emulator and virtualizer. diff --git a/documentation/ref-manual/resources.xml b/documentation/ref-manual/resources.xml deleted file mode 100644 index 6a0cee8a56..0000000000 --- a/documentation/ref-manual/resources.xml +++ /dev/null @@ -1,305 +0,0 @@ -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" -"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" -[<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > - -<chapter id='resources'> -<title>Contributions and Additional Information</title> - -<section id='resources-intro'> - <title>Introduction</title> - <para> - The Yocto Project team is happy for people to experiment with the - Yocto Project. - A number of places exist to find help if you run into difficulties - or find bugs. - This presents information about contributing and participating in - the Yocto Project. - </para> -</section> - -<section id='resources-contributions'> - <title>Contributions</title> - - <para> - The Yocto Project gladly accepts contributions. - You can submit changes to the project either by creating and sending - pull requests, - or by submitting patches through email. - For information on how to do both as well as information on how - to identify the maintainer for each area of code, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#how-to-submit-a-change'>Submitting a Change to the Yocto Project</ulink>" - section in the Yocto Project Development Tasks Manual. - </para> -</section> - -<section id='resources-bugtracker'> - <title>Yocto Project Bugzilla</title> - - <para> - The Yocto Project uses its own implementation of - <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink> to - track defects (bugs). - Implementations of Bugzilla work well for group development because - they track bugs and code changes, can be used to communicate changes - and problems with developers, can be used to submit and review patches, - and can be used to manage quality assurance. - </para> - - <para> - Sometimes it is helpful to submit, investigate, or track a bug against - the Yocto Project itself (e.g. when discovering an issue with some - component of the build system that acts contrary to the documentation - or your expectations). - </para> - - <para> - A general procedure and guidelines exist for when you use Bugzilla to - submit a bug. - For information on how to use Bugzilla to submit a bug against the - Yocto Project, see the following: - <itemizedlist> - <listitem><para> - The - "<ulink url='&YOCTO_DOCS_DEV_URL;#submitting-a-defect-against-the-yocto-project'>Submitting a Defect Against the Yocto Project</ulink>" - section in the Yocto Project Development Tasks Manual. - </para></listitem> - <listitem><para> - The Yocto Project - <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>Bugzilla wiki page</ulink> - </para></listitem> - </itemizedlist> - For information on Bugzilla in general, see - <ulink url='http://www.bugzilla.org/about/'></ulink>. - </para> -</section> - -<section id='resources-mailinglist'> - <title>Mailing lists</title> - - <para> - A number of mailing lists maintained by the Yocto Project exist - as well as related OpenEmbedded mailing lists for discussion, - patch submission and announcements. - To subscribe to one of the following mailing lists, click on the - appropriate URL in the following list and follow the instructions: - <itemizedlist> - <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto'></ulink> - - General Yocto Project discussion mailing list. </para></listitem> - <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/openembedded-core'></ulink> - - Discussion mailing list about OpenEmbedded-Core (the core metadata).</para></listitem> - <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/openembedded-devel'></ulink> - - Discussion mailing list about OpenEmbedded.</para></listitem> - <listitem><para><ulink url='&OE_LISTS_URL;/listinfo/bitbake-devel'></ulink> - - Discussion mailing list about the - <link linkend='bitbake-term'>BitBake</link> - build tool.</para></listitem> - <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/poky'></ulink> - - Discussion mailing list about - <link linkend='poky'>Poky</link>. - </para></listitem> - <listitem><para><ulink url='&YOCTO_LISTS_URL;/listinfo/yocto-announce'></ulink> - - Mailing list to receive official Yocto Project release and milestone - announcements.</para></listitem> - </itemizedlist> - </para> - For more Yocto Project-related mailing lists, see the - <ulink url='&YOCTO_HOME_URL;'>Yocto Project Website</ulink>. -</section> - -<section id='resources-irc'> - <title>Internet Relay Chat (IRC)</title> - - <para> - Two IRC channels on freenode are available for the Yocto Project and Poky discussions: - <itemizedlist> - <listitem><para><filename>#yocto</filename></para></listitem> - <listitem><para><filename>#poky</filename></para></listitem> - </itemizedlist> - </para> -</section> - -<section id='resources-links-and-related-documentation'> - <title>Links and Related Documentation</title> - - <para> - Here is a list of resources you might find helpful: - <itemizedlist> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_HOME_URL;'>The Yocto Project website</ulink>: - </emphasis> The home site for the Yocto Project. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_WIKI_URL;/wiki/Main_Page'>The Yocto Project Main Wiki Page</ulink>: - </emphasis> - The main wiki page for the Yocto Project. - This page contains information about project planning, - release engineering, QA & automation, a reference - site map, and other resources related to the Yocto Project. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&OE_HOME_URL;'>OpenEmbedded</ulink>: - </emphasis> - The build system used by the Yocto Project. - This project is the upstream, generic, embedded distribution - from which the Yocto Project derives its build system (Poky) - and to which it contributes. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='http://www.openembedded.org/wiki/BitBake'> - BitBake</ulink>: - </emphasis> The tool used to process metadata. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>: - </emphasis> - A comprehensive guide to the BitBake tool. - If you want information on BitBake, see this manual. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_BRIEF_URL;'>Yocto Project Quick Build</ulink>: - </emphasis> - This short document lets you experience building an image using - the Yocto Project without having to understand any concepts or - details. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_OM_URL;'>Yocto Project Overview and Concepts Manual</ulink>: - </emphasis> - This manual provides overview and conceptual information - about the Yocto Project. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Tasks Manual</ulink>: - </emphasis> - This manual is a "how-to" guide that presents procedures - useful to both application and system developers who use the - Yocto Project. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_SDK_URL;'>Yocto Project Application Development and the Extensible Software Development Kit (eSDK)</ulink> - manual:</emphasis> - This guide provides information that lets you get going - with the standard or extensible SDK. - An SDK, with its cross-development toolchains, allows you - to develop projects inside or outside of the Yocto Project - environment. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>: - </emphasis> - This guide defines the structure for BSP components. - Having a commonly understood structure encourages - standardization. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>: - </emphasis> - This manual describes how to work with Linux Yocto kernels as - well as provides a bit of conceptual information on the - construction of the Yocto Linux kernel tree. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_REF_URL;'>Yocto Project Reference Manual</ulink>: - </emphasis> - This manual provides reference material such as variable, - task, and class descriptions. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_MM_URL;'>Yocto Project Mega-Manual</ulink>: - </emphasis> - This manual is simply a single HTML file comprised of the - bulk of the Yocto Project manuals. - The Mega-Manual primarily exists as a vehicle by which you can - easily search for phrases and terms used in the Yocto Project - documentation set. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_PROF_URL;'>Yocto Project Profiling and Tracing Manual</ulink>: - </emphasis> - This manual presents a set of common and generally useful - tracing and profiling schemes along with their applications - (as appropriate) to each tool. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_TOAST_URL;'>Toaster User Manual</ulink>: - </emphasis> - This manual introduces and describes how to set up and use - Toaster. - Toaster is an Application Programming Interface (API) and - web-based interface to the - <link linkend='build-system-term'>OpenEmbedded Build System</link>, - which uses BitBake, that reports build information. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_DOCS_SDK_URL;#adt-eclipse'>Eclipse IDE Yocto Plug-in</ulink>: - </emphasis> - Instructions that demonstrate how an application developer - uses the Eclipse Yocto Project Plug-in feature within - the Eclipse IDE. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_WIKI_URL;/wiki/FAQ'>FAQ</ulink>: - </emphasis> - A list of commonly asked questions and their answers. - </para></listitem> - <listitem><para> - <emphasis>Release Notes:</emphasis> - Features, updates and known issues for the current - release of the Yocto Project. - To access the Release Notes, go to the - <ulink url='&YOCTO_HOME_URL;/software-overview/downloads/'>Downloads</ulink> - page on the Yocto Project website and click on the - "RELEASE INFORMATION" link for the appropriate release. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_BUGZILLA_URL;'>Bugzilla</ulink>: - </emphasis> - The bug tracking application the Yocto Project uses. - If you find problems with the Yocto Project, you should report - them using this application. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='&YOCTO_WIKI_URL;/wiki/Bugzilla_Configuration_and_Bug_Tracking'>Bugzilla Configuration and Bug Tracking Wiki Page</ulink>: - </emphasis> - Information on how to get set up and use the Yocto Project - implementation of Bugzilla for logging and tracking Yocto - Project defects. - </para></listitem> - <listitem><para> - <emphasis>Internet Relay Chat (IRC):</emphasis> - Two IRC channels on freenode are available - for Yocto Project and Poky discussions: <filename>#yocto</filename> and - <filename>#poky</filename>, respectively. - </para></listitem> - <listitem><para> - <emphasis> - <ulink url='http://wiki.qemu.org/Index.html'>Quick EMUlator (QEMU)</ulink>: - </emphasis> - An open-source machine emulator and virtualizer. - </para></listitem> - </itemizedlist> - </para> -</section> -</chapter> -<!-- -vim: expandtab tw=80 ts=4 ---> diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst new file mode 100644 index 0000000000..e4d8b54bb9 --- /dev/null +++ b/documentation/ref-manual/structure.rst @@ -0,0 +1,871 @@ +.. 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. + +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 +<bitbake:index>`. + +.. _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. + +See the ":ref:`The Build Directory --- build/ <structure-build>`" section for details +about the contents of the :term:`Build Directory`. + +.. _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 +:term:`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 <target>' + + Common targets are: + core-image-minimal + core-image-sato + meta-toolchain + meta-ide-support + + You can also run generated QEMU images with a command like 'runqemu qemux86-64' + +The default output of the ``oe-init-build-env`` script is from the +``conf-summary.txt`` and ``conf-notes.txt`` files, which are found in the ``meta-poky`` directory +within the :term:`Source Directory`. If you design a +custom distribution, you can include your own versions of these +configuration files where you can provide a brief summary and detailed usage +notes, such as a list of the targets defined by your distribution. +See the +":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" +section in the Yocto Project Development Tasks Manual for more +information. + +By default, running this script without a :term:`Build Directory` argument +creates the ``build/`` directory in your current working directory. If +you provide a :term:`Build Directory` argument when you ``source`` the script, +you direct the OpenEmbedded build system to create a :term:`Build Directory` of +your choice. For example, the following command creates a +:term:`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/templates/default`` directory in the Source +Directory. See the +":ref:`dev-manual/custom-template-configuration-directory: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 :term:`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 :ref:`ref-classes-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/build-quality:maintaining build output quality`" +section in the Yocto Project Development Tasks Manual. + +.. _structure-build-cache: + +``build/cache/`` +---------------- + +This directory contains several internal files used by the OpenEmbedded +build system. + +It also contains ``sanity_info``, a text file keeping track of important +build information such as the values of :term:`TMPDIR`, :term:`SSTATE_DIR`, +as well as the name and version of the host distribution. + +.. _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 +:term:`MACHINE`, which package types you wish to use +(:term:`PACKAGE_CLASSES`), and the location from +which you want to access downloaded files (:term:`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 +:term:`TEMPLATECONF` script variable, which defaults to ``meta-poky/conf/templates/default`` +when you are building from the Yocto Project development environment, +and to ``meta/conf/templates/default`` 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/templates/your_template_name + +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 :term:`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/templates/default`` directory. + +.. _structure-build-conf-bblayers.conf: + +``build/conf/bblayers.conf`` +---------------------------- + +This configuration file defines +:ref:`layers <dev-manual/layers:understanding and creating 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 :term:`TEMPLATECONF` script variable, which +defaults to ``meta-poky/conf/templates/default`` when you are building from the Yocto +Project development environment, and to ``meta/conf/templates/default`` 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/templates/your_template_name + +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 :term:`TEMPLATECONF` variable is defined by the ``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/templates/default`` + directory. + +.. _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 +:term:`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 +:term:`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 as generated by the +:ref:`ref-classes-buildstats` class. + +.. _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/licenses: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. Since +the 2.3 version of the Yocto Project, there are sysroots 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. +Here 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 :term:`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 :term:`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/quilt: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 :term:`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`). + +Here are key subdirectories 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 + :ref:`ref-tasks-package` task after the output has been split into individual + packages. There are subdirectories 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*/`` +------------------ + +These directories contain the ``*.bbclass`` files. Class files are used to +abstract common code so it can be reused by multiple packages. Every +package inherits the :ref:`ref-classes-base` file. Examples of other important +classes are :ref:`ref-classes-autotools`, which in theory allows any +Autotool-enabled package to work with the Yocto Project with minimal +effort. Another example is :ref:`ref-classes-kernel` 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 +:ref:`ref-classes-image`, :ref:`ref-classes-rootfs*` and +:ref:`package*.bbclass <ref-classes-package>`. + +For reference information on classes, see the +":doc:`/ref-manual/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 :term:`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. It is enabled via the ``addpylib`` directive in +``meta/conf/local.conf``. For more information, see +:ref:`bitbake-user-manual/bitbake-user-manual-metadata:extending python library code`. + +.. _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. + +.. _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-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/svg/releases.svg b/documentation/ref-manual/svg/releases.svg new file mode 100644 index 0000000000..036aa467cc --- /dev/null +++ b/documentation/ref-manual/svg/releases.svg @@ -0,0 +1,1767 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + version="1.1" + id="svg2" + width="2040.0006" + height="669.30511" + viewBox="0 0 2040.0006 669.30509" + sodipodi:docname="releases.svg" + inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns="http://www.w3.org/2000/svg" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:dc="http://purl.org/dc/elements/1.1/"> + <title + id="title8568">Yocto Project Release Timeline</title> + <metadata + id="metadata8"> + <rdf:RDF> + <cc:Work + rdf:about=""> + <dc:format>image/svg+xml</dc:format> + <dc:type + rdf:resource="http://purl.org/dc/dcmitype/StillImage" /> + <cc:license + rdf:resource="http://artlibre.org/licence/lal" /> + <dc:title>Yocto Project Release Timeline</dc:title> + <dc:creator> + <cc:Agent> + <dc:title>The Yocto Project</dc:title> + </cc:Agent> + </dc:creator> + </cc:Work> + <cc:License + rdf:about="http://creativecommons.org/licenses/by-sa/4.0/"> + <cc:permits + rdf:resource="http://creativecommons.org/ns#Reproduction" /> + <cc:permits + rdf:resource="http://creativecommons.org/ns#Distribution" /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#Notice" /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#Attribution" /> + <cc:permits + rdf:resource="http://creativecommons.org/ns#DerivativeWorks" /> + <cc:requires + rdf:resource="http://creativecommons.org/ns#ShareAlike" /> + </cc:License> + </rdf:RDF> + </metadata> + <defs + id="defs6"> + <inkscape:path-effect + effect="powerstroke" + id="path-effect6121" + is_visible="true" + lpeversion="1" + offset_points="0,0.5" + sort_points="true" + interpolator_type="CubicBezierJohan" + interpolator_beta="0.2" + start_linecap_type="zerowidth" + linejoin_type="extrp_arc" + miter_limit="4" + scale_width="1" + end_linecap_type="zerowidth" + not_jump="false" /> + <marker + style="overflow:visible" + id="marker5783" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5781" /> + </marker> + <marker + style="overflow:visible" + id="marker5623" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5621" /> + </marker> + <marker + style="overflow:visible" + id="marker5487" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5485" /> + </marker> + <marker + style="overflow:visible" + id="marker5285" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mstart" + inkscape:isstock="true"> + <path + transform="scale(0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5283" /> + </marker> + <marker + style="overflow:visible" + id="marker5161" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5159" /> + </marker> + <marker + style="overflow:visible" + id="marker4860" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path4858" /> + </marker> + <marker + style="overflow:visible" + id="marker4504" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#ffa348;fill-opacity:1;fill-rule:evenodd;stroke:#ffa348;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path4502" /> + </marker> + <marker + style="overflow:visible" + id="Arrow1Mend" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow1Mend" + inkscape:isstock="true"> + <path + transform="matrix(-0.4,0,0,-0.4,-4,0)" + style="fill:#62a0ea;fill-opacity:1;fill-rule:evenodd;stroke:#62a0ea;stroke-width:1pt;stroke-opacity:1" + d="M 0,0 5,-5 -12.5,0 5,5 Z" + id="path3318" /> + </marker> + <marker + style="overflow:visible" + id="marker4174" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mstart" + inkscape:isstock="true"> + <path + transform="scale(0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#62a0ea;fill-opacity:1;fill-rule:evenodd;stroke:#62a0ea;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path4172" /> + </marker> + <marker + style="overflow:visible" + id="Arrow2Mend" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#ffa348;fill-opacity:1;fill-rule:evenodd;stroke:#ffa348;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path3336" /> + </marker> + <marker + style="overflow:visible" + id="Arrow1Mstart" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow1Mstart" + inkscape:isstock="true"> + <path + transform="matrix(0.4,0,0,0.4,4,0)" + style="fill:#ff7800;fill-opacity:1;fill-rule:evenodd;stroke:#ffa348;stroke-width:1pt;stroke-opacity:1" + d="M 0,0 5,-5 -12.5,0 5,5 Z" + id="path3315" /> + </marker> + <marker + style="overflow:visible" + id="Arrow2Lstart" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Lstart" + inkscape:isstock="true"> + <path + transform="matrix(1.1,0,0,1.1,1.1,0)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#ff7800;fill-opacity:1;fill-rule:evenodd;stroke:#ffa348;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path3327" /> + </marker> + <marker + style="overflow:visible" + id="Arrow1Lstart" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow1Lstart" + inkscape:isstock="true"> + <path + transform="matrix(0.8,0,0,0.8,10,0)" + style="fill:#ff7800;fill-opacity:1;fill-rule:evenodd;stroke:#ffa348;stroke-width:1pt;stroke-opacity:1" + d="M 0,0 5,-5 -12.5,0 5,5 Z" + id="path3309" /> + </marker> + <linearGradient + id="linearGradient921" + inkscape:swatch="solid"> + <stop + style="stop-color:#deddda;stop-opacity:1;" + offset="0" + id="stop919" /> + </linearGradient> + <linearGradient + id="linearGradient6035-4"> + <stop + id="stop6037-2" + style="stop-color:#ffffff" + offset="0" /> + <stop + id="stop6039-9" + style="stop-color:#ffffff;stop-opacity:0" + offset="1" /> + </linearGradient> + <marker + style="overflow:visible" + id="Arrow2Mstart-4" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mstart" + inkscape:isstock="true"> + <path + transform="scale(0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#ffa348;fill-opacity:1;fill-rule:evenodd;stroke:#ffa348;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path3333-2" /> + </marker> + <marker + style="overflow:visible" + id="Arrow2Mend-2" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#ffa348;fill-opacity:1;fill-rule:evenodd;stroke:#ffa348;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path3336-7" /> + </marker> + <marker + style="overflow:visible" + id="marker5623-2" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5621-3" /> + </marker> + <marker + style="overflow:visible" + id="Arrow2Mend-4" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#ffa348;fill-opacity:1;fill-rule:evenodd;stroke:#ffa348;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path3336-3" /> + </marker> + <marker + style="overflow:visible" + id="marker5285-1" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mstart" + inkscape:isstock="true"> + <path + transform="scale(0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5283-7" /> + </marker> + <marker + style="overflow:visible" + id="marker5161-4" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5159-3" /> + </marker> + <marker + style="overflow:visible" + id="marker5285-1-4" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mstart" + inkscape:isstock="true"> + <path + transform="scale(0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5283-7-6" /> + </marker> + <marker + style="overflow:visible" + id="marker5161-4-9" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mend" + inkscape:isstock="true"> + <path + transform="scale(-0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#000000;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path5159-3-4" /> + </marker> + <marker + style="overflow:visible" + id="marker4174-8" + refX="0" + refY="0" + orient="auto" + inkscape:stockid="Arrow2Mstart" + inkscape:isstock="true"> + <path + transform="scale(0.6)" + d="M 8.7185878,4.0337352 -2.2072895,0.01601326 8.7185884,-4.0017078 c -1.7454984,2.3720609 -1.7354408,5.6174519 -6e-7,8.035443 z" + style="fill:#62a0ea;fill-opacity:1;fill-rule:evenodd;stroke:#62a0ea;stroke-width:0.625;stroke-linejoin:round;stroke-opacity:1" + id="path4172-8" /> + </marker> + </defs> + <sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1920" + inkscape:window-height="1043" + id="namedview4" + showgrid="true" + inkscape:zoom="1.4472045" + inkscape:cx="987.76641" + inkscape:cy="357.93145" + inkscape:window-x="1728" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:current-layer="g10" + inkscape:document-rotation="0" + inkscape:snap-perpendicular="true" + fit-margin-top="30" + lock-margins="true" + fit-margin-left="30" + fit-margin-right="30" + fit-margin-bottom="30" + inkscape:pagecheckerboard="0"> + <inkscape:grid + type="xygrid" + id="grid1257" + originx="-289.99936" + originy="369.99998" /> + </sodipodi:namedview> + <g + inkscape:groupmode="layer" + inkscape:label="Image" + id="g10" + transform="translate(-289.99936,370.00003)"> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1080,220.00003 v -515.00007 0 0" + id="path207708" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1200,220.00003 v -515.00007 0 0" + id="path207708-4" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1320,220.00003 v -515.00007 0 0" + id="path207708-4-3" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1440,219.99998 v -515.00002 0 0" + id="path207708-4-3-6" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1560,219.99998 v -515.00001 0 0" + id="path207708-4-3-6-2" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1680,219.99998 v -515.00002 0 0" + id="path207708-4-3-6-2-8" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1800,219.99998 v -515.00002 0 0" + id="path207708-4-3-6-2-8-4" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1920,219.99998 v -515.00002 0 0" + id="path207708-4-3-6-2-8-4-3" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 2040,219.99997 v -460.00002 0 0" + id="path207708-4-3-6-2-8-4-3-8" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 2040,219.99998 v -515.00002 0 0" + id="path207708-4-3-6-2-8-4-3-8-0" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 2159.954,219.99997 v -514.99999 0 0" + id="path207708-4-3-6-2-8-4-3-8-4" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 2280,219.99997 v -514.99999 0 0" + id="path207708-4-3-6-2-8-4-3-8-4-0" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 960,220.00003 v -515.00007 0 0" + id="path207708-9" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 840,220.00001 v -375 0 0" + id="path207708-9-6" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 840,220.00002 v -515.00004 0 0" + id="path207708-9-6-2" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 720,220.00003 v -515.00007 0 0" + id="path207708-9-6-2-5" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 600,220.00003 v -515.00007 0 0" + id="path207708-9-6-2-5-9" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 480,220.00003 v -515.00007 0 0" + id="path207708-9-6-2-5-9-0" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 360,220.00003 v -515.00007 0 0" + id="path207708-9-6-2-5-9-0-5" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:42.5884px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="142.22464" + y="565.10297" + id="text907"><tspan + sodipodi:role="line" + id="tspan905" + x="142.22464" + y="565.10297" /></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:42.5884px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="98.363503" + y="637.8432" + id="text911"><tspan + sodipodi:role="line" + id="tspan909" + x="98.363503" + y="637.8432" /></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:42.5884px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="-59.575905" + y="580.05695" + id="text915"><tspan + sodipodi:role="line" + id="tspan913" + x="-59.575905" + y="580.05695" /></text> + <rect + style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0" + width="980" + height="45.000004" + x="360" + y="154.99997" + ry="2.2558987" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="420.52835" + y="174.12433" + id="text1185-3-55-4"><tspan + sodipodi:role="line" + x="420.52835" + y="174.12433" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8">Dunfell (LTS)</tspan><tspan + sodipodi:role="line" + x="420.52835" + y="192.121" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317">3.1</tspan></text> + <rect + style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4" + width="140.00002" + height="45.000004" + x="480" + y="99.999969" + ry="2.2558987" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="534.10651" + y="118.94971" + id="text1185-3-55-4-0"><tspan + sodipodi:role="line" + x="534.10651" + y="118.94971" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6">Gatesgarth</tspan><tspan + sodipodi:role="line" + x="534.10651" + y="136.94638" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2">3.2</tspan></text> + <rect + style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4-4" + width="260" + height="45.000004" + x="599.99994" + y="45.000011" + ry="2.2558987" /> + <rect + style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4-4-9" + width="160.00002" + height="45.000004" + x="720" + y="-9.9999905" + ry="2.2558987" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="766.10297" + y="9.57586" + id="text1185-3-55-4-0-0"><tspan + sodipodi:role="line" + x="766.10297" + y="9.57586" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6-3">Honister</tspan><tspan + sodipodi:role="line" + x="766.10297" + y="27.57254" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2-9">3.4</tspan></text> + <rect + style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4-4-9-4" + width="160.00002" + height="45.000004" + x="959.99994" + y="-120" + ry="2.2558987" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1008.4941" + y="-100.605" + id="text1185-3-55-4-0-0-0"><tspan + sodipodi:role="line" + x="1008.4941" + y="-100.605" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6-3-9">Langdale</tspan><tspan + sodipodi:role="line" + x="1008.4941" + y="-82.608322" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2-9-1">4.1</tspan></text> + <rect + style="opacity:1;fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4-4-9-4-5" + width="140.00003" + height="45.000004" + x="1100" + y="-175.00003" + ry="2.2558987" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1156.057" + y="-155.49881" + id="text1185-3-55-4-0-0-0-1"><tspan + sodipodi:role="line" + x="1156.057" + y="-155.49881" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6-3-9-7">Mickledore</tspan><tspan + sodipodi:role="line" + x="1156.057" + y="-137.50214" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2-9-1-4">4.2</tspan></text> + <g + id="g1258"> + <rect + style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4-4-9-4-5-38" + width="120.00002" + height="45.000004" + x="1220" + y="-230.00005" + ry="2.2558987" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1269.2329" + y="-210.32925" + id="text1185-3-55-4-0-0-0-1-1"><tspan + sodipodi:role="line" + x="1269.2329" + y="-210.32925" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6-3-9-7-4">Nanbield</tspan><tspan + sodipodi:role="line" + x="1269.2329" + y="-192.33258" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2-9-1-4-6">4.3</tspan></text> + </g> + <rect + style="opacity:0.75;fill:#241f31;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4-4-9-4-5-3-9-2" + width="140" + height="45.000004" + x="1440" + y="-340.00003" + ry="2.2558987" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1487.233" + y="-320.32928" + id="text1185-3-55-4-0-0-0-1-1-6-4"><tspan + sodipodi:role="line" + x="1487.233" + y="-320.32928" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6-3-9-7-4-2-0">Styhead</tspan><tspan + sodipodi:role="line" + x="1487.233" + y="-302.33261" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2-9-1-4-6-5-6">5.1</tspan></text> + <g + id="g1591"> + <rect + style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4-4-9-9" + width="960.00012" + height="45.000004" + x="859.99994" + y="-64.999992" + ry="2.2558987" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="928.49872" + y="-45.648258" + id="text1185-3-55-4-0-0-9"><tspan + sodipodi:role="line" + x="928.49872" + y="-45.648258" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6-3-6">Kirkstone (LTS)</tspan><tspan + sodipodi:role="line" + x="928.49872" + y="-27.651579" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2-9-0">4.0</tspan></text> + </g> + <path + id="rect917-0-0-4-4-9-9-9" + style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + d="m 1322.3015,-285.00003 c -1.2753,0 -2.302,1.00609 -2.302,2.25586 v 40.48828 c 0,1.24977 1.0267,2.25586 2.302,2.25586 h 975.0412 c 1.2754,0 2.302,-1.00609 2.302,-2.25586 v -40.48828 c 0,-1.24977 -1.0266,-2.25586 -2.302,-2.25586 z" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1390.4988" + y="-265.64832" + id="text1185-3-55-4-0-0-9-0"><tspan + sodipodi:role="line" + x="1390.4988" + y="-265.64832" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6-3-6-8">Scarthgap (LTS)</tspan><tspan + sodipodi:role="line" + x="1390.4988" + y="-247.65164" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2-9-0-1">5.0</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="653.72168" + y="64.866302" + id="text1185-3-55-4-0-0-7"><tspan + sodipodi:role="line" + x="653.72168" + y="64.866302" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6-3-2">Hardknott </tspan><tspan + sodipodi:role="line" + x="653.72168" + y="82.862984" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2-9-8">3.3</tspan></text> + <g + id="g1125-0" + transform="matrix(0.42240595,0,0,0.41654472,354.53445,-399.96314)" + style="stroke:none;stroke-width:2.38399"> + <rect + style="opacity:1;fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:4.76797;stroke-opacity:1" + id="rect1061-9" + width="452.00439" + height="192.0562" + x="11.609296" + y="276.44562" + ry="4.0176301" /> + <g + id="g1109-1" + transform="translate(-2.7615661,-1.7576335)" + style="stroke:none;stroke-width:2.38399"> + <path + id="path14-9" + class="st0" + d="m 439.74452,358.11274 c 0,4.22 -3.41,7.64 -7.64,7.64 -4.22,0 -7.63,-3.42 -7.63,-7.64 0,-4.22 3.41,-7.64 7.63,-7.64 4.23,0 7.64,3.42 7.64,7.64 v 0" + style="fill:#4a97d2;fill-opacity:1;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path16-6" + class="st1" + d="m 114.56452,324.94274 -11.13,-6.3 -22.409996,45.41 -23.9,-45.41 -11.27,6.3 28.41,53.38 c -0.21,0.51 -0.86,1.9 -1.95,4.22 -1.11,2.21 -2.25,4.41 -3.46,6.62 -2.11,3.81 -4.26,6.91 -6.46,9.32 -2.21,2.51 -4.46,4.51 -6.78,6.02 -2.3,1.51 -4.7,2.65 -7.21,3.46 -2.41,0.8 -4.87,1.45 -7.38,1.95 l 5.12,10.68 c 1.6,-0.21 3.75,-0.71 6.46,-1.51 2.81,-0.7 5.86,-2.06 9.17,-4.06 3.3,-2 6.67,-4.86 10.07,-8.57 3.52,-3.71 6.78,-8.62 9.78,-14.73 l 32.939996,-66.78" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path18-2" + class="st1" + d="m 175.39452,358.18274 c 0,3.51 -0.6,6.76 -1.81,9.78 -1.21,3 -2.86,5.62 -4.95,7.81 -2.01,2.11 -4.41,3.81 -7.22,5.12 -2.71,1.19 -5.67,1.8 -8.87,1.8 -3.21,0 -6.22,-0.6 -9.02,-1.8 -2.81,-1.31 -5.27,-3.01 -7.38,-5.12 -2,-2.19 -3.6,-4.81 -4.81,-7.81 -1.21,-3.01 -1.81,-6.27 -1.81,-9.78 0,-3.51 0.6,-6.76 1.81,-9.77 1.21,-3 2.81,-5.61 4.81,-7.82 2.11,-2.21 4.57,-3.92 7.38,-5.11 2.8,-1.32 5.81,-1.97 9.02,-1.97 3.21,0 6.16,0.65 8.87,1.97 2.81,1.19 5.21,2.9 7.22,5.11 2.1,2.21 3.75,4.81 4.95,7.82 1.2,3.01 1.81,6.26 1.81,9.77 m 13.98,0 c 0,-5.21 -0.95,-10.08 -2.86,-14.59 -1.81,-4.51 -4.36,-8.42 -7.67,-11.73 -3.32,-3.3 -7.22,-5.86 -11.73,-7.67 -4.51,-1.9 -9.38,-2.86 -14.59,-2.86 -5.21,0 -10.08,0.95 -14.59,2.86 -4.51,1.81 -8.43,4.36 -11.73,7.67 -3.3,3.31 -5.92,7.22 -7.82,11.73 -1.9,4.51 -2.86,9.38 -2.86,14.59 0,5.21 0.95,10.08 2.86,14.59 1.9,4.41 4.52,8.27 7.82,11.57 3.3,3.32 7.22,5.92 11.73,7.82 4.51,1.81 9.38,2.71 14.59,2.71 5.21,0 10.08,-0.9 14.59,-2.71 4.51,-1.91 8.41,-4.51 11.73,-7.82 3.3,-3.3 5.86,-7.16 7.67,-11.57 1.91,-4.51 2.86,-9.38 2.86,-14.59" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path20-5" + class="st1" + d="m 373.22452,358.18274 c 0,3.51 -0.6,6.76 -1.81,9.78 -1.21,3 -2.86,5.62 -4.97,7.81 -2,2.11 -4.4,3.81 -7.21,5.12 -2.71,1.19 -5.67,1.8 -8.87,1.8 -3.21,0 -6.22,-0.6 -9.03,-1.8 -2.8,-1.31 -5.26,-3.01 -7.37,-5.12 -2,-2.19 -3.61,-4.81 -4.81,-7.81 -1.21,-3.01 -1.81,-6.27 -1.81,-9.78 0,-3.51 0.6,-6.76 1.81,-9.77 1.21,-3 2.81,-5.61 4.81,-7.82 2.11,-2.21 4.57,-3.92 7.37,-5.11 2.81,-1.32 5.82,-1.97 9.03,-1.97 3.21,0 6.16,0.65 8.87,1.97 2.81,1.19 5.21,2.9 7.21,5.11 2.11,2.21 3.76,4.81 4.97,7.82 1.21,3.01 1.81,6.26 1.81,9.77 m 13.98,0 c 0,-5.21 -0.95,-10.08 -2.86,-14.59 -1.81,-4.51 -4.36,-8.42 -7.67,-11.73 -3.32,-3.3 -7.22,-5.86 -11.73,-7.67 -4.51,-1.9 -9.38,-2.86 -14.59,-2.86 -5.22,0 -10.08,0.95 -14.59,2.86 -4.51,1.81 -8.43,4.36 -11.73,7.67 -3.3,3.31 -5.92,7.22 -7.82,11.73 -1.9,4.51 -2.86,9.38 -2.86,14.59 0,5.21 0.95,10.08 2.86,14.59 1.9,4.41 4.52,8.27 7.82,11.57 3.3,3.32 7.22,5.92 11.73,7.82 4.51,1.81 9.37,2.71 14.59,2.71 5.21,0 10.08,-0.9 14.59,-2.71 4.51,-1.91 8.41,-4.51 11.73,-7.82 3.3,-3.3 5.86,-7.16 7.67,-11.57 1.91,-4.51 2.86,-9.38 2.86,-14.59" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path22-4" + class="st1" + d="m 288.05452,298.59274 -13.39,7.52 v 16.45 h -36.21 c -26.15,0 -41.9,12.74 -41.9,35.95 0,36.04 37.55,42.84 64.25,29.96 l -5.63,-10.92 c -21.13,9.23 -44.53,5.3 -44.53,-19.28 0,-15.86 8.26,-24.54 27.49,-24.54 h 36.54 v 43.82 c 0,19.37 22.19,19.81 35.95,11.86 l -5.29,-10.45 c -8.85,4.48 -17.26,5.06 -17.26,-3.53 v -41.7 h 18.32 v -11.17 h -18.32 l -0.02,-23.97 v 0" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path24-4" + class="st1" + d="m 136.79452,428.30274 h 3.35 c 1.69,-0.01 3.34,1.19 3.34,2.9 0,2.87 -3.23,3.3 -3.23,3.3 l -3.46,0.02 z m -4.84,-4.1 v 25.3 h 4.83 l 0.06,-10.67 c 8.62,0.54 11.84,-2.46 11.84,-7.75 0,-4.75 -4.26,-6.88 -8.34,-6.88 h -8.39 v 0" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path26-9" + class="st1" + d="m 224.38452,436.87274 c 0,1.23 -0.23,2.39 -0.69,3.46 -0.42,1.04 -1.02,1.95 -1.81,2.74 -0.78,0.78 -1.7,1.4 -2.75,1.86 -1.04,0.42 -2.17,0.64 -3.38,0.64 -1.22,0 -2.35,-0.22 -3.39,-0.64 -1.05,-0.46 -1.96,-1.07 -2.75,-1.86 -0.76,-0.78 -1.36,-1.7 -1.81,-2.74 -0.46,-1.07 -0.69,-2.23 -0.69,-3.46 0,-1.23 0.23,-2.37 0.69,-3.42 0.45,-1.06 1.05,-1.99 1.81,-2.77 0.78,-0.78 1.7,-1.39 2.75,-1.82 1.04,-0.45 2.17,-0.67 3.39,-0.67 1.21,0 2.34,0.23 3.38,0.67 1.05,0.43 1.96,1.04 2.75,1.82 0.78,0.78 1.39,1.71 1.81,2.77 0.46,1.05 0.69,2.19 0.69,3.42 m 4.9,0 c 0,-1.81 -0.35,-3.5 -1.06,-5.06 -0.69,-1.59 -1.65,-2.97 -2.89,-4.12 -1.21,-1.17 -2.64,-2.09 -4.3,-2.75 -1.64,-0.69 -3.41,-1.04 -5.3,-1.04 -1.9,0 -3.69,0.35 -5.35,1.04 -1.64,0.66 -3.06,1.58 -4.27,2.75 -1.22,1.16 -2.17,2.53 -2.89,4.12 -0.69,1.57 -1.03,3.25 -1.03,5.06 0,1.83 0.34,3.53 1.03,5.1 0.72,1.57 1.68,2.94 2.89,4.12 1.21,1.17 2.63,2.09 4.27,2.75 1.66,0.66 3.45,1 5.35,1 1.89,0 3.67,-0.34 5.3,-1 1.66,-0.66 3.1,-1.58 4.3,-2.75 1.24,-1.18 2.21,-2.55 2.89,-4.12 0.71,-1.56 1.06,-3.26 1.06,-5.1" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path28-9" + class="st1" + d="m 249.02452,424.25274 v 19.18 c 0,0.77 -0.57,1.63 -1.51,1.65 l -1.51,0.06 0.08,4.7 1.41,0.02 c 4.73,0.07 6.36,-4.37 6.36,-6.45 v -19.13" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path30-3" + class="st1" + d="m 290.20452,424.19274 h -16.13 v 25.22 h 16.2 l -0.07,-4.06 h -11.28 v -6.58 h 9.44 v -4.06 h -9.44 v -6.38 h 11.21 l 0.07,-4.14" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path32-6" + class="st1" + d="m 327.39452,430.24274 c -8.26,-4.53 -16.39,-1.78 -16.39,6.52 0,6.69 6.43,11.84 17,6.31 l 1.53,4.13 c -10.15,5.58 -23.51,1.6 -23.51,-10.44 0,-10.91 11.85,-16.59 23.36,-10.61 l -1.99,4.09" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path34-0" + class="st1" + d="m 366.07452,424.19274 0.01,4.13 h -8.05 v 21.16 h -4.85 v -21.15 h -7.73 l 0.11,-4.13 h 20.51" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + <path + id="path36-5" + class="st1" + d="m 172.67452,428.30274 h 3.35 c 1.69,-0.01 3.34,1.19 3.34,2.9 0,2.87 -3.23,3.3 -3.23,3.3 l -3.46,0.02 z m -4.82,-4.1 v 25.3 h 4.82 v -10.89 h 3.2 l 5.59,10.89 h 5.5 l -6.67,-12.2 c 2.64,-1.18 4.01,-3.26 4.01,-6.22 0,-4.94 -4.33,-6.88 -9.09,-6.88 h -7.36 v 0" + style="fill:#ffffff;stroke:none;stroke-width:0.238399;stroke-opacity:1" /> + </g> + </g> + <text + xml:space="preserve" + style="font-weight:bold;font-size:42.5884px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="313.46567" + y="412.9321" + id="text3781"><tspan + sodipodi:role="line" + id="tspan3779" + x="313.46567" + y="412.9321" /></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1199.6055" + y="250.21216" + id="text1185-9-7-1-1"><tspan + sodipodi:role="line" + x="1199.6055" + y="250.21216" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345">Oct.</tspan><tspan + sodipodi:role="line" + x="1199.6055" + y="268.20883" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906">2023</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1439.3904" + y="249.86044" + id="text1185-9-7-1-1-89"><tspan + sodipodi:role="line" + x="1439.3904" + y="249.86044" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-7">Oct.</tspan><tspan + sodipodi:role="line" + x="1439.3904" + y="267.85712" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-76">2024</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1679.3094" + y="250.58356" + id="text1185-9-7-1-1-89-6"><tspan + sodipodi:role="line" + x="1679.3094" + y="250.58356" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-7-8">Oct.</tspan><tspan + sodipodi:role="line" + x="1679.3094" + y="268.58023" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-76-0">2025</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:6.66667px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="849.49744" + y="61.106953" + id="text1185-9-7-1-1-0"><tspan + sodipodi:role="line" + x="849.49744" + y="61.106953" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:6.66667px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:end;text-anchor:end;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan46212">Support for this version was extended to leave</tspan><tspan + sodipodi:role="line" + x="849.49744" + y="70.105324" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:6.66667px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:end;text-anchor:end;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan120364">users more time to adapt to override syntax</tspan><tspan + sodipodi:role="line" + x="849.49744" + y="79.103691" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:6.66667px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:end;text-anchor:end;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan123280">changes in the 3.4 release.</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="959.52008" + y="250.67822" + id="text1185-9-7-1-1-0-7"><tspan + sodipodi:role="line" + x="959.52008" + y="250.67822" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-42-7">Oct.</tspan><tspan + sodipodi:role="line" + x="959.52008" + y="268.6749" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-9-6">2022</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="719.13617" + y="250.21216" + id="text1185-9-7-1-1-2"><tspan + sodipodi:role="line" + x="719.13617" + y="250.21216" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-1">Oct.</tspan><tspan + sodipodi:role="line" + x="719.13617" + y="268.20883" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-5">2021</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="478.82367" + y="250.21216" + id="text1185-9-7-1-1-80"><tspan + sodipodi:role="line" + x="478.82367" + y="250.21216" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-5">Oct.</tspan><tspan + sodipodi:role="line" + x="478.82367" + y="268.20883" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-6">2020</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="361.81961" + y="250.07544" + id="text1185-9-7-1-1-8"><tspan + sodipodi:role="line" + x="361.81961" + y="250.07544" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-4">Apr.</tspan><tspan + sodipodi:role="line" + x="361.81961" + y="268.07211" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-7">2020</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="840.9248" + y="250.07544" + id="text1185-9-7-1-1-8-1"><tspan + sodipodi:role="line" + x="840.9248" + y="250.07544" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-4-0">Apr</tspan><tspan + sodipodi:role="line" + x="840.9248" + y="268.07211" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-7-3">2022</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1321.8608" + y="250.07544" + id="text1185-9-7-1-1-8-1-0"><tspan + sodipodi:role="line" + x="1321.8608" + y="250.07544" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-4-0-4">Apr.</tspan><tspan + sodipodi:role="line" + x="1321.8608" + y="268.07211" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-7-3-8">2024</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1561.8163" + y="249.66977" + id="text1185-9-7-1-1-8-1-0-4"><tspan + sodipodi:role="line" + x="1561.8163" + y="249.66977" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-4-0-4-81">Apr.</tspan><tspan + sodipodi:role="line" + x="1561.8163" + y="267.66644" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-7-3-8-2">2025</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1802.1477" + y="250.26334" + id="text1185-9-7-1-1-8-1-0-4-2"><tspan + sodipodi:role="line" + x="1802.1477" + y="250.26334" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-4-0-4-81-5">Apr.</tspan><tspan + sodipodi:role="line" + x="1802.1477" + y="268.26001" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-7-3-8-2-8">2026</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1081.4458" + y="250.07544" + id="text1185-9-7-1-1-8-1-0-2"><tspan + sodipodi:role="line" + x="1081.4458" + y="250.07544" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-4-0-4-8">Apr.</tspan><tspan + sodipodi:role="line" + x="1081.4458" + y="268.07211" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-7-3-8-3">2023</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="602.51526" + y="250.07544" + id="text1185-9-7-1-1-8-1-7"><tspan + sodipodi:role="line" + x="602.51526" + y="250.07544" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-4-0-5">Apr.</tspan><tspan + sodipodi:role="line" + x="602.51526" + y="268.07211" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-7-3-6">2021</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:42.5884px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:none;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="-16.290483" + y="345.7359" + id="text3116"><tspan + sodipodi:role="line" + id="tspan3114" + x="-16.290483" + y="345.7359" /></text> + <path + id="path29430" + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="M 319.99936,219.99912 H 2300 Z" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 360,219.99997 v 10.00004 0" + id="path29548" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 480,219.99996 v 10 0" + id="path29548-5" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 600,219.99992 v 10.00005 0" + id="path29548-5-1" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 720,220.00002 v 9.99999 0" + id="path29548-5-1-3" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 840,220.00002 v 9.99995 0" + id="path29548-5-1-3-6" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 960,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1080,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3-1" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 380,219.99997 v 5.00004 0" + id="path29548-8" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 400,219.99997 v 5.00004 0" + id="path29548-8-5" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.999997;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 420,219.99997 v 5 0" + id="path29548-8-5-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282155" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.999997;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 440,219.99997 v 5 0" + id="path29548-8-5-0-6" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282155" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 460,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 500,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.999997;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 520,219.99997 v 5 0" + id="path29548-8-5-0-6-4-6-2-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282155" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 540,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 560,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 580,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 620.266,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 640,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 660,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 679.61073,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 700,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 740,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 760,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 780.36587,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 800,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 820,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 860,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 880,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 899.72384,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 920,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 940,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 980,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1000,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1020,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1040,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1059.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1100,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1120,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1140,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1160,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1179.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1320,219.99996 v 10 0" + id="path29548-5-1-3-6-3-1-0-8" /> + <g + id="g1267"> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1200,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1220,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0-5" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1240,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7-5" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1260,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5-2" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1280,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1299.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7-0" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + </g> + <g + id="g1267-4" + transform="translate(240,-4e-5)"> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1200,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0-3" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1220,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0-5-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1240,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7-5-3" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1260,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5-2-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1280,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8-9-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1299.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7-0-2" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + </g> + <g + id="g1267-4-5" + transform="translate(480,-5e-5)"> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1200,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0-3-4" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1220,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0-5-0-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1240,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7-5-3-5" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1260,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5-2-0-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1280,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8-9-9-4" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1299.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7-0-2-6" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + </g> + <g + id="g1267-4-5-22" + transform="translate(600,-4e-5)"> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1200,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0-3-4-0" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1220,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0-5-0-0-55" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1240,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7-5-3-5-2" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1260,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5-2-0-9-90" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1280,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8-9-9-4-2" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1299.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7-0-2-6-8" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + </g> + <g + id="g1267-4-5-9" + transform="translate(360,-4e-5)"> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1200,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0-3-4-2" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1220,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0-5-0-0-2" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1240,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7-5-3-5-4" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1260,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5-2-0-9-7" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1280,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8-9-9-4-7" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1299.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7-0-2-6-5" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + </g> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1800,219.99997 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0-3-4-2-0" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1340,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0-5-3" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1360,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7-5-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1380,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5-2-3" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1400,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8-9-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1419.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7-0-9" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="1919.3904" + y="249.86044" + id="text1185-9-7-1-1-89-62"><tspan + sodipodi:role="line" + x="1919.3904" + y="249.86044" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-7-6">Oct.</tspan><tspan + sodipodi:role="line" + x="1919.3904" + y="267.85712" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-76-7">2026</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="2159.3093" + y="250.58356" + id="text1185-9-7-1-1-89-6-5"><tspan + sodipodi:role="line" + x="2159.3093" + y="250.58356" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-7-8-6">Oct.</tspan><tspan + sodipodi:role="line" + x="2159.3093" + y="268.58023" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-76-0-9">2027</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="2041.8163" + y="249.66977" + id="text1185-9-7-1-1-8-1-0-4-8"><tspan + sodipodi:role="line" + x="2041.8163" + y="249.66977" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-4-0-4-81-7">Apr.</tspan><tspan + sodipodi:role="line" + x="2041.8163" + y="267.66644" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-7-3-8-2-2">2027</tspan></text> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="2282.1477" + y="250.26334" + id="text1185-9-7-1-1-8-1-0-4-2-8"><tspan + sodipodi:role="line" + x="2282.1477" + y="250.26334" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan31345-4-0-4-81-5-2">Apr.</tspan><tspan + sodipodi:role="line" + x="2282.1477" + y="268.26001" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans, Bold';font-variant-ligatures:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-east-asian:normal;text-align:center;text-anchor:middle;stroke:none" + id="tspan49906-7-3-8-2-8-9">2028</tspan></text> + <g + id="g1267-4-9" + transform="translate(720,-3e-5)"> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1200,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0-3-6" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1220,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0-5-0-02" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1240,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7-5-3-7" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1260,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5-2-0-6" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1280,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8-9-9-1" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1299.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7-0-2-3" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + </g> + <g + id="g1267-4-5-2" + transform="translate(960,-4e-5)"> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1200,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0-3-4-1" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1220,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0-5-0-0-5" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1240,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7-5-3-5-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1260,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5-2-0-9-9" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1280,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8-9-9-4-1" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1299.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7-0-2-6-4" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + </g> + <g + id="g1267-4-5-9-9" + transform="translate(840,-3e-5)"> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1200,220.00002 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0-3-4-2-1" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1220,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-0-5-0-0-2-0" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1240,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-7-5-3-5-4-7" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1260,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-5-2-0-9-7-5" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1280,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-8-9-9-4-7-8" + inkscape:transform-center-x="14.782001" + inkscape:transform-center-y="-0.085282837" /> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:1;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 1299.7216,219.99997 v 5.00004 0" + id="path29548-8-5-0-6-4-6-2-9-0-8-1-3-1-9-6-9-3-4-0-4-6-2-2-7-6-1-9-9-1-4-9-7-0-2-6-5-7" + inkscape:transform-center-x="-14.78205" + inkscape:transform-center-y="-0.085282837" /> + </g> + <path + style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:2;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + d="m 2280,219.99998 v 9.99999 0" + id="path29548-5-1-3-6-3-1-0-3-4-2-0-0" /> + </g> + <style + type="text/css" + id="style1021"> .st0{fill:#4A97D2;} .st1{fill:#333333;} </style> +</svg> diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst new file mode 100644 index 0000000000..0fc92550a5 --- /dev/null +++ b/documentation/ref-manual/system-requirements.rst @@ -0,0 +1,425 @@ +.. 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. + +Minimum Free Disk Space +======================= + +To build an image such as ``core-image-sato`` for the ``qemux86-64`` machine, +you need a system with at least &MIN_DISK_SPACE; Gbytes of free disk space. +However, much more disk space will be necessary to build more complex images, +to run multiple builds and to cache build artifacts, improving build efficiency. + +If you have a shortage of disk space, see the ":doc:`/dev-manual/disk-space`" +section of the Development Tasks Manual. + +.. _system-requirements-minimum-ram: + +Minimum System RAM +================== + +You will manage to build an image such as ``core-image-sato`` for the +``qemux86-64`` machine with as little as &MIN_RAM; Gbytes of RAM on an old +system with 4 CPU cores, but your builds will be much faster on a system with +as much RAM and as many CPU cores as possible. + +.. _system-requirements-supported-distros: + +Supported Linux Distributions +============================= + +Currently, the &DISTRO; release ("&DISTRO_NAME;") of the Yocto Project is +supported on the following distributions: + +- Ubuntu 20.04 (LTS) + +- Ubuntu 22.04 (LTS) + +- Fedora 38 + +- CentOS Stream 8 + +- Debian GNU/Linux 11 (Bullseye) + +- Debian GNU/Linux 12 (Bookworm) + +- OpenSUSE Leap 15.4 + +- AlmaLinux 8 + +- AlmaLinux 9 + +- Rocky 9 + +The following distribution versions are still tested, even though the +organizations publishing them no longer make updates publicly available: + +- Ubuntu 18.04 (LTS) + +- Ubuntu 23.04 + +Note that the Yocto Project doesn't have access to private updates +that some of these versions may have. Therefore, our testing has +limited value if you have access to such updates. + +Finally, here are the distribution versions which were previously +tested on former revisions of "&DISTRO_NAME;", but no longer are: + +*This list is currently empty* + +.. note:: + + - While the Yocto Project Team attempts to ensure all Yocto Project + releases are one hundred percent compatible with each officially + supported Linux distribution, you may still encounter problems + that happen only with 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 above. + + - If your Linux distribution is not in the above list, we recommend to + get the :term:`buildtools` or :term:`buildtools-extended` tarballs + containing the host tools required by your Yocto Project release, + typically by running ``scripts/install-buildtools`` as explained in + the ":ref:`system-requirements-buildtools`" section. + + - You may use Windows Subsystem For Linux v2 to set up a build host + using Windows 10 or later, or Windows Server 2019 or later, but validation + is not performed against build hosts using WSL 2. + + See the + :ref:`dev-manual/start:setting up to use windows subsystem for linux (wsl 2)` + section in the Yocto Project Development Tasks Manual for more information. + + - 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 </Bugzilla_Configuration_and_Bug_Tracking>` + and the ":doc:`../contributor-guide/report-defect`" + section in the Yocto Project and OpenEmbedded Contributor Guide. + +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 +----------------- + +Here are the packages needed to build an image on a headless system +with a supported Ubuntu or Debian Linux distribution:: + + $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; + +.. 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, try either of these solutions:: + + $ sudo apt build-dep qemu + $ sudo apt remove oss4-dev + +Here are the packages needed to build Project documentation manuals:: + + $ sudo apt install git make inkscape texlive-latex-extra + $ sudo apt install sphinx python3-saneyaml python3-sphinx-rtd-theme + +Fedora Packages +--------------- + +Here are the packages needed to build an image on a headless system +with a supported Fedora Linux distribution:: + + $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; + +Here are the packages needed to build Project documentation manuals:: + + $ sudo dnf install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; + +openSUSE Packages +----------------- + +Here are the packages needed to build an image on a headless system +with a supported openSUSE distribution:: + + $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; + +Here are the packages needed to build Project documentation manuals:: + + $ sudo zypper install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; + + +AlmaLinux Packages +------------------ + +Here are the packages needed to build an image on a headless system +with a supported AlmaLinux distribution:: + + $ sudo dnf install &ALMALINUX_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/CRB`` repo provides additional packages such as + ``rpcgen`` and ``texinfo``. + + - The ``makecache`` command consumes additional Metadata from + ``epel-release``. + +Here are the packages needed to build Project documentation manuals:: + + $ sudo dnf install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; + +.. _system-requirements-buildtools: + +Required Git, tar, Python, make 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 &MIN_GIT_VERSION; or greater + +- tar &MIN_TAR_VERSION; or greater + +- Python &MIN_PYTHON_VERSION; or greater + +- GNU make &MIN_MAKE_VERSION; or greater + +If your host development system does not meet all these requirements, +you can resolve this by installing a :term:`buildtools` tarball that +contains these tools. You can either download a pre-built tarball or +use BitBake to build one. + +In addition, your host development system must meet the following +version requirement for gcc: + +- gcc &MIN_GCC_VERSION; or greater + +If your host development system does not meet this requirement, you can +resolve this by installing a :term:`buildtools-extended` tarball that +contains additional tools, the equivalent of the Debian/Ubuntu ``build-essential`` +package. + +For systems with a broken make version (e.g. make 4.2.1 without patches) but +where the rest of the host tools are usable, you can use the :term:`buildtools-make` +tarball instead. + +In the sections that follow, three different methods will be described for +installing the :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make` +toolset. + +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 :term:`buildtools` +installer and automatically installs the tools for you: + +#. 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 :term:`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 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 :term:`buildtools-extended` tarball, you can instead execute the + ``install-buildtools`` script with the default parameters:: + + $ cd poky + $ scripts/install-buildtools + + Alternatively if your host development system has a broken ``make`` + version such that you only need a known good version of ``make``, + you can use the ``--make-only`` option:: + + $ cd poky + $ scripts/install-buildtools --make-only + +#. Source the tools environment setup script by using a command like the + following:: + + $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux + + 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 + :term:`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 +---------------------------------------------- + +If you would prefer not to use the ``install-buildtools`` script, you can instead +download and run a pre-built :term:`buildtools` installer yourself with the following +steps: + +#. Go to :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/`, locate and + download the ``.sh`` file corresponding to your host architecture + and to :term:`buildtools`, :term:`buildtools-extended` or :term:`buildtools-make`. + +#. 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 + + An example for the make-only installer:: + + $ sh ~/Downloads/x86_64-buildtools-make-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`` + +#. As instructed by the installer script, you will have to source the tools + environment setup script:: + + $ source /home/your_username/buildtools/environment-setup-x86_64-pokysdk-linux + + 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 + :term:`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 :term:`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 :term:`buildtools` +installer: + +#. 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`). + +#. Run the BitBake command to build the tarball:: + + $ bitbake buildtools-tarball + + or to build the extended tarball:: + + $ bitbake buildtools-extended-tarball + + or to build the make-only tarball:: + + $ bitbake buildtools-make-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. + +#. Transfer the ``.sh`` file from the build host to the machine that + does not meet the Git, tar, or Python (or gcc) requirements. + +#. On this machine, 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 + + For the extended installer:: + + $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh + + And for the make-only installer:: + + $ sh ~/Downloads/x86_64-buildtools-make-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`` + +#. Source the tools environment setup script by using a command like the + following:: + + $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux + + 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 + :term:`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..2e4b23408d --- /dev/null +++ b/documentation/ref-manual/tasks.rst @@ -0,0 +1,813 @@ +.. 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:`bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and +":ref:`bitbake-user-manual/bitbake-user-manual-execution: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 :ref:`ref-tasks-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 :term:`CLEANBROKEN` variable is set to "1", the +:ref:`ref-tasks-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:`ref-classes-deploy` class and should write the output +to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be +confused with ``${DEPLOY_DIR}``. The :ref:`ref-classes-deploy` class sets up +:ref:`ref-tasks-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 :ref:`ref-tasks-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 :ref:`ref-tasks-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 :ref:`ref-classes-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 :ref:`ref-tasks-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 <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` +module. + +.. _ref-tasks-image: + +``do_image`` +------------ + +Starts the image generation process. The :ref:`ref-tasks-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 :ref:`ref-tasks-image` task performs pre-processing on the image through the +:term:`IMAGE_PREPROCESS_COMMAND` and +dynamically generates supporting :ref:`do_image_* <ref-tasks-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 :ref:`do_image_complete <ref-tasks-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 :ref:`do_image_* <ref-tasks-image>` +tasks the image is constructed. + +The :ref:`do_image_complete <ref-tasks-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 :ref:`ref-tasks-install` task, as well as other tasks +that either directly or indirectly depend on the installed files (e.g. +:ref:`ref-tasks-package`, :ref:`do_package_write_* <ref-tasks-package_write_deb>`, and +:ref:`ref-tasks-rootfs`), run under +:ref:`fakeroot <overview-manual/concepts:fakeroot and pseudo>`. + +.. 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-recipe`` + subdirectory 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 :ref:`ref-tasks-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:`ref-classes-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-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 </poky/tree/meta/recipes-connectivity/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 :term:`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 :term:`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 :term:`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 file whose file type is ``.patch`` or ``.diff`` +and you want to exclude it so that the :ref:`ref-tasks-patch` task does not apply +it during the patch phase, you can use the "apply=no" parameter with the +:term:`SRC_URI` statement:: + + SRC_URI = " \ + git://path_to_repo/some_package \ + file://file1.patch \ + file://file2.patch;apply=no \ + " + +In the previous example ``file1.patch`` would be applied as a patch by default +while ``file2.patch`` would not be applied. + +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/new-recipe: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* <STAGING_DIR_HOST>` 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* <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 :ref:`ref-tasks-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:`ref-classes-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:`ref-classes-rm-work`" 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 :term:`WORKDIR` and :term:`S` variable descriptions. + +Manually Called Tasks +===================== + +These tasks are typically manually triggered (e.g. by using the +``bitbake -c`` command-line option): + +``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. :ref:`ref-tasks-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 <overview-manual/concepts:shared state cache>` 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 <overview-manual/concepts:shared state cache>`) cache, and +downloaded source files for a target (i.e. the contents of +:term:`DL_DIR`). Essentially, the :ref:`ref-tasks-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 + +You should never use the :ref:`ref-tasks-cleanall` task in a normal +scenario. If you want to start fresh with the :ref:`ref-tasks-fetch` task, +use instead:: + + $ bitbake -f -c fetch recipe + +.. note:: + + The reason to prefer ``bitbake -f -c fetch`` is that the + :ref:`ref-tasks-cleanall` task would break in some cases, such as:: + + $ bitbake -c fetch recipe + $ bitbake -c cleanall recipe-native + $ bitbake -c unpack recipe + + because after step 1 there is a stamp file for the + :ref:`ref-tasks-fetch` task of ``recipe``, and it won't be removed at + step 2 because step 2 uses a different work directory. So the unpack task + at step 3 will try to extract the downloaded archive and fail as it has + been deleted in step 2. + + Note that this also applies to BitBake from concurrent processes when a + shared download directory (:term:`DL_DIR`) is setup. + +.. _ref-tasks-cleansstate: + +``do_cleansstate`` +------------------ + +Removes all output files and shared state +(:ref:`sstate <overview-manual/concepts:shared state cache>`) cache for a +target. Essentially, the :ref:`ref-tasks-cleansstate` task is identical to the +:ref:`ref-tasks-clean` task with the added removal of +shared state (:ref:`sstate <overview-manual/concepts:shared state cache>`) +cache. + +You can run this task using BitBake as follows:: + + $ bitbake -c cleansstate recipe + +When you run the :ref:`ref-tasks-cleansstate` task, the OpenEmbedded build system +no longer uses any sstate. Consequently, building the recipe from +scratch is guaranteed. + +.. note:: + + Using :ref:`ref-tasks-cleansstate` with a shared :term:`SSTATE_DIR` is + not recommended because it could trigger an error during the build of a + separate BitBake instance. This is because the builds check sstate "up + front" but download the files later, so it if is deleted in the + meantime, it will cause an error but not a total failure as it will + rebuild it. + + The reliable and preferred way to force a new build is to use ``bitbake + -f`` instead. + +.. note:: + + The :ref:`ref-tasks-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-pydevshell: + +``do_pydevshell`` +----------------- + +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/python-development-shell:using a Python development shell`" section in +the Yocto Project Development Tasks Manual for more information about +using ``pydevshell``. + +.. _ref-tasks-devshell: + +``do_devshell`` +--------------- + +Starts a shell whose environment is set up for development, debugging, +or both. See the ":ref:`dev-manual/development-shell: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 :term:`Initramfs` image and kernel together to +form a single image. + +.. _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/runtime-testing: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/runtime-testing: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 :ref:`ref-tasks-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 +:ref:`ref-tasks-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 :ref:`ref-tasks-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 :ref:`ref-tasks-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. Otherwise, if :term:`AUTOREV` is not being used, the +:ref:`ref-tasks-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..b18c4183b6 --- /dev/null +++ b/documentation/ref-manual/terms.rst @@ -0,0 +1,537 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +******************* +Yocto Project Terms +******************* + +Here 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/layers:appending other layers metadata with 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 <bitbake:index>`. + + :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 :term:`Build Directory`. + + You have a lot of flexibility when creating the :term:`Build Directory`. + Here are some examples that show how to create the directory. The + examples assume your :term:`Source Directory` is named ``poky``: + + - Create the :term:`Build Directory` inside your Source Directory and let + the name of the :term:`Build Directory` default to ``build``: + + .. code-block:: shell + + $ cd poky + $ source oe-init-build-env + + - Create the :term:`Build Directory` inside your home directory and + specifically name it ``test-builds``: + + .. code-block:: shell + + $ source poky/oe-init-build-env test-builds + + - Provide a directory path and specifically name the + :term:`Build Directory`. Any intermediate folders in the pathname + must exist. This next example creates a :term:`Build Directory` + named ``YP-&DISTRO;`` within the existing directory ``mybuilds``: + + .. code-block:: shell + + $ source poky/oe-init-build-env mybuilds/YP-&DISTRO; + + .. note:: + + By default, the :term:`Build Directory` contains :term:`TMPDIR`, which is a + temporary directory the build system uses for its work. :term:`TMPDIR` cannot + be under NFS. Thus, by default, the :term:`Build Directory` cannot be under + NFS. However, if you need the :term:`Build Directory` to be under NFS, you can + set this up by setting :term:`TMPDIR` in your ``local.conf`` file to use a local + drive. Doing so effectively separates :term:`TMPDIR` from :term:`TOPDIR`, which is the + :term:`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:`buildtools` + Build tools in binary form, providing required versions of development + tools (such as Git, GCC, Python and make), to run the OpenEmbedded build + system on a development host without such minimum versions. + + See the ":ref:`system-requirements-buildtools`" paragraph in the + Reference Manual for details about downloading or building an archive + of such tools. + + :term:`buildtools-extended` + A set of :term:`buildtools` binaries extended with additional development + tools, such as a required version of the GCC compiler to run the + OpenEmbedded build system. + + See the ":ref:`system-requirements-buildtools`" paragraph in the + Reference Manual for details about downloading or building an archive + of such tools. + + :term:`buildtools-make` + A variant of :term:`buildtools`, just providing the required + version of ``make`` to run the OpenEmbedded build system. + + :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` + A flexible definition that typically refers to a single Git checkout + which contains multiple (and typically related) sub-layers which can + be included independently in your project's ``bblayers.conf`` file. + + In some cases, such as with OpenEmbedded's :oe_git:`meta-openembedded </meta-openembedded>` + layer, the top level ``meta-openembedded/`` directory is not itself an actual layer, + so you would never explicitly include it in a ``bblayers.conf`` file; + rather, you would include any number of its layer subdirectories, such as + :oe_git:`meta-oe </meta-openembedded/tree/meta-oe>`, :oe_git:`meta-python + </meta-openembedded/tree/meta-python>` and so on. + + On the other hand, some container layers (such as + :yocto_git:`meta-security </meta-security>`) + have a top-level directory that is itself an actual layer, as well as + a variety of sub-layers, both of which could be included in your + ``bblayers.conf`` file. + + In either case, the phrase "container layer" is simply used to describe + a directory structure which contains multiple valid OpenEmbedded 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:`Initramfs` + An Initial RAM Filesystem (:term:`Initramfs`) is an optionally compressed + :wikipedia:`cpio <Cpio>` archive which is extracted + by the Linux kernel into RAM in a special :wikipedia:`tmpfs <Tmpfs>` + instance, used as the initial root filesystem. + + This is a replacement for the legacy init RAM disk ("initrd") + technique, booting on an emulated block device in RAM, but being less + efficient because of the overhead of going through a filesystem and + having to duplicate accessed file contents in the file cache in RAM, + as for any block device. + + .. note:: + + As far as bootloaders are concerned, :term:`Initramfs` and "initrd" + images are still copied to RAM in the same way. That's why most + most bootloaders refer to :term:`Initramfs` images as "initrd" + or "init RAM disk". + + This kind of mechanism is typically used for two reasons: + + - For booting the same kernel binary on multiple systems requiring + different device drivers. The :term:`Initramfs` image is then customized + for each type of system, to include the specific kernel modules + necessary to access the final root filesystem. This technique + is used on all GNU / Linux distributions for desktops and servers. + + - For booting faster. As the root filesystem is extracted into RAM, + accessing the first user-space applications is very fast, compared + to having to initialize a block device, to access multiple blocks + from it, and to go through a filesystem having its own overhead. + For example, this allows to display a splashscreen very early, + and to later take care of mounting the final root filesystem and + loading less time-critical kernel drivers. + + This cpio archive can either be loaded to RAM by the bootloader, + or be included in the kernel binary. + + For information on creating and using an :term:`Initramfs`, see the + ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" + section in the Yocto Project Development Tasks Manual. + + :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/layers: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:`LTS` + This term means "Long Term Support", and in the context of the Yocto + Project, it corresponds to selected stable releases for which bug and + security fixes are provided for at least four years. See + the :ref:`ref-long-term-support-releases` section for details. + + :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 </yocto-kernel-cache>` + Git repository. + + :term:`Mixin` + A :term:`Mixin` layer is a layer which can be created by the community to + add a specific feature or support a new version of some package for an + :term:`LTS` release. See the :ref:`ref-long-term-support-releases` + section for details. + + :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 </poky>`. + + :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<Board Support Package (BSP)>` as well as a + :term:`build host<Build Host>` and other components, that can + work on specific hardware. + + :term:`SBOM` + This term means *Software Bill of Materials*. When you distribute + software, it offers a description of all the components you used, + their corresponding licenses, their dependencies, the changes that were + applied and the known vulnerabilities that were fixed. + + This can be used by the recipients of the software to assess + their exposure to license compliance and security vulnerability issues. + + See the :wikipedia:`Software Supply Chain <Software_supply_chain>` + article on Wikipedia for more details. + + The OpenEmbedded Build System can generate such documentation for your + project, in :term:`SPDX` format, based on all the metadata it used to + build the software images. See the ":ref:`dev-manual/sbom:creating + a software bill of materials`" section of the Development Tasks manual. + + :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 extraction 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 poky tarballs from + :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/` + 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:`SPDX` + This term means *Software Package Data Exchange*, and is used as an open + standard for providing a *Software Bill of Materials* (:term:`SBOM`). + This standard is developed through a `Linux Foundation project + <https://spdx.dev/>`__ and is used by the OpenEmbedded Build System to + provide an :term:`SBOM` associated to each software image. + + For details, see Wikipedia's :wikipedia:`SPDX page <Software_Package_Data_Exchange>` + and the ":ref:`dev-manual/sbom:creating a software bill of materials`" + section of the Development Tasks manual. + + :term:`Sysroot` + When cross-compiling, the target file system may be differently laid + out and contain different things compared to the host system. The concept + of a *sysroot* is directory which looks like the target filesystem and + can be used to cross-compile against. + + In the context of cross-compiling toolchains, a *sysroot* + typically contains C library and kernel headers, plus the + compiled binaries for the C library. A *multilib toolchain* + can contain multiple variants of the C library binaries, + each compiled for a target instruction set (such as ``armv5``, + ``armv7`` and ``armv8``), and possibly optimized for a specific CPU core. + + In the more specific context of the OpenEmbedded build System and + of the Yocto Project, each recipe has two sysroots: + + - A *target sysroot* contains all the **target** libraries and headers + needed to build the recipe. + + - A *native sysroot* contains all the **host** files and executables + needed to build the recipe. + + See the :term:`SYSROOT_* <SYSROOT_DESTDIR>` variables controlling + how sysroots are created and stored. + + :term:`Task` + A per-recipe unit of execution for BitBake (e.g. + :ref:`ref-tasks-compile`, + :ref:`ref-tasks-fetch`, + :ref:`ref-tasks-patch`, and so forth). + One of the major benefits of the build system is that, since each + recipe will typically spawn the execution of numerous tasks, + it is entirely possible that many tasks can execute in parallel, + either tasks from separate recipes or independent tasks within + the same recipe, potentially up to the parallelism of your + build system. + + :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 remote 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..3f37f42f21 --- /dev/null +++ b/documentation/ref-manual/variables.rst @@ -0,0 +1,10083 @@ +.. 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 <ABIEXTENSION>` :term:`B` :term:`C <CACHE>` +:term:`D` :term:`E <EFI_PROVIDER>` :term:`F <FEATURE_PACKAGES>` +:term:`G <GCCPIE>` :term:`H <HOMEPAGE>` :term:`I <ICECC_DISABLED>` +:term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>` +:term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P` +:term:`R <RANLIB>` :term:`S` :term:`T` +:term:`U <UBOOT_CONFIG>` :term:`V <VOLATILE_LOG_DIR>` +:term:`W <WARN_QA>` :term:`X <XSERVER>` + +.. glossary:: + :sorted: + + :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 are also + provided by another package. For example, if the ``busybox`` package + has four such commands, you identify them as follows:: + + ALTERNATIVE:busybox = "sh sed test bracket" + + For more information on the alternatives system, see the + ":ref:`ref-classes-update-alternatives`" + 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 :term:`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 :term:`ALTERNATIVE_LINK_NAME` is not defined, it defaults to ``${bindir}/name``. + + For more information on the alternatives system, see the + ":ref:`ref-classes-update-alternatives`" + 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:`ref-classes-update-alternatives`" + 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 :term:`ALTERNATIVE_TARGET` is not defined, it inherits the value + from the :term:`ALTERNATIVE_LINK_NAME` variable. + + If :term:`ALTERNATIVE_LINK_NAME` and :term:`ALTERNATIVE_TARGET` are the + same, the target for :term:`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:`ref-classes-update-alternatives`" section. + + :term:`ANY_OF_DISTRO_FEATURES` + When inheriting the :ref:`ref-classes-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 :term:`ANY_OF_DISTRO_FEATURES` + appear in :term:`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:`ref-classes-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:`ref-classes-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, :term:`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:`AUTO_LIBNAME_PKGS` + When the :ref:`ref-classes-debian` class is inherited, + which is the default behavior, :term:`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 + :ref:`ref-classes-debian` class to act on all packages that are + explicitly generated by the recipe. + + :term:`AUTOREV` + When :term:`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:`ref-classes-kernel` class and you + use the previous statement. In this example, ``${SRCPV}`` does not + automatically get into :term:`PV`. Consequently, you need to change + :term:`PV` in your recipe so that it does contain ``${SRCPV}``. + + For more information see the + ":ref:`dev-manual/packages:automatically incrementing a package version number`" + section in the Yocto Project Development Tasks Manual. + + :term:`AUTO_SYSLINUXMENU` + Enables creating an automatic menu for the syslinux bootloader. You + must set this variable in your recipe. The + :ref:`ref-classes-syslinux` class checks this variable. + + :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 <dev-manual/libraries:combining multiple versions of library files into one image>` + 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:`bitbake-user-manual/bitbake-user-manual-metadata:basic syntax`" section in the BitBake + User Manual for more information. + + :term:`AZ_SAS` + Azure Storage Shared Access Signature, when using the + :ref:`Azure Storage fetcher (az://) <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` + This variable can be defined to be used by the fetcher to authenticate + and gain access to non-public artifacts:: + + AZ_SAS = ""se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>"" + + For more information see Microsoft's Azure Storage documentation at + https://docs.microsoft.com/en-us/azure/storage/common/storage-sas-overview + + :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 (:term:`S`) directory and the directory pointed to + by the :term:`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 :term:`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. + + This variable is supported only when using the IPK and RPM + packaging backends. DEB is not supported. + + 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 :term:`BASE_LIB` applies only in the Multilib + context. See the ":ref:`dev-manual/libraries:combining multiple versions of library files into one image`" + section in the Yocto Project Development Tasks Manual for information + on Multilib. + + The :term:`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. Here are + considerations surrounding this variable: + + - This host list is only used if :term:`BB_NO_NETWORK` is either not set + or set to "0". + + - There is limited support for wildcard matching against the beginning of + host names. 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 :term:`BB_ALLOWED_NETWORKS` in conjunction with + :term:`PREMIRRORS` is very useful. Adding the host + you want to use to :term:`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 :term:`SRC_URI` after a successful fetch from the + :term:`PREMIRRORS` occurs. + + :term:`BB_BASEHASH_IGNORE_VARS` + See :term:`bitbake:BB_BASEHASH_IGNORE_VARS` in the BitBake manual. + + :term:`BB_CACHEDIR` + See :term:`bitbake:BB_CACHEDIR` in the BitBake manual. + + :term:`BB_CHECK_SSL_CERTS` + See :term:`bitbake:BB_CHECK_SSL_CERTS` in the BitBake manual. + + :term:`BB_CONSOLELOG` + See :term:`bitbake:BB_CONSOLELOG` in the BitBake manual. + + :term:`BB_CURRENTTASK` + See :term:`bitbake:BB_CURRENTTASK` in the BitBake manual. + + :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_DEFAULT_TASK` + See :term:`bitbake:BB_DEFAULT_TASK` in the BitBake manual. + + :term:`BB_DEFAULT_UMASK` + See :term:`bitbake:BB_DEFAULT_UMASK` in the BitBake manual. + + :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 :term:`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 stop 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 stop 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 :term:`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 stops 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 :term:`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 :term:`BB_DISKMON_WARNINTERVAL` variable and you + do use :term:`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_ENV_PASSTHROUGH` + See :term:`bitbake:BB_ENV_PASSTHROUGH` in the BitBake manual. + + :term:`BB_ENV_PASSTHROUGH_ADDITIONS` + See :term:`bitbake:BB_ENV_PASSTHROUGH_ADDITIONS` in the BitBake manual. + + :term:`BB_FETCH_PREMIRRORONLY` + See :term:`bitbake:BB_FETCH_PREMIRRORONLY` in the BitBake manual. + + :term:`BB_FILENAME` + See :term:`bitbake:BB_FILENAME` in the BitBake manual. + + :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 :term:`DL_DIR` directory by deleting any Git or other + source control work directories. + + :term:`BB_GENERATE_SHALLOW_TARBALLS` + See :term:`bitbake:BB_GENERATE_SHALLOW_TARBALLS` in the BitBake manual. + + :term:`BB_GIT_SHALLOW` + See :term:`bitbake:BB_GIT_SHALLOW` in the BitBake manual. + + :term:`BB_GIT_SHALLOW_DEPTH` + See :term:`bitbake:BB_GIT_SHALLOW_DEPTH` in the BitBake manual. + + :term:`BB_HASHCHECK_FUNCTION` + See :term:`bitbake:BB_HASHCHECK_FUNCTION` in the BitBake manual. + + :term:`BB_HASHCONFIG_IGNORE_VARS` + See :term:`bitbake:BB_HASHCONFIG_IGNORE_VARS` in the BitBake manual. + + :term:`BB_HASHSERVE` + See :term:`bitbake:BB_HASHSERVE` in the BitBake manual. + + :term:`BB_HASHSERVE_UPSTREAM` + See :term:`bitbake:BB_HASHSERVE_UPSTREAM` in the BitBake manual. + + :term:`BB_INVALIDCONF` + See :term:`bitbake:BB_INVALIDCONF` in the BitBake manual. + + :term:`BB_LOADFACTOR_MAX` + The system load threshold above which BitBake will stop runnig extra + tasks. + + :term:`BB_LOGCONFIG` + See :term:`bitbake:BB_LOGCONFIG` in the BitBake manual. + + :term:`BB_LOGFMT` + See :term:`bitbake:BB_LOGFMT` in the BitBake manual. + + :term:`BB_MULTI_PROVIDER_ALLOWED` + See :term:`bitbake:BB_MULTI_PROVIDER_ALLOWED` in the BitBake manual. + + :term:`BB_NICE_LEVEL` + See :term:`bitbake:BB_NICE_LEVEL` in the BitBake manual. + + :term:`BB_NO_NETWORK` + See :term:`bitbake:BB_NO_NETWORK` in the BitBake manual. + + :term:`BB_NUMBER_PARSE_THREADS` + See :term:`bitbake:BB_NUMBER_PARSE_THREADS` in the BitBake manual. + + :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 :term:`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 :term:`BB_NUMBER_THREADS` variable + is not set higher than "20". + + For more information on speeding up builds, see the + ":ref:`dev-manual/speeding-up-build:speeding up a build`" + section in the Yocto Project Development Tasks Manual. + + On the other hand, if your goal is to limit the amount of system + resources consumed by BitBake tasks, setting :term:`BB_NUMBER_THREADS` + to a number lower than the number of CPU threads in your machine + won't be sufficient. That's because each package will still be built + and installed through a number of parallel jobs specified by the + :term:`PARALLEL_MAKE` variable, which is by default the number of CPU + threads in your system, and is not impacted by the + :term:`BB_NUMBER_THREADS` value. + + So, if you set :term:`BB_NUMBER_THREADS` to "1" but don't set + :term:`PARALLEL_MAKE`, most of your system resources will be consumed + anyway. + + Therefore, if you intend to reduce the load of your build system by + setting :term:`BB_NUMBER_THREADS` to a relatively low value compared + to the number of CPU threads on your system, you should also set + :term:`PARALLEL_MAKE` to a similarly low value. + + An alternative to using :term:`BB_NUMBER_THREADS` to keep the usage + of build system resources under control is to use the smarter + :term:`BB_PRESSURE_MAX_CPU`, :term:`BB_PRESSURE_MAX_IO` or + :term:`BB_PRESSURE_MAX_MEMORY` controls. They will prevent BitBake + from starting new tasks as long as thresholds are exceeded. Anyway, + as with :term:`BB_NUMBER_THREADS`, such controls won't prevent the + tasks already being run from using all CPU threads on the system + if :term:`PARALLEL_MAKE` is not set to a low value. + + :term:`BB_ORIGENV` + See :term:`bitbake:BB_ORIGENV` in the BitBake manual. + + :term:`BB_PRESERVE_ENV` + See :term:`bitbake:BB_PRESERVE_ENV` in the BitBake manual. + + :term:`BB_PRESSURE_MAX_CPU` + See :term:`bitbake:BB_PRESSURE_MAX_CPU` in the BitBake manual. + + :term:`BB_PRESSURE_MAX_IO` + See :term:`bitbake:BB_PRESSURE_MAX_IO` in the BitBake manual. + + :term:`BB_PRESSURE_MAX_MEMORY` + See :term:`bitbake:BB_PRESSURE_MAX_MEMORY` in the BitBake manual. + + :term:`BB_RUNFMT` + See :term:`bitbake:BB_RUNFMT` in the BitBake manual. + + :term:`BB_RUNTASK` + See :term:`bitbake:BB_RUNTASK` in the BitBake manual. + + :term:`BB_SCHEDULER` + See :term:`bitbake:BB_SCHEDULER` in the BitBake manual. + + :term:`BB_SCHEDULERS` + See :term:`bitbake:BB_SCHEDULERS` in the BitBake manual. + + :term:`BB_SERVER_TIMEOUT` + Specifies the time (in seconds) after which to unload the BitBake + server due to inactivity. Set :term:`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 :term:`BB_SERVER_TIMEOUT` to "-1". + + :term:`BB_SETSCENE_DEPVALID` + See :term:`bitbake:BB_SETSCENE_DEPVALID` in the BitBake manual. + + :term:`BB_SIGNATURE_EXCLUDE_FLAGS` + See :term:`bitbake:BB_SIGNATURE_EXCLUDE_FLAGS` in the BitBake manual. + + :term:`BB_SIGNATURE_HANDLER` + See :term:`bitbake:BB_SIGNATURE_HANDLER` in the BitBake manual. + + :term:`BB_SRCREV_POLICY` + See :term:`bitbake:BB_SRCREV_POLICY` in the BitBake manual. + + :term:`BB_STRICT_CHECKSUM` + See :term:`bitbake:BB_STRICT_CHECKSUM` in the BitBake manual. + + :term:`BB_TASK_IONICE_LEVEL` + See :term:`bitbake:BB_TASK_IONICE_LEVEL` in the BitBake manual. + + :term:`BB_TASK_NICE_LEVEL` + See :term:`bitbake:BB_TASK_NICE_LEVEL` in the BitBake manual. + + :term:`BB_TASKHASH` + See :term:`bitbake:BB_TASKHASH` in the BitBake manual. + + :term:`BB_VERBOSE_LOGS` + See :term:`bitbake:BB_VERBOSE_LOGS` in the BitBake manual. + + :term:`BB_WORKERCONTEXT` + See :term:`bitbake:BB_WORKERCONTEXT` in the BitBake manual. + + :term:`BBCLASSEXTEND` + Allows you to extend a recipe so that it builds variants of the + software. There are common variants for recipes 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`; ":ref:`ref-classes-nativesdk`", which + targets the SDK machine instead of :term:`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 :term:`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 :term:`DEPENDS` on "foo-native". + + Even when using :term:`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:`BBDEBUG` + See :term:`bitbake:BBDEBUG` in the BitBake manual. + + :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 :term:`PV` value but for + which the :term:`BBFILE_PRIORITY` is set to have a lower precedence still + has a lower precedence. + + A larger value for the :term:`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 :term:`BBFILE_PRIORITY` variable + is set based on layer dependencies (see the :term:`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 <https://docs.python.org/3/library/glob.html>`__ 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 :term:`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 :term:`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 fail: + + .. code-block:: none + + ERROR: BBFILES_DYNAMIC entries must be of the form <collection name>:<filename pattern>, not: + /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend + /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend + + :term:`BBINCLUDED` + See :term:`bitbake:BBINCLUDED` in the BitBake manual. + + :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 :term:`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:`BBLAYERS_FETCH_DIR` + See :term:`bitbake:BBLAYERS_FETCH_DIR` in the BitBake manual. + + :term:`BBMASK` + Prevents BitBake from processing recipes and recipe append files. + + You can use the :term:`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 a ``multiconfig`` + subdirectory of a configuration directory within a layer, or + within the :term:`Build Directory` (e.g. + ``build_directory/conf/multiconfig/configA.conf`` or + ``mylayer/conf/multiconfig/configB.conf``). + + For information on how to use :term:`BBMULTICONFIG` in an environment + that supports building targets with multiple configurations, see the + ":ref:`dev-manual/building:building images for multiple targets using multiple configurations`" + section in the Yocto Project Development Tasks Manual. + + :term:`BBPATH` + See :term:`bitbake:BBPATH` in the BitBake manual. + + :term:`BBSERVER` + If defined in the BitBake environment, :term:`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, :term:`BBSERVER` also appears in :term:`BB_BASEHASH_IGNORE_VARS`. + Consequently, :term:`BBSERVER` is excluded from checksum and dependency + data. + + :term:`BBTARGETS` + See :term:`bitbake:BBTARGETS` in the BitBake manual. + + :term:`BINCONFIG` + When inheriting the :ref:`ref-classes-binconfig-disabled` class, this + variable specifies binary configuration scripts to disable in favor of + using ``pkg-config`` to query the information. The + :ref:`ref-classes-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:`ref-classes-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 :term:`BINCONFIG_GLOB` variable uses + `shell globbing <https://tldp.org/LDP/abs/html/globbingref.html>`__, + which is recognition and expansion of wildcards during pattern + matching. Shell globbing is very similar to + `fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__ + and `glob <https://docs.python.org/3/library/glob.html>`__. + + For more information on how this variable works, see + ``meta/classes-recipe/binconfig.bbclass`` in the :term:`Source Directory`. + You can also find general + information on the class in the + ":ref:`ref-classes-binconfig`" section. + + :term:`BITBAKE_UI` + See :term:`bitbake:BITBAKE_UI` in the BitBake manual. + + :term:`BP` + The base recipe name and version but without any special recipe name + suffix (i.e. ``-native``, ``lib64-``, and so forth). :term:`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 :term:`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 :term:`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 :term:`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, :term:`BUILD_CCLD` + points to GCC and passes as arguments the value of + :term:`BUILD_CC_ARCH`, assuming + :term:`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, :term:`BUILD_FC` points to Gfortran and passes as arguments the + value of :term:`BUILD_CC_ARCH`, assuming + :term:`BUILD_CC_ARCH` is set. + + :term:`BUILD_LD` + Specifies the linker command for the build host. By default, + :term:`BUILD_LD` points to the GNU linker (ld) and passes as arguments + the value of :term:`BUILD_LD_ARCH`, assuming + :term:`BUILD_LD_ARCH` is set. + + :term:`BUILD_LD_ARCH` + Specifies architecture-specific linker flags for the build host. By + default, the value of :term:`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 :term:`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 + :term:`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 :term:`BUILD_PREFIX` value to set the + :term:`TARGET_PREFIX` when building for :ref:`ref-classes-native` recipes. + + :term:`BUILD_STRIP` + Specifies the command to be used to strip debugging symbols from + binaries produced for the build host. By default, :term:`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 + :ref:`ref-classes-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 + :term:`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 :term:`Build Directory` path when you run the script. If + you run the script and do not provide a :term:`Build Directory` path, the + :term:`BUILDDIR` defaults to ``build`` in the current directory. + + :term:`BUILDHISTORY_COMMIT` + When inheriting the :ref:`ref-classes-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 :ref:`ref-classes-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 :ref:`ref-classes-buildhistory` class + enables committing the buildhistory output in a local Git repository:: + + BUILDHISTORY_COMMIT ?= "1" + + :term:`BUILDHISTORY_COMMIT_AUTHOR` + When inheriting the :ref:`ref-classes-buildhistory` + class, this variable specifies the author to use for each Git commit. + In order for the :term:`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 + :term:`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 :ref:`ref-classes-buildhistory` class sets the variable + as follows:: + + BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" + + :term:`BUILDHISTORY_DIR` + When inheriting the :ref:`ref-classes-buildhistory` + class, this variable specifies the directory in which build history + information is kept. For more information on how the variable works, + see the :ref:`ref-classes-buildhistory` class. + + By default, the :ref:`ref-classes-buildhistory` class sets the directory + as follows:: + + BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" + + :term:`BUILDHISTORY_FEATURES` + When inheriting the :ref:`ref-classes-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/build-quality: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 <overview-manual/concepts:shared state cache>` + (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 :ref:`ref-classes-buildhistory` class enables the + following features:: + + BUILDHISTORY_FEATURES ?= "image package sdk" + + :term:`BUILDHISTORY_IMAGE_FILES` + When inheriting the :ref:`ref-classes-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 :ref:`ref-classes-buildhistory` class provides paths to + the following files:: + + BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" + + :term:`BUILDHISTORY_PATH_PREFIX_STRIP` + When inheriting the :ref:`ref-classes-buildhistory` + class, this variable specifies a common path prefix that should be + stripped off the beginning of paths in the task signature list when the + ``task`` feature is active in :term:`BUILDHISTORY_FEATURES`. This can be + useful when build history is populated from multiple sources that may not + all use the same top level directory. + + By default, the :ref:`ref-classes-buildhistory` class sets the variable + as follows:: + + BUILDHISTORY_PATH_PREFIX_STRIP ?= "" + + In this case, no prefixes will be stripped. + + :term:`BUILDHISTORY_PUSH_REPO` + When inheriting the :ref:`ref-classes-buildhistory` class, this variable + optionally specifies a remote repository to which build history pushes + Git changes. In order for :term:`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 :ref:`ref-classes-buildhistory` class sets the variable + as follows:: + + BUILDHISTORY_PUSH_REPO ?= "" + + :term:`BUILDNAME` + See :term:`bitbake:BUILDNAME` in the BitBake manual. + + :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:`ref-classes-buildstats` class. The + :term:`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 :term:`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:`BZRDIR` + See :term:`bitbake:BZRDIR` in the BitBake manual. + + :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 :term:`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:`ref-classes-native`, :ref:`ref-classes-nativesdk`, and so forth) + set the variable to appropriate values. + + .. note:: + + :term:`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 :term:`CLASSOVERRIDE` is simply + that it is included in the default value of + :term:`OVERRIDES`. + + :term:`CLEANBROKEN` + If set to "1" within a recipe, :term:`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:`COMMERCIAL_AUDIO_PLUGINS` + This variable is specific to the :yocto_git:`GStreamer recipes + </poky/tree/meta/recipes-multimedia/gstreamer/gstreamer1.0-meta-base.bb>`. + It allows to build the GStreamer `"ugly" + <https://github.com/GStreamer/gst-plugins-ugly>`__ and + `"bad" <https://github.com/GStreamer/gst-plugins-bad>`__ audio plugins. + + See the :ref:`dev-manual/licenses:other variables related to commercial licenses` + section for usage details. + + :term:`COMMERCIAL_VIDEO_PLUGINS` + This variable is specific to the :yocto_git:`GStreamer recipes + </poky/tree/meta/recipes-multimedia/gstreamer/gstreamer1.0-meta-base.bb>`. + It allows to build the GStreamer `"ugly" + <https://github.com/GStreamer/gst-plugins-ugly>`__ and + `"bad" <https://github.com/GStreamer/gst-plugins-bad>`__ video plugins. + + See the :ref:`dev-manual/licenses:other variables related to commercial licenses` + section for usage details. + + :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. + + If one wants to have a recipe only available for some architectures + (here ``aarch64`` and ``mips64``), the following can be used:: + + COMPATIBLE_MACHINE = "^$" + COMPATIBLE_MACHINE:arch64 = "^(aarch64)$" + COMPATIBLE_MACHINE:mips64 = "^(mips64)$" + + The first line means "match all machines whose :term:`MACHINEOVERRIDES` + contains the empty string", which will always be none. + + The second is for matching all machines whose :term:`MACHINEOVERRIDES` + contains one override which is exactly ``aarch64``. + + The third is for matching all machines whose :term:`MACHINEOVERRIDES` + contains one override which is exactly ``mips64``. + + The same could be achieved with:: + + COMPATIBLE_MACHINE = "^(aarch64|mips64)$" + + .. note:: + + When :term:`COMPATIBLE_MACHINE` is set in a recipe inherits from + native, the recipe is always skipped. All native recipes must be + entirely target independent and should not rely on :term:`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. + + The :term:`COMPLEMENTARY_GLOB` variable uses Unix filename pattern matching + (`fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__), + which is similar to the Unix style pathname pattern expansion + (`glob <https://docs.python.org/3/library/glob.html>`__). + + 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 :term:`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' + + .. note:: + + When installing complementary packages, recommends relationships + (set via :term:`RRECOMMENDS`) are always ignored. + + :term:`COMPONENTS_DIR` + Stores sysroot components for each recipe. The OpenEmbedded build + system uses :term:`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 :term:`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 :term:`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 :term:`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" + + There is a relationship between the :term:`CONFFILES` and :term:`FILES` + variables. The files listed within :term:`CONFFILES` must be a subset of + the files listed within :term:`FILES`. Because the configuration files + you provide with :term:`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 :term:`FILES` + variable. + + .. note:: + + When specifying paths as part of the :term:`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 (:term:`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 :term:`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 :term:`Initramfs` image. A cpio archive should contain + a filesystem archive to be used as an :term:`Initramfs` image. Directories + should contain a filesystem layout to be included in the :term:`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 :term:`Initramfs` image + will be the aggregate of all of them. + + For information on creating an :term:`Initramfs`, see the + ":ref:`dev-manual/building: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:`ref-classes-features_check` + class, this variable identifies distribution features that would be + in conflict should the recipe be built. In other words, if the + :term:`CONFLICT_DISTRO_FEATURES` variable lists a feature that also + appears in :term:`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:`CONVERSION_CMD` + This variable is used for storing image conversion commands. + Image conversion can convert an image into different objects like: + + - Compressed version of the image + + - Checksums for the image + + An example of :term:`CONVERSION_CMD` from :ref:`ref-classes-image_types` + class is:: + + CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}" + + :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 :term:`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/licenses: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 :term:`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/licenses:providing license text`" + section in the Yocto Project Development Tasks Manual for + information on providing license text. + + :term:`COPYLEFT_LICENSE_EXCLUDE` + A space-separated list of licenses to exclude from the source archived by + the :ref:`ref-classes-archiver` class. In other words, if a license in a + recipe's :term:`LICENSE` value is in the value of + :term:`COPYLEFT_LICENSE_EXCLUDE`, then its source is not archived by the + class. + + .. note:: + + The :term:`COPYLEFT_LICENSE_EXCLUDE` variable takes precedence over the + :term:`COPYLEFT_LICENSE_INCLUDE` variable. + + The default value, which is "CLOSED Proprietary", for + :term:`COPYLEFT_LICENSE_EXCLUDE` is set by the + :ref:`ref-classes-copyleft_filter` class, which + is inherited by the :ref:`ref-classes-archiver` class. + + :term:`COPYLEFT_LICENSE_INCLUDE` + A space-separated list of licenses to include in the source archived + by the :ref:`ref-classes-archiver` class. In other + words, if a license in a recipe's :term:`LICENSE` + value is in the value of :term:`COPYLEFT_LICENSE_INCLUDE`, then its + source is archived by the class. + + The default value is set by the :ref:`ref-classes-copyleft_filter` class, + which is inherited by the :ref:`ref-classes-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:`ref-classes-archiver` class. The :term:`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 :term:`COPYLEFT_PN_EXCLUDE` is set by the + :ref:`ref-classes-copyleft_filter` class, which is inherited by the + :ref:`ref-classes-archiver` class. + + :term:`COPYLEFT_PN_INCLUDE` + A list of recipes to include in the source archived by the + :ref:`ref-classes-archiver` class. The :term:`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 :term:`COPYLEFT_PN_INCLUDE` is set by the + :ref:`ref-classes-copyleft_filter` class, which is inherited by the + :ref:`ref-classes-archiver` class. + + :term:`COPYLEFT_RECIPE_TYPES` + A space-separated list of recipe types to include in the source + archived by the :ref:`archiver <ref-classes-archiver>` class. + Recipe types are ``target``, :ref:`ref-classes-native`, + :ref:`ref-classes-nativesdk`, :ref:`ref-classes-cross`, + :ref:`ref-classes-crosssdk`, and :ref:`ref-classes-cross-canadian`. + + The default value, which is "target*", for :term:`COPYLEFT_RECIPE_TYPES` + is set by the :ref:`ref-classes-copyleft_filter` class, which is + inherited by the :ref:`ref-classes-archiver` class. + + :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 :term:`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, :term:`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 :term:`COREBASE_FILES` variable allows + to copy metadata from the OpenEmbedded build system + into the extensible SDK. + + Explicitly listing files in :term:`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 :term:`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 :term:`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 + :term:`CROSS_COMPILE` variable is the same as the + :term:`TARGET_PREFIX` variable. + + .. note:: + + The OpenEmbedded build system sets the :term:`CROSS_COMPILE` + variable only in certain contexts (e.g. when building for kernel + and kernel module recipes). + + :term:`CVE_CHECK_IGNORE` + This variable is deprecated and should be replaced by :term:`CVE_STATUS`. + + :term:`CVE_CHECK_SHOW_WARNINGS` + Specifies whether or not the :ref:`ref-classes-cve-check` + class should generate warning messages on the console when unpatched + CVEs are found. The default is "1", but you may wish to set it to "0" if + you are already examining/processing the logs after the build has + completed and thus do not need the warning messages. + + :term:`CVE_CHECK_SKIP_RECIPE` + The list of package names (:term:`PN`) for which + CVEs (Common Vulnerabilities and Exposures) are ignored. + + :term:`CVE_DB_INCR_UPDATE_AGE_THRES` + Specifies the maximum age of the CVE database in seconds for an + incremental update (instead of a full-download). Use "0" to force a + full-download. + + :term:`CVE_DB_UPDATE_INTERVAL` + Specifies the CVE database update interval in seconds, as used by + ``cve-update-db-native``. The default value is "86400" i.e. once a day + (24*60*60). If the value is set to "0" then the update will be forced + every time. Alternatively, a negative value e.g. "-1" will disable + updates entirely. + + :term:`CVE_PRODUCT` + In a recipe, defines the name used to match the recipe name + against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__. + + The default is ${:term:`BPN`} (except for recipes that inherit the + :ref:`ref-classes-pypi` class where it is set based upon + :term:`PYPI_PACKAGE`). If it does not match the name in the NIST CVE + database or matches with multiple entries in the database, the default + value needs to be changed. + + Here is an example from the :oe_layerindex:`Berkeley DB recipe </layerindex/recipe/544>`:: + + CVE_PRODUCT = "oracle_berkeley_db berkeley_db" + + Sometimes the product name is not specific enough, for example + "tar" has been matching CVEs for the GNU ``tar`` package and also + the ``node-tar`` node.js extension. To avoid this problem, use the + vendor name as a prefix. The syntax for this is:: + + CVE_PRODUCT = "vendor:package" + + :term:`CVE_STATUS` + The CVE ID which is patched or should be ignored. Here is + an example from the :oe_layerindex:`Python3 recipe</layerindex/recipe/23823>`:: + + CVE_STATUS[CVE-2020-15523] = "not-applicable-platform: Issue only applies on Windows" + + It has the format "reason: description" and the description is optional. + The Reason is mapped to the final CVE state by mapping via + :term:`CVE_CHECK_STATUSMAP`. See :ref:`dev-manual/vulnerabilities:fixing vulnerabilities in recipes` + for details. + + :term:`CVE_STATUS_GROUPS` + If there are many CVEs with the same status and reason, they can by simplified by using this + variable instead of many similar lines with :term:`CVE_STATUS`:: + + CVE_STATUS_GROUPS = "CVE_STATUS_WIN CVE_STATUS_PATCHED" + + CVE_STATUS_WIN = "CVE-1234-0001 CVE-1234-0002" + CVE_STATUS_WIN[status] = "not-applicable-platform: Issue only applies on Windows" + CVE_STATUS_PATCHED = "CVE-1234-0003 CVE-1234-0004" + CVE_STATUS_PATCHED[status] = "fixed-version: Fixed externally" + + :term:`CVE_CHECK_STATUSMAP` + Mapping variable for all possible reasons of :term:`CVE_STATUS`: + ``Patched``, ``Unpatched`` and ``Ignored``. + See :ref:`ref-classes-cve-check` or ``meta/conf/cve-check-map.conf`` for more details:: + + CVE_CHECK_STATUSMAP[cpe-incorrect] = "Ignored" + + :term:`CVE_VERSION` + In a recipe, defines the version used to match the recipe version + against the version in the `NIST CVE database <https://nvd.nist.gov/>`__ + when usign :ref:`ref-classes-cve-check`. + + The default is ${:term:`PV`} but if recipes use custom version numbers + which do not map to upstream software component release versions and the versions + used in the CVE database, then this variable can be used to set the + version number for :ref:`ref-classes-cve-check`. Example:: + + CVE_VERSION = "2.39" + + :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 :term:`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 <overview-manual/concepts:fakeroot and pseudo>`. + + :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:`ref-classes-debian` class is inherited, + which is the default behavior, :term:`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:`ref-classes-debian` class is inherited, + which is the default behavior, :term:`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 :term:`SELECTED_OPTIMIZATION` variable. + + :term:`DEBUG_OPTIMIZATION` + The options to pass in :term:`TARGET_CFLAGS` and :term:`CFLAGS` when + compiling a system for debugging. This variable defaults to "-O + -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe". + + :term:`DEBUG_PREFIX_MAP` + Allows to set C compiler options, such as ``-fdebug-prefix-map``, + ``-fmacro-prefix-map``, and ``-ffile-prefix-map``, which allow to + replace build-time paths by install-time ones in the debugging sections + of binaries. This makes compiler output files location independent, + at the cost of having to pass an extra command to tell the debugger + where source files are. + + This is used by the Yocto Project to guarantee + :doc:`/test-manual/reproducible-builds` even when the source code of + a package uses the ``__FILE__`` or ``assert()`` macros. See the + `reproducible-builds.org <https://reproducible-builds.org/docs/build-path/>`__ + website for details. + + This variable is set in the ``meta/conf/bitbake.conf`` file. It is + not intended to be user-configurable. + + :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 :term:`PREFERRED_VERSION` being used to + build the development version. + + .. note:: + + The bias provided by :term:`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 + :term:`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* <STAGING_DIR>` variables, by the time + the :ref:`ref-tasks-configure` task for ``foo`` runs. This mechanism is + implemented by having :ref:`ref-tasks-configure` depend on the + :ref:`ref-tasks-populate_sysroot` task of each recipe listed in + :term:`DEPENDS`, through a + ``[``\ :ref:`deptask <bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` + declaration in the :ref:`ref-classes-base` class. + + .. note:: + + It seldom is necessary to reference, for example, :term:`STAGING_DIR_HOST` + explicitly. The standard classes and build-related variables are + configured to automatically use the appropriate staging sysroots. + + As another example, :term:`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:`ref-classes-native` class and + the :term:`EXTRANATIVEPATH` variable. + + .. note:: + + - :term:`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 :term:`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 :term:`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 + :term:`DEPENDS` alone is sufficient for most recipes. + + - Counterintuitively, :term:`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 :term:`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:`bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and + ":ref:`bitbake-user-manual/bitbake-user-manual-execution: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 + ":ref:`ref-classes-package_deb`". + + The BitBake configuration file initially defines the + :term:`DEPLOY_DIR_DEB` variable as a sub-folder of + :term:`DEPLOY_DIR`:: + + DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" + + The :ref:`ref-classes-package_deb` class uses the + :term:`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}/``. + + It must not be used directly in recipes when deploying files. Instead, + it's only useful when a recipe needs to "read" a file already deployed + by a dependency. So, it should be filled with the contents of + :term:`DEPLOYDIR` by the :ref:`ref-classes-deploy` class or with the + contents of :term:`IMGDEPLOYDIR` by the :ref:`ref-classes-image` class. + + For more information on the structure of the :term:`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 + ":ref:`ref-classes-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:`ref-classes-package_ipk` class uses the :term:`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 + ":ref:`ref-classes-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:`ref-classes-package_rpm` class uses the + :term:`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:`DEPLOYDIR` + When inheriting the :ref:`ref-classes-deploy` class, the + :term:`DEPLOYDIR` points to a temporary work area for deployed files that + is set in the :ref:`ref-classes-deploy` class as follows:: + + DEPLOYDIR = "${WORKDIR}/deploy-${PN}" + + Recipes inheriting the :ref:`ref-classes-deploy` class should copy files to be + deployed into :term:`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, + :term:`DESCRIPTION` takes the value of the :term:`SUMMARY` + variable. + + :term:`DEV_PKG_DEPENDENCY` + Provides an easy way for recipes to disable or adjust the runtime recommendation + (:term:`RRECOMMENDS`) of the ``${PN}-dev`` package on the main + (``${PN}``) package. + + :term:`DISABLE_STATIC` + Used in order to disable static linking by default (in order to save + space, since static libraries are often unused in embedded systems.) + The default value is " --disable-static", however it can be set to "" + in order to enable static linking if desired. Certain recipes do this + individually, and also there is a + ``meta/conf/distro/include/no-static-libs.inc`` include file that + disables static linking for a number of recipes. Some software + packages or build tools (such as CMake) have explicit support for + enabling / disabling static linking, and in those cases + :term:`DISABLE_STATIC` is not used. + + :term:`DISTRO` + The short name of the distribution. For information on the long name + of the distribution, see the :term:`DISTRO_NAME` + variable. + + The :term:`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 :term:`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 :term:`DISTRO` must not contain + spaces, and is typically all lower-case. + + .. note:: + + If the :term:`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 effect 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 + :term:`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 + :term:`DISTRO_FEATURES`, causes every piece of software built for the + target that can optionally support X11 to have its X11 support + enabled. + + .. note:: + + Just enabling :term:`DISTRO_FEATURES` alone doesn't + enable feature support for packages. Mechanisms such as making + :term:`PACKAGECONFIG` track :term:`DISTRO_FEATURES` are used + to enable/disable package features. + + 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` + A space-separated list of features to be added to :term:`DISTRO_FEATURES` + if not also present in :term:`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 + :ref:`backfilled <ref-features-backfill>` for all distro configurations. + + :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` + A space-separated list of features from :term:`DISTRO_FEATURES_BACKFILL` + that should not be :ref:`backfilled <ref-features-backfill>` (i.e. added + to :term:`DISTRO_FEATURES`) during the build. + + This corresponds to an opt-out mechanism. When new default distro + features are introduced, distribution maintainers can review (`consider`) + them and decide to exclude them from the + :ref:`backfilled <ref-features-backfill>` features. Therefore, the + combination of :term:`DISTRO_FEATURES_BACKFILL` and + :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` makes it possible to + add new default features without breaking existing distributions. + + + :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 + :term:`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 :term:`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 + :term:`DISTRO_FEATURES` when building :ref:`ref-classes-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 + :ref:`ref-classes-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 :term:`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 :term:`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 :term:`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 :term:`DISTROOVERRIDES` to add extra overrides that should + apply to the distribution. + + The underlying mechanism behind :term:`DISTROOVERRIDES` is simply that it + is included in the default value of + :term:`OVERRIDES`. + + Here is an example from :yocto_git:`meta-poky/conf/distro/poky-tiny.conf + </poky/tree/meta-poky/conf/distro/poky-tiny.conf>`:: + + DISTROOVERRIDES = "poky:poky-tiny" + + :term:`DL_DIR` + The central download directory used by the build process to store + downloads. By default, :term:`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 :term:`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 :term:`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 </Working_Behind_a_Network_Proxy>`" + Wiki page. + + :term:`DOC_COMPRESS` + When inheriting the :ref:`ref-classes-compress_doc` + class, this variable sets the compression policy used when the + OpenEmbedded build system compresses manual 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-recipe/compress_doc.bbclass`` file. + + :term:`DT_FILES` + Space-separated list of device tree source files to compile using + a recipe that inherits the :ref:`ref-classes-devicetree` class. These + are relative to the :term:`DT_FILES_PATH`. + + For convenience, both ``.dts`` and ``.dtb`` extensions can be used. + + Use an empty string (default) to build all device tree sources within + the :term:`DT_FILES_PATH` directory. + + :term:`DT_FILES_PATH` + When compiling out-of-tree device tree sources using a recipe that + inherits the :ref:`ref-classes-devicetree` class, this variable specifies + the path to the directory containing dts files to build. + + Defaults to the :term:`S` directory. + + :term:`DT_PADDING_SIZE` + When inheriting the :ref:`ref-classes-devicetree` class, this variable + specifies the size of padding appended to the device tree blob, used as + extra space typically for additional properties during boot. + + :term:`EFI_PROVIDER` + When building bootable images (i.e. where ``hddimg``, ``iso``, or + ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the + :term:`EFI_PROVIDER` variable specifies the EFI bootloader to use. The + default is "grub-efi", but "systemd-boot" can be used instead. + + See the :ref:`ref-classes-systemd-boot` and :ref:`ref-classes-image-live` + classes for more information. + + :term:`EFI_UKI_DIR` + The primary place for the UKI image inside the EFI System Partition. + + :term:`EFI_UKI_PATH` + The path for the UKI image inside the root filesystem. + + :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:`ref-classes-report-error` class, specifies the + path used for storing the debug files created by the :ref:`error reporting + tool <dev-manual/error-reporting-tool:using the 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 :term:`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:`ref-classes-insane`" section. + + :term:`ESDK_CLASS_INHERIT_DISABLE` + A list of classes to remove from the :term:`INHERIT` + value globally within the extensible SDK configuration. The + :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the + default value:: + + ESDK_CLASS_INHERIT_DISABLE ?= "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:`ESDK_LOCALCONF_ALLOW` + 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 <ref-classes-populate-sdk-*>` class. + + This list overrides the variables specified using the + :term:`ESDK_LOCALCONF_REMOVE` variable as well as + other variables automatically added 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:`ESDK_LOCALCONF_REMOVE` + 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, :term:`ESDK_LOCALCONF_REMOVE` is set in the + :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and + excludes the following variables: + + - :term:`CONF_VERSION` + - :term:`BB_NUMBER_THREADS` + - :term:`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:`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 :term:`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 :term:`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 :term:`EXCLUDE_FROM_WORLD` may still be built during a + world build in order to satisfy dependencies of other recipes. Adding + a recipe to :term:`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 :term:`PE` + is set and greater than zero for a recipe, :term:`EXTENDPE` becomes that + value (e.g if :term:`PE` is equal to "1" then :term:`EXTENDPE` becomes "1"). + If a recipe's :term:`PE` is not set (the default) or is equal to zero, + :term:`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 :term:`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 :term:`EXTERNAL_KERNEL_TOOLS` + variable tells the OpenEmbedded build system to prefer the installed + external tools. See the :ref:`ref-classes-kernel-yocto` class in + ``meta/classes-recipe`` to see how the variable is used. + + :term:`KERNEL_LOCALVERSION` + This variable allows to append a string to the version + of the kernel image. This corresponds to the ``CONFIG_LOCALVERSION`` + kernel configuration parameter. + + Using this variable is only useful when you are using a kernel recipe + inheriting the :ref:`ref-classes-kernel` class, and which doesn't + already set a local version. Therefore, setting this variable has no + impact on ``linux-yocto`` kernels. + + :term:`EXTERNAL_TOOLCHAIN` + When you intend to use an + :ref:`external toolchain <dev-manual/external-toolchain:optionally using an external toolchain>`, + this variable allows to specify the directory where this toolchain was + installed. + + :term:`EXTERNALSRC` + When inheriting the :ref:`ref-classes-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. + + See the ":ref:`ref-classes-externalsrc`" section for details. You + can also find information on how to use this variable in the + ":ref:`dev-manual/building:building software from an external source`" + section in the Yocto Project Development Tasks Manual. + + :term:`EXTERNALSRC_BUILD` + When inheriting the :ref:`ref-classes-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 + :term:`Build Directory`. + + See the ":ref:`ref-classes-externalsrc`" section for details. You + can also find information on how to use this variable in the + ":ref:`dev-manual/building:building software from an external source`" + section in the Yocto Project Development Tasks Manual. + + :term:`EXTRA_AUTORECONF` + For recipes inheriting the :ref:`ref-classes-autotools` + class, you can use :term:`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/read-only-rootfs: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/customizing-images: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 :term:`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:`EXTRA_OECMAKE` + Additional `CMake <https://cmake.org/overview/>`__ options. See the + :ref:`ref-classes-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 :term:`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 + :term:`EXTRA_OEMAKE` to pass the required flags. + + :term:`EXTRA_OESCONS` + When inheriting the :ref:`ref-classes-scons` class, this + variable specifies additional configuration options you want to pass + to the ``scons`` command line. + + :term:`EXTRA_OEMESON` + Additional `Meson <https://mesonbuild.com/>`__ options. See the + :ref:`ref-classes-meson` class for additional information. + + In addition to standard Meson options, such options correspond to + `Meson build options <https://mesonbuild.com/Build-options.html>`__ + defined in the ``meson_options.txt`` file in the sources to build. + Here is an example:: + + EXTRA_OEMESON = "-Dpython=disabled -Dvalgrind=disabled" + + Note that any custom value for the Meson ``--buildtype`` option + should be set through the :term:`MESON_BUILDTYPE` variable. + + :term:`EXTRA_USERS_PARAMS` + When inheriting the :ref:`ref-classes-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:`ref-classes-useradd` class, which ties user and + group configurations to a specific recipe. + + The set list of commands you can configure using the + :term:`EXTRA_USERS_PARAMS` is shown in the + :ref:`ref-classes-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; \ + # " + + Hardcoded passwords are supported via the ``-p`` parameters for + ``useradd`` or ``usermod``, but only hashed. + + Here is an example that adds two users named "tester-jim" and "tester-sue" and assigns + passwords. First on host, create the (escaped) password hash:: + + printf "%q" $(mkpasswd -m sha256crypt tester01) + + The resulting hash is set to a variable and used in ``useradd`` command parameters:: + + inherit extrausers + PASSWD = "\$X\$ABC123\$A-Long-Hash" + EXTRA_USERS_PARAMS = "\ + useradd -p '${PASSWD}' tester-jim; \ + useradd -p '${PASSWD}' tester-sue; \ + " + + Finally, here is an example that sets the root password:: + + inherit extrausers + EXTRA_USERS_PARAMS = "\ + usermod -p '${PASSWD}' root; \ + " + + .. note:: + + From a security perspective, hardcoding a default password is not + generally a good idea or even legal in some jurisdictions. It is + recommended that you do not do this if you are building a production + image. + + Additionally there is a special ``passwd-expire`` command that will + cause the password for a user to be expired and thus force changing it + on first login, for example:: + + EXTRA_USERS_PARAMS += " useradd myuser; passwd-expire myuser;" + + .. note:: + + At present, ``passwd-expire`` may only work for remote logins when + using OpenSSH and not dropbear as an SSH server. + + :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:`FAKEROOT` + See :term:`bitbake:FAKEROOT` in the BitBake manual. + + :term:`FAKEROOTBASEENV` + See :term:`bitbake:FAKEROOTBASEENV` in the BitBake manual. + + :term:`FAKEROOTCMD` + See :term:`bitbake:FAKEROOTCMD` in the BitBake manual. + + :term:`FAKEROOTDIRS` + See :term:`bitbake:FAKEROOTDIRS` in the BitBake manual. + + :term:`FAKEROOTENV` + See :term:`bitbake:FAKEROOTENV` in the BitBake manual. + + :term:`FAKEROOTNOENV` + See :term:`bitbake:FAKEROOTNOENV` in the BitBake manual. + + :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, :term:`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 :term:`IMAGE_FEATURES`, + package1 and package2 would be included in the image. + + .. note:: + + Packages installed by features defined through :term:`FEATURE_PACKAGES` + are often package groups. While similarly named, you should not + confuse the :term:`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:`FETCHCMD` + See :term:`bitbake:FETCHCMD` in the BitBake manual. + + :term:`FILE` + See :term:`bitbake:FILE` in the BitBake manual. + + :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 :term:`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 <https://docs.python.org/3/library/glob.html>`__ + syntax. For details on the syntax, see the documentation by + following the previous link. + + - When specifying paths as part of the :term:`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 :term:`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, + :term:`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` + A colon-separated list to extend 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 :term:`FILESPATH` variable by using :term:`FILESEXTRAPATHS`. + + Best practices dictate that you accomplish this by using + :term:`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 :term:`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 + :term:`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 :term:`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 colon-separated list to specify a subset of :term:`OVERRIDES` used by + the OpenEmbedded build system for creating :term:`FILESPATH`. The + :term:`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-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" + section of the BitBake User Manual. + + By default, the :term:`FILESOVERRIDES` variable is defined as:: + + FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}" + + .. note:: + + Do not hand-edit the :term:`FILESOVERRIDES` variable. The values match up + with expected overrides and are used in an expected manner by the + build system. + + :term:`FILESPATH` + A colon-separated list specifying 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 + :term:`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 :term:`FILESPATH` variable is defined in the + :ref:`ref-classes-base` class found in ``meta/classes-global`` in the + :term:`Source Directory`:: + + FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ + "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" + + The + :term:`FILESPATH` variable is automatically extended using the overrides + from the :term:`FILESOVERRIDES` variable. + + .. note:: + + - Do not hand-edit the :term:`FILESPATH` variable. If you want the + build system to look in directories other than the defaults, + extend the :term:`FILESPATH` variable by using the + :term:`FILESEXTRAPATHS` variable. + + - Be aware that the default :term:`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 :term:`FILESPATH` variable by using the + :term:`FILESEXTRAPATHS` variable. + + You can take advantage of this searching behavior in useful ways. For + example, consider a case where there is the following directory structure + for general and machine-specific configurations:: + + files/defconfig + files/MACHINEA/defconfig + files/MACHINEB/defconfig + + Also in the example, the :term:`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 :term:`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/new-recipe: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 :term:`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_ADDRESS_CELLS` + Specifies the value of the ``#address-cells`` value for the + description of the FIT image. + + The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage` + class, which corresponds to 32 bit addresses. + + For platforms that need to set 64 bit addresses, for example in + :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to + set this value to "2", as two 32 bit values (cells) will be needed + to represent such addresses. + + Here is an example setting "0x400000000" as a load address:: + + FIT_ADDRESS_CELLS = "2" + UBOOT_LOADADDRESS= "0x04 0x00000000" + + See `more details about #address-cells <https://elinux.org/Device_Tree_Usage#How_Addressing_Works>`__. + + :term:`FIT_CONF_DEFAULT_DTB` + Specifies the default device tree binary (dtb) file for a FIT image + when multiple ones are provided. + + This variable is used in the :ref:`ref-classes-kernel-fitimage` class. + + :term:`FIT_DESC` + Specifies the description string encoded into a FIT image. The + default value is set by the :ref:`ref-classes-kernel-fitimage` class as + follows:: + + FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" + + :term:`FIT_GENERATE_KEYS` + Decides whether to generate the keys for signing the FIT image if + they don't already exist. The keys are created in + :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0" + by the :ref:`ref-classes-kernel-fitimage` class. + + :term:`FIT_HASH_ALG` + Specifies the hash algorithm used in creating the FIT Image. + This variable is set by default to "sha256" by the + :ref:`ref-classes-kernel-fitimage` class. + + :term:`FIT_KERNEL_COMP_ALG` + The compression algorithm to use for the kernel image inside the FIT Image. + At present, the only supported values are "gzip" (default), "lzo" or "none". + If you set this variable to anything other than "none" you may also need + to set :term:`FIT_KERNEL_COMP_ALG_EXTENSION`. + + This variable is used in the :ref:`ref-classes-kernel-uboot` class. + + :term:`FIT_KERNEL_COMP_ALG_EXTENSION` + File extension corresponding to :term:`FIT_KERNEL_COMP_ALG`. The default + value is set ".gz" by the :ref:`ref-classes-kernel-uboot` class. If you + set :term:`FIT_KERNEL_COMP_ALG` to "lzo", you may want to set this + variable to ".lzo". + + :term:`FIT_KEY_GENRSA_ARGS` + Arguments to ``openssl genrsa`` for generating a RSA private key for + signing the FIT image. The default value is set to "-F4" by the + :ref:`ref-classes-kernel-fitimage` class. + + :term:`FIT_KEY_REQ_ARGS` + Arguments to ``openssl req`` for generating a certificate for signing + the FIT image. The default value is "-batch -new" by the + :ref:`ref-classes-kernel-fitimage` class, "batch" for + non interactive mode and "new" for generating new keys. + + :term:`FIT_KEY_SIGN_PKCS` + Format for the public key certificate used for signing the FIT image. + The default value is set to "x509" by the + :ref:`ref-classes-kernel-fitimage` class. + + :term:`FIT_SIGN_ALG` + Specifies the signature algorithm used in creating the FIT Image. + This variable is set by default to "rsa2048" by the + :ref:`ref-classes-kernel-fitimage` class. + + :term:`FIT_PAD_ALG` + Specifies the padding algorithm used in creating the FIT Image. + The default value is set to "pkcs-1.5" by the + :ref:`ref-classes-kernel-fitimage` class. + + :term:`FIT_SIGN_INDIVIDUAL` + If set to "1", then the :ref:`ref-classes-kernel-fitimage` + class will sign the kernel, dtb and ramdisk images individually in addition + to signing the FIT image itself. This could be useful if you are + intending to verify signatures in another context than booting via + U-Boot. + + This variable is set to "0" by default. + + :term:`FIT_SIGN_NUMBITS` + Size of the private key used in the FIT image, in number of bits. + The default value for this variable is set to "2048" + by the :ref:`ref-classes-kernel-fitimage` class. + + :term:`FONT_EXTRA_RDEPENDS` + When inheriting the :ref:`ref-classes-fontcache` class, + this variable specifies the runtime dependencies for font packages. + By default, the :term:`FONT_EXTRA_RDEPENDS` is set to "fontconfig-utils". + + :term:`FONT_PACKAGES` + When inheriting the :ref:`ref-classes-fontcache` class, this variable + identifies packages containing font files that need to be cached by + Fontconfig. By default, the :ref:`ref-classes-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 :term:`TARGET_CFLAGS` and :term:`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, :term:`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:`GIR_EXTRA_LIBS_PATH` + Allows to specify an extra search path for ``.so`` files + in GLib related recipes using GObject introspection, + and which do not compile without this setting. + See the ":ref:`dev-manual/gobject-introspection:enabling gobject introspection support`" + section for details. + + :term:`GITDIR` + The directory in which a local copy of a Git repository is stored + when it is cloned. + + :term:`GITHUB_BASE_URI` + When inheriting the :ref:`ref-classes-github-releases` + class, specifies the base URL for fetching releases for the github + project you wish to fetch sources from. The default value is as follows:: + + GITHUB_BASE_URI ?= "https://github.com/${BPN}/${BPN}/releases/" + + :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 :term:`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:`GO_IMPORT` + When inheriting the :ref:`ref-classes-go` class, this mandatory variable + sets the import path for the Go package that will be created for the code + to build. If you have a ``go.mod`` file in the source directory, this + typically matches the path in the ``module`` line in this file. + + Other Go programs importing this package will use this path. + + Here is an example setting from the + :yocto_git:`go-helloworld_0.1.bb </poky/tree/meta/recipes-extended/go-examples/go-helloworld_0.1.bb>` + recipe:: + + GO_IMPORT = "golang.org/x/example" + + :term:`GO_INSTALL` + When inheriting the :ref:`ref-classes-go` class, this optional variable + specifies which packages in the sources should be compiled and + installed in the Go build space by the + `go install <https://go.dev/ref/mod#go-install>`__ command. + + Here is an example setting from the + :oe_git:`crucible </meta-openembedded/tree/meta-oe/recipes-support/crucible/>` + recipe:: + + GO_INSTALL = "\ + ${GO_IMPORT}/cmd/crucible \ + ${GO_IMPORT}/cmd/habtool \ + " + + By default, :term:`GO_INSTALL` is defined as:: + + GO_INSTALL ?= "${GO_IMPORT}/..." + + The ``...`` wildcard means that it will catch all + packages found in the sources. + + See the :term:`GO_INSTALL_FILTEROUT` variable for + filtering out unwanted packages from the ones + found from the :term:`GO_INSTALL` value. + + :term:`GO_INSTALL_FILTEROUT` + When using the Go "vendor" mechanism to bring in dependencies for a Go + package, the default :term:`GO_INSTALL` setting, which uses the ``...`` + wildcard, will include the vendored packages in the build, which produces + incorrect results. + + There are also some Go packages that are structured poorly, so that the + ``...`` wildcard results in building example or test code that should not + be included in the build, or could fail to build. + + This optional variable allows for filtering out a subset of the sources. + It defaults to excluding everything under the ``vendor`` subdirectory + under package's main directory. This is the normal location for vendored + packages, but it can be overridden by a recipe to filter out other + subdirectories if needed. + + :term:`GO_WORKDIR` + When using Go Modules, the current working directory must be the directory + containing the ``go.mod`` file, or one of its subdirectories. When the + ``go`` tool is used, it will automatically look for the ``go.mod`` file + in the Go working directory or in any parent directory, but not in + subdirectories. + + When using the :ref:`ref-classes-go-mod` class to use Go modules, + the optional :term:`GO_WORKDIR` variable, defaulting to the value + of :term:`GO_IMPORT`, allows to specify a different Go working directory. + + :term:`GROUPADD_PARAM` + When inheriting the :ref:`ref-classes-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" + + More than one group can be added by separating each set of different + groups' parameters with a semicolon. + + Here is an example adding multiple groups from the ``useradd-example.bb`` + file in the ``meta-skeleton`` layer:: + + GROUPADD_PARAM:${PN} = "-g 880 group1; -g 890 group2" + + For information on the standard Linux shell command + ``groupadd``, see https://linux.die.net/man/8/groupadd. + + :term:`GROUPMEMS_PARAM` + When inheriting the :ref:`ref-classes-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 https://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:`ref-classes-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 :term:`GRUB_OPTS` variable is optional. See the + :ref:`ref-classes-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 :term:`GRUB_TIMEOUT` variable is optional. See the + :ref:`ref-classes-grub-efi` class for more information + on how this variable is used. + + :term:`GTKIMMODULES_PACKAGES` + When inheriting the :ref:`ref-classes-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:`HGDIR` + See :term:`bitbake:HGDIR` in the BitBake manual. + + :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 :term:`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. :term:`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:`HOST_VENDOR` + Specifies the name of the vendor. :term:`HOST_VENDOR` is normally the + same as :term:`TARGET_VENDOR`. + + :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 :term:`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 + :term:`HOSTTOOLS_NONFATAL` is not found on the build host. Thus, you can + use :term:`HOSTTOOLS_NONFATAL` to filter optional host tools. + + :term:`ICECC_CLASS_DISABLE` + Identifies user classes that you do not want the Icecream distributed + compile support to consider. This variable is used by the + :ref:`ref-classes-icecc` class. You set this variable in + your ``local.conf`` file. + + When you list classes using this variable, the recipes inheriting + those classes will not benefit from distributed compilation across + remote hosts. Instead they will be built locally. + + :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:`ref-classes-icecc`" + 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:`ref-classes-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 + :oe_git:`icecc-create-env_0.1.bb + </openembedded-core/tree/meta/recipes-devtools/icecc-create-env/icecc-create-env_0.1.bb>` + recipe, which is a modified version and not the one that comes with + ``icecream``. + + :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 :term:`ICECC_PARALLEL_MAKE` to achieve optimal + performance. + + If you do not set :term:`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 :term:`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:`ref-classes-icecc` class attempts + to define it by locating ``icecc`` using ``which``. + + :term:`ICECC_RECIPE_DISABLE` + Identifies user recipes that you do not want the Icecream distributed + compile support to consider. This variable is used by the + :ref:`ref-classes-icecc` class. You set this variable in + your ``local.conf`` file. + + When you list recipes using this variable, you are excluding them + from distributed compilation across remote hosts. Instead they will + be built locally. + + :term:`ICECC_RECIPE_ENABLE` + 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:`ref-classes-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_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/wic: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_BUILDINFO_FILE` + When using the :ref:`ref-classes-image-buildinfo` class, + specifies the file in the image to write the build information into. The + default value is "``${sysconfdir}/buildinfo``". + + :term:`IMAGE_BUILDINFO_VARS` + When using the :ref:`ref-classes-image-buildinfo` class, + specifies the list of variables to include in the `Build Configuration` + section of the output file (as a space-separated list). Defaults to + ":term:`DISTRO` :term:`DISTRO_VERSION`". + + :term:`IMAGE_CLASSES` + A list of classes that all images should inherit. This is typically used + to enable functionality across all image recipes. + + Classes specified in :term:`IMAGE_CLASSES` must be located in the + ``classes-recipe/`` or ``classes/`` subdirectories. + + :term:`IMAGE_CMD` + Specifies the command to create the image file for a specific image + type, which corresponds to the value 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=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.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:`ref-classes-image_types` + class file, which is ``meta/classes-recipe/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 :term:`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_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/wic: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_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/customizing-images: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 + :term:`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 :term:`IMAGE_FSTYPES` inside the recipe, you must set + :term:`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 :term:`IMAGE_FSTYPES` variable. + + :term:`IMAGE_INSTALL` + Used by recipes to specify the packages to install into an image + through the :ref:`ref-classes-image` class. Use the + :term:`IMAGE_INSTALL` variable with care to avoid ordering issues. + + Image recipes set :term:`IMAGE_INSTALL` to specify the packages to + install into an image through :ref:`ref-classes-image`. Additionally, + there are "helper" classes such as the :ref:`ref-classes-core-image` + class which can take lists used with :term:`IMAGE_FEATURES` and turn + them into auto-generated entries in :term:`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 <ref-manual/images:images>` + image, do not use the :term:`IMAGE_INSTALL` variable to specify + packages for installation. Instead, use the + :term:`PACKAGE_INSTALL` variable, which + allows the initial RAM filesystem (:term:`Initramfs`) recipe to use a + fixed set of packages and not be affected by :term:`IMAGE_INSTALL`. + For information on creating an :term:`Initramfs`, see the + ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" + section in the Yocto Project Development Tasks Manual. + + - Using :term:`IMAGE_INSTALL` with the + :ref:`+= <bitbake-user-manual/bitbake-user-manual-metadata:appending (+=) and prepending (=+) with spaces>` + 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 + :ref:`ref-classes-core-image` sets :term:`IMAGE_INSTALL` to a + default value using the + :ref:`?= <bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>` + operator, using a ``+=`` operation against :term:`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 :term:`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:`IMAGE_MACHINE_SUFFIX` variables:: + + IMAGE_LINK_NAME ?= "${IMAGE_BASENAME}${IMAGE_MACHINE_SUFFIX}" + + .. note:: + + It is possible to set this to "" to disable symlink creation, + however, you also need to set :term:`IMAGE_NAME` to still have + a reasonable value e.g.:: + + IMAGE_LINK_NAME = "" + IMAGE_NAME = "${IMAGE_BASENAME}${IMAGE_MACHINE_SUFFIX}${IMAGE_VERSION_SUFFIX}" + + :term:`IMAGE_MACHINE_SUFFIX` + Specifies the by default machine-specific suffix for image file names + (before the extension). The default value is set as follows:: + + IMAGE_MACHINE_SUFFIX ??= "-${MACHINE}" + + The default :term:`DEPLOY_DIR_IMAGE` already has a :term:`MACHINE` + subdirectory, so you may find it unnecessary to also include this suffix + in the name of every image file. If you prefer to remove the suffix you + can set this variable to an empty string:: + + IMAGE_MACHINE_SUFFIX = "" + + (Not to be confused with :term:`IMAGE_NAME_SUFFIX`.) + + :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:`rootfs-postcommands <ref-classes-rootfs*>` class defines the manifest + file as follows:: + + IMAGE_MANIFEST ="${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.manifest" + + The location is + derived using the :term:`IMGDEPLOYDIR` + 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. By default + this variable is set using the :term:`IMAGE_LINK_NAME`, and + :term:`IMAGE_VERSION_SUFFIX` variables:: + + IMAGE_NAME ?= "${IMAGE_LINK_NAME}${IMAGE_VERSION_SUFFIX}" + + :term:`IMAGE_NAME_SUFFIX` + Suffix used for the image output filename --- 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 :term:`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 + :term:`IMAGE_ROOTFS_SIZE` and :term:`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 + :term:`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 :term:`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:`ref-classes-package_deb`, :ref:`ref-classes-package_rpm`, + or :ref:`ref-classes-package_ipk` class. + + The :ref:`ref-classes-populate-sdk-*` and :ref:`ref-classes-image` + classes use the :term:`IMAGE_PKGTYPE` for packaging up images and SDKs. + + You should not set the :term:`IMAGE_PKGTYPE` manually. Rather, the + variable is set indirectly through the appropriate + :ref:`package_* <ref-classes-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 spaces:: + + 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 spaces:: + + 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 :term:`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:`ref-classes-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 + - erofs + - erofs-lz4 + - erofs-lz4hc + - 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-recipe/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:`IMGDEPLOYDIR` + When inheriting the :ref:`ref-classes-image` class directly or + through the :ref:`ref-classes-core-image` class, the + :term:`IMGDEPLOYDIR` points to a temporary work area for deployed files + that is set in the ``image`` class as follows:: + + IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" + + Recipes inheriting the :ref:`ref-classes-image` class should copy + files to be deployed into :term:`IMGDEPLOYDIR`, and the class will take + care of copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. + + :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 (if set globally), or from an image (if set locally + in an image recipe). + + When the variable is set globally, 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. + Most of the time this does not allow a feasible build (because it becomes impossible + to satisfy build time dependencies), so the recommended way to + implement license restrictions is to set the variable in specific + image recipes where the restrictions must apply. That way there + are no build time restrictions, but the license check is still + performed when the image's filesystem is assembled from packages. + + There is some support for wildcards in this variable's value, + however it is restricted to specific licenses. Currently only + these wildcards are allowed and expand as follows: + + - ``AGPL-3.0*"``: ``AGPL-3.0-only``, ``AGPL-3.0-or-later`` + - ``GPL-3.0*``: ``GPL-3.0-only``, ``GPL-3.0-or-later`` + - ``LGPL-3.0*``: ``LGPL-3.0-only``, ``LGPL-3.0-or-later`` + + .. 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. + + :term:`INCOMPATIBLE_LICENSE_EXCEPTIONS` + Specifies a space-separated list of package and license pairs that + are allowed to be used even if the license is specified in + :term:`INCOMPATIBLE_LICENSE`. The package and license pairs are + separated using a colon. Example:: + + INCOMPATIBLE_LICENSE_EXCEPTIONS = "gdbserver:GPL-3.0-only gdbserver:LGPL-3.0-only" + + :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 :term:`INHERIT` in individual recipes. + Classes inherited using :term:`INHERIT` must be located in the + ``classes-global/`` or ``classes/`` subdirectories. + + For more information on :term:`INHERIT`, see the + :ref:`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. + + Classes specified in :term:`INHERIT_DISTRO` must be located in the + ``classes-global/`` or ``classes/`` subdirectories. + + The default value of the variable is set as follows in the + ``meta/conf/distro/defaultsetup.conf`` file:: + + INHERIT_DISTRO ?= "debian devshell sstate license remove-libtool create-spdx" + + :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 :term:`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 :term:`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 + :term:`INHIBIT_SYSROOT_STRIP` variable to "1" in your recipe, you inhibit + this stripping. + + If you want to use this variable, include the :ref:`ref-classes-staging` + class. This class uses a ``sys_strip()`` function to test for the variable + and acts accordingly. + + .. note:: + + Use of the :term:`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, there are other files + needed for the build that are not strippable. + + :term:`INIT_MANAGER` + Specifies the system init manager to use. Available options are: + + - ``sysvinit`` + - ``systemd`` + - ``mdev-busybox`` + + With ``sysvinit``, the init manager is set to + :wikipedia:`SysVinit <Init#SysV-style>`, the traditional UNIX init + system. This is the default choice in the Poky distribution, together with + the Udev device manager (see the ":ref:`device-manager`" section). + + With ``systemd``, the init manager becomes :wikipedia:`systemd <Systemd>`, + which comes with the :wikipedia:`udev <Udev>` device manager. + + With ``mdev-busybox``, the init manager becomes the much simpler BusyBox + init, together with the BusyBox mdev device manager. This is the simplest + and lightest solution, and probably the best choice for low-end systems + with a rather slow CPU and a limited amount of RAM. + + More concretely, this is used to include + ``conf/distro/include/init-manager-${INIT_MANAGER}.inc`` into the global + configuration. You can have a look at the + :yocto_git:`meta/conf/distro/include/init-manager-*.inc </poky/tree/meta/conf/distro/include>` + files for more information, and also the ":ref:`init-manager`" + section in the Yocto Project Development Tasks Manual. + + :term:`INITRAMFS_DEPLOY_DIR_IMAGE` + Indicates the deploy directory used by :ref:`ref-tasks-bundle_initramfs` + where the :term:`INITRAMFS_IMAGE` will be fetched from. This variable is + set by default to ``${DEPLOY_DIR_IMAGE}`` in the + :ref:`ref-classes-kernel` class and it's only meant to be changed when + building an :term:`Initramfs` image from a separate multiconfig via + :term:`INITRAMFS_MULTICONFIG`. + + :term:`INITRAMFS_FSTYPES` + Defines the format for the output image of an initial RAM filesystem + (:term:`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 + :term:`Initramfs` mechanism, as opposed to the initial RAM filesystem + :wikipedia:`initrd <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 (:term:`Initramfs`) + image. In other words, the :term:`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 + :term:`Initramfs` image recipe you provide should set + :term:`IMAGE_FSTYPES` to + :term:`INITRAMFS_FSTYPES`. + + An :term:`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 :term:`Initramfs` recipe. To select this sample recipe as + the one built to provide the :term:`Initramfs` image, set :term:`INITRAMFS_IMAGE` + to "core-image-minimal-initramfs". + + You can also find more information by referencing the + ``meta-poky/conf/templates/default/local.conf.sample.extended`` + configuration file in the Source Directory, the :ref:`ref-classes-image` + class, and the :ref:`ref-classes-kernel` class to see how to use the + :term:`INITRAMFS_IMAGE` variable. + + If :term:`INITRAMFS_IMAGE` is empty, which is the default, then no + :term:`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 :term:`Initramfs` + image, see the ":ref:`dev-manual/building: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 (:term:`Initramfs`) + image. This makes use of the + :term:`CONFIG_INITRAMFS_SOURCE` kernel + feature. + + .. note:: + + Bundling the :term:`Initramfs` with the kernel conflates the code in the + :term:`Initramfs` with the GPLv2 licensed Linux kernel binary. Thus only GPLv2 + compatible software may be part of a bundled :term:`Initramfs`. + + .. note:: + + Using an extra compilation pass to bundle the :term:`Initramfs` avoids a + circular dependency between the kernel recipe and the :term:`Initramfs` + recipe should the :term:`Initramfs` include kernel modules. Should that be + the case, the :term:`Initramfs` recipe depends on the kernel for the + kernel modules, and the kernel depends on the :term:`Initramfs` recipe + since the :term:`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 + :term:`Initramfs` specified in :term:`INITRAMFS_IMAGE` bundled within:: + + INITRAMFS_IMAGE_BUNDLE = "1" + + By default, the :ref:`ref-classes-kernel` class sets this variable to a + null string as follows:: + + INITRAMFS_IMAGE_BUNDLE ?= "" + + .. note:: + + You must set the :term:`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 </poky/tree/meta-poky/conf/templates/default/local.conf.sample.extended>` + file for additional information. Also, for information on creating an + :term:`Initramfs`, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section + in the Yocto Project Development Tasks Manual. + + :term:`INITRAMFS_IMAGE_NAME` + + This value needs to stay in sync with :term:`IMAGE_LINK_NAME`, but with + :term:`INITRAMFS_IMAGE` instead of :term:`IMAGE_BASENAME`. The default value + is set as follows: + + INITRAMFS_IMAGE_NAME ?= "${@['${INITRAMFS_IMAGE}${IMAGE_MACHINE_SUFFIX}', ''][d.getVar('INITRAMFS_IMAGE') == '']}" + + That is, if :term:`INITRAMFS_IMAGE` is set, the value of + :term:`INITRAMFS_IMAGE_NAME` will be set based upon + :term:`INITRAMFS_IMAGE` and :term:`IMAGE_MACHINE_SUFFIX`. + + + :term:`INITRAMFS_LINK_NAME` + The link name of the initial RAM filesystem image. This variable is + set in the ``meta/classes-recipe/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_MULTICONFIG` + Defines the multiconfig to create a multiconfig dependency to be used by + the :ref:`ref-classes-kernel` class. + + This allows the kernel to bundle an :term:`INITRAMFS_IMAGE` coming from + a separate multiconfig, this is meant to be used in addition to :term:`INITRAMFS_DEPLOY_DIR_IMAGE`. + + For more information on how to bundle an :term:`Initramfs` image from a separate + multiconfig see the ":ref:`dev-manual/building:Bundling an Initramfs Image From a Separate Multiconfig`" + section in the Yocto Project Development Tasks Manual. + + :term:`INITRAMFS_NAME` + The base name of the initial RAM filesystem image. This variable is + set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as + follows:: + + INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" + + See :term:`KERNEL_ARTIFACT_NAME` for additional information. + + :term:`INITRD` + Indicates list of filesystem images to concatenate and use as an + initial RAM disk (``initrd``). + + The :term:`INITRD` variable is an optional variable used with the + :ref:`ref-classes-image-live` class. + + :term:`INITRD_IMAGE` + When building a "live" bootable image (i.e. when + :term:`IMAGE_FSTYPES` contains "live"), + :term:`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:`ref-classes-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 :ref:`ref-classes-update-rc.d`. + 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 :ref:`ref-classes-update-rc.d`. + 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:`ref-classes-update-rc.d` class. + + The value in :term:`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:`ref-classes-insane`" 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 :term:`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 :term:`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. :term:`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 is located in the + BSP layer for a given machine. For example, the append file for the + Beaglebone and generic versions of both 32 and 64-bit IA + machines (``meta-yocto-bsp``) is named + ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_6.1.bbappend``. + Here are the related statements from that append file:: + + KBRANCH:genericx86 = "v6.1/standard/base" + KBRANCH:genericx86-64 = "v6.1/standard/base" + KBRANCH:beaglebone-yocto = "v6.1/standard/beaglebone" + + The :term:`KBRANCH` statements + identify the kernel branch to use when building for each supported + BSP. + + :term:`KBUILD_DEFCONFIG` + When used with the :ref:`ref-classes-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 + :term:`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:<machine> ?= "defconfig_file" + + Here is an example from a "raspberrypi2" :term:`MACHINE` 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 :term:`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:`KCONFIG_MODE` + When used with the :ref:`ref-classes-kernel-yocto` + class, specifies the kernel configuration values to use for options + not specified in the provided ``defconfig`` file. Valid options are:: + + KCONFIG_MODE = "alldefconfig" + KCONFIG_MODE = "allnoconfig" + + In ``alldefconfig`` mode the options not explicitly specified will be + assigned their Kconfig default value. In ``allnoconfig`` mode the + options not explicitly specified will be disabled in the kernel + config. + + In case :term:`KCONFIG_MODE` is not set the behaviour will depend on where + the ``defconfig`` file is coming from. An "in-tree" ``defconfig`` file + will be handled in ``alldefconfig`` mode, a ``defconfig`` file placed + in ``${WORKDIR}`` through a meta-layer will be handled in + ``allnoconfig`` mode. + + An "in-tree" ``defconfig`` file can be selected via the + :term:`KBUILD_DEFCONFIG` variable. :term:`KCONFIG_MODE` does not need to + be explicitly set. + + A ``defconfig`` file compatible with ``allnoconfig`` mode can be + generated by copying the ``.config`` file from a working Linux kernel + build, renaming it to ``defconfig`` and placing it into the Linux + kernel ``${WORKDIR}`` through your meta-layer. :term:`KCONFIG_MODE` does + not need to be explicitly set. + + A ``defconfig`` file compatible with ``alldefconfig`` mode can be + generated using the + :ref:`ref-tasks-savedefconfig` + task and placed into the Linux kernel ``${WORKDIR}`` through your + meta-layer. Explicitely set :term:`KCONFIG_MODE`:: + + KCONFIG_MODE = "alldefconfig" + + :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` and + :term:`KERNEL_IMAGETYPES` variables. + + :term:`KERNEL_ARTIFACT_NAME` + Specifies the name of all of the build artifacts. You can change the + name of the artifacts by changing the :term:`KERNEL_ARTIFACT_NAME` + variable. + + The value of :term:`KERNEL_ARTIFACT_NAME`, which is set in the + ``meta/classes-recipe/kernel-artifact-names.bbclass`` file, has the + following default value:: + + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}${IMAGE_MACHINE_SUFFIX}${IMAGE_VERSION_SUFFIX}" + + See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, :term:`IMAGE_MACHINE_SUFFIX` + and :term:`IMAGE_VERSION_SUFFIX` variables for additional information. + + :term:`KERNEL_CLASSES` + A list of classes defining kernel image types that the + :ref:`ref-classes-kernel` class should inherit. You typically + append this variable to enable extended image types. An example is + ":ref:`ref-classes-kernel-fitimage`", which enables + FIT image support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. + You can register custom kernel image types with the + :ref:`ref-classes-kernel` class using this variable. + + :term:`KERNEL_DANGLING_FEATURES_WARN_ONLY` + When kernel configuration fragments are missing for some + :term:`KERNEL_FEATURES` specified by layers or BSPs, + building and configuring the kernel stops with an error. + + You can turn these errors into warnings by setting the + following in ``conf/local.conf``:: + + KERNEL_DANGLING_FEATURES_WARN_ONLY = "1" + + You will still be warned that runtime issues may occur, + but at least the kernel configuration and build process will + be allowed to continue. + + :term:`KERNEL_DEBUG_TIMESTAMPS` + If set to "1", enables timestamping functionality during building + the kernel. The default is "0" to disable this for reproducibility + reasons. + + :term:`KERNEL_DEPLOY_DEPEND` + Provides a means of controlling the dependency of an image recipe + on the kernel. The default value is "virtual/kernel:do_deploy", + however for a small initramfs image or other images that do not + need the kernel, this can be set to "" in the image recipe. + + :term:`KERNEL_DEVICETREE` + Specifies the name of the generated Linux kernel device tree (i.e. + the ``.dtb``) file. + + .. note:: + + There is legacy support 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:`ref-classes-kernel-devicetree` + class must be inherited. + + :term:`KERNEL_DEVICETREE_BUNDLE` + When set to "1", this variable allows to bundle the Linux kernel + and the Device Tree Binary together in a single file. + + This feature is currently only supported on the "arm" (32 bit) + architecture. + + This variable is set to "0" by default by the + :ref:`ref-classes-kernel-devicetree` class. + + :term:`KERNEL_DTB_LINK_NAME` + The link name of the kernel device tree binary (DTB). This variable + is set in the ``meta/classes-recipe/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-recipe/kernel-artifact-names.bbclass`` file as + follows:: + + KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + See :term:`KERNEL_ARTIFACT_NAME` for additional information. + + :term:`KERNEL_DTBDEST` + This variable, used by the :ref:`ref-classes-kernel-devicetree` + class, allows to change the installation directory of the DTB + (Device Tree Binary) files. + + It is set by default to "${KERNEL_IMAGEDEST}" by the + :ref:`ref-classes-kernel` class. + + :term:`KERNEL_DTBVENDORED` + This variable, used by the :ref:`ref-classes-kernel-devicetree`, + allows to ignore vendor subdirectories when installing DTB + (Device Tree Binary) files, when it is set to "false". + + To keep vendor subdirectories, set this variable to "true". + + It is set by default to "false" by the :ref:`ref-classes-kernel` class. + + :term:`KERNEL_DTC_FLAGS` + Specifies the ``dtc`` flags that are passed to the Linux kernel build + system when generating the device trees (via ``DTC_FLAGS`` environment + variable). + + In order to use this variable, the :ref:`ref-classes-kernel-devicetree` + class must be inherited. + + :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 :term:`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 :term:`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-recipe/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-recipe/kernel-artifact-names.bbclass`` + file as follows:: + + KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + See :term:`KERNEL_ARTIFACT_NAME` for additional information. + + :term:`KERNEL_IMAGE_LINK_NAME` + The link name for the kernel image. This variable is set in the + ``meta/classes-recipe/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 + :term:`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. + + :term:`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-recipe/kernel-artifact-names.bbclass`` file as follows:: + + KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + See :term:`KERNEL_ARTIFACT_NAME` for additional information. + + :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. + + To build additional kernel image types, use :term:`KERNEL_IMAGETYPES`. + + :term:`KERNEL_IMAGETYPES` + Lists additional types of kernel images to build for a device in addition + to image type specified in :term:`KERNEL_IMAGETYPE`. Usually set by the + machine configuration files. + + :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 :term:`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 :term:`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_* <module_conf>` variable. + + :term:`KERNEL_PACKAGE_NAME` + Specifies the base name of the kernel packages, such as "kernel" + in the kernel packages such as "kernel-modules", "kernel-image" and + "kernel-dbg". + + The default value for this variable is set to "kernel" by the + :ref:`ref-classes-kernel` class. + + :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:`ref-classes-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 :term:`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:`ref-classes-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 :term:`KERNEL_SRC` variable. Both variables are common variables + used by external Makefiles to point to the kernel source directory. + + :term:`KERNEL_STRIP` + Allows to specific which ``strip`` command to use to strip the kernel + binary, typically either GNU binutils ``strip`` or ``llvm-strip``. + + :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 effect 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. + :term:`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 :term:`KERNELDEPMODDEPEND` variable in your + :term:`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 :term:`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 :term:`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 :term:`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:`ref-classes-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:`LAYERDIR_RE` + See :term:`bitbake:LAYERDIR_RE` in the BitBake manual. + + :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` + See :term:`bitbake:LAYERSERIES_COMPAT` in the BitBake 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 :term:`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:`ref-classes-debian` class applies its + naming policy to given a recipe that packages multiple libraries. + + This variable works in conjunction with the :ref:`ref-classes-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/licenses: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 there are + multiple licenses for 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 = "LGPL-2.1-only | GPL-3.0-only" + LICENSE = "MPL-1.0 & LGPL-2.1-only" + LICENSE = "GPL-2.0-or-later" + + 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 & GPL-2.0-only" + LICENSE:${PN} = "GPL-2.0.only" + LICENSE:${PN}-doc = "GFDL-1.2" + + :term:`LICENSE_CREATE_PACKAGE` + Setting :term:`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/licenses:providing license text`" + section in the Yocto Project Development Tasks Manual. + + :term:`LICENSE_FLAGS` + Specifies additional flags for a recipe you must allow through + :term:`LICENSE_FLAGS_ACCEPTED` in + order for 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/licenses:enabling commercially licensed recipes`" + section in the Yocto Project Development Tasks Manual. + + :term:`LICENSE_FLAGS_ACCEPTED` + Lists license flags that when specified in + :term:`LICENSE_FLAGS` within a recipe should not + prevent that recipe from being built. For more information, see the + ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" + section in the Yocto Project Development Tasks Manual. + + :term:`LICENSE_FLAGS_DETAILS` + Adds details about a flag in :term:`LICENSE_FLAGS`. This way, + if such a flag is not accepted through :term:`LICENSE_FLAGS_ACCEPTED`, + the error message will be more informative, containing the specified + extra details. + + For example, a recipe with an EULA may set:: + + LICENSE_FLAGS = "FooBar-EULA" + LICENSE_FLAGS_DETAILS[FooBar-EULA] = "For further details, see https://example.com/eula." + + If ``Foobar-EULA`` isn't in :term:`LICENSE_FLAGS_ACCEPTED`, the + error message is more useful:: + + Has a restricted license 'FooBar-EULA' which is not listed in your LICENSE_FLAGS_ACCEPTED. + For further details, see https://example.com/eula. + + :term:`LICENSE_PATH` + Path to additional licenses used during the build. By default, the + OpenEmbedded build system uses :term:`COMMON_LICENSE_DIR` to define the + directory that holds common license text used during the build. The + :term:`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 :term:`LINUX_KERNEL_TYPE`, it defaults to + "standard". Together with :term:`KMACHINE`, the + :term:`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 :term:`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 + :term:`MACHINE` in the ``local.conf`` file found in the + :term:`Build Directory`. By default, :term:`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 :term:`MACHINE` is set to "qemux86", the corresponding + ``qemux86.conf`` machine configuration file 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" + + 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 :term:`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 :term:`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 + :term:`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 :term:`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 :term:`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 :term:`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` + A list of space-separated features to be added to + :term:`MACHINE_FEATURES` if not also present in + :term:`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 + :ref:`backfilled <ref-features-backfill>` for all machine configurations. + + :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` + A list of space-separated features from :term:`MACHINE_FEATURES_BACKFILL` + that should not be :ref:`backfilled <ref-features-backfill>` (i.e. added + to :term:`MACHINE_FEATURES`) during the build. + + This corresponds to an opt-out mechanism. When new default machine + features are introduced, machine definition maintainers can review + (`consider`) them and decide to exclude them from the + :ref:`backfilled <ref-features-backfill>` features. Therefore, the + combination of :term:`MACHINE_FEATURES_BACKFILL` and + :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` makes it possible to + add new default features without breaking existing machine definitions. + + :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 :term:`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 :term:`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 + :term:`MACHINEOVERRIDES` is simply that it is included in the default + value of :term:`OVERRIDES`. + + :term:`MAINTAINER` + The email address of the distribution maintainer. + + :term:`MESON_BUILDTYPE` + Value of the Meson ``--buildtype`` argument used by the + :ref:`ref-classes-meson` class. It defaults to ``debug`` if + :term:`DEBUG_BUILD` is set to "1", and ``plain`` otherwise. + + See `Meson build options <https://mesonbuild.com/Builtin-options.html>`__ + for the values you could set in a recipe. Values such as ``plain``, + ``debug``, ``debugoptimized``, ``release`` and ``minsize`` allow + you to specify the inclusion of debugging symbols and the compiler + optimizations (none, performance or size). + + :term:`MESON_TARGET` + A variable for the :ref:`ref-classes-meson` class, allowing to choose + a Meson target to build in :ref:`ref-tasks-compile`. Otherwise, the + default targets are built. + + :term:`METADATA_BRANCH` + The branch currently checked out for the OpenEmbedded-Core layer (path + determined by :term:`COREBASE`). + + :term:`METADATA_REVISION` + The revision currently checked out for the OpenEmbedded-Core layer (path + determined by :term:`COREBASE`). + + :term:`MIME_XDG_PACKAGES` + The current implementation of the :ref:`ref-classes-mime-xdg` + class cannot detect ``.desktop`` files installed through absolute + symbolic links. Use this setting to make the class create post-install + and post-remove scripts for these packages anyway, to invoke the + ``update-destop-database`` command. + + :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 :term:`MIRRORS` in that order. + + The default value for :term:`MIRRORS` is defined in the + ``meta/classes-global/mirrors.bbclass`` file in the core metadata layer. + + :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 name (e.g. the :term:`BPN` variable). + :term:`MLPREFIX` gets set when a prefix has been added to :term:`PN`. + + .. note:: + + The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation + is historical and comes from a time when ":ref:`ref-classes-nativesdk`" + was a suffix rather than a prefix on the recipe name. When + ":ref:`ref-classes-nativesdk`" was turned into a prefix, it made sense + to set :term:`MLPREFIX` for it as well. + + To help understand when :term:`MLPREFIX` might be needed, consider when + :term:`BBCLASSEXTEND` is used to provide a :ref:`ref-classes-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" + + :term:`module_autoload` + This variable has been replaced by the :term:`KERNEL_MODULE_AUTOLOAD` + variable. You should replace all occurrences of :term:`module_autoload` + with additions to :term:`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. + + :term:`module_conf` + Specifies `modprobe.d <https://linux.die.net/man/5/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_PROBECONF` + 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 :term:`module_conf`. + + Including :term:`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-recipe/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-recipe/kernel-artifact-names.bbclass`` file as follows:: + + MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" + + See :term:`KERNEL_ARTIFACT_NAME` for additional information. + + :term:`MOUNT_BASE` + On non-systemd systems (where ``udev-extraconf`` is being used), + specifies the base directory for auto-mounting filesystems. The + default value is "/run/media". + + :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:`ref-classes-cross-canadian`) modify the + :term:`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. There are packages, 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. + :term:`NO_GENERIC_LICENSE` is used to allow copying a license that does + not exist in common licenses. + + The following example shows how to add :term:`NO_GENERIC_LICENSE` to a + recipe:: + + NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source" + + Here 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 + :term:`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. + + This variable is only supported when using the IPK and RPM + packaging backends. DEB is not supported. + + 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 + :term:`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:`NON_MULTILIB_RECIPES` + A list of recipes that should not be built for multilib. OE-Core's + ``multilib.conf`` file defines a reasonable starting point for this + list with:: + + NON_MULTILIB_RECIPES = "grub grub-efi make-mod-scripts ovmf u-boot" + + :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:`ref-classes-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-recipe/binconfig.bbclass`` in the + :term:`Source Directory` for details on how this class + applies these additional sed command arguments. + + :term:`OECMAKE_GENERATOR` + A variable for the :ref:`ref-classes-cmake` class, allowing to choose + which back-end will be generated by CMake to build an application. + + By default, this variable is set to ``Ninja``, which is faster than GNU + make, but if building is broken with Ninja, a recipe can use this + variable to use GNU make instead:: + + OECMAKE_GENERATOR = "Unix Makefiles" + + :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 + :term:`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/development-shell:using a development shell`" section in + the Yocto Project Development Tasks Manual. + + You can use the following values for the :term:`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 :term:`OEROOT` variable resolves to the directory that + contains the script. + + For additional information on how this variable is used, see the + initialization script. + + :term:`OEQA_REPRODUCIBLE_TEST_PACKAGE` + Set the package manager(s) for build reproducibility testing. + See :yocto_git:`reproducible.py </poky/tree/meta/lib/oeqa/selftest/cases/reproducible.py>` + and :doc:`/test-manual/reproducible-builds`. + + :term:`OEQA_REPRODUCIBLE_TEST_TARGET` + Set build target for build reproducibility testing. By default + all available recipes are compiled with "bitbake world", see also :term:`EXCLUDE_FROM_WORLD` + and :doc:`/test-manual/reproducible-builds`. + + :term:`OEQA_REPRODUCIBLE_TEST_SSTATE_TARGETS` + Set build targets which can be rebuilt using :ref:`shared state <overview-manual/concepts:shared state cache>` + when running build reproducibility tests. See :doc:`/test-manual/reproducible-builds`. + + :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:`OPKG_MAKE_INDEX_EXTRA_PARAMS` + Specifies extra parameters for the ``opkg-make-index`` command. + + :term:`OVERLAYFS_ETC_DEVICE` + When the :ref:`ref-classes-overlayfs-etc` class is + inherited, specifies the device to be mounted for the read/write + layer of ``/etc``. There is no default, so you must set this if you + wish to enable :ref:`ref-classes-overlayfs-etc`, for + example, assuming ``/dev/mmcblk0p2`` was the desired device:: + + OVERLAYFS_ETC_DEVICE = "/dev/mmcblk0p2" + + :term:`OVERLAYFS_ETC_EXPOSE_LOWER` + When the :ref:`ref-classes-overlayfs-etc` class is + inherited, if set to "1" then a read-only access to the original + ``/etc`` content will be provided as a ``lower/`` subdirectory of + :term:`OVERLAYFS_ETC_MOUNT_POINT`. The default value is "0". + + :term:`OVERLAYFS_ETC_FSTYPE` + When the :ref:`ref-classes-overlayfs-etc` class is + inherited, specifies the file system type for the read/write + layer of ``/etc``. There is no default, so you must set this if you + wish to enable :ref:`ref-classes-overlayfs-etc`, + for example, assuming the file system is ext4:: + + OVERLAYFS_ETC_FSTYPE = "ext4" + + :term:`OVERLAYFS_ETC_MOUNT_OPTIONS` + When the :ref:`ref-classes-overlayfs-etc` class is + inherited, specifies the mount options for the read-write layer. + The default value is "defaults". + + :term:`OVERLAYFS_ETC_MOUNT_POINT` + When the :ref:`ref-classes-overlayfs-etc` class is + inherited, specifies the parent mount path for the filesystem layers. + There is no default, so you must set this if you wish to enable + :ref:`ref-classes-overlayfs-etc`, for example if the desired path is + "/data":: + + OVERLAYFS_ETC_MOUNT_POINT = "/data" + + :term:`OVERLAYFS_ETC_USE_ORIG_INIT_NAME` + When the :ref:`ref-classes-overlayfs-etc` class is inherited, controls + how the generated init will be named. For more information, see the + :ref:`ref-classes-overlayfs-etc` class documentation. The default value + is "1". + + :term:`OVERLAYFS_MOUNT_POINT` + When inheriting the :ref:`ref-classes-overlayfs` class, + specifies mount point(s) to be used. For example:: + + OVERLAYFS_MOUNT_POINT[data] = "/data" + + The assumes you have a ``data.mount`` systemd unit defined elsewhere in + your BSP (e.g. in ``systemd-machine-units`` recipe) and it is installed + into the image. For more information see :ref:`ref-classes-overlayfs`. + + .. note:: + + Although the :ref:`ref-classes-overlayfs` class is + inherited by individual recipes, :term:`OVERLAYFS_MOUNT_POINT` + should be set in your machine configuration. + + :term:`OVERLAYFS_QA_SKIP` + When inheriting the :ref:`ref-classes-overlayfs` class, + provides the ability to disable QA checks for particular overlayfs + mounts. For example:: + + OVERLAYFS_QA_SKIP[data] = "mount-configured" + + .. note:: + + Although the :ref:`ref-classes-overlayfs` class is + inherited by individual recipes, :term:`OVERLAYFS_QA_SKIP` + should be set in your machine configuration. + + :term:`OVERLAYFS_WRITABLE_PATHS` + When inheriting the :ref:`ref-classes-overlayfs` class, + specifies writable paths used at runtime for the recipe. For + example:: + + OVERLAYFS_WRITABLE_PATHS[data] = "/usr/share/my-custom-application" + + :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 + :term:`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 :term:`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-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 :term:`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 :term:`OVERRIDES` + in the output of the ``bitbake -e`` command. See the + ":ref:`dev-manual/debugging:viewing variable values`" section in the Yocto + Project Development Tasks Manual for more information. + + :term:`P` + The recipe name and version. :term:`P` is comprised of the following:: + + ${PN}-${PV} + + :term:`P4DIR` + See :term:`bitbake:P4DIR` in the BitBake manual. + + :term:`PACKAGE_ADD_METADATA` + This variable defines additional metadata 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/packages: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 :term:`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 :term:`PACKAGE_ARCHS` is "all any + noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}". + + :term:`PACKAGE_BEFORE_PN` + Enables easily adding packages to :term:`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" + + 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:`ref-classes-package`" section. + + :term:`PACKAGE_DEBUG_SPLIT_STYLE` + Determines how to split up and package debug and source information + when creating debugging packages to be used with the GNU Project + Debugger (GDB). In general, based on the value of this variable, + you can combine the source and debug info in a single package, + you can break out the source into a separate package that can be + installed independently, or you can choose to not have the source + packaged at all. + + The possible values of :term:`PACKAGE_DEBUG_SPLIT_STYLE` variable: + + - "``.debug``": All debugging and source info is placed in a single + ``*-dbg`` package; debug symbol files are placed next to the + binary in a ``.debug`` directory so that, if a binary is installed + into ``/bin``, the corresponding debug symbol file is installed + in ``/bin/.debug``. Source files are installed in the same ``*-dbg`` + package under ``/usr/src/debug``. + + - "``debug-file-directory``": As above, all debugging and source info + is placed in a single ``*-dbg`` package; debug symbol files are + placed entirely under the directory ``/usr/lib/debug`` and separated + by the path from where the binary is installed, so that if a binary + is installed in ``/bin``, the corresponding debug symbols are installed + in ``/usr/lib/debug/bin``, and so on. As above, source is installed + in the same package under ``/usr/src/debug``. + + - "``debug-with-srcpkg``": Debugging info is placed in the standard + ``*-dbg`` package as with the ``.debug`` value, while source is + placed in a separate ``*-src`` package, which can be installed + independently. This is the default setting for this variable, + as defined in Poky's ``bitbake.conf`` file. + + - "``debug-without-src``": The same behavior as with the ``.debug`` + setting, but no source is packaged at all. + + .. note:: + + Much of the above package splitting can be overridden via + use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable. + + You can find out more about debugging using GDB by reading the + ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) remotely`" section + in the Yocto Project Development Tasks Manual. + + :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. + + This variable is supported only when using the IPK and RPM + packaging backends. DEB is not supported. + + See the :term:`NO_RECOMMENDATIONS` and the + :term:`BAD_RECOMMENDATIONS` variables for + related information. + + :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 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` variable to specify regular + expressions to match the packages you want to exclude. + + :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 + :term:`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 :term:`PACKAGE_FEED_ARCHS` + variable to allow specific package architectures. If you do + not need to allow 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 :term:`PACKAGE_FEED_URIS`, + :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`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 + :term:`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 :term:`PACKAGE_FEED_URIS`, + :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`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 :term:`PACKAGE_FEED_URIS`, + :term:`PACKAGE_FEED_BASE_PATHS`, and + :term:`PACKAGE_FEED_ARCHS` variables. + + Consider the following example where the :term:`PACKAGE_FEED_URIS`, + :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`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 :term:`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 <ref-manual/images:images>` + image. When working with an initial RAM filesystem (:term:`Initramfs`) image, + use the :term:`PACKAGE_INSTALL` variable. For information on creating an + :term:`Initramfs`, see the ":ref:`dev-manual/building: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 root filesystem + creation time rather than on the target but depends on a native tool + in order to execute, you need to list the tools in + :term:`PACKAGE_WRITE_DEPS`. + + For information on running post-installation scripts, see the + ":ref:`dev-manual/new-recipe: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. :term:`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 :term:`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: + + #. Extra arguments that should be added to :term:`PACKAGECONFIG_CONFARGS` + if the feature is enabled. + + #. Extra arguments that should be added to :term:`PACKAGECONFIG_CONFARGS` + if the feature is disabled. + + #. Additional build dependencies (:term:`DEPENDS`) + that should be added if the feature is enabled. + + #. Additional runtime dependencies (:term:`RDEPENDS`) + that should be added if the feature is enabled. + + #. Additional runtime recommendations + (:term:`RRECOMMENDS`) that should be added if + the feature is enabled. + + #. Any conflicting (that is, mutually exclusive) :term:`PACKAGECONFIG` + settings for this feature. + + Consider the following :term:`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 :term:`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 :term:`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 :term:`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 + :term:`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" + + Consider the following example of a :ref:`ref-classes-cmake` recipe with a systemd service + in which :term:`PACKAGECONFIG` is used to transform the systemd service + into a feature that can be easily enabled or disabled via :term:`PACKAGECONFIG`:: + + example.c + example.service + CMakeLists.txt + + The ``CMakeLists.txt`` file contains:: + + if(WITH_SYSTEMD) + install(FILES ${PROJECT_SOURCE_DIR}/example.service DESTINATION /etc/systemd/systemd) + endif(WITH_SYSTEMD) + + In order to enable the installation of ``example.service`` we need to + ensure that ``-DWITH_SYSTEMD=ON`` is passed to the ``cmake`` command + execution. Recipes that have ``CMakeLists.txt`` generally inherit the + :ref:`ref-classes-cmake` class, that runs ``cmake`` with + :term:`EXTRA_OECMAKE`, which :term:`PACKAGECONFIG_CONFARGS` will be + appended to. Now, knowing that :term:`PACKAGECONFIG_CONFARGS` is + automatically filled with either the first or second element of + :term:`PACKAGECONFIG` flag value, the recipe would be like:: + + inherit cmake + PACKAGECONFIG = "systemd" + PACKAGECONFIG[systemd] = "-DWITH_SYSTEMD=ON,-DWITH_SYSTEMD=OFF" + + A side note to this recipe is to check if ``systemd`` is in fact the used :term:`INIT_MANAGER` + or not:: + + PACKAGECONFIG = "${@'systemd' if d.getVar('INIT_MANAGER') == 'systemd' else ''}" + + :term:`PACKAGECONFIG_CONFARGS` + A space-separated list of configuration options generated from the + :term:`PACKAGECONFIG` setting. + + Classes such as :ref:`ref-classes-autotools` and :ref:`ref-classes-cmake` + use :term:`PACKAGECONFIG_CONFARGS` to pass :term:`PACKAGECONFIG` options + to ``configure`` and ``cmake``, respectively. If you are using + :term:`PACKAGECONFIG` but not a class that handles the + :ref:`ref-tasks-configure` task, then you need to use + :term:`PACKAGECONFIG_CONFARGS` appropriately. + + :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY` + For recipes inheriting the :ref:`ref-classes-packagegroup` class, setting + :term:`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}-src ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} + + During packaging, the :ref:`ref-tasks-package` task + goes through :term:`PACKAGES` and uses the :term:`FILES` + variable corresponding to each package to assign files to the + package. If a file matches the :term:`FILES` variable for more than one + package in :term:`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. + :term:`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 :term:`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 :term:`RDEPENDS`. + + For an example of how to use the :term:`PACKAGES_DYNAMIC` variable when + you are splitting packages, see the + ":ref:`dev-manual/packages: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 build tool command (``make``, + ``ninja`` or more specific build engines, like the Go language one) + during the :ref:`ref-tasks-compile` task, 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 such engines + can run. + + .. note:: + + For software compiled by ``make``, in order for :term:`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 :ref:`ref-tasks-compile` task that result in race conditions, you can clear + the :term:`PARALLEL_MAKE` variable within the recipe as a workaround. For + information on addressing race conditions, see the + ":ref:`dev-manual/debugging: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 :term:`PARALLEL_MAKE` variable is + not set higher than "-j 20". + + For more information on speeding up builds, see the + ":ref:`dev-manual/speeding-up-build:speeding up a build`" + section in the Yocto Project Development Tasks Manual. + + :term:`PARALLEL_MAKEINST` + Extra options passed to the build tool install command + (``make install``, ``ninja install`` or more specific ones) + during the :ref:`ref-tasks-install` task in order to specify + parallel installation. This variable defaults to the value of + :term:`PARALLEL_MAKE`. + + .. note:: + + For software compiled by ``make``, in order for :term:`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 :ref:`ref-tasks-install` task that result in race conditions, you can + clear the :term:`PARALLEL_MAKEINST` variable within the recipe as a + workaround. For information on addressing race conditions, see the + ":ref:`dev-manual/debugging: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. + + :term:`PE` is the default value of the :term:`PKGE` variable. + + :term:`PEP517_WHEEL_PATH` + When used by recipes that inherit the :ref:`ref-classes-python_pep517` + class, denotes the path to ``dist/`` (short for distribution) where the + binary archive ``wheel`` is built. + + :term:`PERSISTENT_DIR` + See :term:`bitbake:PERSISTENT_DIR` in the BitBake manual. + + :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:`ref-classes-pixbufcache` + class, this variable identifies packages that contain the pixbuf + loaders used with ``gdk-pixbuf``. By default, the + :ref:`ref-classes-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 :term:`PKG` variable, you must use a package name override. + + For example, when the :ref:`ref-classes-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/debugging: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 :term:`PKGDESTWORK` location defaults to the following:: + + ${WORKDIR}/pkgdata + + Do not change this default. + + The :ref:`ref-tasks-packagedata` task copies the + package metadata from :term:`PKGDESTWORK` to + :term:`PKGDATA_DIR` to make it available globally. + + :term:`PKGE` + The epoch of the package(s) built by the recipe. By default, :term:`PKGE` + is set to :term:`PE`. + + :term:`PKGR` + The revision of the package(s) built by the recipe. By default, + :term:`PKGR` is set to :term:`PR`. + + :term:`PKGV` + The version of the package(s) built by the recipe. By default, + :term:`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. + + :term:`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 :term:`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 :term:`PN` variable also contains any special suffix + or prefix. For example, using ``bash`` to build packages for the + native machine, :term:`PN` is ``bash-native``. Using ``bash`` to build + packages for the target and for Multilib, :term:`PN` would be ``bash`` + and ``lib64-bash``, respectively. + + :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 spaces:: + + 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 spaces:: + + 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, + :term:`PR` is conventionally reset to "r0". + + .. note:: + + The OpenEmbedded build system does not need the aid of :term:`PR` + to know when to rebuild a recipe. The build system uses the task + :ref:`input checksums <overview-manual/concepts:checksums (signatures)>` along with the + :ref:`stamp <structure-build-tmp-stamps>` and + :ref:`overview-manual/concepts:shared state cache` + mechanisms. + + The :term:`PR` variable primarily becomes significant when a package + manager dynamically installs packages on an already built image. In + this case, :term:`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 :term:`PV` (i.e. :term:`PKGV`). A component having many packages with + the same :term:`PV` usually means that the packages all install the same + upstream version, but with later (:term:`PR`) version packages including + packaging fixes. + + .. note:: + + :term:`PR` does not need to be increased for changes that do not change the + package contents or metadata. + + Because manually managing :term:`PR` can be cumbersome and error-prone, + an automated solution exists. See the + ":ref:`dev-manual/packages: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 :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of + the recipe you prefer to provide "virtual/kernel". + + Here are more examples:: + + PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" + PREFERRED_PROVIDER_virtual/libgl ?= "mesa" + + For more + information, see the ":ref:`dev-manual/new-recipe:using virtual providers`" + section in the Yocto Project Development Tasks Manual. + + .. note:: + + If you use a ``virtual/\*`` item with :term:`PREFERRED_PROVIDER`, then any + recipe that :term:`PROVIDES` that item but is not selected (defined) + by :term:`PREFERRED_PROVIDER` is prevented from building, which is usually + desirable since this mechanism is designed to select between mutually + exclusive alternative providers. + + :term:`PREFERRED_PROVIDERS` + See :term:`bitbake:PREFERRED_PROVIDERS` in the BitBake manual. + + :term:`PREFERRED_VERSION` + If there are multiple versions of a recipe available, this variable + determines which version should be given preference. You must always + suffix the variable with the :term:`PN` you want to select (`python` in + the first example below), and you should specify the :term:`PV` + accordingly (`3.4.0` in the example). + + The :term:`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 :term:`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 :term:`OVERRIDES` includes "forcevariable". + + If a recipe with the specified version is not available, a warning + message will be shown. See :term:`REQUIRED_VERSION` if you want this + to be an error instead. + + :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 :term:`PREMIRRORS`, the upstream + source, and then locations specified by + :term:`MIRRORS` in that order. + + The default value for :term:`PREMIRRORS` is defined in the + ``meta/classes-global/mirrors.bbclass`` file in the core metadata layer. + + 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://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ + ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ + http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \ + https://.*/.* &YOCTO_DL_URL;/mirror/sources/" + + 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. + + :term:`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, :term:`PRIORITY` is not + normally set within recipes. + + You can set :term:`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 :term:`PN` is implicitly already in its + :term:`PROVIDES` list and therefore does not need to mention that it + provides itself. If a recipe uses :term:`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 + :term:`DEPENDS`. + + Consider the following example :term:`PROVIDES` statement from the recipe + file ``eudev_3.2.9.bb``:: + + PROVIDES += "udev" + + The :term:`PROVIDES` statement + results in the "eudev" recipe also being available as simply "udev". + + .. note:: + + A recipe's own recipe name (:term:`PN`) is always implicitly prepended + to :term:`PROVIDES`, so while using "+=" in the above example may not be + strictly necessary it is recommended to avoid confusion. + + In addition to providing recipes under alternate names, the + :term:`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 :term:`PROVIDES`. + Recipes that depend on the functionality in question can include the + virtual target in :term:`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, + :term:`VIRTUAL-RUNTIME_dev_manager <VIRTUAL-RUNTIME>` 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/templates/default/local.conf.sample.extended`` configuration + file in the :term:`Source Directory` shows how the :term:`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 <dev-manual/packages:working with a pr service>`. You can + set :term:`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 <dev-manual/packages:testing packages with ptest>` (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 :term:`PV` will be "2.0.1". + :term:`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). + + :term:`PV` is the default value of the :term:`PKGV` variable. + + :term:`PYPI_PACKAGE` + When inheriting the :ref:`ref-classes-pypi` class, specifies the + `PyPI <https://pypi.org/>`__ package name to be built. The default value + is set based upon :term:`BPN` (stripping any "python-" or "python3-" + prefix off if present), however for some packages it will need to be set + explicitly if that will not match the package name (e.g. where the + package name has a prefix, underscores, uppercase letters etc.) + + :term:`PYTHON_ABI` + When used by recipes that inherit the :ref:`ref-classes-setuptools3` + class, 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/...``). + + :term:`QA_EMPTY_DIRS` + Specifies a list of directories that are expected to be empty when + packaging; if ``empty-dirs`` appears in :term:`ERROR_QA` or + :term:`WARN_QA` these will be checked and an error or warning + (respectively) will be produced. + + The default :term:`QA_EMPTY_DIRS` value is set in + :ref:`insane.bbclass <ref-classes-insane>`. + + :term:`QA_EMPTY_DIRS_RECOMMENDATION` + Specifies a recommendation for why a directory must be empty, + which will be included in the error message if a specific directory + is found to contain files. Must be overridden with the directory + path to match on. + + If no recommendation is specified for a directory, then the default + "but it is expected to be empty" will be used. + + An example message shows if files were present in '/dev':: + + QA_EMPTY_DIRS_RECOMMENDATION:/dev = "but all devices must be created at runtime" + + :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 + :term:`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 :term:`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 :term:`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_* <ref-tasks-package_write_deb>` 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 :term:`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 + :ref:`do_package_write_* <ref-tasks-package_write_deb>` task of the recipes that build ``bar`` and + ``baz``. + + The names of the packages you list within :term:`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 :term:`RDEPENDS` + variable. For an example of the default list of packages created from + a recipe, see the :term:`PACKAGES` variable. + + Because the :term:`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 + :term:`RDEPENDS` statement:: + + RDEPENDS:${PN}-dev += "perl" + + In the example, + the development package depends on the ``perl`` package. Thus, the + :term:`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 :term:`RDEPENDS` must appear as they would + in the :term:`PACKAGES` variable. The :term:`PKG` variable + allows a different name to be used for the final package (e.g. the + :ref:`ref-classes-debian` class uses this to rename + packages), but this final package name cannot be used with + :term:`RDEPENDS`, which makes sense as :term:`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 + :term:`RDEPENDS` variable:: + + RDEPENDS:${PN} = "package (operator version)" + + For ``operator``, you can specify the following: + + - = + - < + - > + - <= + - >= + + For version, provide the version number. + + .. note:: + + You can use :term:`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:`bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and + ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" sections in the + BitBake User Manual for additional information on tasks and dependencies. + + :term:`RECIPE_MAINTAINER` + This variable defines the name and e-mail address of the maintainer of a + recipe. Such information can be used by human users submitted changes, + and by automated tools to send notifications, for example about + vulnerabilities or source updates. + + The variable can be defined in a global distribution :oe_git:`maintainers.inc + </openembedded-core/tree/meta/conf/distro/include/maintainers.inc>` file:: + + meta/conf/distro/include/maintainers.inc:RECIPE_MAINTAINER:pn-sysvinit = "Ross Burton <ross.burton@arm.com>" + + It can also be directly defined in a recipe, + for example in the ``libgpiod`` one:: + + RECIPE_MAINTAINER = "Bartosz Golaszewski <brgl@bgdev.pl>" + + :term:`RECIPE_NO_UPDATE_REASON` + If a recipe should not be replaced by a more recent upstream version, + putting the reason why in this variable in a recipe allows + ``devtool check-upgrade-status`` command to display it, as explained + in the ":ref:`ref-manual/devtool-reference:checking on the upgrade status of a recipe`" + section. + + :term:`RECIPE_SYSROOT` + This variable points to the directory that holds all files populated from + recipes specified in :term:`DEPENDS`. As the name indicates, + think of this variable as a custom root (``/``) for the recipe that will be + used by the compiler in order to find headers and other files needed to complete + its job. + + This variable is related to :term:`STAGING_DIR_HOST` or :term:`STAGING_DIR_TARGET` + according to the type of the recipe and the build target. + + To better understand this variable, consider the following examples: + + - For ``#include <header.h>``, ``header.h`` should be in ``"${RECIPE_SYSROOT}/usr/include"`` + + - For ``-lexample``, ``libexample.so`` should be in ``"${RECIPE_SYSROOT}/lib"`` + or other library sysroot directories. + + The default value is ``"${WORKDIR}/recipe-sysroot"``. + Do not modify it. + + :term:`RECIPE_SYSROOT_NATIVE` + This is similar to :term:`RECIPE_SYSROOT` but the populated files are from + ``-native`` recipes. This allows a recipe built for the target machine to + use ``native`` tools. + + This variable is related to :term:`STAGING_DIR_NATIVE`. + + The default value is ``"${WORKDIR}/recipe-sysroot-native"``. + Do not modify it. + + :term:`REPODIR` + See :term:`bitbake:REPODIR` in the BitBake manual. + + :term:`REQUIRED_DISTRO_FEATURES` + When inheriting the :ref:`ref-classes-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 + :term:`REQUIRED_DISTRO_FEATURES` variable lists a feature that does not + appear in :term:`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:`REQUIRED_VERSION` + If there are multiple versions of a recipe available, this variable + determines which version should be given preference. + :term:`REQUIRED_VERSION` works in exactly the same manner as + :term:`PREFERRED_VERSION`, except that if the specified version is not + available then an error message is shown and the build fails + immediately. + + If both :term:`REQUIRED_VERSION` and :term:`PREFERRED_VERSION` are set + for the same recipe, the :term:`REQUIRED_VERSION` value applies. + + :term:`RM_WORK_EXCLUDE` + With :ref:`ref-classes-rm-work` enabled, this variable + specifies a list of recipes whose work directories should not be removed. + See the ":ref:`ref-classes-rm-work`" 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 :term:`ROOTFS` variable is an optional variable used with the + :ref:`ref-classes-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 + spaces:: + + 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 spaces:: + + 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 spaces:: + + 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 spaces:: + + 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:`RPMBUILD_EXTRA_PARAMS` + Specifies extra user-defined parameters for the ``rpmbuild`` command. + + :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 + :term:`RDEPENDS`). + + .. note:: + + A package's own name is implicitly already in its :term:`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 :term:`RDEPENDS` variable. + + The package manager will automatically install the :term:`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 :term:`RRECOMMENDS` need not actually be produced. + However, there must be a recipe providing 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 :term:`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 :term:`PACKAGES` namespace before any renaming of the output package + by classes such as :ref:`ref-classes-debian`. + + 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 + :term:`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 :term:`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 + :term:`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:`RUST_CHANNEL` + Specifies which version of Rust to build - "stable", "beta" or "nightly". + The default value is "stable". Set this at your own risk, as values other + than "stable" are not guaranteed to work at a given time. + + :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 + :term:`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 :term:`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 :term:`S`, you must set it specifically so the + source can be located:: + + SRC_URI = "git://path/to/repo.git;branch=main" + 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 :term:`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_ARCHIVE_TYPE` + Specifies the type of archive to create for the SDK. Valid values: + + - ``tar.xz`` (default) + - ``zip`` + + Only one archive type can be specified. + + :term:`SDK_BUILDINFO_FILE` + When using the :ref:`ref-classes-image-buildinfo` class, + specifies the file in the SDK to write the build information into. The + default value is "``/buildinfo``". + + :term:`SDK_CUSTOM_TEMPLATECONF` + When building the extensible SDK, if :term:`SDK_CUSTOM_TEMPLATECONF` is set to + "1" and a ``conf/templateconf.cfg`` file exists in the :term:`Build Directory` + (:term:`TOPDIR`) then this will be copied into the SDK. + + :term:`SDK_DEPLOY` + The directory set up and used by the + :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which the + SDK is deployed. The :ref:`populate_sdk_base <ref-classes-populate-sdk>` + class defines :term:`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 <ref-classes-populate-sdk-*>` class defines + the variable as follows:: + + SDK_DIR = "${WORKDIR}/sdk" + + .. note:: + + The :term:`SDK_DIR` directory is a temporary directory as it is part of + :term:`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 <ref-classes-populate-sdk-*>` 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 :term:`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 :term:`SDK_INCLUDE_TOOLCHAIN` variable defaults to "0" if + :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if + :term:`SDK_EXT_TYPE` is set to "full". + + :term:`SDK_NAME` + The base name for SDK output files. The default value (as set in + ``meta-poky/conf/distro/poky.conf``) is derived from the + :term:`DISTRO`, + :term:`TCLIBC`, + :term:`SDKMACHINE`, + :term:`IMAGE_BASENAME`, + :term:`TUNE_PKGARCH`, and + :term:`MACHINE` variables:: + + SDK_NAME = "${DISTRO}-${TCLIBC}-${SDKMACHINE}-${IMAGE_BASENAME}-${TUNE_PKGARCH}-${MACHINE}" + + :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 <ref-classes-populate-sdk-*>` + class defines the variable as follows:: + + SDK_DIR = "${WORKDIR}/sdk" + SDK_OUTPUT = "${SDK_DIR}/image" + SDK_DEPLOY = "${DEPLOY_DIR}/sdk" + + .. note:: + + The :term:`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 :term:`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 + spaces: + + 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 + :ref:`ref-classes-nativesdk` recipes. The + OpenEmbedded build system uses the :term:`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: + + - :ref:`ref-tasks-populate_lic` + - :ref:`ref-tasks-package_qa` + - :ref:`ref-tasks-populate_sysroot` + - :ref:`ref-tasks-deploy` + + Despite the default value of "" for the + :term:`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 + :term:`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 :term:`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 <ref-classes-populate-sdk-*>` 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 :term:`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 <ref-classes-populate-sdk-*>` class as + follows:: + + SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" + + For the default distribution "poky", + :term:`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_TOOLCHAIN_LANGS` + Specifies programming languages to support in the SDK, as a + space-separated list. Currently supported items are ``rust`` and ``go``. + + :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 Poky distribution configuration file + (``/meta-poky/conf/distro/poky.conf``) sets the default + :term:`SDK_VERSION` as follows:: + + SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${METADATA_REVISION}', 'snapshot')}" + + For additional information, see the + :term:`DISTRO_VERSION` and + :term:`METADATA_REVISION` variables. + + :term:`SDK_ZIP_OPTIONS` + Specifies extra options to pass to the ``zip`` command when zipping the SDK + (i.e. when :term:`SDK_ARCHIVE_TYPE` is set to "zip"). The default value is + "-y". + + :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 <ref-classes-populate-sdk-*>` class as + follows:: + + SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" + + For the + default distribution "poky", the :term:`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 :term:`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 :term:`SDKMACHINE` + value. The value points to a corresponding ``.conf`` file under + ``conf/machine-sdk/`` in the enabled layers, for example ``aarch64``, + ``i586``, ``i686``, ``ppc64``, ``ppc64le``, and ``x86_64`` are + :oe_git:`available in OpenEmbedded-Core </openembedded-core/tree/meta/conf/machine-sdk>`. + + The variable defaults to :term:`BUILD_ARCH` so that SDKs are built for the + architecture of the build machine. + + .. note:: + + You cannot set the :term:`SDKMACHINE` + variable in your distribution configuration file. If you do, the + configuration will not take effect. + + :term:`SDKPATH` + Defines the path used to collect the SDK components and build the + installer. + + :term:`SDKPATHINSTALL` + 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:`SDKPATHINSTALL`. + + :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 :term:`SELECTED_OPTIMIZATION` variable takes the value of + :term:`FULL_OPTIMIZATION` unless :term:`DEBUG_BUILD` = "1", in which + case the value of :term:`DEBUG_OPTIMIZATION` is used. + + :term:`SERIAL_CONSOLES` + Defines a serial console (TTY) to enable using + :wikipedia:`getty <Getty_(Unix)>`. 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:`SETUPTOOLS_BUILD_ARGS` + When used by recipes that inherit the :ref:`ref-classes-setuptools3` + class, this variable can be used to specify additional arguments to be + passed to ``setup.py build`` in the ``setuptools3_do_compile()`` task. + + :term:`SETUPTOOLS_INSTALL_ARGS` + When used by recipes that inherit the :ref:`ref-classes-setuptools3` + class, this variable can be used to specify additional arguments to be + passed to ``setup.py install`` in the ``setuptools3_do_install()`` task. + + :term:`SETUPTOOLS_SETUP_PATH` + When used by recipes that inherit the :ref:`ref-classes-setuptools3` + class, this variable should be used to specify the directory in which + the ``setup.py`` file is located if it is not at the root of the source + tree (as specified by :term:`S`). For example, in a recipe where the + sources are fetched from a Git repository and ``setup.py`` is in a + ``python/pythonmodule`` subdirectory, you would have this:: + + S = "${WORKDIR}/git" + SETUPTOOLS_SETUP_PATH = "${S}/python/pythonmodule" + + :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:`SKIP_RECIPE` + Used to prevent the OpenEmbedded build system from building a given + recipe. Specify the :term:`PN` value as a variable flag (``varflag``) + and provide a reason, which will be reported when attempting to + build the recipe. + + To prevent a recipe from being built, use the :term:`SKIP_RECIPE` + variable in your ``local.conf`` file or distribution configuration. + Here is an example which prevents ``myrecipe`` from being built:: + + SKIP_RECIPE[myrecipe] = "Not supported by our organization." + + :term:`SOC_FAMILY` + A colon-separated list grouping 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_DATE_EPOCH` + This defines a date expressed in number of seconds since + the UNIX EPOCH (01 Jan 1970 00:00:00 UTC), which is used by + multiple build systems to force a timestamp in built binaries. + Many upstream projects already support this variable. + + You will find more details in the `official specifications + <https://reproducible-builds.org/specs/source-date-epoch/>`__. + + A value for each recipe is computed from the sources by + :oe_git:`meta/lib/oe/reproducible.py </openembedded-core/tree/meta/lib/oe/reproducible.py>`. + + If a recipe wishes to override the default behavior, it should set its + own :term:`SOURCE_DATE_EPOCH` value:: + + SOURCE_DATE_EPOCH = "1613559011" + + :term:`SOURCE_MIRROR_FETCH` + When you are fetching files to create a mirror of sources (i.e. + creating a source mirror), setting :term:`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 :term:`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:`ref-classes-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 :term:`SOURCE_MIRROR_URL`. + + :term:`SPDX_ARCHIVE_PACKAGED` + This option allows to add to :term:`SPDX` output compressed archives + of the files in the generated target packages. + + Such archives are available in + ``tmp/deploy/spdx/MACHINE/packages/packagename.tar.zst`` + under the :term:`Build Directory`. + + Enable this option as follows:: + + SPDX_ARCHIVE_PACKAGED = "1" + + According to our tests on release 4.1 "langdale", building + ``core-image-minimal`` for the ``qemux86-64`` machine, enabling this + option multiplied the size of the ``tmp/deploy/spdx`` directory by a + factor of 13 (+1.6 GiB for this image), compared to just using the + :ref:`ref-classes-create-spdx` class with no option. + + Note that this option doesn't increase the size of :term:`SPDX` + files in ``tmp/deploy/images/MACHINE``. + + :term:`SPDX_ARCHIVE_SOURCES` + This option allows to add to :term:`SPDX` output compressed archives + of the sources for packages installed on the target. It currently + only works when :term:`SPDX_INCLUDE_SOURCES` is set. + + This is one way of fulfilling "source code access" license + requirements. + + Such source archives are available in + ``tmp/deploy/spdx/MACHINE/recipes/recipe-packagename.tar.zst`` + under the :term:`Build Directory`. + + Enable this option as follows:: + + SPDX_INCLUDE_SOURCES = "1" + SPDX_ARCHIVE_SOURCES = "1" + + According to our tests on release 4.1 "langdale", building + ``core-image-minimal`` for the ``qemux86-64`` machine, enabling + these options multiplied the size of the ``tmp/deploy/spdx`` + directory by a factor of 11 (+1.4 GiB for this image), + compared to just using the :ref:`ref-classes-create-spdx` + class with no option. + + Note that using this option only marginally increases the size + of the :term:`SPDX` output in ``tmp/deploy/images/MACHINE/`` + (+ 0.07\% with the tested image), compared to just enabling + :term:`SPDX_INCLUDE_SOURCES`. + + :term:`SPDX_CUSTOM_ANNOTATION_VARS` + This option allows to associate `SPDX annotations + <https://spdx.github.io/spdx-spec/v2.3/annotations/>`__ to a recipe, + using the values of variables in the recipe:: + + ANNOTATION1 = "First annotation for recipe" + ANNOTATION2 = "Second annotation for recipe" + SPDX_CUSTOM_ANNOTATION_VARS = "ANNOTATION1 ANNOTATION2" + + This will add a new block to the recipe ``.sdpx.json`` output:: + + "annotations": [ + { + "annotationDate": "2023-04-18T08:32:12Z", + "annotationType": "OTHER", + "annotator": "Tool: oe-spdx-creator - 1.0", + "comment": "ANNOTATION1=First annotation for recipe" + }, + { + "annotationDate": "2023-04-18T08:32:12Z", + "annotationType": "OTHER", + "annotator": "Tool: oe-spdx-creator - 1.0", + "comment": "ANNOTATION2=Second annotation for recipe" + } + ], + + :term:`SPDX_INCLUDE_SOURCES` + This option allows to add a description of the source files used to build + the host tools and the target packages, to the ``spdx.json`` files in + ``tmp/deploy/spdx/MACHINE/recipes/`` under the :term:`Build Directory`. + As a consequence, the ``spdx.json`` files under the ``by-namespace`` and + ``packages`` subdirectories in ``tmp/deploy/spdx/MACHINE`` are also + modified to include references to such source file descriptions. + + Enable this option as follows:: + + SPDX_INCLUDE_SOURCES = "1" + + According to our tests on release 4.1 "langdale", building + ``core-image-minimal`` for the ``qemux86-64`` machine, enabling + this option multiplied the total size of the ``tmp/deploy/spdx`` + directory by a factor of 3 (+291 MiB for this image), + and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in + ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this + image), compared to just using the :ref:`ref-classes-create-spdx` class + with no option. + + :term:`SPDX_NAMESPACE_PREFIX` + This option could be used in order to change the prefix of ``spdxDocument`` + and the prefix of ``documentNamespace``. It is set by default to + ``http://spdx.org/spdxdoc``. + + :term:`SPDX_PRETTY` + This option makes the SPDX output more human-readable, using + identation and newlines, instead of the default output in a + single line:: + + SPDX_PRETTY = "1" + + The generated SPDX files are approximately 20% bigger, but + this option is recommended if you want to inspect the SPDX + output files with a text editor. + + :term:`SPDXLICENSEMAP` + Maps commonly used license names to their SPDX counterparts found in + ``meta/files/common-licenses/``. For the default :term:`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 :term:`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/layers:adding a layer using the \`\`bitbake-layers\`\` script`" + section in the Yocto Project Board Support Package Developer's Guide + for additional information. + + :term:`SPL_MKIMAGE_DTCOPTS` + Options for the device tree compiler passed to ``mkimage -D`` feature + while creating a FIT image with the :ref:`ref-classes-uboot-sign` + class. If :term:`SPL_MKIMAGE_DTCOPTS` is not set then the + :ref:`ref-classes-uboot-sign` class will not pass the ``-D`` option + to ``mkimage``. + + The default value is set to "" by the :ref:`ref-classes-uboot-config` + class. + + :term:`SPL_SIGN_ENABLE` + Enable signing of the U-Boot FIT image. The default value is "0". + This variable is used by the :ref:`ref-classes-uboot-sign` class. + + :term:`SPL_SIGN_KEYDIR` + Location of the directory containing the RSA key and certificate used for + signing the U-Boot FIT image, used by the :ref:`ref-classes-uboot-sign` + class. + + :term:`SPL_SIGN_KEYNAME` + The name of keys used by the :ref:`ref-classes-kernel-fitimage` class + for signing U-Boot FIT image stored in the :term:`SPL_SIGN_KEYDIR` + directory. If we have for example a ``dev.key`` key and a ``dev.crt`` + certificate stored in the :term:`SPL_SIGN_KEYDIR` directory, you will + have to set :term:`SPL_SIGN_KEYNAME` to ``dev``. + + :term:`SPLASH` + This variable, used by the :ref:`ref-classes-image` class, allows + to choose splashscreen applications. Set it to the names of packages + for such applications to use. This variable is set by default to + ``psplash``. + + :term:`SPLASH_IMAGES` + This variable, used by the ``psplash`` recipe, allows to customize + the default splashscreen image. + + Specified images in PNG format are converted to ``.h`` files by the recipe, + and are included in the ``psplash`` binary, so you won't find them in + the root filesystem. + + To make such a change, it is recommended to customize the + ``psplash`` recipe in a custom layer. Here is an example structure for + an ``ACME`` board:: + + meta-acme/recipes-core/psplash + ├── files + │ └── logo-acme.png + └── psplash_%.bbappend + + And here are the contents of the ``psplash_%.bbappend`` file in + this example:: + + SPLASH_IMAGES = "file://logo-acme.png;outsuffix=default" + FILESEXTRAPATHS:prepend := "${THISDIR}/files:" + + You could even add specific configuration options for ``psplash``, + for example:: + + EXTRA_OECONF += "--disable-startup-msg --enable-img-fullscreen" + + For information on append files, see the + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" + section. + + :term:`SRCREV_FORMAT` + See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual. + + :term:`SRC_URI` + + See the BitBake manual for the initial description for this variable: + :term:`bitbake:SRC_URI`. + + The following features are added by OpenEmbedded and the Yocto Project. + + There are standard and recipe-specific options. Here are standard ones: + + - ``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 :term:`SRCDATE` is not later + than ``maxdate``. + + - ``minrev`` --- apply the patch only if :term:`SRCREV` is equal to or + greater than ``minrev``. + + - ``maxrev`` --- apply the patch only if :term:`SRCREV` is not later + than ``maxrev``. + + - ``rev`` --- apply the patch only if :term:`SRCREV` is equal to + ``rev``. + + - ``notrev`` --- apply the patch only if :term:`SRCREV` is not equal to + ``rev``. + + .. note:: + + If you want the build system to pick up files specified through + a :term:`SRC_URI` statement from your append file, you need to be + sure to extend the :term:`FILESPATH` variable by also using the + :term:`FILESEXTRAPATHS` variable from within your append file. + + :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` + By default, the OpenEmbedded build system automatically detects + whether :term:`SRC_URI` contains files that are machine-specific. If so, + the build system automatically changes :term:`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 :term:`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 :term:`PV` do so with the help of the + :term:`SRCPV`. For example, the ``ofono`` recipe (``ofono_git.bb``) + located in ``meta/recipes-connectivity`` in the Source Directory + defines :term:`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 :term:`SRCREV` that is a full revision + identifier (e.g. the full SHA hash in git) and not just a tag. + + .. note:: + + For information on limitations when inheriting the latest revision + of software using :term:`SRCREV`, see the :term:`AUTOREV` variable + description and the + ":ref:`dev-manual/packages:automatically incrementing a package version number`" + section, which is in the Yocto Project Development Tasks Manual. + + :term:`SRCTREECOVEREDTASKS` + A list of tasks that are typically not relevant (and therefore skipped) + when building using the :ref:`ref-classes-externalsrc` + class. The default value as set in that class file is the set of tasks + that are rarely needed when using external source:: + + SRCTREECOVEREDTASKS ?= "do_patch do_unpack do_fetch" + + The notable exception is when processing external kernel source as + defined in the :ref:`ref-classes-kernel-yocto` class file (formatted for + aesthetics):: + + SRCTREECOVEREDTASKS += "\ + do_validate_branches \ + do_kernel_configcheck \ + do_kernel_checkout \ + do_fetch \ + do_unpack \ + do_patch \ + " + + See the associated :term:`EXTERNALSRC` and :term:`EXTERNALSRC_BUILD` + variables for more information. + + :term:`SSTATE_DIR` + The directory for the shared state cache. + + :term:`SSTATE_EXCLUDEDEPS_SYSROOT` + This variable allows to specify indirect dependencies to exclude + from sysroots, for example to avoid the situations when a dependency on + any ``-native`` recipe will pull in all dependencies of that recipe + in the recipe sysroot. This behaviour might not always be wanted, + for example when that ``-native`` recipe depends on build tools + that are not relevant for the current recipe. + + This way, irrelevant dependencies are ignored, which could have + prevented the reuse of prebuilt artifacts stored in the Shared + State Cache. + + :term:`SSTATE_EXCLUDEDEPS_SYSROOT` is evaluated as two regular + expressions of recipe and dependency to ignore. An example + is the rule in :oe_git:`meta/conf/layer.conf </openembedded-core/tree/meta/conf/layer.conf>`:: + + # Nothing needs to depend on libc-initial + # base-passwd/shadow-sysroot don't need their dependencies + SSTATE_EXCLUDEDEPS_SYSROOT += "\ + .*->.*-initial.* \ + .*(base-passwd|shadow-sysroot)->.* \ + " + + The ``->`` substring represents the dependency between + the two regular expressions. + + :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 :term:`BB_NO_NETWORK` to + "1". Using the :term:`SSTATE_MIRROR_ALLOW_NETWORK` variable is useful if + you have set :term:`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 + :term:`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:`ref-classes-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/(.*) https://server_url_sstate_path/universal-4.8/\1" + + 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://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \ + file://.* file:///some-local-dir/sstate/PATH" + + The Yocto Project actually shares the cache data objects built by its + autobuilder:: + + SSTATE_MIRRORS ?= "file://.* http://cdn.jsdelivr.net/yocto/sstate/all/PATH;downloadfilename=PATH" + + As such binary artifacts are built for the generic QEMU machines + supported by the various Poky releases, they are less likely to be + reusable in real projects building binaries optimized for a specific + CPU family. + + :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 :term:`SSTATE_SCAN_FILES` variable. Typically, recipes add files + they want to be scanned to the value of :term:`SSTATE_SCAN_FILES` rather + than the variable being comprehensively set. The + :ref:`ref-classes-sstate` class specifies the default list of files. + + For details on the process, see the :ref:`ref-classes-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 :term:`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 + :ref:`ref-tasks-populate_sysroot` task instead uses + :term:`STAGING_DIR_NATIVE`. Depending on + the type of recipe and the build target, :term:`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 + :term:`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 :term:`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 :term:`STAGING_DIR_HOST` makes conceptual sense + for ``-native`` recipes, as they make use of host headers and + libraries. + + Check :term:`RECIPE_SYSROOT` and :term:`RECIPE_SYSROOT_NATIVE`. + + :term:`STAGING_DIR_NATIVE` + Specifies the path to the sysroot directory used when building + components that run on the build host itself. + + The default value is ``"${RECIPE_SYSROOT_NATIVE}"``, + check :term:`RECIPE_SYSROOT_NATIVE`. + + :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, :term:`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. + :ref:`ref-classes-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 :term:`STAGING_DIR_HOST` variable points to the sysroot used + for the "HOST" system, while :term:`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 :term:`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 :term:`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:`STAMPCLEAN` + See :term:`bitbake:STAMPCLEAN` in the BitBake manual. + + :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, + :term:`SUMMARY` is used to define the + :term:`DESCRIPTION` variable if :term:`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:`ref-classes-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:`ref-classes-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:`ref-classes-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:`ref-classes-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:`ref-classes-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} \ + /sysroot-only \ + " + + :term:`SYSROOT_DIRS_IGNORE` + 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_IGNORE = " \ + ${mandir} \ + ${docdir} \ + ${infodir} \ + ${datadir}/X11/locale \ + ${datadir}/applications \ + ${datadir}/bash-completion \ + ${datadir}/fonts \ + ${datadir}/gtk-doc/html \ + ${datadir}/installed-tests \ + ${datadir}/locale \ + ${datadir}/pixmaps \ + ${datadir}/terminfo \ + ${libdir}/${BPN}/ptest \ + " + + Consider the following example in which you need to manipulate this variable. + Assume you have a recipe ``A`` that provides a shared library ``.so.*`` that is + installed into a custom folder other than "``${libdir}``" + or "``${base_libdir}``", let's say "``/opt/lib``". + + .. note:: + + This is not a recommended way to deal with shared libraries, but this + is just to show the usefulness of setting :term:`SYSROOT_DIRS`. + + When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in + :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``B`` + into ``B``'s :term:`SYSROOT_DESTDIR` that is "``${WORKDIR}/sysroot-destdir``". + + Now, since ``/opt/lib`` is not in :term:`SYSROOT_DIRS`, it will never be copied to + ``A``'s :term:`RECIPE_SYSROOT`, which is "``${WORKDIR}/recipe-sysroot``". So, + the linking process will fail. + + To fix this, you need to add ``/opt/lib`` to :term:`SYSROOT_DIRS`:: + + SYSROOT_DIRS:append = " /opt/lib" + + .. note:: + Even after setting ``/opt/lib`` to :term:`SYSROOT_DIRS`, the linking process will still fail + because the linker does not know that location, since :term:`TARGET_LDFLAGS` + doesn't contain it (if your recipe is for the target). Therefore, so you should add:: + + TARGET_LDFLAGS:append = " -L${RECIPE_SYSROOT}/opt/lib" + + :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:`ref-classes-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:`ref-classes-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 :term:`SYSTEMD_BOOT_CFG` variable specifies the + configuration file that should be used. By default, the + :ref:`ref-classes-systemd-boot` class sets the + :term:`SYSTEMD_BOOT_CFG` as follows:: + + SYSTEMD_BOOT_CFG ?= "${S}/loader.conf" + + For information on Systemd-boot, see the `Systemd-boot + documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. + + :term:`SYSTEMD_BOOT_ENTRIES` + When :term:`EFI_PROVIDER` is set to + "systemd-boot", the :term:`SYSTEMD_BOOT_ENTRIES` variable specifies a + list of entry files (``*.conf``) to install that contain one boot + entry per file. By default, the :ref:`ref-classes-systemd-boot` class + sets the :term:`SYSTEMD_BOOT_ENTRIES` as follows:: + + SYSTEMD_BOOT_ENTRIES ?= "" + + For information on Systemd-boot, see the `Systemd-boot + documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. + + :term:`SYSTEMD_BOOT_TIMEOUT` + When :term:`EFI_PROVIDER` is set to + "systemd-boot", the :term:`SYSTEMD_BOOT_TIMEOUT` variable specifies the + boot menu timeout in seconds. By default, the + :ref:`ref-classes-systemd-boot` class sets the + :term:`SYSTEMD_BOOT_TIMEOUT` as follows:: + + SYSTEMD_BOOT_TIMEOUT ?= "10" + + For information on Systemd-boot, see the `Systemd-boot + documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. + + :term:`SYSTEMD_DEFAULT_TARGET` + + This variable allows to set the default unit that systemd starts at bootup. + Usually, this is either ``multi-user.target`` or ``graphical.target``. + This works by creating a ``default.target`` symbolic link to the chosen systemd + target file. + + See `systemd's documentation + <https://www.freedesktop.org/software/systemd/man/systemd.special.html>`__ + for details. + + For example, this variable is used in the :oe_git:`core-image-minimal-xfce.bb + </meta-openembedded/tree/meta-xfce/recipes-core/images/core-image-minimal-xfce.bb>` + recipe:: + + SYSTEMD_DEFAULT_TARGET = "graphical.target" + + :term:`SYSTEMD_PACKAGES` + When inheriting the :ref:`ref-classes-systemd` class, + this variable locates the systemd unit files when they are not found + in the main recipe's package. By default, the :term:`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 :term:`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:`ref-classes-systemd` class, + this variable specifies the systemd service name for a package. + + Multiple services can be specified, each one separated by a space. + + 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" + + The package overrides that can be specified are directly related to the value of + :term:`SYSTEMD_PACKAGES`. Overrides not included in :term:`SYSTEMD_PACKAGES` + will be silently ignored. + + :term:`SYSVINIT_ENABLED_GETTYS` + When using :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`, + specifies a space-separated list of the virtual terminals that should + run a :wikipedia:`getty <Getty_(Unix)>` (allowing login), assuming + :term:`USE_VT` is not set to "0". + + The default value for :term:`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 :term:`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. :term:`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. :term:`TARGET_CC_ARCH` is initialized from + :term:`TUNE_CCARGS` by default. + + .. note:: + + It is a common workaround to append :term:`LDFLAGS` to + :term:`TARGET_CC_ARCH` in recipes that build software for the target that + would not otherwise respect the exported :term:`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 :term:`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 :term:`CFLAGS` + variable in the environment to the :term:`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 + :term:`CPPFLAGS` variable in the environment to the :term:`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 + :term:`CXXFLAGS` variable in the environment to the :term:`TARGET_CXXFLAGS` + value so that executables built using the SDK also have the flags + applied. + + :term:`TARGET_DBGSRC_DIR` + Specifies the target path to debug source files. The default is + ``/usr/src/debug/${PN}/${PV}``. + + :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. + :term:`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 + :term:`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, the possible values are + "linux-gnueabi" and "linux-musleabi". + + :term:`TARGET_PREFIX` + Specifies the prefix used for the toolchain binary target tools. + + Depending on the type of recipe and the build target, + :term:`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 :term:`BUILD_PREFIX`. + + - For native SDK recipes (:ref:`ref-classes-nativesdk`), + the build system sets the variable to the value of :term:`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 :term:`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. + + 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 + :term:`TCLIBCAPPEND` is "-${TCLIBC}". However, distros such as poky, + which normally only support one ``libc`` variant, set + :term:`TCLIBCAPPEND` to "" in their distro configuration file resulting + in no suffix being applied. + + :term:`TCMODE` + Specifies the toolchain selector. :term:`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 :term:`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 + :doc:`Release Information </migration-guides/index>` for your + version of the Yocto Project, to find the specific components with + which the toolchain must be compatible. + + The :term:`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 + https://github.com/MentorEmbedded/meta-sourcery/. + + The layer's ``README`` file contains information on how to use the + Sourcery G++ Toolchain as an external toolchain. You will have to + add the layer to your ``bblayers.conf`` file and then set the + :term:`EXTERNAL_TOOLCHAIN` variable in your ``local.conf`` file to + the location of 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. + + In addition to toolchain configuration, you will also need a + corresponding toolchain recipe file. This recipe file needs to package + up any pre-built objects in the toolchain such as ``libgcc``, + ``libstdcc++``, any locales, and ``libc``. + + :term:`TC_CXX_RUNTIME` + Specifies the C/C++ STL and runtime variant to use during + the build process. Default value is 'gnu' + + You can select "gnu", "llvm", or "android". + + :term:`TEMPLATECONF` + Specifies the directory used by the build system to find templates + from which to build the ``bblayers.conf`` and ``local.conf`` files. + Use this variable if you wish to customize such files, and the default + BitBake targets shown when sourcing the ``oe-init-build-env`` script. + + For details, see the + :ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory` + section in the Yocto Project Development Tasks manual. + + .. note:: + + You must set this variable in the external environment in order + for it to work. + + :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 :term:`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 + :term:`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 + :term:`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/runtime-testing: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 + :term:`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 :term:`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 :term:`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/runtime-testing: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 :term:`TEST_TARGET`. + + You can provide the following arguments with :term:`TEST_TARGET`: + + - *"qemu":* Boots a QEMU image and runs the tests. See the + ":ref:`dev-manual/runtime-testing: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/runtime-testing: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 :term:`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 :term:`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/runtime-testing:performing automated runtime testing`" + section in the Yocto Project Development Tasks Manual and the + ":ref:`ref-classes-testimage`" 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 :term:`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 :term:`TMPDIR` to a local disk, + which does not use NFS, while having the :term:`Build Directory` use NFS. + + The filesystem used by :term:`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, :term:`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. + + Note that this variable applies to building an SDK, not an eSDK, + in which case the :term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be + used instead. + + :term:`TOOLCHAIN_HOST_TASK_ESDK` + This variable allows to extend what is installed in the host + portion of an eSDK. This is similar to :term:`TOOLCHAIN_HOST_TASK` + applying to SDKs. + + :term:`TOOLCHAIN_OPTIONS` + This variable holds extra options passed to the compiler and the linker + for non ``-native`` recipes as they have to point to their custom + ``sysroot`` folder pointed to by :term:`RECIPE_SYSROOT`:: + + TOOLCHAIN_OPTIONS = " --sysroot=${RECIPE_SYSROOT}" + + Native recipes don't need this variable to be set, as they are + built for the host machine with the native compiler. + + :term:`TOOLCHAIN_OUTPUTNAME` + This variable defines the name used for the toolchain output. The + :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets + the :term:`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` + See :term:`bitbake:TOPDIR` in the BitBake manual. + + :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 + :term:`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. + + :term:`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 + :term:`TUNE_ARCH` specific to the ``mips`` architecture. + + :term:`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 :term:`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. + :term:`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. + :term:`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 + :term:`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. + :term:`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/x86/tune-core2.inc`` file:: + + TUNE_PKGARCH:tune-core2-32 = "core2-32" + + :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_BINARY` + Specifies the name of the binary build by U-Boot. + + :term:`UBOOT_CONFIG` + Configures one or more U-Boot configurations to build. Each + configuration can define the :term:`UBOOT_MACHINE` and optionally the + :term:`IMAGE_FSTYPES` and the :term:`UBOOT_BINARY`. + + Here is an example from the ``meta-freescale`` layer. :: + + UBOOT_CONFIG ??= "sdcard-ifc-secure-boot sdcard-ifc sdcard-qspi lpuart qspi secure-boot nor" + UBOOT_CONFIG[nor] = "ls1021atwr_nor_defconfig" + UBOOT_CONFIG[sdcard-ifc] = "ls1021atwr_sdcard_ifc_defconfig,,u-boot-with-spl-pbl.bin" + UBOOT_CONFIG[sdcard-qspi] = "ls1021atwr_sdcard_qspi_defconfig,,u-boot-with-spl-pbl.bin" + UBOOT_CONFIG[lpuart] = "ls1021atwr_nor_lpuart_defconfig" + UBOOT_CONFIG[qspi] = "ls1021atwr_qspi_defconfig" + UBOOT_CONFIG[secure-boot] = "ls1021atwr_nor_SECURE_BOOT_defconfig" + UBOOT_CONFIG[sdcard-ifc-secure-boot] = "ls1021atwr_sdcard_ifc_SECURE_BOOT_defconfig,,u-boot-with-spl-pbl.bin" + + In this example, all possible seven configurations are selected. Each + configuration specifies "..._defconfig" as :term:`UBOOT_MACHINE`, and + the "sd..." configurations define an individual name for + :term:`UBOOT_BINARY`. No configuration defines a second parameter for + :term:`IMAGE_FSTYPES` to use for the U-Boot image. + + For more information on how the :term:`UBOOT_CONFIG` is handled, see the + :ref:`ref-classes-uboot-config` class. + + :term:`UBOOT_DTB_LOADADDRESS` + Specifies the load address for the dtb image used by U-Boot. During FIT + image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in + :ref:`ref-classes-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 :term:`UBOOT_DTBO_LOADADDRESS` variable is used in + :ref:`ref-classes-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 :term:`UBOOT_ENTRYPOINT` variable is passed as a + command-line parameter to the ``uboot-mkimage`` utility. + + To pass a 64 bit address for FIT image creation, you will need to set: + - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. + - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. + + This variable is used by the :ref:`ref-classes-kernel-fitimage`, + :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, + :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` + classes. + + :term:`UBOOT_FIT_ADDRESS_CELLS` + Specifies the value of the ``#address-cells`` value for the + description of the U-Boot FIT image. + + The default value is set to "1" by the :ref:`ref-classes-uboot-sign` + class, which corresponds to 32 bit addresses. + + For platforms that need to set 64 bit addresses in + :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to + set this value to "2", as two 32 bit values (cells) will be needed + to represent such addresses. + + Here is an example setting "0x400000000" as a load address:: + + UBOOT_FIT_ADDRESS_CELLS = "2" + UBOOT_LOADADDRESS= "0x04 0x00000000" + + See `more details about #address-cells <https://elinux.org/Device_Tree_Usage#How_Addressing_Works>`__. + + :term:`UBOOT_FIT_DESC` + Specifies the description string encoded into a U-Boot fitImage. The default + value is set by the :ref:`ref-classes-uboot-sign` class as follows:: + + UBOOT_FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" + + :term:`UBOOT_FIT_GENERATE_KEYS` + Decides whether to generate the keys for signing the U-Boot fitImage if + they don't already exist. The keys are created in :term:`SPL_SIGN_KEYDIR`. + The default value is "0". + + Enable this as follows:: + + UBOOT_FIT_GENERATE_KEYS = "1" + + This variable is used in the :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FIT_HASH_ALG` + Specifies the hash algorithm used in creating the U-Boot FIT Image. + It is set by default to ``sha256`` by the :ref:`ref-classes-uboot-sign` + class. + + :term:`UBOOT_FIT_KEY_GENRSA_ARGS` + Arguments to ``openssl genrsa`` for generating a RSA private key for + signing the U-Boot FIT image. The default value of this variable + is set to "-F4" by the :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FIT_KEY_REQ_ARGS` + Arguments to ``openssl req`` for generating a certificate for signing + the U-Boot FIT image. The default value is "-batch -new" by the + :ref:`ref-classes-uboot-sign` class, "batch" for + non interactive mode and "new" for generating new keys. + + :term:`UBOOT_FIT_KEY_SIGN_PKCS` + Format for the public key certificate used for signing the U-Boot FIT + image. The default value is set to "x509" by the + :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FIT_SIGN_ALG` + Specifies the signature algorithm used in creating the U-Boot FIT Image. + This variable is set by default to "rsa2048" by the + :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FIT_SIGN_NUMBITS` + Size of the private key used in signing the U-Boot FIT image, in number + of bits. The default value for this variable is set to "2048" + by the :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FITIMAGE_ENABLE` + This variable allows to generate a FIT image for U-Boot, which is one + of the ways to implement a verified boot process. + + Its default value is "0", so set it to "1" to enable this functionality:: + + UBOOT_FITIMAGE_ENABLE = "1" + + See the :ref:`ref-classes-uboot-sign` class for details. + + :term:`UBOOT_LOADADDRESS` + Specifies the load address for the U-Boot image. During U-Boot image + creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a + command-line parameter to the ``uboot-mkimage`` utility. + + To pass a 64 bit address, you will also need to set: + + - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. + - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. + + This variable is used by the :ref:`ref-classes-kernel-fitimage`, + :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, + :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` + classes. + + :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` + Specifies the name of the mkimage command as used by the + :ref:`ref-classes-kernel-fitimage` class to assemble + the FIT image. This can be used to substitute an alternative command, wrapper + script or function if desired. The default is "uboot-mkimage". + + :term:`UBOOT_MKIMAGE_DTCOPTS` + Options for the device tree compiler passed to ``mkimage -D`` feature + while creating a FIT image with the :ref:`ref-classes-kernel-fitimage` + class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the + :ref:`ref-classes-kernel-fitimage` class will not pass the ``-D`` option + to ``mkimage``. + + This variable is also used by the :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_MKIMAGE_KERNEL_TYPE` + Specifies the type argument for the kernel as passed to ``uboot-mkimage``. + The default value is "kernel". + + :term:`UBOOT_MKIMAGE_SIGN` + Specifies the name of the mkimage command as used by the + :ref:`ref-classes-kernel-fitimage` class to sign + the FIT image after it has been assembled (if enabled). This can be used + to substitute an alternative command, wrapper script or function if + desired. The default is "${:term:`UBOOT_MKIMAGE`}". + + :term:`UBOOT_MKIMAGE_SIGN_ARGS` + Optionally specifies additional arguments for the + :ref:`ref-classes-kernel-fitimage` class to pass to the + mkimage command when signing the FIT image. + + :term:`UBOOT_RD_ENTRYPOINT` + Specifies the entrypoint for the RAM disk image. During FIT image + creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in + :ref:`ref-classes-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 :term:`UBOOT_RD_LOADADDRESS` variable is used in + :ref:`ref-classes-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". + + This variable is used by the :ref:`ref-classes-kernel-fitimage`, + :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` + classes. + + :term:`UBOOT_SIGN_KEYDIR` + Location of the directory containing the RSA key and certificate used for + signing FIT image, used by the :ref:`ref-classes-kernel-fitimage` and + :ref:`ref-classes-uboot-sign` classes. + + :term:`UBOOT_SIGN_KEYNAME` + The name of keys used by the :ref:`ref-classes-kernel-fitimage` class + for signing U-Boot FIT image stored in the :term:`UBOOT_SIGN_KEYDIR` + directory. If we have for example a ``dev.key`` key and a ``dev.crt`` + certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will + have to set :term:`UBOOT_SIGN_KEYNAME` 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_OPT_IGNORE` + 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, there are common options that are passed to all + configure scripts at a class level, but might not be valid for some + configure scripts. Therefore warnings about these options are useless. + For these cases, the options are added to :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`. + + The configure arguments check that uses + :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` is part of the + :ref:`ref-classes-insane` class and is only enabled if the + recipe inherits the :ref:`ref-classes-autotools` class. + + :term:`UPDATERCPN` + For recipes inheriting the + :ref:`ref-classes-update-rc.d` class, :term:`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_COMMITS` + You can perform a per-recipe check for what the latest upstream + source code version is by calling ``devtool latest-version recipe``. If + the recipe source code is provided from Git repositories, but + releases are not identified by Git tags, set :term:`UPSTREAM_CHECK_COMMITS` + to ``1`` in the recipe, and the OpenEmbedded build system + will compare the latest commit with the one currently specified + by the recipe (:term:`SRCREV`):: + + UPSTREAM_CHECK_COMMITS = "1" + + :term:`UPSTREAM_CHECK_GITTAGREGEX` + You can perform a per-recipe check for what the latest upstream + source code version is by calling ``devtool latest-version 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 :term:`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 :term:`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 ``devtool latest-version 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 :term:`UPSTREAM_CHECK_URI` to provide a different URI that + contains the link to the latest tarball:: + + UPSTREAM_CHECK_URI = "recipe_url" + + :term:`UPSTREAM_VERSION_UNKNOWN` + You can perform a per-recipe check for what the latest upstream + source code version is by calling ``devtool latest-version recipe``. + If no combination of the :term:`UPSTREAM_CHECK_URI`, :term:`UPSTREAM_CHECK_REGEX`, + :term:`UPSTREAM_CHECK_GITTAGREGEX` and :term:`UPSTREAM_CHECK_COMMITS` variables in + the recipe allows to determine what the latest upstream version is, + you can set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` in the recipe + to acknowledge that the check cannot be performed:: + + UPSTREAM_VERSION_UNKNOWN = "1" + + :term:`USE_DEVFS` + Determines if ``devtmpfs`` is used for ``/dev`` population. The + default value used for :term:`USE_DEVFS` is "1" when no value is + specifically set. Typically, you would set :term:`USE_DEVFS` to "0" for a + statically populated ``/dev`` directory. + + See the ":ref:`dev-manual/device-manager: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 <dev-manual/new-recipe:enabling system services>`, + determines whether or not to run a :wikipedia:`getty <Getty_(Unix)>` + on any virtual terminals in order to enable logging in through those + terminals. + + The default value used for :term:`USE_VT` is "1" when no default value is + specifically set. Typically, you would set :term:`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. + + Classes inherited using :term:`USER_CLASSES` must be located in the + ``classes-global/`` or ``classes/`` subdirectories. + + The default list is set in your ``local.conf`` file:: + + USER_CLASSES ?= "buildstats" + + For more information, see + ``meta-poky/conf/templates/default/local.conf.sample`` in the + :term:`Source Directory`. + + :term:`USERADD_DEPENDS` + Specifies a list of recipes that create users / groups (via + :term:`USERADD_PARAM` / :term:`GROUPADD_PARAM`) which a recipe + depends upon. This ensures that those users / groups are available + when building a recipe. + + :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 + :term:`USERADD_ERROR_DYNAMIC` variable is by default not set. If you plan + on using statically assigned ``gid`` and ``uid`` values, you should + set the :term:`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 + :term:`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:`ref-classes-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 :term:`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:`ref-classes-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 + https://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:`VIRTUAL-RUNTIME` + :term:`VIRTUAL-RUNTIME` is a commonly used prefix for defining virtual + packages for runtime usage, typically for use in :term:`RDEPENDS` + or in image definitions. + + An example is ``VIRTUAL-RUNTIME_base-utils`` that makes it possible + to either use BusyBox based utilities:: + + VIRTUAL-RUNTIME_base-utils = "busybox" + + or their full featured implementations from GNU Coreutils + and other projects:: + + VIRTUAL-RUNTIME_base-utils = "packagegroup-core-base-utils" + + Here are two examples using this virtual runtime package. The + first one is in :yocto_git:`initramfs-framework_1.0.bb + </poky/tree/meta/recipes-core/initrdscripts/initramfs-framework_1.0.bb?h=scarthgap>`:: + + RDEPENDS:${PN} += "${VIRTUAL-RUNTIME_base-utils}" + + The second example is in the :yocto_git:`core-image-initramfs-boot + </poky/tree/meta/recipes-core/images/core-image-initramfs-boot.bb?h=scarthgap>` + image definition:: + + PACKAGE_INSTALL = "${INITRAMFS_SCRIPTS} ${VIRTUAL-RUNTIME_base-utils} base-passwd" + + :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, :term:`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:`VOLATILE_TMP_DIR` + Specifies the persistence of the target's ``/tmp`` directory. + + By default, :term:`VOLATILE_TMP_DIR` is set to "yes", in which case + ``/tmp`` links to a directory which resides in RAM in a ``tmpfs`` + filesystem. + + If instead, you want the ``/tmp`` directory to be persistent, set the + variable to "no" to make it a regular directory in the root filesystem. + + This supports both sysvinit and systemd based systems. + + :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:`ref-classes-insane`" section. + + :term:`WATCHDOG_TIMEOUT` + Specifies the timeout in seconds used by the ``watchdog`` recipe and + also by ``systemd`` during reboot. The default is 60 seconds. + + :term:`WIRELESS_DAEMON` + For ``connman`` and ``packagegroup-base``, specifies the wireless + daemon to use. The default is "wpa-supplicant" (note that the value + uses a dash and not an underscore). + + :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/wic: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 :term:`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 :term:`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 + :term:`WKS_FILE_DEPENDS` variable are added to the :term:`DEPENDS` variable. + + With the :term:`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. + Here 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:`WKS_FILES` + Specifies a list of candidate Wic kickstart files to be used by the + OpenEmbedded build system to create a partitioned image. Only the + first one that is found, from left to right, will be used. + + This is only useful when there are multiple ``.wks`` files that can be + used to produce an image. A typical case is when multiple layers are + used for different hardware platforms, each supplying a different + ``.wks`` file. In this case, you specify all possible ones through + :term:`WKS_FILES`. + + If only one ``.wks`` file is used, set :term:`WKS_FILE` instead. + + :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 :term:`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 :term:`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 :term:`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 :term:`XSERVER`, if not specified in the machine + configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". + + :term:`XZ_THREADS` + Specifies the number of parallel threads that should be used when + using xz compression. + + By default this scales with core count, but is never set less than 2 + to ensure that multi-threaded mode is always used so that the output + file contents are deterministic. Builds will work with a value of 1 + but the output will differ compared to the output from the compression + generated when more than one thread is used. + + On systems where many tasks run in parallel, setting a limit to this + can be helpful in controlling system resource usage. + + :term:`XZ_MEMLIMIT` + Specifies the maximum memory the xz compression should use as a percentage + of system memory. If unconstrained the xz compressor can use large amounts of + memory and become problematic with parallelism elsewhere in the build. + "50%" has been found to be a good value. + + :term:`ZSTD_THREADS` + Specifies the number of parallel threads that should be used when + using ZStandard compression. + + By default this scales with core count, but is never set less than 2 + to ensure that multi-threaded mode is always used so that the output + file contents are deterministic. Builds will work with a value of 1 + but the output will differ compared to the output from the compression + generated when more than one thread is used. + + On systems where many tasks run in parallel, setting a limit to this + can be helpful in controlling system resource usage. diff --git a/documentation/ref-manual/varlocality.rst b/documentation/ref-manual/varlocality.rst new file mode 100644 index 0000000000..e2c086ffa0 --- /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` |
