diff options
Diffstat (limited to 'documentation/ref-manual')
44 files changed, 8538 insertions, 10533 deletions
diff --git a/documentation/ref-manual/TODO b/documentation/ref-manual/TODO deleted file mode 100644 index 0510f54710..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 Development 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 index 52a50faf67..9520d0bf7c 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -13,8 +13,14 @@ some default behavior. Any :term:`Metadata` usually found in a recipe can also be placed in a class file. Class files are identified by the extension -``.bbclass`` and are usually placed in a ``classes/`` directory beneath -the ``meta*/`` directory found in the :term:`Source Directory`. +``.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 @@ -22,16 +28,16 @@ in :term:`BBPATH` using the same method by which ``.conf`` files are searched. This chapter discusses only the most useful and important classes. Other -classes do exist within the ``meta/classes`` directory in the Source +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.bbclass`` -=================== +``allarch`` +=========== -The ``allarch`` class is inherited by recipes that do not produce +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 @@ -43,42 +49,43 @@ splitting out of debug symbols during packaging). produce packages that depend on tunings through use of the :term:`RDEPENDS` and :term:`TUNE_PKGARCH` variables, should never be - configured for all architectures using ``allarch``. This is the case + 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 - ``do_package_write_*`` tasks to + :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 ``MACHINE`` is built even when the recipe never changes. + different :term:`MACHINE` is built even when the recipe never changes. -By default, all recipes inherit the :ref:`base <ref-classes-base>` and -:ref:`package <ref-classes-package>` classes, which enable +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 ``allarch`` class. +inherit the :ref:`ref-classes-allarch` class. .. _ref-classes-archiver: -``archiver.bbclass`` -==================== +``archiver`` +============ -The ``archiver`` class supports releasing source code and other +The :ref:`ref-classes-archiver` class supports releasing source code and other materials with the binaries. -For more details on the source archiver, see the -":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" +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*.bbclass`` -====================== +``autotools*`` +============== -The ``autotools*`` classes support Autotooled packages. +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``, @@ -86,16 +93,16 @@ standardization. This class defines a set of tasks (e.g. ``configure``, should usually be enough to define a few standard variables and then simply ``inherit autotools``. These classes can also work with software that emulates Autotools. For more information, see the -":ref:`dev-manual/common-tasks:autotooled package`" section +":ref:`dev-manual/new-recipe:building an autotooled package`" section in the Yocto Project Development Tasks Manual. -By default, the ``autotools*`` classes use out-of-tree builds (i.e. +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 -``autotools-brokensep`` class. The ``autotools-brokensep`` class behaves -the same as the ``autotools`` class but builds with :term:`B` +: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. @@ -105,35 +112,34 @@ support is either not present or is broken. all possible. It's useful to have some idea of how the tasks defined by the -``autotools*`` classes work and what they do behind the scenes. +:ref:`autotools* <ref-classes-autotools>` classes work and what they do behind the scenes. -- :ref:`ref-tasks-configure` - Regenerates the +- :ref:`ref-tasks-configure` --- regenerates the configure script (using ``autoreconf``) and then launches it with a standard set of arguments used during cross-compilation. You can pass - additional parameters to ``configure`` through the ``EXTRA_OECONF`` + additional parameters to ``configure`` through the :term:`EXTRA_OECONF` or :term:`PACKAGECONFIG_CONFARGS` variables. -- :ref:`ref-tasks-compile` - Runs ``make`` with +- :ref:`ref-tasks-compile` --- runs ``make`` with arguments that specify the compiler and linker. You can pass - additional arguments through the ``EXTRA_OEMAKE`` variable. + additional arguments through the :term:`EXTRA_OEMAKE` variable. -- :ref:`ref-tasks-install` - Runs ``make install`` and +- :ref:`ref-tasks-install` --- runs ``make install`` and passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``. .. _ref-classes-base: -``base.bbclass`` -================ +``base`` +======== -The ``base`` class is special in that every ``.bb`` file implicitly +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 classes are often overridden or -extended by other classes such as the -:ref:`autotools <ref-classes-autotools>` class or the -:ref:`package <ref-classes-package>` class. +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 @@ -142,18 +148,18 @@ arguments passed directly to ``oe_runmake``. .. _ref-classes-bash-completion: -``bash-completion.bbclass`` -=========================== +``bash-completion`` +=================== Sets up packaging and dependencies appropriate for recipes that build software that includes bash-completion data. .. _ref-classes-bin-package: -``bin_package.bbclass`` -======================= +``bin_package`` +=============== -The ``bin_package`` class is a helper class for recipes that extract the +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 @@ -168,21 +174,19 @@ example use for this class. the "subpath" parameter limits the checkout to a specific subpath of the tree. Here is an example where ``${BP}`` is used so that the files are extracted into the subdirectory expected by the default value of - ``S``: - :: - - SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}" + :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.bbclass`` -===================== +``binconfig`` +============= -The ``binconfig`` class helps to correct paths in shell scripts. +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 @@ -199,52 +203,33 @@ information. .. _ref-classes-binconfig-disabled: -``binconfig-disabled.bbclass`` -============================== +``binconfig-disabled`` +====================== -An alternative version of the :ref:`binconfig <ref-classes-binconfig>` +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-blacklist: - -``blacklist.bbclass`` -===================== - -The ``blacklist`` class prevents the OpenEmbedded build system from -building specific recipes (blacklists them). To use this class, inherit -the class globally and set :term:`PNBLACKLIST` for -each recipe you wish to blacklist. Specify the :term:`PN` -value as a variable flag (varflag) and provide a reason, which is -reported, if the package is requested to be built as the value. For -example, if you want to blacklist a recipe called "exoticware", you add -the following to your ``local.conf`` or distribution configuration: -:: - - INHERIT += "blacklist" - PNBLACKLIST[exoticware] = "Not supported by our organization." +scripts to be disabled should be specified using the :term:`BINCONFIG` +variable within the recipe inheriting the class. .. _ref-classes-buildhistory: -``buildhistory.bbclass`` -======================== +``buildhistory`` +================ -The ``buildhistory`` class records a history of build output metadata, +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/common-tasks:maintaining build output quality`" +":ref:`dev-manual/build-quality:maintaining build output quality`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-buildstats: -``buildstats.bbclass`` -====================== +``buildstats`` +============== -The ``buildstats`` class records performance statistics about each task +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 @@ -258,124 +243,224 @@ Collecting build statistics is enabled by default through the :term:`USER_CLASSES` variable from your ``local.conf`` file. Consequently, you do not have to do anything to enable the class. However, if you want to disable the class, simply -remove "buildstats" from the ``USER_CLASSES`` list. +remove ":ref:`ref-classes-buildstats`" from the :term:`USER_CLASSES` list. .. _ref-classes-buildstats-summary: -``buildstats-summary.bbclass`` -============================== +``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:`buildstats <ref-classes-buildstats>` class be enabled. +: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.bbclass`` -================== +``ccache`` +========== -The ``ccache`` class enables the C/C++ Compiler Cache for the build. +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. -However, using the class can lead to unexpected side-effects. Thus, it -is recommended that you do not use this class. See -https://ccache.samba.org/ for information on the C/C++ Compiler -Cache. + +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.bbclass`` -=================== +``chrpath`` +=========== -The ``chrpath`` class is a wrapper around the "chrpath" utility, which -is used during the build process for ``nativesdk``, ``cross``, and -``cross-canadian`` recipes to change ``RPATH`` records within binaries +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-clutter: +.. _ref-classes-cmake: -``clutter.bbclass`` -=================== +``cmake`` +========= -The ``clutter`` class consolidates the major and minor version naming -and other common items used by Clutter and related recipes. +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. -.. note:: +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. - 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. +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: +.. _ref-classes-cmake-qemu: -``cmake.bbclass`` -================= +``cmake-qemu`` +============== -The ``cmake`` class allows for recipes that need 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 be passed using the ``cmake`` -command line. +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. -On the occasion that you would be installing custom CMake toolchain -files supplied by the application being built, you should install them -to the preferred CMake Module directory: ``${D}${datadir}/cmake/`` -Modules during -:ref:`ref-tasks-install`. +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.bbclass`` -================ +``cml1`` +======== -The ``cml1`` class provides basic support for the Linux kernel style -build configuration system. +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.bbclass`` -======================== +``compress_doc`` +================ -Enables compression for man pages and info pages. This class is intended +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.bbclass`` -=============================== +``copyleft_compliance`` +======================= -The ``copyleft_compliance`` class preserves source code for the purposes -of license compliance. This class is an alternative to the ``archiver`` +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:`archiver <ref-classes-archiver>` class. +in favor of the :ref:`ref-classes-archiver` class. .. _ref-classes-copyleft_filter: -``copyleft_filter.bbclass`` -=========================== +``copyleft_filter`` +=================== -A class used by the :ref:`archiver <ref-classes-archiver>` and -:ref:`copyleft_compliance <ref-classes-copyleft_compliance>` classes +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.bbclass`` -====================== +``core-image`` +============== -The ``core-image`` class provides common definitions for the +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*.bbclass`` -================= +``cpan*`` +========= -The ``cpan*`` classes support Perl modules. +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. @@ -388,23 +473,49 @@ authors used. - Modules that use ``Build.PL``-based build system require using ``cpan_build.bbclass`` in their recipes. -Both build methods inherit the ``cpan-base`` class for basic Perl +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.bbclass`` -================= +``cross`` +========= -The ``cross`` class provides support for the recipes that build the +The :ref:`ref-classes-cross` class provides support for the recipes that build the cross-compilation tools. .. _ref-classes-cross-canadian: -``cross-canadian.bbclass`` -========================== +``cross-canadian`` +================== -The ``cross-canadian`` class provides support for the recipes that build +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 @@ -412,21 +523,92 @@ discussion on these cross-compilation tools. .. _ref-classes-crosssdk: -``crosssdk.bbclass`` -==================== +``crosssdk`` +============ -The ``crosssdk`` class provides support for the recipes that build the +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.bbclass`` -================== +``debian`` +========== -The ``debian`` class renames output packages so that they follow the +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. @@ -438,10 +620,10 @@ naming scheme. .. _ref-classes-deploy: -``deploy.bbclass`` -================== +``deploy`` +========== -The ``deploy`` class handles deploying files to the +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 @@ -450,84 +632,109 @@ deployed to :term:`DEPLOYDIR`, and use ``addtask`` to add the task at the appropriate place, which is usually after :ref:`ref-tasks-compile` or :ref:`ref-tasks-install`. The class then takes care of -staging the files from ``DEPLOYDIR`` to ``DEPLOY_DIR_IMAGE``. +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.bbclass`` -==================== +``devshell`` +============ -The ``devshell`` class adds the ``do_devshell`` task. Distribution -policy dictates whether to include this class. See the ":ref:`dev-manual/common-tasks:using a development shell`" +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 ``devshell``. +information about using :ref:`ref-classes-devshell`. .. _ref-classes-devupstream: -``devupstream.bbclass`` -======================= +``devupstream`` +=============== -The ``devupstream`` class uses +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. Following is an example: -:: +tarball. Here is an example:: BBCLASSEXTEND = "devupstream:target" - SRC_URI_class-devupstream = "git://git.example.com/example" - SRCREV_class-devupstream = "abcd1234" + 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: -:: +``class-devupstream`` override. Here is an example:: - DEPENDS_append_class-devupstream = " gperf-native" - do_configure_prepend_class-devupstream() { + DEPENDS:append:class-devupstream = " gperf-native" + do_configure:prepend:class-devupstream() { touch ${S}/README } The class currently only supports creating a development variant of the target -recipe, not ``native`` or ``nativesdk`` variants. +recipe, not :ref:`ref-classes-native` or :ref:`ref-classes-nativesdk` variants. -The ``BBCLASSEXTEND`` syntax (i.e. ``devupstream:target``) provides -support for ``native`` and ``nativesdk`` variants. Consequently, this +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-distutils3: - -``distutils3*.bbclass`` -======================= - -The ``distutils3*`` classes support recipes for Python version 3.x -extensions, which are simple. These recipes usually only need to point -to the source's archive and then inherit the proper class. Building is -split into three methods depending on which method the module authors -used. - -- Extensions that use an Autotools-based build system require Autotools - and ``distutils``-based classes in their recipes. - -- Extensions that use ``distutils``-based build systems require the - ``distutils`` class in their recipes. - -- Extensions that use build systems based on ``setuptools3`` require - the :ref:`setuptools3 <ref-classes-setuptools3>` class in their - recipes. - .. _ref-classes-externalsrc: -``externalsrc.bbclass`` -======================= +``externalsrc`` +=============== -The ``externalsrc`` class supports building software from source code +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. @@ -535,37 +742,34 @@ unpack, and patch process is not used. By default, the OpenEmbedded build system uses the :term:`S` and :term:`B` variables to locate unpacked recipe source code and to build it, respectively. When your recipe inherits the -``externalsrc`` class, you use the -:term:`EXTERNALSRC` and -:term:`EXTERNALSRC_BUILD` variables to -ultimately define ``S`` and ``B``. +: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 ``B`` directory is set to the -following, which is separate from the source directory (``S``): -:: +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}/ + ${WORKDIR}/${BPN}-{PV}/ See these variables for more information: :term:`WORKDIR`, :term:`BPN`, and :term:`PV`, -For more information on the ``externalsrc`` class, see the comments in +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 -``externalsrc`` class, see the -":ref:`dev-manual/common-tasks:building software from an external source`" +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.bbclass`` -====================== +``extrausers`` +============== -The ``extrausers`` class allows additional user and group configuration +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 @@ -573,16 +777,13 @@ be performed using the .. note:: - The user and group operations added using the - extrausers + 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 - useradd - class to add user and group configuration to a specific recipe. + 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: -:: +Here is an example that uses this class in an image recipe:: inherit extrausers EXTRA_USERS_PARAMS = "\ @@ -595,31 +796,42 @@ Here is an example that uses this class in an image recipe: " Here is an example that adds two users named "tester-jim" and "tester-sue" and assigns -passwords: -:: +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 tester01 tester-jim; \ - useradd -P tester01 tester-sue; \ + useradd -p '${PASSWD}' tester-jim; \ + useradd -p '${PASSWD}' tester-sue; \ " -Finally, here is an example that sets the root password to "1876*18": -:: +Finally, here is an example that sets the root password:: inherit extrausers EXTRA_USERS_PARAMS = "\ - usermod -P 1876*18 root; \ + 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.bbclass`` -================================= +``features_check`` +================== -The ``features_check`` class allows individual recipes to check -for required and conflicting -:term:`DISTRO_FEATURES`, :term:`MACHINE_FEATURES` or :term:`COMBINED_FEATURES`. +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: @@ -640,10 +852,10 @@ triggered. .. _ref-classes-fontcache: -``fontcache.bbclass`` -===================== +``fontcache`` +============= -The ``fontcache`` class generates the proper post-install and +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 @@ -656,20 +868,20 @@ packages containing the fonts. .. _ref-classes-fs-uuid: -``fs-uuid.bbclass`` -=================== +``fs-uuid`` +=========== -The ``fs-uuid`` class extracts UUID from +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 ``fs-uuid`` class only +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.bbclass`` -================= +``gconf`` +========= -The ``gconf`` class provides common functionality for recipes that need +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 @@ -678,29 +890,80 @@ register and unregister the schemas in the target image. .. _ref-classes-gettext: -``gettext.bbclass`` -=================== +``gettext`` +=========== -The ``gettext`` class provides support for building software that uses -the GNU ``gettext`` internationalization and localization system. All -recipes building software that use ``gettext`` should inherit this +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.bbclass`` -===================== +``gnomebase`` +============= -The ``gnomebase`` class is the base class for recipes that build +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.bbclass`` -================================= +``gobject-introspection`` +========================= Provides support for recipes building software that supports GObject introspection. This functionality is only enabled if the @@ -711,16 +974,17 @@ introspection. This functionality is only enabled if the .. note:: - This functionality is backfilled by default and, if not applicable, - should be disabled through ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` or - ``MACHINE_FEATURES_BACKFILL_CONSIDERED``, respectively. + 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.bbclass`` -==================== +``grub-efi`` +============ -The ``grub-efi`` class provides ``grub-efi``-specific functions for +The :ref:`ref-classes-grub-efi` class provides ``grub-efi``-specific functions for building bootable images. This class supports several variables: @@ -749,10 +1013,10 @@ This class supports several variables: .. _ref-classes-gsettings: -``gsettings.bbclass`` -===================== +``gsettings`` +============= -The ``gsettings`` class provides common functionality for recipes that +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 @@ -760,18 +1024,18 @@ schemas in the target image. .. _ref-classes-gtk-doc: -``gtk-doc.bbclass`` -=================== +``gtk-doc`` +=========== -The ``gtk-doc`` class is a helper class to pull in the appropriate +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.bbclass`` -========================== +``gtk-icon-cache`` +================== -The ``gtk-icon-cache`` class generates the proper post-install and +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 @@ -781,10 +1045,10 @@ creation. .. _ref-classes-gtk-immodules-cache: -``gtk-immodules-cache.bbclass`` -=============================== +``gtk-immodules-cache`` +======================= -The ``gtk-immodules-cache`` class generates the proper post-install and +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. @@ -799,19 +1063,19 @@ the packages containing the modules. .. _ref-classes-gzipnative: -``gzipnative.bbclass`` -====================== +``gzipnative`` +============== -The ``gzipnative`` class enables the use of different native versions of +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.bbclass`` -================= +``icecc`` +========= -The ``icecc`` class supports +The :ref:`ref-classes-icecc` class supports `Icecream <https://github.com/icecc/icecream>`__, which facilitates taking compile jobs and distributing them among remote machines. @@ -819,7 +1083,7 @@ The class stages directories with symlinks from ``gcc`` and ``g++`` to ``icecc``, for both native and cross compilers. Depending on each configure or compile, the OpenEmbedded build system adds the directories at the head of the ``PATH`` list and then sets the ``ICECC_CXX`` and -``ICEC_CC`` variables, which are the paths to the ``g++`` and ``gcc`` +``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 @@ -827,8 +1091,8 @@ 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 +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. @@ -838,67 +1102,66 @@ using ``which``. If :term:`ICECC_ENV_EXEC` is set in your ``local.conf`` file, the variable should point to the ``icecc-create-env`` script provided by the user. If you do not point to a user-provided script, the build system uses the default script -provided by the recipe ``icecc-create-env-native.bb``. +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 - icecc. + ``icecream``. If you do not want the Icecream distributed compile support to apply to -specific recipes or classes, you can effectively "blacklist" them by -listing the recipes and classes using the -:term:`ICECC_USER_PACKAGE_BL` and -:term:`ICECC_USER_CLASS_BL`, variables, +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_USER_PACKAGE_WL` variable in +: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 ``icecc`` class changes all sstate signatures. +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 ``SSTATE_MIRRORS``, then all developers and the build -system need to either inherit the ``icecc`` class or nobody should. +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 ``icecc`` class to be +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: -:: +:term:`ICECC_DISABLED` variable to "1" as follows:: - INHERIT_DISTRO_append = " icecc" + 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: -:: +individually as follows in your ``local.conf`` file:: ICECC_DISABLED = "" .. _ref-classes-image: -``image.bbclass`` -================= +``image`` +========= -The ``image`` class helps support creating images in different formats. +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 ``IMAGE_FSTYPES`` variable controls the types of images to +- The :term:`IMAGE_FSTYPES` variable controls the types of images to generate. -- The ``IMAGE_INSTALL`` variable controls the list of packages to +- 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/common-tasks:customizing images`" section +":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 @@ -906,49 +1169,66 @@ Yocto Project Overview and Concepts Manual. .. _ref-classes-image-buildinfo: -``image-buildinfo.bbclass`` -=========================== +``image-buildinfo`` +=================== -The ``image-buildinfo`` class writes information to the target -filesystem on ``/etc/build``. +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.bbclass`` -======================= +``image_types`` +=============== -The ``image_types`` class defines all of the standard image output 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:`image <ref-classes-image>` class automatically -enables the ``image_types`` class. The ``image`` class uses the -``IMGCLASSES`` variable as follows: -:: +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}" - IMGCLASSES += "${@['populate_sdk_base', 'populate_sdk_ext']['linux' in d.getVar("SDK_OS")]}" + # 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" - inherit ${IMGCLASSES} + IMGCLASSES += "overlayfs-etc" + inherit_defer ${IMGCLASSES} -The ``image_types`` class also handles conversion and compression of images. +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 - ``IMAGE_FSTYPES``. This would also be similar for Virtual Box Virtual Disk + :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.bbclass`` -====================== +``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 @@ -958,43 +1238,12 @@ specified by :term:`EFI_PROVIDER` if Normally, you do not use this class directly. Instead, you add "live" to :term:`IMAGE_FSTYPES`. -.. _ref-classes-image-mklibs: - -``image-mklibs.bbclass`` -======================== - -The ``image-mklibs`` class enables the use of the ``mklibs`` utility -during the :ref:`ref-tasks-rootfs` task, which optimizes -the size of libraries contained in the image. - -By default, the class is enabled in the ``local.conf.template`` using -the :term:`USER_CLASSES` variable as follows: -:: - - USER_CLASSES ?= "buildstats image-mklibs image-prelink" - -.. _ref-classes-image-prelink: - -``image-prelink.bbclass`` -========================= - -The ``image-prelink`` class enables the use of the ``prelink`` utility -during the :ref:`ref-tasks-rootfs` task, which optimizes -the dynamic linking of shared libraries to reduce executable startup -time. - -By default, the class is enabled in the ``local.conf.template`` using -the :term:`USER_CLASSES` variable as follows: -:: - - USER_CLASSES ?= "buildstats image-mklibs image-prelink" - .. _ref-classes-insane: -``insane.bbclass`` -================== +``insane`` +========== -The ``insane`` class adds a step to the package generation process so +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 @@ -1014,17 +1263,16 @@ 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: -:: +package name override, in this example ``${PN}``, must be used:: - INSANE_SKIP_${PN} += "dev-so" + INSANE_SKIP:${PN} += "dev-so" Please keep in mind that the QA checks -exist in order to detect real or potential problems in the packaged +are meant to detect real or potential problems in the packaged output. So exercise caution when disabling these checks. -The following list shows the tests you can list with the ``WARN_QA`` and -``ERROR_QA`` variables: +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 @@ -1041,8 +1289,8 @@ The following list shows the tests you can list with the ``WARN_QA`` and software, like bootloaders, might need to bypass this check. - ``buildpaths:`` Checks for paths to locations on the build host - inside the output files. Currently, this test triggers too many false - positives and thus is not normally enabled. + 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 @@ -1055,20 +1303,30 @@ The following list shows the tests you can list with the ``WARN_QA`` and the package is installed into the image during the :ref:`ref-tasks-rootfs` task because the auto-detected dependency was not satisfied. An example of this would be where the - :ref:`update-rc.d <ref-classes-update-rc.d>` class automatically + :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 - ``RDEPENDS`` for the package in question on ``initscripts-functions`` + :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. @@ -1099,10 +1357,15 @@ The following list shows the tests you can list with the ``WARN_QA`` and - ``dev-so:`` Checks that the ``.so`` symbolic links are in the ``-dev`` package and not in any of the other packages. In general, these symlinks are only useful for development purposes. Thus, the - ``-dev`` package is the correct location for them. Some very rare - cases do exist for dynamically loaded modules where these symlinks + ``-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``. @@ -1137,12 +1400,12 @@ The following list shows the tests you can list with the ``WARN_QA`` and might result in host contamination of the build output. - ``installed-vs-shipped:`` Reports when files have been installed - within ``do_install`` but have not been included in any package by + 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 - ``do_install`` if the files are not needed in any package. + :ref:`ref-tasks-install` if the files are not needed in any package. - ``invalid-chars:`` Checks that the recipe metadata variables :term:`DESCRIPTION`, @@ -1152,18 +1415,17 @@ The following list shows the tests you can list with the ``WARN_QA`` and - ``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: - :: + example, any name "foo" for which the following form does not exist:: PACKAGECONFIG[foo] = "..." -- ``la:`` Checks ``.la`` files for any ``TMPDIR`` paths. Any ``.la`` +- ``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 ``LDFLAGS`` variable is being + 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 @@ -1176,11 +1438,39 @@ The following list shows the tests you can list with the ``WARN_QA`` and ``/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. @@ -1203,7 +1493,7 @@ The following list shows the tests you can list with the ``WARN_QA`` and invalid characters (i.e. characters other than 0-9, a-z, ., +, and -). -- ``pkgv-undefined:`` Checks to see if the ``PKGV`` variable is +- ``pkgv-undefined:`` Checks to see if the :term:`PKGV` variable is undefined during :ref:`ref-tasks-package`. - ``pkgvarcheck:`` Checks through the variables @@ -1223,23 +1513,31 @@ The following list shows the tests you can list with the ``WARN_QA`` and - ``pn-overrides:`` Checks that a recipe does not have a name (:term:`PN`) value that appears in :term:`OVERRIDES`. If a recipe is named such that - its ``PN`` value matches something already in ``OVERRIDES`` (e.g. - ``PN`` happens to be the same as :term:`MACHINE` or + 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 + For example, assignments such as ``FILES:${PN} = "xyz"`` effectively turn into ``FILES = "xyz"``. - ``rpaths:`` Checks for rpaths in the binaries that contain build - system paths such as ``TMPDIR``. If this test fails, bad ``-rpath`` + 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. @@ -1250,33 +1548,52 @@ The following list shows the tests you can list with the ``WARN_QA`` and ":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`). + 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 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. +- ``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:: - If you are not using runtime package management on your target - system, then you do not need to worry about this situation. + 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 @@ -1286,184 +1603,188 @@ The following list shows the tests you can list with the ``WARN_QA`` and automatically get these versions. Consequently, you should only need to explicitly add dependencies to binary driver recipes. -.. _ref-classes-insserv: - -``insserv.bbclass`` -=================== - -The ``insserv`` class uses the ``insserv`` utility to update the order -of symbolic links in ``/etc/rc?.d/`` within an image based on -dependencies specified by LSB headers in the ``init.d`` scripts -themselves. - .. _ref-classes-kernel: -``kernel.bbclass`` -================== +``kernel`` +========== -The ``kernel`` class handles building Linux kernels. The class contains +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 -``STAGING_KERNEL_DIR`` directory to allow out-of-tree module builds -using the :ref:`module <ref-classes-module>` class. - -This means that each built kernel module is packaged separately and -inter-module dependencies are created by parsing the ``modinfo`` output. -If all modules are required, then installing the ``kernel-modules`` -package installs all packages with modules and various other kernel -packages such as ``kernel-vmlinux``. - -The ``kernel`` class contains logic that allows you to embed an initial -RAM filesystem (initramfs) image when you build the kernel image. For -information on how to build an initramfs, see the -":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section in +: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 ``kernel`` and ``module`` classes -internally including the :ref:`kernel-arch <ref-classes-kernel-arch>`, -:ref:`module-base <ref-classes-module-base>`, and -:ref:`linux-kernel-base <ref-classes-linux-kernel-base>` classes. +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.bbclass`` -======================= +``kernel-arch`` +=============== -The ``kernel-arch`` class sets the ``ARCH`` environment variable for +The :ref:`ref-classes-kernel-arch` class sets the ``ARCH`` environment variable for Linux kernel compilation (including modules). .. _ref-classes-kernel-devicetree: -``kernel-devicetree.bbclass`` -============================= +``kernel-devicetree`` +===================== + +The :ref:`ref-classes-kernel-devicetree` class, which is inherited by the +:ref:`ref-classes-kernel` class, supports device tree generation. -The ``kernel-devicetree`` class, which is inherited by the -:ref:`kernel <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.bbclass`` -=========================== +``kernel-fitimage`` +=================== -The ``kernel-fitimage`` class provides support to pack a kernel image, -device trees, a U-boot script, a Initramfs bundle and a RAM disk +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, Initramfs bundles, RAM disks and device-trees. -However, ``kernel-fitimage`` currently only supports -limited usescases: just one kernel image, an optional U-boot script, -an optional Initramfs bundle, an optional RAM disk, and any number of -device tree. +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 "kernel-fitimage" and :term:`KERNEL_IMAGETYPE` -is set to "fitImage". +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 -``kernel-fitimage`` and the kernel image in FIT is mandatory. The +: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`. +: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 -``kernel-fitimage`` and the device tree is optional. +: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 -``kernel-fitimage`` and the RAM disk in FIT is optional. +: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 FIT image when -:term:`INITRAMFS_IMAGE` is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` -is set to 0. +: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 Initramfs bundle can be added to the FIT image created by -``kernel-fitimage`` and the Initramfs bundle in FIT is optional. -In case of Initramfs, the kernel is configured to be bundled with the rootfs +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 Initramfs rootfs. -The Initramfs bundle can be enabled when :term:`INITRAMFS_IMAGE` -is specified and that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1. -The address where the Initramfs bundle is to be loaded by U-boot is specified +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 -``kernel-fitimage`` and the boot script is optional. +: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 ``do_install`` task to copy the script to sysroot. -So the script can be included in the FIT image by the ``kernel-fitimage`` +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 executes it. +load the boot script from the FIT image and execute it. -The FIT image generated by ``kernel-fitimage`` class is signed when the +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 ``kernel-fitimage`` are "sha256" and -"rsa2048" respectively. The keys for signing fitImage can be generated using -the ``kernel-fitimage`` class when both :term:`FIT_GENERATE_KEYS` and +:term:`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.bbclass`` -======================= +``kernel-grub`` +=============== -The ``kernel-grub`` class updates the boot area and the boot menu with +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.bbclass`` -=============================== +``kernel-module-split`` +======================= -The ``kernel-module-split`` class provides common functionality for +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.bbclass`` -======================== +``kernel-uboot`` +================ -The ``kernel-uboot`` class provides support for building from +The :ref:`ref-classes-kernel-uboot` class provides support for building from vmlinux-style kernel sources. .. _ref-classes-kernel-uimage: -``kernel-uimage.bbclass`` -========================= +``kernel-uimage`` +================= -The ``kernel-uimage`` class provides support to pack uImage. +The :ref:`ref-classes-kernel-uimage` class provides support to pack uImage. .. _ref-classes-kernel-yocto: -``kernel-yocto.bbclass`` -======================== +``kernel-yocto`` +================ -The ``kernel-yocto`` class provides common functionality for building +The :ref:`ref-classes-kernel-yocto` class provides common functionality for building from linux-yocto style kernel source repositories. .. _ref-classes-kernelsrc: -``kernelsrc.bbclass`` -===================== +``kernelsrc`` +============= -The ``kernelsrc`` class sets the Linux kernel source and version. +The :ref:`ref-classes-kernelsrc` class sets the Linux kernel source and version. .. _ref-classes-lib_package: -``lib_package.bbclass`` -======================= +``lib_package`` +=============== -The ``lib_package`` class supports recipes that build libraries and +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 @@ -1471,40 +1792,40 @@ make their installation optional. .. _ref-classes-libc*: -``libc*.bbclass`` -================= +``libc*`` +========= -The ``libc*`` classes support recipes that build packages with ``libc``: +The :ref:`ref-classes-libc*` classes support recipes that build packages with ``libc``: -- The ``libc-common`` class provides common support for building with +- The :ref:`libc-common <ref-classes-libc*>` class provides common support for building with ``libc``. -- The ``libc-package`` class supports packaging up ``glibc`` and +- The :ref:`libc-package <ref-classes-libc*>` class supports packaging up ``glibc`` and ``eglibc``. .. _ref-classes-license: -``license.bbclass`` -=================== +``license`` +=========== -The ``license`` class provides license manifest creation and 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.bbclass`` -============================= +``linux-kernel-base`` +===================== -The ``linux-kernel-base`` class provides common functionality for +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.bbclass`` -======================= +``linuxloader`` +=============== Provides the function ``linuxloader()``, which gives the value of the dynamic loader/linker provided on the platform. This value is used by a @@ -1512,80 +1833,101 @@ number of other classes. .. _ref-classes-logging: -``logging.bbclass`` -=================== +``logging`` +=========== -The ``logging`` class provides the standard shell functions used to log +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 ``base`` +This class is enabled by default since it is inherited by the :ref:`ref-classes-base` class. -.. _ref-classes-meta: +.. _ref-classes-meson: -``meta.bbclass`` -================ +``meson`` +========= -The ``meta`` class is inherited by recipes that do not build any output -packages themselves, but act as a "meta" target for building other -recipes. +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.bbclass`` -======================== +``metadata_scm`` +================ -The ``metadata_scm`` class provides functionality for querying the +The :ref:`ref-classes-metadata_scm` class provides functionality for querying the branch and revision of a Source Code Manager (SCM) repository. -The :ref:`base <ref-classes-base>` class uses this class to print the -revisions of each layer before starting every build. The -``metadata_scm`` class is enabled by default because it is inherited by -the ``base`` class. +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.bbclass`` -============================== +``migrate_localcount`` +====================== -The ``migrate_localcount`` class verifies a recipe's localcount data and +The :ref:`ref-classes-migrate_localcount` class verifies a recipe's localcount data and increments it appropriately. .. _ref-classes-mime: -``mime.bbclass`` -================ +``mime`` +======== -The ``mime`` class generates the proper post-install and post-remove +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.bbclass`` -=================== +``mirrors`` +=========== -The ``mirrors`` class sets up some standard +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:`base <ref-classes-base>` class. +:ref:`ref-classes-base` class. .. _ref-classes-module: -``module.bbclass`` -================== +``module`` +========== -The ``module`` class provides support for building out-of-tree Linux -kernel modules. The class inherits the -:ref:`module-base <ref-classes-module-base>` and -:ref:`kernel-module-split <ref-classes-kernel-module-split>` classes, -and implements the :ref:`ref-tasks-compile` and -:ref:`ref-tasks-install` tasks. The class provides +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 @@ -1594,50 +1936,49 @@ section in the Yocto Project Linux Kernel Development Manual. .. _ref-classes-module-base: -``module-base.bbclass`` -======================= +``module-base`` +=============== -The ``module-base`` class provides the base functionality for building -Linux kernel modules. Typically, a recipe that builds software that -includes one or more kernel modules and has its own means of building -the module inherits this class as opposed to inheriting the -:ref:`module <ref-classes-module>` class. +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*.bbclass`` -===================== +``multilib*`` +============= -The ``multilib*`` classes provide support for building libraries with +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/common-tasks:combining multiple versions of library files into one image`" +":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.bbclass`` -================== +``native`` +========== -The ``native`` class provides common functionality for recipes that +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 ``native`` +- 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 - ``native`` class is inherited last. + :ref:`ref-classes-native` class is inherited last. .. note:: When creating a recipe this way, the recipe name must follow this - naming convention: - :: + naming convention:: myrecipe-native.bb @@ -1645,79 +1986,76 @@ a couple different ways: 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: - :: +- Create or modify a target recipe that contains the following:: BBCLASSEXTEND = "native" Inside the - recipe, use ``_class-native`` and ``_class-target`` overrides to + recipe, use ``:class-native`` and ``:class-target`` overrides to specify any functionality specific to the respective native or target case. -Although applied differently, the ``native`` class is used with both +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.bbclass`` -===================== +``nativesdk`` +============= -The ``nativesdk`` class provides common functionality for recipes that +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 - ``nativesdk`` class. If you use this method, you must order the +- 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 ``nativesdk`` class is inherited last. + that the :ref:`ref-classes-nativesdk` class is inherited last. -- Create a ``nativesdk`` variant of any recipe by adding the following: - :: +- 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 + 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: - :: + When creating a recipe, you must follow this naming convention:: nativesdk-myrecipe.bb - Not doing so can lead to subtle problems because code exists that + Not doing so can lead to subtle problems because there is code that depends on the naming convention. -Although applied differently, the ``nativesdk`` class is used with both +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.bbclass`` -====================== +``nopackages`` +============== Disables packaging tasks for those recipes and classes where packaging is not needed. .. _ref-classes-npm: -``npm.bbclass`` -=============== +``npm`` +======= -Provides support for building Node.js software fetched using the `node -package manager (NPM) <https://en.wikipedia.org/wiki/Npm_(software)>`__. +Provides support for building Node.js software fetched using the +:wikipedia:`node package manager (NPM) <Npm_(software)>`. .. note:: @@ -1725,77 +2063,175 @@ package manager (NPM) <https://en.wikipedia.org/wiki/Npm_(software)>`__. fetcher to have dependencies fetched and packaged automatically. For information on how to create NPM packages, see the -":ref:`dev-manual/common-tasks:creating node package manager (npm) packages`" +":ref:`dev-manual/packages:creating node package manager (npm) packages`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-oelint: -``oelint.bbclass`` -================== +``oelint`` +========== -The ``oelint`` class is an obsolete lint checking tool that exists in +The :ref:`ref-classes-oelint` class is an obsolete lint checking tool available in ``meta/classes`` in the :term:`Source Directory`. -A number of classes exist that could be generally useful in OE-Core but -are never actually used within OE-Core itself. The ``oelint`` class is +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.bbclass`` -======================= +``own-mirrors`` +=============== -The ``own-mirrors`` class makes it easier to set up your own +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: -:: +:term:`SOURCE_MIRROR_URL`. Here is an example:: INHERIT += "own-mirrors" SOURCE_MIRROR_URL = "http://example.com/my-source-mirror" You can specify only a single URL -in ``SOURCE_MIRROR_URL``. +in :term:`SOURCE_MIRROR_URL`. .. _ref-classes-package: -``package.bbclass`` -=================== +``package`` +=========== -The ``package`` class supports generating packages from a build's +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:`package_deb <ref-classes-package_deb>`, -:ref:`package_rpm <ref-classes-package_rpm>`, -:ref:`package_ipk <ref-classes-package_ipk>`, and -:ref:`package_tar <ref-classes-package_tar>`. - -.. note:: - - The - package_tar - class is broken and not supported. It is recommended that you do not - use this class. +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 -``PACKAGE_CLASSES`` variable defined in your ``conf/local.conf`` +: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. +When defining the variable, you can specify one or more package types. +Since images are generated from packages, a packaging class is needed +to enable image generation. The first class listed in this variable is +used for image generation. If you take the optional step to set up a repository (package feed) on the development host that can be used by DNF, you can install packages from the feed while you are running the image on the target (i.e. runtime installation of packages). For more information, see the -":ref:`dev-manual/common-tasks:using runtime package management`" +":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 @@ -1805,8 +2241,8 @@ the same or similar package. This comparison takes into account a complete build of the package with all dependencies previously built. The reason for this discrepancy is because the RPM package manager creates and processes more :term:`Metadata` than the IPK package -manager. Consequently, you might consider setting ``PACKAGE_CLASSES`` to -"package_ipk" if you are building smaller systems. +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: @@ -1831,120 +2267,200 @@ at these two Yocto Project mailing list links: .. _ref-classes-package_deb: -``package_deb.bbclass`` -======================= +``package_deb`` +=============== -The ``package_deb`` class provides support for creating packages that +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:`package <ref-classes-package>` class and +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.bbclass`` -======================= +``package_ipk`` +=============== -The ``package_ipk`` class provides support for creating packages that +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:`package <ref-classes-package>` class and +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.bbclass`` -======================= +``package_rpm`` +=============== -The ``package_rpm`` class provides support for creating packages that +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:`package <ref-classes-package>` class and -is enabled through the :term:`PACKAGE_CLASSES` -variable in the ``local.conf`` file. - -.. _ref-classes-package_tar: - -``package_tar.bbclass`` -======================= - -The ``package_tar`` class provides support for creating tarballs. The -class ensures the packages are written out in a tarball format to the -``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory. - -This class inherits the :ref:`package <ref-classes-package>` class and +This class inherits the :ref:`ref-classes-package` class and is enabled through the :term:`PACKAGE_CLASSES` variable in the ``local.conf`` file. -.. note:: - - You cannot specify the ``package_tar`` class first using the - ``PACKAGE_CLASSES`` variable. You must use ``.deb``, ``.ipk``, or ``.rpm`` - file formats for your image or SDK. - .. _ref-classes-packagedata: -``packagedata.bbclass`` -======================= +``packagedata`` +=============== -The ``packagedata`` class provides common functionality for reading +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:`package <ref-classes-package>` class. +:ref:`ref-classes-package` class. .. _ref-classes-packagegroup: -``packagegroup.bbclass`` -======================== +``packagegroup`` +================ -The ``packagegroup`` class sets default values appropriate for package -group recipes (e.g. ``PACKAGES``, ``PACKAGE_ARCH``, ``ALLOW_EMPTY``, and +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/common-tasks:customizing images using custom package groups`" +":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.bbclass`` -================= +``patch`` +========= -The ``patch`` class provides all functionality for applying patches +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:`base <ref-classes-base>` class. +:ref:`ref-classes-base` class. .. _ref-classes-perlnative: -``perlnative.bbclass`` -====================== +``perlnative`` +============== -When inherited by a recipe, the ``perlnative`` class supports using the +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.bbclass`` -======================= +``pixbufcache`` +=============== -The ``pixbufcache`` class generates the proper post-install and +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. @@ -1959,24 +2475,24 @@ containing the loaders. .. _ref-classes-pkgconfig: -``pkgconfig.bbclass`` -===================== +``pkgconfig`` +============= -The ``pkgconfig`` class provides a standard way to get header and +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 ``pkgconfig`` class no longer has to manipulate the +``pkg-config``, the :ref:`ref-classes-pkgconfig` class no longer has to manipulate the files. .. _ref-classes-populate-sdk: -``populate_sdk.bbclass`` -======================== +``populate_sdk`` +================ -The ``populate_sdk`` class provides support for SDK-only recipes. For +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`" @@ -1985,40 +2501,39 @@ Software Development Kit (eSDK) manual. .. _ref-classes-populate-sdk-*: -``populate_sdk_*.bbclass`` -========================== +``populate_sdk_*`` +================== -The ``populate_sdk_*`` classes support SDK creation and consist of the +The :ref:`ref-classes-populate-sdk-*` classes support SDK creation and consist of the following classes: -- ``populate_sdk_base``: The base class supporting SDK creation under +- :ref:`populate_sdk_base <ref-classes-populate-sdk-*>`: The base class supporting SDK creation under all package managers (i.e. DEB, RPM, and opkg). -- ``populate_sdk_deb``: Supports creation of the SDK given the Debian +- :ref:`populate_sdk_deb <ref-classes-populate-sdk-*>`: Supports creation of the SDK given the Debian package manager. -- ``populate_sdk_rpm``: Supports creation of the SDK given the RPM +- :ref:`populate_sdk_rpm <ref-classes-populate-sdk-*>`: Supports creation of the SDK given the RPM package manager. -- ``populate_sdk_ipk``: Supports creation of the SDK given the opkg +- :ref:`populate_sdk_ipk <ref-classes-populate-sdk-*>`: Supports creation of the SDK given the opkg (IPK format) package manager. -- ``populate_sdk_ext``: Supports extensible SDK creation under all +- :ref:`populate_sdk_ext <ref-classes-populate-sdk-*>`: Supports extensible SDK creation under all package managers. -The ``populate_sdk_base`` class inherits the appropriate +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 -``populate_sdk_base`` class constructs two sysroots: +: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: -:: +which consists of the following:: ${SDK_OUTPUT}/${SDK_ARCH}-nativesdk-pkgs ${SDK_OUTPUT}/${SDKTARGETSYSROOT}/target-pkgs @@ -2026,9 +2541,9 @@ which consists of the following: Finally, the base populate SDK class creates the toolchain environment setup script, the tarball of the SDK, and the installer. -The respective ``populate_sdk_deb``, ``populate_sdk_rpm``, and -``populate_sdk_ipk`` classes each support the specific type of SDK. -These classes are inherited by and used with the ``populate_sdk_base`` +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 @@ -2043,10 +2558,10 @@ Software Development Kit (eSDK) manual. .. _ref-classes-prexport: -``prexport.bbclass`` -==================== +``prexport`` +============ -The ``prexport`` class provides functionality for exporting +The :ref:`ref-classes-prexport` class provides functionality for exporting :term:`PR` values. .. note:: @@ -2056,10 +2571,10 @@ The ``prexport`` class provides functionality for exporting .. _ref-classes-primport: -``primport.bbclass`` -==================== +``primport`` +============ -The ``primport`` class provides functionality for importing +The :ref:`ref-classes-primport` class provides functionality for importing :term:`PR` values. .. note:: @@ -2069,69 +2584,80 @@ The ``primport`` class provides functionality for importing .. _ref-classes-prserv: -``prserv.bbclass`` -================== +``prserv`` +========== -The ``prserv`` class provides functionality for using a :ref:`PR -service <dev-manual/common-tasks:working with a pr service>` in order to +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:`package <ref-classes-package>` class. However, the OpenEmbedded +: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.bbclass`` -================= +``ptest`` +========= -The ``ptest`` class provides functionality for packaging and installing +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/common-tasks:testing packages with ptest`" +":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.bbclass`` -======================= +``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/common-tasks:testing packages with ptest`" +":ref:`dev-manual/packages:testing packages with ptest`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-python3-dir: -``python3-dir.bbclass`` -======================= +``python3-dir`` +=============== -The ``python3-dir`` class provides the base version, location, and site +The :ref:`ref-classes-python3-dir` class provides the base version, location, and site package location for Python 3. .. _ref-classes-python3native: -``python3native.bbclass`` -========================= +``python3native`` +================= -The ``python3native`` class supports using the native version of Python +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.bbclass`` -=============================== +``python3targetconfig`` +======================= -The ``python3targetconfig`` class supports using the native version of Python +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 @@ -2140,62 +2666,60 @@ in order to avoid unnecessarily lengthening builds. .. _ref-classes-qemu: -``qemu.bbclass`` -================ +``qemu`` +======== -The ``qemu`` class provides functionality for recipes that either need +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.bbclass`` -========================= +``recipe_sanity`` +================= -The ``recipe_sanity`` class checks for the presence of any host system +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.bbclass`` -======================= +``relocatable`` +=============== -The ``relocatable`` class enables relocation of binaries when they are +The :ref:`ref-classes-relocatable` class enables relocation of binaries when they are installed into the sysroot. -This class makes use of the :ref:`chrpath <ref-classes-chrpath>` class -and is used by both the :ref:`cross <ref-classes-cross>` and -:ref:`native <ref-classes-native>` classes. +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.bbclass`` -========================== +``remove-libtool`` +================== -The ``remove-libtool`` class adds a post function to the +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: -:: +override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows:: REMOVE_LIBTOOL_LA = "0" .. note:: - The ``remove-libtool`` class is not enabled by default. + The :ref:`ref-classes-remove-libtool` class is not enabled by default. .. _ref-classes-report-error: -``report-error.bbclass`` -======================== +``report-error`` +================ -The ``report-error`` class supports enabling the :ref:`error reporting -tool <dev-manual/common-tasks:using the error reporting tool>`", +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, @@ -2206,10 +2730,10 @@ are created and stored in .. _ref-classes-rm-work: -``rm_work.bbclass`` -=================== +``rm_work`` +=========== -The ``rm_work`` class supports deletion of temporary workspace, which +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 @@ -2218,61 +2742,76 @@ under the ``${TMPDIR}/work`` directory for each recipe. Once the build system generates the packages for a recipe, the work files for that recipe are no longer needed. However, by default, the build system preserves these files for inspection and possible debugging purposes. If -you would rather have these files deleted to save disk space as the -build progresses, you can enable ``rm_work`` by adding the following to -your ``local.conf`` file, which is found in the :term:`Build Directory`. -:: +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 ``rm_work`` will potentially result in your changes to -the source being lost. To exclude some recipes from having their work -directories deleted by ``rm_work``, you can add the names of the recipe -or recipes you are working on to the ``RM_WORK_EXCLUDE`` variable, which -can also be set in your ``local.conf`` file. Here is an example: -:: +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*.bbclass`` -=================== +``rootfs*`` +=========== -The ``rootfs*`` classes support creating the root filesystem for an +The :ref:`ref-classes-rootfs*` classes support creating the root filesystem for an image and consist of the following classes: -- The ``rootfs-postcommands`` class, which defines filesystem +- The :ref:`rootfs-postcommands <ref-classes-rootfs*>` class, which defines filesystem post-processing functions for image recipes. -- The ``rootfs_deb`` class, which supports creation of root filesystems +- The :ref:`rootfs_deb <ref-classes-rootfs*>` class, which supports creation of root filesystems for images built using ``.deb`` packages. -- The ``rootfs_rpm`` class, which supports creation of root filesystems +- The :ref:`rootfs_rpm <ref-classes-rootfs*>` class, which supports creation of root filesystems for images built using ``.rpm`` packages. -- The ``rootfs_ipk`` class, which supports creation of root filesystems +- The :ref:`rootfs_ipk <ref-classes-rootfs*>` class, which supports creation of root filesystems for images built using ``.ipk`` packages. -- The ``rootfsdebugfiles`` class, which installs additional files found +- 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 -``rootfs*.bbclass`` files as determined by the -:term:`PACKAGE_CLASSES` variable. +: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.bbclass`` -================== +``sanity`` +========== -The ``sanity`` class checks to see if prerequisite software is present +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 @@ -2281,63 +2820,117 @@ usually determines whether to include this class. .. _ref-classes-scons: -``scons.bbclass`` -================= +``scons`` +========= -The ``scons`` class supports recipes that need to build software that -uses the SCons build system. You can use the -:term:`EXTRA_OESCONS` variable to specify -additional configuration options you want to pass SCons command line. +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.bbclass`` -=============== +``sdl`` +======= -The ``sdl`` class supports recipes that need to build software that uses +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.bbclass`` -======================= +``setuptools3`` +=============== -The ``setuptools3`` class supports Python version 3.x extensions that -use build systems based on ``setuptools``. If your recipe uses these -build systems, the recipe needs to inherit the ``setuptools3`` class. +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. -.. _ref-classes-sign_rpm: + .. 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:: -``sign_rpm.bbclass`` + 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 ``sign_rpm`` class supports generating signed RPM packages. +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-sip: +.. _ref-classes-sign_rpm: -``sip.bbclass`` -=============== +``sign_rpm`` +============ -The ``sip`` class supports recipes that build or package SIP-based -Python bindings. +The :ref:`ref-classes-sign_rpm` class supports generating signed RPM packages. .. _ref-classes-siteconfig: -``siteconfig.bbclass`` -====================== +``siteconfig`` +============== -The ``siteconfig`` class provides functionality for handling site -configuration. The class is used by the -:ref:`autotools <ref-classes-autotools>` class to accelerate the -:ref:`ref-tasks-configure` task. +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.bbclass`` -==================== +``siteinfo`` +============ -The ``siteinfo`` class provides information about the targets that might -be needed by other classes or recipes. +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 @@ -2346,20 +2939,20 @@ results so these tests can be skipped over but still make the correct values available. The ``meta/site directory`` contains test results sorted into different categories such as architecture, endianness, and the ``libc`` used. Site information provides a list of files containing -data relevant to the current build in the ``CONFIG_SITE`` variable that +data relevant to the current build in the :term:`CONFIG_SITE` variable that Autotools automatically picks up. -The class also provides variables like ``SITEINFO_ENDIANNESS`` and -``SITEINFO_BITS`` that can be used elsewhere in the metadata. +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.bbclass`` -================== +``sstate`` +========== -The ``sstate`` class provides support for Shared State (sstate). By -default, the class is enabled through the -:term:`INHERIT_DISTRO` variable's default value. +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`" @@ -2367,10 +2960,10 @@ section in the Yocto Project Overview and Concepts Manual. .. _ref-classes-staging: -``staging.bbclass`` -=================== +``staging`` +=========== -The ``staging`` class installs files into individual recipe work +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, @@ -2383,25 +2976,25 @@ directories for sysroots. The class contains the following key tasks: installs the files into the individual recipe work directories (i.e. :term:`WORKDIR`). -The code in the ``staging`` class is complex and basically works in two -stages: +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 ``do_populate_sysroot`` task + ``${``\ :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_BLACKLIST` + :term:`SYSROOT_DIRS_IGNORE` variables. .. note:: Additionally, a recipe can customize the files further by - declaring a processing function in the ``SYSROOT_PREPROCESS_FUNCS`` + declaring a processing function in the :term:`SYSROOT_PREPROCESS_FUNCS` variable. A shared state (sstate) object is built from these files and the @@ -2443,11 +3036,11 @@ stages: recommended for general use, the files do allow some issues such as user creation and module indexes to be addressed. - Because recipes can have other dependencies outside of ``DEPENDS`` + 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 - ``DEPENDS`` but operate similarly. + :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 @@ -2457,8 +3050,7 @@ stages: dependencies traversed or installed. The same sstate dependency code is used so that builds should be identical regardless of whether sstate was used or not. For a closer look, see the - ``setscene_depvalid()`` function in the - :ref:`sstate <ref-classes-sstate>` class. + ``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 @@ -2467,11 +3059,11 @@ stages: .. _ref-classes-syslinux: -``syslinux.bbclass`` -==================== +``syslinux`` +============ -The ``syslinux`` class provides syslinux-specific functions for building -bootable images. +The :ref:`ref-classes-syslinux` class provides syslinux-specific functions for +building bootable images. The class supports the following variables: @@ -2510,11 +3102,11 @@ The class supports the following variables: .. _ref-classes-systemd: -``systemd.bbclass`` -=================== +``systemd`` +=========== -The ``systemd`` class provides support for recipes that install systemd -unit files. +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`. @@ -2531,36 +3123,35 @@ 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: -:: +is an example from the connman recipe:: - SYSTEMD_SERVICE_${PN} = "connman.service" + SYSTEMD_SERVICE:${PN} = "connman.service" Services are set up to start on boot automatically unless you have set :term:`SYSTEMD_AUTO_ENABLE` to "disable". -For more information on ``systemd``, see the -":ref:`dev-manual/common-tasks:selecting an initialization manager`" +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.bbclass`` -======================== +``systemd-boot`` +================ -The ``systemd-boot`` class provides functions specific to the +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 ``systemd-boot`` class is a result from merging the ``gummiboot`` class + 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 -"systemd-boot" to use this class. Doing so creates a standalone EFI -bootloader that is not dependent on systemd. +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`, @@ -2573,76 +3164,71 @@ for more information. .. _ref-classes-terminal: -``terminal.bbclass`` -==================== +``terminal`` +============ -The ``terminal`` class provides support for starting a terminal session. -The :term:`OE_TERMINAL` variable controls which -terminal emulator is used for the session. +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 ``terminal`` class anywhere a separate terminal -session needs to be started. For example, the -:ref:`patch <ref-classes-patch>` class assuming -:term:`PATCHRESOLVE` is set to "user", the -:ref:`cml1 <ref-classes-cml1>` class, and the -:ref:`devshell <ref-classes-devshell>` class all use the ``terminal`` -class. +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*: +.. _ref-classes-testimage: -``testimage*.bbclass`` -====================== +``testimage`` +============= -The ``testimage*`` classes support running automated tests against +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. -.. note:: +To enable this class, add the following to your configuration:: - Best practices include using :term:`IMAGE_CLASSES` rather than - :term:`INHERIT` to inherit the ``testimage`` class for automated image - testing. + 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 ``testimage.bbclass`` runs tests on an image when called using the -following: -:: +The :ref:`ref-classes-testimage` class runs tests on an image when called using the +following:: $ bitbake -c testimage image -The ``testimage-auto`` class -runs tests on an image after the image is constructed (i.e. -:term:`TESTIMAGE_AUTO` must be set to "1"). +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/common-tasks:performing automated runtime testing`" +":ref:`dev-manual/runtime-testing:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. .. _ref-classes-testsdk: -``testsdk.bbclass`` -=================== +``testsdk`` +=========== This class supports running automated tests against software development -kits (SDKs). The ``testsdk`` class runs tests on an SDK when called -using the following: -:: +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 ``testsdk`` class for automated SDK + :term:`INHERIT` to inherit the :ref:`ref-classes-testsdk` class for automated SDK testing. .. _ref-classes-texinfo: -``texinfo.bbclass`` -=================== +``texinfo`` +=========== This class should be inherited by recipes whose upstream packages invoke the ``texinfo`` utilities at build-time. Native and cross recipes are @@ -2659,10 +3245,10 @@ host system. .. _ref-classes-toaster: -``toaster.bbclass`` -=================== +``toaster`` +=========== -The ``toaster`` class collects information about packages and images and +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. @@ -2670,49 +3256,84 @@ This class is not intended to be used directly. .. _ref-classes-toolchain-scripts: -``toolchain-scripts.bbclass`` -============================= +``toolchain-scripts`` +===================== -The ``toolchain-scripts`` class provides the scripts used for setting up +The :ref:`ref-classes-toolchain-scripts` class provides the scripts used for setting up the environment for installed SDKs. .. _ref-classes-typecheck: -``typecheck.bbclass`` -===================== +``typecheck`` +============= -The ``typecheck`` class provides support for validating the values of +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: -:: +variable using the "type" varflag. Here is an example:: IMAGE_FEATURES[type] = "list" .. _ref-classes-uboot-config: -``uboot-config.bbclass`` -======================== +``uboot-config`` +================ -The ``uboot-config`` class provides support for U-Boot configuration for -a machine. Specify the machine in your recipe as follows: -:: +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" + UBOOT_CONFIG[foo] = "config,images,binary" -You can also specify the machine using this method: -:: +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.bbclass`` -===================== +``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 @@ -2727,21 +3348,21 @@ yourself, publish the resulting tarball (e.g. via HTTP) and set ``UNINATIVE_URL`` and ``UNINATIVE_CHECKSUM`` appropriately. For an example, see the ``meta/conf/distro/include/yocto-uninative.inc``. -The ``uninative`` class is also used unconditionally by the extensible +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.bbclass`` -=============================== +``update-alternatives`` +======================= -The ``update-alternatives`` class helps the alternatives system when +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 -``update-alternatives`` class handles renaming the binaries so that +: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 @@ -2761,7 +3382,7 @@ To use this class, you need to define a number of variables: 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/update-alternatives.bbclass>` +:yocto_git:`update-alternatives.bbclass </poky/tree/meta/classes-recipe/update-alternatives.bbclass>` file. .. note:: @@ -2771,43 +3392,42 @@ file. .. _ref-classes-update-rc.d: -``update-rc.d.bbclass`` -======================= +``update-rc.d`` +=============== -The ``update-rc.d`` class uses ``update-rc.d`` to safely install an +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: ``INITSCRIPT_PACKAGES``, -``INITSCRIPT_NAME`` and ``INITSCRIPT_PARAMS``. See the variable links +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*.bbclass`` -==================== +``useradd*`` +============ -The ``useradd*`` classes support the addition of users or groups for +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 ``meta-skeleton/recipes-skeleton/useradd/useradd-example.bb`` +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. -See the ``useradd-example.bb`` recipe for more information on how to use -these classes. -The ``useradd_base`` class provides basic functionality for user or +The :ref:`useradd_base <ref-classes-useradd>` class provides basic functionality for user or groups settings. -The ``useradd*`` classes support the +The :ref:`useradd* <ref-classes-useradd>` classes support the :term:`USERADD_PACKAGES`, :term:`USERADD_PARAM`, :term:`GROUPADD_PARAM`, and :term:`GROUPMEMS_PARAM` variables. -The ``useradd-staticids`` class supports the addition of users or groups +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. @@ -2823,61 +3443,58 @@ set static values, the OpenEmbedded build system looks in :term:`BBPATH` for ``files/passwd`` and ``files/group`` files for the values. -To use static ``uid`` and ``gid`` values, you need to set some -variables. See the :term:`USERADDEXTENSION`, -:term:`USERADD_UID_TABLES`, -:term:`USERADD_GID_TABLES`, and -:term:`USERADD_ERROR_DYNAMIC` variables. -You can also see the :ref:`useradd <ref-classes-useradd>` class for -additional information. +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 ``useradd-staticids`` class directly. You either enable - or disable the class by setting the ``USERADDEXTENSION`` variable. If you + 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 ``TMPDIR`` + contain incorrect ``uid`` and ``gid`` values. Deleting the :term:`TMPDIR` directory will correct this condition. .. _ref-classes-utility-tasks: -``utility-tasks.bbclass`` -========================= +``utility-tasks`` +================= -The ``utility-tasks`` class provides support for various "utility" type -tasks that are applicable to all recipes, such as -:ref:`ref-tasks-clean` and -:ref:`ref-tasks-listtasks`. +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:`base <ref-classes-base>` class. +:ref:`ref-classes-base` class. .. _ref-classes-utils: -``utils.bbclass`` -================= +``utils`` +========= -The ``utils`` class provides some useful Python functions that are +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:`base <ref-classes-base>` class. +:ref:`ref-classes-base` class. .. _ref-classes-vala: -``vala.bbclass`` -================ +``vala`` +======== -The ``vala`` class supports recipes that need to build software written +The :ref:`ref-classes-vala` class supports recipes that need to build software written using the Vala programming language. .. _ref-classes-waf: -``waf.bbclass`` -=============== +``waf`` +======= -The ``waf`` class supports recipes that need to build software that uses +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 diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 629aa2ffb9..9319addc3c 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst @@ -22,8 +22,7 @@ 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 --help`` to see all the commands:: $ devtool -h NOTE: Starting bitbake server... @@ -79,8 +78,7 @@ has a number of sub-commands for each function. You can run As directed in the general help output, you can get more syntax on a specific command by providing the command name and -using "--help": -:: +using ``--help``:: $ devtool add --help NOTE: Starting bitbake server... @@ -128,8 +126,7 @@ common working area used across the tool. The following figure shows the workspace structure: .. image:: figures/build-workspace-directory.png - :align: center - :scale: 70% + :scale: 100% .. code-block:: none @@ -167,13 +164,12 @@ 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 +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``: -:: +resides in ``/home/user/sources/jackson``:: $ devtool add jackson /home/user/sources/jackson @@ -201,8 +197,7 @@ 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: - :: +- To specify a source branch, use the ``--srcbranch`` option:: $ devtool add --srcbranch &DISTRO_NAME_NO_CAP; jackson /home/user/sources/jackson @@ -210,8 +205,7 @@ specify these options when using the ``devtool add`` command: branch. - To specify a specific tag or commit hash, use the ``--srcrev`` - option: - :: + option:: $ devtool add --srcrev &DISTRO_REL_TAG; jackson /home/user/sources/jackson $ devtool add --srcrev some_commit_hash /home/user/sources/jackson @@ -269,8 +263,7 @@ 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: -:: +checkout the source files:: $ devtool modify recipe @@ -290,10 +283,7 @@ is identified using the ``EDITOR`` variable, on the specified recipe. When you use the ``devtool edit-recipe`` command, you must supply the root name of the recipe (i.e. no version, paths, or extensions). Also, the recipe file itself must reside in the workspace as a result of the -``devtool add`` or ``devtool upgrade`` commands. However, you can -override that requirement by using the "-a" or "--any-recipe" option. -Using either of these options allows you to edit any recipe regardless -of its location. +``devtool add`` or ``devtool upgrade`` commands. .. _devtool-updating-a-recipe: @@ -309,8 +299,7 @@ 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`` to create the patches and update the recipe:: $ devtool update-recipe recipe @@ -321,8 +310,7 @@ 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: -:: +the layer into which to write an append file:: $ devtool update-recipe recipe -a base-layer-directory @@ -339,27 +327,40 @@ Checking on the Upgrade Status of a Recipe Upstream recipes change over time. Consequently, you might find that you need to determine if you can upgrade a recipe to a newer version. -To check on the upgrade status of a recipe, use the -``devtool check-upgrade-status`` command. The command displays a table -of your current recipe versions, the latest upstream versions, the email -address of the recipe's maintainer, and any additional information such -as commit hash strings and reasons you might not be able to upgrade a -particular recipe. +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: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. + - 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: -:: +command:: $ devtool check-upgrade-status -h NOTE: Starting bitbake server... @@ -377,33 +378,30 @@ command: Unless you provide a specific recipe name on the command line, the command checks all recipes in all configured layers. -Following is a partial example table that reports on all the recipes. +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. +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:: -.. note:: - - When a reason for not upgrading displays, the reason is usually - written into the recipe using the ``RECIPE_NO_UPDATE_REASON`` - variable. See the - :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` - recipe for an example. - -:: + RECIPE_NO_UPDATE_REASON = "Version 3.5.38 requires cdebconf for update-passwd utility" - $ devtool check-upgrade-status - ... - NOTE: acpid 2.0.30 2.0.31 Ross Burton <ross.burton@intel.com> - NOTE: u-boot-fw-utils 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff - NOTE: u-boot-tools 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff - . - . - . - NOTE: base-passwd 3.5.29 3.5.45 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility - NOTE: busybox 1.29.2 1.30.0 Andrej Valek <andrej.valek@siemens.com> - NOTE: dbus-test 1.12.10 1.12.12 Chen Qi <Qi.Chen@windriver.com> +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: @@ -412,8 +410,8 @@ Upgrading a Recipe As software matures, upstream recipes are upgraded to newer versions. As a developer, you need to keep your local recipes up-to-date with the -upstream version releases. Several methods exist by which you can -upgrade recipes. You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`" +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. @@ -441,7 +439,7 @@ You can read more on the ``devtool upgrade`` workflow in the ":ref:`sdk-manual/extensible:use \`\`devtool upgrade\`\` to create a version of the recipe that supports a newer version of the software`" section in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual. You can also see an example of -how to use ``devtool upgrade`` in the ":ref:`dev-manual/common-tasks:using \`\`devtool upgrade\`\``" +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: @@ -462,8 +460,7 @@ 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: -:: +``mtr`` recipe:: $ devtool reset mtr NOTE: Cleaning sysroot for recipe mtr... @@ -481,9 +478,8 @@ Use the ``devtool build`` command to build your recipe. The 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: -:: +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 @@ -499,8 +495,7 @@ 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: -:: +name of the image. This command has no command line options:: $ devtool build-image image @@ -510,8 +505,7 @@ 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: -:: +output to the live target machine:: $ devtool deploy-target recipe target @@ -529,8 +523,8 @@ you do, the package manager is bypassed. should never use it to update an image that will be used in production. -Some conditions exist that could prevent a deployed application from -behaving as expected. When both of the following conditions exist, your +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: @@ -541,7 +535,7 @@ target: - The target does not physically have the packages on which the application depends installed. -If both of these conditions exist, your application will not behave as +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 @@ -562,8 +556,7 @@ 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. -:: +command:: $ devtool undeploy-target recipe target @@ -582,15 +575,13 @@ 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": -:: +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": -:: +"new-workspace":: $ devtool create-workspace /home/scottrif/new-workspace @@ -603,15 +594,13 @@ 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: -:: +The ``devtool status`` command has no command-line options:: $ devtool status -Following is sample output after using +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: -:: +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) diff --git a/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb b/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb deleted file mode 100644 index aa2beb9a9b..0000000000 --- a/documentation/ref-manual/examples/hello-autotools/hello_2.10.bb +++ /dev/null @@ -1,9 +0,0 @@ -DESCRIPTION = "GNU Helloworld application" -SECTION = "examples" -LICENSE = "GPLv3" -LIC_FILES_CHKSUM = "file://COPYING;md5=d32239bcb673463ab874e80d47fae504" - -SRC_URI = "${GNU_MIRROR}/hello/hello-${PV}.tar.gz" -SRC_URI[sha256sum] = "31e066137a962676e89f69d1b65382de95a7ef7d914b8cb956f41ea72e0f516b" - -inherit autotools-brokensep gettext 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 90d3aefd86..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} ${LDFLAGS} 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 c0c8986405..0000000000 --- a/documentation/ref-manual/examples/libxpm/libxpm_3.5.6.bb +++ /dev/null @@ -1,14 +0,0 @@ -require recipes-graphics/xorg-lib/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 index 64fdfdf756..bab284bbfd 100644 --- a/documentation/ref-manual/faq.rst +++ b/documentation/ref-manual/faq.rst @@ -4,9 +4,15 @@ FAQ *** -**Q:** How does Poky differ from :oe_home:`OpenEmbedded <>`? +.. contents:: -**A:** The term ``Poky`` refers to the specific reference build +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 @@ -15,19 +21,10 @@ OpenEmbedded, with changes always being merged to OE-Core or BitBake first before being pulled back into Poky. This practice benefits both projects immediately. -**Q:** My development system does not meet the required Git, tar, and -Python versions. In particular, I do not have Python &MIN_PYTHON_VERSION; or greater. -Can I still use the Yocto Project? - -**A:** You can get the required tools on your host development system a -couple different ways (i.e. building a tarball or downloading a -tarball). See the -":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" -section for steps on how to update your build tools. - -**Q:** How can you claim Poky / OpenEmbedded-Core is stable? +How can you claim Poky / OpenEmbedded-Core is stable? +----------------------------------------------------- -**A:** There are three areas that help with stability; +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 @@ -37,95 +34,110 @@ section for steps on how to update your build tools. - 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 autobuilder, which provides continuous - build and integration tests. +- The Yocto Project uses an :yocto_ab:`autobuilder <>`, which provides + continuous build and integration tests. -**Q:** How do I get support for my board added to the Yocto Project? +Are there any products built using the OpenEmbedded build system? +----------------------------------------------------------------- -**A:** 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/common-tasks:understanding and creating layers`" -section in the Yocto Project Development Tasks Manual and the -:doc:`/bsp-guide/index`. +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. -Usually, if the board is not completely exotic, adding support in the -Yocto Project is fairly straightforward. +Building environment +==================== -**Q:** Are there any products built using the OpenEmbedded build system? +Missing dependencies on the development system? +----------------------------------------------- -**A:** The software running on the `Vernier -LabQuest <https://vernier.com/labquest/>`__ is built using the -OpenEmbedded build system. See the `Vernier -LabQuest <https://www.vernier.com/products/interfaces/labq/>`__ 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. +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. -**Q:** What does the OpenEmbedded build system produce as output? +How does OpenEmbedded fetch source code? Will it work through a firewall or proxy server? +----------------------------------------------------------------------------------------- -**A:** 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. +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. -**Q:** How do I add my package to the Yocto Project? +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. -**A:** 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/common-tasks:writing a new recipe`" -section in the Yocto Project Development Tasks Manual. +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:: -**Q:** Do I have to reflash my entire board with a new Yocto Project -image when recompiling a package? + 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/" -**A:** The OpenEmbedded build system can build packages in various -formats such as IPK for OPKG, Debian package (``.deb``), 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. +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. -**Q:** I see the error -'``chmod: XXXXX new permissions are r-xrwxrwx, not r-xr-xr-x``'. What is -wrong? +Another option is to set:: -**A:** You are probably running the build on an NTFS filesystem. Use -``ext2``, ``ext3``, or ``ext4`` instead. + BB_NO_NETWORK = "1" -**Q:** I see lots of 404 responses for files when the OpenEmbedded build -system is trying to download sources. Is something wrong? +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. -**A:** 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. +Here is another technique:: + + BB_FETCH_PREMIRRORONLY = "1" -**Q:** 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? +This statement limits the build system to pulling source from the +:term:`PREMIRRORS` only. Again, this technique is useful for reproducing +builds. -**A:** Set ``SRC_URI_OVERRIDES_PACKAGE_ARCH`` = "0" in the ``.bb`` file -but make sure the package is manually marked as machine-specific for the -case that needs it. The code that handles -``SRC_URI_OVERRIDES_PACKAGE_ARCH`` is in the -``meta/classes/base.bbclass`` file. +Here is yet another technique:: -**Q:** I'm behind a firewall and need to use a proxy server. How do I do -that? + 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. -**A:** Most source fetching by the OpenEmbedded build system is done by +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. -Following is the applicable code for setting various proxy types in the +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: :: +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. @@ -136,24 +148,53 @@ To use them, remove the comments: :: # 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/site.conf.sample`` 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 -":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" -Wiki page. +``meta-poky/conf/templates/default/site.conf.sample`` file that shows +how to configure CVS and Git proxy servers if needed. -**Q:** What's the difference between target and target\ ``-native``? +.. note:: -**A:** 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. + 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? +------------------------------------- -**Q:** I'm seeing random build failures. Help?! +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``. -**A:** If the same build is failing in totally different and random +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. @@ -166,222 +207,139 @@ 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. -**Q:** When I try to build a native recipe, the build fails with -``iconv.h`` problems. +Why does the build fail with ``iconv.h`` problems? +-------------------------------------------------- -**A:** If you get an error message that indicates GNU ``libiconv`` is -not in use but ``iconv.h`` has been included from ``libiconv``, you need -to check to see if you have a previously installed version of the header -file in ``/usr/local/include``. -:: +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 -If you find a previously installed -file, you should either uninstall it or temporarily rename it and try -the build again. +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``. Be sure that leakage cannot occur from +limited to ``iconv.h``. Make sure that leakage cannot occur from ``/usr/local/include`` and ``/opt`` locations. -**Q:** What do we need to ship for license compliance? - -**A:** 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/common-tasks:maintaining open source license compliance during your product's lifecycle`" -section in the Yocto Project Development Tasks Manual. - -**Q:** How do I disable the cursor on my touchscreen device? - -**A:** 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 - -**Q:** How do I make sure connected network interfaces are brought up by -default? - -**A:** 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 - -**Q:** How do I create images with more free space? - -**A:** 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 - ``IMAGE_ROOTFS_SIZE``. - -**Q:** Why don't you support directories with spaces in the pathnames? - -**A:** 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. - -**Q:** How do I use an external toolchain? - -**A:** The toolchain configuration is very flexible and customizable. It -is primarily controlled with the ``TCMODE`` variable. This variable -controls which ``tcmode-*.inc`` file to include from the -``meta/conf/distro/include`` directory within the :term:`Source Directory`. - -The default value of ``TCMODE`` is "default", which tells the -OpenEmbedded build system to use its internally built toolchain (i.e. -``tcmode-default.inc``). 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 ``meta-sourcery`` layer at -https://github.com/MentorEmbedded/meta-sourcery/. - -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 ``libgcc``, -``libstdcc++``, any locales, and ``libc``. - -**Q:** How does the OpenEmbedded build system obtain source code and -will it work behind my firewall or proxy server? +Why don't other recipes find the files provided by my ``*-native`` recipe? +-------------------------------------------------------------------------- -**A:** 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 ``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. +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. -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: :: +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. - 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" +Can I get rid of build output so I can start over? +-------------------------------------------------- -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. +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. -Aside from the previous technique, these options also exist: -:: +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. - BB_NO_NETWORK = "1" +Customizing generated images +============================ -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. +What does the OpenEmbedded build system produce as output? +---------------------------------------------------------- -Here is another technique: -:: +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. - BB_FETCH_PREMIRRORONLY = "1" +How do I make the Yocto Project support my board? +------------------------------------------------- -This statement -limits the build system to pulling source from the ``PREMIRRORS`` only. -Again, this technique is useful for reproducing builds. +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`. -Here is another technique: -:: +Usually, if the board is not completely exotic, adding support in the +Yocto Project is fairly straightforward. - BB_GENERATE_MIRROR_TARBALLS = "1" +How do I make the Yocto Project support my package? +--------------------------------------------------- -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. +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. -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 ``PREMIRRORS`` server is current: :: +What do I need to ship for license compliance? +---------------------------------------------- - 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" +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. -These changes would cause the build system to successfully fetch source -over HTTP and any network accesses to anything other than the -``PREMIRRORS`` would fail. +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. -The build system also honors the standard shell environment variables -``http_proxy``, ``ftp_proxy``, ``https_proxy``, and ``all_proxy`` to -redirect requests through proxy servers. +Do I have to make a full reflash after recompiling one package? +--------------------------------------------------------------- -.. note:: +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. - You can find more information on the - ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" - Wiki page. +How to prevent my package from being marked as machine specific? +---------------------------------------------------------------- -**Q:** Can I get rid of build output so I can start over? +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. -**A:** 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. +What's the difference between ``target`` and ``target-native``? +--------------------------------------------------------------- -Within the 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. +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. -**Q:** Why do ``${bindir}`` and ``${libdir}`` have strange values for -``-native`` recipes? +Why do ``${bindir}`` and ``${libdir}`` have strange values for ``-native`` recipes? +----------------------------------------------------------------------------------- -**A:** Executables and libraries might need to be used from a directory +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 @@ -408,20 +366,13 @@ system of that image. Thus, the build system provides a value of 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 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. - -:: +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 @@ -430,35 +381,76 @@ relatively normal and the second is not: 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. +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. -**Q:** The files provided by my ``*-native`` 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? +How do I create images with more free space? +-------------------------------------------- -**A:** This situation results when a build system 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, permissions errors might be caused by a -Makefile that ignores ``DESTDIR`` or uses a different name for that -environment variable. Check the build system to see if these kinds -of issues exist. - -**Q:** I'm adding a binary in a recipe but it's different in the image, what is -changing it? - -**A:** 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. The other less obvious thing that can -happen is prelinking of the image. This is set by default in local.conf via -:term:`USER_CLASSES` which can contain 'image-prelink'. If you remove that, the -image will not be prelinked meaning the binaries would be unchanged. +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/features.rst b/documentation/ref-manual/features.rst index 89c06eb65f..2ea946b31d 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst @@ -6,14 +6,14 @@ Features This chapter provides a reference of shipped machine and distro features you can include as part of your image, a reference on image features you -can select, and a reference on feature backfilling. +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 ``DISTRO_FEATURES`` variable, +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 ``MACHINE_FEATURES`` variable, which is +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. @@ -26,8 +26,7 @@ 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: -:: +given feature:: $ cd poky $ git grep 'contains.*MACHINE_FEATURES.*feature' @@ -53,8 +52,6 @@ Project metadata: - *alsa:* Hardware has ALSA audio drivers -- *apm:* Hardware uses APM (or APM emulation) - - *bluetooth:* Hardware has integrated BT - *efi:* Support for booting through EFI @@ -63,6 +60,8 @@ Project metadata: - *keyboard:* Hardware has a keyboard +- *numa:* Hardware has non-uniform memory access + - *pcbios:* Support for booting through BIOS - *pci:* Hardware has a PCI bus @@ -71,6 +70,8 @@ Project metadata: - *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 @@ -101,7 +102,9 @@ 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. +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 @@ -109,11 +112,22 @@ 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: +metadata, as extra layers can define their own: + +- *3g:* Include support for cellular data. -- *alsa:* Include ALSA support (OSS compatibility kernel modules - installed if available). +- *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 @@ -126,39 +140,84 @@ metadata: - *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/common-tasks:testing packages with ptest`" section + ":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). @@ -167,6 +226,10 @@ metadata: 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). @@ -177,6 +240,11 @@ metadata: 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. @@ -184,6 +252,12 @@ metadata: - *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 @@ -197,19 +271,21 @@ you can add several different predefined packages such as development utilities or packages with debug information needed to investigate application problems or profile applications. -The following image features are available for all images: +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-empty-password:* Allows Dropbear and OpenSSH to accept root - logins and 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 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. + 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. @@ -217,8 +293,26 @@ The following image features are available for all images: - *doc-pkgs:* Installs documentation packages for all packages installed in a given image. -- *empty-root-password:* Sets the root password to an empty string, - which allows logins with a blank password. +- *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. @@ -236,23 +330,40 @@ The following image features are available for all images: - *read-only-rootfs:* Creates an image whose root filesystem is read-only. See the - ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" + ":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 ``SPLASH`` variable to a + 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:`core-image <ref-classes-core-image>` class. The current list of +:ref:`ref-classes-core-image` class. The current list of these valid features is as follows: - *hwcodecs:* Installs hardware acceleration codecs. @@ -265,15 +376,30 @@ these valid features is as follows: - *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 - ``IMAGE_FEATURES``, then OpenSSH will take precedence and Dropbear + :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/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section + ":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`. @@ -282,6 +408,8 @@ these valid features is as follows: - *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. @@ -293,58 +421,50 @@ these valid features is as follows: Feature Backfilling =================== -Sometimes it is necessary in the OpenEmbedded build system to extend -:term:`MACHINE_FEATURES` or -:term:`DISTRO_FEATURES` to control functionality -that was previously enabled and not able to be disabled. For these -cases, we need to add an additional feature item to appear in one of -these variables, but we do not want to force developers who have -existing values of the variables in their configuration to add the new -feature in order to retain the same overall level of functionality. -Thus, the OpenEmbedded build system has a mechanism to automatically -"backfill" these added features into existing distro or machine +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 finding the -:term:`DISTRO_FEATURES_BACKFILL` and -:term:`MACHINE_FEATURES_BACKFILL` -variables in the ``meta/conf/bitbake.conf`` file. - -Because such features are backfilled by default into all configurations -as described in the previous paragraph, developers who wish to disable -the new features need to be able to selectively prevent the backfilling -from occurring. They can do this by adding the undesired feature or -features to the +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` -or -:term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` -variables for distro features and machine features respectively. - -Here are two examples to help illustrate feature backfilling: - -- *The "pulseaudio" distro feature option*: Previously, PulseAudio - support was enabled within the Qt and GStreamer frameworks. Because - of this, the feature is backfilled and thus enabled for all distros - through the ``DISTRO_FEATURES_BACKFILL`` variable in the - ``meta/conf/bitbake.conf`` file. However, your distro needs to - disable the feature. You can disable the feature without affecting - other existing distro configurations that need PulseAudio support by - adding "pulseaudio" to ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` in - your distro's ``.conf`` file. Adding the feature to this variable - when it also exists in the ``DISTRO_FEATURES_BACKFILL`` variable - prevents the build system from adding the feature to your - configuration's ``DISTRO_FEATURES``, effectively disabling the - feature for that particular distro. +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 - ``MACHINE_FEATURES_BACKFILL`` variable in the - ``meta/conf/bitbake.conf`` file. However, your target device does not - have this capability. You can disable RTC support for your device - without affecting other machines that need RTC support by adding the - feature to your machine's ``MACHINE_FEATURES_BACKFILL_CONSIDERED`` - list in the machine's ``.conf`` file. Adding the feature to this - variable when it also exists in the ``MACHINE_FEATURES_BACKFILL`` - variable prevents the build system from adding the feature to your - configuration's ``MACHINE_FEATURES``, effectively disabling RTC - support for that particular machine. + :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/history.rst b/documentation/ref-manual/history.rst deleted file mode 100644 index dc0a2ae797..0000000000 --- a/documentation/ref-manual/history.rst +++ /dev/null @@ -1,74 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -*********************** -Manual Revision History -*********************** - -.. list-table:: - :widths: 10 15 40 - :header-rows: 1 - - * - Revision - - Date - - Note - * - 0.9 - - November 2010 - - The initial document released with the Yocto Project 0.9 Release - * - 1.0 - - April 2011 - - Released with the Yocto Project 1.0 Release. - * - 1.1 - - October 2011 - - Released with the Yocto Project 1.1 Release. - * - 1.2 - - April 2012 - - Released with the Yocto Project 1.2 Release. - * - 1.3 - - October 2012 - - Released with the Yocto Project 1.3 Release. - * - 1.4 - - April 2013 - - Released with the Yocto Project 1.4 Release. - * - 1.5 - - October 2013 - - Released with the Yocto Project 1.5 Release. - * - 1.6 - - April 2014 - - Released with the Yocto Project 1.6 Release. - * - 1.7 - - October 2014 - - Released with the Yocto Project 1.7 Release. - * - 1.8 - - April 2015 - - Released with the Yocto Project 1.8 Release. - * - 2.0 - - October 2015 - - Released with the Yocto Project 2.0 Release. - * - 2.1 - - April 2016 - - Released with the Yocto Project 2.1 Release. - * - 2.2 - - October 2016 - - Released with the Yocto Project 2.2 Release. - * - 2.3 - - May 2017 - - Released with the Yocto Project 2.3 Release. - * - 2.4 - - October 2017 - - Released with the Yocto Project 2.4 Release. - * - 2.5 - - May 2018 - - Released with the Yocto Project 2.5 Release. - * - 2.6 - - November 2018 - - Released with the Yocto Project 2.6 Release. - * - 2.7 - - May 2019 - - Released with the Yocto Project 2.7 Release. - * - 3.0 - - October 2019 - - Released with the Yocto Project 3.0 Release. - * - 3.1 - - April 2020 - - Released with the Yocto Project 3.1 Release. - diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst index cf5cc1109f..c45f9104a9 100644 --- a/documentation/ref-manual/images.rst +++ b/documentation/ref-manual/images.rst @@ -14,24 +14,25 @@ image you want. Building an image without GNU General Public License Version 3 (GPLv3), GNU Lesser General Public License Version 3 (LGPLv3), and the GNU Affero General Public License Version 3 (AGPL-3.0) components - is only supported for minimal and base images. Furthermore, if you - are going to build an image using non-GPLv3 and similarly licensed - components, you must make the following changes in the ``local.conf`` - file before using the BitBake command to build the minimal or base - image: - :: + 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: - 1. Comment out the EXTRA_IMAGE_FEATURES line - 2. Set INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" + 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: :: +that contain image recipe files:: $ ls meta*/recipes*/images/*.bb -Following is a list of supported recipes: +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 @@ -47,10 +48,6 @@ Following is a list of supported recipes: - ``core-image-base``: A console-only image that fully supports the target device hardware. -- ``core-image-clutter``: An image with support for the Open GL-based - toolkit Clutter, which enables development of rich and animated - graphical user interfaces. - - ``core-image-full-cmdline``: A console-only image with more full-featured Linux system functionality installed. @@ -83,11 +80,11 @@ Following is a list of supported recipes: libraries you can use in a host development environment. - ``core-image-minimal-initramfs``: A ``core-image-minimal`` image that - has the Minimal RAM-based Initial Root Filesystem (initramfs) as part + 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 initramfs images. + 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 @@ -117,22 +114,22 @@ Following is a list of supported recipes: development headers and libraries to form a complete standalone SDK and is suitable for development using the target. -- ``core-image-testmaster``: A "master" image designed to be used for +- ``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/common-tasks:performing automated runtime testing`" + ":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 (initramfs) image tailored for use with the + 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/common-tasks:using wayland and weston`" + ":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 index deb0383cfc..a746dde492 100644 --- a/documentation/ref-manual/index.rst +++ b/documentation/ref-manual/index.rst @@ -13,7 +13,6 @@ Yocto Project Reference Manual system-requirements terms release-process - migration structure classes tasks @@ -26,6 +25,5 @@ Yocto Project Reference Manual varlocality faq resources - history .. include:: /boilerplate.rst diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst index b87cdc13b1..297887805c 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -30,8 +30,7 @@ Command: part or partition ========================== Either of these commands creates a partition on the system and uses the -following syntax: -:: +following syntax:: part [mntpoint] partition [mntpoint] @@ -55,36 +54,40 @@ must also provide one of the ``--ondrive``, ``--ondisk``, or .. note:: The mount program must understand the PARTUUID syntax you use with - ``--use-uuid`` and non-root *mountpoint*, including swap. The BusyBox - versions of these application are currently excluded. + ``--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: -:: +``--ondisk`` to force the partition onto the ``sdb`` disk:: part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 Here is a list that describes other supported options you can use with the ``part`` and ``partition`` commands: -- ``--size``: The minimum partition size in MBytes. Specify an - integer value such as 500. Do not append the number with "MB". You do - not need this option if you use ``--source``. +- ``--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 in MBytes. You cannot - specify with ``--size``. An error occurs when assembling the disk - image if the partition data is larger than ``--fixed-size``. +- ``--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/common-tasks:using the wic plugin interface`" + 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 rootfs derived + 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`` @@ -93,7 +96,7 @@ the ``part`` and ``partition`` commands: If you use ``--source plugin-name``, Wic creates a partition as large as needed and fills it with the contents of the partition that is generated by the specified plugin name using the data pointed to by - the ``-r`` command-line option or the equivalent rootfs derived from + the ``-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. @@ -108,18 +111,22 @@ the ``part`` and ``partition`` commands: - ``--fstype``: Sets the file system type for the partition. Valid values are: - - ``ext4`` + - ``btrfs`` - - ``ext3`` + - ``erofs`` - ``ext2`` - - ``btrfs`` + - ``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 @@ -134,10 +141,13 @@ the ``part`` and ``partition`` commands: - ``--align (in KBytes)``: This option is a Wic-specific option that says to start partitions on boundaries given x KBytes. -- ``--offset (in KBytes)``: This option is a Wic-specific option that +- ``--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. + 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 @@ -151,7 +161,10 @@ the ``part`` and ``partition`` commands: - ``--extra-space``: This option is a Wic-specific option that adds extra space after the space filled by the content of the partition. The final size can exceed the size specified by the ``--size`` - option. The default value is 10 Mbytes. + 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 @@ -164,7 +177,7 @@ the ``part`` and ``partition`` commands: - ``--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 - https://en.wikipedia.org/wiki/GUID_Partition_Table#Partition_type_GUIDs. + :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 @@ -198,19 +211,24 @@ supports the following options: .. note:: Bootloader functionality and boot partitions are implemented by the - various - --source - plugins that implement bootloader functionality. The bootloader + various source plugins that implement bootloader functionality. The bootloader command essentially provides a means of modifying bootloader configuration. -- ``--timeout``: Specifies the number of seconds before the - bootloader times out and boots the default option. - - ``--append``: Specifies kernel parameters. These parameters will be - added to the syslinux ``APPEND`` or ``grub`` kernel command line. + 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 that exists in the ``canned-wks`` folder. This option overrides + 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-1.3.rst b/documentation/ref-manual/migration-1.3.rst deleted file mode 100644 index 0929f490d7..0000000000 --- a/documentation/ref-manual/migration-1.3.rst +++ /dev/null @@ -1,195 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -Moving to the Yocto Project 1.3 Release (danny) -=============================================== - -This section provides migration information for moving to the Yocto -Project 1.3 Release (codename "danny") from the prior release. - -.. _1.3-local-configuration: - -Local Configuration -------------------- - -Differences include changes for -:term:`SSTATE_MIRRORS` and ``bblayers.conf``. - -.. _migration-1.3-sstate-mirrors: - -SSTATE_MIRRORS -~~~~~~~~~~~~~~ - -The shared state cache (sstate-cache), as pointed to by -:term:`SSTATE_DIR`, 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 -:term:`SSTATE_MIRRORS`, 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: :: - - SSTATE_MIRRORS = "file://.* http://someserver.tld/share/sstate/PATH" - -.. _migration-1.3-bblayers-conf: - -bblayers.conf -~~~~~~~~~~~~~ - -The ``meta-yocto`` layer consists of two parts that correspond to the -Poky reference distribution and the reference hardware Board Support -Packages (BSPs), respectively: ``meta-yocto`` and ``meta-yocto-bsp``. -When running BitBake for the first time after upgrading, your -``conf/bblayers.conf`` file will be updated to handle this change and -you will be asked to re-run or restart for the changes to take effect. - -.. _1.3-recipes: - -Recipes -------- - -Differences include changes for the following: - -.. _migration-1.3-python-function-whitespace: - -Python Function Whitespace -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -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 ``_append`` or ``_prepend`` complicated -given that Python treats whitespace as syntactically significant. If you -are defining or extending any Python functions (e.g. -``populate_packages``, ``do_unpack``, ``do_patch`` and so forth) in -custom recipes or classes, you need to ensure you are using consistent -four-space indentation. - -.. _migration-1.3-proto=-in-src-uri: - -proto= in SRC_URI -~~~~~~~~~~~~~~~~~ - -Any use of ``proto=`` in :term:`SRC_URI` needs to be -changed to ``protocol=``. In particular, this applies to the following -URIs: - -- ``svn://`` - -- ``bzr://`` - -- ``hg://`` - -- ``osc://`` - -Other URIs were already using ``protocol=``. This change improves -consistency. - -.. _migration-1.3-nativesdk: - -nativesdk -~~~~~~~~~ - -The suffix ``nativesdk`` is now implemented as a prefix, which -simplifies a lot of the packaging code for ``nativesdk`` recipes. All -custom ``nativesdk`` recipes, which are relocatable packages that are -native to :term:`SDK_ARCH`, and any references need to -be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. - -.. _migration-1.3-task-recipes: - -Task Recipes -~~~~~~~~~~~~ - -"Task" recipes are now known as "Package groups" and have been renamed -from ``task-*.bb`` to ``packagegroup-*.bb``. Existing references to the -previous ``task-*`` 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 ``task-*`` -recipes to ``packagegroup-*``, and change them to inherit -``packagegroup`` instead of ``task``, as well as taking the opportunity -to remove anything now handled by ``packagegroup.bbclass``, such as -providing ``-dev`` and ``-dbg`` packages, setting -:term:`LIC_FILES_CHKSUM`, and so forth. See the -":ref:`packagegroup.bbclass <ref-classes-packagegroup>`" section for -further details. - -.. _migration-1.3-image-features: - -IMAGE_FEATURES -~~~~~~~~~~~~~~ - -Image recipes that previously included ``apps-console-core`` in -:term:`IMAGE_FEATURES` 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`` ``IMAGE_FEATURES`` -features have been removed. - -.. _migration-1.3-removed-recipes: - -Removed Recipes -~~~~~~~~~~~~~~~ - -The following recipes have been removed. For most of them, it is -unlikely that you would have any references to them in your own -:term:`Metadata`. However, you should check your metadata -against this list to be sure: - -- ``libx11-trim``: Replaced by ``libx11``, which has a negligible - size difference with modern Xorg. - -- ``xserver-xorg-lite``: Use ``xserver-xorg``, which has a negligible - size difference when DRI and GLX modules are not installed. - -- ``xserver-kdrive``: Effectively unmaintained for many years. - -- ``mesa-xlib``: No longer serves any purpose. - -- ``galago``: Replaced by telepathy. - -- ``gail``: Functionality was integrated into GTK+ 2.13. - -- ``eggdbus``: No longer needed. - -- ``gcc-*-intermediate``: The build has been restructured to avoid - the need for this step. - -- ``libgsmd``: Unmaintained for many years. Functionality now - provided by ``ofono`` instead. - -- *contacts, dates, tasks, eds-tools*: Largely unmaintained PIM - application suite. It has been moved to ``meta-gnome`` in - ``meta-openembedded``. - -In addition to the previously listed changes, the ``meta-demoapps`` -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 ``meta-oe`` and -``meta-gnome``. For the remainder, you can now find them in the -``meta-extras`` repository, which is in the -:yocto_git:`Source Repositories <>` at -:yocto_git:`/meta-extras/`. - -.. _1.3-linux-kernel-naming: - -Linux Kernel Naming -------------------- - -The naming scheme for kernel output binaries has been changed to now -include :term:`PE` as part of the filename: -:: - - KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}" - -Because the ``PE`` variable is not set by default, these binary files -could result with names that include two dash characters. Here is an -example: :: - - bzImage--3.10.9+git0+cd502a8814_7144bcc4b8-r0-qemux86-64-20130830085431.bin - - diff --git a/documentation/ref-manual/migration-1.4.rst b/documentation/ref-manual/migration-1.4.rst deleted file mode 100644 index f5fac7a2ac..0000000000 --- a/documentation/ref-manual/migration-1.4.rst +++ /dev/null @@ -1,237 +0,0 @@ -Moving to the Yocto Project 1.4 Release (dylan) -=============================================== - -This section provides migration information for moving to the Yocto -Project 1.4 Release (codename "dylan") from the prior release. - -.. _migration-1.4-bitbake: - -BitBake -------- - -Differences include the following: - -- *Comment Continuation:* 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. - -- *Package Name Overrides:* The runtime package specific variables - :term:`RDEPENDS`, - :term:`RRECOMMENDS`, - :term:`RSUGGESTS`, - :term:`RPROVIDES`, - :term:`RCONFLICTS`, - :term:`RREPLACES`, :term:`FILES`, - :term:`ALLOW_EMPTY`, and the pre, post, install, - and uninstall script functions ``pkg_preinst``, ``pkg_postinst``, - ``pkg_prerm``, and ``pkg_postrm`` should always have a package name - override. For example, use ``RDEPENDS_${PN}`` for the main package - instead of ``RDEPENDS``. BitBake uses more strict checks when it - parses recipes. - -.. _migration-1.4-build-behavior: - -Build Behavior --------------- - -Differences include the following: - -- *Shared State Code:* 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: - :: - - $ bitbake -c rootfs some-image - - 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. - -- *Scanning Directory Names:* When scanning for files in - :term:`SRC_URI`, the build system now uses - :term:`FILESOVERRIDES` instead of - :term:`OVERRIDES` for the directory names. In - general, the values previously in ``OVERRIDES`` are now in - ``FILESOVERRIDES`` as well. However, if you relied upon an additional - value you previously added to ``OVERRIDES``, you might now need to - add it to ``FILESOVERRIDES`` unless you are already adding it through - the :term:`MACHINEOVERRIDES` or - :term:`DISTROOVERRIDES` variables, as - appropriate. For more related changes, see the - ":ref:`ref-manual/migration-1.4:variables`" section. - -.. _migration-1.4-proxies-and-fetching-source: - -Proxies and Fetching Source ---------------------------- - -A new ``oe-git-proxy`` script has been added to replace previous methods -of handling proxies and fetching source from Git. See the -``meta-yocto/conf/site.conf.sample`` file for information on how to use -this script. - -.. _migration-1.4-custom-interfaces-file-netbase-change: - -Custom Interfaces File (netbase change) ---------------------------------------- - -If you have created your own custom ``etc/network/interfaces`` file by -creating an append file for the ``netbase`` recipe, you now need to -create an append file for the ``init-ifupdown`` recipe instead, which -you can find in the :term:`Source Directory` at -``meta/recipes-core/init-ifupdown``. For information on how to use -append files, see the -":ref:`dev-manual/common-tasks:using .bbappend files in your layer`" -section in the Yocto Project Development Tasks Manual. - -.. _migration-1.4-remote-debugging: - -Remote Debugging ----------------- - -Support for remote debugging with the Eclipse IDE is now separated into -an image feature (``eclipse-debug``) that corresponds to the -``packagegroup-core-eclipse-debug`` package group. Previously, the -debugging feature was included through the ``tools-debug`` image -feature, which corresponds to the ``packagegroup-core-tools-debug`` -package group. - -.. _migration-1.4-variables: - -Variables ---------- - -The following variables have changed: - -- ``SANITY_TESTED_DISTROS``: This variable now uses a distribution - ID, which is composed of the host distributor ID followed by the - release. Previously, - :term:`SANITY_TESTED_DISTROS` 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 "". - -- ``SRC_URI``: The ``${``\ :term:`PN`\ ``}``, - ``${``\ :term:`PF`\ ``}``, - ``${``\ :term:`P`\ ``}``, and ``FILE_DIRNAME`` directories - have been dropped from the default value of the - :term:`FILESPATH` variable, which is used as the - search path for finding files referred to in - :term:`SRC_URI`. 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 ``${``\ :term:`BP`\ ``}``, - ``${``\ :term:`BPN`\ ``}``, and "files", which all remain in the default value of - :term:`FILESPATH`. - -.. _migration-target-package-management-with-rpm: - -Target Package Management with RPM ----------------------------------- - -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: -:: - - smart --help - -.. _migration-1.4-recipes-moved: - -Recipes Moved -------------- - -The following recipes were moved from their previous locations because -they are no longer used by anything in the OpenEmbedded-Core: - -- ``clutter-box2d``: Now resides in the ``meta-oe`` layer. - -- ``evolution-data-server``: Now resides in the ``meta-gnome`` layer. - -- ``gthumb``: Now resides in the ``meta-gnome`` layer. - -- ``gtkhtml2``: Now resides in the ``meta-oe`` layer. - -- ``gupnp``: Now resides in the ``meta-multimedia`` layer. - -- ``gypsy``: Now resides in the ``meta-oe`` layer. - -- ``libcanberra``: Now resides in the ``meta-gnome`` layer. - -- ``libgdata``: Now resides in the ``meta-gnome`` layer. - -- ``libmusicbrainz``: Now resides in the ``meta-multimedia`` layer. - -- ``metacity``: Now resides in the ``meta-gnome`` layer. - -- ``polkit``: Now resides in the ``meta-oe`` layer. - -- ``zeroconf``: Now resides in the ``meta-networking`` layer. - -.. _migration-1.4-removals-and-renames: - -Removals and Renames --------------------- - -The following list shows what has been removed or renamed: - -- ``evieext``: Removed because it has been removed from ``xserver`` - since 2008. - -- *Gtk+ DirectFB:* Removed support because upstream Gtk+ no longer - supports it as of version 2.18. - -- ``libxfontcache / xfontcacheproto``: Removed because they were - removed from the Xorg server in 2008. - -- ``libxp / libxprintapputil / libxprintutil / printproto``: Removed - because the XPrint server was removed from Xorg in 2008. - -- ``libxtrap / xtrapproto``: Removed because their functionality was - broken upstream. - -- *linux-yocto 3.0 kernel:* 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. - -- ``lsbsetup``: Removed with functionality now provided by - ``lsbtest``. - -- ``matchbox-stroke``: Removed because it was never more than a - proof-of-concept. - -- ``matchbox-wm-2 / matchbox-theme-sato-2``: Removed because they are - not maintained. However, ``matchbox-wm`` and ``matchbox-theme-sato`` - are still provided. - -- ``mesa-dri``: Renamed to ``mesa``. - -- ``mesa-xlib``: Removed because it was no longer useful. - -- ``mutter``: Removed because nothing ever uses it and the recipe is - very old. - -- ``orinoco-conf``: Removed because it has become obsolete. - -- ``update-modules``: Removed because it is no longer used. The - kernel module ``postinstall`` and ``postrm`` scripts can now do the - same task without the use of this script. - -- ``web``: Removed because it is not maintained. Superseded by - ``web-webkit``. - -- ``xf86bigfontproto``: Removed because upstream it has been disabled - by default since 2007. Nothing uses ``xf86bigfontproto``. - -- ``xf86rushproto``: Removed because its dependency in ``xserver`` - was spurious and it was removed in 2005. - -- ``zypper / libzypp / sat-solver``: Removed and been functionally - replaced with Smart (``python-smartpm``) when RPM packaging is used - and package management is enabled on the target. - diff --git a/documentation/ref-manual/migration-1.5.rst b/documentation/ref-manual/migration-1.5.rst deleted file mode 100644 index c772e51b54..0000000000 --- a/documentation/ref-manual/migration-1.5.rst +++ /dev/null @@ -1,353 +0,0 @@ -Moving to the Yocto Project 1.5 Release (dora) -============================================== - -This section provides migration information for moving to the Yocto -Project 1.5 Release (codename "dora") from the prior release. - -.. _migration-1.5-host-dependency-changes: - -Host Dependency Changes ------------------------ - -The OpenEmbedded build system now has some additional requirements on -the host system: - -- Python 2.7.3+ - -- Tar 1.24+ - -- Git 1.7.8+ - -- Patched version of Make if you are using 3.82. Most distributions - that provide Make 3.82 use the patched version. - -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. - -For more information on this requirement, see the -":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" -section. - -.. _migration-1.5-atom-pc-bsp: - -``atom-pc`` Board Support Package (BSP) ---------------------------------------- - -The ``atom-pc`` hardware reference BSP has been replaced by a -``genericx86`` 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 -``atom-pc`` did. - -.. note:: - - Additionally, a ``genericx86-64`` BSP has been added for 64-bit Atom - systems. - -.. _migration-1.5-bitbake: - -BitBake -------- - -The following changes have been made that relate to BitBake: - -- BitBake now supports a ``_remove`` operator. The addition of this - operator means you will have to rename any items in recipe space - (functions, variables) whose names currently contain ``_remove_`` or - end with ``_remove`` to avoid unexpected behavior. - -- 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. - -- The "none" server backend has been removed. The "process" server - backend has been serving well as the default for a long time now. - -- The ``bitbake-runtask`` script has been removed. - -- ``${``\ :term:`P`\ ``}`` and - ``${``\ :term:`PF`\ ``}`` are no longer added to - :term:`PROVIDES` by default in ``bitbake.conf``. - These version-specific ``PROVIDES`` 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. - -.. _migration-1.5-qa-warnings: - -QA Warnings ------------ - -The following changes have been made to the package QA checks: - -- If you have customized :term:`ERROR_QA` or - :term:`WARN_QA` 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 ``ERROR_QA`` or ``WARN_QA`` would be treated as - a warning. Consequently, several important items were not already in - the default value of ``WARN_QA``. All of the possible QA checks are - now documented in the ":ref:`insane.bbclass <ref-classes-insane>`" - section. - -- An additional QA check has been added to check if - ``/usr/share/info/dir`` is being installed. Your recipe should delete - this file within :ref:`ref-tasks-install` if "make - install" is installing it. - -- 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 ``ERROR_QA`` or ``WARN_QA`` 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 - ":ref:`insane.bbclass <ref-classes-insane>`" section. - -.. _migration-1.5-directory-layout-changes: - -Directory Layout Changes ------------------------- - -The following directory changes exist: - -- Output SDK installer files are now named to include the image name - and tuning architecture through the :term:`SDK_NAME` - variable. - -- 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 - :term:`DEPLOY_DIR_IMAGE` variable continues - to point to the directory containing images for the current - :term:`MACHINE` and should be used anywhere there is a - need to refer to this directory. The ``runqemu`` script now uses this - variable to find images and kernel binaries and will use BitBake to - determine the directory. Alternatively, you can set the - ``DEPLOY_DIR_IMAGE`` variable in the external environment. - -- When buildhistory is enabled, its output is now written under the - :term:`Build Directory` rather than - :term:`TMPDIR`. Doing so makes it easier to delete - ``TMPDIR`` and preserve the build history. Additionally, data for - produced SDKs is now split by :term:`IMAGE_NAME`. - -- The ``pkgdata`` directory produced as part of the packaging process - has been collapsed into a single machine-specific directory. This - directory is located under ``sysroots`` and uses a machine-specific - name (i.e. ``tmp/sysroots/machine/pkgdata``). - -.. _migration-1.5-shortened-git-srcrev-values: - -Shortened Git ``SRCREV`` Values -------------------------------- - -BitBake will now shorten revisions from Git repositories from the normal -40 characters down to 10 characters within :term:`SRCPV` -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. - -.. _migration-1.5-image-features: - -``IMAGE_FEATURES`` ------------------- - -The following changes have been made that relate to -:term:`IMAGE_FEATURES`: - -- The value of ``IMAGE_FEATURES`` is now validated to ensure invalid - feature items are not added. Some users mistakenly add package names - to this variable instead of using - :term:`IMAGE_INSTALL` 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 ``IMAGE_FEATURES`` - are drawn from ``PACKAGE_GROUP`` definitions, - :term:`COMPLEMENTARY_GLOB` and a new - "validitems" varflag on ``IMAGE_FEATURES``. The "validitems" varflag - change allows additional features to be added if they are not - provided using the previous two mechanisms. - -- The previously deprecated "apps-console-core" ``IMAGE_FEATURES`` item - is no longer supported. Add "splash" to ``IMAGE_FEATURES`` if you - wish to have the splash screen enabled, since this is all that - apps-console-core was doing. - -.. _migration-1.5-run: - -``/run`` --------- - -The ``/run`` directory from the Filesystem Hierarchy Standard 3.0 has -been introduced. You can find some of the implications for this change -:oe_git:`here </openembedded-core/commit/?id=0e326280a15b0f2c4ef2ef4ec441f63f55b75873>`. -The change also means that recipes that install files to ``/var/run`` -must be changed. You can find a guide on how to make these changes -`here <https://www.mail-archive.com/openembedded-devel@lists.openembedded.org/msg31649.html>`__. - -.. _migration-1.5-removal-of-package-manager-database-within-image-recipes: - -Removal of Package Manager Database Within Image Recipes --------------------------------------------------------- - -The image ``core-image-minimal`` no longer adds -``remove_packaging_data_files`` to -:term:`ROOTFS_POSTPROCESS_COMMAND`. -This addition is now handled automatically when "package-management" is -not in :term:`IMAGE_FEATURES`. 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. - -.. _migration-1.5-images-now-rebuild-only-on-changes-instead-of-every-time: - -Images Now Rebuild Only on Changes Instead of Every Time --------------------------------------------------------- - -The :ref:`ref-tasks-rootfs` 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. - -.. _migration-1.5-task-recipes: - -Task Recipes ------------- - -The previously deprecated ``task.bbclass`` has now been dropped. For -recipes that previously inherited from this class, you should rename -them from ``task-*`` to ``packagegroup-*`` and inherit packagegroup -instead. - -For more information, see the -":ref:`packagegroup.bbclass <ref-classes-packagegroup>`" section. - -.. _migration-1.5-busybox: - -BusyBox -------- - -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 ``tinylogin`` recipe as recommended by upstream. You can disable -this split by setting -:term:`BUSYBOX_SPLIT_SUID` to "0". - -.. _migration-1.5-automated-image-testing: - -Automated Image Testing ------------------------ - -A new automated image testing framework has been added through the -:ref:`testimage.bbclass <ref-classes-testimage*>` class. This -framework replaces the older ``imagetest-qemu`` framework. - -You can learn more about performing automated image tests in the -":ref:`dev-manual/common-tasks:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. - -.. _migration-1.5-build-history: - -Build History -------------- - -Following are changes to Build History: - -- Installed package sizes: ``installed-package-sizes.txt`` for an image - now records the size of the files installed by each package instead - of the size of each compressed package archive file. - -- The dependency graphs (``depends*.dot``) now use the actual package - names instead of replacing dashes, dots and plus signs with - underscores. - -- The ``buildhistory-diff`` and ``buildhistory-collect-srcrevs`` - utilities have improved command-line handling. Use the ``--help`` - option for each utility for more information on the new syntax. - -For more information on Build History, see the -":ref:`dev-manual/common-tasks:maintaining build output quality`" -section in the Yocto Project Development Tasks Manual. - -.. _migration-1.5-udev: - -``udev`` --------- - -Following are changes to ``udev``: - -- ``udev`` no longer brings in ``udev-extraconf`` automatically through - :term:`RRECOMMENDS`, since this was originally - intended to be optional. If you need the extra rules, then add - ``udev-extraconf`` to your image. - -- ``udev`` no longer brings in ``pciutils-ids`` or ``usbutils-ids`` - through ``RRECOMMENDS``. These are not needed by ``udev`` itself and - removing them saves around 350KB. - -.. _migration-1.5-removed-renamed-recipes: - -Removed and Renamed Recipes ---------------------------- - -- The ``linux-yocto`` 3.2 kernel has been removed. - -- ``libtool-nativesdk`` has been renamed to ``nativesdk-libtool``. - -- ``tinylogin`` has been removed. It has been replaced by a suid - portion of Busybox. See the ":ref:`migration-1.5-busybox`" - section for more information. - -- ``external-python-tarball`` has been renamed to - ``buildtools-tarball``. - -- ``web-webkit`` has been removed. It has been functionally replaced by - ``midori``. - -- ``imake`` has been removed. It is no longer needed by any other - recipe. - -- ``transfig-native`` has been removed. It is no longer needed by any - other recipe. - -- ``anjuta-remote-run`` has been removed. Anjuta IDE integration has - not been officially supported for several releases. - -.. _migration-1.5-other-changes: - -Other Changes -------------- - -Following is a list of short entries describing other changes: - -- ``run-postinsts``: Make this generic. - -- ``base-files``: Remove the unnecessary ``media/``\ xxx directories. - -- ``alsa-state``: Provide an empty ``asound.conf`` by default. - -- ``classes/image``: Ensure - :term:`BAD_RECOMMENDATIONS` supports - pre-renamed package names. - -- ``classes/rootfs_rpm``: Implement ``BAD_RECOMMENDATIONS`` for RPM. - -- ``systemd``: Remove ``systemd_unitdir`` if ``systemd`` is not in - :term:`DISTRO_FEATURES`. - -- ``systemd``: Remove ``init.d`` dir if ``systemd`` unit file is - present and ``sysvinit`` is not a distro feature. - -- ``libpam``: Deny all services for the ``OTHER`` entries. - -- ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict - with ``multilib``. See :yocto_bugs:`YOCTO #4993 </show_bug.cgi?id=4993>` - in Bugzilla for more information. - -- ``linux-dtb``: Use kernel build system to generate the ``dtb`` files. - -- ``kern-tools``: Switch from guilt to new ``kgit-s2q`` tool. - diff --git a/documentation/ref-manual/migration-1.6.rst b/documentation/ref-manual/migration-1.6.rst deleted file mode 100644 index 4c6afab1fb..0000000000 --- a/documentation/ref-manual/migration-1.6.rst +++ /dev/null @@ -1,416 +0,0 @@ -Moving to the Yocto Project 1.6 Release (daisy) -=============================================== - -This section provides migration information for moving to the Yocto -Project 1.6 Release (codename "daisy") from the prior release. - -.. _migration-1.6-archiver-class: - -``archiver`` Class ------------------- - -The :ref:`archiver <ref-classes-archiver>` class has been rewritten -and its configuration has been simplified. For more details on the -source archiver, see the -":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" -section in the Yocto Project Development Tasks Manual. - -.. _migration-1.6-packaging-changes: - -Packaging Changes ------------------ - -The following packaging changes have been made: - -- The ``binutils`` recipe no longer produces a ``binutils-symlinks`` - package. ``update-alternatives`` is now used to handle the preferred - ``binutils`` variant on the target instead. - -- The tc (traffic control) utilities have been split out of the main - ``iproute2`` package and put into the ``iproute2-tc`` package. - -- The ``gtk-engines`` schemas have been moved to a dedicated - ``gtk-engines-schemas`` package. - -- The ``armv7a`` 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. - -.. _migration-1.6-bitbake: - -BitBake -------- - -The following changes have been made to :term:`BitBake`. - -.. _migration-1.6-matching-branch-requirement-for-git-fetching: - -Matching Branch Requirement for Git Fetching -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When fetching source from a Git repository using -:term:`SRC_URI`, BitBake will now validate the -:term:`SRCREV` value against the branch. You can specify -the branch using the following form: -:: - - SRC_URI = "git://server.name/repository;branch=branchname" - -If you do not specify a branch, BitBake looks in the default "master" branch. - -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 ``SRC_URI``. - -.. _migration-1.6-bitbake-deps: - -Python Definition substitutions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -BitBake had some previously deprecated Python definitions within its -``bb`` module removed. You should use their sub-module counterparts -instead: - -- ``bb.MalformedUrl``: Use ``bb.fetch.MalformedUrl``. - -- ``bb.encodeurl``: Use ``bb.fetch.encodeurl``. - -- ``bb.decodeurl``: Use ``bb.fetch.decodeurl`` - -- ``bb.mkdirhier``: Use ``bb.utils.mkdirhier``. - -- ``bb.movefile``: Use ``bb.utils.movefile``. - -- ``bb.copyfile``: Use ``bb.utils.copyfile``. - -- ``bb.which``: Use ``bb.utils.which``. - -- ``bb.vercmp_string``: Use ``bb.utils.vercmp_string``. - -- ``bb.vercmp``: Use ``bb.utils.vercmp``. - -.. _migration-1.6-bitbake-fetcher: - -SVK Fetcher -~~~~~~~~~~~ - -The SVK fetcher has been removed from BitBake. - -.. _migration-1.6-bitbake-console-output: - -Console Output Error Redirection -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The BitBake console UI will now output errors to ``stderr`` instead of -``stdout``. Consequently, if you are piping or redirecting the output of -``bitbake`` to somewhere else, and you wish to retain the errors, you -will need to add ``2>&1`` (or something similar) to the end of your -``bitbake`` command line. - -.. _migration-1.6-task-taskname-overrides: - -``task-``\ taskname Overrides -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -``task-``\ taskname 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 :ref:`ref-tasks-populate_sdk` is -``task-populate-sdk``. - -.. _migration-1.6-variable-changes: - -Changes to Variables --------------------- - -The following variables have changed. For information on the -OpenEmbedded build system variables, see the ":doc:`/ref-manual/variables`" Chapter. - -.. _migration-1.6-variable-changes-TMPDIR: - -``TMPDIR`` -~~~~~~~~~~ - -:term:`TMPDIR` 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 ``TMPDIR``. - -The check for this occurs on startup. If ``TMPDIR`` is detected on an -NFS mount, an error occurs. - -.. _migration-1.6-variable-changes-PRINC: - -``PRINC`` -~~~~~~~~~ - -The ``PRINC`` variable has been deprecated and triggers a warning if -detected during a build. For :term:`PR` increments on changes, -use the PR service instead. You can find out more about this service in -the ":ref:`dev-manual/common-tasks:working with a pr service`" -section in the Yocto Project Development Tasks Manual. - -.. _migration-1.6-variable-changes-IMAGE_TYPES: - -``IMAGE_TYPES`` -~~~~~~~~~~~~~~~ - -The "sum.jffs2" option for :term:`IMAGE_TYPES` has -been replaced by the "jffs2.sum" option, which fits the processing -order. - -.. _migration-1.6-variable-changes-COPY_LIC_MANIFEST: - -``COPY_LIC_MANIFEST`` -~~~~~~~~~~~~~~~~~~~~~ - -The :term:`COPY_LIC_MANIFEST` variable must now -be set to "1" rather than any value in order to enable it. - -.. _migration-1.6-variable-changes-COPY_LIC_DIRS: - -``COPY_LIC_DIRS`` -~~~~~~~~~~~~~~~~~ - -The :term:`COPY_LIC_DIRS` variable must now be set -to "1" rather than any value in order to enable it. - -.. _migration-1.6-variable-changes-PACKAGE_GROUP: - -``PACKAGE_GROUP`` -~~~~~~~~~~~~~~~~~ - -The ``PACKAGE_GROUP`` variable has been renamed to -:term:`FEATURE_PACKAGES` to more accurately -reflect its purpose. You can still use ``PACKAGE_GROUP`` but the -OpenEmbedded build system produces a warning message when it encounters -the variable. - -.. _migration-1.6-variable-changes-variable-entry-behavior: - -Preprocess and Post Process Command Variable Behavior -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The following variables now expect a semicolon separated list of -functions to call and not arbitrary shell commands: - - - :term:`ROOTFS_PREPROCESS_COMMAND` - - :term:`ROOTFS_POSTPROCESS_COMMAND` - - :term:`SDK_POSTPROCESS_COMMAND` - - :term:`POPULATE_SDK_POST_TARGET_COMMAND` - - :term:`POPULATE_SDK_POST_HOST_COMMAND` - - :term:`IMAGE_POSTPROCESS_COMMAND` - - :term:`IMAGE_PREPROCESS_COMMAND` - - :term:`ROOTFS_POSTUNINSTALL_COMMAND` - - :term:`ROOTFS_POSTINSTALL_COMMAND` - -For -migration purposes, you can simply wrap shell commands in a shell -function and then call the function. Here is an example: :: - - my_postprocess_function() { - echo "hello" > ${IMAGE_ROOTFS}/hello.txt - } - ROOTFS_POSTPROCESS_COMMAND += "my_postprocess_function; " - -.. _migration-1.6-package-test-ptest: - -Package Test (ptest) --------------------- - -Package Tests (ptest) are built but not installed by default. For -information on using Package Tests, see the -":ref:`dev-manual/common-tasks:testing packages with ptest`" -section in the Yocto Project Development Tasks Manual. For information on the -``ptest`` class, see the ":ref:`ptest.bbclass <ref-classes-ptest>`" -section. - -.. _migration-1.6-build-changes: - -Build Changes -------------- - -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 :ref:`cmake <ref-classes-cmake>` class. In -future releases the :ref:`autotools <ref-classes-autotools>` 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 -:ref:`autotools-brokensep <ref-classes-autotools>` class instead of -the ``autotools`` or ``autotools_stage``\ classes. - -.. _migration-1.6-building-qemu-native: - -``qemu-native`` ---------------- - -``qemu-native`` now builds without SDL-based graphical output support by -default. The following additional lines are needed in your -``local.conf`` to enable it: -:: - - PACKAGECONFIG_pn-qemu-native = "sdl" - ASSUME_PROVIDED += "libsdl-native" - -.. note:: - - The default ``local.conf`` contains these statements. Consequently, if you - are building a headless system and using a default ``local.conf`` - file, you will need comment these two lines out. - -.. _migration-1.6-core-image-basic: - -``core-image-basic`` --------------------- - -``core-image-basic`` has been renamed to ``core-image-full-cmdline``. - -In addition to ``core-image-basic`` being renamed, -``packagegroup-core-basic`` has been renamed to -``packagegroup-core-full-cmdline`` to match. - -.. _migration-1.6-licensing: - -Licensing ---------- - -The top-level ``LICENSE`` file has been changed to better describe the -license of the various components of :term:`OpenEmbedded-Core (OE-Core)`. However, -the licensing itself remains unchanged. - -Normally, this change would not cause any side-effects. However, some -recipes point to this file within -:term:`LIC_FILES_CHKSUM` (as -``${COREBASE}/LICENSE``) and thus the accompanying checksum must be -changed from 3f40d7994397109285ec7b81fdeb3b58 to -4d92cd373abda3937c2bc47fbc49d690. A better alternative is to have -``LIC_FILES_CHKSUM`` point to a file describing the license that is -distributed with the source that the recipe is building, if possible, -rather than pointing to ``${COREBASE}/LICENSE``. - -.. _migration-1.6-cflags-options: - -``CFLAGS`` Options ------------------- - -The "-fpermissive" option has been removed from the default -:term:`CFLAGS` 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 ``CFLAGS`` in the recipes. - -.. _migration-1.6-custom-images: - -Custom Image Output Types -------------------------- - -Custom image output types, as selected using -:term:`IMAGE_FSTYPES`, must declare their -dependencies on other image types (if any) using a new -:term:`IMAGE_TYPEDEP` variable. - -.. _migration-1.6-do-package-write-task: - -Tasks ------ - -The ``do_package_write`` task has been removed. The task is no longer -needed. - -.. _migration-1.6-update-alternatives-provider: - -``update-alternative`` Provider -------------------------------- - -The default ``update-alternatives`` provider has been changed from -``opkg`` to ``opkg-utils``. This change resolves some troublesome -circular dependencies. The runtime package has also been renamed from -``update-alternatives-cworth`` to ``update-alternatives-opkg``. - -.. _migration-1.6-virtclass-overrides: - -``virtclass`` Overrides ------------------------ - -The ``virtclass`` overrides are now deprecated. Use the equivalent class -overrides instead (e.g. ``virtclass-native`` becomes ``class-native``.) - -.. _migration-1.6-removed-renamed-recipes: - -Removed and Renamed Recipes ---------------------------- - -The following recipes have been removed: - -- ``packagegroup-toolset-native`` - This recipe is largely unused. - -- ``linux-yocto-3.8`` - 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 ``linux-yocto-3.10`` and ``linux-yocto-3.14`` recipes. - -- ``ocf-linux`` - This recipe has been functionally replaced using - ``cryptodev-linux``. - -- ``genext2fs`` - ``genext2fs`` is no longer used by the build system - and is unmaintained upstream. - -- ``js`` - This provided an ancient version of Mozilla's javascript - engine that is no longer needed. - -- ``zaurusd`` - The recipe has been moved to the ``meta-handheld`` - layer. - -- ``eglibc 2.17`` - Replaced by the ``eglibc 2.19`` recipe. - -- ``gcc 4.7.2`` - Replaced by the now stable ``gcc 4.8.2``. - -- ``external-sourcery-toolchain`` - this recipe is now maintained in - the ``meta-sourcery`` layer. - -- ``linux-libc-headers-yocto 3.4+git`` - Now using version 3.10 of the - ``linux-libc-headers`` by default. - -- ``meta-toolchain-gmae`` - This recipe is obsolete. - -- ``packagegroup-core-sdk-gmae`` - This recipe is obsolete. - -- ``packagegroup-core-standalone-gmae-sdk-target`` - This recipe is - obsolete. - -.. _migration-1.6-removed-classes: - -Removed Classes ---------------- - -The following classes have become obsolete and have been removed: - -- ``module_strip`` - -- ``pkg_metainfo`` - -- ``pkg_distribute`` - -- ``image-empty`` - -.. _migration-1.6-reference-bsps: - -Reference Board Support Packages (BSPs) ---------------------------------------- - -The following reference BSPs changes occurred: - -- The BeagleBoard (``beagleboard``) ARM reference hardware has been - replaced by the BeagleBone (``beaglebone``) hardware. - -- The RouterStation Pro (``routerstationpro``) MIPS reference hardware - has been replaced by the EdgeRouter Lite (``edgerouter``) hardware. - -The previous reference BSPs for the ``beagleboard`` and -``routerstationpro`` machines are still available in a new -``meta-yocto-bsp-old`` layer in the -:yocto_git:`Source Repositories <>` at -:yocto_git:`/meta-yocto-bsp-old/`. - - diff --git a/documentation/ref-manual/migration-1.7.rst b/documentation/ref-manual/migration-1.7.rst deleted file mode 100644 index 9cf467f28b..0000000000 --- a/documentation/ref-manual/migration-1.7.rst +++ /dev/null @@ -1,223 +0,0 @@ -Moving to the Yocto Project 1.7 Release (dizzy) -=============================================== - -This section provides migration information for moving to the Yocto -Project 1.7 Release (codename "dizzy") from the prior release. - -.. _migration-1.7-changes-to-setting-qemu-packageconfig-options: - -Changes to Setting QEMU ``PACKAGECONFIG`` Options in ``local.conf`` -------------------------------------------------------------------- - -The QEMU recipe now uses a number of -:term:`PACKAGECONFIG` options to enable various -optional features. The method used to set defaults for these options -means that existing ``local.conf`` files will need to be modified to -append to ``PACKAGECONFIG`` for ``qemu-native`` and ``nativesdk-qemu`` -instead of setting it. In other words, to enable graphical output for -QEMU, you should now have these lines in ``local.conf``: -:: - - PACKAGECONFIG_append_pn-qemu-native = " sdl" - PACKAGECONFIG_append_pn-nativesdk-qemu = " sdl" - -.. _migration-1.7-minimum-git-version: - -Minimum Git version -------------------- - -The minimum :ref:`overview-manual/development-environment:git` -version required on the -build host is now 1.7.8 because the ``--list`` option is now required by -BitBake's Git fetcher. As always, if your host distribution does not -provide a version of Git that meets this requirement, you can use the -``buildtools-tarball`` that does. See the -":ref:`ref-manual/system-requirements:required git, tar, python and gcc versions`" -section for more information. - -.. _migration-1.7-autotools-class-changes: - -Autotools Class Changes ------------------------ - -The following :ref:`autotools <ref-classes-autotools>` class changes -occurred: - -- *A separate build directory is now used by default:* The - ``autotools`` class has been changed to use a directory for building - (:term:`B`), which is separate from the source directory - (:term:`S`). This is commonly referred to as ``B != S``, or - an out-of-tree build. - - 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 :ref:`autotools-brokensep <ref-classes-autotools>` class - instead of the ``autotools`` or ``autotools_stage`` classes. - -- The ``--foreign`` option is no longer passed to ``automake`` when - running ``autoconf``: This option tells ``automake`` that a - particular software package does not follow the GNU standards and - therefore should not be expected to distribute certain files such as - ``ChangeLog``, ``AUTHORS``, and so forth. Because the majority of - upstream software packages already tell ``automake`` 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 ``configure.ac`` so that it passes "foreign" - to ``AM_INIT_AUTOMAKE()``. See :oe_git:`this - commit </openembedded-core/commit/?id=01943188f85ce6411717fb5bf702d609f55813f2>` - for an example showing how to make the patch. - -.. _migration-1.7-binary-configuration-scripts-disabled: - -Binary Configuration Scripts Disabled -------------------------------------- - -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 ``pkg-config`` instead. -The list of recipes changed in this version (and their configuration -scripts) is as follows: -:: - - 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) - -Additionally, support for ``pkg-config`` has been added to some recipes in the -previous list in the rare cases where the upstream software package does -not already provide it. - -.. _migration-1.7-glibc-replaces-eglibc: - -``eglibc 2.19`` Replaced with ``glibc 2.20`` --------------------------------------------- - -Because ``eglibc`` and ``glibc`` were already fairly close, this -replacement should not require any significant changes to other software -that links to ``eglibc``. However, there were a number of minor changes -in ``glibc 2.20`` upstream that could require patching some software -(e.g. the removal of the ``_BSD_SOURCE`` feature test macro). - -``glibc 2.20`` requires version 2.6.32 or greater of the Linux kernel. -Thus, older kernels will no longer be usable in conjunction with it. - -For full details on the changes in ``glibc 2.20``, see the upstream -release notes -`here <https://sourceware.org/ml/libc-alpha/2014-09/msg00088.html>`__. - -.. _migration-1.7-kernel-module-autoloading: - -Kernel Module Autoloading -------------------------- - -The :term:`module_autoload_* <module_autoload>` variable is now -deprecated and a new -:term:`KERNEL_MODULE_AUTOLOAD` variable -should be used instead. Also, :term:`module_conf_* <module_conf>` -must now be used in conjunction with a new -:term:`KERNEL_MODULE_PROBECONF` 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 -``module_autoload_*`` with ``KERNEL_MODULE_AUTOLOAD``, and add any -modules for which ``module_conf_*`` is specified to -``KERNEL_MODULE_PROBECONF``. - -.. _migration-1.7-qa-check-changes: - -QA Check Changes ----------------- - -The following changes have occurred to the QA check process: - -- Additional QA checks ``file-rdeps`` and ``build-deps`` have been - added in order to verify that file dependencies are satisfied (e.g. - package contains a script requiring ``/bin/bash``) and build-time - dependencies are declared, respectively. For more information, please - see the ":doc:`/ref-manual/qa-checks`" chapter. - -- Package QA checks are now performed during a new - :ref:`ref-tasks-package_qa` task rather than being - part of the :ref:`ref-tasks-package` 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 ``noexec``. For those packages, you - will need to disable the ``do_package_qa`` task as well. - -- Files being overwritten during the - :ref:`ref-tasks-populate_sysroot` 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. - - 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 :term:`TMPDIR` 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. - -.. _migration-1.7-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed: - -- ``x-load``: This recipe has been superseded by U-Boot SPL for all - Cortex-based TI SoCs. For legacy boards, the ``meta-ti`` layer, which - contains a maintained recipe, should be used instead. - -- ``ubootchart``: This recipe is obsolete. A ``bootchart2`` recipe has - been added to functionally replace it. - -- ``linux-yocto 3.4``: 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. - -- ``eglibc`` has been removed in favor of ``glibc``. See the - ":ref:`migration-1.7-glibc-replaces-eglibc`" section for more information. - -.. _migration-1.7-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -The following miscellaneous change occurred: - -- The build history feature now writes ``build-id.txt`` instead of - ``build-id``. Additionally, ``build-id.txt`` 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 - ":ref:`dev-manual/common-tasks:maintaining build output quality`" - section in the Yocto Project Development Tasks Manual. - - diff --git a/documentation/ref-manual/migration-1.8.rst b/documentation/ref-manual/migration-1.8.rst deleted file mode 100644 index ec2b138796..0000000000 --- a/documentation/ref-manual/migration-1.8.rst +++ /dev/null @@ -1,183 +0,0 @@ -Moving to the Yocto Project 1.8 Release (fido) -============================================== - -This section provides migration information for moving to the Yocto -Project 1.8 Release (codename "fido") from the prior release. - -.. _migration-1.8-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed: - -- ``owl-video``: Functionality replaced by ``gst-player``. - -- ``gaku``: Functionality replaced by ``gst-player``. - -- ``gnome-desktop``: This recipe is now available in ``meta-gnome`` and - is no longer needed. - -- ``gsettings-desktop-schemas``: This recipe is now available in - ``meta-gnome`` and is no longer needed. - -- ``python-argparse``: The ``argparse`` module is already provided in - the default Python distribution in a package named - ``python-argparse``. Consequently, the separate ``python-argparse`` - recipe is no longer needed. - -- ``telepathy-python, libtelepathy, telepathy-glib, telepathy-idle, telepathy-mission-control``: - All these recipes have moved to ``meta-oe`` and are consequently no - longer needed by any recipes in OpenEmbedded-Core. - -- ``linux-yocto_3.10`` and ``linux-yocto_3.17``: 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. - -- ``poky-feed-config-opkg``: This recipe has become obsolete and is no - longer needed. Use ``distro-feed-config`` from ``meta-oe`` instead. - -- ``libav 0.8.x``: ``libav 9.x`` is now used. - -- ``sed-native``: No longer needed. A working version of ``sed`` is - expected to be provided by the host distribution. - -.. _migration-1.8-bluez: - -BlueZ 4.x / 5.x Selection -------------------------- - -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 -:term:`DISTRO_FEATURES` value. If you had -previously added append files (``*.bbappend``) to make this selection, -you can now remove them. - -Additionally, a ``bluetooth`` 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: :: - - 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" - -.. _migration-1.8-kernel-build-changes: - -Kernel Build Changes --------------------- - -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 ``${S}`` (source files) and -``${B}`` (build artifacts) are used correctly in functions such as -:ref:`ref-tasks-configure` and -:ref:`ref-tasks-install`. For kernel recipes that do not -inherit from ``kernel-yocto`` or include ``linux-yocto.inc``, you might -wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the -kinds of changes you need to make. For reference, here is the -:oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` -where the ``linux.inc`` file in ``meta-oe`` was updated. - -Recipes that rely on the kernel source code and do not inherit the -module classes might need to add explicit dependencies on the -``do_shared_workdir`` kernel task, for example: :: - - do_configure[depends] += "virtual/kernel:do_shared_workdir" - -.. _migration-1.8-ssl: - -SSL 3.0 is Now Disabled in OpenSSL ----------------------------------- - -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 (``*.bbappend``) -for the ``openssl`` recipe to remove "-no-ssl3" from -:term:`EXTRA_OECONF`. - -.. _migration-1.8-default-sysroot-poisoning: - -Default Sysroot Poisoning -------------------------- - -``gcc's`` 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. - -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. - -.. _migration-1.8-rebuild-improvements: - -Rebuild Improvements --------------------- - -Changes have been made to the :ref:`base <ref-classes-base>`, -:ref:`autotools <ref-classes-autotools>`, and -:ref:`cmake <ref-classes-cmake>` classes to clean out generated files -when the :ref:`ref-tasks-configure` task needs to be -re-executed. - -One of the improvements is to attempt to run "make clean" during the -``do_configure`` task if a ``Makefile`` exists. Some software packages -do not provide a working clean target within their make files. If you -have such recipes, you need to set -:term:`CLEANBROKEN` to "1" within the recipe, for example: :: - - CLEANBROKEN = "1" - -.. _migration-1.8-qa-check-and-validation-changes: - -QA Check and Validation Changes -------------------------------- - -The following QA Check and Validation Changes have occurred: - -- Usage of ``PRINC`` previously triggered a warning. It now triggers an - error. You should remove any remaining usage of ``PRINC`` in any - recipe or append file. - -- An additional QA check has been added to detect usage of ``${D}`` in - :term:`FILES` values where :term:`D` values - should not be used at all. The same check ensures that ``$D`` is used - in ``pkg_preinst/pkg_postinst/pkg_prerm/pkg_postrm`` functions - instead of ``${D}``. - -- :term:`S` now needs to be set to a valid value within a - recipe. If ``S`` is not set in the recipe, the directory is not - automatically created. If ``S`` does not point to a directory that - exists at the time the :ref:`ref-tasks-unpack` task - finishes, a warning will be shown. - -- :term:`LICENSE` 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. - -.. _migration-1.8-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -The following miscellaneous changes have occurred: - -- The ``send-error-report`` script now expects a "-s" option to be - specified before the server address. This assumes a server address is - being specified. - -- The ``oe-pkgdata-util`` script now expects a "-p" option to be - specified before the ``pkgdata`` directory, which is now optional. If - the ``pkgdata`` directory is not specified, the script will run - BitBake to query :term:`PKGDATA_DIR` from the - build environment. - - diff --git a/documentation/ref-manual/migration-2.0.rst b/documentation/ref-manual/migration-2.0.rst deleted file mode 100644 index 9da60dfdcb..0000000000 --- a/documentation/ref-manual/migration-2.0.rst +++ /dev/null @@ -1,281 +0,0 @@ -Moving to the Yocto Project 2.0 Release (jethro) -================================================ - -This section provides migration information for moving to the Yocto -Project 2.0 Release (codename "jethro") from the prior release. - -.. _migration-2.0-gcc-5: - -GCC 5 ------ - -The default compiler is now GCC 5.2. This change has required fixes for -compilation errors in a number of other recipes. - -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 -`patch <https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit?id=a077224fd35b2f7fbc93f14cf67074fc792fbac2>`__. -The standard ``linux-yocto`` kernel source tree already has a workaround -for the same issue. - -For further details, see https://gcc.gnu.org/gcc-5/changes.html -and the porting guide at -https://gcc.gnu.org/gcc-5/porting_to.html. - -Alternatively, you can switch back to GCC 4.9 or 4.8 by setting -``GCCVERSION`` in your configuration, as follows: -:: - - GCCVERSION = "4.9%" - -.. _migration-2.0-Gstreamer-0.10-removed: - -Gstreamer 0.10 Removed ----------------------- - -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 ``meta-multimedia``. This change results in Qt4 having Phonon -and Gstreamer support in QtWebkit disabled by default. - -.. _migration-2.0-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been moved or removed: - -- ``bluez4``: The recipe is obsolete and has been moved due to - ``bluez5`` becoming fully integrated. The ``bluez4`` recipe now - resides in ``meta-oe``. - -- ``gamin``: The recipe is obsolete and has been removed. - -- ``gnome-icon-theme``: The recipe's functionally has been replaced by - ``adwaita-icon-theme``. - -- Gstreamer 0.10 Recipes: Recipes for Gstreamer 0.10 have been removed - in favor of the recipes for Gstreamer 1.x. - -- ``insserv``: The recipe is obsolete and has been removed. - -- ``libunique``: The recipe is no longer used and has been moved to - ``meta-oe``. - -- ``midori``: The recipe's functionally has been replaced by - ``epiphany``. - -- ``python-gst``: The recipe is obsolete and has been removed since it - only contains bindings for Gstreamer 0.10. - -- ``qt-mobility``: The recipe is obsolete and has been removed since it - requires ``Gstreamer 0.10``, which has been replaced. - -- ``subversion``: All 1.6.x versions of this recipe have been removed. - -- ``webkit-gtk``: The older 1.8.3 version of this recipe has been - removed in favor of ``webkitgtk``. - -.. _migration-2.0-bitbake-datastore-improvements: - -BitBake datastore improvements ------------------------------- - -The method by which BitBake's datastore handles overrides has changed. -Overrides are now applied dynamically and ``bb.data.update_data()`` is -now a no-op. Thus, ``bb.data.update_data()`` 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: - -- All potential overrides are now visible in the variable history as - seen when you run the following: - :: - - $ bitbake -e - -- ``d.delVar('VARNAME')`` and - ``d.setVar('VARNAME', None)`` result in the variable and all - of its overrides being cleared out. Before the change, only the - non-overridden values were cleared. - -.. _migration-2.0-shell-message-function-changes: - -Shell Message Function Changes ------------------------------- - -The shell versions of the BitBake message functions (i.e. ``bbdebug``, -``bbnote``, ``bbwarn``, ``bbplain``, ``bberror``, and ``bbfatal``) are -now connected through to their BitBake equivalents ``bb.debug()``, -``bb.note()``, ``bb.warn()``, ``bb.plain()``, ``bb.error()``, and -``bb.fatal()``, 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: - -- 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 ``bbwarn``, ``bberror``, and so forth. Or, you might want to - simply remove the calls. - -- The ``bbfatal`` message function now suppresses the full error log in - the UI, which means any calls to ``bbfatal`` where you still wish to - see the full error log should be replaced by ``die`` or - ``bbfatal_log``. - -.. _migration-2.0-extra-development-debug-package-cleanup: - -Extra Development/Debug Package Cleanup ---------------------------------------- - -The following recipes have had extra ``dev/dbg`` packages removed: - -- ``acl`` - -- ``apmd`` - -- ``aspell`` - -- ``attr`` - -- ``augeas`` - -- ``bzip2`` - -- ``cogl`` - -- ``curl`` - -- ``elfutils`` - -- ``gcc-target`` - -- ``libgcc`` - -- ``libtool`` - -- ``libxmu`` - -- ``opkg`` - -- ``pciutils`` - -- ``rpm`` - -- ``sysfsutils`` - -- ``tiff`` - -- ``xz`` - -All of the above recipes now conform to the standard packaging scheme -where a single ``-dev``, ``-dbg``, and ``-staticdev`` package exists per -recipe. - -.. _migration-2.0-recipe-maintenance-tracking-data-moved-to-oe-core: - -Recipe Maintenance Tracking Data Moved to OE-Core -------------------------------------------------- - -Maintenance tracking data for recipes that was previously part of -``meta-yocto`` has been moved to :term:`OpenEmbedded-Core (OE-Core)`. The change -includes ``package_regex.inc`` and ``distro_alias.inc``, which are -typically enabled when using the ``distrodata`` class. Additionally, the -contents of ``upstream_tracking.inc`` has now been split out to the -relevant recipes. - -.. _migration-2.0-automatic-stale-sysroot-file-cleanup: - -Automatic Stale Sysroot File Cleanup ------------------------------------- - -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 -``bblayers.conf``, and :term:`DISTRO_FEATURES` -changes. - -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: -:: - - SSTATE_PRUNE_OBSOLETEWORKDIR = "0" - -.. _migration-2.0-linux-yocto-kernel-metadata-repository-now-split-from-source: - -``linux-yocto`` Kernel Metadata Repository Now Split from Source ----------------------------------------------------------------- - -The ``linux-yocto`` 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. - -Metadata processing has now been removed from the -:ref:`kernel-yocto <ref-classes-kernel-yocto>` class and the external -Metadata repository ``yocto-kernel-cache``, which has always been used -to seed the ``linux-yocto`` "meta" branch. This separate ``linux-yocto`` -cache repository is now the primary location for this data. Due to this -change, ``linux-yocto`` 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 -``meta/recipes-kernel/linux/linux-yocto_4.1.bb`` recipe for an example. - -.. _migration-2.0-additional-qa-checks: - -Additional QA checks --------------------- - -The following QA checks have been added: - -- Added a "host-user-contaminated" check for ownership issues for - packaged files outside of ``/home``. 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. - -- Added an "invalid-chars" check for invalid (non-UTF8) characters in - recipe metadata variable values (i.e. - :term:`DESCRIPTION`, - :term:`SUMMARY`, :term:`LICENSE`, and - :term:`SECTION`). Some package managers do not support - these characters. - -- Added an "invalid-packageconfig" check for any options specified in - :term:`PACKAGECONFIG` that do not match any - ``PACKAGECONFIG`` option defined for the recipe. - -.. _migration-2.0-miscellaneous: - -Miscellaneous Changes ---------------------- - -These additional changes exist: - -- ``gtk-update-icon-cache`` has been renamed to ``gtk-icon-utils``. - -- The ``tools-profile`` :term:`IMAGE_FEATURES` - item as well as its corresponding packagegroup and - ``packagegroup-core-tools-profile`` no longer bring in ``oprofile``. - Bringing in ``oprofile`` 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. - -- The :term:`IMAGE_FSTYPES` variable's default - value now specifies ``ext4`` instead of ``ext3``. - -- All support for the ``PRINC`` variable has been removed. - -- The ``packagegroup-core-full-cmdline`` packagegroup no longer brings - in ``lighttpd`` due to the fact that bringing in ``lighttpd`` 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 - ``busybox``. - - diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst deleted file mode 100644 index 1eb9ab5525..0000000000 --- a/documentation/ref-manual/migration-2.1.rst +++ /dev/null @@ -1,435 +0,0 @@ -Moving to the Yocto Project 2.1 Release (krogoth) -================================================= - -This section provides migration information for moving to the Yocto -Project 2.1 Release (codename "krogoth") from the prior release. - -.. _migration-2.1-variable-expansion-in-python-functions: - -Variable Expansion in Python Functions --------------------------------------- - -Variable expressions, such as ``${VARNAME}`` 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 -``d.getVar()``. To alternatively expand more complex expressions, use -``d.expand()``. - -.. _migration-2.1-overrides-must-now-be-lower-case: - -Overrides Must Now be Lower-Case --------------------------------- - -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 :term:`OVERRIDES` must now -appear in lower-case characters (e.g. values for ``MACHINE``, -``TARGET_ARCH``, ``DISTRO``, and also recipe names if -``_pn-``\ recipename overrides are to be effective). - -.. _migration-2.1-expand-parameter-to-getvar-and-getvarflag-now-mandatory: - -Expand Parameter to ``getVar()`` and ``getVarFlag()`` is Now Mandatory ----------------------------------------------------------------------- - -The expand parameter to ``getVar()`` and ``getVarFlag()`` previously -defaulted to False if not specified. Now, however, no default exists so -one must be specified. You must change any ``getVar()`` calls that do -not specify the final expand parameter to calls that do specify the -parameter. You can run the following ``sed`` command at the base of a -layer to make this change: -:: - - sed -e 's:\(\.getVar([^,()]*\)):\1, False):g' -i `grep -ril getVar *` - sed -e 's:\(\.getVarFlag([^,()]*,[^,()]*\)):\1, False):g' -i `grep -ril getVarFlag *` - -.. 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. - -.. _migration-2.1-makefile-environment-changes: - -Makefile Environment Changes ----------------------------- - -:term:`EXTRA_OEMAKE` now defaults to "" instead of -"-e MAKEFLAGS=". Setting ``EXTRA_OEMAKE`` to "-e MAKEFLAGS=" by default -was a historical accident that has required many classes (e.g. -``autotools``, ``module``) 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 -``EXTRA_OEMAKE`` back to "-e MAKEFLAGS=" or by explicitly setting any -required variable value overrides using ``EXTRA_OEMAKE``, 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. - -.. _migration-2.1-libexecdir-reverted-to-prefix-libexec: - -``libexecdir`` Reverted to ``${prefix}/libexec`` ------------------------------------------------- - -The use of ``${libdir}/${BPN}`` as ``libexecdir`` is different as -compared to all other mainstream distributions, which either uses -``${prefix}/libexec`` or ``${libdir}``. The use is also contrary to the -GNU Coding Standards (i.e. -https://www.gnu.org/prep/standards/html_node/Directory-Variables.html) -that suggest ``${prefix}/libexec`` and also notes that any -package-specific nesting should be done by the package itself. Finally, -having ``libexecdir`` change between recipes makes it very difficult for -different recipes to invoke binaries that have been installed into -``libexecdir``. The Filesystem Hierarchy Standard (i.e. -https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch04s07.html) now -recognizes the use of ``${prefix}/libexec/``, giving distributions the -choice between ``${prefix}/lib`` or ``${prefix}/libexec`` without -breaking FHS. - -.. _migration-2.1-ac-cv-sizeof-off-t-no-longer-cached-in-site-files: - -``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files --------------------------------------------------------- - -For recipes inheriting the :ref:`autotools <ref-classes-autotools>` -class, ``ac_cv_sizeof_off_t`` is no longer cached in the site files for -``autoconf``. The reason for this change is because the -``ac_cv_sizeof_off_t`` 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 ``autoconf``, -this change should not be a problem. However, if you have a recipe that -bypasses the standard :ref:`ref-tasks-configure` task -from the ``autotools`` class and the software the recipe is building -uses a very old version of ``autoconf``, the recipe might be incapable -of determining the correct size of ``off_t`` during ``do_configure``. - -The best course of action is to patch the software as necessary to allow -the default implementation from the ``autotools`` class to work such -that ``autoreconf`` succeeds and produces a working configure script, -and to remove the overridden ``do_configure`` task such that the default -implementation does get used. - -.. _migration-2.1-image-generation-split-out-from-filesystem-generation: - -Image Generation is Now Split Out from Filesystem Generation ------------------------------------------------------------- - -Previously, for image recipes the :ref:`ref-tasks-rootfs` -task assembled the filesystem and then from that filesystem generated -images. With this Yocto Project release, image generation is split into -separate :ref:`ref-tasks-image` tasks for clarity both in -operation and in the code. - -For most cases, this change does not present any problems. However, if -you have made customizations that directly modify the ``do_rootfs`` task -or that mention ``do_rootfs``, you might need to update those changes. -In particular, if you had added any tasks after ``do_rootfs``, you -should make edits so that those tasks are after the -:ref:`ref-tasks-image-complete` task rather than -after ``do_rootfs`` so that your added tasks run at the correct -time. - -A minor part of this restructuring is that the post-processing -definitions and functions have been moved from the -:ref:`image <ref-classes-image>` class to the -:ref:`rootfs-postcommands <ref-classes-rootfs*>` class. Functionally, -however, they remain unchanged. - -.. _migration-2.1-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed in the 2.1 release: - -- ``gcc`` version 4.8: Versions 4.9 and 5.3 remain. - -- ``qt4``: All support for Qt 4.x has been moved out to a separate - ``meta-qt4`` layer because Qt 4 is no longer supported upstream. - -- ``x11vnc``: Moved to the ``meta-oe`` layer. - -- ``linux-yocto-3.14``: No longer supported. - -- ``linux-yocto-3.19``: No longer supported. - -- ``libjpeg``: Replaced by the ``libjpeg-turbo`` recipe. - -- ``pth``: Became obsolete. - -- ``liboil``: Recipe is no longer needed and has been moved to the - ``meta-multimedia`` layer. - -- ``gtk-theme-torturer``: Recipe is no longer needed and has been moved - to the ``meta-gnome`` layer. - -- ``gnome-mime-data``: Recipe is no longer needed and has been moved to - the ``meta-gnome`` layer. - -- ``udev``: Replaced by the ``eudev`` recipe for compatibility when - using ``sysvinit`` with newer kernels. - -- ``python-pygtk``: Recipe became obsolete. - -- ``adt-installer``: Recipe became obsolete. See the - ":ref:`ref-manual/migration-2.1:adt removed`" section for more information. - -.. _migration-2.1-class-changes: - -Class Changes -------------- - -The following classes have changed: - -- ``autotools_stage``: Removed because the - :ref:`autotools <ref-classes-autotools>` class now provides its - functionality. Recipes that inherited from ``autotools_stage`` should - now inherit from ``autotools`` instead. - -- ``boot-directdisk``: Merged into the ``image-vm`` class. The - ``boot-directdisk`` class was rarely directly used. Consequently, - this change should not cause any issues. - -- ``bootimg``: Merged into the - :ref:`image-live <ref-classes-image-live>` class. The ``bootimg`` - class was rarely directly used. Consequently, this change should not - cause any issues. - -- ``packageinfo``: Removed due to its limited use by the Hob UI, which - has itself been removed. - -.. _migration-2.1-build-system-ui-changes: - -Build System User Interface Changes ------------------------------------ - -The following changes have been made to the build system user interface: - -- *Hob GTK+-based UI*: 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 - ":ref:`toaster-manual/setup-and-use:using the toaster web interface`" - section in the Toaster User Manual for more information on this - interface. - -- *"puccho" BitBake UI*: Removed because is unmaintained and no longer - useful. - -.. _migration-2.1-adt-removed: - -ADT Removed ------------ - -The Application Development Toolkit (ADT) has been removed because its -functionality almost completely overlapped with the :ref:`standard -SDK <sdk-manual/using:using the standard sdk>` and the -:ref:`extensible SDK <sdk-manual/extensible:using the extensible sdk>`. For -information on these SDKs and how to build and use them, see the -:doc:`/sdk-manual/index` manual. - -.. note:: - - The Yocto Project Eclipse IDE Plug-in is still supported and is not - affected by this change. - -.. _migration-2.1-poky-reference-distribution-changes: - -Poky Reference Distribution Changes ------------------------------------ - -The following changes have been made for the Poky distribution: - -- The ``meta-yocto`` layer has been renamed to ``meta-poky`` to better - match its purpose, which is to provide the Poky reference - distribution. The ``meta-yocto-bsp`` layer retains its original name - since it provides reference machines for the Yocto Project and it is - otherwise unrelated to Poky. References to ``meta-yocto`` in your - ``conf/bblayers.conf`` should automatically be updated, so you should - not need to change anything unless you are relying on this naming - elsewhere. - -- The :ref:`uninative <ref-classes-uninative>` 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. - - The ``uninative`` class is enabled through the - ``meta/conf/distro/include/yocto-uninative.inc`` file, which for - those not using the Poky distribution, can include to easily enable - the same functionality. - - Alternatively, if you wish to build your own ``uninative`` tarball, - you can do so by building the ``uninative-tarball`` recipe, making it - available to your build machines (e.g. over HTTP/HTTPS) and setting a - similar configuration as the one set by ``yocto-uninative.inc``. - -- 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. - - Disabling this library generation is accomplished through a - ``meta/conf/distro/include/no-static-libs.inc``, which for those not - using the Poky distribution can easily include to enable the same - functionality. - - 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: - :: - - DISABLE_STATIC = "" - -- The separate ``poky-tiny`` distribution now uses the musl C library - instead of a heavily pared down ``glibc``. Using musl results in a - smaller distribution and facilitates much greater maintainability - because musl is designed to have a small footprint. - - If you have used ``poky-tiny`` and have customized the ``glibc`` - configuration you will need to redo those customizations with musl - when upgrading to the new release. - -.. _migration-2.1-packaging-changes: - -Packaging Changes ------------------ - -The following changes have been made to packaging: - -- The ``runuser`` and ``mountpoint`` binaries, which were previously in - the main ``util-linux`` package, have been split out into the - ``util-linux-runuser`` and ``util-linux-mountpoint`` packages, - respectively. - -- The ``python-elementtree`` package has been merged into the - ``python-xml`` package. - -.. _migration-2.1-tuning-file-changes: - -Tuning File Changes -------------------- - -The following changes have been made to the tuning files: - -- 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. - -- The ``tune-cortexm*.inc`` and ``tune-cortexr4.inc`` 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. - -.. _migration-2.1-supporting-gobject-introspection: - -Supporting GObject Introspection --------------------------------- - -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 -":ref:`dev-manual/common-tasks:enabling gobject introspection support`" -section in the Yocto Project Development Tasks Manual for more -information. - -.. _migration-2.1-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -These additional changes exist: - -- The minimum Git version has been increased to 1.8.3.1. If your host - distribution does not provide a sufficiently recent version, you can - install the buildtools, which will provide it. See the - :ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` - section for more information on the buildtools tarball. - -- The buggy and incomplete support for the RPM version 4 package - manager has been removed. The well-tested and maintained support for - RPM version 5 remains. - -- Previously, the following list of packages were removed if - package-management was not in - :term:`IMAGE_FEATURES`, regardless of any - dependencies: - :: - - update-rc.d - base-passwd - shadow - update-alternatives - run-postinsts - - With the Yocto Project 2.1 release, these packages are - only removed if "read-only-rootfs" is in ``IMAGE_FEATURES``, 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). - -- The - :ref:`devtool modify <sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component>` - 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 - ``devtool modify``. - -- 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. - -- The ``.debug`` 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 - ``FILES_${PN}-dbg`` to pick up the resulting ``.debug`` directories - as these directories are automatically found and added. - -- Inaccurate disk and CPU percentage data has been dropped from - ``buildstats`` output. This data has been replaced with - ``getrusage()`` data and corrected IO statistics. You will probably - need to update any custom code that reads the ``buildstats`` data. - -- The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. - The contents of this file have been moved to individual recipes. - - .. note:: - - 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. - -- The ``v86d/uvesafb`` has been removed from the ``genericx86`` and - ``genericx86-64`` reference machines, which are provided by the - ``meta-yocto-bsp`` 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 ``uvesafb``, you can simply add ``v86d`` to - your image. - -- 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 - ``IMAGE_GEN_DEBUGFS`` to "1", which will generate a companion debug - image containing unstripped binaries and associated debug sources - alongside the image. - - diff --git a/documentation/ref-manual/migration-2.2.rst b/documentation/ref-manual/migration-2.2.rst deleted file mode 100644 index 198181a469..0000000000 --- a/documentation/ref-manual/migration-2.2.rst +++ /dev/null @@ -1,450 +0,0 @@ -Moving to the Yocto Project 2.2 Release (morty) -=============================================== - -This section provides migration information for moving to the Yocto -Project 2.2 Release (codename "morty") from the prior release. - -.. _migration-2.2-minimum-kernel-version: - -Minimum Kernel Version ----------------------- - -The minimum kernel version for the target system and for SDK is now -3.2.0, due to the upgrade to ``glibc 2.24``. 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 :term:`OLDEST_KERNEL` - to anything down to 2.6.32 if desired. - -.. _migration-2.2-staging-directories-in-sysroot-simplified: - -Staging Directories in Sysroot Has Been Simplified --------------------------------------------------- - -The way directories are staged in sysroot has been simplified and -introduces the new :term:`SYSROOT_DIRS`, -:term:`SYSROOT_DIRS_NATIVE`, and -:term:`SYSROOT_DIRS_BLACKLIST`. See the -:oe_lists:`v2 patch series on the OE-Core Mailing List -</pipermail/openembedded-core/2016-May/121365.html>` -for additional information. - -.. _migration-2.2-removal-of-old-images-from-tmp-deploy-now-enabled: - -Removal of Old Images and Other Files in ``tmp/deploy`` Now Enabled -------------------------------------------------------------------- - -Removal of old images and other files in ``tmp/deploy/`` is now enabled -by default due to a new staging method used for those files. As a result -of this change, the ``RM_OLD_IMAGE`` variable is now redundant. - -.. _migration-2.2-python-changes: - -Python Changes --------------- - -The following changes for Python occurred: - -.. _migration-2.2-bitbake-now-requires-python-3.4: - -BitBake Now Requires Python 3.4+ -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -BitBake requires Python 3.4 or greater. - -.. _migration-2.2-utf-8-locale-required-on-build-host: - -UTF-8 Locale Required on Build Host -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -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. - -.. _migration-2.2-metadata-now-must-use-python-3-syntax: - -Metadata Must Now Use Python 3 Syntax -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -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 :term:`OpenEmbedded-Core (OE-Core)` as a guide for changes. Following are -particular areas of interest: - - - subprocess command-line pipes needing locale decoding - - - the syntax for octal values changed - - - the ``iter*()`` functions changed name - - - iterators now return views, not lists - - - changed names for Python modules - -.. _migration-2.2-target-python-recipes-switched-to-python-3: - -Target Python Recipes Switched to Python 3 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -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. - -.. _migration-2.2-buildtools-tarball-includes-python-3: - -``buildtools-tarball`` Includes Python 3 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -``buildtools-tarball`` now includes Python 3. - -.. _migration-2.2-uclibc-replaced-by-musl: - -uClibc Replaced by musl ------------------------ - -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. - -.. _migration-2.2-B-no-longer-default-working-directory-for-tasks: - -``${B}`` No Longer Default Working Directory for Tasks ------------------------------------------------------- - -``${``\ :term:`B`\ ``}`` is no longer the default working -directory for tasks. Consequently, any custom tasks you define now need -to either have the -``[``\ :ref:`dirs <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` flag -set, or the task needs to change into the appropriate working directory -manually (e.g using ``cd`` for a shell task). - -.. note:: - - The preferred method is to use the - [dirs] - flag. - -.. _migration-2.2-runqemu-ported-to-python: - -``runqemu`` Ported to Python ----------------------------- - -``runqemu`` has been ported to Python and has changed behavior in some -cases. Previous usage patterns continue to be supported. - -The new ``runqemu`` is a Python script. Machine knowledge is no longer -hardcoded into ``runqemu``. You can choose to use the ``qemuboot`` -configuration file to define the BSP's own arguments and to make it -bootable with ``runqemu``. If you use a configuration file, use the -following form: -:: - - image-name-machine.qemuboot.conf - -The configuration file -enables fine-grained tuning of options passed to QEMU without the -``runqemu`` 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 ``qemu*`` machines in -:term:`OpenEmbedded-Core (OE-Core)`. The ``qemuboot.conf`` file is generated by the -``qemuboot`` 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 ``qemuboot`` class will save them to ``qemuboot.conf``. - -If you want to use ``runqemu`` without a configuration file, use the -following command form: -:: - - $ runqemu machine rootfs kernel [options] - -Supported machines are as follows: - - - qemuarm - - qemuarm64 - - qemux86 - - qemux86-64 - - qemuppc - - qemumips - - qemumips64 - - qemumipsel - - qemumips64el - -Consider the -following example, which uses the ``qemux86-64`` machine, provides a -root filesystem, provides an image, and uses the ``nographic`` option: :: - - $ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic - -Following is a list of variables that can be set in configuration files -such as ``bsp.conf`` to enable the BSP to be booted by ``runqemu``: - -.. note:: - - "QB" means "QEMU Boot". - -:: - - 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. - -To use ``runqemu``, set :term:`IMAGE_CLASSES` as -follows and run ``runqemu``: - -.. note:: - - For command-line syntax, use ``runqemu help``. - -:: - - IMAGE_CLASSES += "qemuboot" - -.. _migration-2.2-default-linker-hash-style-changed: - -Default Linker Hash Style Changed ---------------------------------- - -The default linker hash style for ``gcc-cross`` is now "sysv" in order -to catch recipes that are building software without using the -OpenEmbedded :term:`LDFLAGS`. 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 -``LDFLAGS``. 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: -:: - - TARGET_CC_ARCH += "${LDFLAGS}" - -.. _migration-2.2-kernel-image-base-name-no-longer-uses-kernel-imagetype: - -``KERNEL_IMAGE_BASE_NAME`` no Longer Uses ``KERNEL_IMAGETYPE`` --------------------------------------------------------------- - -The ``KERNEL_IMAGE_BASE_NAME`` variable no longer uses the -:term:`KERNEL_IMAGETYPE` 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: -:: - - KERNEL_IMAGE_BASE_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}-${DATETIME}" - -If you have recipes or -classes that use ``KERNEL_IMAGE_BASE_NAME`` directly, you might need to -update the references to ensure they continue to work. - -.. _migration-2.2-bitbake-changes: - -BitBake Changes ---------------- - -The following changes took place for BitBake: - -- The "goggle" UI and standalone image-writer tool have been removed as - they both require GTK+ 2.0 and were not being maintained. - -- The Perforce fetcher now supports :term:`SRCREV` for - specifying the source revision to use, be it - ``${``\ :term:`AUTOREV`\ ``}``, changelist number, - p4date, or label, in preference to separate - :term:`SRC_URI` 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 ``SRCREV`` in place of specifying the source revision - within ``SRC_URI``. - -- 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: - :yocto_git:`1 </poky/commit/?id=189371f8393971d00bca0fceffd67cc07784f6ee>` - and - :yocto_git:`2 </poky/commit/?id=4a5aa7ea4d07c2c90a1654b174873abb018acc67>`. - -- 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 - ``BB_SETSCENE_VERIFY_FUNCTION`` needed to change signature. - Consequently, a new variable named ``BB_SETSCENE_VERIFY_FUNCTION2`` - 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. - -.. _migration-2.2-swabber-has-been-removed: - -Swabber has Been Removed ------------------------- - -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. - -.. _migration-2.2-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed: - -- ``augeas``: No longer needed and has been moved to ``meta-oe``. - -- ``directfb``: Unmaintained and has been moved to ``meta-oe``. - -- ``gcc``: Removed 4.9 version. Versions 5.4 and 6.2 are still present. - -- ``gnome-doc-utils``: No longer needed. - -- ``gtk-doc-stub``: Replaced by ``gtk-doc``. - -- ``gtk-engines``: No longer needed and has been moved to - ``meta-gnome``. - -- ``gtk-sato-engine``: Became obsolete. - -- ``libglade``: No longer needed and has been moved to ``meta-oe``. - -- ``libmad``: Unmaintained and functionally replaced by ``libmpg123``. - ``libmad`` has been moved to ``meta-oe``. - -- ``libowl``: Became obsolete. - -- ``libxsettings-client``: No longer needed. - -- ``oh-puzzles``: Functionally replaced by ``puzzles``. - -- ``oprofileui``: Became obsolete. OProfile has been largely supplanted - by perf. - -- ``packagegroup-core-directfb.bb``: Removed. - -- ``core-image-directfb.bb``: Removed. - -- ``pointercal``: No longer needed and has been moved to ``meta-oe``. - -- ``python-imaging``: No longer needed and moved to ``meta-python`` - -- ``python-pyrex``: No longer needed and moved to ``meta-python``. - -- ``sato-icon-theme``: Became obsolete. - -- ``swabber-native``: Swabber has been removed. See the :ref:`entry on - Swabber <ref-manual/migration-2.2:swabber has been removed>`. - -- ``tslib``: No longer needed and has been moved to ``meta-oe``. - -- ``uclibc``: Removed in favor of musl. - -- ``xtscal``: No longer needed and moved to ``meta-oe`` - -.. _migration-2.2-removed-classes: - -Removed Classes ---------------- - -The following classes have been removed: - -- ``distutils-native-base``: No longer needed. - -- ``distutils3-native-base``: No longer needed. - -- ``sdl``: Only set :term:`DEPENDS` and - :term:`SECTION`, which are better set within the - recipe instead. - -- ``sip``: Mostly unused. - -- ``swabber``: See the :ref:`entry on - Swabber <ref-manual/migration-2.2:swabber has been removed>`. - -.. _migration-2.2-minor-packaging-changes: - -Minor Packaging Changes ------------------------ - -The following minor packaging changes have occurred: - -- ``grub``: Split ``grub-editenv`` into its own package. - -- ``systemd``: Split container and vm related units into a new package, - systemd-container. - -- ``util-linux``: Moved ``prlimit`` to a separate - ``util-linux-prlimit`` package. - -.. _migration-2.2-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -The following miscellaneous changes have occurred: - -- ``package_regex.inc``: Removed because the definitions - ``package_regex.inc`` previously contained have been moved to their - respective recipes. - -- Both ``devtool add`` and ``recipetool create`` now use a fixed - :term:`SRCREV` by default when fetching from a Git - repository. You can override this in either case to use - ``${``\ :term:`AUTOREV`\ ``}`` instead by using the - ``-a`` or ``DASHDASHautorev`` command-line option - -- ``distcc``: GTK+ UI is now disabled by default. - -- ``packagegroup-core-tools-testapps``: Removed Piglit. - -- ``image.bbclass``: Renamed COMPRESS(ION) to CONVERSION. This change - means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and - ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``, - ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*`` - 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 ``COMPRESS*`` ones will be removed in a future - release. - -- ``gtk-doc``: A full version of ``gtk-doc`` is now made available. - However, some old software might not be capable of using the current - version of ``gtk-doc`` to build documentation. You need to change - recipes that build such software so that they explicitly disable - building documentation with ``gtk-doc``. - - diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst deleted file mode 100644 index 0541eb3e74..0000000000 --- a/documentation/ref-manual/migration-2.3.rst +++ /dev/null @@ -1,523 +0,0 @@ -Moving to the Yocto Project 2.3 Release (pyro) -============================================== - -This section provides migration information for moving to the Yocto -Project 2.3 Release (codename "pyro") from the prior release. - -.. _migration-2.3-recipe-specific-sysroots: - -Recipe-specific Sysroots ------------------------- - -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. - -Consider the following: - -- *Declare Build-Time Dependencies:* 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. - -- *Specify Pre-Installation and Post-Installation Native Tool - Dependencies:* You must specifically specify any special native tool - dependencies of ``pkg_preinst`` and ``pkg_postinst`` scripts by using - the :term:`PACKAGE_WRITE_DEPS` variable. - Specifying these dependencies ensures that these tools are available - if these scripts need to be run on the build host during the - :ref:`ref-tasks-rootfs` task. - - As an example, see the ``dbus`` recipe. You will see that this recipe - has a ``pkg_postinst`` that calls ``systemctl`` if "systemd" is in - :term:`DISTRO_FEATURES`. In the example, - ``systemd-systemctl-native`` is added to ``PACKAGE_WRITE_DEPS``, - which is also conditional on "systemd" being in ``DISTRO_FEATURES``. - -- Examine Recipes that Use ``SSTATEPOSTINSTFUNCS``: You need to - examine any recipe that uses ``SSTATEPOSTINSTFUNCS`` and determine - steps to take. - - Functions added to ``SSTATEPOSTINSTFUNCS`` 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 ``SSTATEPOSTINSTFUNCS`` are doing - relocation, then you will need to change these to use a - post-installation script that is installed by a function added to - :term:`SYSROOT_PREPROCESS_FUNCS`. - - For an example, see the ``pixbufcache`` class in ``meta/classes/`` in - the :ref:`overview-manual/development-environment:yocto project source repositories`. - - .. note:: - - The - SSTATEPOSTINSTFUNCS - variable itself is now deprecated in favor of the - do_populate_sysroot[postfuncs] - 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 - SSTATEPOSTINSTFUNCS - is removed in a future Yocto Project release. - -- *Specify the Sysroot when Using Certain External Scripts:* Because - the shared sysroot is now gone, the scripts - ``oe-find-native-sysroot`` and ``oe-run-native`` have been changed - such that you need to specify which recipe's - :term:`STAGING_DIR_NATIVE` is used. - -.. note:: - - You can find more information on how recipe-specific sysroots work in - the ":ref:`ref-classes-staging`" section. - -.. _migration-2.3-path-variable: - -``PATH`` Variable ------------------ - -Within the environment used to run build tasks, the environment variable -``PATH`` is now sanitized such that the normal native binary paths -(``/bin``, ``/sbin``, ``/usr/bin`` and so forth) are removed and a -directory containing symbolic links linking only to the binaries from -the host mentioned in the :term:`HOSTTOOLS` and -:term:`HOSTTOOLS_NONFATAL` variables is added -to ``PATH``. - -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. - -Alternatively, you can add a native recipe (i.e. ``-native``) that -provides the binary to the recipe's :term:`DEPENDS` -value. - -.. note:: - - PATH - is not sanitized in the same way within ``devshell``. - If it were, you would have difficulty running host tools for - development and debugging within the shell. - -.. _migration-2.3-scripts: - -Changes to Scripts ------------------- - -The following changes to scripts took place: - -- ``oe-find-native-sysroot``: The usage for the - ``oe-find-native-sysroot`` script has changed to the following: - :: - - $ . oe-find-native-sysroot recipe - - You must now supply a recipe for recipe - as part of the command. Prior to the Yocto Project 2.3 release, it - was not necessary to provide the script with the command. - -- ``oe-run-native``: The usage for the ``oe-run-native`` script has - changed to the following: - :: - - $ oe-run-native native_recipe tool - - 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 2.3 release, it - was not necessary to provide the native recipe with the command. - -- ``cleanup-workdir``: The ``cleanup-workdir`` 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 :term:`TMPDIR` and getting it wrong, - it is recommended that you delete ``TMPDIR`` and have it restored - from shared state (sstate) on subsequent builds. - -- ``wipe-sysroot``: The ``wipe-sysroot`` script has been removed as - it is no longer needed with recipe-specific sysroots. - -.. _migration-2.3-functions: - -Changes to Functions --------------------- - -The previously deprecated ``bb.data.getVar()``, ``bb.data.setVar()``, -and related functions have been removed in favor of ``d.getVar()``, -``d.setVar()``, and so forth. - -You need to fix any references to these old functions. - -.. _migration-2.3-bitbake-changes: - -BitBake Changes ---------------- - -The following changes took place for BitBake: - -- *BitBake's Graphical Dependency Explorer UI Replaced:* BitBake's - graphical dependency explorer UI ``depexp`` was replaced by - ``taskexp`` ("Task Explorer"), which provides a graphical way of - exploring the ``task-depends.dot`` file. The data presented by Task - Explorer is much more accurate than the data that was presented by - ``depexp``. Being able to visualize the data is an often requested - feature as standard ``*.dot`` file viewers cannot usual cope with the - size of the ``task-depends.dot`` file. - -- *BitBake "-g" Output Changes:* The ``package-depends.dot`` and - ``pn-depends.dot`` files as previously generated using the - ``bitbake -g`` command have been removed. A ``recipe-depends.dot`` - file is now generated as a collapsed version of ``task-depends.dot`` - instead. - - The reason for this change is because ``package-depends.dot`` and - ``pn-depends.dot`` 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. - -- *Mirror Variable Splitting Changes:* Mirror variables including - :term:`MIRRORS`, :term:`PREMIRRORS`, - and :term:`SSTATE_MIRRORS` 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. - -- *The Subversion (SVN) Fetcher Uses an "ssh" Parameter and Not an - "rsh" Parameter:* 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 ``ssh`` program used by SVN. The SVN - fetcher passes the new parameter through the ``SVN_SSH`` environment - variable during the :ref:`ref-tasks-fetch` task. - - See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:subversion (svn) fetcher (\`\`svn://\`\`)`" - section in the BitBake - User Manual for additional information. - -- ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2`` - Removed: Because the mechanism they were part of is no longer - necessary with recipe-specific sysroots, the - ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2`` - variables have been removed. - -.. _migration-2.3-absolute-symlinks: - -Absolute Symbolic Links ------------------------ - -Absolute symbolic links (symlinks) within staged files are no longer -permitted and now trigger an error. Any explicit creation of symlinks -can use the ``lnr`` script, which is a replacement for ``ln -r``. - -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 ``relative_symlinks`` within the recipe to turn those -absolute symlinks into relative symlinks. - -.. _migration-2.3-gplv2-and-gplv3-moves: - -GPLv2 Versions of GPLv3 Recipes Moved -------------------------------------- - -Older GPLv2 versions of GPLv3 recipes have moved to a separate -``meta-gplv2`` layer. - -If you use :term:`INCOMPATIBLE_LICENSE` to -exclude GPLv3 or set :term:`PREFERRED_VERSION` -to substitute a GPLv2 version of a GPLv3 recipe, then you must add the -``meta-gplv2`` layer to your configuration. - -.. note:: - - You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at - :oe_layer:`/meta-gplv2`. - -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. - -.. _migration-2.3-package-management-changes: - -Package Management Changes --------------------------- - -The following package management changes took place: - -- 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. - - 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. - - For more information, see the `DNF - Documentation <https://dnf.readthedocs.io/en/latest/>`__. - -- Rpm 5.x is replaced with Rpm 4.x. This is done for two major reasons: - - - DNF is API-incompatible with Rpm 5.x and porting it and - maintaining the port is non-trivial. - - - Rpm 5.x itself has limited maintenance upstream, and the Yocto - Project is one of the very few remaining users. - -- Berkeley DB 6.x is removed and Berkeley DB 5.x becomes the default: - - - 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. - - - 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. - -- ``createrepo`` is replaced with ``createrepo_c``. - - ``createrepo_c`` is the current incarnation of the tool that - generates remote repository metadata. It is written in C as compared - to ``createrepo``, which is written in Python. ``createrepo_c`` is - faster and is maintained. - -- Architecture-independent RPM packages are "noarch" instead of "all". - - 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 :ref:`allarch.bbclass <ref-classes-allarch>` - class. - -- Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not - currently supported. This issue will be fully addressed in a future - Yocto Project release. See :yocto_bugs:`defect 11209 </show_bug.cgi?id=11209>` - for more information on a solution to package feed signing with RPM - in the Yocto Project 2.3 release. - -- 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 - :yocto_git:`commit message </poky/commit/?id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81>`. - -.. _migration-2.3-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed: - -- ``linux-yocto 4.8``: Version 4.8 has been removed. Versions 4.1 - (LTSI), 4.4 (LTS), 4.9 (LTS/LTSI) and 4.10 are now present. - -- ``python-smartpm``: Functionally replaced by ``dnf``. - -- ``createrepo``: Replaced by the ``createrepo-c`` recipe. - -- ``rpmresolve``: No longer needed with the move to RPM 4 as RPM - itself is used instead. - -- ``gstreamer``: Removed the GStreamer Git version recipes as they - have been stale. ``1.10.``\ x recipes are still present. - -- ``alsa-conf-base``: Merged into ``alsa-conf`` since ``libasound`` - depended on both. Essentially, no way existed to install only one of - these. - -- ``tremor``: Moved to ``meta-multimedia``. 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 - ``tremor`` recipe in :term:`OpenEmbedded-Core (OE-Core)`. - -- ``gummiboot``: Replaced by ``systemd-boot``. - -.. _migration-2.3-wic-changes: - -Wic Changes ------------ - -The following changes have been made to Wic: - -.. note:: - - For more information on Wic, see the - ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" - section in the Yocto Project Development Tasks Manual. - -- *Default Output Directory Changed:* Wic's default output directory is - now the current directory by default instead of the unusual - ``/var/tmp/wic``. - - 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. - -- *fsimage Plug-in Removed:* The Wic fsimage plugin has been removed as - it duplicates functionality of the rawcopy plugin. - -.. _migration-2.3-qa-changes: - -QA Changes ----------- - -The following QA checks have changed: - -- ``unsafe-references-in-binaries``: The - ``unsafe-references-in-binaries`` QA check, which was disabled by - default, has now been removed. This check was intended to detect - binaries in ``/bin`` that link to libraries in ``/usr/lib`` and have - the case where the user has ``/usr`` on a separate filesystem to - ``/``. - - The removed QA check was buggy. Additionally, ``/usr`` residing on a - separate partition from ``/`` is now a rare configuration. - Consequently, ``unsafe-references-in-binaries`` was removed. - -- ``file-rdeps``: The ``file-rdeps`` 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. - - For additional information, see the - :ref:`insane <ref-classes-insane>` class and the - ":ref:`ref-manual/qa-checks:errors and warnings`" section. - -.. _migration-2.3-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -The following miscellaneous changes have occurred: - -- In this release, a number of recipes have been changed to ignore the - ``largefile`` :term:`DISTRO_FEATURES` 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 - largefile - feature, which would make it unconditionally enabled everywhere. - -- If the :term:`DISTRO_VERSION` value contains - the value of the :term:`DATE` variable, which is the - default between Poky releases, the ``DATE`` value is explicitly - excluded from ``/etc/issue`` and ``/etc/issue.net``, which is - displayed at the login prompt, in order to avoid conflicts with - Multilib enabled. Regardless, the ``DATE`` value is inaccurate if the - ``base-files`` recipe is restored from shared state (sstate) rather - than rebuilt. - - If you need the build date recorded in ``/etc/issue*`` 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 - :term:`ROOTFS_POSTPROCESS_COMMAND`. - Doing so ensures the value is always up-to-date with the created - image. - -- Dropbear's ``init`` 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. - -- The :ref:`buildhistory <ref-classes-buildhistory>` class now - correctly uses tabs as separators between all columns in - ``installed-package-sizes.txt`` in order to aid import into other - tools. - -- The ``USE_LDCONFIG`` variable has been replaced with the "ldconfig" - ``DISTRO_FEATURES`` feature. Distributions that previously set: - :: - - USE_LDCONFIG = "0" - - should now instead use the following: - - :: - - DISTRO_FEATURES_BACKFILL_CONSIDERED_append = " ldconfig" - -- The default value of - :term:`COPYLEFT_LICENSE_INCLUDE` 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. - -- 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: - :: - - KERNEL_MODULE_PACKAGE_SUFFIX = "" - -- Removal of ``libtool`` ``*.la`` files is now enabled by default. The - ``*.la`` files are not actually needed on Linux and relocating them - is an unnecessary burden. - - If you need to preserve these ``.la`` files (e.g. in a custom - distribution), you must change - :term:`INHERIT_DISTRO` such that - "remove-libtool" is not included in the value. - -- 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 ``uninative`` shared state (sstate) package is built. See - the :ref:`uninative <ref-classes-uninative>` class for additional - information. - -- All native and nativesdk recipes now use a separate - ``DISTRO_FEATURES`` value instead of sharing the value used by - recipes for the target, in order to avoid unnecessary rebuilds. - - The ``DISTRO_FEATURES`` for ``native`` recipes is - :term:`DISTRO_FEATURES_NATIVE` added to - an intersection of ``DISTRO_FEATURES`` and - :term:`DISTRO_FEATURES_FILTER_NATIVE`. - - For nativesdk recipes, the corresponding variables are - :term:`DISTRO_FEATURES_NATIVESDK` - and - :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. - -- The ``FILESDIR`` variable, which was previously deprecated and rarely - used, has now been removed. You should change any recipes that set - ``FILESDIR`` to set :term:`FILESPATH` instead. - -- The ``MULTIMACH_HOST_SYS`` variable has been removed as it is no - longer needed with recipe-specific sysroots. - - diff --git a/documentation/ref-manual/migration-2.4.rst b/documentation/ref-manual/migration-2.4.rst deleted file mode 100644 index 2ba17e0ed5..0000000000 --- a/documentation/ref-manual/migration-2.4.rst +++ /dev/null @@ -1,327 +0,0 @@ -Moving to the Yocto Project 2.4 Release (rocko) -=============================================== - -This section provides migration information for moving to the Yocto -Project 2.4 Release (codename "rocko") from the prior release. - -.. _migration-2.4-memory-resident-mode: - -Memory Resident Mode --------------------- - -A persistent mode is now available in BitBake's default operation, -replacing its previous "memory resident mode" (i.e. -``oe-init-build-env-memres``). Now you only need to set -:term:`BB_SERVER_TIMEOUT` to a timeout (in -seconds) and BitBake's server stays resident for that amount of time -between invocations. The ``oe-init-build-env-memres`` script has been -removed since a separate environment setup script is no longer needed. - -.. _migration-2.4-packaging-changes: - -Packaging Changes ------------------ - -This section provides information about packaging changes that have -occurred: - -- ``python3`` Changes: - - - 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 ``python-core`` plus - one or more of the individual packages that are still produced. - - - ``python3``: The ``bz2.py``, ``lzma.py``, and - ``_compression.py`` scripts have been moved from the - ``python3-misc`` package to the ``python3-compression`` package. - -- ``binutils``: The ``libbfd`` library is now packaged in a separate - "libbfd" package. This packaging saves space when certain tools (e.g. - ``perf``) are installed. In such cases, the tools only need - ``libbfd`` rather than all the packages in ``binutils``. - -- ``util-linux`` Changes: - - - The ``su`` program is now packaged in a separate "util-linux-su" - package, which is only built when "pam" is listed in the - :term:`DISTRO_FEATURES` variable. - ``util-linux`` should not be installed unless it is needed because - ``su`` is normally provided through the shadow file format. The - main ``util-linux`` package has runtime dependencies (i.e. - :term:`RDEPENDS`) on the ``util-linux-su`` package - when "pam" is in ``DISTRO_FEATURES``. - - - The ``switch_root`` program is now packaged in a separate - "util-linux-switch-root" package for small initramfs images that - do not need the whole ``util-linux`` package or the busybox - binary, which are both much larger than ``switch_root``. The main - ``util-linux`` package has a recommended runtime dependency (i.e. - :term:`RRECOMMENDS`) on the - ``util-linux-switch-root`` package. - - - The ``ionice`` program is now packaged in a separate - "util-linux-ionice" package. The main ``util-linux`` package has a - recommended runtime dependency (i.e. ``RRECOMMENDS``) on the - ``util-linux-ionice`` package. - -- ``initscripts``: The ``sushell`` program is now packaged in a - separate "initscripts-sushell" package. This packaging change allows - systems to pull ``sushell`` in when ``selinux`` is enabled. The - change also eliminates needing to pull in the entire ``initscripts`` - package. The main ``initscripts`` package has a runtime dependency - (i.e. ``RDEPENDS``) on the ``sushell`` package when "selinux" is in - ``DISTRO_FEATURES``. - -- ``glib-2.0``: The ``glib-2.0`` package now has a recommended - runtime dependency (i.e. ``RRECOMMENDS``) on the ``shared-mime-info`` - package, since large portions of GIO are not useful without the MIME - database. You can remove the dependency by using the - :term:`BAD_RECOMMENDATIONS` variable if - ``shared-mime-info`` is too large and is not required. - -- *Go Standard Runtime:* The Go standard runtime has been split out - from the main ``go`` recipe into a separate ``go-runtime`` recipe. - -.. _migration-2.4-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed: - -- ``acpitests``: This recipe is not maintained. - -- ``autogen-native``: No longer required by Grub, oe-core, or - meta-oe. - -- ``bdwgc``: Nothing in OpenEmbedded-Core requires this recipe. It - has moved to meta-oe. - -- ``byacc``: This recipe was only needed by rpm 5.x and has moved to - meta-oe. - -- ``gcc (5.4)``: The 5.4 series dropped the recipe in favor of 6.3 / - 7.2. - -- ``gnome-common``: Deprecated upstream and no longer needed. - -- ``go-bootstrap-native``: Go 1.9 does its own bootstrapping so this - recipe has been removed. - -- ``guile``: This recipe was only needed by ``autogen-native`` and - ``remake``. The recipe is no longer needed by either of these - programs. - -- ``libclass-isa-perl``: This recipe was previously needed for LSB 4, - no longer needed. - -- ``libdumpvalue-perl``: This recipe was previously needed for LSB 4, - no longer needed. - -- ``libenv-perl``: This recipe was previously needed for LSB 4, no - longer needed. - -- ``libfile-checktree-perl``: This recipe was previously needed for - LSB 4, no longer needed. - -- ``libi18n-collate-perl``: This recipe was previously needed for LSB - 4, no longer needed. - -- ``libiconv``: This recipe was only needed for ``uclibc``, which was - removed in the previous release. ``glibc`` and ``musl`` have their - own implementations. ``meta-mingw`` still needs ``libiconv``, so it - has been moved to ``meta-mingw``. - -- ``libpng12``: This recipe was previously needed for LSB. The - current ``libpng`` is 1.6.x. - -- ``libpod-plainer-perl``: This recipe was previously needed for LSB - 4, no longer needed. - -- ``linux-yocto (4.1)``: This recipe was removed in favor of 4.4, - 4.9, 4.10 and 4.12. - -- ``mailx``: This recipe was previously only needed for LSB - compatibility, and upstream is defunct. - -- ``mesa (git version only)``: The git version recipe was stale with - respect to the release version. - -- ``ofono (git version only)``: The git version recipe was stale with - respect to the release version. - -- ``portmap``: This recipe is obsolete and is superseded by - ``rpcbind``. - -- ``python3-pygpgme``: This recipe is old and unmaintained. It was - previously required by ``dnf``, which has switched to official - ``gpgme`` Python bindings. - -- ``python-async``: This recipe has been removed in favor of the - Python 3 version. - -- ``python-gitdb``: This recipe has been removed in favor of the - Python 3 version. - -- ``python-git``: This recipe was removed in favor of the Python 3 - version. - -- ``python-mako``: This recipe was removed in favor of the Python 3 - version. - -- ``python-pexpect``: This recipe was removed in favor of the Python - 3 version. - -- ``python-ptyprocess``: This recipe was removed in favor of Python - the 3 version. - -- ``python-pycurl``: Nothing is using this recipe in - OpenEmbedded-Core (i.e. ``meta-oe``). - -- ``python-six``: This recipe was removed in favor of the Python 3 - version. - -- ``python-smmap``: This recipe was removed in favor of the Python 3 - version. - -- ``remake``: Using ``remake`` as the provider of ``virtual/make`` is - broken. Consequently, this recipe is not needed in OpenEmbedded-Core. - -.. _migration-2.4-kernel-device-tree-move: - -Kernel Device Tree Move ------------------------ - -Kernel Device Tree support is now easier to enable in a kernel recipe. -The Device Tree code has moved to a -:ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class. -Functionality is automatically enabled for any recipe that inherits the -:ref:`kernel <ref-classes-kernel>` class and sets the -:term:`KERNEL_DEVICETREE` variable. The -previous mechanism for doing this, -``meta/recipes-kernel/linux/linux-dtb.inc``, is still available to avoid -breakage, but triggers a deprecation warning. Future releases of the -Yocto Project will remove ``meta/recipes-kernel/linux/linux-dtb.inc``. -It is advisable to remove any ``require`` statements that request -``meta/recipes-kernel/linux/linux-dtb.inc`` from any custom kernel -recipes you might have. This will avoid breakage in post 2.4 releases. - -.. _migration-2.4-package-qa-changes: - -Package QA Changes ------------------- - -The following package QA changes took place: - -- The "unsafe-references-in-scripts" QA check has been removed. - -- If you refer to ``${COREBASE}/LICENSE`` within - :term:`LIC_FILES_CHKSUM` you receive a - warning because this file is a description of the license for - OE-Core. Use ``${COMMON_LICENSE_DIR}/MIT`` if your recipe is - MIT-licensed and you cannot use the preferred method of referring to - a file within the source tree. - -.. _migration-2.4-readme-changes: - -``README`` File Changes ------------------------ - -The following are changes to ``README`` files: - -- The main Poky ``README`` file has been moved to the ``meta-poky`` - layer and has been renamed ``README.poky``. A symlink has been - created so that references to the old location work. - -- The ``README.hardware`` file has been moved to ``meta-yocto-bsp``. A - symlink has been created so that references to the old location work. - -- A ``README.qemu`` file has been created with coverage of the - ``qemu*`` machines. - -.. _migration-2.4-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -The following are additional changes: - -- The ``ROOTFS_PKGMANAGE_BOOTSTRAP`` variable and any references to it - have been removed. You should remove this variable from any custom - recipes. - -- The ``meta-yocto`` directory has been removed. - - .. note:: - - In the Yocto Project 2.1 release - meta-yocto - was renamed to - meta-poky - and the - meta-yocto - subdirectory remained to avoid breaking existing configurations. - -- The ``maintainers.inc`` file, which tracks maintainers by listing a - primary person responsible for each recipe in OE-Core, has been moved - from ``meta-poky`` to OE-Core (i.e. from - ``meta-poky/conf/distro/include`` to ``meta/conf/distro/include``). - -- The :ref:`buildhistory <ref-classes-buildhistory>` 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 - :term:`BUILDHISTORY_COMMIT` = "1", which - is typical. Previously, the ``buildhistory`` 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 - ``git show`` or ``git diff`` commands. - -- The ``x86-base.inc`` file, which is included by all x86-based machine - configurations, now sets :term:`IMAGE_FSTYPES` - using ``?=`` to "live" rather than appending with ``+=``. This change - makes the default easier to override. - -- BitBake fires multiple "BuildStarted" events when multiconfig is - enabled (one per configuration). For more information, see the - ":ref:`Events <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:events>`" section in the BitBake User - Manual. - -- By default, the ``security_flags.inc`` file sets a - :term:`GCCPIE` variable with an option to enable - Position Independent Executables (PIE) within ``gcc``. Enabling PIE - in the GNU C Compiler (GCC), makes Return Oriented Programming (ROP) - attacks much more difficult to execute. - -- OE-Core now provides a ``bitbake-layers`` plugin that implements a - "create-layer" subcommand. The implementation of this subcommand has - resulted in the ``yocto-layer`` script being deprecated and will - likely be removed in the next Yocto Project release. - -- The ``vmdk``, ``vdi``, and ``qcow2`` image file types are now used in - conjunction with the "wic" image type through ``CONVERSION_CMD``. - Consequently, the equivalent image types are now ``wic.vmdk``, - ``wic.vdi``, and ``wic.qcow2``, respectively. - -- ``do_image_<type>[depends]`` has replaced ``IMAGE_DEPENDS_<type>``. - If you have your own classes that implement custom image types, then - you need to update them. - -- OpenSSL 1.1 has been introduced. However, the default is still 1.0.x - through the :term:`PREFERRED_VERSION` - variable. This preference is set is due to the remaining - compatibility issues with other software. The - :term:`PROVIDES` variable in the openssl 1.0 recipe - now includes "openssl10" as a marker that can be used in - :term:`DEPENDS` within recipes that build software - that still depend on OpenSSL 1.0. - -- 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. - - diff --git a/documentation/ref-manual/migration-2.5.rst b/documentation/ref-manual/migration-2.5.rst deleted file mode 100644 index 9ef4b55399..0000000000 --- a/documentation/ref-manual/migration-2.5.rst +++ /dev/null @@ -1,310 +0,0 @@ -Moving to the Yocto Project 2.5 Release (sumo) -============================================== - -This section provides migration information for moving to the Yocto -Project 2.5 Release (codename "sumo") from the prior release. - -.. _migration-2.5-packaging-changes: - -Packaging Changes ------------------ - -This section provides information about packaging changes that have -occurred: - -- ``bind-libs``: The libraries packaged by the bind recipe are in a - separate ``bind-libs`` package. - -- ``libfm-gtk``: The ``libfm`` GTK+ bindings are split into a - separate ``libfm-gtk`` package. - -- ``flex-libfl``: The flex recipe splits out libfl into a separate - ``flex-libfl`` package to avoid too many dependencies being pulled in - where only the library is needed. - -- ``grub-efi``: The ``grub-efi`` configuration is split into a - separate ``grub-bootconf`` recipe. However, the dependency - relationship from ``grub-efi`` 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 ``grub-efi`` recipe. - -- *armv7a Legacy Package Feed Support:* Legacy support is removed for - transitioning from ``armv7a`` to ``armv7a-vfp-neon`` in package - feeds, which was previously enabled by setting - ``PKGARCHCOMPAT_ARMV7A``. This transition occurred in 2011 and active - package feeds should by now be updated to the new naming. - -.. _migration-2.5-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed: - -- ``gcc``: The version 6.4 recipes are replaced by 7.x. - -- ``gst-player``: Renamed to ``gst-examples`` as per upstream. - -- ``hostap-utils``: This software package is obsolete. - -- ``latencytop``: This recipe is no longer maintained upstream. The - last release was in 2009. - -- ``libpfm4``: The only file that requires this recipe is - ``oprofile``, which has been removed. - -- ``linux-yocto``: The version 4.4, 4.9, and 4.10 recipes have been - removed. Versions 4.12, 4.14, and 4.15 remain. - -- ``man``: This recipe has been replaced by modern ``man-db`` - -- ``mkelfimage``: This tool has been removed in the upstream coreboot - project, and is no longer needed with the removal of the ELF image - type. - -- ``nativesdk-postinst-intercept``: This recipe is not maintained. - -- ``neon``: This software package is no longer maintained upstream - and is no longer needed by anything in OpenEmbedded-Core. - -- ``oprofile``: The functionality of this recipe is replaced by - ``perf`` and keeping compatibility on an ongoing basis with ``musl`` - is difficult. - -- ``pax``: This software package is obsolete. - -- ``stat``: This software package is not maintained upstream. - ``coreutils`` provides a modern stat binary. - -- ``zisofs-tools-native``: This recipe is no longer needed because - the compressed ISO image feature has been removed. - -.. _migration-2.5-scripts-and-tools-changes: - -Scripts and Tools Changes -------------------------- - -The following are changes to scripts and tools: - -- ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer``: The - ``yocto-bsp``, ``yocto-kernel``, and ``yocto-layer`` 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 - ``bitbake-layers create-layer`` command is a direct replacement for - ``yocto-layer``. See the documentation to create a BSP or kernel - recipe in the ":ref:`bsp-guide/bsp:bsp kernel recipe example`" section. - -- ``devtool finish``: ``devtool finish`` 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. - -- ``scripts/oe-setup-rpmrepo`` script: The functionality of - ``scripts/oe-setup-rpmrepo`` is replaced by - ``bitbake package-index``. - -- ``scripts/test-dependencies.sh`` script: The script is largely made - obsolete by the recipe-specific sysroots functionality introduced in - the previous release. - -.. _migration-2.5-bitbake-changes: - -BitBake Changes ---------------- - -The following are BitBake changes: - -- The ``--runall`` option has changed. There are two different - behaviors people might want: - - - *Behavior A:* 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. - - - *Behavior B:* 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. - - The ``--runall`` option now performs "Behavior B". Previously - ``--runall`` behaved like "Behavior A". A ``--runonly`` option has - been added to retain the ability to perform "Behavior A". - -- Several explicit "run this task for all recipes in the dependency - tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``, - and the ``*all`` tasks provided by the ``distrodata`` and - ``archiver`` classes). There is a BitBake option to complete this for - any arbitrary task. For example: - :: - - bitbake <target> -c fetchall - - should now be replaced with: - :: - - bitbake <target> --runall=fetch - -.. _migration-2.5-python-and-python3-changes: - -Python and Python 3 Changes ---------------------------- - -The following are auto-packaging changes to Python and Python 3: - -The script-managed ``python-*-manifest.inc`` 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. - -One particular change to note is that the Python recipes no longer have -build-time provides for their packages. This assumes ``python-foo`` is -one of the packages provided by the Python recipe. You can no longer run -``bitbake python-foo`` or have a -:term:`DEPENDS` on ``python-foo``, -but doing either of the following causes the package to work as -expected: :: - - IMAGE_INSTALL_append = " python-foo" - -or :: - - RDEPENDS_${PN} = "python-foo" - -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 :yocto_git:`this commit -</poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce>`. - -.. _migration-2.5-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -The following are additional changes: - -- The ``kernel`` class supports building packages for multiple kernels. - If your kernel recipe or ``.bbappend`` file mentions packaging at - all, you should replace references to the kernel in package names - with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable - automatic installation of the kernel image using - ``RDEPENDS_kernel-base = ""`` you can avoid warnings using - ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead. - -- The ``buildhistory`` class commits changes to the repository by - default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``. - If you want to disable commits you need to set - ``BUILDHISTORY_COMMIT = "0"`` in your configuration. - -- The ``beaglebone`` reference machine has been renamed to - ``beaglebone-yocto``. The ``beaglebone-yocto`` BSP is a reference - implementation using only mainline components available in - OpenEmbedded-Core and ``meta-yocto-bsp``, whereas Texas Instruments - maintains a full-featured BSP in the ``meta-ti`` layer. This rename - avoids the previous name clash that existed between the two BSPs. - -- The ``update-alternatives`` class no longer works with SysV ``init`` - scripts because this usage has been problematic. Also, the - ``sysklogd`` recipe no longer uses ``update-alternatives`` because it - is incompatible with other implementations. - -- By default, the :ref:`cmake <ref-classes-cmake>` class uses - ``ninja`` instead of ``make`` for building. This improves build - performance. If a recipe is broken with ``ninja``, then the recipe - can set ``OECMAKE_GENERATOR = "Unix Makefiles"`` to change back to - ``make``. - -- The previously deprecated ``base_*`` functions have been removed in - favor of their replacements in ``meta/lib/oe`` and - ``bitbake/lib/bb``. 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: - - +------------------------------+----------------------------------------------------------+ - | *Removed* | *Replacement* | - +==============================+==========================================================+ - | 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) | - +------------------------------+----------------------------------------------------------+ - -- Using ``exit 1`` 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 ``rootfs`` creation time, use - ``pkg_postinst_ontarget()`` or call - ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. - Any failure of a ``pkg_postinst()`` script (including ``exit 1``) - will trigger a warning during ``do_rootfs``. - - For more information, see the - ":ref:`dev-manual/common-tasks:post-installation scripts`" - section in the Yocto Project Development Tasks Manual. - -- The ``elf`` image type has been removed. This image type was removed - because the ``mkelfimage`` tool that was required to create it is no - longer provided by coreboot upstream and required updating every time - ``binutils`` updated. - -- Support for .iso image compression (previously enabled through - ``COMPRESSISO = "1"``) has been removed. The userspace tools - (``zisofs-tools``) are unmaintained and ``squashfs`` provides better - performance and compression. In order to build a live image with - squashfs+lz4 compression enabled you should now set - ``LIVE_ROOTFS_TYPE = "squashfs-lz4"`` and ensure that ``live`` is in - ``IMAGE_FSTYPES``. - -- Recipes with an unconditional dependency on ``libpam`` are only - buildable with ``pam`` in ``DISTRO_FEATURES``. If the dependency is - truly optional then it is recommended that the dependency be - conditional upon ``pam`` being in ``DISTRO_FEATURES``. - -- For EFI-based machines, the bootloader (``grub-efi`` 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. - -- 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 :yocto_git:`this commit - </poky/commit/?id=cc97bc08125b63821ce3f616771830f77c456f57>`. - -- Layers are expected to set ``LAYERSERIES_COMPAT_layername`` 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 - ``LAYERSERIES_COMPAT_layername``, 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. - -- The ``TZ`` environment variable is set to "UTC" within the build - environment in order to fix reproducibility problems in some recipes. - - diff --git a/documentation/ref-manual/migration-2.6.rst b/documentation/ref-manual/migration-2.6.rst deleted file mode 100644 index aeac509808..0000000000 --- a/documentation/ref-manual/migration-2.6.rst +++ /dev/null @@ -1,457 +0,0 @@ -Moving to the Yocto Project 2.6 Release (thud) -============================================== - -This section provides migration information for moving to the Yocto -Project 2.6 Release (codename "thud") from the prior release. - -.. _migration-2.6-gcc-changes: - -GCC 8.2 is Now Used by Default ------------------------------- - -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 https://gcc.gnu.org/gcc-8/changes.html. - -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 :term:`GCCVERSION` variable to "7.%" in -your configuration. - -.. _migration-2.6-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed: - -- *beecrypt*: No longer needed since moving to RPM 4. -- *bigreqsproto*: Replaced by ``xorgproto``. -- *calibrateproto*: Removed in favor of ``xinput``. -- *compositeproto*: Replaced by ``xorgproto``. -- *damageproto*: Replaced by ``xorgproto``. -- *dmxproto*: Replaced by ``xorgproto``. -- *dri2proto*: Replaced by ``xorgproto``. -- *dri3proto*: Replaced by ``xorgproto``. -- *eee-acpi-scripts*: Became obsolete. -- *fixesproto*: Replaced by ``xorgproto``. -- *fontsproto*: Replaced by ``xorgproto``. -- *fstests*: Became obsolete. -- *gccmakedep*: No longer used. -- *glproto*: Replaced by ``xorgproto``. -- *gnome-desktop3*: No longer needed. This recipe has moved to ``meta-oe``. -- *icon-naming-utils*: No longer used since the Sato theme was removed in 2016. -- *inputproto*: Replaced by ``xorgproto``. -- *kbproto*: Replaced by ``xorgproto``. -- *libusb-compat*: Became obsolete. -- *libuser*: Became obsolete. -- *libnfsidmap*: No longer an external requirement since ``nfs-utils`` 2.2.1. ``libnfsidmap`` is now integrated. -- *libxcalibrate*: No longer needed with ``xinput`` -- *mktemp*: Became obsolete. The ``mktemp`` command is provided by both ``busybox`` and ``coreutils``. -- *ossp-uuid*: Is not being maintained and has mostly been replaced by ``uuid.h`` in ``util-linux``. -- *pax-utils*: No longer needed. Previous QA tests that did use this recipe are now done at build time. -- *pcmciautils*: Became obsolete. -- *pixz*: No longer needed. ``xz`` now supports multi-threaded compression. -- *presentproto*: Replaced by ``xorgproto``. -- *randrproto*: Replaced by ``xorgproto``. -- *recordproto*: Replaced by ``xorgproto``. -- *renderproto*: Replaced by ``xorgproto``. -- *resourceproto*: Replaced by ``xorgproto``. -- *scrnsaverproto*: Replaced by ``xorgproto``. -- *trace-cmd*: Became obsolete. ``perf`` replaced this recipe's functionally. -- *videoproto*: Replaced by ``xorgproto``. -- *wireless-tools*: Became obsolete. Superseded by ``iw``. -- *xcmiscproto*: Replaced by ``xorgproto``. -- *xextproto*: Replaced by ``xorgproto``. -- *xf86dgaproto*: Replaced by ``xorgproto``. -- *xf86driproto*: Replaced by ``xorgproto``. -- *xf86miscproto*: Replaced by ``xorgproto``. -- *xf86-video-omapfb*: Became obsolete. Use kernel modesetting driver instead. -- *xf86-video-omap*: Became obsolete. Use kernel modesetting driver instead. -- *xf86vidmodeproto*: Replaced by ``xorgproto``. -- *xineramaproto*: Replaced by ``xorgproto``. -- *xproto*: Replaced by ``xorgproto``. -- *yasm*: No longer needed since previous usages are now satisfied by ``nasm``. - -.. _migration-2.6-packaging-changes: - -Packaging Changes ------------------ - -The following packaging changes have been made: - -- *cmake*: ``cmake.m4`` and ``toolchain`` files have been moved to - the main package. - -- *iptables*: The ``iptables`` modules have been split into - separate packages. - -- *alsa-lib*: ``libasound`` is now in the main ``alsa-lib`` package - instead of ``libasound``. - -- *glibc*: ``libnss-db`` is now in its own package along with a - ``/var/db/makedbs.sh`` script to update databases. - -- *python and python3*: The main package has been removed from - the recipe. You must install specific packages or ``python-modules`` - / ``python3-modules`` for everything. - -- *systemtap*: Moved ``systemtap-exporter`` into its own package. - -.. _migration-2.6-xorg-protocol-dependencies: - -XOrg Protocol dependencies --------------------------- - -The ``*proto`` upstream repositories have been combined into one -"xorgproto" repository. Thus, the corresponding recipes have also been -combined into a single ``xorgproto`` recipe. Any recipes that depend -upon the older ``*proto`` recipes need to be changed to depend on the -newer ``xorgproto`` recipe instead. - -For names of recipes removed because of this repository change, see the -:ref:`ref-manual/migration-2.6:removed recipes` section. - -.. _migration-2.6-distutils-distutils3-fetching-dependencies: - -``distutils`` and ``distutils3`` Now Prevent Fetching Dependencies During the ``do_configure`` Task ---------------------------------------------------------------------------------------------------- - -Previously, it was possible for Python recipes that inherited the -``distutils`` and -:ref:`distutils3 <ref-classes-distutils3>` classes to fetch code -during the :ref:`ref-tasks-configure` task to satisfy -dependencies mentioned in ``setup.py`` if those dependencies were not -provided in the sysroot (i.e. recipes providing the dependencies were -missing from :term:`DEPENDS`). - -.. note:: - - This change affects classes beyond just the two mentioned (i.e. - ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*`` - classes are affected. For example, the ``setuptools`` and ``setuptools3`` - recipes are affected since they inherit the ``distutils*`` classes. - -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 ``do_configure`` task. - -.. _migration-2.6-linux-yocto-configuration-audit-issues-now-correctly-reported: - -``linux-yocto`` Configuration Audit Issues Now Correctly Reported ------------------------------------------------------------------ - -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 ``linux-yocto`` style kernel recipe. - -.. _migration-2.6-image-kernel-artifact-naming-changes: - -Image/Kernel Artifact Naming Changes ------------------------------------- - -The following changes have been made: - -- Name variables (e.g. :term:`IMAGE_NAME`) use a new - ``IMAGE_VERSION_SUFFIX`` variable instead of - :term:`DATETIME`. Using ``IMAGE_VERSION_SUFFIX`` - allows easier and more direct changes. - - The ``IMAGE_VERSION_SUFFIX`` variable is set in the ``bitbake.conf`` - configuration file as follows: - :: - - IMAGE_VERSION_SUFFIX = "-${DATETIME}" - -- Several variables have changed names for consistency: - :: - - Old Variable Name New Variable Name - ======================================================== - KERNEL_IMAGE_BASE_NAME KERNEL_IMAGE_NAME - KERNEL_IMAGE_SYMLINK_NAME KERNEL_IMAGE_LINK_NAME - MODULE_TARBALL_BASE_NAME MODULE_TARBALL_NAME - MODULE_TARBALL_SYMLINK_NAME MODULE_TARBALL_LINK_NAME - INITRAMFS_BASE_NAME INITRAMFS_NAME - -- The ``MODULE_IMAGE_BASE_NAME`` variable has been removed. The module - tarball name is now controlled directly with the - :term:`MODULE_TARBALL_NAME` variable. - -- The :term:`KERNEL_DTB_NAME` and - :term:`KERNEL_DTB_LINK_NAME` variables - have been introduced to control kernel Device Tree Binary (DTB) - artifact names instead of mangling ``KERNEL_IMAGE_*`` variables. - -- The :term:`KERNEL_FIT_NAME` and - :term:`KERNEL_FIT_LINK_NAME` variables - have been introduced to specify the name of flattened image tree - (FIT) kernel images similar to other deployed artifacts. - -- The :term:`MODULE_TARBALL_NAME` and - :term:`MODULE_TARBALL_LINK_NAME` - 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. - -- Added the :term:`INITRAMFS_LINK_NAME` - variable so that the symlink can be controlled similarly to other - artifact types. - -- :term:`INITRAMFS_NAME` now uses - "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" instead - of "${PV}-${PR}-${MACHINE}-${DATETIME}", which makes it consistent - with other variables. - -.. _migration-2.6-serial-console-deprecated: - -``SERIAL_CONSOLE`` Deprecated ------------------------------ - -The :term:`SERIAL_CONSOLE` variable has been -functionally replaced by the -:term:`SERIAL_CONSOLES` variable for some time. -With the Yocto Project 2.6 release, ``SERIAL_CONSOLE`` has been -officially deprecated. - -``SERIAL_CONSOLE`` 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 ``SERIAL_CONSOLE`` with -``SERIAL_CONSOLES``. - -.. note:: - - The only difference in usage is that ``SERIAL_CONSOLES`` - expects entries to be separated using semicolons as compared to - ``SERIAL_CONSOLE``, which expects spaces. - -.. _migration-2.6-poky-sets-unknown-configure-option-to-qa-error: - -Configure Script Reports Unknown Options as Errors --------------------------------------------------- - -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. - -.. _migration-2.6-override-changes: - -Override Changes ----------------- - -The following changes have occurred: - -- The ``virtclass-native`` and ``virtclass-nativesdk`` Overrides Have - Been Removed: The ``virtclass-native`` and ``virtclass-nativesdk`` - overrides have been deprecated since 2012 in favor of - ``class-native`` and ``class-nativesdk``, respectively. Both - ``virtclass-native`` and ``virtclass-nativesdk`` are now dropped. - - .. note:: - - The ``virtclass-multilib-`` overrides for multilib are still valid. - -- The ``forcevariable`` Override Now Has a Higher Priority Than - ``libc`` Overrides: The ``forcevariable`` override is documented to - be the highest priority override. However, due to a long-standing - quirk of how :term:`OVERRIDES` is set, the ``libc`` - overrides (e.g. ``libc-glibc``, ``libc-musl``, and so forth) - erroneously had a higher priority. This issue is now corrected. - - 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 ``forcevariable`` and ``libc-*`` overrides in your - custom layers and configuration files to ensure they make sense. - -- The ``build-${BUILD_OS}`` Override Has Been Removed: The - ``build-${BUILD_OS}``, which is typically ``build-linux``, 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. - -- 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. - - See the ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`" - section in the BitBake User Manual for a detailed example. - -.. _migration-2.6-systemd-configuration-now-split-out-to-system-conf: - -``systemd`` Configuration is Now Split Into ``systemd-conf`` ------------------------------------------------------------- - -The configuration for the ``systemd`` recipe has been moved into a -``system-conf`` recipe. Moving this configuration to a separate recipe -avoids the ``systemd`` recipe from becoming machine-specific for cases -where machine-specific configurations need to be applied (e.g. for -``qemu*`` machines). - -Currently, the new recipe packages the following files: -:: - - ${sysconfdir}/machine-id - ${sysconfdir}/systemd/coredump.conf - ${sysconfdir}/systemd/journald.conf - ${sysconfdir}/systemd/logind.conf - ${sysconfdir}/systemd/system.conf - ${sysconfdir}/systemd/user.conf - -If you previously used bbappend files to append the ``systemd`` recipe to -change any of the listed files, you must do so for the ``systemd-conf`` -recipe instead. - -.. _migration-2.6-automatic-testing-changes: - -Automatic Testing Changes -------------------------- - -This section provides information about automatic testing changes: - -- ``TEST_IMAGE`` Variable Removed: Prior to this release, you set the - ``TEST_IMAGE`` variable to "1" to enable automatic testing for - successfully built images. The ``TEST_IMAGE`` variable no longer - exists and has been replaced by the - :term:`TESTIMAGE_AUTO` variable. - -- Inheriting the ``testimage`` and ``testsdk`` Classes: Best - practices now dictate that you use the - :term:`IMAGE_CLASSES` variable rather than the - :term:`INHERIT` variable when you inherit the - :ref:`testimage <ref-classes-testimage*>` and - :ref:`testsdk <ref-classes-testsdk>` classes used for automatic - testing. - -.. _migration-2.6-openssl-changes: - -OpenSSL Changes ---------------- - -`OpenSSL <https://www.openssl.org/>`__ 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. - -.. _migration-2.6-bitbake-changes: - -BitBake Changes ---------------- - -The server logfile ``bitbake-cookerdaemon.log`` is now always placed in -the :term:`Build Directory` instead of the current -directory. - -.. _migration-2.6-security-changes: - -Security Changes ----------------- - -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. - -.. _migration-2.6-post-installation-changes: - -Post Installation Changes -------------------------- - -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 ``pkg_postinst_ontarget()`` or -call ``postinst_intercept delay_to_first_boot`` from ``pkg_postinst()``. -Any failure of a ``pkg_postinst()`` script (including exit 1) triggers -an error during the :ref:`ref-tasks-rootfs` task. - -For more information on post-installation behavior, see the -":ref:`dev-manual/common-tasks:post-installation scripts`" -section in the Yocto Project Development Tasks Manual. - -.. _migration-2.6-python-3-profile-guided-optimizations: - -Python 3 Profile-Guided Optimization ------------------------------------- - -The ``python3`` 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 -:term:`MACHINE` has support for user-mode emulation in -QEMU (i.e. "qemu-usermode" is in -:term:`MACHINE_FEATURES`, which it is by -default). - -If you wish to disable Python profile-guided optimization regardless of -the value of ``MACHINE_FEATURES``, then ensure that -:term:`PACKAGECONFIG` for the ``python3`` recipe -does not contain "pgo". You could accomplish the latter using the -following at the configuration level: -:: - - PACKAGECONFIG_remove_pn-python3 = "pgo" - -Alternatively, you can set ``PACKAGECONFIG`` using an append file -for the ``python3`` recipe. - -.. _migration-2.6-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -The following miscellaneous changes occurred: - -- 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: - :: - - ARM_INSTRUCTION_SET = "arm" - -- ``run-postinsts`` no longer uses ``/etc/*-postinsts`` for - ``dpkg/opkg`` in favor of built-in postinst support. RPM behavior - remains unchanged. - -- The ``NOISO`` and ``NOHDD`` variables are no longer used. You now - control building ``*.iso`` and ``*.hddimg`` image types directly by - using the :term:`IMAGE_FSTYPES` variable. - -- The ``scripts/contrib/mkefidisk.sh`` has been removed in favor of - Wic. - -- ``kernel-modules`` has been removed from - :term:`RRECOMMENDS` for ``qemumips`` and - ``qemumips64`` machines. Removal also impacts the ``x86-base.inc`` - file. - - .. note:: - - ``genericx86`` and ``genericx86-64`` retain ``kernel-modules`` as part of - the ``RRECOMMENDS`` variable setting. - -- The ``LGPLv2_WHITELIST_GPL-3.0`` variable has been removed. If you - are setting this variable in your configuration, set or append it to - the ``WHITELIST_GPL-3.0`` variable instead. - -- ``${ASNEEDED}`` is now included in the - :term:`TARGET_LDFLAGS` variable directly. The - remaining definitions from ``meta/conf/distro/include/as-needed.inc`` - have been moved to corresponding recipes. - -- 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. - -- The ``dhcp`` recipe now uses the ``dhcpd6.conf`` configuration file - in ``dhcpd6.service`` for IPv6 DHCP rather than re-using - ``dhcpd.conf``, which is now reserved for IPv4. - - diff --git a/documentation/ref-manual/migration-2.7.rst b/documentation/ref-manual/migration-2.7.rst deleted file mode 100644 index 1be4d5d5b9..0000000000 --- a/documentation/ref-manual/migration-2.7.rst +++ /dev/null @@ -1,180 +0,0 @@ -Moving to the Yocto Project 2.7 Release (warrior) -================================================= - -This section provides migration information for moving to the Yocto -Project 2.7 Release (codename "warrior") from the prior release. - -.. _migration-2.7-bitbake-changes: - -BitBake Changes ---------------- - -The following changes have been made to BitBake: - -- BitBake now checks anonymous Python functions and pure Python - functions (e.g. ``def funcname:``) in the metadata for tab - indentation. If found, BitBake produces a warning. - -- Bitbake now checks - :term:`BBFILE_COLLECTIONS` for duplicate - entries and triggers an error if any are found. - -.. _migration-2.7-eclipse-support-dropped: - -Eclipse Support Removed ------------------------ - -Support for the Eclipse IDE has been removed. Support continues for -those releases prior to 2.7 that did include support. The 2.7 release -does not include the Eclipse Yocto plugin. - -.. _migration-2.7-qemu-native-splits-system-and-user-mode-parts: - -``qemu-native`` Splits the System and User-Mode Parts ------------------------------------------------------ - -The system and user-mode parts of ``qemu-native`` are now split. -``qemu-native`` provides the user-mode components and -``qemu-system-native`` provides the system components. If you have -recipes that depend on QEMU's system emulation functionality at build -time, they should now depend upon ``qemu-system-native`` instead of -``qemu-native``. - -.. _migration-2.7-upstream-tracking.inc-removed: - -The ``upstream-tracking.inc`` File Has Been Removed ---------------------------------------------------- - -The previously deprecated ``upstream-tracking.inc`` file is now removed. -Any ``UPSTREAM_TRACKING*`` variables are now set in the corresponding -recipes instead. - -Remove any references you have to the ``upstream-tracking.inc`` file in -your configuration. - -.. _migration-2.7-distro-features-libc-removed: - -The ``DISTRO_FEATURES_LIBC`` Variable Has Been Removed ------------------------------------------------------- - -The ``DISTRO_FEATURES_LIBC`` variable is no longer used. The ability to -configure glibc using kconfig has been removed for quite some time -making the ``libc-*`` features set no longer effective. - -Remove any references you have to ``DISTRO_FEATURES_LIBC`` in your own -layers. - -.. _migration-2.7-license-values: - -License Value Corrections -------------------------- - -The following corrections have been made to the -:term:`LICENSE` values set by recipes: - -- *socat*: Corrected ``LICENSE`` to be "GPLv2" rather than "GPLv2+". -- *libgfortran*: Set license to "GPL-3.0-with-GCC-exception". -- *elfutils*: Removed "Elfutils-Exception" and set to "GPLv2" for shared libraries - -.. _migration-2.7-packaging-changes: - -Packaging Changes ------------------ - -This section provides information about packaging changes. - -- ``bind``: The ``nsupdate`` binary has been moved to the - ``bind-utils`` package. - -- Debug split: The default debug split has been changed to create - separate source packages (i.e. package_name\ ``-dbg`` and - package_name\ ``-src``). If you are currently using ``dbg-pkgs`` in - :term:`IMAGE_FEATURES` to bring in debug - symbols and you still need the sources, you must now also add - ``src-pkgs`` to ``IMAGE_FEATURES``. Source packages remain in the - target portion of the SDK by default, unless you have set your own - value for :term:`SDKIMAGE_FEATURES` that - does not include ``src-pkgs``. - -- Mount all using ``util-linux``: ``/etc/default/mountall`` has moved - into the -mount sub-package. - -- Splitting binaries using ``util-linux``: ``util-linux`` now splits - each binary into its own package for fine-grained control. The main - ``util-linux`` package pulls in the individual binary packages using - the :term:`RRECOMMENDS` and - :term:`RDEPENDS` variables. As a result, existing - images should not see any changes assuming - :term:`NO_RECOMMENDATIONS` is not set. - -- ``netbase/base-files``: ``/etc/hosts`` has moved from ``netbase`` to - ``base-files``. - -- ``tzdata``: The main package has been converted to an empty meta - package that pulls in all ``tzdata`` packages by default. - -- ``lrzsz``: This package has been removed from - ``packagegroup-self-hosted`` and - ``packagegroup-core-tools-testapps``. The X/Y/ZModem support is less - likely to be needed on modern systems. If you are relying on these - packagegroups to include the ``lrzsz`` package in your image, you now - need to explicitly add the package. - -.. _migration-2.7-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed: - -- *gcc*: Drop version 7.3 recipes. Version 8.3 now remains. -- *linux-yocto*: Drop versions 4.14 and 4.18 recipes. Versions 4.19 and 5.0 remain. -- *go*: Drop version 1.9 recipes. Versions 1.11 and 1.12 remain. -- *xvideo-tests*: Became obsolete. -- *libart-lgpl*: Became obsolete. -- *gtk-icon-utils-native*: These tools are now provided by gtk+3-native -- *gcc-cross-initial*: No longer needed. gcc-cross/gcc-crosssdk is now used instead. -- *gcc-crosssdk-initial*: No longer needed. gcc-cross/gcc-crosssdk is now used instead. -- *glibc-initial*: Removed because the benefits of having it for site_config are currently outweighed by the cost of building the recipe. - -.. _migration-2.7-removed-classes: - -Removed Classes ---------------- - -The following classes have been removed: - -- *distutils-tools*: This class was never used. -- *bugzilla.bbclass*: Became obsolete. -- *distrodata*: This functionally has been replaced by a more modern tinfoil-based implementation. - -.. _migration-2.7-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -The following miscellaneous changes occurred: - -- The ``distro`` subdirectory of the Poky repository has been removed - from the top-level ``scripts`` directory. - -- Perl now builds for the target using - `perl-cross <https://arsv.github.io/perl-cross/>`_ for better - maintainability and improved build performance. This change should - not present any problems unless you have heavily customized your Perl - recipe. - -- ``arm-tunes``: Removed the "-march" option if mcpu is already added. - -- ``update-alternatives``: Convert file renames to - :term:`PACKAGE_PREPROCESS_FUNCS` - -- ``base/pixbufcache``: Obsolete ``sstatecompletions`` code has been - removed. - -- :ref:`native <ref-classes-native>` class: - :term:`RDEPENDS` handling has been enabled. - -- ``inetutils``: This recipe has rsh disabled. - - diff --git a/documentation/ref-manual/migration-3.0.rst b/documentation/ref-manual/migration-3.0.rst deleted file mode 100644 index f3d20e2eda..0000000000 --- a/documentation/ref-manual/migration-3.0.rst +++ /dev/null @@ -1,320 +0,0 @@ -Moving to the Yocto Project 3.0 Release (zeus) -============================================== - -This section provides migration information for moving to the Yocto -Project 3.0 Release (codename "zeus") from the prior release. - -.. _migration-3.0-init-system-selection: - -Init System Selection ---------------------- - -Changing the init system manager previously required setting a number of -different variables. You can now change the manager by setting the -``INIT_MANAGER`` variable and the corresponding include files (i.e. -``conf/distro/include/init-manager-*.conf``). Include files are provided -for four values: "none", "sysvinit", "systemd", and "mdev-busybox". The -default value, "none", for ``INIT_MANAGER`` should allow your current -settings to continue working. However, it is advisable to explicitly set -``INIT_MANAGER``. - -.. _migration-3.0-lsb-support-removed: - -LSB Support Removed -------------------- - -Linux Standard Base (LSB) as a standard is not current, and is not well -suited for embedded applications. Support can be continued in a separate -layer if needed. However, presently LSB support has been removed from -the core. - -As a result of this change, the ``poky-lsb`` derivative distribution -configuration that was also used for testing alternative configurations -has been replaced with a ``poky-altcfg`` distribution that has LSB parts -removed. - -.. _migration-3.0-removed-recipes: - -Removed Recipes ---------------- - -The following recipes have been removed. - -- ``core-image-lsb-dev``: Part of removed LSB support. - -- ``core-image-lsb``: Part of removed LSB support. - -- ``core-image-lsb-sdk``: Part of removed LSB support. - -- ``cve-check-tool``: Functionally replaced by the ``cve-update-db`` - recipe and ``cve-check`` class. - -- ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is - an adequate and maintained alternative. - -- ``gcc-8.3``: Version 8.3 removed. Replaced by 9.2. - -- ``gnome-themes-standard``: Only needed by gtk+ 2.x, which has been - removed. - -- ``gtk+``: GTK+ 2 is obsolete and has been replaced by gtk+3. - -- ``irda-utils``: Has become obsolete. IrDA support has been removed - from the Linux kernel in version 4.17 and later. - -- ``libnewt-python``: ``libnewt`` Python support merged into main - ``libnewt`` recipe. - -- ``libsdl``: Replaced by newer ``libsdl2``. - -- ``libx11-diet``: Became obsolete. - -- ``libxx86dga``: Removed obsolete client library. - -- ``libxx86misc``: Removed. Library is redundant. - -- ``linux-yocto``: Version 5.0 removed, which is now redundant (5.2 / - 4.19 present). - -- ``lsbinitscripts``: Part of removed LSB support. - -- ``lsb``: Part of removed LSB support. - -- ``lsbtest``: Part of removed LSB support. - -- ``openssl10``: Replaced by newer ``openssl`` version 1.1. - -- ``packagegroup-core-lsb``: Part of removed LSB support. - -- ``python-nose``: Removed the Python 2.x version of the recipe. - -- ``python-numpy``: Removed the Python 2.x version of the recipe. - -- ``python-scons``: Removed the Python 2.x version of the recipe. - -- ``source-highlight``: No longer needed. - -- ``stress``: Replaced by ``stress-ng``. - -- ``vulkan``: Split into ``vulkan-loader``, ``vulkan-headers``, and - ``vulkan-tools``. - -- ``weston-conf``: Functionality moved to ``weston-init``. - -.. _migration-3.0-packaging-changes: - -Packaging Changes ------------------ - -The following packaging changes have occurred. - -- The `Epiphany <https://en.wikipedia.org/wiki/GNOME_Web>`__ browser - has been dropped from ``packagegroup-self-hosted`` as it has not been - needed inside ``build-appliance-image`` for quite some time and was - causing resource problems. - -- ``libcap-ng`` Python support has been moved to a separate - ``libcap-ng-python`` recipe to streamline the build process when the - Python bindings are not needed. - -- ``libdrm`` now packages the file ``amdgpu.ids`` into a separate - ``libdrm-amdgpu`` package. - -- ``python3``: The ``runpy`` module is now in the ``python3-core`` - package as it is required to support the common "python3 -m" command - usage. - -- ``distcc`` now provides separate ``distcc-client`` and - ``distcc-server`` packages as typically one or the other are needed, - rather than both. - -- ``python*-setuptools`` recipes now separately package the - ``pkg_resources`` module in a ``python-pkg-resources`` / - ``python3-pkg-resources`` package as the module is useful independent - of the rest of the setuptools package. The main ``python-setuptools`` - / ``python3-setuptools`` package depends on this new package so you - should only need to update dependencies unless you want to take - advantage of the increased granularity. - -.. _migration-3.0-cve-checking: - -CVE Checking ------------- - -``cve-check-tool`` has been functionally replaced by a new -``cve-update-db`` recipe and functionality built into the ``cve-check`` -class. The result uses NVD JSON data feeds rather than the deprecated -XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, -and makes other improvements. - -Additionally, the ``CVE_CHECK_CVE_WHITELIST`` variable has been replaced -by ``CVE_CHECK_WHITELIST``. - -.. _migration-3.0-bitbake-changes: - -Bitbake Changes ---------------- - -The following BitBake changes have occurred. - -- ``addtask`` statements now properly validate dependent tasks. - Previously, an invalid task was silently ignored. With this change, - the invalid task generates a warning. - -- Other invalid ``addtask`` and ``deltask`` usages now trigger these - warnings: "multiple target tasks arguments with addtask / deltask", - and "multiple before/after clauses". - -- The "multiconfig" prefix is now shortened to "mc". "multiconfig" will - continue to work, however it may be removed in a future release. - -- The ``bitbake -g`` command no longer generates a - ``recipe-depends.dot`` file as the contents (i.e. a reprocessed - version of ``task-depends.dot``) were confusing. - -- The ``bb.build.FuncFailed`` exception, previously raised by - ``bb.build.exec_func()`` when certain other exceptions have occurred, - has been removed. The real underlying exceptions will be raised - instead. If you have calls to ``bb.build.exec_func()`` in custom - classes or ``tinfoil-using`` scripts, any references to - ``bb.build.FuncFailed`` should be cleaned up. - -- Additionally, the ``bb.build.exec_func()`` no longer accepts the - "pythonexception" parameter. The function now always raises - exceptions. Remove this argument in any calls to - ``bb.build.exec_func()`` in custom classes or scripts. - -- The - :term:`bitbake:BB_SETSCENE_VERIFY_FUNCTION2` - is no longer used. In the unlikely event that you have any references - to it, they should be removed. - -- The ``RunQueueExecuteScenequeue`` and ``RunQueueExecuteTasks`` events - have been removed since setscene tasks are now executed as part of - the normal runqueue. Any event handling code in custom classes or - scripts that handles these two events need to be updated. - -- The arguments passed to functions used with - :term:`bitbake:BB_HASHCHECK_FUNCTION` - have changed. If you are using your own custom hash check function, - see :yocto_git:`/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725` - for details. - -- Task specifications in ``BB_TASKDEPDATA`` and class implementations - used in signature generator classes now use "<fn>:<task>" everywhere - rather than the "." delimiter that was being used in some places. - This change makes it consistent with all areas in the code. Custom - signature generator classes and code that reads ``BB_TASKDEPDATA`` - need to be updated to use ':' as a separator rather than '.'. - -.. _migration-3.0-sanity-checks: - -Sanity Checks -------------- - -The following sanity check changes occurred. - -- :term:`SRC_URI` is now checked for usage of two - problematic items: - - - "${PN}" prefix/suffix use - Warnings always appear if ${PN} is - used. You must fix the issue regardless of whether multiconfig or - anything else that would cause prefixing/suffixing to happen. - - - Github archive tarballs - these are not guaranteed to be stable. - Consequently, it is likely that the tarballs will be refreshed and - thus the SRC_URI checksums will fail to apply. It is recommended - that you fetch either an official release tarball or a specific - revision from the actual Git repository instead. - - Either one of these items now trigger a warning by default. If you - wish to disable this check, remove ``src-uri-bad`` from - :term:`WARN_QA`. - -- The ``file-rdeps`` runtime dependency check no longer expands - :term:`RDEPENDS` recursively as there is no mechanism - to ensure they can be fully computed, and thus races sometimes result - in errors either showing up or not. Thus, you might now see errors - for missing runtime dependencies that were previously satisfied - recursively. Here is an example: package A contains a shell script - starting with ``#!/bin/bash`` but has no dependency on bash. However, - package A depends on package B, which does depend on bash. You need - to add the missing dependency or dependencies to resolve the warning. - -- Setting ``DEPENDS_${PN}`` anywhere (i.e. typically in a recipe) now - triggers an error. The error is triggered because - :term:`DEPENDS` is not a package-specific variable - unlike RDEPENDS. You should set ``DEPENDS`` instead. - -- systemd currently does not work well with the musl C library because - only upstream officially supports linking the library with glibc. - Thus, a warning is shown when building systemd in conjunction with - musl. - -.. _migration-3.0-miscellaneous-changes: - -Miscellaneous Changes ---------------------- - -The following miscellaneous changes have occurred. - -- The ``gnome`` class has been removed because it now does very little. - You should update recipes that previously inherited this class to do - the following: inherit gnomebase gtk-icon-cache gconf mime - -- The ``meta/recipes-kernel/linux/linux-dtb.inc`` file has been - removed. This file was previously deprecated in favor of setting - :term:`KERNEL_DEVICETREE` in any kernel - recipe and only produced a warning. Remove any ``include`` or - ``require`` statements pointing to this file. - -- :term:`TARGET_CFLAGS`, - :term:`TARGET_CPPFLAGS`, - :term:`TARGET_CXXFLAGS`, and - :term:`TARGET_LDFLAGS` are no longer exported - to the external environment. This change did not require any changes - to core recipes, which is a good indicator that no changes will be - required. However, if for some reason the software being built by one - of your recipes is expecting these variables to be set, then building - the recipe will fail. In such cases, you must either export the - variable or variables in the recipe or change the scripts so that - exporting is not necessary. - -- You must change the host distro identifier used in - :term:`NATIVELSBSTRING` to use all lowercase - characters even if it does not contain a version number. This change - is necessary only if you are not using ``uninative`` and - :term:`SANITY_TESTED_DISTROS`. - -- In the ``base-files`` recipe, writing the hostname into - ``/etc/hosts`` and ``/etc/hostname`` is now done within the main - :ref:`ref-tasks-install` function rather than in the - ``do_install_basefilesissue`` function. The reason for the change is - because ``do_install_basefilesissue`` is more easily overridden - without having to duplicate the hostname functionality. If you have - done the latter (e.g. in a ``base-files`` bbappend), then you should - remove it from your customized ``do_install_basefilesissue`` - function. - -- The ``wic --expand`` command now uses commas to separate "key:value" - pairs rather than hyphens. - - .. note:: - - The wic command-line help is not updated. - - You must update any scripts or commands where you use - ``wic --expand`` with multiple "key:value" pairs. - -- UEFI image variable settings have been moved from various places to a - central ``conf/image-uefi.conf``. This change should not influence - any existing configuration as the ``meta/conf/image-uefi.conf`` in - the core metadata sets defaults that can be overridden in the same - manner as before. - -- ``conf/distro/include/world-broken.inc`` has been removed. For cases - where certain recipes need to be disabled when using the musl C - library, these recipes now have ``COMPATIBLE_HOST_libc-musl`` set - with a comment that explains why. - - diff --git a/documentation/ref-manual/migration-3.1.rst b/documentation/ref-manual/migration-3.1.rst deleted file mode 100644 index 84d32502e5..0000000000 --- a/documentation/ref-manual/migration-3.1.rst +++ /dev/null @@ -1,276 +0,0 @@ -Moving to the Yocto Project 3.1 Release (dunfell) -================================================= - -This section provides migration information for moving to the Yocto -Project 3.1 Release (codename "dunfell") from the prior release. - -.. _migration-3.1-minimum-system-requirements: - -Minimum system requirements ---------------------------- - -The following versions / requirements of build host components have been -updated: - -- gcc 5.0 - -- python 3.5 - -- tar 1.28 - -- ``rpcgen`` is now required on the host (part of the ``libc-dev-bin`` - package on Ubuntu, Debian and related distributions, and the - ``glibc`` package on RPM-based distributions). - -Additionally, the ``makeinfo`` and ``pod2man`` tools are *no longer* -required on the host. - -.. _migration-3.1-mpc8315e-rdb-removed: - -mpc8315e-rdb machine removed ----------------------------- - -The MPC8315E-RDB machine is old/obsolete and unobtainable, thus given -the maintenance burden the ``mpc8315e-rdb`` machine configuration that -supported it has been removed in this release. The removal does leave a -gap in official PowerPC reference hardware support; this may change in -future if a suitable machine with accompanying support resources is -found. - -.. _migration-3.1-python-2-removed: - -Python 2 removed ----------------- - -Due to the expiration of upstream support in January 2020, support for -Python 2 has now been removed; it is recommended that you use Python 3 -instead. If absolutely needed there is a meta-python2 community layer -containing Python 2, related classes and various Python 2-based modules, -however it should not be considered as supported. - -.. _migration-3.1-reproducible-builds: - -Reproducible builds now enabled by default ------------------------------------------- - -In order to avoid unnecessary differences in output files (aiding binary -reproducibility), the Poky distribution configuration -(``DISTRO = "poky"``) now inherits the ``reproducible_build`` class by -default. - -.. _migration-3.1-ptest-feature-impact: - -Impact of ptest feature is now more significant ------------------------------------------------ - -The Poky distribution configuration (``DISTRO = "poky"``) enables ptests -by default to enable runtime testing of various components. In this -release, a dependency needed to be added that has resulted in a -significant increase in the number of components that will be built just -when building a simple image such as core-image-minimal. If you do not -need runtime tests enabled for core components, then it is recommended -that you remove "ptest" from -:term:`DISTRO_FEATURES` to save a significant -amount of build time e.g. by adding the following in your configuration: -:: - - DISTRO_FEATURES_remove = "ptest" - -.. _migration-3.1-removed-recipes: - -Removed recipes ---------------- - -The following recipes have been removed: - -- ``chkconfig``: obsolete - -- ``console-tools``: obsolete - -- ``enchant``: replaced by ``enchant2`` - -- ``foomatic-filters``: obsolete - -- ``libidn``: no longer needed, moved to meta-oe - -- ``libmodulemd``: replaced by ``libmodulemd-v1`` - -- ``linux-yocto``: drop 4.19, 5.2 version recipes (5.4 now provided) - -- ``nspr``: no longer needed, moved to meta-oe - -- ``nss``: no longer needed, moved to meta-oe - -- ``python``: Python 2 removed (Python 3 preferred) - -- ``python-setuptools``: Python 2 version removed (python3-setuptools - preferred) - -- ``sysprof``: no longer needed, moved to meta-oe - -- ``texi2html``: obsolete - -- ``u-boot-fw-utils``: functionally replaced by ``libubootenv`` - -.. _migration-3.1-features-check: - -features_check class replaces distro_features_check ---------------------------------------------------- - -The ``distro_features_check`` class has had its functionality expanded, -now supporting ``ANY_OF_MACHINE_FEATURES``, -``REQUIRED_MACHINE_FEATURES``, ``CONFLICT_MACHINE_FEATURES``, -``ANY_OF_COMBINED_FEATURES``, ``REQUIRED_COMBINED_FEATURES``, -``CONFLICT_COMBINED_FEATURES``. As a result the class has now been -renamed to ``features_check``; the ``distro_features_check`` class still -exists but generates a warning and redirects to the new class. In -preparation for a future removal of the old class it is recommended that -you update recipes currently inheriting ``distro_features_check`` to -inherit ``features_check`` instead. - -.. _migration-3.1-removed-classes: - -Removed classes ---------------- - -The following classes have been removed: - -- ``distutils-base``: moved to meta-python2 - -- ``distutils``: moved to meta-python2 - -- ``libc-common``: merged into the glibc recipe as nothing else used - it. - -- ``python-dir``: moved to meta-python2 - -- ``pythonnative``: moved to meta-python2 - -- ``setuptools``: moved to meta-python2 - -- ``tinderclient``: dropped as it was obsolete. - -.. _migration-3.1-src-uri-checksums: - -SRC_URI checksum behaviour --------------------------- - -Previously, recipes by tradition included both SHA256 and MD5 checksums -for remotely fetched files in :term:`SRC_URI`, even -though only one is actually mandated. However, the MD5 checksum does not -add much given its inherent weakness; thus when a checksum fails only -the SHA256 sum will now be printed. The md5sum will still be verified if -it is specified. - -.. _migration-3.1-npm: - -npm fetcher changes -------------------- - -The npm fetcher has been completely reworked in this release. The npm -fetcher now only fetches the package source itself and no longer the -dependencies; there is now also an npmsw fetcher which explicitly -fetches the shrinkwrap file and the dependencies. This removes the -slightly awkward ``NPM_LOCKDOWN`` and ``NPM_SHRINKWRAP`` variables which -pointed to local files; the lockdown file is no longer needed at all. -Additionally, the package name in ``npm://`` entries in -:term:`SRC_URI` is now specified using a ``package`` -parameter instead of the earlier ``name`` which overlapped with the -generic ``name`` parameter. All recipes using the npm fetcher will need -to be changed as a result. - -An example of the new scheme: :: - - SRC_URI = "npm://registry.npmjs.org;package=array-flatten;version=1.1.1 \ - npmsw://${THISDIR}/npm-shrinkwrap.json" - -Another example where the sources are fetched from git rather than an npm repository: :: - - SRC_URI = "git://github.com/foo/bar.git;protocol=https \ - npmsw://${THISDIR}/npm-shrinkwrap.json" - -devtool and recipetool have also been updated to match with the npm -fetcher changes. Other than producing working and more complete recipes -for npm sources, there is also a minor change to the command line for -devtool: the ``--fetch-dev`` option has been renamed to ``--npm-dev`` as -it is npm-specific. - -.. _migration-3.1-packaging-changes: - -Packaging changes ------------------ - -- ``intltool`` has been removed from ``packagegroup-core-sdk`` as it is - rarely needed to build modern software - gettext can do most of the - things it used to be needed for. ``intltool`` has also been removed - from ``packagegroup-core-self-hosted`` as it is not needed to for - standard builds. - -- git: ``git-am``, ``git-difftool``, ``git-submodule``, and - ``git-request-pull`` are no longer perl-based, so are now installed - with the main ``git`` package instead of within ``git-perltools``. - -- The ``ldconfig`` binary built as part of glibc has now been moved to - its own ``ldconfig`` package (note no ``glibc-`` prefix). This - package is in the :term:`RRECOMMENDS` of the main - ``glibc`` package if ``ldconfig`` is present in - :term:`DISTRO_FEATURES`. - -- ``libevent`` now splits each shared library into its own package (as - Debian does). Since these are shared libraries and will be pulled in - through the normal shared library dependency handling, there should - be no impact to existing configurations other than less unnecessary - libraries being installed in some cases. - -- linux-firmware now has a new package for ``bcm4366c`` and includes - available NVRAM config files into the ``bcm43340``, ``bcm43362``, - ``bcm43430`` and ``bcm4356-pcie`` packages. - -- ``harfbuzz`` now splits the new ``libharfbuzz-subset.so`` library - into its own package to reduce the main package size in cases where - ``libharfbuzz-subset.so`` is not needed. - -.. _migration-3.1-package-qa-warnings: - -Additional warnings -------------------- - -Warnings will now be shown at ``do_package_qa`` time in the following -circumstances: - -- A recipe installs ``.desktop`` files containing ``MimeType`` keys but - does not inherit the new ``mime-xdg`` class - -- A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` - but does not inherit the ``mime`` class - -.. _migration-3.1-x86-live-wic: - -``wic`` image type now used instead of ``live`` by default for x86 ------------------------------------------------------------------- - -``conf/machine/include/x86-base.inc`` (inherited by most x86 machine -configurations) now specifies ``wic`` instead of ``live`` by default in -:term:`IMAGE_FSTYPES`. The ``live`` image type will -likely be removed in a future release so it is recommended that you use -``wic`` instead. - -.. _migration-3.1-misc: - -Miscellaneous changes ---------------------- - -- The undocumented ``SRC_DISTRIBUTE_LICENSES`` variable has now been - removed in favour of a new ``AVAILABLE_LICENSES`` variable which is - dynamically set based upon license files found in - ``${COMMON_LICENSE_DIR}`` and ``${LICENSE_PATH}``. - -- The tune definition for big-endian microblaze machines is now - ``microblaze`` instead of ``microblazeeb``. - -- ``newlib`` no longer has built-in syscalls. ``libgloss`` should then - provide the syscalls, ``crt0.o`` and other functions that are no - longer part of ``newlib`` itself. If you are using - ``TCLIBC = "newlib"`` this now means that you must link applications - with both ``newlib`` and ``libgloss``, whereas before ``newlib`` - would run in many configurations by itself. diff --git a/documentation/ref-manual/migration-3.2.rst b/documentation/ref-manual/migration-3.2.rst deleted file mode 100644 index 39743af70d..0000000000 --- a/documentation/ref-manual/migration-3.2.rst +++ /dev/null @@ -1,313 +0,0 @@ -Moving to the Yocto Project 3.2 Release (gatesgarth) -==================================================== - -This section provides migration information for moving to the Yocto -Project 3.2 Release (codename "gatesgarth") from the prior release. - -.. _migration-3.2-minimum-system-requirements: - -Minimum system requirements ---------------------------- - -``gcc`` version 6.0 is now required at minimum on the build host. For older -host distributions where this is not available, you can use the -``buildtools-extended-tarball`` (easily installable using -``scripts/install-buildtools``). - - -.. _migration-3.2-removed-recipes: - -Removed recipes ---------------- - -The following recipes have been removed: - -- ``bjam-native``: replaced by ``boost-build-native`` -- ``avahi-ui``: folded into the main ``avahi`` recipe - the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``. -- ``build-compare``: no longer needed with the removal of the ``packagefeed-stability`` class -- ``dhcp``: obsolete, functionally replaced by ``dhcpcd`` and ``kea`` -- ``libmodulemd-v1``: replaced by ``libmodulemd`` -- ``packagegroup-core-device-devel``: obsolete - - -.. _migration-3.2-removed-classes: - -Removed classes ---------------- - -The following classes (.bbclass files) have been removed: - -- ``spdx``: obsolete - the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement. - -- ``packagefeed-stability``: this class had become obsolete with the advent of hash equivalence and reproducible builds. - - -pseudo path filtering and mismatch behaviour --------------------------------------------- - -pseudo now operates on a filtered subset of files. This is a significant change -to the way pseudo operates within OpenEmbedded - by default, pseudo monitors and -logs (adds to its database) any file created or modified whilst in a ``fakeroot`` -environment. However, there are large numbers of files that we simply don't care -about the permissions of whilst in that ``fakeroot`` context, for example ${:term:`S`}, ${:term:`B`}, ${:term:`T`}, -${:term:`SSTATE_DIR`}, the central sstate control directories, and others. - -As of this release, new functionality in pseudo is enabled to ignore these -directory trees (controlled using a new :term:`PSEUDO_IGNORE_PATHS` variable) -resulting in a cleaner database with less chance of "stray" mismatches if files -are modified outside pseudo context. It also should reduce some overhead from -pseudo as the interprocess round trip to the server is avoided. - -There is a possible complication where some existing recipe may break, for -example, a recipe was found to be writing to ``${B}/install`` for -``make install`` in ``do_install`` and since ``${B}`` is listed as not to be tracked, -there were errors trying to ``chown root`` for files in this location. Another -example was the ``tcl`` recipe where the source directory ``S`` is set to a -subdirectory of the source tree but files were written out to the directory -structure above that subdirectory. For these types of cases in your own recipes, -extend ``PSEUDO_IGNORE_PATHS`` to cover additional paths that pseudo should not -be monitoring. - -In addition, pseudo's behaviour on mismatches has now been changed - rather -than doing what turns out to be a rather dangerous "fixup" if it sees a file -with a different path but the same inode as another file it has previously seen, -pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` -that explains how to deal with this. - - -.. _migration-3.2-multilib-mlprefix: - -``MLPREFIX`` now required for multilib when runtime dependencies conditionally added ------------------------------------------------------------------------------------- - -In order to solve some previously intractable problems with runtime -dependencies and multilib, a change was made that now requires the :term:`MLPREFIX` -value to be explicitly prepended to package names being added as -dependencies (e.g. in :term:`RDEPENDS` and :term:`RRECOMMENDS` values) -where the dependency is conditionally added. - -If you have anonymous python or in-line python conditionally adding -dependencies in your custom recipes, and you intend for those recipes to -work with multilib, then you will need to ensure that ``${MLPREFIX}`` -is prefixed on the package names in the dependencies, for example -(from the ``glibc`` recipe): :: - - RRECOMMENDS_${PN} = "${@bb.utils.contains('DISTRO_FEATURES', 'ldconfig', '${MLPREFIX}ldconfig', '', d)}" - -This also applies when conditionally adding packages to :term:`PACKAGES` where -those packages have dependencies, for example (from the ``alsa-plugins`` recipe): :: - - PACKAGES += "${@bb.utils.contains('PACKAGECONFIG', 'pulseaudio', 'alsa-plugins-pulseaudio-conf', '', d)}" - ... - RDEPENDS_${PN}-pulseaudio-conf += "\ - ${MLPREFIX}libasound-module-conf-pulse \ - ${MLPREFIX}libasound-module-ctl-pulse \ - ${MLPREFIX}libasound-module-pcm-pulse \ - " - - -.. _migration-3.2-packagegroup-core-device-devel: - -packagegroup-core-device-devel no longer included in images built for qemu* machines ------------------------------------------------------------------------------------- - -``packagegroup-core-device-devel`` was previously added automatically to -images built for ``qemu*`` machines, however the purpose of the group and what -it should contain is no longer clear, and in general, adding userspace -development items to images is best done at the image/class level; thus this -packagegroup was removed. - -This packagegroup previously pulled in the following: - -- ``distcc-config`` -- ``nfs-export-root`` -- ``bash`` -- ``binutils-symlinks`` - -If you still need any of these in your image built for a ``qemu*`` machine -then you will add them explicitly to :term:`IMAGE_INSTALL` or another -appropriate place in the dependency chain for your image (if you have not -already done so). - - -.. _migration-3.2-dhcp: - -DHCP server/client replaced ---------------------------- - -The ``dhcp`` software package has become unmaintained and thus has been -functionally replaced by ``dhcpcd`` (client) and ``kea`` (server). You will -need to replace references to the recipe/package names as appropriate - most -commonly, at the package level ``dhcp-client`` should be replaced by -``dhcpcd`` and ``dhcp-server`` should be replaced by ``kea``. If you have any -custom configuration files for these they will need to be adapted - refer to -the upstream documentation for ``dhcpcd`` and ``kea`` for further details. - - -.. _migration-3.2-packaging-changes: - -Packaging changes ------------------ - -- ``python3``: the ``urllib`` python package has now moved into the core package, as it is used more commonly than just netclient (e.g. email, xml, mimetypes, pydoc). In addition, the ``pathlib`` module is now also part of the core package. - -- ``iptables``: ``iptables-apply`` and ``ip6tables-apply`` have been split out to their own package to avoid a bash dependency in the main ``iptables`` package - - -.. _migration-3.2-package-qa-checks: - -Package QA check changes ------------------------- - -Previously, the following package QA checks triggered warnings, however they can -be indicators of genuine underlying problems and are therefore now treated as -errors: - -- :ref:`already-stripped <qa-check-already-stripped>` -- :ref:`compile-host-path <qa-check-compile-host-path>` -- :ref:`installed-vs-shipped <qa-check-installed-vs-shipped>` -- :ref:`ldflags <qa-check-ldflags>` -- :ref:`pn-overrides <qa-check-pn-overrides>` -- :ref:`rpaths <qa-check-rpaths>` -- :ref:`staticdev <qa-check-staticdev>` -- :ref:`unknown-configure-option <qa-check-unknown-configure-option>` -- :ref:`useless-rpaths <qa-check-useless-rpaths>` - -In addition, the following new checks were added and default to triggering an error: - -- :ref:`shebang-size <qa-check-shebang-size>`: Check for shebang (#!) lines longer than 128 characters, which can give an error at runtime depending on the operating system. - -- :ref:`unhandled-features-check <qa-check-unhandled-features-check>`: Check if any of the variables supported by the :ref:`features_check <ref-classes-features_check>` class is set while not inheriting the class itself. - -- :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its packages, and does not inherit the :ref:`update-alternatives <ref-classes-update-alternatives>` class. - -- A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable - remove any instances of these in your recipes if the warning is displayed. - - -.. _migration-3.2-src-uri-file-globbing: - -Globbing no longer supported in ``file://`` entries in ``SRC_URI`` ------------------------------------------------------------------- - -Globbing (``*`` and ``?`` wildcards) in ``file://`` URLs within :term:`SRC_URI` -did not properly support file checksums, thus changes to the source files -would not always change the do_fetch task checksum, and consequently would -not ensure that the changed files would be incorporated in subsequent builds. - -Unfortunately it is not practical to make globbing work generically here, so -the decision was taken to remove support for globs in ``file://`` URLs. -If you have any usage of these in your recipes, then you will now need to -either add each of the files that you expect to match explicitly, or -alternatively if you still need files to be pulled in dynamically, put the -files into a subdirectory and reference that instead. - - -.. _migration-3.2-deploydir-clean: - -deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` ----------------------------------------------------------- - -``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of ``DEPLOYDIR`` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. - -Most recipes and classes that inherit the ``deploy`` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead. - - -.. _migration-3.2-nativesdk-sdk-provides-dummy: - -Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` -------------------------------------------------------------------------------- - -All ``nativesdk`` packages require ``/bin/sh`` due to their postinstall scriptlets, thus this package has to be dummy-provided within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have a custom SDK recipe (or your own SDK-style recipe similar to e.g. ``buildtools-tarball``), you will need to ensure ``nativesdk-sdk-provides-dummy`` or an equivalent is included in :term:`TOOLCHAIN_HOST_TASK`. - - -``ld.so.conf`` now moved back to main ``glibc`` package -------------------------------------------------------- - -There are cases where one doesn't want ``ldconfig`` on target (e.g. for -read-only root filesystems, it's rather pointless), yet one still -needs ``/etc/ld.so.conf`` to be present at image build time: - -When some recipe installs libraries to a non-standard location, and -therefore installs in a file in ``/etc/ld.so.conf.d/foo.conf``, we -need ``/etc/ld.so.conf`` containing: :: - - include /etc/ld.so.conf.d/*.conf - -in order to get those other locations picked up. - -Thus ``/etc/ld.so.conf`` is now in the main ``glibc`` package so that -there's always an ``ld.so.conf`` present when the build-time ``ldconfig`` -runs towards the end of image construction. - -The ``ld.so.conf`` and ``ld.so.conf.d/*.conf`` files do not take up -significant space (at least not compared to the ~700kB ``ldconfig`` binary), and they -might be needed in case ``ldconfig`` is installable, so they are left -in place after the image is built. Technically it would be possible to -remove them if desired, though it would not be trivial if you still -wanted the build-time ldconfig to function (:term:`ROOTFS_POSTPROCESS_COMMAND` -will not work as ``ldconfig`` is run after the functions referred to -by that variable). - - -.. _migration-3.2-virgl: - -Host DRI drivers now used for GL support within ``runqemu`` ------------------------------------------------------------ - -``runqemu`` now uses the mesa-native libraries everywhere virgl is used -(i.e. when ``gl``, ``gl-es`` or ``egl-headless`` options are specified), -but instructs them to load DRI drivers from the host. Unfortunately this -may not work well with proprietary graphics drivers such as those from -Nvidia; if you are using such drivers then you may need to switch to an -alternative (such as Nouveau in the case of Nvidia hardware) or avoid -using the GL options. - - -.. _migration-3.2-initramfs-suffix: - -initramfs images now use a blank suffix ---------------------------------------- - -The reference initramfs images (``core-image-minimal-initramfs``, -``core-image-tiny-initramfs`` and ``core-image-testmaster-initramfs``) now -set an empty string for :term:`IMAGE_NAME_SUFFIX`, which otherwise defaults -to ``".rootfs"``. These images aren't root filesystems and thus the rootfs -label didn't make sense. If you are looking for the output files generated -by these image recipes directly then you will need to adapt to the new -naming without the ``.rootfs`` part. - - -.. _migration-3.2-image-artifact-names: - -Image artifact name variables now centralised in image-artifact-names class ---------------------------------------------------------------------------- - -The defaults for the following image artifact name variables have been moved -from bitbake.conf to a new ``image-artifact-names`` class: - -- :term:`IMAGE_BASENAME` -- :term:`IMAGE_LINK_NAME` -- :term:`IMAGE_NAME` -- :term:`IMAGE_NAME_SUFFIX` -- :term:`IMAGE_VERSION_SUFFIX` - -Image-related classes now inherit this class, and typically these variables -are only referenced within image recipes so those will be unaffected by this -change. However if you have references to these variables in either a recipe -that is not an image or a class that is enabled globally, then those will -now need to be changed to ``inherit image-artifact-names``. - - -.. _migration-3.2-misc: - -Miscellaneous changes ---------------------- - -- Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed - replace any remaining instances with :term:`FEATURE_PACKAGES`. -- The ``FILESPATHPKG`` variable, having been previously deprecated, has now been removed. Replace any remaining references with appropriate use of :term:`FILESEXTRAPATHS`. -- Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored. -- ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment. -- ``oe.utils.is_machine_specific()`` and ``oe.utils.machine_paths()`` have been removed as their utility was questionable. In the unlikely event that you have references to these in your own code, then the code will need to be reworked. -- The ``i2ctransfer`` module is now disabled by default when building ``busybox`` in order to be consistent with disabling the other i2c tools there. If you do wish the i2ctransfer module to be built in BusyBox then add ``CONFIG_I2CTRANSFER=y`` to your custom BusyBox configuration. -- In the ``Upstream-Status`` header convention for patches, ``Accepted`` has been replaced with ``Backport`` as these almost always mean the same thing i.e. the patch is already upstream and may need to be removed in a future recipe upgrade. If you are adding these headers to your own patches then use ``Backport`` to indicate that the patch has been sent upstream. -- The ``tune-supersparc.inc`` tune file has been removed as it does not appear to be widely used and no longer works. diff --git a/documentation/ref-manual/migration-3.3.rst b/documentation/ref-manual/migration-3.3.rst deleted file mode 100644 index 4fb51a39dc..0000000000 --- a/documentation/ref-manual/migration-3.3.rst +++ /dev/null @@ -1,168 +0,0 @@ -Moving to the Yocto Project 3.3 Release (hardknott) -=================================================== - -This section provides migration information for moving to the Yocto -Project 3.3 Release (codename "hardknott") from the prior release. - - -.. _migration-3.3-minimum-system-requirements: - -Minimum system requirements ---------------------------- - -You will now need at least Python 3.6 installed on your build host. Most recent -distributions provide this, but should you be building on a distribution that -does not have it, you can use the ``buildtools-tarball`` (easily installable -using ``scripts/install-buildtools``) - see -:ref:`ref-manual/system-requirements:required git, tar, python and gcc versions` -for details. - - -.. _migration-3.3-removed-recipes: - -Removed recipes ---------------- - -The following recipes have been removed: - -- ``go-dep``: obsolete with the advent of go modules -- ``gst-validate``: replaced by ``gst-devtools`` -- ``linux-yocto``: removed 5.8 version recipes (5.4 / 5.10 still provided) -- ``vulkan-demos``: replaced by ``vulkan-samples`` - - -.. _migration-3.3-common-license-only-versions: - -Single version common license file naming ------------------------------------------ - -Some license files in ``meta/files/common-licenses`` have been renamed to match -current SPDX naming conventions: - -- AGPL-3.0 -> AGPL-3.0-only -- GPL-1.0 -> GPL-1.0-only -- GPL-2.0 -> GPL-2.0-only -- GPL-3.0 -> GPL-3.0-only -- LGPL-2.0 -> LGPL-2.0-only -- LGPL-2.1 -> LGPL-2.1-only -- LGPL-3.0 -> LGPL-3.0-only - -Additionally, corresponding "-or-later" suffixed files have been added e.g. -``GPL-2.0-or-later``. - -It is not required that you change :term:`LICENSE` values as there are mappings -from the original names in place; however, in rare cases where you have a recipe -which sets :term:`LIC_FILES_CHKSUM` to point to file(s) in -``meta/files/common-licenses`` (which in any case is not recommended) you will -need to update those. - - -.. _migration-3.3-python3targetconfig: - -New ``python3targetconfig`` class ---------------------------------- - -A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has been -created for situations where you would previously have inherited the -``python3native`` class but need access to target configuration data (such as -correct installation directories). Recipes where this situation applies should -be changed to inherit ``python3targetconfig`` instead of ``python3native``. This -also adds a dependency on target ``python3``, so it should only be used where -appropriate in order to avoid unnecessarily lengthening builds. - -Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``, -``python3-pycairo``. - - -.. _migration-3.3-distutils-path: - -``setup.py`` path for python modules ------------------------------------- - -In a Python module, sometimes ``setup.py`` can be buried deep in the -source tree. Previously this was handled in recipes by setting :term:`S` to -point to the subdirectory within the source where ``setup.py`` is located. -However with the recent :ref:`pseudo <overview-manual/concepts:fakeroot and pseudo>` -changes, some Python modules make changes to files beneath ``${S}``, for -example:: - - S = "${WORKDIR}/git/python/pythonmodule" - -then in ``setup.py`` it works with source code in a relative fashion, such -as ``../../src``. This causes pseudo to abort as it isn't able to track -the paths properly. This release introduces a new :term:`DISTUTILS_SETUP_PATH` -variable so that recipes can specify it explicitly, for example:: - - S = "${WORKDIR}/git" - DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule" - -Recipes that inherit from :ref:`distutils3 <ref-classes-distutils3>` (or -:ref:`setuptools3 <ref-classes-setuptools3>` which itself inherits -:ref:`distutils3 <ref-classes-distutils3>`) that also set :term:`S` to -point to a Python module within a subdirectory in the aforementioned -manner should be changed to set :term:`DISTUTILS_SETUP_PATH` instead. - - -.. _migration-3.3-bitbake: - -BitBake changes ---------------- - -- BitBake is now configured to use a default ``umask`` of ``022`` for all tasks - (specified via a new :term:`BB_DEFAULT_UMASK` variable). If needed, ``umask`` can - still be set on a per-task basis via the ``umask`` varflag on the task - function, but that is unlikely to be necessary in most cases. - -- If a version specified in :term:`PREFERRED_VERSION` is not available this - will now trigger a warning instead of just a note, making such issues more - visible. - - -.. _migration-3.3-packaging: - -Packaging changes ------------------ - -The following packaging changes have been made; in all cases the main package -still depends upon the split out packages so you should not need to do anything -unless you want to take advantage of the improved granularity: - -- ``dbus``: ``-common`` and ``-tools`` split out -- ``iproute2``: split ``ip`` binary to its own package -- ``net-tools``: split ``mii-tool`` into its own package -- ``procps``: split ``ps`` and ``sysctl`` into their own packages -- ``rpm``: split build and extra functionality into separate packages -- ``sudo``: split ``sudo`` binary into ``sudo-sudo`` and libs into ``sudo-lib`` -- ``systemtap``: examples, python scripts and runtime material split out -- ``util-linux``: ``libuuid`` has been split out to its own - ``util-linux-libuuid`` recipe (and corresponding packages) to avoid circular - dependencies if ``libgcrypt`` support is enabled in ``util-linux``. - (``util-linux`` depends upon ``util-linux-libuuid``.) - - -.. _migration-3.3-misc: - -Miscellaneous changes ---------------------- - -- The default poky :term:`DISTRO_VERSION` value now uses the core metadata's - git hash (i.e. :term:`METADATA_REVISION`) rather than the date (i.e. - :term:`DATE`) to reduce one small source of non-reproducibility. You can - of course specify your own :term:`DISTRO_VERSION` value as desired - (particularly if you create your own custom distro configuration). -- ``adwaita-icon-theme`` version 3.34.3 has been added back, and is selected - as the default via :term:`PREFERRED_VERSION` in - ``meta/conf/distro/include/default-versions.inc`` due to newer versions - not working well with ``librsvg`` 2.40. ``librsvg`` is not practically - upgradeable at the moment as it has been ported to Rust, and Rust is not - (yet) in OE-Core, but this will change in a future release. -- ``ffmpeg`` is now configured to disable GPL-licensed portions by default - to make it harder to accidentally violate the GPL. To explicitly enable GPL - licensed portions, add ``gpl`` to :term:`PACKAGECONFIG` for ``ffmpeg`` - using a bbappend (or use ``PACKAGECONFIG_append_pn-ffmpeg = " gpl"`` in - your configuration.) -- ``connman`` is now set to conflict with ``systemd-networkd`` as they - overlap functionally and may interfere with each other at runtime. -- Canonical SPDX license names are now used in image license manifests in - order to avoid aliases of the same license from showing up together (e.g. - ``GPLv2`` and ``GPL-2.0``) diff --git a/documentation/ref-manual/migration-general.rst b/documentation/ref-manual/migration-general.rst deleted file mode 100644 index 182482ec43..0000000000 --- a/documentation/ref-manual/migration-general.rst +++ /dev/null @@ -1,54 +0,0 @@ -General Migration Considerations -================================ - -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. - -- *Dealing with Customized Recipes*: - - 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. - - 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. - - The better solution (where practical) is to use append files - (``*.bbappend``) 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. - -- *Updating Append Files*: - - Since append files generally only contain - your customizations, they often do not need to be adjusted for new - releases. However, if the ``.bbappend`` 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 (``.bb``) will trigger an error - during parsing. - - 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. - - - diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst deleted file mode 100644 index a01d4ee143..0000000000 --- a/documentation/ref-manual/migration.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. SPDX-License-Identifier: CC-BY-SA-2.0-UK - -****************************************** -Migrating to a Newer Yocto Project Release -****************************************** - -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. - -.. toctree:: - - migration-general - migration-1.3 - migration-1.4 - migration-1.5 - migration-1.6 - migration-1.7 - migration-1.8 - migration-2.0 - migration-2.1 - migration-2.2 - migration-2.3 - migration-2.4 - migration-2.5 - migration-2.6 - migration-2.7 - migration-3.0 - migration-3.1 - migration-3.2 - migration-3.3 - diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index 6cb767d934..53b1836e74 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst @@ -28,7 +28,7 @@ error form along with an explanation. .. note:: - At the end of each message, the name of the associated QA test (as - listed in the ":ref:`insane.bbclass <ref-classes-insane>`" + listed in the ":ref:`ref-classes-insane`" section) appears within square brackets. - As mentioned, this list of error and warning messages is for QA @@ -88,7 +88,7 @@ Errors and Warnings A file-level dependency has been identified from the specified package on the specified files, but there is no explicit corresponding entry in :term:`RDEPENDS`. If - particular files are required at runtime then ``RDEPENDS`` should be + particular files are required at runtime then :term:`RDEPENDS` should be declared in the recipe to ensure the packages providing them are built. @@ -97,14 +97,14 @@ Errors and Warnings - ``<packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps]`` - A runtime dependency exists between the two specified packages, but + 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 ``RDEPENDS`` for the dependency. + to add an explicit :term:`RDEPENDS` for the dependency.  .. _qa-check-dev-so: @@ -151,10 +151,19 @@ Errors and Warnings occur if you add a path which contains a ``.debug`` directory and do not explicitly add the ``.debug`` directory to the ``-dbg`` package. If this is the case, add the ``.debug`` directory explicitly to - ``FILES_${PN}-dbg``. See :term:`FILES` for additional - information on ``FILES``. + ``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]`` @@ -221,10 +230,9 @@ Errors and Warnings 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: - :: + you could add the following to your recipe:: - CFLAGS_append = " -fPIC " + CFLAGS:append = " -fPIC " For more information on text relocations at runtime, see https://www.akkadia.org/drepper/textrelocs.html. @@ -236,12 +244,11 @@ Errors and Warnings This indicates that binaries produced when building the recipe have not been linked with the :term:`LDFLAGS` options - provided by the build system. Check to be sure that the ``LDFLAGS`` + 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 ``LDFLAGS`` using + for this situation is to pass in :term:`LDFLAGS` using :term:`TARGET_CC_ARCH` within the recipe as - follows: - :: + follows:: TARGET_CC_ARCH += "${LDFLAGS}" @@ -265,8 +272,7 @@ Errors and Warnings 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: - :: + ``do_install:append`` within the recipe as follows:: rm ${D}${infodir}/dir  @@ -306,7 +312,7 @@ Errors and Warnings - ``<packagename> rdepends on <debug_packagename> [debug-deps]`` - A dependency exists between the specified non-dbg package (i.e. a + 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: @@ -329,7 +335,7 @@ Errors and Warnings - ``<packagename> rdepends on <dev_packagename> [dev-deps]`` - A dependency exists between the specified non-dev package (a package + 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: @@ -350,7 +356,7 @@ Errors and Warnings  .. _qa-check-dep-cmp: -- ``<var>_<packagename> is invalid: <comparison> (<value>) only comparisons <, =, >, <=, and >= are allowed [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`, @@ -406,7 +412,7 @@ Errors and Warnings If your recipe name does not match this, or you add packages to :term:`PACKAGES` that do not conform to the convention, then you will receive this error. Rename your recipe. Or, - if you have added a non-conforming package name to ``PACKAGES``, + if you have added a non-conforming package name to :term:`PACKAGES`, change the package name appropriately.  @@ -434,13 +440,13 @@ Errors and Warnings The specified recipe has a name (:term:`PN`) value that appears in :term:`OVERRIDES`. If a recipe is named - such that its ``PN`` value matches something already in ``OVERRIDES`` - (e.g. ``PN`` happens to be the same as :term:`MACHINE` + 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 ``PN`` is being set explicitly, change the - ``PN`` value) so that the conflict does not occur. See + ``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.  @@ -457,17 +463,17 @@ Errors and Warnings ``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 + 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]`` +- ``recipe uses DEPENDS:${PN}, should use DEPENDS [pkgvarcheck]`` - This check looks for instances of setting ``DEPENDS_${PN}`` + This check looks for instances of setting ``DEPENDS:${PN}`` which is erroneous (:term:`DEPENDS` is a recipe-wide variable and thus it is not correct to specify it for a particular package, nor will such - an assignment actually work.) Set ``DEPENDS`` instead. + an assignment actually work.) Set :term:`DEPENDS` instead. .. _qa-check-already-stripped: @@ -502,7 +508,7 @@ Errors and Warnings Package names must appear only once in the :term:`PACKAGES` variable. You might receive this - error if you are attempting to add a package to ``PACKAGES`` that is + error if you are attempting to add a package to :term:`PACKAGES` that is already in the variable's value.  @@ -526,11 +532,11 @@ Errors and Warnings in an image later on in the build process. You need to do one of the following: - - Add the files to ``FILES`` for the package you want them to appear - in (e.g. ``FILES_${``\ :term:`PN`\ ``}`` for the main + - 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 ``do_install`` task if the + - Delete the files at the end of the :ref:`ref-tasks-install` task if the files are not needed in any package.  @@ -542,18 +548,18 @@ Errors and Warnings when a recipe has been renamed. However, if that is not the case, the message might indicate that a private version of a library is being erroneously picked up as the provider for a common library. If that - is the case, you should add the library's ``.so`` file name to + 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]`` +- ``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 + words, any license in ``LICENSE:*`` should also appear in :term:`LICENSE`. @@ -573,10 +579,10 @@ Errors and Warnings - ``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 mime - class which will ensure that these get properly installed. Either - add ``inherit mime`` to the recipe or remove the files at the - ``do_install`` step if they are not needed. + ``${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: @@ -584,10 +590,10 @@ Errors and Warnings - ``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 mime-xdg class that is required in - order for that to be activated. Either add ``inherit mime`` to the - recipe or remove the files at the ``do_install`` step if they are not - needed. + 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: @@ -596,7 +602,7 @@ Errors and Warnings GitHub provides "archive" tarballs, however these can be re-generated on the fly and thus the file's signature will not necessarily match that - in the SRC_URI checksums in future leading to build failures. It is + 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. @@ -607,26 +613,28 @@ Errors and Warnings so using ${:term:`BPN`} rather than ${:term:`PN`} as the latter will change for different variants of the same recipe e.g. when :term:`BBCLASSEXTEND` or multilib are being used. This check will fail if a reference to ``${PN}`` - is found within the ``SRC_URI`` value - change it to ``${BPN}`` instead. + 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:`features_check <ref-classes-features_check>` - class supports (e.g. :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe - inherits ``features_check`` in order for the requirement to actually work. If - you are seeing this message, either add ``inherit features_check`` to your recipe - or remove the reference to the variable if it is not needed. + 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]`` +- ``<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:`update-alternatives <ref-classes-update-alternatives>` such + 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. @@ -647,7 +655,7 @@ Errors and Warnings - ``<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:`cpan <ref-classes-cpan>` class + 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 @@ -661,8 +669,8 @@ Errors and Warnings If ``usrmerge`` is in :term:`DISTRO_FEATURES`, this check will ensure that no package installs files to root (``/bin``, ``/sbin``, ``/lib``, ``/lib64``) directories. If you are seeing this - message, it indicates that the ``do_install`` step (or perhaps the build process that - ``do_install`` is calling into, e.g. ``make install`` is using hardcoded paths instead + 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. @@ -671,11 +679,11 @@ Errors and Warnings - ``Fuzz detected: <patch output> [patch-fuzz]`` - This check looks for evidence of "fuzz" when applying patches within the ``do_patch`` + 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: :: + Patch to be applied:: --- filename +++ filename @@ -687,7 +695,7 @@ Errors and Warnings context line 5 context line 6 - Original source code: :: + Original source code:: different context line 1 different context line 2 @@ -696,7 +704,7 @@ Errors and Warnings different context line 5 different context line 6 - Outcome (after applying patch with fuzz): :: + Outcome (after applying patch with fuzz):: different context line 1 different context line 2 @@ -716,14 +724,14 @@ Errors and Warnings *How to eliminate patch fuzz warnings* Use the ``devtool`` command as explained by the warning. First, unpack the - source into devtool workspace: :: + 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. + the workspace --- with the patch context updated. - Then, replace the patches in the recipe layer: :: + Then, replace the patches in the recipe layer:: devtool finish --force-patch-refresh <recipe> <layer_path> @@ -742,6 +750,64 @@ Errors and Warnings 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 =================================== @@ -752,10 +818,10 @@ either raise a warning or an error message, using the variables, respectively. You can also disable checks within a particular recipe using :term:`INSANE_SKIP`. For information on how to work with the QA checks, see the -":ref:`insane.bbclass <ref-classes-insane>`" section. +":ref:`ref-classes-insane`" section. .. note:: - Please keep in mind that the QA checks exist in order to detect real + 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/release-process.rst b/documentation/ref-manual/release-process.rst index 93ab6ed08a..920794679d 100644 --- a/documentation/ref-manual/release-process.rst +++ b/documentation/ref-manual/release-process.rst @@ -14,13 +14,13 @@ Major and Minor Release Cadence The Yocto Project delivers major releases (e.g. &DISTRO;) using a six month cadence roughly timed each April and October of the year. -Following are examples of some major YP releases with their codenames +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. - - 2.2 (Morty) - - 2.1 (Krogoth) - - 2.0 (Jethro) + - 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 @@ -29,12 +29,12 @@ major holidays in various geographies. The Yocto project delivers minor (point) releases on an unscheduled basis and are usually driven by the accumulation of enough significant -fixes or enhancements to the associated major release. Following are -some example past point releases: +fixes or enhancements to the associated major release. +Some example past point releases are: - - 2.1.1 - - 2.1.2 - - 2.2.1 + - 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 @@ -62,8 +62,10 @@ codename are likely to be compatible and thus work together. 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`. +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 ====================== @@ -82,18 +84,54 @@ stable release. 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 + exception to this policy occurs when there is a strong reason such as the fix happens to also be the preferred upstream approach. -Stable release branches have strong maintenance for about a year after -their initial release. Should significant issues be found for any -release regardless of its age, fixes could be backported to older -releases. For issues that are not backported given an older release, -Community LTS trees and branches exist where community members share -patches for older releases. However, these types of patches do not go -through the same release process as do point releases. You can find more -information about stable branch maintenance at -:yocto_wiki:`/Stable_branch_maintenance`. +.. _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 ============================= @@ -105,7 +143,7 @@ Additionally, because the test strategies are visible to you as a developer, you can validate your projects. This section overviews the available test infrastructure used in the Yocto Project. For information on how to run available tests on your projects, see the -":ref:`dev-manual/common-tasks:performing automated runtime testing`" +":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 @@ -115,58 +153,49 @@ consists of the following pieces: - ``bitbake-selftest``: A standalone command that runs unit tests on key pieces of BitBake and its fetchers. -- :ref:`sanity.bbclass <ref-classes-sanity>`: This automatically +- :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:`insane.bbclass <ref-classes-insane>`: This class checks the +- :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:`testimage.bbclass <ref-classes-testimage*>`: This class +- :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/common-tasks:testing packages with ptest>`: +- :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 combination BitBake invocations. These tests +- ``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. - .. note:: - - Running ``oe-selftest`` requires host packages beyond the "Essential" - grouping. See the :ref:`ref-manual/system-requirements:required packages for the build host` - section for more information. - Originally, much of this testing was done manually. However, significant effort has been made to automate the tests so that more people can use them and the Yocto Project development team can run them faster and more efficiently. -The Yocto Project's main Autobuilder (&YOCTO_AB_URL;) -publicly tests each Yocto Project release's code in the -:term:`OpenEmbedded-Core (OE-Core)`, Poky, and BitBake repositories. The testing -occurs for both the current state of the "master" branch and also for +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 -"ross/mut" branch in the ``poky-contrib`` repository (i.e. the -master-under-test branch) or in the "master-next" branch in the ``poky`` -repository. +in the "master-next" branch in the :yocto_git:`poky </poky>` repository. .. note:: - You can find all these branches in the Yocto Project - Source Repositories - . + 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 diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index 663f0d96d5..4eaaca942e 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -10,7 +10,7 @@ Introduction ============ 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 +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. @@ -23,8 +23,7 @@ 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 ":ref:`dev-manual/common-tasks:submitting a change to the yocto project`" section in the -Yocto Project Development Tasks Manual. +code, see the :doc:`../contributor-guide/index`. .. _resources-bugtracker: @@ -43,12 +42,11 @@ 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). -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 +For a general procedure and guidelines on how to use Bugzilla to submit a bug against the Yocto Project, see the following: -- The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" - section in the Yocto Project Development Tasks Manual. +- 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>` @@ -59,44 +57,49 @@ For information on Bugzilla in general, see https://www.bugzilla.org/about/. Mailing lists ============= -A number of mailing lists maintained by the Yocto Project exist as well +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 +- :yocto_lists:`/g/yocto` --- general Yocto Project discussion mailing list. -- :oe_lists:`/g/openembedded-core` - Discussion mailing +- :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 +- :oe_lists:`/g/openembedded-devel` --- discussion mailing list about OpenEmbedded. -- :oe_lists:`/g/bitbake-devel` - Discussion mailing +- :oe_lists:`/g/bitbake-devel` --- discussion mailing list about the :term:`BitBake` build tool. -- :yocto_lists:`/g/poky` - Discussion mailing list +- :yocto_lists:`/g/poky` --- discussion mailing list about :term:`Poky`. -- :yocto_lists:`/g/yocto-announce` - Mailing list to +- :yocto_lists:`/g/yocto-announce` --- mailing list to receive official Yocto Project release and milestone announcements. -For more Yocto Project-related mailing lists, see the -:yocto_home:`Yocto Project Website <>`. +- :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 Freenode are available for the Yocto Project and -Poky discussions: +Two IRC channels on `Libera Chat <https://libera.chat/>`__ +are available for the Yocto Project and OpenEmbedded discussions: - ``#yocto`` -- ``#poky`` +- ``#oe`` .. _resources-links-and-related-documentation: @@ -105,93 +108,96 @@ Links and Related Documentation Here is a list of resources you might find helpful: -- :yocto_home:`The Yocto Project Website <>`\ *:* The home site +- :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 +- :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 +- :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. +- :oe_wiki:`BitBake </BitBake>`: The tool used to process metadata. -- :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive +- :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 +- :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 +- :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 +- :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 +- :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 +- :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 +- :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 +- :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 +- :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. 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. + 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 +- :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 +- :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_wiki:`FAQ </FAQ>`\ *:* A list of commonly asked +- `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. -- *Release Notes:* Features, updates and known issues for the current - release of the Yocto Project. To access the Release Notes, go to the - :yocto_home:`Downloads </software-overview/downloads>` page on - the Yocto Project website and click on the "RELEASE INFORMATION" link - for the appropriate release. +- :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 +- :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>`\ *:* + </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 Freenode are - available for Yocto Project and Poky discussions: ``#yocto`` and - ``#poky``, respectively. +- 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 +- `Quick EMUlator (QEMU) <https://wiki.qemu.org/Index.html>`__: An open-source machine emulator and virtualizer. diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 0f2093a8d4..e4d8b54bb9 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -38,7 +38,7 @@ usually matches the current stable BitBake release from the BitBake project. BitBake, a :term:`Metadata` interpreter, reads the Yocto Project Metadata and runs the tasks defined by that data. Failures are usually caused by errors in your Metadata and not from BitBake -itself; consequently, most users do not need to worry about BitBake. +itself. When you run the ``bitbake`` command, the main BitBake executable (which resides in the ``bitbake/bin/`` directory) starts. Sourcing the @@ -57,9 +57,8 @@ For more information on BitBake, see the :doc:`BitBake User Manual 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`). +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 @@ -68,6 +67,9 @@ 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/`` @@ -150,11 +152,10 @@ BitBake commands. The script uses other scripts within the ``scripts`` directory to do the bulk of the work. When you run this script, your Yocto Project environment is set up, a -:term:`Build Directory` is created, your working -directory becomes the Build Directory, and you are presented with some -simple suggestions as to what to do next, including a list of some -possible targets to build. Here is an example: -:: +: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 @@ -171,29 +172,30 @@ possible targets to build. Here is an example: You can also run generated QEMU images with a command like 'runqemu qemux86-64' The default output of the ``oe-init-build-env`` script is from the -``conf-notes.txt`` file, which is found in the ``meta-poky`` directory +``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 version of this -configuration file to mention the targets defined by your distribution. +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/common-tasks:creating a custom template configuration directory`" +":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 Build Directory argument +By default, running this script without a :term:`Build Directory` argument creates the ``build/`` directory in your current working directory. If -you provide a Build Directory argument when you ``source`` the script, -you direct the OpenEmbedded build system to create a Build Directory of -your choice. For example, the following command creates a Build -Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`: -:: +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/`` directory in the Source +are found by default in the ``meta-poky/conf/templates/default`` directory in the Source Directory. See the -":ref:`dev-manual/common-tasks:creating a custom template configuration directory`" +":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" section in the Yocto Project Development Tasks Manual for more information. @@ -215,14 +217,13 @@ These files are standard top-level files. .. _structure-build: -The Build Directory - ``build/`` -================================ +The Build Directory --- ``build/`` +================================== -The OpenEmbedded build system creates the :term:`Build Directory` -when you run the build environment setup -script :ref:`structure-core-script`. If you do not give the Build -Directory a specific name when you run the setup script, the name -defaults to ``build/``. +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. @@ -233,12 +234,24 @@ is available via the :term:`TOPDIR` variable. ----------------------- The OpenEmbedded build system creates this directory when you enable -build history via the ``buildhistory`` class file. The directory +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/common-tasks:maintaining build output quality`" +":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`` @@ -253,9 +266,9 @@ variables are hard-coded for various reasons but such variables are relatively rare. At a minimum, you would normally edit this file to select the target -``MACHINE``, which package types you wish to use +:term:`MACHINE`, which package types you wish to use (:term:`PACKAGE_CLASSES`), and the location from -which you want to access downloaded files (``DL_DIR``). +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 @@ -263,16 +276,15 @@ OpenEmbedded build system creates it from ``local.conf.sample`` when you :ref:`structure-core-script`. The source ``local.conf.sample`` file used depends on the -``$TEMPLATECONF`` script variable, which defaults to ``meta-poky/conf/`` +: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/`` when you are building from the OpenEmbedded-Core +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: -:: +top-level build environment setup script as follows:: - TEMPLATECONF=your_layer/conf + TEMPLATECONF=your_layer/conf/templates/your_template_name Once the build process gets the sample file, it uses ``sed`` to substitute final @@ -281,10 +293,10 @@ file, it uses ``sed`` to substitute final .. note:: - You can see how the ``TEMPLATECONF`` variable is used by looking at the - ``scripts/oe-setup-builddir``` script in the :term:`Source Directory`. + You can 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`` directory. + the ``meta-poky/conf/templates/default`` directory. .. _structure-build-conf-bblayers.conf: @@ -292,7 +304,7 @@ file, it uses ``sed`` to substitute final ---------------------------- This configuration file defines -:ref:`layers <dev-manual/common-tasks:understanding and creating layers>`, +: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. @@ -303,35 +315,26 @@ you ``source`` the top-level build environment setup script (i.e. :ref:`structure-core-script`). As with the ``local.conf`` file, the source ``bblayers.conf.sample`` -file used depends on the ``$TEMPLATECONF`` script variable, which -defaults to ``meta-poky/conf/`` when you are building from the Yocto -Project development environment, and to ``meta/conf/`` when you are +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: -:: +variable in the top-level build environment setup script as follows:: - TEMPLATECONF=your_layer/conf + 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 ``TEMPLATECONF`` variable ``scripts/oe-setup-builddir`` + 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/`` + version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/templates/default`` directory. -.. _structure-build-conf-sanity_info: - -``build/cache/sanity_info`` ---------------------------- - -This file indicates the state of the sanity checks and is created during -the build. - .. _structure-build-downloads: ``build/downloads/`` @@ -340,7 +343,7 @@ the build. This directory contains downloaded upstream source tarballs. You can reuse the directory for multiple builds or move the directory to another location. You can control the location of this directory through the -``DL_DIR`` variable. +:term:`DL_DIR` variable. .. _structure-build-sstate-cache: @@ -350,7 +353,7 @@ location. You can control the location of this directory through the This directory contains the shared state cache. You can reuse the directory for multiple builds or move the directory to another location. You can control the location of this directory through the -``SSTATE_DIR`` variable. +:term:`SSTATE_DIR` variable. .. _structure-build-tmp: @@ -370,14 +373,15 @@ remove the ``build/sstate-cache`` directory. .. _structure-build-tmp-buildstats: ``build/tmp/buildstats/`` -------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~ -This directory stores the build statistics. +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. @@ -393,7 +397,7 @@ 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 @@ -406,7 +410,7 @@ 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 @@ -415,7 +419,7 @@ 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 @@ -424,27 +428,27 @@ types. .. _structure-build-tmp-deploy-ipk: ``build/tmp/deploy/ipk/`` -------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^ This directory receives ``.ipk`` packages produced by the build process. .. _structure-build-tmp-deploy-licenses: ``build/tmp/deploy/licenses/`` ------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ This directory receives package licensing information. For example, the directory contains sub-directories for ``bash``, ``busybox``, and ``glibc`` (among others) that in turn contain appropriate ``COPYING`` license files with other licensing information. For information on licensing, see the -":ref:`dev-manual/common-tasks:maintaining open source license compliance during your product's lifecycle`" +":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), @@ -463,8 +467,7 @@ 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: -:: +the kernel files:: $ bitbake -c clean virtual/kernel $ bitbake virtual/kernel @@ -472,7 +475,7 @@ the kernel files: .. _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 @@ -484,7 +487,7 @@ 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 @@ -497,7 +500,7 @@ 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` @@ -512,11 +515,11 @@ should be automatic, and recipes should not directly reference .. _structure-build-tmp-sysroots: ``build/tmp/sysroots/`` ------------------------ +~~~~~~~~~~~~~~~~~~~~~~~ Previous versions of the OpenEmbedded build system used to create a -global shared sysroot per machine along with a native sysroot. Beginning -with the 2.3 version of the Yocto Project, sysroots exist in +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. @@ -530,13 +533,12 @@ recipe-specific :term:`WORKDIR` directories. Thus, the .. _structure-build-tmp-stamps: ``build/tmp/stamps/`` ---------------------- +~~~~~~~~~~~~~~~~~~~~~ This directory holds information that BitBake uses for accounting purposes to track what tasks have run and when they have run. The directory is sub-divided by architecture, package name, and version. -Following is an example: -:: +Here is an example:: stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do @@ -551,17 +553,17 @@ section in the Yocto Project Overview and Concepts Manual. .. _structure-build-tmp-log: ``build/tmp/log/`` ------------------- +~~~~~~~~~~~~~~~~~~ This directory contains general logs that are not otherwise placed using -the package's ``WORKDIR``. Examples of logs are the output from the +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 @@ -575,15 +577,15 @@ It is worth considering the structure of a typical work directory. As an example, consider ``linux-yocto-kernel-3.0`` on the machine ``qemux86`` built within the Yocto Project. For this package, a work directory of ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred -to as the ``WORKDIR``, is created. Within this directory, the source is +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/common-tasks:using quilt in your workflow`" section in +(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 ``WORKDIR``. The most +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 @@ -593,9 +595,9 @@ install" places its output that is then split into sub-packages within .. _structure-build-tmp-work-tunearch-recipename-version: ``build/tmp/work/tunearch/recipename/version/`` ------------------------------------------------ +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The recipe work directory - ``${WORKDIR}``. +The recipe work directory --- ``${WORKDIR}``. As described earlier in the ":ref:`structure-build-tmp-sysroots`" section, @@ -607,7 +609,7 @@ constructed using the architecture of the given build (e.g. name, and the version of the recipe (i.e. :term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`). -A number of key subdirectories exist within each recipe work directory: +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 @@ -629,8 +631,8 @@ A number of key subdirectories exist within each recipe work directory: split into individual packages. - ``${WORKDIR}/packages-split``: Contains the output of the - ``do_package`` task after the output has been split into individual - packages. Subdirectories exist for each individual package created by + :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 @@ -651,7 +653,7 @@ A number of key subdirectories exist within each recipe work directory: .. _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 @@ -660,29 +662,30 @@ recipes. In practice, this is only used for ``gcc`` and its variants .. _structure-meta: -The Metadata - ``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/`` ------------------ +``meta/classes*/`` +------------------ -This directory contains the ``*.bbclass`` files. Class files are used to +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 ``base.bbclass`` file. Examples of other important -classes are ``autotools.bbclass``, which in theory allows any +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 ``kernel.bbclass`` that contains common code +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 -``image.bbclass``, ``rootfs_*.bbclass`` and ``package*.bbclass``. +:ref:`ref-classes-image`, :ref:`ref-classes-rootfs*` and +:ref:`package*.bbclass <ref-classes-package>`. For reference information on classes, see the -":ref:`ref-manual/classes:Classes`" chapter. +":doc:`/ref-manual/classes`" chapter. .. _structure-meta-conf: @@ -700,7 +703,7 @@ 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 @@ -711,11 +714,11 @@ support for a new machine to the Yocto Project, look in this directory. .. _structure-meta-conf-distro: ``meta/conf/distro/`` ---------------------- +~~~~~~~~~~~~~~~~~~~~~ The contents of this directory controls any distribution-specific configurations. For the Yocto Project, the ``defaultsetup.conf`` is the -main file here. This directory includes the versions and the ``SRCDATE`` +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. @@ -723,7 +726,7 @@ 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 @@ -748,7 +751,9 @@ and lists of files and directories with known permissions. ------------- This directory contains OpenEmbedded Python library code used during the -build process. +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: @@ -789,7 +794,7 @@ system. The tools, however, can also be used on targets. 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. +full tool functionality. .. _structure-meta-recipes-gnome: @@ -815,14 +820,6 @@ libraries. This directory contains the kernel and generic applications and libraries that have strong kernel dependencies. -.. _structure-meta-recipes-lsb4: - -``meta/recipes-lsb4/`` ----------------------- - -This directory contains recipes specifically added to support the Linux -Standard Base (LSB) version 4.x. - .. _structure-meta-recipes-multimedia: ``meta/recipes-multimedia/`` 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 index 80378cedb7..0fc92550a5 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst @@ -4,7 +4,7 @@ System Requirements ******************* -Welcome to the Yocto Project Reference Manual! This manual provides +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 @@ -29,46 +29,77 @@ and conceptual information in the :doc:`/overview-manual/index`. For more information about the Yocto Project Documentation set, see the :ref:`ref-manual/resources:links and related documentation` section. -.. _detailed-supported-distros: +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 Yocto Project is supported on the following -distributions: +Currently, the &DISTRO; release ("&DISTRO_NAME;") of the Yocto Project is +supported on the following distributions: -- Ubuntu 16.04 (LTS) +- Ubuntu 20.04 (LTS) -- Ubuntu 18.04 (LTS) +- Ubuntu 22.04 (LTS) -- Ubuntu 20.04 +- Fedora 38 -- Fedora 30 +- CentOS Stream 8 -- Fedora 31 +- Debian GNU/Linux 11 (Bullseye) -- Fedora 32 +- Debian GNU/Linux 12 (Bookworm) -- CentOS 7.x +- OpenSUSE Leap 15.4 -- CentOS 8.x +- AlmaLinux 8 -- Debian GNU/Linux 8.x (Jessie) +- AlmaLinux 9 -- Debian GNU/Linux 9.x (Stretch) +- Rocky 9 -- Debian GNU/Linux 10.x (Buster) +The following distribution versions are still tested, even though the +organizations publishing them no longer make updates publicly available: -- openSUSE Leap 15.1 +- 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, instances might exist where you - encounter a problem while using the Yocto Project on a specific - distribution. + 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 @@ -79,24 +110,29 @@ distributions: 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. + 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, but validation is not performed against build - hosts using WSLv2. + using Windows 10 or later, or Windows Server 2019 or later, but validation + is not performed against build hosts using WSL 2. - - The Yocto Project is not compatible with WSLv1, it is - compatible but not officially supported nor validated with - WSLv2, if you still decide to use WSL please upgrade to WSLv2. + 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 ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" - section in the Yocto Project Development Tasks Manual. - + and the ":doc:`../contributor-guide/report-defect`" + section in the Yocto Project and OpenEmbedded Contributor Guide. Required Packages for the Build Host ==================================== @@ -111,147 +147,83 @@ function. Ubuntu and Debian ----------------- -The following list shows the required packages by function given a -supported Ubuntu or Debian Linux distribution: +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, either of the following - solutions exist: - :: - - $ sudo apt-get build-dep qemu - $ sudo apt-get remove oss4-dev - - - For Debian-8, ``python3-git`` and ``pylint3`` are no longer - available via ``apt-get``. - :: - - $ sudo pip3 install GitPython pylint==1.9.5 + system. If you run into this situation, try either of these solutions:: -- *Essentials:* Packages needed to build an image on a headless system: - :: + $ sudo apt build-dep qemu + $ sudo apt remove oss4-dev - $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; +Here are the packages needed to build Project documentation manuals:: -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: - - $ sudo apt-get install make python3-pip - &PIP3_HOST_PACKAGES_DOC; - - .. note:: - - It is currently not possible to build out documentation from Debian 8 - (Jessie) because of outdated ``pip3`` and ``python3``. ``python3-sphinx`` - is too outdated. + $ sudo apt install git make inkscape texlive-latex-extra + $ sudo apt install sphinx python3-saneyaml python3-sphinx-rtd-theme Fedora Packages --------------- -The following list shows the required packages by function given a -supported Fedora Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system: - :: +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; + $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: +Here are the packages needed to build Project documentation manuals:: - $ sudo dnf install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; + $ sudo dnf install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; openSUSE Packages ----------------- -The following list shows the required packages by function given a -supported openSUSE Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system: - :: +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; + $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: +Here are the packages needed to build Project documentation manuals:: - $ sudo zypper install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; + $ sudo zypper install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; -CentOS-7 Packages ------------------ - -The following list shows the required packages by function given a -supported CentOS-7 Linux distribution: +AlmaLinux Packages +------------------ -- *Essentials:* Packages needed to build an image for a headless - system: - :: +Here are the packages needed to build an image on a headless system +with a supported AlmaLinux distribution:: - $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL; + $ 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 ``makecache`` command consumes additional Metadata from - ``epel-release``. - -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: - - $ sudo yum install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; - -CentOS-8 Packages ------------------ - -The following list shows the required packages by function given a -supported CentOS-8 Linux distribution: - -- *Essentials:* Packages needed to build an image for a headless - system: - :: - - $ sudo dnf install &CENTOS8_HOST_PACKAGES_ESSENTIAL; +.. note:: - .. 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. - - 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 ``PowerTools`` repo provides additional packages such as - ``rpcgen`` and ``texinfo``. + - The ``makecache`` command consumes additional Metadata from + ``epel-release``. - - The ``makecache`` command consumes additional Metadata from - ``epel-release``. +Here are the packages needed to build Project documentation manuals:: -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals: - :: + $ sudo dnf install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; - $ sudo dnf install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; +.. _system-requirements-buildtools: -Required Git, tar, Python and gcc Versions -========================================== +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: @@ -262,10 +234,12 @@ the following version requirements for Git, tar, and Python: - 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 ``buildtools`` tarball that -contains these tools. You can get the tarball one of two ways: download -a pre-built tarball or use BitBake to build the tarball. +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: @@ -273,62 +247,68 @@ 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 ``buildtools-extended`` tarball that +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 ``buildtools`` or ``buildtools-extended`` toolset. +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 buildtools +which you can get these tools. It downloads a pre-built :term:`buildtools` installer and automatically installs the tools for you: -1. Execute the ``install-buildtools`` script. Here is an example: - :: +#. Execute the ``install-buildtools`` script. Here is an example:: $ cd poky - $ scripts/install-buildtools --without-extended-buildtools \ + $ scripts/install-buildtools \ + --without-extended-buildtools \ --base-url &YOCTO_DL_URL;/releases/yocto \ --release yocto-&DISTRO; \ --installer-version &DISTRO; - During execution, the buildtools tarball will be downloaded, the + 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: - :: + script will by default tell the installer to install in:: /path/to/poky/buildtools If your host development system needs the additional tools provided - in the ``buildtools-extended`` tarball, you can instead execute the - ``install-buildtools`` script with the default parameters: - :: + in the :term:`buildtools-extended` tarball, you can instead execute the + ``install-buildtools`` script with the default parameters:: $ cd poky $ scripts/install-buildtools -2. Source the tools environment setup script by using a command like the - following: - :: + 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:: - $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux + $ cd poky + $ scripts/install-buildtools --make-only + +#. Source the tools environment setup script by using a command like the + following:: - Of course, you need to supply your installation directory and be sure to - use the right file (i.e. i586 or x86_64). + $ 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 - ``buildtools-extended`` tarball, additional working versions of tools + :term:`buildtools-extended` tarball, additional working versions of tools including ``gcc``, ``make`` and the other tools included in ``packagegroup-core-buildessential``. @@ -336,70 +316,71 @@ 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 buildtools installer yourself with the following +download and run a pre-built :term:`buildtools` installer yourself with the following steps: -1. Locate and download the ``*.sh`` at &YOCTO_RELEASE_DL_URL;/buildtools/ +#. 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`. -2. Execute the installation script. Here is an example for the - traditional installer: - :: +#. 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: - :: + 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`` -3. Source the tools environment setup script by using a command like the - following: - :: +#. As instructed by the installer script, you will have to source the tools + environment setup script:: - $ source /home/your_username/buildtools/environment-setup-i586-poky-linux - - Of - course, you need to supply your installation directory and be sure to - use the right file (i.e. i585 or x86-64). + $ 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 - ``buildtools-extended`` tarball, additional working versions of tools + :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 buildtools installer applies only when you +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 buildtools +Here are the steps to take to build and run your own :term:`buildtools` installer: -1. On the machine that is able to run BitBake, be sure you have set up +#. On the machine that is able to run BitBake, be sure you have set up your build environment with the setup script (:ref:`structure-core-script`). -2. Run the BitBake command to build the tarball: - :: +#. Run the BitBake command to build the tarball:: $ bitbake buildtools-tarball - or run the BitBake command to build the extended 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 @@ -408,40 +389,37 @@ installer: 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. + "buildtools" or "buildtools-extended" in the name. -3. Transfer the ``.sh`` file from the build host to the machine that +#. Transfer the ``.sh`` file from the build host to the machine that does not meet the Git, tar, or Python (or gcc) requirements. -4. On the machine that does not meet the requirements, run the ``.sh`` - file to install the tools. Here is an example for the traditional - installer: - :: +#. 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 - Here is an example for the extended installer: - :: + 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`` -5. Source the tools environment setup script by using a command like the - following: - :: +#. Source the tools environment setup script by using a command like the + following:: $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux - Of course, you need to supply your installation directory and be sure to - use the right file (i.e. i586 or x86_64). - After you have sourced the setup script, the tools are added to ``PATH`` and any other environment variables required to run the tools are initialized. The results are working versions versions of Git, tar, Python and ``chrpath``. And in the case of the - ``buildtools-extended`` tarball, additional working versions of tools + :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 index 9fe1c296aa..df751d75a3 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -14,8 +14,8 @@ Normal Recipe Build Tasks The following sections describe normal tasks associated with building a recipe. For more information on tasks and dependencies, see the -":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and -":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in 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: @@ -36,7 +36,7 @@ directory set to ``${``\ :term:`B`\ ``}``. The default behavior of this task is to run the ``oe_runmake`` function if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found. -If no such file is found, the ``do_compile`` task does nothing. +If no such file is found, the :ref:`ref-tasks-compile` task does nothing. .. _ref-tasks-compile_ptest_base: @@ -57,8 +57,8 @@ the current working directory set to ``${``\ :term:`B`\ ``}``. The default behavior of this task is to run ``oe_runmake clean`` if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and :term:`CLEANBROKEN` is not set to "1". If no such -file is found or the ``CLEANBROKEN`` variable is set to "1", the -``do_configure`` task does nothing. +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: @@ -78,10 +78,10 @@ task runs with the current working directory set to ``${``\ :term:`B`\ ``}``. Recipes implementing this task should inherit the -:ref:`deploy <ref-classes-deploy>` class and should write the output +:ref:`ref-classes-deploy` class and should write the output to ``${``\ :term:`DEPLOYDIR`\ ``}``, which is not to be -confused with ``${DEPLOY_DIR}``. The ``deploy`` class sets up -``do_deploy`` as a shared state (sstate) task that can be accelerated +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}``. @@ -90,21 +90,19 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``. Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes the sstate mechanism to malfunction. -The ``do_deploy`` task is not added as a task by default and +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: -:: +the following:: addtask deploy after do_compile -Adding ``do_deploy`` after other tasks works the same way. +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 ``base`` class contains the following: - :: + (though it is harmless), because the :ref:`ref-classes-base` class contains the following:: do_build[recrdeptask] += "do_deploy" @@ -112,7 +110,7 @@ Adding ``do_deploy`` after other tasks works the same way. See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`" section in the BitBake User Manual for more information. -If the ``do_deploy`` task re-executes, any previous output is removed +If the :ref:`ref-tasks-deploy` task re-executes, any previous output is removed (i.e. "cleaned"). .. _ref-tasks-fetch: @@ -120,9 +118,9 @@ If the ``do_deploy`` task re-executes, any previous output is removed ``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:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` +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: @@ -130,15 +128,15 @@ module. ``do_image`` ------------ -Starts the image generation process. The ``do_image`` task runs after +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 ``do_image`` task performs pre-processing on the image through the +The :ref:`ref-tasks-image` task performs pre-processing on the image through the :term:`IMAGE_PREPROCESS_COMMAND` and -dynamically generates supporting ``do_image_*`` tasks as needed. +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. @@ -148,13 +146,13 @@ section in the Yocto Project Overview and Concepts Manual. ``do_image_complete`` --------------------- -Completes the image generation process. The ``do_image_complete`` task +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 ``do_image_*`` +pre-processing occurs and through dynamically generated :ref:`do_image_* <ref-tasks-image>` tasks the image is constructed. -The ``do_image_complete`` task performs post-processing on the image +The :ref:`do_image_complete <ref-tasks-image-complete>` task performs post-processing on the image through the :term:`IMAGE_POSTPROCESS_COMMAND`. @@ -170,9 +168,9 @@ section in the Yocto Project Overview and Concepts Manual. Copies files that are to be packaged into the holding area ``${``\ :term:`D`\ ``}``. This task runs with the current working directory set to ``${``\ :term:`B`\ ``}``, which is the -compilation directory. The ``do_install`` task, as well as other tasks +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`, ``do_package_write_*``, and +: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>`. @@ -189,11 +187,11 @@ that either directly or indirectly depend on the installed files (e.g. - The ``install`` utility. This utility is the preferred method. - - The ``cp`` command with the "--no-preserve=ownership" option. + - The ``cp`` command with the ``--no-preserve=ownership`` option. - - The ``tar`` command with the "--no-same-owner" option. See the - ``bin_package.bbclass`` file in the ``meta/classes`` directory of - the :term:`Source Directory` for an example. + - 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: @@ -214,7 +212,7 @@ based on available packages and files. This task makes use of the :term:`PACKAGES` and :term:`FILES` variables. -The ``do_package`` task, in conjunction with the +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 @@ -227,7 +225,7 @@ section in the Yocto Project Overview and Concepts Manual. ----------------- Runs QA checks on packaged files. For more information on these checks, -see the :ref:`insane <ref-classes-insane>` class. +see the :ref:`ref-classes-insane` class. .. _ref-tasks-package_write_deb: @@ -262,17 +260,6 @@ the package feeds area. For more information, see the ":ref:`overview-manual/concepts:package feeds`" section in the Yocto Project Overview and Concepts Manual. -.. _ref-tasks-package_write_tar: - -``do_package_write_tar`` ------------------------- - -Creates tarballs and places them in the -``${``\ :term:`DEPLOY_DIR_TAR`\ ``}`` directory in -the package feeds area. For more information, see the -":ref:`overview-manual/concepts:package feeds`" section in -the Yocto Project Overview and Concepts Manual. - .. _ref-tasks-packagedata: ``do_packagedata`` @@ -302,56 +289,50 @@ 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``): -:: +recipe from the OE-Core layer (i.e. ``poky/meta``):: poky/meta/recipes-connectivity/bluez5 -This recipe has two patch files located here: -:: +This recipe has two patch files located here:: poky/meta/recipes-connectivity/bluez5/bluez5 -In the ``bluez5`` recipe, the ``SRC_URI`` statements point to the source +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 ``SRC_URI`` statements + 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 ``SRC_URI`` statement to indicate any -file as a patch file: -:: +"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 directory full of patch files and you want to -exclude some so that the ``do_patch`` task does not apply them during -the patch phase, you can use the "apply=no" parameter with the -``SRC_URI`` statement: -:: +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://path_to_lots_of_patch_files \ - file://path_to_lots_of_patch_files/patch_file5;apply=no \ + file://file1.patch \ + file://file2.patch;apply=no \ " -In the -previous example, assuming all the files in the directory holding the -patch files end with either ``.patch`` or ``.diff``, every file would be -applied as a patch by default except for the ``patch_file5`` patch. +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/common-tasks:patching code`" section in the +":ref:`dev-manual/new-recipe:patching code`" section in the Yocto Project Development Tasks Manual. .. _ref-tasks-populate_lic: @@ -377,7 +358,7 @@ information. ``do_populate_sdk_ext`` ----------------------- -Creates the file and directory structure for an installable extensible +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. @@ -400,7 +381,7 @@ For information on what directories are copied by default, see the these variables inside your recipe if you need to make additional (or fewer) directories available to other recipes at build time. -The ``do_populate_sysroot`` task is a shared state (sstate) task, which +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"). @@ -414,7 +395,7 @@ Installs the files into the individual recipe specific sysroots (i.e. ``recipe-sysroot`` and ``recipe-sysroot-native`` under ``${``\ :term:`WORKDIR`\ ``}`` based upon the dependencies specified by :term:`DEPENDS`). See the -":ref:`staging <ref-classes-staging>`" class for more information. +":ref:`ref-classes-staging`" class for more information. .. _ref-tasks-rm_work: @@ -423,7 +404,7 @@ dependencies specified by :term:`DEPENDS`). See the Removes work files after the OpenEmbedded build system has finished with them. You can learn more by looking at the -":ref:`rm_work.bbclass <ref-classes-rm-work>`" section. +":ref:`ref-classes-rm-work`" section. .. _ref-tasks-unpack: @@ -431,12 +412,11 @@ them. You can learn more by looking at the ------------- 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 +``${``\ :term:`UNPACKDIR`\ ``}``. A legacy way to specify +this directory is through the :term:`S` and :term:`WORKDIR` variables. +For more information on how source files are unpacked, see the ":ref:`overview-manual/concepts:source fetching`" -section in the Yocto Project Overview and Concepts Manual and also see -the ``WORKDIR`` and ``S`` variable descriptions. +section in the Yocto Project Overview and Concepts Manual. Manually Called Tasks ===================== @@ -444,39 +424,6 @@ Manually Called Tasks These tasks are typically manually triggered (e.g. by using the ``bitbake -c`` command-line option): -.. _ref-tasks-checkpkg: - -``do_checkpkg`` ---------------- - -Provides information about the recipe including its upstream version and -status. The upstream version and status reveals whether or not a version -of the recipe exists upstream and a status of not updated, updated, or -unknown. - -To check the upstream version and status of a recipe, use the following -devtool commands: -:: - - $ devtool latest-version - $ devtool check-upgrade-status - -See the ":ref:`ref-manual/devtool-reference:\`\`devtool\`\` quick reference`" -chapter for more information on -``devtool``. See the ":ref:`devtool-checking-on-the-upgrade-status-of-a-recipe`" -section for information on checking the upgrade status of a recipe. - -To build the ``checkpkg`` task, use the ``bitbake`` command with the -"-c" option and task name: -:: - - $ bitbake core-image-minimal -c checkpkg - -By default, the results are stored in :term:`$LOG_DIR <LOG_DIR>` (e.g. -``$BUILD_DIR/tmp/log``). - -.. _ref-tasks-checkuri: - ``do_checkuri`` --------------- @@ -488,14 +435,13 @@ Validates the :term:`SRC_URI` value. ------------ Removes all output files for a target from the -:ref:`ref-tasks-unpack` task forward (i.e. ``do_unpack``, +: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: -:: +You can run this task using BitBake as follows:: $ bitbake -c clean recipe @@ -515,18 +461,37 @@ use the :ref:`ref-tasks-cleansstate` task instead 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 ``do_cleanall`` task is +: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: -:: +You can run this task using BitBake as follows:: $ bitbake -c cleanall recipe -Typically, you would not normally use the ``cleanall`` task. Do so only -if you want to start fresh with the :ref:`ref-tasks-fetch` -task. +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: @@ -535,41 +500,51 @@ task. Removes all output files and shared state (:ref:`sstate <overview-manual/concepts:shared state cache>`) cache for a -target. Essentially, the ``do_cleansstate`` task is identical to the +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: -:: +You can run this task using BitBake as follows:: $ bitbake -c cleansstate recipe -When you run the ``do_cleansstate`` task, the OpenEmbedded build system +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:: - The ``do_cleansstate`` task cannot remove sstate from a remote sstate + 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: - :: + the "-f" option as follows:: $ bitbake -f -c do_cleansstate target -.. _ref-tasks-devpyshell: +.. _ref-tasks-pydevshell: -``do_devpyshell`` +``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/common-tasks:using a development python shell`" section in +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 ``devpyshell``. +using ``pydevshell``. .. _ref-tasks-devshell: @@ -577,7 +552,7 @@ using ``devpyshell``. --------------- Starts a shell whose environment is set up for development, debugging, -or both. See the ":ref:`dev-manual/common-tasks:using a development shell`" section in the +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``. @@ -620,10 +595,8 @@ information on live image types. ``do_bundle_initramfs`` ----------------------- -Combines an initial RAM disk (initramfs) image and kernel together to -form a single image. The -:term:`CONFIG_INITRAMFS_SOURCE` variable -has some more information about these types of images. +Combines an :term:`Initramfs` image and kernel together to +form a single image. .. _ref-tasks-rootfs: @@ -642,7 +615,7 @@ information on how the root filesystem is created. Boots an image and performs runtime tests within the image. For information on automatically testing images, see the -":ref:`dev-manual/common-tasks:performing automated runtime testing`" +":ref:`dev-manual/runtime-testing:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. .. _ref-tasks-testimage_auto: @@ -655,7 +628,7 @@ after it has been built. This task is enabled when you set :term:`TESTIMAGE_AUTO` equal to "1". For information on automatically testing images, see the -":ref:`dev-manual/common-tasks:performing automated runtime testing`" +":ref:`dev-manual/runtime-testing:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. Kernel-Related Tasks @@ -687,8 +660,7 @@ 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: -:: +from the command line as follows:: $ bitbake linux-yocto -c diffconfig @@ -703,7 +675,7 @@ section in the Yocto Project Linux Kernel Development Manual. Converts the newly unpacked kernel source into a form with which the OpenEmbedded build system can work. Because the kernel source can be -fetched in several different ways, the ``do_kernel_checkout`` task makes +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. @@ -714,12 +686,11 @@ kernel with the correct branches checked out. Validates the configuration produced by the :ref:`ref-tasks-kernel_menuconfig` task. The -``do_kernel_configcheck`` task produces warnings when a requested +: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: -:: +following command:: $ bitbake linux-yocto -c kernel_configcheck -f @@ -733,7 +704,7 @@ section in the Yocto Project Linux Kernel Development Manual. ---------------------- After the kernel is patched by the :ref:`ref-tasks-patch` -task, the ``do_kernel_configme`` task assembles and merges all the +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 @@ -750,8 +721,7 @@ tool, which you then use to modify the kernel configuration. .. note:: - You can also invoke this tool from the command line as follows: - :: + You can also invoke this tool from the command line as follows:: $ bitbake linux-yocto -c menuconfig @@ -767,7 +737,7 @@ information on this configuration tool. Collects all the features required for a given kernel build, whether the features come from :term:`SRC_URI` or from Git -repositories. After collection, the ``do_kernel_metadata`` task +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 @@ -793,8 +763,7 @@ 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: -:: +can invoke the task using the following command:: $ bitbake linux-yocto -c savedefconfig @@ -839,6 +808,5 @@ sections from a size-sensitive configuration. After the kernel is unpacked but before it is patched, this task makes sure that the machine and metadata branches as specified by the :term:`SRCREV` variables actually exist on the specified -branches. If these branches do not exist and -:term:`AUTOREV` is not being used, the -``do_validate_branches`` task fails during the build. +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 index 32bb75b271..b18c4183b6 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -4,7 +4,7 @@ Yocto Project Terms ******************* -Following is a list of terms and definitions users new to the Yocto Project +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: @@ -21,18 +21,17 @@ universal, the list includes them just in case: Information in append files extends or overrides the information in the similarly-named recipe file. For an example of an append file in use, see - the ":ref:`dev-manual/common-tasks:Using .bbappend Files in - Your Layer`" section in the Yocto Project Development Tasks Manual. + 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: - :: + 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, + 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 @@ -65,51 +64,73 @@ universal, the list includes them just in case: builds. The area is created when you ``source`` the setup environment script that is found in the Source Directory (i.e. :ref:`ref-manual/structure:\`\`oe-init-build-env\`\``). The - :term:`TOPDIR` variable points to the Build Directory. + :term:`TOPDIR` variable points to the :term:`Build Directory`. - You have a lot of flexibility when creating the Build Directory. - Following are some examples that show how to create the directory. The + 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 Build Directory inside your Source Directory and let - the name of the Build Directory default to ``build``: + - 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 Build Directory inside your home directory and + - 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 Build - Directory. Any intermediate folders in the pathname must exist. - This next example creates a Build Directory named - ``YP-&POKYVERSION;`` within the existing directory ``mybuilds``: + - 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-&POKYVERSION; + $ source poky/oe-init-build-env mybuilds/YP-&DISTRO; .. note:: - By default, the Build Directory contains :term:`TMPDIR`, which is a - temporary directory the build system uses for its work. ``TMPDIR`` cannot - be under NFS. Thus, by default, the Build Directory cannot be under - NFS. However, if you need the Build Directory to be under NFS, you can - set this up by setting ``TMPDIR`` in your ``local.conf`` file to use a local - drive. Doing so effectively separates ``TMPDIR`` from :term:`TOPDIR`, which is the - Build Directory. + 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 @@ -135,10 +156,25 @@ universal, the list includes them just in case: the Texas Instruments ARM Cortex-A8 development board). :term:`Container Layer` - Layers that hold other layers. An example of a container layer is - OpenEmbedded's `meta-openembedded - <https://github.com/openembedded/meta-openembedded>`_ layer. The - ``meta-openembedded`` layer contains many ``meta-*`` layers. + 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 @@ -176,6 +212,48 @@ universal, the list includes them just in case: 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 @@ -189,12 +267,18 @@ universal, the list includes them just in case: ":ref:`overview-manual/yp-intro:The Yocto Project Layer Model`" section in the Yocto Project Overview and Concepts Manual. For more detailed information on layers, see the - ":ref:`dev-manual/common-tasks:Understanding and Creating + ":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 @@ -214,6 +298,12 @@ universal, the list includes them just in case: :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 @@ -254,7 +344,7 @@ universal, the list includes them just in case: your Linux distribution. Another point worth noting is that historically within the Yocto - Project, recipes were referred to as packages - thus, the existence + 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`). @@ -307,6 +397,23 @@ universal, the list includes them just in case: :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 @@ -341,19 +448,19 @@ universal, the list includes them just in case: repository results in a local Git repository whose top-level folder is also named "poky". - While it is not recommended that you use tarball expansion to set up + 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 - :yocto_dl:`/releases/yocto/&DISTRO_REL_TAG;/&YOCTO_POKY;.tar.bz2` - results in a Source Directory whose root folder is named - ``&YOCTO_POKY;``. + 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 + 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 @@ -367,11 +474,53 @@ universal, the list includes them just in case: ":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 unit of execution for BitBake (e.g. + 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`. @@ -382,7 +531,7 @@ universal, the list includes them just in case: :term:`Upstream` A reference to source code or repositories that are not - local to the development system but located in a master area that is + 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 index 74ac12bf98..07b5b6f95c 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -17,6 +17,7 @@ system and gives an overview of their function and contents. :term:`W <WARN_QA>` :term:`X <XSERVER>` .. glossary:: + :sorted: :term:`ABIEXTENSION` Extension to the Application Binary Interface (ABI) field of the GNU @@ -24,8 +25,7 @@ system and gives an overview of their function and contents. 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: - :: + following extension:: ABIEXTENSION = "eabi" @@ -37,12 +37,11 @@ system and gives an overview of their function and contents. 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: - :: + conjunction with a package name override, as in:: - ALLOW_EMPTY_${PN} = "1" - ALLOW_EMPTY_${PN}-dev = "1" - ALLOW_EMPTY_${PN}-staticdev = "1" + 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 @@ -51,25 +50,22 @@ system and gives an overview of their function and contents. alternatives system to create a different binary naming scheme so the commands can co-exist. - To use the variable, list out the package's commands that also exist - as part of another package. For example, if the ``busybox`` package - has four commands that also exist as part of another package, you - identify them as follows: - :: + 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" + ALTERNATIVE:busybox = "sh sed test bracket" For more information on the alternatives system, see the - ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" + ":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 ``ALTERNATIVE_LINK_NAME`` variable to specify the actual - location: - :: + use the :term:`ALTERNATIVE_LINK_NAME` variable to specify the actual + location:: ALTERNATIVE_LINK_NAME[bracket] = "/usr/bin/[" @@ -78,10 +74,10 @@ system and gives an overview of their function and contents. .. note:: - If ``ALTERNATIVE_LINK_NAME`` is not defined, it defaults to ``${bindir}/name``. + If :term:`ALTERNATIVE_LINK_NAME` is not defined, it defaults to ``${bindir}/name``. For more information on the alternatives system, see the - ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" + ":ref:`ref-classes-update-alternatives`" section. :term:`ALTERNATIVE_PRIORITY` @@ -90,15 +86,14 @@ system and gives an overview of their function and contents. 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: - :: + available syntax forms:: ALTERNATIVE_PRIORITY = "priority" ALTERNATIVE_PRIORITY[name] = "priority" ALTERNATIVE_PRIORITY_pkg[name] = "priority" For more information on the alternatives system, see the - ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" + ":ref:`ref-classes-update-alternatives`" section. :term:`ALTERNATIVE_TARGET` @@ -107,8 +102,7 @@ system and gives an overview of their function and contents. 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: - :: + particular packages. Here are the available syntax forms:: ALTERNATIVE_TARGET = "target" ALTERNATIVE_TARGET[name] = "target" @@ -116,11 +110,11 @@ system and gives an overview of their function and contents. .. note:: - If ``ALTERNATIVE_TARGET`` is not defined, it inherits the value + If :term:`ALTERNATIVE_TARGET` is not defined, it inherits the value from the :term:`ALTERNATIVE_LINK_NAME` variable. - If ``ALTERNATIVE_LINK_NAME`` and ``ALTERNATIVE_TARGET`` are the - same, the target for ``ALTERNATIVE_TARGET`` has "``.{BPN}``" + 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 @@ -129,38 +123,34 @@ system and gives an overview of their function and contents. task while retaining support for the command if necessary. For more information on the alternatives system, see the - ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" - section. + ":ref:`ref-classes-update-alternatives`" section. :term:`ANY_OF_DISTRO_FEATURES` - When inheriting the - :ref:`features_check <ref-classes-features_check>` + 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 ``ANY_OF_DISTRO_FEATURES`` - appear in ``DISTRO_FEATURES`` within the current configuration, then + 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:`grub-efi <ref-classes-grub-efi>` class for more + 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:`archiver <ref-classes-archiver>` class, + 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): - :: + 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. @@ -182,7 +172,7 @@ system and gives an overview of their function and contents. attempt to build. Instead, BitBake assumes these recipes have already been built. - In OpenEmbedded-Core, ``ASSUME_PROVIDED`` mostly specifies native + 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``. @@ -193,65 +183,47 @@ system and gives an overview of their function and contents. 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 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: - :: + as being provided by the ``libegl-implementation`` package:: ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation" - :term:`AUTHOR` - The email address used to contact the original author or authors in - order to send patches and forward bugs. - :term:`AUTO_LIBNAME_PKGS` - When the :ref:`debian <ref-classes-debian>` class is inherited, - which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which + 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 debian class to - act on all packages that are explicitly generated by the recipe. - - :term:`AUTO_SYSLINUXMENU` - Enables creating an automatic menu for the syslinux bootloader. You - must set this variable in your recipe. The - :ref:`syslinux <ref-classes-syslinux>` class checks this variable. + 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 ``SRCREV`` is set to the value of this variable, it specifies to - use the latest source revision in the repository. Here is an example: - :: + 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:`kernel <ref-classes-kernel>` class and you use the previous - statement. In this example, ``${SRCPV}`` does not automatically get - into ``PV``. Consequently, you need to change ``PV`` in your recipe - so that it does contain ``${SRCPV}``. + ``${``\ :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/common-tasks:automatically incrementing a package version number`" + ":ref:`dev-manual/packages:automatically incrementing a package version number`" section in the Yocto Project Development Tasks Manual. - :term:`AVAILABLE_LICENSES` - List of licenses found in the directories specified by - :term:`COMMON_LICENSE_DIR` and - :term:`LICENSE_PATH`. - - .. note:: - - It is assumed that all changes to ``COMMON_LICENSE_DIR`` and - ``LICENSE_PATH`` have been done before ``AVAILABLE_LICENSES`` - is defined (in :ref:`ref-classes-license`). + :term:`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) @@ -261,21 +233,20 @@ system and gives an overview of their function and contents. 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/common-tasks:combining multiple versions of library files into one image>` + :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:`Basic Syntax <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax>`" section in the BitBake + ":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:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` + :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. - :: + 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>"" @@ -283,16 +254,15 @@ system and gives an overview of their function and contents. 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: - :: + The directory within the :term:`Build Directory` in which the + OpenEmbedded build system places generated objects during a recipe's + build process. By default, this directory is the same as the + :term:`S` directory, which is defined as:: S = "${WORKDIR}/${BP}" - You can separate the (``S``) directory and the directory pointed to - by the ``B`` variable. Most Autotools-based recipes support + 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. @@ -301,17 +271,15 @@ system and gives an overview of their function and contents. packages are packages installed only through the :term:`RRECOMMENDS` variable. You can prevent any of these "recommended" packages from being installed by listing them - with the ``BAD_RECOMMENDATIONS`` variable: - :: + 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: - :: + override:: - BAD_RECOMMENDATIONS_pn-target_image = "package_name" + 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 @@ -319,8 +287,8 @@ system and gives an overview of their function and contents. variable), the OpenEmbedded build system ignores your request and will install the packages to avoid dependency errors. - Support for this variable exists only when using the IPK and RPM - packaging backend. Support does not exist for DEB. + 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 @@ -328,12 +296,12 @@ system and gives an overview of their function and contents. :term:`BASE_LIB` The library directory name for the CPU or Application Binary - Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib - context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" + 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 ``BASE_LIB`` variable is defined in the machine include files in + 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". @@ -343,16 +311,15 @@ system and gives an overview of their function and contents. :term:`BB_ALLOWED_NETWORKS` Specifies a space-delimited list of hosts that the fetcher is allowed - to use to obtain the required source code. Following are + to use to obtain the required source code. Here are considerations surrounding this variable: - - This host list is only used if ``BB_NO_NETWORK`` is either not set + - This host list is only used if :term:`BB_NO_NETWORK` is either not set or set to "0". - - Limited support for wildcard matching against the beginning of - host names exists. For example, the following setting matches - ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``. - :: + - 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" @@ -371,14 +338,29 @@ system and gives an overview of their function and contents. - Attempts to access networks not in the host list cause a failure. - Using ``BB_ALLOWED_NETWORKS`` in conjunction with + Using :term:`BB_ALLOWED_NETWORKS` in conjunction with :term:`PREMIRRORS` is very useful. Adding the host - you want to use to ``PREMIRRORS`` results in the source code being + 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 ``SRC_URI`` after a successful fetch from the - ``PREMIRRORS`` occurs. + 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 @@ -394,17 +376,22 @@ system and gives an overview of their function and contents. 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: - :: + :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 ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file + add the :term:`BB_DISKMON_DIRS` variable to your ``conf/local.conf`` file found in the :term:`Build Directory`. Use the following form: @@ -415,7 +402,7 @@ system and gives an overview of their function and contents. where: action is: - ABORT: Immediately abort the build when + ABORT: Immediately stop the build when a threshold is broken. STOPTASKS: Stop the build after the currently executing tasks have finished when @@ -444,8 +431,7 @@ system and gives an overview of their function and contents. not specify G, M, or K, Kbytes is assumed by default. Do not use GB, MB, or KB. - Here are some examples: - :: + Here are some examples:: BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" @@ -454,13 +440,13 @@ system and gives an overview of their function and contents. The first example works only if you also provide the :term:`BB_DISKMON_WARNINTERVAL` variable in the ``conf/local.conf``. This example causes the build - system to immediately abort when either the disk space in + 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 ``BB_DISKMON_WARNINTERVAL`` + during intervals as defined by the :term:`BB_DISKMON_WARNINTERVAL` variable. The second example stops the build after all currently executing @@ -468,7 +454,7 @@ system and gives an overview of their function and contents. directory drops below 1 Gbyte. No disk monitoring occurs for the free inodes in this case. - The final example immediately aborts the build when the number of + 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. @@ -477,16 +463,15 @@ system and gives an overview of their function and contents. intervals, define the variable in your ``conf/local.conf`` file in the :term:`Build Directory`. - If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you + 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 ``BB_DISKMON_WARNINTERVAL`` variable and you - do use ``BB_DISKMON_DIRS`` with the "WARN" action, the disk - monitoring interval defaults to the following: - :: + 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" @@ -509,8 +494,7 @@ system and gives an overview of their function and contents. G, M, or K for Gbytes, Mbytes, or Kbytes, respectively. You cannot use GB, MB, or KB. - Here is an example: - :: + Here is an example:: BB_DISKMON_DIRS = "WARN,${SSTATE_DIR},1G,100K" BB_DISKMON_WARNINTERVAL = "50M,5K" @@ -523,6 +507,18 @@ system and gives an overview of their function and contents. 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 @@ -530,8 +526,7 @@ system and gives an overview of their function and contents. For performance reasons, creating and placing tarballs of these repositories is not the default action by the OpenEmbedded build - system. - :: + system:: BB_GENERATE_MIRROR_TARBALLS = "1" @@ -539,72 +534,203 @@ system and gives an overview of their function and contents. ``local.conf`` file in the :term:`Build Directory`. Once you have the tarballs containing your source files, you can - clean up your ``DL_DIR`` directory by deleting any Git or other + 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 ``BB_NUMBER_THREADS`` variable to default + 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 ``BB_NUMBER_THREADS`` variable + 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/common-tasks:speeding up a build`" + ":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 ``BB_SERVER_TIMEOUT`` to determine how + 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: - :: + instructs the server to be unloaded after 20 seconds of inactivity:: BB_SERVER_TIMEOUT = "20" If you want the server to never be unloaded, - set ``BB_SERVER_TIMEOUT`` to "-1". + 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. Common variants for recipes exist such as "natives" like + 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`; "nativesdk", which targets the SDK - machine instead of ``MACHINE``; and "mulitlibs" in the form - "``multilib:``\ multilib_name". + :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: - :: + code, it usually is as simple as adding the following to your recipe:: BBCLASSEXTEND =+ "native nativesdk" BBCLASSEXTEND =+ "multilib:multilib_name" .. note:: - Internally, the ``BBCLASSEXTEND`` mechanism generates recipe + 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 + as ``:class-native``. For example, to generate a native version of a recipe, a :term:`DEPENDS` on "foo" is rewritten - to a ``DEPENDS`` on "foo-native". + to a :term:`DEPENDS` on "foo-native". - Even when using ``BBCLASSEXTEND``, the recipe is only parsed once. + 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 @@ -622,17 +748,17 @@ system and gives an overview of their function and contents. 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 + --- effectively letting you control the precedence for the multiple layers. The precedence established through this variable stands regardless of a recipe's version (:term:`PV` variable). For - example, a layer that has a recipe with a higher ``PV`` value but for - which the ``BBFILE_PRIORITY`` is set to have a lower precedence still + 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 ``BBFILE_PRIORITY`` variable results in a + 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 ``BBFILE_PRIORITY`` variable - is set based on layer dependencies (see the ``LAYERDEPENDS`` variable + 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). @@ -647,7 +773,7 @@ system and gives an overview of their function and contents. software. When specifying recipe files, you can pattern match using Python's - `glob <https://docs.python.org/3/library/glob.html>`_ syntax. + `glob <https://docs.python.org/3/library/glob.html>`__ syntax. For details on the syntax, see the documentation by following the previous link. @@ -655,15 +781,16 @@ system and gives an overview of their function and contents. Activates content when identified layers are present. You identify the layers by the collections that the layers define. - Use the ``BBFILES_DYNAMIC`` variable to avoid ``.bbappend`` files + 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 ``BBFILES_DYNAMIC``: - collection_name:filename_pattern The following example identifies two - collection names and two filename patterns: - :: + 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 \ @@ -671,7 +798,7 @@ system and gives an overview of their function and contents. " This next example shows an error message that occurs because invalid - entries are found, which cause parsing to abort: + entries are found, which cause parsing to fail: .. code-block:: none @@ -679,20 +806,22 @@ system and gives an overview of their function and contents. /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 ``BBINCLUDELOGS_LINES``, + 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: - :: + Here is an example:: BBLAYERS = " \ /home/scottrif/poky/meta \ @@ -704,10 +833,13 @@ system and gives an overview of their function and contents. 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 ``BBMASK`` variable to "hide" these ``.bb`` and + 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 @@ -721,14 +853,13 @@ system and gives an overview of their function and contents. 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: - :: + ``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: :: + masks out multiple directories and individual recipes:: BBMASK += "/meta-ti/recipes-misc/ meta-ti/recipes-ti/packagegroup/" BBMASK += "/meta-oe/recipes-support/" @@ -746,70 +877,55 @@ system and gives an overview of their function and contents. 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: - :: + example, the following line specifies three configuration files:: BBMULTICONFIG = "configA configB configC" - Each configuration file you - use must reside in the :term:`Build Directory` - ``conf/multiconfig`` directory (e.g. - build_directory\ ``/conf/multiconfig/configA.conf``). + 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 ``BBMULTICONFIG`` in an environment + For information on how to use :term:`BBMULTICONFIG` in an environment that supports building targets with multiple configurations, see the - ":ref:`dev-manual/common-tasks:building images for multiple targets using multiple configurations`" + ":ref:`dev-manual/building:building images for multiple targets using multiple configurations`" section in the Yocto Project Development Tasks Manual. :term:`BBPATH` - Used by BitBake to locate ``.bbclass`` and configuration files. This - variable is analogous to the ``PATH`` variable. - - .. note:: - - If you run BitBake from a directory outside of the - :term:`Build Directory`, you must be sure to set ``BBPATH`` - to point to the Build Directory. Set the variable as you would any - environment variable and then run BitBake: - :: - - $ BBPATH = "build_directory" - $ export BBPATH - $ bitbake target - + See :term:`bitbake:BBPATH` in the BitBake manual. :term:`BBSERVER` - If defined in the BitBake environment, ``BBSERVER`` points to the + 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: - :: + environment:: export BBSERVER=localhost:$port - By default, ``BBSERVER`` also appears in - :term:`bitbake:BB_HASHBASE_WHITELIST`. - Consequently, ``BBSERVER`` is excluded from checksum and dependency + 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:`binconfig-disabled <ref-classes-binconfig-disabled>` class, - this variable specifies binary configuration scripts to disable in - favor of using ``pkg-config`` to query the information. The - ``binconfig-disabled`` class will modify the specified scripts to - return an error so that calls to them can be easily found and - replaced. + 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: - :: + from the ``libpng`` recipe:: BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config" :term:`BINCONFIG_GLOB` - When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, + 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 @@ -818,7 +934,7 @@ system and gives an overview of their function and contents. .. note:: - The ``BINCONFIG_GLOB`` variable uses + 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 @@ -826,16 +942,18 @@ system and gives an overview of their function and contents. and `glob <https://docs.python.org/3/library/glob.html>`__. For more information on how this variable works, see - ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`. + ``meta/classes-recipe/binconfig.bbclass`` in the :term:`Source Directory`. You can also find general information on the class in the - ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. + ":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). ``BP`` is - comprised of the following: - :: + suffix (i.e. ``-native``, ``lib64-``, and so forth). :term:`BP` is + comprised of the following:: ${BPN}-${PV} @@ -856,23 +974,23 @@ system and gives an overview of their function and contents. :term:`BUILD_ARCH` Specifies the architecture of the build host (e.g. ``i686``). The - OpenEmbedded build system sets the value of ``BUILD_ARCH`` from the + 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 ``BUILD_AS_ARCH`` is empty. + 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 ``BUILD_CC_ARCH`` is empty. + 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, ``BUILD_CCLD`` + 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 - ``BUILD_CC_ARCH`` is set. + :term:`BUILD_CC_ARCH` is set. :term:`BUILD_CFLAGS` Specifies the flags to pass to the C compiler when building for the @@ -894,19 +1012,19 @@ system and gives an overview of their function and contents. :term:`BUILD_FC` Specifies the Fortran compiler command for the build host. By - default, ``BUILD_FC`` points to Gfortran and passes as arguments the + default, :term:`BUILD_FC` points to Gfortran and passes as arguments the value of :term:`BUILD_CC_ARCH`, assuming - ``BUILD_CC_ARCH`` is set. + :term:`BUILD_CC_ARCH` is set. :term:`BUILD_LD` Specifies the linker command for the build host. By default, - ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments + :term:`BUILD_LD` points to the GNU linker (ld) and passes as arguments the value of :term:`BUILD_LD_ARCH`, assuming - ``BUILD_LD_ARCH`` is set. + :term:`BUILD_LD_ARCH` is set. :term:`BUILD_LD_ARCH` Specifies architecture-specific linker flags for the build host. By - default, the value of ``BUILD_LD_ARCH`` is empty. + 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 @@ -920,99 +1038,96 @@ system and gives an overview of their function and contents. the :term:`BUILD_CFLAGS` and :term:`BUILDSDK_CFLAGS` default values. - The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2 + 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 - ``BUILD_OS`` from the OS reported by the ``uname`` command - the + :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 ``BUILD_PREFIX`` value to set the - :term:`TARGET_PREFIX` when building for - ``native`` recipes. + 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, ``BUILD_STRIP`` + 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 - ``native`` recipes). + :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 - ``BUILD_SYS`` variable yourself. + :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 Build - Directory path when you run the script. If you run the script and do - not provide a Build Directory path, the ``BUILDDIR`` defaults to - ``build`` in the current directory. + 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:`buildhistory <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 ``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". + 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 ``buildhistory`` class does not commit the build - history output in a local Git repository: - :: + By default, the :ref:`ref-classes-buildhistory` class + enables committing the buildhistory output in a local Git repository:: - BUILDHISTORY_COMMIT ?= "0" + BUILDHISTORY_COMMIT ?= "1" :term:`BUILDHISTORY_COMMIT_AUTHOR` - When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` + When inheriting the :ref:`ref-classes-buildhistory` class, this variable specifies the author to use for each Git commit. - In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the + 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 - ``BUILDHISTORY_COMMIT_AUTHOR`` variable takes the form of "name + :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 ``buildhistory`` class sets the variable as follows: - :: + 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:`buildhistory <ref-classes-buildhistory>` + 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 ``buildhistory.class``. + see the :ref:`ref-classes-buildhistory` class. - By default, the ``buildhistory`` class sets the directory as follows: - :: + By default, the :ref:`ref-classes-buildhistory` class sets the directory + as follows:: BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" :term:`BUILDHISTORY_FEATURES` - When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` + 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/common-tasks:maintaining build output quality`" + ":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: @@ -1031,14 +1146,13 @@ system and gives an overview of their function and contents. This saves one file per task and lists the SHA-256 checksums for each file staged (i.e. the output of the task). - By default, the ``buildhistory`` class enables the following - features: - :: + 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:`buildhistory <ref-classes-buildhistory>` + 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 @@ -1048,30 +1162,45 @@ system and gives an overview of their function and contents. any file. Specifying an invalid path does not produce an error. Consequently, you can include files that might not always be present. - By default, the ``buildhistory`` class provides paths to the - following files: - :: + 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:`buildhistory <ref-classes-buildhistory>` - class, this variable optionally specifies a remote repository to - which build history pushes Git changes. In order for - ``BUILDHISTORY_PUSH_REPO`` to work, - :term:`BUILDHISTORY_COMMIT` must be set to - "1". + 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 ``buildhistory`` class sets the variable as follows: - :: + 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, @@ -1098,9 +1227,8 @@ system and gives an overview of their function and contents. :term:`BUILDSTATS_BASE` Points to the location of the directory that holds build statistics - when you use and enable the - :ref:`buildstats <ref-classes-buildstats>` class. The - ``BUILDSTATS_BASE`` directory defaults to + 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` @@ -1109,10 +1237,13 @@ system and gives an overview of their function and contents. ``setuid root``, and one for the remaining features (i.e. those that do not require ``setuid root``). - The ``BUSYBOX_SPLIT_SUID`` variable defaults to "1", which results in + 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 @@ -1126,7 +1257,7 @@ system and gives an overview of their function and contents. exported to an environment variable and thus made visible to the software being built during the compilation step. - Default initialization for ``CFLAGS`` varies depending on what is + Default initialization for :term:`CFLAGS` varies depending on what is being built: - :term:`TARGET_CFLAGS` when building for the @@ -1142,37 +1273,34 @@ system and gives an overview of their function and contents. An internal variable specifying the special class override that should currently apply (e.g. "class-target", "class-native", and so forth). The classes that use this variable (e.g. - :ref:`native <ref-classes-native>`, - :ref:`nativesdk <ref-classes-nativesdk>`, and so forth) set the - variable to appropriate values. + :ref:`ref-classes-native`, :ref:`ref-classes-nativesdk`, and so forth) + set the variable to appropriate values. .. note:: - ``CLASSOVERRIDE`` gets its default "class-target" value from the + :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: - :: + files, but only when building for the target:: - do_install_append_class-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: - :: + building for the build host:: - FOO_class-native = "native" + FOO:class-native = "native" FOO = "other" - The underlying mechanism behind ``CLASSOVERRIDE`` is simply + 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, ``CLEANBROKEN`` specifies that the + 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` @@ -1188,6 +1316,26 @@ system and gives an overview of their function and contents. 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 @@ -1214,35 +1362,63 @@ system and gives an overview of their function and contents. 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. - .. note:: - - The ``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 :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 ``IMAGE_FEATURES`` + 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: - :: + 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 ``COMPONENTS_DIR`` when constructing recipe-specific + system uses :term:`COMPONENTS_DIR` when constructing recipe-specific sysroots for other recipes. The default is @@ -1252,7 +1428,7 @@ system and gives an overview of their function and contents. :term:`CONF_VERSION` Tracks the version of the local configuration file (i.e. - ``local.conf``). The value for ``CONF_VERSION`` increments each time + ``local.conf``). The value for :term:`CONF_VERSION` increments each time ``build/conf/`` compatibility changes. :term:`CONFFILES` @@ -1262,29 +1438,28 @@ system and gives an overview of their function and contents. files you have changed after the original installation and that you now want to remain unchanged are overwritten. In other words, editable files might exist in the package that you do not want reset - as part of the package update process. You can use the ``CONFFILES`` + 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 ``CONFFILES`` variable, provide a package name override + 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: - :: + space-separated list of files. Here is an example:: - CONFFILES_${PN} += "${sysconfdir}/file1 \ + CONFFILES:${PN} += "${sysconfdir}/file1 \ ${sysconfdir}/file2 ${sysconfdir}/file3" - A relationship exists between the ``CONFFILES`` and ``FILES`` - variables. The files listed within ``CONFFILES`` must be a subset of - the files listed within ``FILES``. Because the configuration files - you provide with ``CONFFILES`` are simply being identified so that + 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 ``FILES`` + already be included as part of the package through the :term:`FILES` variable. .. note:: - When specifying paths as part of the ``CONFFILES`` variable, it is + 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 @@ -1292,24 +1467,24 @@ system and gives an overview of their function and contents. :term:`Source Directory`. :term:`CONFIG_INITRAMFS_SOURCE` - Identifies the initial RAM filesystem (initramfs) source files. The + 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 ``CONFIG_INITRAMFS_SOURCE`` can be either a single cpio archive + 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 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 + 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 initramfs image + If you specify multiple directories and files, the :term:`Initramfs` image will be the aggregate of all of them. - For information on creating an initramfs, see the - ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section + 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` @@ -1321,82 +1496,26 @@ system and gives an overview of their function and contents. The minimal arguments for GNU configure. :term:`CONFLICT_DISTRO_FEATURES` - When inheriting the - :ref:`features_check <ref-classes-features_check>` + 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 - ``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also - appears in ``DISTRO_FEATURES`` within the current configuration, then + :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:`COPYLEFT_LICENSE_EXCLUDE` - A space-separated list of licenses to exclude from the source - archived by the :ref:`archiver <ref-classes-archiver>` class. In - other words, if a license in a recipe's - :term:`LICENSE` value is in the value of - ``COPYLEFT_LICENSE_EXCLUDE``, then its source is not archived by the - class. + :term:`CONVERSION_CMD` + This variable is used for storing image conversion commands. + Image conversion can convert an image into different objects like: - .. note:: + - Compressed version of the image - The ``COPYLEFT_LICENSE_EXCLUDE`` variable takes precedence over the - :term:`COPYLEFT_LICENSE_INCLUDE` variable. + - Checksums for the image - The default value, which is "CLOSED Proprietary", for - ``COPYLEFT_LICENSE_EXCLUDE`` is set by the - :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which - is inherited by the ``archiver`` class. - - :term:`COPYLEFT_LICENSE_INCLUDE` - A space-separated list of licenses to include in the source archived - by the :ref:`archiver <ref-classes-archiver>` class. In other - words, if a license in a recipe's :term:`LICENSE` - value is in the value of ``COPYLEFT_LICENSE_INCLUDE``, then its - source is archived by the class. - - The default value is set by the - :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which - is inherited by the ``archiver`` class. The default value includes - "GPL*", "LGPL*", and "AGPL*". - - :term:`COPYLEFT_PN_EXCLUDE` - A list of recipes to exclude in the source archived by the - :ref:`archiver <ref-classes-archiver>` class. The - ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and - exclusion caused through the - :term:`COPYLEFT_LICENSE_INCLUDE` and - :term:`COPYLEFT_LICENSE_EXCLUDE` - variables, respectively. - - The default value, which is "" indicating to not explicitly exclude - any recipes by name, for ``COPYLEFT_PN_EXCLUDE`` is set by the - :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which - is inherited by the ``archiver`` class. + An example of :term:`CONVERSION_CMD` from :ref:`ref-classes-image_types` + class is:: - :term:`COPYLEFT_PN_INCLUDE` - A list of recipes to include in the source archived by the - :ref:`archiver <ref-classes-archiver>` class. The - ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and - exclusion caused through the - :term:`COPYLEFT_LICENSE_INCLUDE` and - :term:`COPYLEFT_LICENSE_EXCLUDE` - variables, respectively. - - The default value, which is "" indicating to not explicitly include - any recipes by name, for ``COPYLEFT_PN_INCLUDE`` is set by the - :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which - is inherited by the ``archiver`` class. - - :term:`COPYLEFT_RECIPE_TYPES` - A space-separated list of recipe types to include in the source - archived by the :ref:`archiver <ref-classes-archiver>` class. - Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``, - ``crosssdk``, and ``cross-canadian``. - - The default value, which is "target*", for ``COPYLEFT_RECIPE_TYPES`` - is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` - class, which is inherited by the ``archiver`` class. + CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}" :term:`COPY_LIC_DIRS` If set to "1" along with the @@ -1408,11 +1527,11 @@ system and gives an overview of their function and contents. .. note:: - The ``COPY_LIC_DIRS`` does not offer a path for adding licenses for + 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/common-tasks:providing license text`" + 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. @@ -1424,14 +1543,77 @@ system and gives an overview of their function and contents. .. note:: - The ``COPY_LIC_MANIFEST`` does not offer a path for adding licenses for + 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/common-tasks:providing license text`" + 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 @@ -1444,24 +1626,24 @@ system and gives an overview of their function and contents. Specifies the parent directory of the OpenEmbedded-Core Metadata layer (i.e. ``meta``). - It is an important distinction that ``COREBASE`` points to the parent + 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, ``COREBASE`` + 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 ``COREBASE_FILES`` variable exists for - the purpose of copying metadata from the OpenEmbedded build system + ``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 ``COREBASE`` is needed because it + 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 ``COREBASE_FILES`` is used in order to only copy the files that + of :term:`COREBASE_FILES` is used in order to only copy the files that are actually needed. :term:`CPP` @@ -1473,7 +1655,7 @@ system and gives an overview of their function and contents. variable and thus made visible to the software being built during the compilation step. - Default initialization for ``CPPFLAGS`` varies depending on what is + Default initialization for :term:`CPPFLAGS` varies depending on what is being built: - :term:`TARGET_CPPFLAGS` when building for @@ -1487,15 +1669,103 @@ system and gives an overview of their function and contents. :term:`CROSS_COMPILE` The toolchain binary prefix for the target tools. The - ``CROSS_COMPILE`` variable is the same as the + :term:`CROSS_COMPILE` variable is the same as the :term:`TARGET_PREFIX` variable. .. note:: - The OpenEmbedded build system sets the ``CROSS_COMPILE`` + 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. @@ -1508,7 +1778,7 @@ system and gives an overview of their function and contents. exported to an environment variable and thus made visible to the software being built during the compilation step. - Default initialization for ``CXXFLAGS`` varies depending on what is + Default initialization for :term:`CXXFLAGS` varies depending on what is being built: - :term:`TARGET_CXXFLAGS` when building for @@ -1524,8 +1794,7 @@ system and gives an overview of their function and contents. 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: - :: + to:: ${WORKDIR}/image @@ -1543,60 +1812,69 @@ system and gives an overview of their function and contents. suitable for timestamps. :term:`DEBIAN_NOAUTONAME` - When the :ref:`debian <ref-classes-debian>` class is inherited, - which is the default behavior, ``DEBIAN_NOAUTONAME`` specifies a + 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: - :: + set this variable. Here is an example from the ``fontconfig`` recipe:: - DEBIAN_NOAUTONAME_fontconfig-utils = "1" + DEBIAN_NOAUTONAME:fontconfig-utils = "1" :term:`DEBIANNAME` - When the :ref:`debian <ref-classes-debian>` class is inherited, - which is the default behavior, ``DEBIANNAME`` allows you to override + 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" + ``dbus`` recipe:: - :term:`DEBUGINFOD_URLS` - Points to the URL of the "debuginfod" server. Such that for every - debugging information lookup, the debuginfod client will query the - server and return the requested information. You set this variable - in your ``local.conf`` file. + DEBIANNAME:${PN} = "dbus-1" :term:`DEBUG_BUILD` Specifies to build packages with debugging information. This - influences the value of the ``SELECTED_OPTIMIZATION`` variable. + influences the value of the :term:`SELECTED_OPTIMIZATION` variable. :term:`DEBUG_OPTIMIZATION` - The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when + 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 ``PREFERRED_VERSION`` being used to + by default in the absence of :term:`PREFERRED_VERSION` being used to build the development version. .. note:: - The bias provided by ``DEFAULT_PREFERENCE`` is weak and is overridden + 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 - ``DEFAULTTUNE`` helps define + :term:`DEFAULTTUNE` helps define :term:`TUNE_FEATURES`. The default tune is either implicitly or explicitly set by the @@ -1610,83 +1888,79 @@ system and gives an overview of their function and contents. needed by the recipe at build time. As an example, consider a recipe ``foo`` that contains the following - assignment: - :: + 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 ``do_configure`` depend on - the :ref:`ref-tasks-populate_sysroot` task of - each recipe listed in ``DEPENDS``, through a - ``[``\ :ref:`deptask <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:variable flags>`\ ``]`` - declaration in the :ref:`base <ref-classes-base>` class. + 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, ``STAGING_DIR_HOST`` + 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, ``DEPENDS`` can also be used to add utilities + 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: - :: + might have the following:: DEPENDS = "codegen-native" For more - information, see the :ref:`native <ref-classes-native>` class and + information, see the :ref:`ref-classes-native` class and the :term:`EXTRANATIVEPATH` variable. .. note:: - - ``DEPENDS`` is a list of recipe names. Or, to be more precise, + - :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 ``DEPENDS`` does not make sense. Use "foo" + "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 ``DEPENDS`` does not by + - 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 - ``DEPENDS`` alone is sufficient for most recipes. + :term:`DEPENDS` alone is sufficient for most recipes. - - Counterintuitively, ``DEPENDS`` is often necessary even for + - 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 ``DEPENDS`` from the recipe that installs ``libfoo`` + 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:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and - ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the - BitBake User Manual for additional information on tasks and - dependencies. + 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``. + 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. + ":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 @@ -1696,19 +1970,17 @@ system and gives an overview of their function and contents. :term:`DEPLOY_DIR_DEB` Points to the area that the OpenEmbedded build system uses to place Debian packages that are ready to be used outside of the build - system. This variable applies only when - :term:`PACKAGE_CLASSES` contains - "package_deb". + system. This variable applies only when :term:`PACKAGE_CLASSES` contains + ":ref:`ref-classes-package_deb`". The BitBake configuration file initially defines the - ``DEPLOY_DIR_DEB`` variable as a sub-folder of - :term:`DEPLOY_DIR`: - :: + :term:`DEPLOY_DIR_DEB` variable as a sub-folder of + :term:`DEPLOY_DIR`:: DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" - The :ref:`package_deb <ref-classes-package_deb>` class uses the - ``DEPLOY_DIR_DEB`` variable to make sure the + 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 @@ -1723,8 +1995,14 @@ system and gives an overview of their function and contents. resides within the :term:`Build Directory` as ``${DEPLOY_DIR}/images/${MACHINE}/``. - For more information on the structure of the Build Directory, see - ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. + 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 @@ -1733,19 +2011,16 @@ system and gives an overview of their function and contents. :term:`DEPLOY_DIR_IPK` Points to the area that the OpenEmbedded build system uses to place IPK packages that are ready to be used outside of the build system. - This variable applies only when - :term:`PACKAGE_CLASSES` contains - "package_ipk". + 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`: - :: + sub-folder of :term:`DEPLOY_DIR`:: DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk" - The :ref:`package_ipk <ref-classes-package_ipk>` class uses the - ``DEPLOY_DIR_IPK`` variable to make sure the - :ref:`ref-tasks-package_write_ipk` task + 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 @@ -1754,89 +2029,81 @@ system and gives an overview of their function and contents. :term:`DEPLOY_DIR_RPM` Points to the area that the OpenEmbedded build system uses to place RPM packages that are ready to be used outside of the build system. - This variable applies only when - :term:`PACKAGE_CLASSES` contains - "package_rpm". + 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`: - :: + sub-folder of :term:`DEPLOY_DIR`:: DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm" - The :ref:`package_rpm <ref-classes-package_rpm>` class uses the - ``DEPLOY_DIR_RPM`` variable to make sure the + 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:`DEPLOY_DIR_TAR` - Points to the area that the OpenEmbedded build system uses to place - tarballs that are ready to be used outside of the build system. This - variable applies only when - :term:`PACKAGE_CLASSES` contains - "package_tar". - - The BitBake configuration file initially defines this variable as a - sub-folder of :term:`DEPLOY_DIR`: - :: - - DEPLOY_DIR_TAR = "${DEPLOY_DIR}/tar" - - The :ref:`package_tar <ref-classes-package_tar>` class uses the - ``DEPLOY_DIR_TAR`` variable to make sure the - :ref:`ref-tasks-package_write_tar` task - writes TAR packages into the appropriate folder. For more information - on how packaging works, see the - ":ref:`overview-manual/concepts:package feeds`" section - in the Yocto Project Overview and Concepts Manual. - :term:`DEPLOYDIR` - When inheriting the :ref:`deploy <ref-classes-deploy>` class, the - ``DEPLOYDIR`` points to a temporary work area for deployed files that - is set in the ``deploy`` class as follows: - :: + 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 ``deploy`` class should copy files to be - deployed into ``DEPLOYDIR``, and the class will take care of copying + 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, - ``DESCRIPTION`` takes the value of the :term:`SUMMARY` + :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 ``DISTRO`` variable corresponds to a distribution configuration + 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 ``DISTRO`` variable is set as - follows: - :: + 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 ``DISTRO`` must not contain + distribution configuration. The value for :term:`DISTRO` must not contain spaces, and is typically all lower-case. .. note:: - If the ``DISTRO`` variable is blank, a set of default configurations + 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. @@ -1845,7 +2112,7 @@ system and gives an overview of their function and contents. :term:`DISTRO_EXTRA_RDEPENDS` Specifies a list of distro-specific packages to add to all images. - This variable takes affect through ``packagegroup-base`` so the + 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 @@ -1863,32 +2130,47 @@ system and gives an overview of their function and contents. configuration file. In most cases, the presence or absence of a feature in - ``DISTRO_FEATURES`` is translated to the appropriate option supplied + :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 - ``DISTRO_FEATURES``, causes every piece of software built for the + :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` - Features to be added to ``DISTRO_FEATURES`` if not also present in - ``DISTRO_FEATURES_BACKFILL_CONSIDERED``. + 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 backfilled for - all distro configurations. See the ":ref:`ref-features-backfill`" section - for more information. + the variable to see which distro features are being + :ref:`backfilled <ref-features-backfill>` for all distro configurations. :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` - Features from ``DISTRO_FEATURES_BACKFILL`` that should not be - backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See - the ":ref:`ref-features-backfill`" section for more information. + 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 @@ -1899,26 +2181,24 @@ system and gives an overview of their function and contents. able to reuse the default :term:`DISTRO_FEATURES` options without the need to write out the full set. Here is an example that uses - ``DISTRO_FEATURES_DEFAULT`` from a custom distro configuration file: - :: + :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 ``DISTRO_FEATURES`` when building native recipes. This + 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 ``DISTRO_FEATURES`` when building nativesdk recipes. This - variable is used in addition to the features filtered using the - :term:`DISTRO_FEATURES_NATIVESDK` - variable. + :term:`DISTRO_FEATURES` 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 @@ -1931,25 +2211,23 @@ system and gives an overview of their function and contents. :term:`DISTRO_FEATURES_NATIVESDK` Specifies a list of features that should be included in :term:`DISTRO_FEATURES` when building - nativesdk recipes. This variable is used in addition to the features - filtered using the - :term:`DISTRO_FEATURES_FILTER_NATIVESDK` - variable. + :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 ``DISTRO_NAME`` variable corresponds to a distribution + 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 ``DISTRO_NAME`` variable is set - as follows: - :: + Within that ``poky.conf`` file, the :term:`DISTRO_NAME` variable is set + as follows:: DISTRO_NAME = "Poky (Yocto Project Reference Distro)" @@ -1959,7 +2237,7 @@ system and gives an overview of their function and contents. .. note:: - If the ``DISTRO_NAME`` variable is blank, a set of default + 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. @@ -1971,39 +2249,30 @@ system and gives an overview of their function and contents. distribution. By default, this list includes the value of :term:`DISTRO`. - You can extend ``DISTROOVERRIDES`` to add extra overrides that should + You can extend :term:`DISTROOVERRIDES` to add extra overrides that should apply to the distribution. - The underlying mechanism behind ``DISTROOVERRIDES`` is simply that it + The underlying mechanism behind :term:`DISTROOVERRIDES` is simply that it is included in the default value of :term:`OVERRIDES`. - :term:`DISTUTILS_SETUP_PATH` - When used by recipes that inherit the - :ref:`distutils3 <ref-classes-distutils3>` or - :ref:`setuptools3 <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:: + Here is an example from :yocto_git:`meta-poky/conf/distro/poky-tiny.conf + </poky/tree/meta-poky/conf/distro/poky-tiny.conf>`:: - S = "${WORKDIR}/git" - DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule" + DISTROOVERRIDES = "poky:poky-tiny" :term:`DL_DIR` The central download directory used by the build process to store - downloads. By default, ``DL_DIR`` gets files suitable for mirroring + 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 ``DL_DIR`` variable in the + 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`. - :: + ``downloads`` in the :term:`Build Directory`:: #DL_DIR ?= "${TOPDIR}/downloads" @@ -2013,7 +2282,7 @@ system and gives an overview of their function and contents. During a first build, the system downloads many different source code tarballs from various upstream projects. Downloading can take a while, particularly if your network connection is slow. Tarballs are - all stored in the directory defined by ``DL_DIR`` and the build + all stored in the directory defined by :term:`DL_DIR` and the build system looks there first to find source tarballs. .. note:: @@ -2030,24 +2299,51 @@ system and gives an overview of their function and contents. Wiki page. :term:`DOC_COMPRESS` - When inheriting the :ref:`compress_doc <ref-classes-compress_doc>` + When inheriting the :ref:`ref-classes-compress_doc` class, this variable sets the compression policy used when the - OpenEmbedded build system compresses man pages and info pages. By + 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/compress_doc.bbclass`` file. + 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 - ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. 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:`systemd-boot <ref-classes-systemd-boot>` and - :ref:`image-live <ref-classes-image-live>` classes for more - information. + 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 @@ -2055,18 +2351,16 @@ system and gives an overview of their function and contents. less). :term:`ERR_REPORT_DIR` - When used with the :ref:`report-error <ref-classes-report-error>` - class, specifies the path used for storing the debug files created by - the :ref:`error reporting - tool <dev-manual/common-tasks:using the error reporting tool>`, which - allows you to submit build errors you encounter to a central + 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 ``ERR_REPORT_DIR`` to the path you want the error + 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: - :: + ``local.conf`` file:: ERR_REPORT_DIR = "path" @@ -2075,7 +2369,69 @@ system and gives an overview of their function and contents. errors by the OpenEmbedded build system. You set this variable in your distribution configuration file. For a list of the checks you can control with this variable, see the - ":ref:`insane.bbclass <ref-classes-insane>`" section. + ":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 @@ -2089,13 +2445,12 @@ system and gives an overview of their function and contents. libraries resolver might implicitly define some dependencies between packages. - The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the + 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 ``EXCLUDE_FROM_SHLIBS`` variable by setting it to "1" for a - particular package: - :: + Use the :term:`EXCLUDE_FROM_SHLIBS` variable by setting it to "1" for a + particular package:: EXCLUDE_FROM_SHLIBS = "1" @@ -2110,18 +2465,18 @@ system and gives an overview of their function and contents. .. note:: - Recipes added to ``EXCLUDE_FROM_WORLD`` may still be built during a + 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 ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not + 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 ``PE`` - is set and greater than zero for a recipe, ``EXTENDPE`` becomes that - value (e.g if ``PE`` is equal to "1" then ``EXTENDPE`` becomes "1"). - If a recipe's ``PE`` is not set (the default) or is equal to zero, - ``EXTENDPE`` becomes "". + 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. @@ -2129,55 +2484,67 @@ system and gives an overview of their function and contents. 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: - :: + package in the same recipe:: - RDEPENDS_${PN}-additional-module = "${PN} (= ${EXTENDPKGV})" + RDEPENDS:${PN}-additional-module = "${PN} (= ${EXTENDPKGV})" The dependency relationships are intended to force the package manager to upgrade these types of packages in lock-step. :term:`EXTERNAL_KERNEL_TOOLS` - When set, the ``EXTERNAL_KERNEL_TOOLS`` variable indicates that these + 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 ``EXTERNAL_KERNEL_TOOLS`` + 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:`kernel-yocto <ref-classes-kernel-yocto>` class in - ``meta/classes`` to see how the variable is used. + 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:`externalsrc <ref-classes-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. - For more information on ``externalsrc.bbclass``, see the - ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You + 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/common-tasks:building software from an external source`" + ":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:`externalsrc <ref-classes-externalsrc>` + 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 Build - Directory. + which is what the OpenEmbedded build system uses to locate the + :term:`Build Directory`. - For more information on ``externalsrc.bbclass``, see the - ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You + 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/common-tasks:building software from an external source`" + ":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:`autotools <ref-classes-autotools>` - class, you can use ``EXTRA_AUTORECONF`` to specify extra options to + 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. @@ -2188,9 +2555,8 @@ system and gives an overview of their function and contents. 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. + 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:: @@ -2199,48 +2565,47 @@ system and gives an overview of their function and contents. Here are some examples of features you can add: - - "dbg-pkgs" - Adds -dbg packages for all installed packages including + - "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 + - "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 + - "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-rootfs" --- creates an image whose root filesystem is read-only. See the - ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" + ":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, + - "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 + - "tools-testapps" --- adds useful testing tools such as ts_print, aplay, arecord and so forth. For a complete list of image features that ships with the Yocto Project, see the ":ref:`ref-features-image`" section. For an example that shows how to customize your image by using this - variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" + 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: - :: + an example:: - EXTRA_IMAGECMD_ext3 ?= "-i 4096" + EXTRA_IMAGECMD:ext3 ?= "-i 4096" :term:`EXTRA_IMAGEDEPENDS` A list of recipes to build that do not provide packages for installing into the root filesystem. Sometimes a recipe is required to build the final image but is not - needed in the root filesystem. You can use the ``EXTRA_IMAGEDEPENDS`` + 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. @@ -2249,20 +2614,9 @@ system and gives an overview of their function and contents. To add packages to the root filesystem, see the various :term:`RDEPENDS` and :term:`RRECOMMENDS` variables. - :term:`EXTRANATIVEPATH` - A list of subdirectories of - ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}`` - added to the beginning of the environment variable ``PATH``. As an - example, the following prepends - "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to - ``PATH``: - :: - - EXTRANATIVEPATH = "foo bar" - :term:`EXTRA_OECMAKE` Additional `CMake <https://cmake.org/overview/>`__ options. See the - :ref:`cmake <ref-classes-cmake>` class for additional information. + :ref:`ref-classes-cmake` class for additional information. :term:`EXTRA_OECONF` Additional ``configure`` script options. See @@ -2272,30 +2626,44 @@ system and gives an overview of their function and contents. :term:`EXTRA_OEMAKE` Additional GNU ``make`` options. - Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the + 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 - ``EXTRA_OEMAKE`` to pass the required flags. + :term:`EXTRA_OEMAKE` to pass the required flags. :term:`EXTRA_OESCONS` - When inheriting the :ref:`scons <ref-classes-scons>` class, this + 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:`extrausers <ref-classes-extrausers>` + 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:`useradd <ref-classes-useradd>` class, which ties user and + :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 - ``EXTRA_USERS_PARAMS`` is shown in the ``extrausers`` class. These - commands map to the normal Unix commands of the same names: - :: + :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; \ @@ -2306,6 +2674,37 @@ system and gives an overview of their function and contents. # 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:: @@ -2317,23 +2716,50 @@ system and gives an overview of their function and contents. 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, ``FEATURE_PACKAGES`` should have the name of - the feature item as an override. Here is an example: - :: + 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 ``IMAGE_FEATURES``, + 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 ``FEATURE_PACKAGES`` + Packages installed by features defined through :term:`FEATURE_PACKAGES` are often package groups. While similarly named, you should not - confuse the ``FEATURE_PACKAGES`` variable with package groups, which + confuse the :term:`FEATURE_PACKAGES` variable with package groups, which are discussed elsewhere in the documentation. :term:`FEED_DEPLOYDIR_BASE_URI` @@ -2342,8 +2768,7 @@ system and gives an overview of their function and contents. OPKG to support runtime package management of IPK packages. You set this variable in your ``local.conf`` file. - Consider the following example: - :: + Consider the following example:: FEED_DEPLOYDIR_BASE_URI = "http://192.168.7.1/BOARD-dir" @@ -2354,37 +2779,42 @@ system and gives an overview of their function and contents. 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 ``FILES`` variable, provide a package name override that + 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: - :: + part of the resulting package. Here is an example:: - FILES_${PN} += "${bindir}/mydir1 ${bindir}/mydir2/myfile" + 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>`_ + `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 ``FILES`` variable, it is + - 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 + find the default values of the various ``FILES:*`` variables in this file. - If some of the files you provide with the ``FILES`` variable are + 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 @@ -2394,29 +2824,26 @@ system and gives an overview of their function and contents. :term:`FILES_SOLIBSDEV` Defines the file specification to match :term:`SOLIBSDEV`. In other words, - ``FILES_SOLIBSDEV`` defines the full path name of the development + :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: - :: + set:: FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" :term:`FILESEXTRAPATHS` - Extends the search path the OpenEmbedded build system uses when - looking for files and patches as it processes recipes and append - files. The default directories BitBake uses when it processes recipes - are initially defined by the :term:`FILESPATH` - variable. You can extend ``FILESPATH`` variable by using - ``FILESEXTRAPATHS``. + 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 - ``FILESEXTRAPATHS`` from within a ``.bbappend`` file and that you - prepend paths as follows: - :: + :term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you + prepend paths as follows:: - FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}:" + 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 @@ -2424,7 +2851,7 @@ system and gives an overview of their function and contents. .. note:: - When extending ``FILESEXTRAPATHS``, be sure to use the immediate + 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 @@ -2436,26 +2863,23 @@ system and gives an overview of their function and contents. are directing BitBake to extend the path by prepending directories to the search path. - Here is another common use: - :: + Here is another common use:: - FILESEXTRAPATHS_prepend := "${THISDIR}/files:" + FILESEXTRAPATHS:prepend := "${THISDIR}/files:" In this example, the build system extends the - ``FILESPATH`` variable to include a directory named ``files`` that is + :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: - :: + This next example specifically adds three paths:: - FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" + 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: - :: + in a BSP layer:: - FILESEXTRAPATHS_prepend_intel-x86-common := "${THISDIR}/${PN}:" + FILESEXTRAPATHS:prepend:intel-x86-common := "${THISDIR}/${PN}:" The previous statement appears in the ``linux-yocto-dev.bbappend`` file, which is found in the @@ -2467,83 +2891,78 @@ system and gives an overview of their function and contents. .. note:: For a layer that supports a single BSP, the override could just be - the value of ``MACHINE``. + 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 subset of :term:`OVERRIDES` used by the - OpenEmbedded build system for creating - :term:`FILESPATH`. The ``FILESOVERRIDES`` variable - uses overrides to automatically extend the - :term:`FILESPATH` variable. For an example of how - that works, see the :term:`FILESPATH` variable - description. Additionally, you find more information on how overrides - are handled in the - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" + 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 ``FILESOVERRIDES`` variable is defined as: - :: + By default, the :term:`FILESOVERRIDES` variable is defined as:: FILESOVERRIDES = "${TRANSLATED_TARGET_ARCH}:${MACHINEOVERRIDES}:${DISTROOVERRIDES}" .. note:: - Do not hand-edit the ``FILESOVERRIDES`` variable. The values match up + 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` - The default set of directories the OpenEmbedded build system uses - when searching for patches and files. + 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 - ``FILESPATH`` in the specified order when looking for files and + :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 ``FILESPATH`` variable is defined in the - ``base.bbclass`` class found in ``meta/classes`` in the - :term:`Source Directory`: - :: + 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 - ``FILESPATH`` variable is automatically extended using the overrides + :term:`FILESPATH` variable is automatically extended using the overrides from the :term:`FILESOVERRIDES` variable. .. note:: - - Do not hand-edit the ``FILESPATH`` variable. If you want the + - Do not hand-edit the :term:`FILESPATH` variable. If you want the build system to look in directories other than the defaults, - extend the ``FILESPATH`` variable by using the + extend the :term:`FILESPATH` variable by using the :term:`FILESEXTRAPATHS` variable. - - Be aware that the default ``FILESPATH`` directories do not map + - 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 ``FILESPATH`` variable by using the - ``FILESEXTRAPATHS`` variable. + 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 the following directory structure - exists for general and machine-specific configurations: - :: + 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 ``SRC_URI`` statement contains + 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 ``MACHINE`` to + 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``. @@ -2551,7 +2970,7 @@ system and gives an overview of their function and contents. You can find out more about the patching process in the ":ref:`overview-manual/concepts:patching`" section in the Yocto Project Overview and Concepts Manual and the - ":ref:`dev-manual/common-tasks:patching code`" section in + ":ref:`dev-manual/new-recipe:patching code`" section in the Yocto Project Development Tasks Manual. See the :ref:`ref-tasks-patch` task as well. @@ -2568,79 +2987,121 @@ system and gives an overview of their function and contents. permissions setting table, you should place it in your layer or the distro's layer. - You define the ``FILESYSTEM_PERMS_TABLES`` variable in the + 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. + 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 fitImage. The default - value is set by the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` - class as follows:: + 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 fitImage if they - don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. - The default value is 0. + 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. For e.g. sha256. + 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` - Compression algorithm to use for the kernel image inside the FIT Image. - At present, the only supported values are "gzip" (default) or "none" + 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 ".gz". + 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 RSA private key for signing - fitImage. The default value is "-F4". i.e. the public exponent 65537 to - use. + 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 certificate for signing fitImage. - The default value is "-batch -new". batch for non interactive mode - and new for generating new keys. + 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 public key certificate used in signing fitImage. - The default value is "x509". + 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. - For e.g. rsa2048. + This variable is set by default to "rsa2048" by the + :ref:`ref-classes-kernel-fitimage` class. - :term:`FIT_SIGN_NUMBITS` - Size of private key in number of bits used in fitImage. The default - value is "2048". + :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:`kernel-fitimage <ref-classes-kernel-fitimage>` + 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 fitImage itself. This could be useful if you are + 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:`fontcache <ref-classes-fontcache>` class, + When inheriting the :ref:`ref-classes-fontcache` class, this variable specifies the runtime dependencies for font packages. - By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". + By default, the :term:`FONT_EXTRA_RDEPENDS` is set to "fontconfig-utils". :term:`FONT_PACKAGES` - When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, - this variable identifies packages containing font files that need to - be cached by Fontconfig. By default, the ``fontcache`` class assumes + 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. @@ -2652,7 +3113,7 @@ system and gives an overview of their function and contents. Set the variable to "1" to force the removal of these packages. :term:`FULL_OPTIMIZATION` - The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when + The options to pass in :term:`TARGET_CFLAGS` and :term:`CFLAGS` when compiling an optimized system. This variable defaults to "-O2 -pipe ${DEBUG_FLAGS}". @@ -2662,16 +3123,14 @@ system and gives an overview of their function and contents. Programming (ROP) attacks much more difficult to execute. By default the ``security_flags.inc`` file enables PIE by setting the - variable as follows: - :: + variable as follows:: GCCPIE ?= "--enable-default-pie" :term:`GCCVERSION` Specifies the default version of the GNU C Compiler (GCC) used for - compilation. By default, ``GCCVERSION`` is set to "8.x" in the - ``meta/conf/distro/include/tcmode-default.inc`` include file: - :: + compilation. By default, :term:`GCCVERSION` is set to "8.x" in the + ``meta/conf/distro/include/tcmode-default.inc`` include file:: GCCVERSION ?= "8.%" @@ -2681,10 +3140,24 @@ system and gives an overview of their function and contents. :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. @@ -2694,28 +3167,101 @@ system and gives an overview of their function and contents. If you specifically remove the locale ``en_US.UTF-8``, you must set :term:`IMAGE_LINGUAS` appropriately. - You can set ``GLIBC_GENERATE_LOCALES`` in your ``local.conf`` file. - By default, all locales are generated. - :: + 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:`useradd <ref-classes-useradd>` class, + 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: - :: + 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. - GROUPADD_PARAM_${PN} = "-r netdev" + 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:`useradd <ref-classes-useradd>` class, + 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. @@ -2729,7 +3275,7 @@ system and gives an overview of their function and contents. ``local.conf`` or distribution configuration file to enable graphics and serial in the menu. - See the :ref:`grub-efi <ref-classes-grub-efi>` class for more + See the :ref:`ref-classes-grub-efi` class for more information on how this variable is used. :term:`GRUB_OPTS` @@ -2737,25 +3283,27 @@ system and gives an overview of their function and contents. configuration. Use a semi-colon character (``;``) to separate multiple options. - The ``GRUB_OPTS`` variable is optional. See the - :ref:`grub-efi <ref-classes-grub-efi>` class for more information + 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 ``GRUB_TIMEOUT`` variable is optional. See the - :ref:`grub-efi <ref-classes-grub-efi>` class for more information + 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:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class, + 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. @@ -2779,7 +3327,7 @@ system and gives an overview of their function and contents. Specifies architecture-specific compiler flags that are passed to the C compiler. - Default initialization for ``HOST_CC_ARCH`` varies depending on what + Default initialization for :term:`HOST_CC_ARCH` varies depending on what is being built: - :term:`TARGET_CC_ARCH` when building for the @@ -2799,7 +3347,7 @@ system and gives an overview of their function and contents. "linux-musleabi" values possible. :term:`HOST_PREFIX` - Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX`` + Specifies the prefix for the cross-compile toolchain. :term:`HOST_PREFIX` is normally the same as :term:`TARGET_PREFIX`. :term:`HOST_SYS` @@ -2824,11 +3372,15 @@ system and gives an overview of their function and contents. - 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 ``HOSTTOOLS`` is not found on the build + 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. @@ -2841,39 +3393,45 @@ system and gives an overview of their function and contents. filter helps reduce the possibility of host contamination. Unlike :term:`HOSTTOOLS`, the OpenEmbedded build system does not produce an error if a tool specified in the value of - ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can - use ``HOSTTOOLS_NONFATAL`` to filter optional host tools. + :term:`HOSTTOOLS_NONFATAL` is not found on the build host. Thus, you can + use :term:`HOSTTOOLS_NONFATAL` to filter optional host tools. - :term:`HOST_VENDOR` - Specifies the name of the vendor. ``HOST_VENDOR`` is normally the - same as :term:`TARGET_VENDOR`. + :term:`ICECC_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:`icecc.bbclass <ref-classes-icecc>`" + variable, see the ":ref:`ref-classes-icecc`" section. Setting this variable to "1" in your ``local.conf`` disables the - function: - :: + function:: ICECC_DISABLED ??= "1" - To enable the function, set the variable as follows: - :: + To enable the function, set the variable as follows:: ICECC_DISABLED = "" :term:`ICECC_ENV_EXEC` Points to the ``icecc-create-env`` script that you provide. This - variable is used by the :ref:`icecc <ref-classes-icecc>` class. You + 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 - ``icecc-create-env.bb`` recipe, which is a modified version and not - the one that comes with ``icecc``. + :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 @@ -2892,87 +3450,41 @@ system and gives an overview of their function and contents. network lag, available memory, and existing machine loads can all affect build time. Consequently, unlike the :term:`PARALLEL_MAKE` variable, there is no - rule-of-thumb for setting ``ICECC_PARALLEL_MAKE`` to achieve optimal + rule-of-thumb for setting :term:`ICECC_PARALLEL_MAKE` to achieve optimal performance. - If you do not set ``ICECC_PARALLEL_MAKE``, the build system does not + 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 ``PARALLEL_MAKE``). + 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:`icecc <ref-classes-icecc>` class attempts + this variable, the :ref:`ref-classes-icecc` class attempts to define it by locating ``icecc`` using ``which``. - :term:`ICECC_USER_CLASS_BL` - Identifies user classes that you do not want the Icecream distributed - compile support to consider. This variable is used by the - :ref:`icecc <ref-classes-icecc>` class. You set this variable in - your ``local.conf`` file. - - When you list classes using this variable, you are "blacklisting" - them from distributed compilation across remote hosts. Any classes - you list will be distributed and compiled locally. - - :term:`ICECC_USER_PACKAGE_BL` + :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:`icecc <ref-classes-icecc>` class. You set this variable in + :ref:`ref-classes-icecc` class. You set this variable in your ``local.conf`` file. - When you list packages using this variable, you are "blacklisting" - them from distributed compilation across remote hosts. Any packages - you list will be distributed and compiled locally. + 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_USER_PACKAGE_WL` + :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:`icecc <ref-classes-icecc>` class. You set this variable in + :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_EFI_BOOT_FILES` - A space-separated list of files installed into the boot partition - when preparing an image using the Wic tool with the - ``bootimg-efi`` source plugin. By default, - the files are - installed under the same name as the source files. To change the - installed name, separate it from the original name with a semi-colon - (;). Source files need to be located in - :term:`DEPLOY_DIR_IMAGE`. Here are two - examples: - :: - - IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE};bz2" - IMAGE_EFI_BOOT_FILES = "${KERNEL_IMAGETYPE} microcode.cpio" - - Alternatively, source files can be picked up using a glob pattern. In - this case, the destination file must have the same name as the base - name of the source file path. To install files into a directory - within the target location, pass its name after a semi-colon (;). - Here are two examples: - :: - - IMAGE_EFI_BOOT_FILES = "boot/loader/*" - IMAGE_EFI_BOOT_FILES = "boot/loader/*;boot/" - - The first example - installs all files from ``${DEPLOY_DIR_IMAGE}/boot/loader/`` - into the root of the target partition. The second example installs - the same files into a ``boot`` directory within the target partition. - - You can find information on how to use the Wic tool in the - ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" - section of the Yocto Project Development Tasks Manual. Reference - material for Wic is located in the - ":doc:`/ref-manual/kickstart`" chapter. - :term:`IMAGE_BOOT_FILES` A space-separated list of files installed into the boot partition when preparing an image using the Wic tool with the @@ -2982,8 +3494,7 @@ system and gives an overview of their function and contents. 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: - :: + examples:: IMAGE_BOOT_FILES = "u-boot.img uImage;kernel" IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}" @@ -2992,8 +3503,7 @@ system and gives an overview of their function and contents. 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: - :: + Here are two examples:: IMAGE_BOOT_FILES = "bcm2835-bootfiles/*" IMAGE_BOOT_FILES = "bcm2835-bootfiles/*;boot/" @@ -3004,50 +3514,89 @@ system and gives an overview of their function and contents. the same files into a ``boot`` directory within the target partition. You can find information on how to use the Wic tool in the - ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" + ":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_CLASSES` - A list of classes that all images should inherit. You typically use - this variable to specify the list of classes that register the - different types of images the OpenEmbedded build system creates. + :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``". - The default value for ``IMAGE_CLASSES`` is ``image_types``. You can - set this variable in your ``local.conf`` or in a distribution - configuration file. + :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`". - For more information, see ``meta/classes/image_types.bbclass`` in the - :term:`Source Directory`. + :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: - :: + an override for the associated type. Here is an example:: - IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \ - --faketime --output=${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.jffs2 \ + 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:`image_types <ref-classes-image_types>` - class file, which is ``meta/classes/image_types.bbclass``. + 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 ``IMAGE_DEVICE_TABLES`` is not set, + ``/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 @@ -3064,15 +3613,14 @@ system and gives an overview of their function and contents. the ":ref:`ref-features-image`" section. For an example that shows how to customize your image by using this - variable, see the ":ref:`dev-manual/common-tasks:customizing images using custom \`\`image_features\`\` and \`\`extra_image_features\`\``" + 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 - ``IMAGE_FSTYPES`` as follows causes the build system to create root - filesystems using two formats: ``.ext3`` and ``.tar.bz2``: - :: + :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" @@ -3082,31 +3630,29 @@ system and gives an overview of their function and contents. .. note:: - If an image recipe uses the "inherit image" line and you are - setting ``IMAGE_FSTYPES`` inside the recipe, you must set - ``IMAGE_FSTYPES`` prior to using the "inherit image" line. + 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 ``IMAGE_FSTYPES`` variable. + 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:`image <ref-classes-image>` class. Use the - ``IMAGE_INSTALL`` variable with care to avoid ordering issues. + through the :ref:`ref-classes-image` class. Use the + :term:`IMAGE_INSTALL` variable with care to avoid ordering issues. - Image recipes set ``IMAGE_INSTALL`` to specify the packages to - install into an image through ``image.bbclass``. Additionally, - "helper" classes such as the - :ref:`core-image <ref-classes-core-image>` class exist that can - take lists used with ``IMAGE_FEATURES`` and turn them into - auto-generated entries in ``IMAGE_INSTALL`` in addition to its - default contents. + 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: - :: + When you use this variable, it is best to use it as follows:: - IMAGE_INSTALL_append = " package-name" + IMAGE_INSTALL:append = " package-name" Be sure to include the space between the quotation character and the start of the package name or @@ -3116,39 +3662,38 @@ system and gives an overview of their function and contents. - When working with a :ref:`core-image-minimal-initramfs <ref-manual/images:images>` - image, do not use the ``IMAGE_INSTALL`` variable to specify + 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 (initramfs) recipe to use a - fixed set of packages and not be affected by ``IMAGE_INSTALL``. - For information on creating an initramfs, see the - ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" + 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 ``IMAGE_INSTALL`` with the - :ref:`+= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending (+=) and prepending (=+) with spaces>` + - 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 - ``core-image.bbclass`` sets ``IMAGE_INSTALL`` to a default - value using the - :ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>` - operator, using a ``+=`` operation against ``IMAGE_INSTALL`` + 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. + ``conf/local.conf``. Furthermore, the same operation from within an + image recipe may or may not succeed depending on the specific + situation. In both these cases, the behavior is contrary to how + most users expect the ``+=`` operator to work. :term:`IMAGE_LINGUAS` Specifies the list of locales to install into the image during the root filesystem construction process. The OpenEmbedded build system automatically splits locale files, which are used for localization, - into separate packages. Setting the ``IMAGE_LINGUAS`` variable + 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: - :: + an example:: IMAGE_LINGUAS = "pt-br de-de" @@ -3166,54 +3711,72 @@ system and gives an overview of their function and contents. :term:`IMAGE_LINK_NAME` The name of the output image symlink (which does not include the version part as :term:`IMAGE_NAME` does). The default value - is derived using the :term:`IMAGE_BASENAME` and :term:`MACHINE` - variables: - :: + 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_BASENAME}-${MACHINE}" + 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: - :: + information on a line-per-package basis as follows:: packagename packagearch version - The :ref:`image <ref-classes-image>` class defines the manifest - file as follows: - :: + The :ref:`rootfs-postcommands <ref-classes-rootfs*>` class defines the manifest + file as follows:: - IMAGE_MANIFEST ="${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest" + IMAGE_MANIFEST ="${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.manifest" The location is - derived using the :term:`DEPLOY_DIR_IMAGE` + 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. This variable - is derived using the :term:`IMAGE_BASENAME`, - :term:`MACHINE`, and :term:`IMAGE_VERSION_SUFFIX` - variables: - :: + 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_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + IMAGE_NAME ?= "${IMAGE_LINK_NAME}${IMAGE_VERSION_SUFFIX}" :term:`IMAGE_NAME_SUFFIX` - Suffix used for the image output file name - defaults to ``".rootfs"`` + 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 initramfs image recipes. + 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 - ``IMAGE_ROOTFS_SIZE`` and ``IMAGE_ROOTFS_EXTRA_SPACE``. The result 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 @@ -3222,40 +3785,31 @@ system and gives an overview of their function and contents. post install scripts and the package management system uses disk space inside this overhead area. Consequently, the multiplier does not produce an image with all the theoretical free disk space. See - ``IMAGE_ROOTFS_SIZE`` for information on how the build system + :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: - :: + gives you 50% free space added to the image:: IMAGE_OVERHEAD_FACTOR = "1.5" Alternatively, you can ensure a specific amount of free disk space is - added to the image by using the ``IMAGE_ROOTFS_EXTRA_SPACE`` + 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:`package_deb <ref-classes-package_deb>`, - :ref:`package_rpm <ref-classes-package_rpm>`, - :ref:`package_ipk <ref-classes-package_ipk>`, or - :ref:`package_tar <ref-classes-package_tar>` class. - - .. note:: + the :ref:`ref-classes-package_deb`, :ref:`ref-classes-package_rpm`, + or :ref:`ref-classes-package_ipk` class. - The ``package_tar`` class is broken and is not supported. It is - recommended that you do not use it. + The :ref:`ref-classes-populate-sdk-*` and :ref:`ref-classes-image` + classes use the :term:`IMAGE_PKGTYPE` for packaging up images and SDKs. - The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and - :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE`` - for packaging up images and SDKs. - - You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the + 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 @@ -3271,10 +3825,9 @@ system and gives an overview of their function and contents. :term:`IMAGE_POSTPROCESS_COMMAND` Specifies a list of functions to call once the OpenEmbedded build system creates the final image output files. You can specify - functions separated by semicolons: - :: + functions separated by spaces:: - IMAGE_POSTPROCESS_COMMAND += "function; ... " + 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 @@ -3285,10 +3838,9 @@ system and gives an overview of their function and contents. :term:`IMAGE_PREPROCESS_COMMAND` Specifies a list of functions to call before the OpenEmbedded build system creates the final image output files. You can specify - functions separated by semicolons: - :: + functions separated by spaces:: - IMAGE_PREPROCESS_COMMAND += "function; ... " + 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 @@ -3312,19 +3864,17 @@ system and gives an overview of their function and contents. Defines additional free disk space created in the image in Kbytes. By default, this variable is set to "0". This free disk space is added to the image after the build system determines the image size as - described in ``IMAGE_ROOTFS_SIZE``. + 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: - :: + 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: - :: + 40 Gbytes of extra space with the line:: IMAGE_ROOTFS_EXTRA_SPACE = "41943040" @@ -3335,8 +3885,7 @@ system and gives an overview of their function and contents. 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: - :: + follows:: if (image-du * overhead) < rootfs-size: internal-rootfs-size = rootfs-size + xspace @@ -3355,10 +3904,9 @@ system and gives an overview of their function and contents. :term:`IMAGE_TYPEDEP` Specifies a dependency from one image type on another. Here is an - example from the :ref:`image-live <ref-classes-image-live>` class: - :: + example from the :ref:`ref-classes-image-live` class:: - IMAGE_TYPEDEP_live = "ext3" + IMAGE_TYPEDEP:live = "ext3" In the previous example, the variable ensures that when "live" is listed with the :term:`IMAGE_FSTYPES` variable, @@ -3377,6 +3925,9 @@ system and gives an overview of their function and contents. - cpio.lzma - cpio.xz - cramfs + - erofs + - erofs-lz4 + - erofs-lz4hc - ext2 - ext2.bz2 - ext2.gz @@ -3409,7 +3960,7 @@ system and gives an overview of their function and contents. - wic.lzma For more information about these types of images, see - ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`. + ``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 @@ -3419,99 +3970,85 @@ system and gives an overview of their function and contents. desired, and this suffix would then be used consistently across the build artifacts. - :term:`INC_PR` - Helps define the recipe revision for recipes that share a common - ``include`` file. You can think of this variable as part of the - recipe revision as set from within an include file. - - Suppose, for example, you have a set of recipes that are used across - several projects. And, within each of those recipes the revision (its - :term:`PR` value) is set accordingly. In this case, when - the revision of those recipes changes, the burden is on you to find - all those recipes and be sure that they get changed to reflect the - updated version of the recipe. In this scenario, it can get - complicated when recipes that are used in many places and provide - common functionality are upgraded to a new revision. - - A more efficient way of dealing with this situation is to set the - ``INC_PR`` variable inside the ``include`` files that the recipes - share and then expand the ``INC_PR`` variable within the recipes to - help define the recipe revision. - - The following provides an example that shows how to use the - ``INC_PR`` variable given a common ``include`` file that defines the - variable. Once the variable is defined in the ``include`` file, you - can use the variable to set the ``PR`` values in each recipe. You - will notice that when you set a recipe's ``PR`` you can provide more - granular revisioning by appending values to the ``INC_PR`` variable: - :: - - recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" - recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1" - recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0" - recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" + :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:: - The - first line of the example establishes the baseline revision to be - used for all recipes that use the ``include`` file. The remaining - lines in the example are from individual recipes and show how the - ``PR`` value is set. + 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. Recipes that provide no alternatives to listed + 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: - :: + setting:: - INCOMPATIBLE_LICENSE = "GPL-3.0 LGPL-3.0 AGPL-3.0" + 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 + remove dependencies on (or provide alternatives to) components that are required to produce a functional system image. - .. note:: + :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:: - It is possible to define a list of licenses that are allowed to be - used instead of the licenses that are excluded. To do this, define - a variable ``COMPATIBLE_LICENSES`` with the names of the licenses - that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as: - :: - - INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}" - - - This will result in ``INCOMPATIBLE_LICENSE`` containing the names of - all licenses from :term:`AVAILABLE_LICENSES` except the ones specified - in ``COMPATIBLE_LICENSES``, thus only allowing the latter licenses to - be used. + 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 ``INHERIT`` in individual recipes. + 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 ``INHERIT``, see the - :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" - section in the Bitbake User Manual. + 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: - :: + ``meta/conf/distro/defaultsetup.conf`` file:: - INHERIT_DISTRO ?= "debian devshell sstate license" + INHERIT_DISTRO ?= "debian devshell sstate license remove-libtool create-spdx" :term:`INHIBIT_DEFAULT_DEPS` Prevents the default dependencies, namely the C compiler and standard @@ -3532,9 +4069,8 @@ system and gives an overview of their function and contents. variable. To prevent the build system from splitting out debug information - during packaging, set the ``INHIBIT_PACKAGE_DEBUG_SPLIT`` variable as - follows: - :: + during packaging, set the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable as + follows:: INHIBIT_PACKAGE_DEBUG_SPLIT = "1" @@ -3545,7 +4081,7 @@ system and gives an overview of their function and contents. By default, the OpenEmbedded build system strips binaries and puts the debugging symbols into ``${``\ :term:`PN`\ ``}-dbg``. - Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you + Consequently, you should not set :term:`INHIBIT_PACKAGE_STRIP` when you plan to debug in general. :term:`INHIBIT_SYSROOT_STRIP` @@ -3554,46 +4090,80 @@ system and gives an overview of their function and contents. By default, the OpenEmbedded build system strips binaries in the resulting sysroot. When you specifically set the - ``INHIBIT_SYSROOT_STRIP`` variable to "1" in your recipe, you inhibit + :term:`INHIBIT_SYSROOT_STRIP` variable to "1" in your recipe, you inhibit this stripping. - If you want to use this variable, include the - :ref:`staging <ref-classes-staging>` class. This class uses a - ``sys_strip()`` function to test for the variable and acts - accordingly. + 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 ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and + 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, other files exist - that are needed for the build that are not strippable. + 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 - (initramfs), which is used during boot. Supported formats are the + (: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 - initramfs mechanism, as opposed to the initial RAM filesystem - `initrd <https://en.wikipedia.org/wiki/Initrd>`__ mechanism, expects + :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 (initramfs) - image. In other words, the ``INITRAMFS_IMAGE`` variable causes an + 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 - initramfs image recipe you provide should set + :term:`Initramfs` image recipe you provide should set :term:`IMAGE_FSTYPES` to :term:`INITRAMFS_FSTYPES`. - An initramfs image provides a temporary root filesystem used for + 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). @@ -3601,24 +4171,24 @@ system and gives an overview of their function and contents. See the ``meta/recipes-core/images/core-image-minimal-initramfs.bb`` recipe in the :term:`Source Directory` - for an example initramfs recipe. To select this sample recipe as - the one built to provide the initramfs image, set ``INITRAMFS_IMAGE`` + 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/local.conf.sample.extended`` configuration file in - the Source Directory, the :ref:`image <ref-classes-image>` class, - and the :ref:`kernel <ref-classes-kernel>` class to see how to use - the ``INITRAMFS_IMAGE`` variable. + ``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 ``INITRAMFS_IMAGE`` is empty, which is the default, then no - initramfs image is built. + 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 initramfs - image, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section + 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` @@ -3627,102 +4197,121 @@ system and gives an overview of their function and contents. extra pass (:ref:`ref-tasks-bundle_initramfs`) during kernel compilation in order to build a single binary that contains - both the kernel image and the initial RAM filesystem (initramfs) + both the kernel image and the initial RAM filesystem (:term:`Initramfs`) image. This makes use of the :term:`CONFIG_INITRAMFS_SOURCE` kernel feature. .. note:: - Using an extra compilation pass to bundle the initramfs avoids a - circular dependency between the kernel recipe and the initramfs - recipe should the initramfs include kernel modules. Should that be - the case, the initramfs recipe depends on the kernel for the - kernel modules, and the kernel depends on the initramfs recipe - since the initramfs is bundled inside the kernel image. + 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 - initramfs specified in ``INITRAMFS_IMAGE`` bundled within: - :: + :term:`Initramfs` specified in :term:`INITRAMFS_IMAGE` bundled within:: INITRAMFS_IMAGE_BUNDLE = "1" - By default, the - :ref:`kernel <ref-classes-kernel>` class sets this variable to a - null string as follows: - :: + 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 ``INITRAMFS_IMAGE_BUNDLE`` variable in a + 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/local.conf.sample.extended>` + :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 - initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section + :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/kernel-artifact-names.bbclass`` file as - follows: - :: + 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: - :: + 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/kernel-artifact-names.bbclass`` file as - follows: - :: + set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as + follows:: INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" - The value of the :term:`KERNEL_ARTIFACT_NAME` - variable, which is set in the same file, has the following value: - :: - - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + 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 ``INITRD`` variable is an optional variable used with the - :ref:`image-live <ref-classes-image-live>` class. + 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"), - ``INITRD_IMAGE`` specifies the image recipe that should be built to + :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:`image-live <ref-classes-image-live>` class for more - information. + 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 ``update-rc.d.bbclass``. + This variable is used in recipes when using :ref:`ref-classes-update-rc.d`. The variable is mandatory. :term:`INITSCRIPT_PACKAGES` @@ -3730,13 +4319,12 @@ system and gives an overview of their function and contents. are specified, you need to append the package name to the other ``INITSCRIPT_*`` as an override. - This variable is used in recipes when using ``update-rc.d.bbclass``. + 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: - :: + Specifies the options to pass to ``update-rc.d``. Here is an example:: INITSCRIPT_PARAMS = "start 99 5 2 . stop 20 0 1 6 ." @@ -3744,9 +4332,9 @@ system and gives an overview of their function and contents. in initlevels 2 and 5, and stops the script in levels 0, 1 and 6. The variable's default value is "defaults", which is set in the - :ref:`update-rc.d <ref-classes-update-rc.d>` class. + :ref:`ref-classes-update-rc.d` class. - The value in ``INITSCRIPT_PARAMS`` is passed through to the + 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 @@ -3756,17 +4344,16 @@ system and gives an overview of their function and contents. 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}``: - :: + is ``${PN}``:: - INSANE_SKIP_${PN} += "dev-so" + INSANE_SKIP:${PN} += "dev-so" - See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a + 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 ``INSTALL_TIMEZONE_FILE`` variable to "0" at the + Set the :term:`INSTALL_TIMEZONE_FILE` variable to "0" at the configuration level to disable this behavior. :term:`IPK_FEED_URIS` @@ -3787,7 +4374,7 @@ system and gives an overview of their function and contents. - qemu - mips - You define the ``KARCH`` variable in the :ref:`kernel-dev/advanced:bsp descriptions`. + 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 @@ -3798,34 +4385,31 @@ system and gives an overview of their function and contents. Values for this variable are set in the kernel's recipe file and the kernel's append file. For example, if you are using the ``linux-yocto_4.12`` kernel, the kernel recipe file is the - ``meta/recipes-kernel/linux/linux-yocto_4.12.bb`` file. ``KBRANCH`` - is set as follows in that kernel recipe file: - :: + ``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 (i.e. ``linux-yocto_4.12.bbappend``) is located in the + append file 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 + 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_4.12.bbappend``. - Here are the related statements from that append file: - :: + ``meta-yocto-bsp/recipes-kernel/linux/linux-yocto_6.1.bbappend``. + Here are the related statements from that append file:: - KBRANCH_genericx86 = "standard/base" - KBRANCH_genericx86-64 = "standard/base" - KBRANCH_edgerouter = "standard/edgerouter" - KBRANCH_beaglebone = "standard/beaglebone" + KBRANCH:genericx86 = "v6.1/standard/base" + KBRANCH:genericx86-64 = "v6.1/standard/base" + KBRANCH:beaglebone-yocto = "v6.1/standard/beaglebone" - The ``KBRANCH`` statements + The :term:`KBRANCH` statements identify the kernel branch to use when building for each supported BSP. :term:`KBUILD_DEFCONFIG` - When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>` + When used with the :ref:`ref-classes-kernel-yocto` class, specifies an "in-tree" kernel configuration file for use during a kernel build. @@ -3834,60 +4418,118 @@ system and gives an overview of their function and contents. would place patch files and configuration fragment files (i.e. "out-of-tree"). However, if you want to use a ``defconfig`` file that is part of the kernel tree (i.e. "in-tree"), you can use the - ``KBUILD_DEFCONFIG`` variable and append the + :term:`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: - :: + using the following form:: - KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file + KBUILD_DEFCONFIG:<machine> ?= "defconfig_file" - Here is an example from a "raspberrypi2" ``KMACHINE`` build that uses - a ``defconfig`` file named "bcm2709_defconfig": - :: + Here is an example from a "raspberrypi2" :term:`MACHINE` build that uses + a ``defconfig`` file named "bcm2709_defconfig":: - KBUILD_DEFCONFIG_raspberrypi2 = "bcm2709_defconfig" + KBUILD_DEFCONFIG:raspberrypi2 = "bcm2709_defconfig" - As an alternative, you can use the following within your append file: - :: + As an alternative, you can use the following within your append file:: - KBUILD_DEFCONFIG_pn-linux-yocto ?= defconfig_file + KBUILD_DEFCONFIG:pn-linux-yocto ?= "defconfig_file" For more - information on how to use the ``KBUILD_DEFCONFIG`` variable, see the + 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` variable. + 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 ``KERNEL_ARTIFACT_NAME`` + name of the artifacts by changing the :term:`KERNEL_ARTIFACT_NAME` variable. - The value of ``KERNEL_ARTIFACT_NAME``, which is set in the - ``meta/classes/kernel-artifact-names.bbclass`` file, has the - following default value: - :: + 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}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}${IMAGE_MACHINE_SUFFIX}${IMAGE_VERSION_SUFFIX}" - See the :term:`PKGE`, :term:`PKGV`, :term:`PKGR`, :term:`MACHINE` + 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:`kernel <ref-classes-kernel>` class should inherit. You - typically append this variable to enable extended image types. An - example is the "kernel-fitimage", which enables fitImage support and - resides in ``meta/classes/kernel-fitimage.bbclass``. You can register - custom kernel image types with the ``kernel`` class using this - variable. + :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. @@ -3895,25 +4537,32 @@ system and gives an overview of their function and contents. .. note:: - Legacy support exists for specifying the full path to the device + 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:`kernel-devicetree <ref-classes-kernel-devicetree>` class must - be inherited. + 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/kernel-artifact-names.bbclass`` file as - follows: - :: + 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: - :: + the same file, has the following value:: KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" @@ -3922,26 +4571,37 @@ system and gives an overview of their function and contents. :term:`KERNEL_DTB_NAME` The base name of the kernel device tree binary (DTB). This variable - is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as - follows: - :: + is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as + follows:: KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" - The value of the :term:`KERNEL_ARTIFACT_NAME` - variable, which is set in the same file, has the following value: - :: + See :term:`KERNEL_ARTIFACT_NAME` for additional information. - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + :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:`kernel-devicetree <ref-classes-kernel-devicetree>` class must - be inherited. + 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 @@ -3952,40 +4612,37 @@ system and gives an overview of their function and contents. system, the default Board Support Packages (BSPs) :term:`Metadata` is provided through the :term:`KMACHINE` and :term:`KBRANCH` - variables. You can use the ``KERNEL_FEATURES`` variable from within + 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 ``KERNEL_FEATURES`` + 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: - :: + 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" + KERNEL_FEATURES:append = " ${KERNEL_EXTRA_FEATURES}" + KERNEL_FEATURES:append:qemuall = " cfg/virtio.scc" + KERNEL_FEATURES:append:qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc" + KERNEL_FEATURES:append:qemux86-64 = " cfg/sound.scc" :term:`KERNEL_FIT_LINK_NAME` The link name of the kernel flattened image tree (FIT) image. This - variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` - file as follows: - :: + 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: - :: + file, has the following value:: KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" @@ -3994,29 +4651,22 @@ system and gives an overview of their function and contents. :term:`KERNEL_FIT_NAME` The base name of the kernel flattened image tree (FIT) image. This - variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` - file as follows: - :: + variable is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` + file as follows:: KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" - The value of the :term:`KERNEL_ARTIFACT_NAME` - variable, which is set in the same file, has the following value: - :: - - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + 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/kernel-artifact-names.bbclass`` file as follows: - :: + ``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: - :: + file, has the following value:: KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" @@ -4025,12 +4675,12 @@ system and gives an overview of their function and contents. :term:`KERNEL_IMAGE_MAXSIZE` Specifies the maximum size of the kernel image file in kilobytes. If - ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is + :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. - ``KERNEL_IMAGE_MAXSIZE`` is useful for target devices that have a + :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 @@ -4038,17 +4688,11 @@ system and gives an overview of their function and contents. :term:`KERNEL_IMAGE_NAME` The base name of the kernel image. This variable is set in the - ``meta/classes/kernel-artifact-names.bbclass`` file as follows: - :: + ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows:: KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" - The value of the - :term:`KERNEL_ARTIFACT_NAME` variable, - which is set in the same file, has the following value: - :: - - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + 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 @@ -4056,9 +4700,12 @@ system and gives an overview of their function and contents. when building the kernel and is passed to ``make`` as the target to build. - If you want to build an alternate kernel image type in addition to that - specified by ``KERNEL_IMAGETYPE``, use the :term:`KERNEL_ALT_IMAGETYPE` - variable. + 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. @@ -4068,23 +4715,21 @@ system and gives an overview of their function and contents. This variable replaces the deprecated :term:`module_autoload` variable. - You can use the ``KERNEL_MODULE_AUTOLOAD`` variable anywhere that it + 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: - :: + Specify it as follows:: KERNEL_MODULE_AUTOLOAD += "module_name1 module_name2 module_name3" - Including ``KERNEL_MODULE_AUTOLOAD`` causes the OpenEmbedded build + 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: - :: + case:: KERNEL_MODULE_AUTOLOAD += "module_name" @@ -4098,56 +4743,65 @@ system and gives an overview of their function and contents. 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:`module <ref-classes-module>` class. For information on - how this variable is used, see the + 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 ``KERNEL_PATH`` variable. Both variables are common variables + 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:`module <ref-classes-module>` class. For information on - how this variable is used, see the + 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 ``KERNEL_SRC`` variable. Both variables are common variables + 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 affect until the kernel has been + 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. The - ``KERNELDEPMODDEPEND`` does not control whether or not that data + :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 ``KERNELDEPMODDEPEND`` variable in your - ``initramfs`` recipe. Setting the variable there when the data is not + 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: - :: + to describe SMP being enabled:: define KFEATURE_DESCRIPTION "Enable SMP" @@ -4158,23 +4812,22 @@ system and gives an overview of their function and contents. OpenEmbedded build system understands as ``core2-32-intel-common`` goes by a different name in the Linux Yocto kernel. The kernel understands that machine as ``intel-core2-32``. For cases like these, - the ``KMACHINE`` variable maps the kernel machine name to the + 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 ``KMACHINE`` statement says + ``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". @@ -4187,7 +4840,7 @@ system and gives an overview of their function and contents. Yocto Project Linux Kernel Development Manual for more information on kernel types. - You define the ``KTYPE`` variable in the + 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 @@ -4196,14 +4849,13 @@ system and gives an overview of their function and contents. :term:`LABELS` Provides a list of targets for automatic configuration. - See the :ref:`grub-efi <ref-classes-grub-efi>` class for more + 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: - :: + by adding it to the end of the layer name. Here is an example:: LAYERDEPENDS_mylayer = "anotherlayer (=3)" @@ -4222,14 +4874,16 @@ system and gives an overview of their function and contents. 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: - :: + Here is an example:: LAYERRECOMMENDS_mylayer = "anotherlayer (=3)" @@ -4241,32 +4895,7 @@ system and gives an overview of their function and contents. ``LAYERRECOMMENDS_mylayer``). :term:`LAYERSERIES_COMPAT` - Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which - a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable - allows the layer maintainer to indicate which combinations of the - layer and OE-Core can be expected to work. The variable gives the - system a way to detect when a layer has not been tested with new - releases of OE-Core (e.g. the layer is not maintained). - - To specify the OE-Core versions for which a layer is compatible, use - this variable in your layer's ``conf/layer.conf`` configuration file. - For the list, use the Yocto Project - :yocto_wiki:`Release Name </Releases>` (e.g. - &DISTRO_NAME_NO_CAP;). To specify multiple OE-Core versions for the - layer, use a space-separated list: - :: - - LAYERSERIES_COMPAT_layer_root_name = "&DISTRO_NAME_NO_CAP; &DISTRO_NAME_NO_CAP_MINUS_ONE;" - - .. note:: - - Setting ``LAYERSERIES_COMPAT`` is required by the Yocto Project - Compatible version 2 standard. - The OpenEmbedded build system produces a warning if the variable - is not set for any given layer. - - See the ":ref:`dev-manual/common-tasks:creating your own layer`" - section in the Yocto Project Development Tasks Manual. + See :term:`bitbake:LAYERSERIES_COMPAT` in the BitBake manual. :term:`LAYERVERSION` Optionally specifies the version of a layer as a single number. You @@ -4284,7 +4913,7 @@ system and gives an overview of their function and contents. to an environment variable and thus made visible to the software being built during the compilation step. - Default initialization for ``LDFLAGS`` varies depending on what is + Default initialization for :term:`LDFLAGS` varies depending on what is being built: - :term:`TARGET_LDFLAGS` when building for the @@ -4298,10 +4927,11 @@ system and gives an overview of their function and contents. :term:`LEAD_SONAME` Specifies the lead (or primary) compiled library file (i.e. ``.so``) - that the :ref:`debian <ref-classes-debian>` class applies its + 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 ``debian`` class. + 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. @@ -4314,7 +4944,7 @@ system and gives an overview of their function and contents. This variable must be defined for all recipes (unless :term:`LICENSE` is set to "CLOSED"). - For more information, see the ":ref:`dev-manual/common-tasks:tracking license changes`" + For more information, see the ":ref:`dev-manual/licenses:tracking license changes`" section in the Yocto Project Development Tasks Manual. :term:`LICENSE` @@ -4325,8 +4955,8 @@ system and gives an overview of their function and contents. - Separate license names using \| (pipe) when there is a choice between licenses. - - Separate license names using & (ampersand) when multiple licenses - exist that cover different parts of the source. + - Separate license names using & (ampersand) when there are + multiple licenses for different parts of the source. - You can use spaces between license names. @@ -4335,12 +4965,11 @@ system and gives an overview of their function and contents. :term:`SPDXLICENSEMAP` flag names defined in ``meta/conf/licenses.conf``. - Here are some examples: - :: + Here are some examples:: - LICENSE = "LGPLv2.1 | GPLv3" - LICENSE = "MPL-1 & LGPLv2.1" - LICENSE = "GPLv2+" + 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 @@ -4353,19 +4982,18 @@ system and gives an overview of their function and contents. 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: - :: + Documentation License 1.2 could be specified as follows:: - LICENSE = "GFDL-1.2 & GPLv2" - LICENSE_${PN} = "GPLv2" - LICENSE_${PN}-doc = "GFDL-1.2" + 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 ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded + 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}``. + :term:`RRECOMMENDS`\ ``:${PN}``. The ``${PN}-lic`` package installs a directory in ``/usr/share/licenses`` named ``${PN}``, which is the recipe's base @@ -4380,37 +5008,52 @@ system and gives an overview of their function and contents. For related information on providing license text, see the :term:`COPY_LIC_DIRS` variable, the :term:`COPY_LIC_MANIFEST` variable, and the - ":ref:`dev-manual/common-tasks:providing license text`" + ":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 whitelist through - :term:`LICENSE_FLAGS_WHITELIST` in - order to allow the recipe to be built. When providing multiple 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/common-tasks:enabling commercially licensed recipes`" + ":ref:`dev-manual/licenses:enabling commercially licensed recipes`" section in the Yocto Project Development Tasks Manual. - :term:`LICENSE_FLAGS_WHITELIST` + :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. This practice is otherwise - known as "whitelisting" license flags. For more information, see the - ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" + 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 ``COMMON_LICENSE_DIR`` to define the + OpenEmbedded build system uses :term:`COMMON_LICENSE_DIR` to define the directory that holds common license text used during the build. The - ``LICENSE_PATH`` variable allows you to extend that location to other - areas that have additional licenses: - :: + :term:`LICENSE_PATH` variable allows you to extend that location to other + areas that have additional licenses:: LICENSE_PATH += "path-to-additional-common-licenses" @@ -4422,9 +5065,9 @@ system and gives an overview of their function and contents. Yocto Project Linux Kernel Development Manual for more information on kernel types. - If you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to + If you do not specify a :term:`LINUX_KERNEL_TYPE`, it defaults to "standard". Together with :term:`KMACHINE`, the - ``LINUX_KERNEL_TYPE`` variable defines the search arguments used by + :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. @@ -4434,14 +5077,12 @@ system and gives an overview of their function and contents. 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: - :: + ``meta/recipes-kernel/linux`` defines the variables as follows:: LINUX_VERSION ?= "3.4.24" - The ``LINUX_VERSION`` variable is used to define :term:`PV` - for the recipe: - :: + The :term:`LINUX_VERSION` variable is used to define :term:`PV` + for the recipe:: PV = "${LINUX_VERSION}+git${SRCPV}" @@ -4449,16 +5090,14 @@ system and gives an overview of their function and contents. 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: - :: + 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: - :: + assuming it was set as previously shown:: $ uname -r 3.7.0-rc8-custom @@ -4472,24 +5111,22 @@ system and gives an overview of their function and contents. :term:`MACHINE` Specifies the target device for which the image is built. You define - ``MACHINE`` in the ``local.conf`` file found in the - :term:`Build Directory`. By default, ``MACHINE`` is set to + :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: - :: + using QEMU:: MACHINE ?= "qemux86" The variable corresponds to a machine configuration file of the same name, through which machine-specific configurations are set. Thus, - when ``MACHINE`` is set to "qemux86" there exists the corresponding - ``qemux86.conf`` machine configuration file, which can be found in + 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: - :: + include the following:: MACHINE ?= "qemuarm" MACHINE ?= "qemuarm64" @@ -4501,7 +5138,6 @@ system and gives an overview of their function and contents. MACHINE ?= "genericx86" MACHINE ?= "genericx86-64" MACHINE ?= "beaglebone" - MACHINE ?= "edgerouter" The last five are Yocto Project reference hardware boards, which are provided in the ``meta-yocto-bsp`` layer. @@ -4509,13 +5145,13 @@ system and gives an overview of their function and contents. .. note:: Adding additional Board Support Package (BSP) layers to your - configuration adds new possible settings for ``MACHINE``. + 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 ``MACHINE_ARCH`` variable. + the :term:`MACHINE_ARCH` variable. :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS` A list of required machine-specific packages to install as part of @@ -4527,7 +5163,7 @@ system and gives an overview of their function and contents. image. This variable is similar to the - ``MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`` variable with the exception + :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. @@ -4535,8 +5171,7 @@ system and gives an overview of their function and contents. 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: - :: + ``.conf`` configuration file:: MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init" @@ -4549,7 +5184,7 @@ system and gives an overview of their function and contents. on ``packagegroup-core-boot``, including the ``core-image-minimal`` image. - This variable is similar to the ``MACHINE_ESSENTIAL_EXTRA_RDEPENDS`` + 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 @@ -4567,8 +5202,7 @@ system and gives an overview of their function and contents. "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: - :: + use the following in the machine's ``.conf`` configuration file:: MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-module-ab123" @@ -4592,7 +5226,7 @@ system and gives an overview of their function and contents. which does not include the ``core-image-minimal`` or ``core-image-full-cmdline`` images. - The variable is similar to the ``MACHINE_EXTRA_RRECOMMENDS`` variable + 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. @@ -4604,8 +5238,7 @@ system and gives an overview of their function and contents. 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: - :: + following in the ``.conf`` file for the machine:: MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware" @@ -4618,7 +5251,7 @@ system and gives an overview of their function and contents. which does not include the ``core-image-minimal`` or ``core-image-full-cmdline`` images. - This variable is similar to the ``MACHINE_EXTRA_RDEPENDS`` variable + 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. @@ -4631,8 +5264,7 @@ system and gives an overview of their function and contents. 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: - :: + following in the ``.conf`` file for the machine:: MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi" @@ -4648,51 +5280,73 @@ system and gives an overview of their function and contents. shipped, see the ":ref:`ref-features-machine`" section. :term:`MACHINE_FEATURES_BACKFILL` - Features to be added to ``MACHINE_FEATURES`` if not also present in - ``MACHINE_FEATURES_BACKFILL_CONSIDERED``. + 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 backfilled for - all machine configurations. See the ":ref:`ref-features-backfill`" - section for more information. + 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` - Features from ``MACHINE_FEATURES_BACKFILL`` that should not be - backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See - the ":ref:`ref-features-backfill`" section for more information. + 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 ``MACHINEOVERRIDES`` to add extra overrides that + 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 ``MACHINEOVERRIDES``: - :: + 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: - :: + recipe:: - SRC_URI_append_qemuall = " file://wired.config \ + SRC_URI:append:qemuall = " file://wired.config \ file://wired-setup \ " The underlying mechanism behind - ``MACHINEOVERRIDES`` is simply that it is included in the default + :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`). @@ -4701,67 +5355,69 @@ system and gives an overview of their function and contents. 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 ``MIRRORS`` in that order. + locations specified by :term:`MIRRORS` in that order. - Assuming your distribution (:term:`DISTRO`) is "poky", - the default value for ``MIRRORS`` is defined in the - ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. + 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 the name (e.g. the :term:`BPN` variable). - ``MLPREFIX`` gets set when a prefix has been added to ``PN``. + 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 ``MLPREFIX`` stands for "MultiLib". This representation is - historical and comes from a time when ``nativesdk`` was a suffix - rather than a prefix on the recipe name. When ``nativesdk`` was turned - into a prefix, it made sense to set ``MLPREFIX`` for it as well. - - To help understand when ``MLPREFIX`` might be needed, consider when - :term:`BBCLASSEXTEND` is used to provide a - ``nativesdk`` version of a recipe in addition to the target version. - If that recipe declares build-time dependencies on tasks in other - recipes by using :term:`DEPENDS`, then a dependency on - "foo" will automatically get rewritten to a dependency on - "nativesdk-foo". However, dependencies like the following will not - get rewritten automatically: - :: + 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: - :: + following:: do_foo[depends] += "${MLPREFIX}recipe:do_foo" - module_autoload - This variable has been replaced by the ``KERNEL_MODULE_AUTOLOAD`` - variable. You should replace all occurrences of ``module_autoload`` - with additions to ``KERNEL_MODULE_AUTOLOAD``, for example: - :: + :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: - :: + should now be replaced with:: KERNEL_MODULE_AUTOLOAD += "rfcomm" See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. - module_conf - Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`_ + :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. @@ -4770,24 +5426,22 @@ system and gives an overview of their function and contents. configuration file, a distribution configuration file, an append file for the recipe, or the recipe itself). If you use this variable, you must also be sure to list the module name in the - :term:`KERNEL_MODULE_AUTOLOAD` + :term:`KERNEL_MODULE_PROBECONF` variable. - Here is the general syntax: - :: + Here is the general syntax:: module_conf_module_name = "modprobe.d-syntax" You must use the kernel module name override. Run ``man modprobe.d`` in the shell to find out more information on - the exact syntax you want to provide with ``module_conf``. + the exact syntax you want to provide with :term:`module_conf`. - Including ``module_conf`` causes the OpenEmbedded build system to + 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``: - :: + ``arg1`` and ``arg2`` to a module named ``mymodule``:: module_conf_mymodule = "options mymodule arg1=val1 arg2=val2" @@ -4801,15 +5455,13 @@ system and gives an overview of their function and contents. :term:`MODULE_TARBALL_LINK_NAME` The link name of the kernel module tarball. This variable is set in - the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: - :: + 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: - :: + same file, has the following value:: KERNEL_ARTIFACT_LINK_NAME ?= "${MACHINE}" @@ -4817,16 +5469,16 @@ system and gives an overview of their function and contents. :term:`MODULE_TARBALL_NAME` The base name of the kernel module tarball. This variable is set in - the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: - :: + the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows:: MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" - The value of the :term:`KERNEL_ARTIFACT_NAME` variable, - which is set in the same file, has the following value: - :: + See :term:`KERNEL_ARTIFACT_NAME` for additional information. - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + :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 @@ -4834,14 +5486,12 @@ system and gives an overview of their function and contents. target systems to be put into different subdirectories of the same output directory. - The default value of this variable is: - :: + The default value of this variable is:: ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} - Some classes (e.g. - :ref:`cross-canadian <ref-classes-cross-canadian>`) modify the - ``MULTIMACH_TARGET_SYS`` value. + 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. @@ -4866,23 +5516,21 @@ system and gives an overview of their function and contents. :term:`NO_GENERIC_LICENSE` Avoids QA errors when you use a non-common, non-CLOSED license in a - recipe. Packages exist, such as the linux-firmware package, with many + 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. - ``NO_GENERIC_LICENSE`` is used to allow copying a license that does + :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 ``NO_GENERIC_LICENSE`` to a - recipe: - :: + The following example shows how to add :term:`NO_GENERIC_LICENSE` to a + recipe:: NO_GENERIC_LICENSE[license_name] = "license_file_in_fetched_source" - The following is an example that + Here is an example that uses the ``LICENSE.Abilis.txt`` file as the license from the fetched - source: - :: + source:: NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" @@ -4890,15 +5538,15 @@ system and gives an overview of their function and contents. Prevents installation of all "recommended-only" packages. Recommended-only packages are packages installed only through the :term:`RRECOMMENDS` variable). Setting the - ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on: :: + :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: :: + override:: - NO_RECOMMENDATIONS_pn-target_image = "1" + 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 @@ -4912,8 +5560,8 @@ system and gives an overview of their function and contents. functionality, such as kernel modules. It is up to you to add packages with the :term:`IMAGE_INSTALL` variable. - Support for this variable exists only when using the IPK and RPM - packaging backend. Support does not exist for DEB. + 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 @@ -4921,15 +5569,36 @@ system and gives an overview of their function and contents. :term:`NOAUTOPACKAGEDEBUG` Disables auto package from splitting ``.debug`` files. If a recipe - requires ``FILES_${PN}-dbg`` to be set manually, the - ``NOAUTOPACKAGEDEBUG`` can be defined allowing you to define the - content of the debug package. For example: - :: + 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" + 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:`NVDCVE_API_KEY` + The NVD API key used to retrieve data from the CVE database when + using :ref:`ref-classes-cve-check`. + + By default, no API key is used, which results in larger delays between API + requests and limits the number of queries to the public rate limits posted + at the `NVD developer's page <https://nvd.nist.gov/developers/start-here>`__. + + NVD API keys can be requested through the + `Request an API Key <https://nvd.nist.gov/developers/request-an-api-key>`__ + page. You can set this variable to the NVD API key in your ``local.conf`` file. + Example:: + + NVDCVE_API_KEY = "fe753&7a2-1427-347d-23ff-b2e2b7ca5f3" :term:`OBJCOPY` The minimal command and arguments to run ``objcopy``. @@ -4938,7 +5607,7 @@ system and gives an overview of their function and contents. The minimal command and arguments to run ``objdump``. :term:`OE_BINCONFIG_EXTRA_MANGLE` - When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, + 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 @@ -4946,11 +5615,19 @@ system and gives an overview of their function and contents. ``sysroots/`` directory so that all builds that use the script will use the correct directories for the cross compiling layout. - See the ``meta/classes/binconfig.bbclass`` in the + See the ``meta/classes-recipe/binconfig.bbclass`` in the :term:`Source Directory` for details on how this class - applies these additional sed command arguments. For general - information on the ``binconfig`` class, see the - ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. + 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 @@ -4966,16 +5643,16 @@ system and gives an overview of their function and contents. value is "oe-init-build-env". If you use a custom script to set up your build environment, set the - ``OE_INIT_ENV_SCRIPT`` variable to its name. + :term:`OE_INIT_ENV_SCRIPT` variable to its name. :term:`OE_TERMINAL` Controls how the OpenEmbedded build system spawns interactive terminals on the host development system (e.g. using the BitBake command with the ``-c devshell`` command-line option). For more - information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in + 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 ``OE_TERMINAL`` variable: + You can use the following values for the :term:`OE_TERMINAL` variable: - auto - gnome @@ -4989,12 +5666,26 @@ system and gives an overview of their function and contents. The directory from which the top-level build environment setup script is sourced. The Yocto Project provides a top-level build environment setup script: :ref:`structure-core-script`. When you run this - script, the ``OEROOT`` variable resolves to the directory that + 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 @@ -5005,51 +5696,134 @@ system and gives an overview of their function and contents. 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 - ``OVERRIDES`` represents the "state" during building, which includes + :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 ``OVERRIDES``, then the following + the colon-separated list in :term:`OVERRIDES`, then the following assignment will override ``FOO`` with the value "overridden" at the - end of parsing: - :: + end of parsing:: - FOO_an-override = "overridden" + FOO:an-override = "overridden" See the - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax (overrides)`" + ":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 ``OVERRIDES`` includes the values of the + 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: - :: + (``.conf``) files. Here is an example:: - FOO_pn-myrecipe = "myrecipe-specific value" + FOO:pn-myrecipe = "myrecipe-specific value" .. note:: - An easy way to see what overrides apply is to search for ``OVERRIDES`` + 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/common-tasks:viewing variable values`" section in the Yocto + ":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. ``P`` is comprised of the following: - :: + 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. @@ -5063,7 +5837,7 @@ system and gives an overview of their function and contents. specific by using the package name as a suffix. You can find out more about applying this variable in the - ":ref:`dev-manual/common-tasks:adding custom metadata to packages`" + ":ref:`dev-manual/packages:adding custom metadata to packages`" section in the Yocto Project Development Tasks Manual. :term:`PACKAGE_ARCH` @@ -5081,9 +5855,8 @@ system and gives an overview of their function and contents. However, if your recipe's output packages are built specific to the target machine rather than generally for the architecture of the - machine, you should set ``PACKAGE_ARCH`` to the value of - :term:`MACHINE_ARCH` in the recipe as follows: - :: + machine, you should set :term:`PACKAGE_ARCH` to the value of + :term:`MACHINE_ARCH` in the recipe as follows:: PACKAGE_ARCH = "${MACHINE_ARCH}" @@ -5091,11 +5864,11 @@ system and gives an overview of their function and contents. Specifies a list of architectures compatible with the target machine. This variable is set automatically and should not normally be hand-edited. Entries are separated using spaces and listed in order - of priority. The default value for ``PACKAGE_ARCHS`` is "all any + 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 ``PACKAGES`` before ``${PN}`` so + 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. @@ -5106,21 +5879,14 @@ system and gives an overview of their function and contents. OpenEmbedded build system uses when packaging data. You can provide one or more of the following arguments for the - variable: PACKAGE_CLASSES ?= "package_rpm package_deb package_ipk - package_tar" + variable:: - .. note:: - - While it is a legal option, the ``package_tar`` - class has limited functionality due to no support for package - dependencies by that backend. Therefore, it is recommended that - you do not use it. + 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: - :: + For example, if you use the following in your ``local.conf`` file:: PACKAGE_CLASSES ?= "package_ipk" @@ -5129,66 +5895,63 @@ system and gives an overview of their function and contents. For information on packaging and build performance effects as a result of the package manager in use, see the - ":ref:`package.bbclass <ref-classes-package>`" section. + ":ref:`ref-classes-package`" section. :term:`PACKAGE_DEBUG_SPLIT_STYLE` - Determines how to split up the binary and debug information when - creating ``*-dbg`` packages to be used with the GNU Project Debugger - (GDB). - - With the ``PACKAGE_DEBUG_SPLIT_STYLE`` variable, you can control - where debug information, which can include or exclude source files, - is stored: - - - ".debug": Debug symbol files are placed next to the binary in a - ``.debug`` directory on the target. For example, if a binary is - installed into ``/bin``, the corresponding debug symbol files are - installed in ``/bin/.debug``. Source files are placed in - ``/usr/src/debug``. - - - "debug-file-directory": Debug symbol files are placed under - ``/usr/lib/debug`` on the target, and separated by the path from - where the binary is installed. For example, if a binary is - installed in ``/bin``, the corresponding debug symbols are - installed in ``/usr/lib/debug/bin``. Source files are placed in - ``/usr/src/debug``. - - - "debug-without-src": The same behavior as ".debug" previously - described with the exception that no source files are installed. - - - "debug-with-srcpkg": The same behavior as ".debug" previously - described with the exception that all source files are placed in a - separate ``*-src`` pkg. This is the default behavior. + 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. - You can find out more about debugging using GDB by reading the - ":ref:`dev-manual/common-tasks:debugging with the gnu project debugger (gdb) remotely`" section - in the Yocto Project Development Tasks Manual. + .. note:: - :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` - Prevents specific packages from being installed when you are - installing complementary packages. + Much of the above package splitting can be overridden via + use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable. - You might find that you want to prevent installing certain packages - when you are installing complementary packages. For example, if you - are using :term:`IMAGE_FEATURES` to install - ``dev-pkgs``, you might not want to install all packages from a - particular multilib. If you find yourself in this situation, you can - use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular - expressions to match the packages you want to exclude. + 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: - :: + 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: - :: + override:: - PACKAGE_EXCLUDE_pn-target_image = "package_name" + 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 @@ -5198,13 +5961,25 @@ system and gives an overview of their function and contents. an iterative development process to remove specific components from a system. - Support for this variable exists only when using the IPK and RPM - packaging backend. Support does not exist for DEB. + 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 @@ -5213,7 +5988,7 @@ system and gives an overview of their function and contents. :term:`PACKAGE_FEED_ARCHS` Optionally specifies the package architectures used as part of the package feed URIs during the build. When used, the - ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed + :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` @@ -5221,17 +5996,16 @@ system and gives an overview of their function and contents. .. note:: - You can use the ``PACKAGE_FEED_ARCHS`` - variable to whitelist specific package architectures. If you do - not need to whitelist specific architectures, which is a common + 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 ``PACKAGE_FEED_URIS``, - ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are - defined in your ``local.conf`` file: - :: + 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" @@ -5253,15 +6027,14 @@ system and gives an overview of their function and contents. :term:`PACKAGE_FEED_BASE_PATHS` Specifies the base path used when constructing package feed URIs. The - ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a + :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 ``PACKAGE_FEED_URIS``, - ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are - defined in your ``local.conf`` file: - :: + 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" @@ -5284,14 +6057,13 @@ system and gives an overview of their function and contents. :term:`PACKAGE_FEED_URIS` Specifies the front portion of the package feed URI used by the OpenEmbedded build system. Each final package feed URI is comprised - of ``PACKAGE_FEED_URIS``, + of :term:`PACKAGE_FEED_URIS`, :term:`PACKAGE_FEED_BASE_PATHS`, and :term:`PACKAGE_FEED_ARCHS` variables. - Consider the following example where the ``PACKAGE_FEED_URIS``, - ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are - defined in your ``local.conf`` file: - :: + 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" @@ -5316,16 +6088,16 @@ system and gives an overview of their function and contents. installation into the image. Because the package manager controls actual installation of all - packages, the list of packages passed using ``PACKAGE_INSTALL`` is + 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 (initramfs) image, - use the ``PACKAGE_INSTALL`` variable. For information on creating an - initramfs, see the ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" section + 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` @@ -5342,22 +6114,21 @@ system and gives an overview of their function and contents. :term:`PACKAGE_WRITE_DEPS` Specifies a list of dependencies for post-installation and pre-installation scripts on native/cross tools. If your - post-installation or pre-installation script can execute at rootfs + 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 - ``PACKAGE_WRITE_DEPS``. + :term:`PACKAGE_WRITE_DEPS`. For information on running post-installation scripts, see the - ":ref:`dev-manual/common-tasks:post-installation scripts`" + ":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. ``PACKAGECONFIG`` blocks are defined in + 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): - :: + multiple lines for readability):: PACKAGECONFIG ??= "f1 f2 f3 ..." PACKAGECONFIG[f1] = "\ @@ -5370,117 +6141,140 @@ system and gives an overview of their function and contents. PACKAGECONFIG[f2] = "\ ... and so on and so on ... - The ``PACKAGECONFIG`` variable itself specifies a space-separated + 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: - 1. Extra arguments that should be added to the configure script - argument list (:term:`EXTRA_OECONF` or - :term:`PACKAGECONFIG_CONFARGS`) if - the feature is enabled. + #. Extra arguments that should be added to :term:`PACKAGECONFIG_CONFARGS` + if the feature is enabled. - 2. Extra arguments that should be added to ``EXTRA_OECONF`` or - ``PACKAGECONFIG_CONFARGS`` if the feature is disabled. + #. Extra arguments that should be added to :term:`PACKAGECONFIG_CONFARGS` + if the feature is disabled. - 3. Additional build dependencies (:term:`DEPENDS`) + #. Additional build dependencies (:term:`DEPENDS`) that should be added if the feature is enabled. - 4. Additional runtime dependencies (:term:`RDEPENDS`) + #. Additional runtime dependencies (:term:`RDEPENDS`) that should be added if the feature is enabled. - 5. Additional runtime recommendations + #. Additional runtime recommendations (:term:`RRECOMMENDS`) that should be added if the feature is enabled. - 6. Any conflicting (that is, mutually exclusive) ``PACKAGECONFIG`` + #. Any conflicting (that is, mutually exclusive) :term:`PACKAGECONFIG` settings for this feature. - Consider the following ``PACKAGECONFIG`` block taken from the + 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. - :: + three arguments that determine the feature's behavior:: PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3" The ``--with-gtk3`` and ``gtk+3`` arguments apply only if the feature is enabled. In this case, ``--with-gtk3`` is added to the configure - script argument list and ``gtk+3`` is added to ``DEPENDS``. On the + 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 ``PACKAGECONFIG`` structure previously described holds true + 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 ``PACKAGECONFIG`` block, you can do + 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 - ``PACKAGECONFIG``. You can either completely override the - variable: - :: + ``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: - :: + Or, you can just append the variable:: - PACKAGECONFIG_append = " f4" + 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: - :: + 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) - PACKAGECONFIG_pn-recipename = "f4 f5" + 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:: - Or, you can just amend the variable: - :: + inherit cmake + PACKAGECONFIG = "systemd" + PACKAGECONFIG[systemd] = "-DWITH_SYSTEMD=ON,-DWITH_SYSTEMD=OFF" - PACKAGECONFIG_append_pn-recipename = " f4" + 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:`autotools <ref-classes-autotools>` and - :ref:`cmake <ref-classes-cmake>` use ``PACKAGECONFIG_CONFARGS`` to - pass ``PACKAGECONFIG`` options to ``configure`` and ``cmake``, - respectively. If you are using ``PACKAGECONFIG`` but not a class that - handles the ``do_configure`` task, then you need to use - ``PACKAGECONFIG_CONFARGS`` appropriately. + 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:`packagegroup <ref-classes-packagegroup>` class, setting - ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the + 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: - :: + following:: - ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale ${PACKAGE_BEFORE_PN} ${PN} + ${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 ``PACKAGES`` and uses the :term:`FILES` + 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 ``FILES`` variable for more than one - package in ``PACKAGES``, it will be assigned to the earliest + 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 + 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. @@ -5488,10 +6282,10 @@ system and gives an overview of their function and contents. :term:`PACKAGES_DYNAMIC` A promise that your recipe satisfies runtime dependencies for optional modules that are found in other recipes. - ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it + :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 ``PACKAGES_DYNAMIC`` + 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 @@ -5501,11 +6295,11 @@ system and gives an overview of their function and contents. Typically, if there is a chance that such a situation can occur and the package that is not created is valid without the dependency being satisfied, then you should use :term:`RRECOMMENDS` - (a soft runtime dependency) instead of ``RDEPENDS``. + (a soft runtime dependency) instead of :term:`RDEPENDS`. - For an example of how to use the ``PACKAGES_DYNAMIC`` variable when + For an example of how to use the :term:`PACKAGES_DYNAMIC` variable when you are splitting packages, see the - ":ref:`dev-manual/common-tasks:handling optional module packaging`" + ":ref:`dev-manual/packages:handling optional module packaging`" section in the Yocto Project Development Tasks Manual. :term:`PACKAGESPLITFUNCS` @@ -5519,17 +6313,20 @@ system and gives an overview of their function and contents. desired splitting. :term:`PARALLEL_MAKE` - Extra options passed to the ``make`` command during the - :ref:`ref-tasks-compile` task in order to specify - parallel compilation on the local build host. This variable is - usually in the form "-j x", where x represents the maximum number of - parallel threads ``make`` can run. + + 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:: - In order for ``PARALLEL_MAKE`` to be effective, ``make`` must be - called with ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure - this is to use the ``oe_runmake`` function. + 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. @@ -5537,40 +6334,41 @@ system and gives an overview of their function and contents. .. note:: If the software being built experiences dependency issues during - the ``do_compile`` task that result in race conditions, you can clear - the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For + 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/common-tasks:debugging parallel make races`" + ":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 ``PARALLEL_MAKE`` variable is + 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/common-tasks:speeding up a build`" + ":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 ``make install`` command during the - :ref:`ref-tasks-install` task in order to specify + 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:: - In order for ``PARALLEL_MAKEINST`` to be effective, ``make`` must - be called with + 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 ``do_install`` task that result in race conditions, you can - clear the ``PARALLEL_MAKEINST`` variable within the recipe as a + 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/common-tasks:debugging parallel make races`" + ":ref:`dev-manual/debugging:debugging parallel make races`" section in the Yocto Project Development Tasks Manual. :term:`PATCHRESOLVE` @@ -5594,8 +6392,7 @@ system and gives an overview of their function and contents. patched, it uses "patch". If you wish to use an alternative patching tool, set the variable in - the recipe using one of the following: - :: + the recipe using one of the following:: PATCHTOOL = "patch" PATCHTOOL = "quilt" @@ -5606,7 +6403,15 @@ system and gives an overview of their function and contents. variable is used to make upgrades possible when the versioning scheme changes in some backwards incompatible way. - ``PE`` is the default value of the :term:`PKGE` variable. + :term:`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 @@ -5615,10 +6420,11 @@ system and gives an overview of their function and contents. ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} :term:`PIXBUF_PACKAGES` - When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` + When inheriting the :ref:`ref-classes-pixbufcache` class, this variable identifies packages that contain the pixbuf - loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` - class assumes that the loaders are in the recipe's main package (i.e. + 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. @@ -5628,11 +6434,10 @@ system and gives an overview of their function and contents. .. note:: - When using the ``PKG`` variable, you must use a package name override. + When using the :term:`PKG` variable, you must use a package name override. - For example, when the :ref:`debian <ref-classes-debian>` class - renames the output package, it does so by setting - ``PKG_packagename``. + 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. @@ -5641,8 +6446,7 @@ system and gives an overview of their function and contents. :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: - :: + the following:: ${WORKDIR}/package @@ -5654,15 +6458,14 @@ system and gives an overview of their function and contents. :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: - :: + change:: ${STAGING_DIR_HOST}/pkgdata For examples of how this data is used, see the ":ref:`overview-manual/concepts:automatically added runtime dependencies`" section in the Yocto Project Overview and Concepts Manual and the - ":ref:`dev-manual/common-tasks:viewing package information with \`\`oe-pkgdata-util\`\``" + ":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`. @@ -5670,8 +6473,7 @@ system and gives an overview of their function and contents. :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: - :: + the following:: ${WORKDIR}/packages-split @@ -5682,68 +6484,53 @@ system and gives an overview of their function and contents. :term:`PKGDESTWORK` Points to a temporary work area where the :ref:`ref-tasks-package` task saves package metadata. - The ``PKGDESTWORK`` location defaults to the following: - :: + 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 ``PKGDESTWORK`` to + 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, ``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, - ``PKGR`` is set to :term:`PR`. + :term:`PKGR` is set to :term:`PR`. :term:`PKGV` The version of the package(s) built by the recipe. By default, - ``PKGV`` is set to :term:`PV`. + :term:`PKGV` is set to :term:`PV`. :term:`PN` This variable can have two separate functions depending on the context: a recipe name or a resulting package name. - ``PN`` refers to a recipe name in the context of a file used by the + :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 ``PN`` + 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 ``PN`` variable also contains any special suffix + If applicable, the :term:`PN` variable also contains any special suffix or prefix. For example, using ``bash`` to build packages for the - native machine, ``PN`` is ``bash-native``. Using ``bash`` to build - packages for the target and for Multilib, ``PN`` would be ``bash`` + 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:`PNBLACKLIST` - Lists recipes you do not want the OpenEmbedded build system to build. - This variable works in conjunction with the - :ref:`blacklist <ref-classes-blacklist>` class, which is inherited - globally. - - To prevent a recipe from being built, use the ``PNBLACKLIST`` - variable in your ``local.conf`` file. Here is an example that - prevents ``myrecipe`` from being built: - :: - - PNBLACKLIST[myrecipe] = "Not supported by our organization." - :term:`POPULATE_SDK_POST_HOST_COMMAND` Specifies a list of functions to call once the OpenEmbedded build system has created the host part of the SDK. You can specify - functions separated by semicolons: - :: + functions separated by spaces:: - POPULATE_SDK_POST_HOST_COMMAND += "function; ... " + 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 @@ -5753,10 +6540,9 @@ system and gives an overview of their function and contents. :term:`POPULATE_SDK_POST_TARGET_COMMAND` Specifies a list of functions to call once the OpenEmbedded build system has created the target part of the SDK. You can specify - functions separated by semicolons: - :: + functions separated by spaces:: - POPULATE_SDK_POST_TARGET_COMMAND += "function; ... " + 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 @@ -5767,35 +6553,35 @@ system and gives an overview of their function and contents. The revision of the recipe. The default value for this variable is "r0". Subsequent revisions of the recipe conventionally have the values "r1", "r2", and so forth. When :term:`PV` increases, - ``PR`` is conventionally reset to "r0". + :term:`PR` is conventionally reset to "r0". .. note:: - The OpenEmbedded build system does not need the aid of ``PR`` + 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 ``PR`` variable primarily becomes significant when a package + The :term:`PR` variable primarily becomes significant when a package manager dynamically installs packages on an already built image. In - this case, ``PR``, which is the default value of + 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 ``PV`` (i.e. ``PKGV``). A component having many packages with - the same ``PV`` usually means that the packages all install the same - upstream version, but with later (``PR``) version packages including + 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:: - ``PR`` does not need to be increased for changes that do not change the + :term:`PR` does not need to be increased for changes that do not change the package contents or metadata. - Because manually managing ``PR`` can be cumbersome and error-prone, + Because manually managing :term:`PR` can be cumbersome and error-prone, an automated solution exists. See the - ":ref:`dev-manual/common-tasks:working with a pr service`" section + ":ref:`dev-manual/packages:working with a pr service`" section in the Yocto Project Development Tasks Manual for more information. :term:`PREFERRED_PROVIDER` @@ -5804,33 +6590,34 @@ system and gives an overview of their function and contents. 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: - :: + example:: PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" In the previous example, multiple recipes are providing "virtual/kernel". - The ``PREFERRED_PROVIDER`` variable is set with the name (``PN``) of + The :term:`PREFERRED_PROVIDER` variable is set with the name (:term:`PN`) of the recipe you prefer to provide "virtual/kernel". - Following are more examples: - :: + Here are more examples:: PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" PREFERRED_PROVIDER_virtual/libgl ?= "mesa" For more - information, see the ":ref:`dev-manual/common-tasks:using virtual providers`" + 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 ``PREFERRED_PROVIDER``, then any + If you use a ``virtual/\*`` item with :term:`PREFERRED_PROVIDER`, then any recipe that :term:`PROVIDES` that item but is not selected (defined) - by ``PREFERRED_PROVIDER`` is prevented from building, which is usually + 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 @@ -5838,12 +6625,11 @@ system and gives an overview of their function and contents. the first example below), and you should specify the :term:`PV` accordingly (`3.4.0` in the example). - The ``PREFERRED_VERSION`` variable supports limited wildcard use + 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: - :: + two examples:: PREFERRED_VERSION_python = "3.4.0" PREFERRED_VERSION_linux-yocto = "5.0%" @@ -5857,42 +6643,37 @@ system and gives an overview of their function and contents. 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: - :: + 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: - :: + ``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: - :: + against the following incorrect example, which does not work:: PREFERRED_VERSION_foo = "git" - Sometimes the ``PREFERRED_VERSION`` variable can be set by + 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: - :: + override. Here is an example:: - PREFERRED_VERSION_linux-yocto_qemux86 = "5.0%" + 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: - :: + Here is an example:: - PREFERRED_VERSION_linux-yocto_forcevariable = "5.0%" + PREFERRED_VERSION_linux-yocto:forcevariable = "5.0%" .. note:: - The ``\_forcevariable`` override is not handled specially. This override - only works because the default value of ``OVERRIDES`` includes "forcevariable". + 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 @@ -5902,25 +6683,23 @@ system and gives an overview of their function and contents. Specifies additional paths from which the OpenEmbedded build system gets source code. When the build system searches for source code, it first tries the local download directory. If that location fails, the - build system tries locations defined by ``PREMIRRORS``, the upstream + build system tries locations defined by :term:`PREMIRRORS`, the upstream source, and then locations specified by :term:`MIRRORS` in that order. - Assuming your distribution (:term:`DISTRO`) is "poky", - the default value for ``PREMIRRORS`` is defined in the - ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. + 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`: - :: + :term:`Build Directory`:: - PREMIRRORS_prepend = "\ - git://.*/.* http://www.yoctoproject.org/sources/ \n \ - ftp://.*/.* http://www.yoctoproject.org/sources/ \n \ - http://.*/.* http://www.yoctoproject.org/sources/ \n \ - https://.*/.* http://www.yoctoproject.org/sources/ \n" + 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 @@ -5931,12 +6710,12 @@ system and gives an overview of their function and contents. :term:`PRIORITY` Indicates the importance of a package. - ``PRIORITY`` is considered to be part of the distribution policy + :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, ``PRIORITY`` is not + which the distribution is being produced. Thus, :term:`PRIORITY` is not normally set within recipes. - You can set ``PRIORITY`` to "required", "standard", "extra", and + You can set :term:`PRIORITY` to "required", "standard", "extra", and "optional", which is the default. :term:`PRIVATE_LIBS` @@ -5950,8 +6729,7 @@ system and gives an overview of their function and contents. 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: - :: + file name. For example, from the Firefox recipe in meta-browser:: PRIVATE_LIBS = "libmozjs.so \ libxpcom.so \ @@ -5967,35 +6745,34 @@ system and gives an overview of their function and contents. :term:`PROVIDES` A list of aliases by which a particular recipe can be known. By - default, a recipe's own ``PN`` is implicitly already in its - ``PROVIDES`` list and therefore does not need to mention that it - provides itself. If a recipe uses ``PROVIDES``, the additional + 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 - ``DEPENDS``. + :term:`DEPENDS`. - Consider the following example ``PROVIDES`` statement from the recipe - file ``eudev_3.2.9.bb``: - :: + Consider the following example :term:`PROVIDES` statement from the recipe + file ``eudev_3.2.9.bb``:: PROVIDES += "udev" - The ``PROVIDES`` statement + 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 `PROVIDES`, so while using "+=" in the above example may not be + 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 - ``PROVIDES`` mechanism is also used to implement virtual targets. A + :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 ``PROVIDES``. + functionality in question list the virtual target in :term:`PROVIDES`. Recipes that depend on the functionality in question can include the - virtual target in ``DEPENDS`` to leave the choice of provider open. + 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 @@ -6006,15 +6783,14 @@ system and gives an overview of their function and contents. .. note:: - A corresponding mechanism for virtual runtime dependencies - (packages) exists. However, the mechanism does not depend on any - special functionality beyond ordinary variable assignments. For - example, ``VIRTUAL-RUNTIME_dev_manager`` refers to the package of - the component that manages the ``/dev`` directory. + 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: - :: + simple as using the following assignment in a configuration file:: VIRTUAL-RUNTIME_dev_manager = "udev" @@ -6022,17 +6798,16 @@ system and gives an overview of their function and contents. :term:`PRSERV_HOST` The network based :term:`PR` service host and port. - The ``conf/local.conf.sample.extended`` configuration file in the - :term:`Source Directory` shows how the - ``PRSERV_HOST`` variable is set: - :: + 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/common-tasks:working with a pr service>`. You can - set ``PRSERV_HOST`` to other values to use a remote PR service. + 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` @@ -6045,7 +6820,7 @@ system and gives an overview of their function and contents. :term:`PTEST_ENABLED` Specifies whether or not :ref:`Package - Test <dev-manual/common-tasks:testing packages with ptest>` (ptest) + 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 @@ -6054,45 +6829,65 @@ system and gives an overview of their function and contents. :term:`PV` The version of the recipe. The version is normally extracted from the recipe filename. For example, if the recipe is named - ``expat_2.0.1.bb``, then the default value of ``PV`` will be "2.0.1". - ``PV`` is generally not overridden within a recipe unless it is + ``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). - ``PV`` is the default value of the :term:`PKGV` variable. + :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:`PYPI_PACKAGE_EXT` + When inheriting the :ref:`ref-classes-pypi` class, specifies the + file extension to use when fetching a package from `PyPI + <https://pypi.org/>`__. Default is ``tar.gz``. + + :term:`PYPI_SRC_URI` + When inheriting the :ref:`ref-classes-pypi` class, specifies the + full `pythonhosted <https://files.pythonhosted.org/>`__ URI for + fetching the package to be built. The default value is constructed + based upon :term:`PYPI_PACKAGE`, :term:`PYPI_PACKAGE_EXT`, and + :term:`PV`. Most recipes will not need to set this variable unless + they are building an unstable (i.e. development) version. :term:`PYTHON_ABI` - When used by recipes that inherit the - :ref:`distutils3 <ref-classes-distutils3>`, - :ref:`setuptools3 <ref-classes-setuptools3>` 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. + 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/...``). - Recipes that inherit the ``distutils3`` class during cross-builds also - use this variable to locate the headers and libraries of the - appropriate Python that the extension is targeting. + :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:`PYTHON_PN` - When used by recipes that inherit the - `distutils3 <ref-classes-distutils3>`, - :ref:`setuptools3 <ref-classes-setuptools3>` classes, specifies the - major Python version being built. For Python 3.x, ``PYTHON_PN`` would - be "python3". You do not have to set this variable as the - OpenEmbedded build system automatically sets it for you. + :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. - The variable allows recipes to use common infrastructure such as the - following: - :: + If no recommendation is specified for a directory, then the default + "but it is expected to be empty" will be used. - DEPENDS += "${PYTHON_PN}-native" + An example message shows if files were present in '/dev':: - In the previous example, - the version of the dependency is ``PYTHON_PN``. + QA_EMPTY_DIRS_RECOMMENDATION:/dev = "but all devices must be created at runtime" :term:`RANLIB` The minimal command and arguments to run ``ranlib``. @@ -6102,19 +6897,17 @@ system and gives an overview of their function and contents. 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: - :: + conjunction with a package name override. Here is an example:: - RCONFLICTS_${PN} = "another_conflicting_package_name" + RCONFLICTS:${PN} = "another_conflicting_package_name" BitBake, which the OpenEmbedded build system uses, supports specifying versioned dependencies. Although the syntax varies depending on the packaging format, BitBake hides these differences from you. Here is the general syntax to specify versions with the - ``RCONFLICTS`` variable: - :: + :term:`RCONFLICTS` variable:: - RCONFLICTS_${PN} = "package (operator version)" + RCONFLICTS:${PN} = "package (operator version)" For ``operator``, you can specify the following: @@ -6125,32 +6918,30 @@ system and gives an overview of their function and contents. - >= For example, the following sets up a dependency on version 1.2 or - greater of the package ``foo``: - :: + greater of the package ``foo``:: - RCONFLICTS_${PN} = "foo (>= 1.2)" + 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: - :: + installed:: - RDEPENDS_foo = "bar baz" + RDEPENDS:foo = "bar baz" The most common types of package runtime dependencies are automatically detected and added. Therefore, - most recipes do not need to set ``RDEPENDS``. For more information, + 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 ``RDEPENDS`` assignment is that + 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. + :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 @@ -6158,59 +6949,57 @@ system and gives an overview of their function and contents. also install the packages on which it depends. To ensure that the packages ``bar`` and ``baz`` get built, the - previous ``RDEPENDS`` assignment also causes a task dependency to be + 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 - ``do_package_write_*`` task of the recipes that build ``bar`` and + :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 ``RDEPENDS`` must be the - names of other packages - they cannot be recipe names. Although + 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 ``RDEPENDS`` + 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 ``RDEPENDS`` variable applies to packages being built, + 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 - ``RDEPENDS`` statement: - :: + :term:`RDEPENDS` statement:: - RDEPENDS_${PN}-dev += "perl" + RDEPENDS:${PN}-dev += "perl" In the example, the development package depends on the ``perl`` package. Thus, the - ``RDEPENDS`` variable has the ``${PN}-dev`` package name as part of + :term:`RDEPENDS` variable has the ``${PN}-dev`` package name as part of the variable. .. note:: - ``RDEPENDS_${PN}-dev`` includes ``${``\ :term:`PN`\ ``}`` + ``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 + ``${PN}`` when modifying ``RDEPENDS:${PN}-dev``. Use the "+=" operator rather than the "=" operator. - The package names you use with ``RDEPENDS`` must appear as they would - in the ``PACKAGES`` variable. The :term:`PKG` variable + 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:`debian <ref-classes-debian>` class uses this to rename + :ref:`ref-classes-debian` class uses this to rename packages), but this final package name cannot be used with - ``RDEPENDS``, which makes sense as ``RDEPENDS`` is meant to be + :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 - ``RDEPENDS`` variable: - :: + :term:`RDEPENDS` variable:: - RDEPENDS_${PN} = "package (operator version)" + RDEPENDS:${PN} = "package (operator version)" For ``operator``, you can specify the following: @@ -6224,30 +7013,83 @@ system and gives an overview of their function and contents. .. note:: - You can use ``EXTENDPKGV`` to provide a full package version + 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``: - :: + greater of the package ``foo``:: - RDEPENDS_${PN} = "foo (>= 1.2)" + RDEPENDS:${PN} = "foo (>= 1.2)" - For information on build-time dependencies, see the - :term:`DEPENDS` variable. You can also see the - ":ref:`Tasks <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks>`" and - ":ref:`Dependencies <bitbake:bitbake-user-manual/bitbake-user-manual-execution:dependencies>`" sections in the - BitBake User Manual for additional information on tasks and - dependencies. + 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:`features_check <ref-classes-features_check>` + 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 - ``REQUIRED_DISTRO_FEATURES`` variable lists a feature that does not - appear in ``DISTRO_FEATURES`` within the current configuration, then + :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. @@ -6263,15 +7105,13 @@ system and gives an overview of their function and contents. for the same recipe, the :term:`REQUIRED_VERSION` value applies. :term:`RM_WORK_EXCLUDE` - With ``rm_work`` enabled, this variable specifies a list of recipes - whose work directories should not be removed. See the - ":ref:`rm_work.bbclass <ref-classes-rm-work>`" section for more - details. + 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: - :: + follows in the BitBake configuration file:: ROOT_HOME ??= "/home/root" @@ -6284,8 +7124,7 @@ system and gives an overview of their function and contents. 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: - :: + define your override:: ROOT_HOME = "/root" ROOT_HOME ?= "/root" @@ -6297,16 +7136,15 @@ system and gives an overview of their function and contents. :term:`ROOTFS` Indicates a filesystem image to include as the root filesystem. - The ``ROOTFS`` variable is an optional variable used with the - :ref:`image-live <ref-classes-image-live>` class. + 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 - semicolons: - :: + spaces:: - ROOTFS_POSTINSTALL_COMMAND += "function; ... " + 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 @@ -6317,10 +7155,9 @@ system and gives an overview of their function and contents. :term:`ROOTFS_POSTPROCESS_COMMAND` Specifies a list of functions to call once the OpenEmbedded build system has created the root filesystem. You can specify functions - separated by semicolons: - :: + separated by spaces:: - ROOTFS_POSTPROCESS_COMMAND += "function; ... " + 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 @@ -6333,10 +7170,9 @@ system and gives an overview of their function and contents. system has removed unnecessary packages. When runtime package management is disabled in the image, several packages are removed including ``base-passwd``, ``shadow``, and ``update-alternatives``. - You can specify functions separated by semicolons: - :: + You can specify functions separated by spaces:: - ROOTFS_POSTUNINSTALL_COMMAND += "function; ... " + 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 @@ -6347,10 +7183,9 @@ system and gives an overview of their function and contents. :term:`ROOTFS_PREPROCESS_COMMAND` Specifies a list of functions to call before the OpenEmbedded build system has created the root filesystem. You can specify functions - separated by semicolons: - :: + separated by spaces:: - ROOTFS_PREPROCESS_COMMAND += "function; ... " + 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 @@ -6358,68 +7193,68 @@ system and gives an overview of their function and contents. :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 - ``RDEPENDS``). + :term:`RDEPENDS`). .. note:: - A package's own name is implicitly already in its ``RPROVIDES`` list. + 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: - :: + example:: - RPROVIDES_${PN} = "widget-abi-2" + RPROVIDES:${PN} = "widget-abi-2" :term:`RRECOMMENDS` A list of packages that extends the usability of a package being built. The package being built does not depend on this list of packages in order to successfully build, but rather uses them for extended usability. To specify runtime dependencies for packages, see - the ``RDEPENDS`` variable. + the :term:`RDEPENDS` variable. - The package manager will automatically install the ``RRECOMMENDS`` + 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 ``RRECOMMENDS`` need not actually be produced. - However, a recipe must exist that provides each package, either + 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 ``RRECOMMENDS`` variable applies to packages being built, + 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: - :: + following:: - RRECOMMENDS_${PN}-dev += "wireless_package_name" + RRECOMMENDS:${PN}-dev += "wireless_package_name" In the example, the package name (``${PN}-dev``) must appear as it would in - the ``PACKAGES`` namespace before any renaming of the output package - by classes such as ``debian.bbclass``. + 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 - ``RRECOMMENDS`` variable: - :: + :term:`RRECOMMENDS` variable:: - RRECOMMENDS_${PN} = "package (operator version)" + RRECOMMENDS:${PN} = "package (operator version)" For ``operator``, you can specify the following: @@ -6430,32 +7265,29 @@ system and gives an overview of their function and contents. - >= For example, the following sets up a recommend on version 1.2 or - greater of the package ``foo``: - :: + greater of the package ``foo``:: - RRECOMMENDS_${PN} = "foo (>= 1.2)" + RRECOMMENDS:${PN} = "foo (>= 1.2)" :term:`RREPLACES` A list of packages replaced by a package. The package manager uses this variable to determine which package should be installed to replace other package(s) during an upgrade. In order to also have the other package(s) removed at the same time, you must add the name of - the other package to the ``RCONFLICTS`` variable. + 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: - :: + in conjunction with a package name override. Here is an example:: - RREPLACES_${PN} = "other_package_being_replaced" + RREPLACES:${PN} = "other_package_being_replaced" BitBake, which the OpenEmbedded build system uses, supports specifying versioned replacements. Although the syntax varies depending on the packaging format, BitBake hides these differences from you. Here is the general syntax to specify versions with the - ``RREPLACES`` variable: - :: + :term:`RREPLACES` variable:: - RREPLACES_${PN} = "package (operator version)" + RREPLACES:${PN} = "package (operator version)" For ``operator``, you can specify the following: @@ -6466,10 +7298,9 @@ system and gives an overview of their function and contents. - >= For example, the following sets up a replacement using version 1.2 - or greater of the package ``foo``: - :: + or greater of the package ``foo``:: - RREPLACES_${PN} = "foo (>= 1.2)" + RREPLACES:${PN} = "foo (>= 1.2)" :term:`RSUGGESTS` A list of additional packages that you can suggest for installation @@ -6478,10 +7309,14 @@ system and gives an overview of their function and contents. As with all package-controlling variables, you must always use this variable in conjunction with a package name override. Here is an - example: - :: + example:: + + RSUGGESTS:${PN} = "useful_package another_package" - 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 @@ -6491,14 +7326,13 @@ system and gives an overview of their function and contents. version. If the source tarball extracts the code to a directory named anything other than ``${BPN}-${PV}``, or if the source code is fetched from an SCM such as Git or Subversion, then you must set - ``S`` in the recipe so that the OpenEmbedded build system knows where + :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 Build Directory at + 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: - :: + 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 @@ -6507,11 +7341,10 @@ system and gives an overview of their function and contents. This next example assumes a Git repository. By default, Git repositories are cloned to ``${WORKDIR}/git`` during :ref:`ref-tasks-fetch`. Since this path is different - from the default value of ``S``, you must set it specifically so the - source can be located: - :: + 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" + SRC_URI = "git://path/to/repo.git;branch=main" S = "${WORKDIR}/git" :term:`SANITY_REQUIRED_UTILITIES` @@ -6525,7 +7358,7 @@ system and gives an overview of their function and contents. been tested against. Identifiers consist of the host distributor ID followed by the release, as reported by the ``lsb_release`` tool or as read from ``/etc/lsb-release``. Separate the list items with - explicit newline characters (``\n``). If ``SANITY_TESTED_DISTROS`` is + 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 @@ -6535,17 +7368,29 @@ system and gives an overview of their function and contents. 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 ``SDK_CUSTOM_TEMPLATECONF`` is set to - "1" and a ``conf/templateconf.conf`` file exists in the build directory + 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 ``populate_sdk_base`` class defines - ``SDK_DEPLOY`` as follows: - :: + :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" @@ -6553,15 +7398,14 @@ system and gives an overview of their function and contents. 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: - :: + the variable as follows:: SDK_DIR = "${WORKDIR}/sdk" .. note:: - The ``SDK_DIR`` directory is a temporary directory as it is part of - ``WORKDIR``. The final output directory is :term:`SDK_DEPLOY`. + 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 @@ -6579,14 +7423,12 @@ system and gives an overview of their function and contents. 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: - :: + follows:: packagename packagearch version The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class - defines the manifest file as follows: - :: + defines the manifest file as follows:: SDK_HOST_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" @@ -6602,7 +7444,7 @@ system and gives an overview of their function and contents. .. note:: - Enabling the ``SDK_INCLUDE_PKGDATA`` + 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. @@ -6616,82 +7458,21 @@ system and gives an overview of their function and contents. IDE or from other tools and you do not want to perform additional steps to install the toolchain. - The ``SDK_INCLUDE_TOOLCHAIN`` variable defaults to "0" if - ``SDK_EXT_TYPE`` is set to "minimal", and defaults to "1" if - ``SDK_EXT_TYPE`` is set to "full". - - :term:`SDK_INHERIT_BLACKLIST` - A list of classes to remove from the :term:`INHERIT` - value globally within the extensible SDK configuration. The - :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the - default value: - :: - - SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" - - Some classes are not generally applicable within the extensible SDK - context. You can use this variable to disable those classes. - - For additional information on how to customize the extensible SDK's - configuration, see the - ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - :term:`SDK_LOCAL_CONF_BLACKLIST` - A list of variables not allowed through from the OpenEmbedded build - system configuration into the extensible SDK configuration. Usually, - these are variables that are specific to the machine on which the - build system is running and thus would be potentially problematic - within the extensible SDK. - - By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the - :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and - excludes the following variables: - - - :term:`CONF_VERSION` - - :term:`BB_NUMBER_THREADS` - - :term:`bitbake:BB_NUMBER_PARSE_THREADS` - - :term:`PARALLEL_MAKE` - - :term:`PRSERV_HOST` - - :term:`SSTATE_MIRRORS` :term:`DL_DIR` - - :term:`SSTATE_DIR` :term:`TMPDIR` - - :term:`BB_SERVER_TIMEOUT` - - For additional information on how to customize the extensible SDK's - configuration, see the - ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. - - :term:`SDK_LOCAL_CONF_WHITELIST` - A list of variables allowed through from the OpenEmbedded build - system configuration into the extensible SDK configuration. By - default, the list of variables is empty and is set in the - :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class. - - This list overrides the variables specified using the - :term:`SDK_LOCAL_CONF_BLACKLIST` - variable as well as any variables identified by automatic - blacklisting due to the "/" character being found at the start of the - value, which is usually indicative of being a path and thus might not - be valid on the system where the SDK is installed. - - For additional information on how to customize the extensible SDK's - configuration, see the - ":ref:`sdk-manual/appendix-customizing:configuring the extensible sdk`" - section in the Yocto Project Application Development and the - Extensible Software Development Kit (eSDK) manual. + 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 name is derived from the - :term:`DISTRO`, :term:`TCLIBC`, - :term:`SDK_ARCH`, - :term:`IMAGE_BASENAME`, and - :term:`TUNE_PKGARCH` variables: - :: + 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}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" + 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 @@ -6700,8 +7481,7 @@ system and gives an overview of their function and contents. :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: - :: + class defines the variable as follows:: SDK_DIR = "${WORKDIR}/sdk" SDK_OUTPUT = "${SDK_DIR}/image" @@ -6709,7 +7489,7 @@ system and gives an overview of their function and contents. .. note:: - The ``SDK_OUTPUT`` directory is a temporary directory as it is part of + 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`. @@ -6717,13 +7497,15 @@ system and gives an overview of their function and contents. Specifies a list of architectures compatible with the SDK machine. This variable is set automatically and should not normally be hand-edited. Entries are separated using spaces and listed in order - of priority. The default value for ``SDK_PACKAGE_ARCHS`` is "all any + 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 - semicolons: SDK_POSTPROCESS_COMMAND += "function; ... " + 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 @@ -6731,8 +7513,9 @@ system and gives an overview of their function and contents. :term:`SDK_DIR` variable for more information. :term:`SDK_PREFIX` - The toolchain binary prefix used for ``nativesdk`` recipes. The - OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the + 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}-". @@ -6740,15 +7523,15 @@ system and gives an overview of their function and contents. A list of shared state tasks added to the extensible SDK. By default, the following tasks are added: - - do_populate_lic - - do_package_qa - - do_populate_sysroot - - do_deploy + - :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 - ``SDK_RECRDEP_TASKS`` variable, the above four tasks are always added + :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 - ``SDK_RECRDEP_TASKS`` variable (e.g. you are defining additional + :term:`SDK_RECRDEP_TASKS` variable (e.g. you are defining additional tasks that are needed in order to build :term:`SDK_TARGETS`). @@ -6759,21 +7542,19 @@ system and gives an overview of their function and contents. The OpenEmbedded build system automatically sets this variable based on :term:`SDK_ARCH`, :term:`SDK_VENDOR`, and - :term:`SDK_OS`. You do not need to set the ``SDK_SYS`` + :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: - :: + follows:: packagename packagearch version The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class - defines the manifest file as follows: - :: + defines the manifest file as follows:: SDK_TARGET_MANIFEST = "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" @@ -6785,7 +7566,7 @@ system and gives an overview of their function and contents. standard or extensible SDK installation. The default value is "${PN}" (i.e. the image from which the SDK is built). - The ``SDK_TARGETS`` variable is an internal variable and typically + The :term:`SDK_TARGETS` variable is an internal variable and typically would not be changed. :term:`SDK_TITLE` @@ -6793,19 +7574,22 @@ system and gives an overview of their function and contents. 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: - :: + follows:: SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" For the default distribution "poky", - ``SDK_TITLE`` is set to "Poky (Yocto Project Reference Distro)". + :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 @@ -6817,8 +7601,7 @@ system and gives an overview of their function and contents. :term:`SDK_VERSION` Specifies the version of the SDK. The Poky distribution configuration file (``/meta-poky/conf/distro/poky.conf``) sets the default - ``SDK_VERSION`` as follows: - :: + :term:`SDK_VERSION` as follows:: SDK_VERSION = "${@d.getVar('DISTRO_VERSION').replace('snapshot-${METADATA_REVISION}', 'snapshot')}" @@ -6826,18 +7609,22 @@ system and gives an overview of their function and contents. :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: - :: + follows:: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" For the - default distribution "poky", the ``SDKEXTPATH`` is set to "poky_sdk". + 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`" @@ -6845,32 +7632,33 @@ system and gives an overview of their function and contents. Extensible Software Development Kit (eSDK) manual. :term:`SDKIMAGE_FEATURES` - Equivalent to ``IMAGE_FEATURES``. However, this variable applies to - the SDK generated from an image using the following command: - :: + 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 - ``SDKMACHINE`` value. The value points to a corresponding ``.conf`` - file under ``conf/machine-sdk/``. - - You can use "i686" and "x86_64" as possible values for this variable. - The variable defaults to "i686" and is set in the local.conf file in - the Build Directory. - :: + 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>`. - SDKMACHINE ?= "i686" + The variable defaults to :term:`BUILD_ARCH` so that SDKs are built for the + architecture of the build machine. .. note:: - You cannot set the ``SDKMACHINE`` + You cannot set the :term:`SDKMACHINE` variable in your distribution configuration file. If you do, the - configuration will not take affect. + 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 @@ -6880,7 +7668,7 @@ system and gives an overview of their function and contents. :term:`SDKTARGETSYSROOT` The full path to the sysroot used for cross-compilation within an SDK as it will be when installed into the default - :term:`SDKPATH`. + :term:`SDKPATHINSTALL`. :term:`SECTION` The section in which packages should be categorized. Package @@ -6891,50 +7679,43 @@ system and gives an overview of their function and contents. building for the target. The flags are passed through the default value of the :term:`TARGET_CFLAGS` variable. - The ``SELECTED_OPTIMIZATION`` variable takes the value of - ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the - case, the value of ``DEBUG_OPTIMIZATION`` is used. - - :term:`SERIAL_CONSOLE` - Defines a serial console (TTY) to enable using - `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a - value that specifies the baud rate followed by the TTY device name - separated by a space. You cannot specify more than one TTY device: - :: - - SERIAL_CONSOLE = "115200 ttyS0" - - .. note:: - - The ``SERIAL_CONSOLE`` variable is deprecated. Please use the - :term:`SERIAL_CONSOLES` variable. + 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 - `getty <https://en.wikipedia.org/wiki/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: - :: + :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:`SERIAL_CONSOLES_CHECK` - Specifies serial consoles, which must be listed in - :term:`SERIAL_CONSOLES`, to check against - ``/proc/console`` before enabling them using getty. This variable - allows aliasing in the format: <device>:<alias>. If a device was - listed as "sclp_line0" in ``/dev/`` and "ttyS0" was listed in - ``/proc/console``, you would do the following: :: + :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. - SERIAL_CONSOLES_CHECK = "slcp_line0:ttyS0" + :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. - This variable is currently only supported with SysVinit (i.e. not - with systemd). + :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: :: + another recipe. For example:: SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "intone->mplayer2" @@ -6942,7 +7723,7 @@ system and gives an overview of their function and contents. 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: :: + side. Here is an example:: SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS += "*->quilt-native" @@ -6987,15 +7768,27 @@ system and gives an overview of their function and contents. To enable file removal, set the variable to "1" in your ``conf/local.conf`` configuration file in your: - :term:`Build Directory`. - :: + :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` - 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. + 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:: @@ -7008,7 +7801,7 @@ system and gives an overview of their function and contents. defined in the ``meta/conf/bitbake.conf`` configuration file. You will see this variable referenced in the default values of - ``FILES_${PN}``. + ``FILES:${PN}``. :term:`SOLIBSDEV` Defines the suffix for the development symbolic link (symlink) for @@ -7017,11 +7810,28 @@ system and gives an overview of their function and contents. ``meta/conf/bitbake.conf`` configuration file. You will see this variable referenced in the default values of - ``FILES_${PN}-dev``. + ``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 ``SOURCE_MIRROR_FETCH`` to "1" in + 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 @@ -7033,7 +7843,7 @@ system and gives an overview of their function and contents. .. note:: - Do not set the ``SOURCE_MIRROR_FETCH`` + 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. @@ -7043,20 +7853,132 @@ system and gives an overview of their function and contents. specified in :term:`SRC_URI`. To use this variable, you must globally inherit the - :ref:`own-mirrors <ref-classes-own-mirrors>` class and then provide - the URL to your mirrors. Here is the general syntax: - :: + :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 ``SOURCE_MIRROR_URL``. + 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 ``SPDXLICENSEMAP`` + ``meta/files/common-licenses/``. For the default :term:`SPDXLICENSEMAP` mappings, see the ``meta/conf/licenses.conf`` file. For additional information, see the :term:`LICENSE` @@ -7076,8 +7998,7 @@ system and gives an overview of their function and contents. U-Boot recipe. The SPL file type is set to "null" by default in the ``u-boot.inc`` - file as follows: - :: + 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 @@ -7088,173 +8009,132 @@ system and gives an overview of their function and contents. SPL_IMAGE ?= "${SPL_BINARYNAME}-${MACHINE}-${PV}-${PR}" SPL_SYMLINK ?= "${SPL_BINARYNAME}-${MACHINE}" - The ``SPL_BINARY`` variable helps form + 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/common-tasks:adding a layer using the \`\`bitbake-layers\`\` script`" + ":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:`SRC_URI` - The list of source files - local or remote. This variable tells the - OpenEmbedded build system which bits to pull in for the build and how - to pull them in. For example, if the recipe or append file only needs - to fetch a tarball from the Internet, the recipe or append file uses - a single ``SRC_URI`` entry. On the other hand, if the recipe or - append file needs to fetch a tarball, apply two patches, and include - a custom file, the recipe or append file would include four instances - of the variable. - - The following list explains the available URI protocols. URI - protocols are highly dependent on particular BitBake Fetcher - submodules. Depending on the fetcher BitBake uses, various URL - parameters are employed. For specifics on the supported Fetchers, see - the ":ref:`Fetchers <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`" section in the - BitBake User Manual. - - - ``file://`` - Fetches files, which are usually files shipped - with the :term:`Metadata`, from the local machine (e.g. - :ref:`patch <overview-manual/concepts:patching>` files). - The path is relative to the :term:`FILESPATH` - variable. Thus, the build system searches, in order, from the - following directories, which are assumed to be a subdirectories of - the directory in which the recipe file (``.bb``) or append file - (``.bbappend``) resides: - - - ``${BPN}`` - The base recipe name without any special suffix - or version numbers. - - - ``${BP}`` - ``${BPN}-${PV}``. The base recipe name and - version but without any special package name suffix. - - - *files -* Files within a directory, which is named ``files`` - and is also alongside the recipe or append file. + :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``. - .. note:: + 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. - If you want the build system to pick up files specified through - a - SRC_URI - statement from your append file, you need to be sure to extend - the - FILESPATH - variable by also using the - FILESEXTRAPATHS - variable from within your append file. + :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. - - ``bzr://`` - Fetches files from a Bazaar revision control - repository. + :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``. - - ``git://`` - Fetches files from a Git revision control - repository. + :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``. - - ``osc://`` - Fetches files from an OSC (openSUSE Build service) - revision control repository. + :term:`SPLASH_IMAGES` + This variable, used by the ``psplash`` recipe, allows to customize + the default splashscreen image. - - ``repo://`` - Fetches files from a repo (Git) repository. + 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. - - ``ccrc://`` - Fetches files from a ClearCase repository. + 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:: - - ``http://`` - Fetches files from the Internet using ``http``. + meta-acme/recipes-core/psplash + ├── files + │  └── logo-acme.png + └── psplash_%.bbappend - - ``https://`` - Fetches files from the Internet using ``https``. + And here are the contents of the ``psplash_%.bbappend`` file in + this example:: - - ``ftp://`` - Fetches files from the Internet using ``ftp``. + SPLASH_IMAGES = "file://logo-acme.png;outsuffix=default" + FILESEXTRAPATHS:prepend := "${THISDIR}/files:" - - ``cvs://`` - Fetches files from a CVS revision control - repository. + You could even add specific configuration options for ``psplash``, + for example:: - - ``hg://`` - Fetches files from a Mercurial (``hg``) revision - control repository. + EXTRA_OECONF += "--disable-startup-msg --enable-img-fullscreen" - - ``p4://`` - Fetches files from a Perforce (``p4``) revision - control repository. + For information on append files, see the + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" + section. - - ``ssh://`` - Fetches files from a secure shell. + :term:`SRCREV_FORMAT` + See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual. - - ``svn://`` - Fetches files from a Subversion (``svn``) revision - control repository. + :term:`SRC_URI` - - ``npm://`` - Fetches JavaScript modules from a registry. + See the BitBake manual for the initial description for this variable: + :term:`bitbake:SRC_URI`. - - ``az://`` - Fetches files from an Azure Storage account. + The following features are added by OpenEmbedded and the Yocto Project. - Standard and recipe-specific options for ``SRC_URI`` exist. Here are - standard options: + There are standard and recipe-specific options. Here are standard ones: - - ``apply`` - Whether to apply the patch or not. The default + - ``apply`` --- whether to apply the patch or not. The default action is to apply the patch. - - ``striplevel`` - Which striplevel to use when applying the + - ``striplevel`` --- which striplevel to use when applying the patch. The default level is 1. - - ``patchdir`` - Specifies the directory in which the patch should + - ``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 + - ``mindate`` --- apply the patch only if :term:`SRCDATE` is equal to or greater than ``mindate``. - - ``maxdate`` - Apply the patch only if ``SRCDATE`` is not later + - ``maxdate`` --- apply the patch only if :term:`SRCDATE` is not later than ``maxdate``. - - ``minrev`` - Apply the patch only if ``SRCREV`` is equal to or + - ``minrev`` --- apply the patch only if :term:`SRCREV` is equal to or greater than ``minrev``. - - ``maxrev`` - Apply the patch only if ``SRCREV`` is not later + - ``maxrev`` --- apply the patch only if :term:`SRCREV` is not later than ``maxrev``. - - ``rev`` - Apply the patch only if ``SRCREV`` is equal to + - ``rev`` --- apply the patch only if :term:`SRCREV` is equal to ``rev``. - - ``notrev`` - Apply the patch only if ``SRCREV`` is not equal to + - ``notrev`` --- apply the patch only if :term:`SRCREV` is not equal to ``rev``. - Here are some additional options worth mentioning: - - - ``unpack`` - Controls whether or not to unpack the file if it is - an archive. The default action is to unpack the file. - - - ``destsuffix`` - Places the file (or extracts its contents) into - the specified subdirectory of :term:`WORKDIR` when - the Git fetcher is used. - - - ``subdir`` - Places the file (or extracts its contents) into the - specified subdirectory of ``WORKDIR`` when the local (``file://``) - fetcher is used. - - - ``localdir`` - Places the file (or extracts its contents) into - the specified subdirectory of ``WORKDIR`` when the CVS fetcher is - used. - - - ``subpath`` - Limits the checkout to a specific subpath of the - tree when using the Git fetcher is used. - - - ``name`` - Specifies a name to be used for association with - ``SRC_URI`` checksums or :term:`SRCREV` when you have more than one - file or git repository specified in ``SRC_URI``. For example: - :: - - SRC_URI = "git://example.com/foo.git;name=first \ - git://example.com/bar.git;name=second \ - http://example.com/file.tar.gz;name=third" - - SRCREV_first = "f1d2d2f924e986ac86fdf7b36c94bcdf32beec15" - SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f" - SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de" - + .. note:: - - ``downloadfilename`` - Specifies the filename used when storing - the downloaded file. + 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 ``SRC_URI`` contains files that are machine-specific. If so, - the build system automatically changes ``PACKAGE_ARCH``. Setting this + 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` @@ -7266,18 +8146,16 @@ system and gives an overview of their function and contents. Returns the version string of the current package. This string is used to help define the value of :term:`PV`. - The ``SRCPV`` variable is defined in the ``meta/conf/bitbake.conf`` + The :term:`SRCPV` variable is defined in the ``meta/conf/bitbake.conf`` configuration file in the :term:`Source Directory` as - follows: - :: + follows:: SRCPV = "${@bb.fetch2.get_srcrev(d)}" - Recipes that need to define ``PV`` do so with the help of the - ``SRCPV``. For example, the ``ofono`` recipe (``ofono_git.bb``) + 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 ``PV`` as follows: - :: + defines :term:`PV` as follows:: PV = "0.12-git${SRCPV}" @@ -7286,26 +8164,76 @@ system and gives an overview of their function and contents. variable applies to Subversion, Git, Mercurial, and Bazaar only. Note that if you want to build a fixed revision and you want to avoid performing a query on the remote repository every time BitBake parses - your recipe, you should specify a ``SRCREV`` that is a full revision - identifier and not just a tag. + 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 ``SRCREV``, see the :term:`AUTOREV` variable + of software using :term:`SRCREV`, see the :term:`AUTOREV` variable description and the - ":ref:`dev-manual/common-tasks:automatically incrementing a package version number`" + ":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 ``BB_NO_NETWORK`` to - "1". Using the ``SSTATE_MIRROR_ALLOW_NETWORK`` variable is useful if - you have set ``SSTATE_MIRRORS`` to point to an internal server for + 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. @@ -7323,26 +8251,33 @@ system and gives an overview of their function and contents. When pointing to sstate build artifacts on another machine that uses a different GCC version for native builds, you must configure - ``SSTATE_MIRRORS`` with a regular expression that maps local search + :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:`uninative <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: - :: + :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/(.*) http://server_url_sstate_path/universal-4.8/\1 \n" + 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. - :: + correct path within the directory structure:: SSTATE_MIRRORS ?= "\ - file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \ + 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 @@ -7353,14 +8288,12 @@ system and gives an overview of their function and contents. (sstate) object during the first stage of preparing the sysroots. That object is scanned for hardcoded paths for original installation locations. The list of files that are scanned for paths is controlled - by the ``SSTATE_SCAN_FILES`` variable. Typically, recipes add files - they want to be scanned to the value of ``SSTATE_SCAN_FILES`` rather + 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:`sstate <ref-classes-sstate>` class specifies the default list - of files. + :ref:`ref-classes-sstate` class specifies the default list of files. - For details on the process, see the - :ref:`staging <ref-classes-staging>` class. + 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 @@ -7416,7 +8349,7 @@ system and gives an overview of their function and contents. .. note:: - Recipes should never write files directly under the ``STAGING_DIR`` + 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` @@ -7429,9 +8362,9 @@ system and gives an overview of their function and contents. For most recipes, this sysroot is the one in which that recipe's :ref:`ref-tasks-populate_sysroot` task copies files. Exceptions include ``-native`` recipes, where the - ``do_populate_sysroot`` task instead uses + :ref:`ref-tasks-populate_sysroot` task instead uses :term:`STAGING_DIR_NATIVE`. Depending on - the type of recipe and the build target, ``STAGING_DIR_HOST`` can + 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 @@ -7445,11 +8378,11 @@ system and gives an overview of their function and contents. ``-native`` recipes are not installed into host paths like such as ``/usr``. Rather, these recipes are installed into - ``STAGING_DIR_NATIVE``. When compiling ``-native`` recipes, + :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 ``STAGING_DIR_NATIVE`` are searched for libraries and + 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 @@ -7457,28 +8390,33 @@ system and gives an overview of their function and contents. :ref:`ref-tasks-configure`, :ref:`ref-tasks-compile`, and :ref:`ref-tasks-install`. Having the real system - root correspond to ``STAGING_DIR_HOST`` makes conceptual sense + 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, ``STAGING_DIR_TARGET`` is set to match + 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. cross-canadian recipes). Using terminology from GNU, the - primary system is referred to as the "HOST" and the secondary, or + 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 ``STAGING_DIR_HOST`` variable points to the sysroot used - for the "HOST" system, while ``STAGING_DIR_TARGET`` points to the + 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` @@ -7503,7 +8441,7 @@ system and gives an overview of their function and contents. Points to the directory containing the kernel build artifacts. Recipes building software that needs to access kernel build artifacts (e.g. ``systemtap-uprobes``) can look in the directory specified with - the ``STAGING_KERNEL_BUILDDIR`` variable to find these artifacts + the :term:`STAGING_KERNEL_BUILDDIR` variable to find these artifacts after the kernel has been built. :term:`STAGING_KERNEL_DIR` @@ -7523,9 +8461,8 @@ system and gives an overview of their function and contents. Specifies the base path used to create recipe stamp files. The path to an actual stamp file is constructed by evaluating this string and then appending additional information. Currently, the default - assignment for ``STAMP`` as set in the ``meta/conf/bitbake.conf`` - file is: - :: + assignment for :term:`STAMP` as set in the ``meta/conf/bitbake.conf`` + file is:: STAMP = "${STAMPS_DIR}/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR}" @@ -7540,6 +8477,9 @@ system and gives an overview of their function and contents. :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``. @@ -7551,8 +8491,8 @@ system and gives an overview of their function and contents. :term:`SUMMARY` The short (72 characters or less) summary of the binary package for packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default, - ``SUMMARY`` is used to define the - :term:`DESCRIPTION` variable if ``DESCRIPTION`` is + :term:`SUMMARY` is used to define the + :term:`DESCRIPTION` variable if :term:`DESCRIPTION` is not set in the recipe. :term:`SVNDIR` @@ -7562,12 +8502,11 @@ system and gives an overview of their function and contents. :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: - :: + follows where "X" is the console number you want to use:: SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" - The :ref:`syslinux <ref-classes-syslinux>` class initially sets + The :ref:`ref-classes-syslinux` class initially sets this variable to null but then checks for a value later. :term:`SYSLINUX_OPTS` @@ -7575,15 +8514,14 @@ system and gives an overview of their function and contents. this variable in your recipe. If you want to list multiple options, separate the options with a semicolon character (``;``). - The :ref:`syslinux <ref-classes-syslinux>` class uses this variable + 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:`syslinux <ref-classes-syslinux>` class as follows: - :: + :ref:`ref-classes-syslinux` class as follows:: SYSLINUX_SERIAL ?= "0 115200" @@ -7591,9 +8529,8 @@ system and gives an overview of their function and contents. :term:`SYSLINUX_SERIAL_TTY` Specifies the alternate console=tty... kernel boot argument. The - variable's default value is set in the - :ref:`syslinux <ref-classes-syslinux>` class as follows: - :: + variable's default value is set in the :ref:`ref-classes-syslinux` + class as follows:: SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" @@ -7603,7 +8540,7 @@ system and gives an overview of their function and contents. An ``.LSS`` file used as the background for the VGA boot menu when you use the boot menu. You need to set this variable in your recipe. - The :ref:`syslinux <ref-classes-syslinux>` class checks for this + The :ref:`ref-classes-syslinux` class checks for this variable and if found, the OpenEmbedded build system installs the splash screen. @@ -7616,8 +8553,7 @@ system and gives an overview of their function and contents. :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: - :: + default, the following directories are staged:: SYSROOT_DIRS = " \ ${includedir} \ @@ -7625,33 +8561,67 @@ system and gives an overview of their function and contents. ${base_libdir} \ ${nonarch_base_libdir} \ ${datadir} \ + /sysroot-only \ " - :term:`SYSROOT_DIRS_BLACKLIST` + :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: - :: + staging. By default, the following directories are not staged:: - SYSROOT_DIRS_BLACKLIST = " \ + SYSROOT_DIRS_IGNORE = " \ ${mandir} \ ${docdir} \ ${infodir} \ - ${datadir}/locale \ + ${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: - :: + extra directories are staged:: SYSROOT_DIRS_NATIVE = " \ ${bindir} \ @@ -7675,13 +8645,12 @@ system and gives an overview of their function and contents. processing on the staged files, or to stage additional files. :term:`SYSTEMD_AUTO_ENABLE` - When inheriting the :ref:`systemd <ref-classes-systemd>` class, + 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:`systemd <ref-classes-systemd>` class as follows: - :: + :ref:`ref-classes-systemd` class as follows:: SYSTEMD_AUTO_ENABLE ??= "enable" @@ -7689,25 +8658,22 @@ system and gives an overview of their function and contents. :term:`SYSTEMD_BOOT_CFG` When :term:`EFI_PROVIDER` is set to - "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the + "systemd-boot", the :term:`SYSTEMD_BOOT_CFG` variable specifies the configuration file that should be used. By default, the - :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the - ``SYSTEMD_BOOT_CFG`` as follows: - :: + :ref:`ref-classes-systemd-boot` class sets the + :term:`SYSTEMD_BOOT_CFG` as follows:: - SYSTEMD_BOOT_CFG ?= "${:term:`S`}/loader.conf" + 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 ``SYSTEMD_BOOT_ENTRIES`` variable specifies a + "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:`systemd-boot <ref-classes-systemd-boot>` class sets the - ``SYSTEMD_BOOT_ENTRIES`` as follows: - :: + entry per file. By default, the :ref:`ref-classes-systemd-boot` class + sets the :term:`SYSTEMD_BOOT_ENTRIES` as follows:: SYSTEMD_BOOT_ENTRIES ?= "" @@ -7716,58 +8682,75 @@ system and gives an overview of their function and contents. :term:`SYSTEMD_BOOT_TIMEOUT` When :term:`EFI_PROVIDER` is set to - "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the + "systemd-boot", the :term:`SYSTEMD_BOOT_TIMEOUT` variable specifies the boot menu timeout in seconds. By default, the - :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the - ``SYSTEMD_BOOT_TIMEOUT`` as follows: - :: + :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:`systemd <ref-classes-systemd>` class, + 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 ``SYSTEMD_PACKAGES`` + 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: - :: + reside in the recipes main package:: SYSTEMD_PACKAGES ?= "${PN}" If these unit files are not in this recipe's main package, you need - to use ``SYSTEMD_PACKAGES`` to list the package or packages in which + 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:`systemd <ref-classes-systemd>` class, + 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: - :: + an example from the connman recipe:: - SYSTEMD_SERVICE_${PN} = "connman.service" + 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/common-tasks:enabling system services>`, + When using :ref:`SysVinit <dev-manual/new-recipe:enabling system services>`, specifies a space-separated list of the virtual terminals that should - run a `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ - (allowing login), assuming :term:`USE_VT` is not set to - "0". + run a :wikipedia:`getty <Getty_(Unix)>` (allowing login), assuming + :term:`USE_VT` is not set to "0". - The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only + 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: - :: + particular recipe. The variable is typically set as follows:: T = "${WORKDIR}/temp" @@ -7775,7 +8758,7 @@ system and gives an overview of their function and contents. BitBake unpacks and builds the recipe. The default ``bitbake.conf`` file sets this variable. - The ``T`` variable is not to be confused with the + 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. @@ -7799,29 +8782,28 @@ system and gives an overview of their function and contents. :term:`TARGET_AS_ARCH` Specifies architecture-specific assembler flags for the target - system. ``TARGET_AS_ARCH`` is initialized from + system. :term:`TARGET_AS_ARCH` is initialized from :term:`TUNE_ASARGS` by default in the BitBake - configuration file (``meta/conf/bitbake.conf``): - :: + configuration file (``meta/conf/bitbake.conf``):: TARGET_AS_ARCH = "${TUNE_ASARGS}" :term:`TARGET_CC_ARCH` Specifies architecture-specific C compiler flags for the target - system. ``TARGET_CC_ARCH`` is initialized from + system. :term:`TARGET_CC_ARCH` is initialized from :term:`TUNE_CCARGS` by default. .. note:: It is a common workaround to append :term:`LDFLAGS` to - ``TARGET_CC_ARCH`` in recipes that build software for the target that - would not otherwise respect the exported ``LDFLAGS`` variable. + :term:`TARGET_CC_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 ``TARGET_CC_KERNEL_ARCH`` + 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 @@ -7833,8 +8815,8 @@ system and gives an overview of their function and contents. :term:`CFLAGS` is set to the value of this variable by default. - Additionally, the SDK's environment setup script sets the ``CFLAGS`` - variable in the environment to the ``TARGET_CFLAGS`` value so that + 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` @@ -7844,7 +8826,7 @@ system and gives an overview of their function and contents. value of this variable by default. Additionally, the SDK's environment setup script sets the - ``CPPFLAGS`` variable in the environment to the ``TARGET_CPPFLAGS`` + :term:`CPPFLAGS` variable in the environment to the :term:`TARGET_CPPFLAGS` value so that executables built using the SDK also have the flags applied. @@ -7855,10 +8837,14 @@ system and gives an overview of their function and contents. by default. Additionally, the SDK's environment setup script sets the - ``CXXFLAGS`` variable in the environment to the ``TARGET_CXXFLAGS`` + :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 @@ -7867,10 +8853,9 @@ system and gives an overview of their function and contents. :term:`TARGET_LD_ARCH` Specifies architecture-specific linker flags for the target system. - ``TARGET_LD_ARCH`` is initialized from + :term:`TARGET_LD_ARCH` is initialized from :term:`TUNE_LDARGS` by default in the BitBake - configuration file (``meta/conf/bitbake.conf``): - :: + configuration file (``meta/conf/bitbake.conf``):: TARGET_LD_ARCH = "${TUNE_LDARGS}" @@ -7882,29 +8867,29 @@ system and gives an overview of their function and contents. Additionally, the SDK's environment setup script sets the :term:`LDFLAGS` variable in the environment to the - ``TARGET_LDFLAGS`` value so that executables built using the SDK also + :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, "linux-gnueabi" and - "linux-musleabi" possible values exist. + 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, - ``TARGET_PREFIX`` is set as follows: + :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 ``BUILD_PREFIX``. + value of :term:`BUILD_PREFIX`. - - For native SDK recipes (``nativesdk``), the build system sets the - variable to the value of ``SDK_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 @@ -7918,7 +8903,7 @@ system and gives an overview of their function and contents. .. note:: - You do not need to set the ``TARGET_SYS`` variable yourself. + You do not need to set the :term:`TARGET_SYS` variable yourself. Consider these two examples: @@ -7933,27 +8918,25 @@ system and gives an overview of their function and contents. :term:`TCLIBC` Specifies the GNU standard C library (``libc``) variant to use during - the build process. This variable replaces ``POKYLIBC``, which is no - longer supported. + the build process. - You can select "glibc", "musl", "newlib", or "baremetal" + 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. + Specifies a suffix to be appended onto the :term:`TMPDIR` value. The + suffix identifies the ``libc`` variant for building. When you are + building for multiple variants with the same :term:`Build Directory`, + this mechanism ensures that output for different ``libc`` variants is + kept separate to avoid potential conflicts. In the ``defaultsetup.conf`` file, the default value of - ``TCLIBCAPPEND`` is "-${TCLIBC}". However, distros such as poky, + :term:`TCLIBCAPPEND` is "-${TCLIBC}". However, distros such as poky, which normally only support one ``libc`` variant, set - ``TCLIBCAPPEND`` to "" in their distro configuration file resulting + :term:`TCLIBCAPPEND` to "" in their distro configuration file resulting in no suffix being applied. :term:`TCMODE` - Specifies the toolchain selector. ``TCMODE`` controls the + 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 @@ -7962,17 +8945,15 @@ system and gives an overview of their function and contents. .. note:: - If ``TCMODE`` is set to a value other than "default", then it is your + 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 the Release Notes for - the Yocto Project release for the specific components with which - the toolchain must be compatible. To access the Release Notes, go - to the :yocto_home:`Downloads </software-overview/downloads>` - page on the Yocto Project website and click on the "RELEASE - INFORMATION" link for the appropriate release. - - The ``TCMODE`` variable is similar to :term:`TCLIBC`, + 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``. @@ -7983,22 +8964,47 @@ system and gives an overview of their function and contents. 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. In summary, you must - be sure to add the layer to your ``bblayers.conf`` file in front of - the ``meta`` layer and then set the ``EXTERNAL_TOOLCHAIN`` variable - in your ``local.conf`` file to the location in which you installed - the toolchain. + 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 ``TEST_EXPORT_DIR`` variable defaults to + The :term:`TEST_EXPORT_DIR` variable defaults to ``"${TMPDIR}/testimage/${PN}"``. :term:`TEST_EXPORT_ONLY` @@ -8008,7 +9014,7 @@ system and gives an overview of their function and contents. :term:`TEST_LOG_DIR` Holds the SSH log and the boot log for QEMU machines. The - ``TEST_LOG_DIR`` variable defaults to ``"${WORKDIR}/testimage"``. + :term:`TEST_LOG_DIR` variable defaults to ``"${WORKDIR}/testimage"``. .. note:: @@ -8028,7 +9034,7 @@ system and gives an overview of their function and contents. For automated hardware testing, specifies additional arguments to pass through to the command specified in :term:`TEST_POWERCONTROL_CMD`. Setting - ``TEST_POWERCONTROL_EXTRA_ARGS`` is optional. You can use it if you + :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. @@ -8040,7 +9046,7 @@ system and gives an overview of their function and contents. file. For more information on testing images, see the - ":ref:`dev-manual/common-tasks:performing automated runtime testing`" + ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual. :term:`TEST_SERIALCONTROL_CMD` @@ -8051,8 +9057,7 @@ system and gives an overview of their function and contents. program does. For example, to use the Picocom terminal program on serial device - ``/dev/ttyUSB0`` at 115200bps, you would set the variable as follows: - :: + ``/dev/ttyUSB0`` at 115200bps, you would set the variable as follows:: TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" @@ -8060,7 +9065,7 @@ system and gives an overview of their function and contents. For automated hardware testing, specifies additional arguments to pass through to the command specified in :term:`TEST_SERIALCONTROL_CMD`. Setting - ``TEST_SERIALCONTROL_EXTRA_ARGS`` is optional. You can use it if you + :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. @@ -8072,7 +9077,7 @@ system and gives an overview of their function and contents. .. note:: - The ``TEST_SERVER_IP`` variable is only used for a small number of + 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``. @@ -8089,18 +9094,16 @@ system and gives an overview of their function and contents. QEMU. Tests include ``ping``, ``ssh``, ``df`` among others. You can add - your own tests to the list of tests by appending ``TEST_SUITES`` as - follows: - :: + your own tests to the list of tests by appending :term:`TEST_SUITES` as + follows:: - TEST_SUITES_append = " mytest" + TEST_SUITES:append = " mytest" Alternatively, you can provide the "auto" option to have all applicable tests run against - the image. - :: + the image:: - TEST_SUITES_append = " auto" + TEST_SUITES:append = " auto" Using this option causes the build system to automatically run tests that are applicable to the @@ -8110,19 +9113,17 @@ system and gives an overview of their function and contents. 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_A``, then you must order the tests as follows:: TEST_SUITES = "test_A test_B" For more information on testing images, see the - ":ref:`dev-manual/common-tasks:performing automated runtime testing`" + ":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 image. The default controller to use is "qemu":: TEST_TARGET = "qemu" @@ -8131,12 +9132,12 @@ system and gives an overview of their function and contents. the controllers by adding a module in the layer's ``/lib/oeqa/controllers`` directory and by inheriting the ``BaseTarget`` class, which is an abstract class that cannot be used - as a value of ``TEST_TARGET``. + as a value of :term:`TEST_TARGET`. - You can provide the following arguments with ``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/common-tasks:enabling runtime tests on qemu`" section + ":ref:`dev-manual/runtime-testing:enabling runtime tests on qemu`" section in the Yocto Project Development Tasks Manual for more information. @@ -8152,17 +9153,16 @@ system and gives an overview of their function and contents. ``meta/lib/oeqa/controllers/simpleremote.py``. For information on running tests on hardware, see the - ":ref:`dev-manual/common-tasks:enabling runtime tests on hardware`" + ":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 ``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: - :: + an example:: TEST_TARGET_IP = "192.168.1.4:2201" @@ -8174,7 +9174,7 @@ system and gives an overview of their function and contents. :term:`TESTIMAGE_AUTO` Automatically runs the series of automated tests for images when an - image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes + 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. @@ -8190,9 +9190,9 @@ system and gives an overview of their function and contents. For more information on enabling, running, and writing these tests, see the - ":ref:`dev-manual/common-tasks:performing automated runtime testing`" + ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" section in the Yocto Project Development Tasks Manual and the - ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section. + ":ref:`ref-classes-testimage`" section. :term:`THISDIR` The directory in which the file BitBake is currently parsing is @@ -8206,24 +9206,23 @@ system and gives an overview of their function and contents. :term:`TMPDIR` This variable is the base directory the OpenEmbedded build system uses for all build output and intermediate files (other than the - shared state cache). By default, the ``TMPDIR`` variable points to + 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`: - :: + ``conf/local.conf`` file in the :term:`Source Directory`:: #TMPDIR = "${TOPDIR}/tmp" - An example use for this scenario is to set ``TMPDIR`` to a local disk, - which does not use NFS, while having the Build Directory use NFS. + 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 ``TMPDIR`` must have standard filesystem + 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, ``TMPDIR`` cannot be on NFS. + Consequently, :term:`TMPDIR` cannot be on NFS. :term:`TOOLCHAIN_HOST_TASK` This variable lists packages the OpenEmbedded build system uses when @@ -8231,8 +9230,7 @@ system and gives an overview of their function and contents. 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: - :: + consider the following command when building an SDK:: $ bitbake -c populate_sdk imagename @@ -8250,11 +9248,29 @@ system and gives an overview of their function and contents. 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 ``TOOLCHAIN_OUTPUTNAME`` variable as follows: - :: + the :term:`TOOLCHAIN_OUTPUTNAME` variable as follows:: TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" @@ -8281,16 +9297,14 @@ system and gives an overview of their function and contents. :doc:`/sdk-manual/index` manual. :term:`TOPDIR` - The top-level :term:`Build Directory`. BitBake - automatically sets this variable when you initialize your build - environment using :ref:`structure-core-script`. + 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 - ``TARGET_ARCH``. + :term:`TARGET_ARCH`. Do not edit this variable. @@ -8299,19 +9313,18 @@ system and gives an overview of their function and contents. ``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses this value to setup configuration. - ``TUNE_ARCH`` definitions are specific to a given architecture. The + :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 - ``TUNE_ARCH`` specific to the ``mips`` architecture. + :term:`TUNE_ARCH` specific to the ``mips`` architecture. - ``TUNE_ARCH`` is tied closely to + :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 ``TARGET_ARCH`` as follows: - :: + (``meta/conf/bitbake.conf``) sets :term:`TARGET_ARCH` as follows:: TARGET_ARCH = "${TUNE_ARCH}" @@ -8329,12 +9342,11 @@ system and gives an overview of their function and contents. :term:`TUNE_ASARGS` Specifies architecture-specific assembler flags for the target system. The set of flags is based on the selected tune features. - ``TUNE_ASARGS`` is set using the tune include files, which are + :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: - :: + for the x86 architecture as follows:: TUNE_ASARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}" @@ -8347,7 +9359,7 @@ system and gives an overview of their function and contents. :term:`TUNE_CCARGS` Specifies architecture-specific C compiler flags for the target system. The set of flags is based on the selected tune features. - ``TUNE_CCARGS`` is set using the tune include files, which are + :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`. @@ -8367,22 +9379,20 @@ system and gives an overview of their function and contents. are not conflicting and that they are supported. The BitBake configuration file (``meta/conf/bitbake.conf``) defines - ``TUNE_FEATURES`` as follows: - :: + :term:`TUNE_FEATURES` as follows:: - TUNE_FEATURES ??= "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" + TUNE_FEATURES ??= "${TUNE_FEATURES:tune-${DEFAULTTUNE}}" See the :term:`DEFAULTTUNE` variable for more information. :term:`TUNE_LDARGS` Specifies architecture-specific linker flags for the target system. The set of flags is based on the selected tune features. - ``TUNE_LDARGS`` is set using the tune include files, which are + :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: - :: + for the x86 architecture as follows:: TUNE_LDARGS += "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", d)}" @@ -8395,51 +9405,15 @@ system and gives an overview of their function and contents. :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 is defined using the "_tune" override as follows:: - TUNE_PKGARCH_tune-tune = "tune" + TUNE_PKGARCH:tune-tune = "tune" These tune-specific package architectures are defined in the machine include files. Here is an example of the "core2-32" tuning as used in - the ``meta/conf/machine/include/tune-core2.inc`` file: - :: - - TUNE_PKGARCH_tune-core2-32 = "core2-32" - - :term:`TUNEABI` - An underlying Application Binary Interface (ABI) used by a particular - tuning in a given toolchain layer. Providers that use prebuilt - libraries can use the ``TUNEABI``, - :term:`TUNEABI_OVERRIDE`, and - :term:`TUNEABI_WHITELIST` variables to check - compatibility of tunings against their selection of libraries. - - If ``TUNEABI`` is undefined, then every tuning is allowed. See the - :ref:`sanity <ref-classes-sanity>` class to see how the variable is - used. - - :term:`TUNEABI_OVERRIDE` - If set, the OpenEmbedded system ignores the - :term:`TUNEABI_WHITELIST` variable. - Providers that use prebuilt libraries can use the - ``TUNEABI_OVERRIDE``, ``TUNEABI_WHITELIST``, and - :term:`TUNEABI` variables to check compatibility of a - tuning against their selection of libraries. - - See the :ref:`sanity <ref-classes-sanity>` class to see how the - variable is used. - - :term:`TUNEABI_WHITELIST` - A whitelist of permissible :term:`TUNEABI` values. If - ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers - that use prebuilt libraries can use the ``TUNEABI_WHITELIST``, - :term:`TUNEABI_OVERRIDE`, and ``TUNEABI`` - variables to check compatibility of a tuning against their selection - of libraries. - - See the :ref:`sanity <ref-classes-sanity>` class to see how the - variable is used. + 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 @@ -8449,8 +9423,7 @@ system and gives an overview of their function and contents. 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: - :: + feature:: TUNECONFLICTS[n32] = "o32 n64" @@ -8459,65 +9432,164 @@ system and gives an overview of their function and contents. 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: - :: + from that file:: TUNEVALID[bigendian] = "Enable big-endian mode." See the machine include files in the :term:`Source Directory` for these features. - :term:`UBOOT_CONFIG` - Configures the :term:`UBOOT_MACHINE` and can - also define :term:`IMAGE_FSTYPES` for individual - cases. - - Following is an example from the ``meta-fsl-arm`` layer. :: - - UBOOT_CONFIG ??= "sd" - UBOOT_CONFIG[sd] = "mx6qsabreauto_config,sdcard" - UBOOT_CONFIG[eimnor] = "mx6qsabreauto_eimnor_config" - UBOOT_CONFIG[nand] = "mx6qsabreauto_nand_config,ubifs" - UBOOT_CONFIG[spinor] = "mx6qsabreauto_spinor_config" + :term:`UBOOT_BINARY` + Specifies the name of the binary build by U-Boot. - In this example, "sd" is selected as the configuration of the possible four for the - ``UBOOT_MACHINE``. The "sd" configuration defines - "mx6qsabreauto_config" as the value for ``UBOOT_MACHINE``, while the - "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-Boot image. - - For more information on how the ``UBOOT_CONFIG`` is handled, see the - :ref:`uboot-config <ref-classes-uboot-config>` - class. + :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 ``UBOOT_DTB_LOADADDRESS`` variable is used in - :ref:`kernel-fitimage <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. + 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 ``UBOOT_DTBO_LOADADDRESS`` variable is used in - :ref:`kernel-fitimage <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. + 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 ``UBOOT_ENTRYPOINT`` variable is passed as a + 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 ``UBOOT_LOADADDRESS`` variable is passed as a + 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: - :: + "2013.10-yocto" given the following statement:: UBOOT_LOCALVERSION = "-yocto" @@ -8536,56 +9608,65 @@ system and gives an overview of their function and contents. :term:`UBOOT_MKIMAGE` Specifies the name of the mkimage command as used by the - :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to assemble + :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 FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. - If ``UBOOT_MKIMAGE_DTCOPTS`` is not set then kernel-fitimage will not - pass the ``-D`` option to mkimage. + 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:`kernel-fitimage <ref-classes-kernel-fitimage>` class to sign + :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:`kernel-fitimage <ref-classes-kernel-fitimage>` class to pass to 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 - ``UBOOT_RD_ENTRYPOINT`` variable is used - in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the - entrypoint to be used in creating the Image Tree Source for - the FIT image. + 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 - ``UBOOT_RD_LOADADDRESS`` variable is used - in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the - load address to be used in creating the Image Tree Source for - the FIT image. + 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. + 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 for signing U-Boot FIT image stored in - :term:`UBOOT_SIGN_KEYDIR` directory. For e.g. dev.key key and dev.crt - certificate stored in :term:`UBOOT_SIGN_KEYDIR` directory will have - :term:`UBOOT_SIGN_KEYNAME` set to "dev". + 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`` @@ -8600,104 +9681,134 @@ system and gives an overview of their function and contents. passes and uses "all" for the target during the U-Boot building process. - :term:`UNKNOWN_CONFIGURE_WHITELIST` + :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, common options, for example, exist that are passed to all - configure scripts at a class level that might not be valid for some - configure scripts. It follows that no benefit exists in seeing a - warning about these options. For these cases, the options are added - to ``UNKNOWN_CONFIGURE_WHITELIST``. + 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 - ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the - :ref:`insane <ref-classes-insane>` class and is only enabled if the - recipe inherits the :ref:`autotools <ref-classes-autotools>` class. + :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:`UNPACKDIR` + This variable, used by the :ref:`ref-classes-base` class, + specifies where fetches sources should be unpacked by the + :ref:`ref-tasks-unpack` task. :term:`UPDATERCPN` For recipes inheriting the - :ref:`update-rc.d <ref-classes-update-rc.d>` class, ``UPDATERCPN`` + :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 ``bitbake -c checkpkg`` recipe. If + 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 ``UPSTREAM_CHECK_GITTAGREGEX`` variable to provide a + 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. - :: + default filter not work correctly:: UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" :term:`UPSTREAM_CHECK_REGEX` - Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different + 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`. - :: + :term:`UPSTREAM_CHECK_URI`:: UPSTREAM_CHECK_REGEX = "package_regex" :term:`UPSTREAM_CHECK_URI` You can perform a per-recipe check for what the latest upstream - source code version is by calling ``bitbake -c checkpkg`` recipe. If + 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 ``UPSTREAM_CHECK_URI`` to provide a different URI that - contains the link to the latest tarball. - :: + 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 ``USE_DEVFS`` is "1" when no value is - specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a + 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/common-tasks:selecting a device manager`" section in + 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/common-tasks:enabling system services>`, - determines whether or not to run a - `getty <https://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ on any - virtual terminals in order to enable logging in through those + :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 ``USE_VT`` is "1" when no default value is - specifically set. Typically, you would set ``USE_VT`` to "0" in the + 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 (e.g. - ``buildstats``, ``image-mklibs``, and so forth). + OpenEmbedded build system to enable extra features. - The default list is set in your ``local.conf`` file: - :: + Classes inherited using :term:`USER_CLASSES` must be located in the + ``classes-global/`` or ``classes/`` subdirectories. - USER_CLASSES ?= "buildstats image-mklibs image-prelink" + The default list is set in your ``local.conf`` file:: + + USER_CLASSES ?= "buildstats" For more information, see - ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`. + ``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 @@ -8709,11 +9820,10 @@ system and gives an overview of their function and contents. The default behavior for the build system is to dynamically apply ``uid`` and ``gid`` values. Consequently, the - ``USERADD_ERROR_DYNAMIC`` variable is by default not set. If you plan + :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 ``USERADD_ERROR_DYNAMIC`` variable in your ``local.conf`` - file as follows: - :: + set the :term:`USERADD_ERROR_DYNAMIC` variable in your ``local.conf`` + file as follows:: USERADD_ERROR_DYNAMIC = "error" @@ -8727,7 +9837,7 @@ system and gives an overview of their function and contents. .. note:: There is a difference in behavior between setting - ``USERADD_ERROR_DYNAMIC`` to ``error`` and setting it to ``warn``. + :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 @@ -8743,8 +9853,7 @@ system and gives an overview of their function and contents. 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: - :: + variable as follows in your ``local.conf`` file:: USERADD_GID_TABLES = "files/group" @@ -8755,33 +9864,31 @@ system and gives an overview of their function and contents. causes the build system to use static ``gid`` values. :term:`USERADD_PACKAGES` - When inheriting the :ref:`useradd <ref-classes-useradd>` class, + 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: - :: + a recipe:: USERADD_PACKAGES = "${PN}" .. note:: - It follows that if you are going to use the ``USERADD_PACKAGES`` + 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:`useradd <ref-classes-useradd>` class, + 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: - :: + Here is an example from the ``dbus`` recipe:: - USERADD_PARAM_${PN} = "--system --home ${localstatedir}/lib/dbus \ + USERADD_PARAM:${PN} = "--system --home ${localstatedir}/lib/dbus \ --no-create-home --shell /bin/false \ --user-group messagebus" @@ -8797,8 +9904,7 @@ system and gives an overview of their function and contents. 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: - :: + variable as follows in your ``local.conf`` file:: USERADD_UID_TABLES = "files/passwd" @@ -8829,48 +9935,95 @@ system and gives an overview of their function and contents. 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, ``VOLATILE_LOG_DIR`` is set to "yes", which means the + 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:`insane.bbclass <ref-classes-insane>`" section. + ":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.wic``). For information on how to create a partitioned image, see the - ":ref:`dev-manual/common-tasks:creating partitioned images using wic`" + ":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 ``WKS_FILE_DEPENDS`` variable is only + 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 ``WKS_FILE_DEPENDS`` variable is similar to the + 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 - ``WKS_FILE_DEPENDS`` variable are added to the ``DEPENDS`` variable. + :term:`WKS_FILE_DEPENDS` variable are added to the :term:`DEPENDS` variable. - With the ``WKS_FILE_DEPENDS`` variable, you have the possibility to + 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. - Following is an example: - :: + Here is an example:: WKS_FILE_DEPENDS = "some-native-tool" @@ -8878,14 +10031,26 @@ system and gives an overview of their function and contents. 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 ``WORKDIR`` directory is defined as follows: - :: + The :term:`WORKDIR` directory is defined as follows:: ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} @@ -8894,18 +10059,17 @@ system and gives an overview of their function and contents. - :term:`TMPDIR`: The top-level build output directory - :term:`MULTIMACH_TARGET_SYS`: The target system identifier - :term:`PN`: The recipe name - - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which - is usually the case for most recipes, then `EXTENDPE` is blank) + - :term:`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 Build Directory at ``poky/build``, and a + ``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: - :: + follows:: poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 @@ -8916,6 +10080,37 @@ system and gives an overview of their function and contents. indirectly, includes "x11-base" in :term:`IMAGE_FEATURES`. - The default value of ``XSERVER``, if not specified in the machine + 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 index 5f7dba8775..e2c086ffa0 100644 --- a/documentation/ref-manual/varlocality.rst +++ b/documentation/ref-manual/varlocality.rst @@ -113,7 +113,7 @@ This section lists variables that are required for recipes. - :term:`LIC_FILES_CHKSUM` -- :term:`SRC_URI` - used in recipes that fetch local or remote files. +- :term:`SRC_URI` --- used in recipes that fetch local or remote files. .. _ref-varlocality-recipe-dependencies: |
