diff options
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/TODO | 11 | ||||
| -rw-r--r-- | documentation/ref-manual/classes.rst | 2235 | ||||
| -rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 37 | ||||
| -rw-r--r-- | documentation/ref-manual/faq.rst | 621 | ||||
| -rw-r--r-- | documentation/ref-manual/features.rst | 261 | ||||
| -rw-r--r-- | documentation/ref-manual/images.rst | 30 | ||||
| -rw-r--r-- | documentation/ref-manual/kickstart.rst | 32 | ||||
| -rw-r--r-- | documentation/ref-manual/qa-checks.rst | 119 | ||||
| -rw-r--r-- | documentation/ref-manual/release-process.rst | 102 | ||||
| -rw-r--r-- | documentation/ref-manual/resources.rst | 81 | ||||
| -rw-r--r-- | documentation/ref-manual/structure.rst | 179 | ||||
| -rw-r--r-- | documentation/ref-manual/svg/releases.svg | 1744 | ||||
| -rw-r--r-- | documentation/ref-manual/system-requirements.rst | 314 | ||||
| -rw-r--r-- | documentation/ref-manual/tasks.rst | 165 | ||||
| -rw-r--r-- | documentation/ref-manual/terms.rst | 204 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 4081 | ||||
| -rw-r--r-- | documentation/ref-manual/varlocality.rst | 2 |
17 files changed, 7107 insertions, 3111 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 79af45ada5..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 :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 :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 :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 @@ -170,18 +176,17 @@ example use for this class. are extracted into the subdirectory expected by the default value of :term:`S`:: - SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}" - + 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 @@ -198,51 +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 @@ -256,109 +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 :term:`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-cmake: -``cmake.bbclass`` -================= +``cmake`` +========= -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` class allows recipes to build software using the +`CMake <https://cmake.org/overview/>`__ build system. You can use the +:term:`EXTRA_OECMAKE` variable to specify additional configuration options to +pass to the ``cmake`` command line. + +By default, the :ref:`ref-classes-cmake` class uses +`Ninja <https://ninja-build.org/>`__ instead of GNU make for building, which +offers better build performance. If a recipe is broken with Ninja, then the +recipe can set the :term:`OECMAKE_GENERATOR` variable to ``Unix Makefiles`` to +use GNU make instead. + +If you need to install custom CMake toolchain files supplied by the application +being built, you should install them (during :ref:`ref-tasks-install`) to the +preferred CMake Module directory: ``${D}${datadir}/cmake/modules/``. -On the occasion that you would be installing custom CMake toolchain -files supplied by the application being built, you should install them -to the preferred CMake Module directory: ``${D}${datadir}/cmake/`` -Modules during -:ref:`ref-tasks-install`. +.. _ref-classes-cmake-qemu: + +``cmake-qemu`` +============== + +The :ref:`ref-classes-cmake-qemu` class might be used instead of the +:ref:`ref-classes-cmake` class. In addition to the features provided by the +:ref:`ref-classes-cmake` class, the :ref:`ref-classes-cmake-qemu` class passes +the ``CMAKE_CROSSCOMPILING_EMULATOR`` setting to ``cmake``. This allows to use +QEMU user-mode emulation for the execution of cross-compiled binaries on the +host machine. For more information about ``CMAKE_CROSSCOMPILING_EMULATOR`` +please refer to the `related section of the CMake documentation +<https://cmake.org/cmake/help/latest/variable/CMAKE_CROSSCOMPILING_EMULATOR.html>`__. + +Not all platforms are supported by QEMU. This class only works for machines with +``qemu-usermode`` in the :ref:`ref-features-machine`. Using QEMU user-mode therefore +involves a certain risk, which is also the reason why this feature is not part of +the main :ref:`ref-classes-cmake` class by default. + +One use case is the execution of cross-compiled unit tests with CTest on the build +machine. If ``CMAKE_CROSSCOMPILING_EMULATOR`` is configured:: + + cmake --build --target test + +works transparently with QEMU user-mode. + +If the CMake project is developed with this use case in mind this works very nicely. +This also applies to an IDE configured to use ``cmake-native`` for cross-compiling. .. _ref-classes-cml1: -``cml1.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. @@ -371,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 @@ -395,10 +523,10 @@ 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 @@ -406,26 +534,81 @@ discussion on these cross-compilation tools. .. _ref-classes-cve-check: -``cve-check.bbclass`` -===================== +``cve-check`` +============= -The ``cve-check`` class looks for known CVEs (Common Vulnerabilities -and Exposures) while building an image. This class is meant to be +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. You will find details in the -":ref:`dev-manual/common-tasks:checking for vulnerabilities`" +``-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. @@ -437,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 @@ -451,28 +634,76 @@ add the task at the appropriate place, which is usually after :ref:`ref-tasks-install`. The class then takes care of staging the files from :term:`DEPLOYDIR` to :term:`DEPLOY_DIR_IMAGE`. +.. _ref-classes-devicetree: + +``devicetree`` +============== + +The :ref:`ref-classes-devicetree` class allows to build a recipe that compiles +device tree source files that are not in the kernel tree. + +The compilation of out-of-tree device tree sources is the same as the kernel +in-tree device tree compilation process. This includes the ability to include +sources from the kernel such as SoC ``dtsi`` files as well as C header files, +such as ``gpio.h``. + +The :ref:`ref-tasks-compile` task will compile two kinds of files: + +- Regular device tree sources with a ``.dts`` extension. + +- Device tree overlays, detected from the presence of the ``/plugin/;`` + string in the file contents. + +This class deploys the generated device tree binaries into +``${``\ :term:`DEPLOY_DIR_IMAGE`\ ``}/devicetree/``. This is similar to +what the :ref:`ref-classes-kernel-devicetree` class does, with the added +``devicetree`` subdirectory to avoid name clashes. Additionally, the device +trees are populated into the sysroot for access via the sysroot from within +other recipes. + +By default, all device tree sources located in :term:`DT_FILES_PATH` directory +are compiled. To select only particular sources, set :term:`DT_FILES` to +a space-separated list of files (relative to :term:`DT_FILES_PATH`). For +convenience, both ``.dts`` and ``.dtb`` extensions can be used. + +An extra padding is appended to non-overlay device trees binaries. This +can typically be used as extra space for adding extra properties at boot time. +The padding size can be modified by setting :term:`DT_PADDING_SIZE` +to the desired size, in bytes. + +See :oe_git:`devicetree.bbclass sources +</openembedded-core/tree/meta/classes-recipe/devicetree.bbclass>` +for further variables controlling this class. + +Here is an excerpt of an example ``recipes-kernel/linux/devicetree-acme.bb`` +recipe inheriting this class:: + + inherit devicetree + COMPATIBLE_MACHINE = "^mymachine$" + SRC_URI:mymachine = "file://mymachine.dts" + .. _ref-classes-devshell: -``devshell.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" + 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 @@ -488,43 +719,22 @@ Any development-specific adjustments can be done by using the 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 :term:`BBCLASSEXTEND` syntax (i.e. ``devupstream:target``) provides -support for ``native`` and ``nativesdk`` variants. Consequently, this +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. @@ -532,9 +742,8 @@ 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 +: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 @@ -549,19 +758,18 @@ 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 @@ -569,13 +777,11 @@ 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:: @@ -590,29 +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: @@ -633,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 @@ -649,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 @@ -671,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 @@ -704,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 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` or + 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: @@ -742,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 @@ -753,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 @@ -774,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. @@ -792,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. @@ -812,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 @@ -820,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. @@ -831,33 +1102,34 @@ 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 :term:`SSTATE_MIRRORS`, then all developers and the build -system need to either inherit the ``icecc`` class or nobody should. +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:: @@ -874,10 +1146,10 @@ individually as follows in your ``local.conf`` file:: .. _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. @@ -889,7 +1161,7 @@ then one or more image files are created. 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 @@ -897,37 +1169,55 @@ Yocto Project Overview and Concepts Manual. .. _ref-classes-image-buildinfo: -``image-buildinfo.bbclass`` -=========================== +``image-buildinfo`` +=================== + +The :ref:`ref-classes-image-buildinfo` class writes a plain text file containing +build information to the target filesystem at ``${sysconfdir}/buildinfo`` +by default (as specified by :term:`IMAGE_BUILDINFO_FILE`). +This can be useful for manually determining the origin of any given +image. It writes out two sections: -The ``image-buildinfo`` class writes information to the target -filesystem on ``/etc/build``. +#. `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 +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:: @@ -937,8 +1227,8 @@ The ``image_types`` class also handles conversion and compression of 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 @@ -948,27 +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-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-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 @@ -996,8 +1271,8 @@ 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. -Here are the tests you can list with the :term:`WARN_QA` and -:term:`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 @@ -1014,8 +1289,8 @@ Here are the tests you can list with the :term:`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 @@ -1028,7 +1303,7 @@ Here are the tests you can list with the :term:`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 @@ -1037,11 +1312,21 @@ Here are the tests you can list with the :term:`WARN_QA` and ``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. @@ -1076,6 +1361,11 @@ Here are the tests you can list with the :term:`WARN_QA` and 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``. @@ -1110,12 +1400,12 @@ Here are the tests you can list with the :term:`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`, @@ -1148,11 +1438,39 @@ Here are the tests you can list with the :term:`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. @@ -1206,12 +1524,20 @@ Here are the tests you can list with the :term:`WARN_QA` and 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. @@ -1222,6 +1548,15 @@ Here are the tests you can list with the :term:`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`). @@ -1231,25 +1566,35 @@ Here are the tests you can list with the :term:`WARN_QA` and 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:: This is only relevant when you are using runtime package management on your target system. +- ``virtual-slash:`` Checks to see if ``virtual/`` is being used in + :term:`RDEPENDS` or :term:`RPROVIDES`, which is not good practice --- + ``virtual/`` is a convention intended for use in the build context + (i.e. :term:`PROVIDES` and :term:`DEPENDS`) rather than the runtime + context. + - ``xorg-driver-abi:`` Checks that all packages containing Xorg drivers have ABI dependencies. The ``xserver-xorg`` recipe provides driver ABI names. All drivers should depend on the ABI versions that @@ -1258,184 +1603,188 @@ Here are the tests you can list with the :term:`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 :term:`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 +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. + +Its behavior is mainly controlled by the following variables: -The ``kernel-devicetree`` class, which is inherited by the -:ref:`kernel <ref-classes-kernel>` class, supports device tree -generation. +- :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 @@ -1443,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 @@ -1484,71 +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-meson: + +``meson`` +========= + +The :ref:`ref-classes-meson` class allows to create recipes that build software +using the `Meson <https://mesonbuild.com/>`__ build system. You can use the +:term:`MESON_BUILDTYPE`, :term:`MESON_TARGET` and :term:`EXTRA_OEMESON` +variables to specify additional configuration options to be passed using the +``meson`` command line. + .. _ref-classes-metadata_scm: -``metadata_scm.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 @@ -1557,44 +1936,44 @@ 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:: @@ -1616,17 +1995,17 @@ a couple different ways: 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`). @@ -1634,11 +2013,11 @@ 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 + :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" @@ -1657,26 +2036,26 @@ couple different ways: 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:: @@ -1684,35 +2063,35 @@ 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 available in +The :ref:`ref-classes-oelint` class is an obsolete lint checking tool available in ``meta/classes`` in the :term:`Source Directory`. There are some classes that could be generally useful in OE-Core but -are never actually used within OE-Core itself. The ``oelint`` class is +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.bbclass`` -======================= +``overlayfs`` +============= -It's often desired in Embedded System design to have a read-only rootfs. +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 rootfs, but you may want your application data to be preserved -between updates. The :ref:`overlayfs <ref-classes-overlayfs>` class provides a way +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 -rootfs read-only. +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 @@ -1725,7 +2104,7 @@ is supported by ``overlayfs``. This has to be done in your machine configuration * 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>`_. + 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. @@ -1736,7 +2115,8 @@ Then you can specify writable directories on a recipe basis (e.g. in my-applicat 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. +survives a reboot, then we could have a ``mnt-overlay.mount`` unit for a ``tmpfs`` +file system. In your machine configuration:: @@ -1746,16 +2126,75 @@ 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. @@ -1771,38 +2210,28 @@ 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 :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 @@ -1813,7 +2242,7 @@ complete build of the package with all dependencies previously built. The reason for this discrepancy is because the RPM package manager creates and processes more :term:`Metadata` than the IPK package manager. Consequently, you might consider setting :term:`PACKAGE_CLASSES` to -"package_ipk" if you are building smaller systems. +":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: @@ -1838,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 +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_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 -is enabled through the :term:`PACKAGE_CLASSES` -variable in the ``local.conf`` file. - -.. note:: - - You cannot specify the ``package_tar`` class first using the - :term:`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 +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. @@ -1966,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`" @@ -1992,34 +2501,34 @@ 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 @@ -2032,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 @@ -2049,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:: @@ -2062,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:: @@ -2075,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 @@ -2146,41 +2666,40 @@ 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. @@ -2192,15 +2711,15 @@ override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows:: .. 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, @@ -2211,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 @@ -2223,60 +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 :term:`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 @@ -2285,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:: + + 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: -``sign_rpm.bbclass`` +``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 @@ -2358,12 +2947,12 @@ The class also provides variables like :term:`SITEINFO_ENDIANNESS` and .. _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`" @@ -2371,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, @@ -2387,19 +2976,19 @@ 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:: @@ -2461,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 @@ -2471,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: @@ -2514,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`. @@ -2543,27 +3131,27 @@ 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`, @@ -2576,60 +3164,57 @@ 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 +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 +kits (SDKs). The :ref:`ref-classes-testsdk` class runs tests on an SDK when called using the following:: $ bitbake -c testsdk image @@ -2637,13 +3222,13 @@ using the following:: .. 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 @@ -2660,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. @@ -2671,18 +3256,18 @@ 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:: @@ -2691,14 +3276,14 @@ variable using the "type" varflag. Here is an example:: .. _ref-classes-uboot-config: -``uboot-config.bbclass`` -======================== +``uboot-config`` +================ -The ``uboot-config`` class provides support for U-Boot configuration for +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:: @@ -2707,10 +3292,48 @@ You can also specify the machine using this method:: 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 @@ -2725,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 @@ -2759,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:: @@ -2769,10 +3392,10 @@ 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. @@ -2783,29 +3406,28 @@ 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. @@ -2821,17 +3443,15 @@ 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 + You do not use the :ref:`useradd-staticids <ref-classes-useradd>` class directly. You either enable or disable the class by setting the :term:`USERADDEXTENSION` variable. If you enable or disable the class in a configured system, :term:`TMPDIR` might contain incorrect ``uid`` and ``gid`` values. Deleting the :term:`TMPDIR` @@ -2839,43 +3459,42 @@ additional information. .. _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 a1a8bcdc98..9319addc3c 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst @@ -126,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 @@ -165,7 +164,7 @@ 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 @@ -354,7 +353,7 @@ variables in package recipes. :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://\`\`)` + - 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`` @@ -379,16 +378,7 @@ 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. -Notice the reported reason for not upgrading the ``base-passwd`` recipe. -In this example, while a new version is available upstream, you do not -want to use it because the dependency on ``cdebconf`` is not easily -satisfied. Maintainers can explicit the reason that is shown by adding -the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. -See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` -for an example. - -:: +Here is a partial example table that reports on all the recipes:: $ devtool check-upgrade-status ... @@ -399,6 +389,16 @@ for an example. INFO: base-passwd 3.5.29 3.5.51 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility ... +Notice the reported reason for not upgrading the ``base-passwd`` recipe. +In this example, while a new version is available upstream, you do not +want to use it because the dependency on ``cdebconf`` is not easily +satisfied. Maintainers can explicit the reason that is shown by adding +the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. +See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb?h=kirkstone>` +for an example:: + + RECIPE_NO_UPDATE_REASON = "Version 3.5.38 requires cdebconf for update-passwd utility" + Last but not least, you may set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` in a recipe when there's currently no way to determine its latest upstream version. @@ -411,7 +411,7 @@ Upgrading a Recipe As software matures, upstream recipes are upgraded to newer versions. As a developer, you need to keep your local recipes up-to-date with the upstream version releases. There are several ways of upgrading recipes. -You can read about them in the ":ref:`dev-manual/common-tasks: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. @@ -439,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: @@ -556,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 @@ -599,7 +598,7 @@ 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:: diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst index 6f2970df23..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,93 +34,108 @@ 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. + +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. -**Q:** How do I add my package to the Yocto Project? +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. -**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. +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" + +This statement limits the build system to pulling source from the +:term:`PREMIRRORS` only. Again, this technique is useful for reproducing +builds. + +Here is yet another technique:: + + BB_GENERATE_MIRROR_TARBALLS = "1" -**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 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:** Set :term:`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 -:term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` is in the -``meta/classes/base.bbclass`` file. +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:: -**Q:** I'm behind a firewall and need to use a proxy server. How do I do -that? + 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. -**A:** Most source fetching by the OpenEmbedded build system is done by +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:: @@ -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? +------------------------------------- + +If you see the error +``chmod: XXXXX new permissions are r-xrwxrwx, not r-xr-xr-x``, +you are probably running the build on an NTFS filesystem. Instead, +run the build system on a partition with a modern Linux filesystem such as +``ext4``, ``btrfs`` or ``xfs``. + +I see many 404 errors trying to download sources. Is anything wrong? +-------------------------------------------------------------------- + +Nothing is wrong. The OpenEmbedded build system checks any +configured source mirrors before downloading from the upstream sources. +The build system does this searching for both source archives and +pre-checked out versions of SCM-managed software. These checks help in +large installations because it can reduce load on the SCM servers +themselves. This can also allow builds to continue to work if an +upstream source disappears. -**Q:** I'm seeing random build failures. Help?! +Why do I get random build failures? +----------------------------------- -**A:** If the same build is failing in totally different and random +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,219 +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 - :term:`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? +Why don't other recipes find the files provided by my ``*-native`` recipe? +-------------------------------------------------------------------------- -**A:** The toolchain configuration is very flexible and customizable. It -is primarily controlled with the :term:`TCMODE` variable. This variable -controls which ``tcmode-*.inc`` file to include from the -``meta/conf/distro/include`` directory within the :term:`Source Directory`. +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. -The default value of :term:`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? - -**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 :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. +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. -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:: +Can I get rid of build output so I can start over? +-------------------------------------------------- - PREMIRRORS:prepend = "\ - git://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ - ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ - http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ - https://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n" +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. -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. +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. -Here are other options:: +Customizing generated images +============================ - BB_NO_NETWORK = "1" +What does the OpenEmbedded build system produce as output? +---------------------------------------------------------- -This statement tells BitBake to issue an error -instead of trying to access the Internet. This technique is useful if -you want to ensure code builds only from local sources. - -Here is another technique:: +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 :term:`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 :term:`PREMIRRORS` server is current:: +What do I need to ship for license compliance? +---------------------------------------------- - PREMIRRORS:prepend = "\ - git://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ - ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ - http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ - https://.*/.* &YOCTO_DL_URL;/mirror/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 -:term:`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 @@ -405,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 @@ -427,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 ded653221c..2ea946b31d 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst @@ -6,7 +6,7 @@ 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 @@ -52,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 @@ -62,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 @@ -70,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 @@ -100,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 @@ -108,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 @@ -125,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). @@ -166,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). @@ -176,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. @@ -183,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 @@ -196,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. -Here are the image features 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. @@ -216,8 +293,26 @@ Here are the image features 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. @@ -235,23 +330,40 @@ Here are the image features 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. @@ -264,6 +376,21 @@ 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 @@ -272,7 +399,7 @@ these valid features is as follows: - *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`. @@ -281,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. @@ -292,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 :term:`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 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` in - your distro's ``.conf`` file. 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. +and :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` variables +which allow distro or machine configuration maintainers to `consider` any +added feature, and decide when they wish to keep or exclude such feature, +thus preventing the backfilling from happening. + +Here are two examples to illustrate feature backfilling: + +- *The "pulseaudio" distro feature option*: Previously, PulseAudio support was + enabled within the Qt and GStreamer frameworks. Because of this, the feature + is now backfilled and thus enabled for all distros through the + :term:`DISTRO_FEATURES_BACKFILL` variable in the ``meta/conf/bitbake.conf`` + file. However, if your distro needs to disable the feature, you can do so + without affecting other existing distro configurations that need PulseAudio + support. You do this by adding "pulseaudio" to + :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` in your distro's ``.conf`` + file. So, adding the feature to this variable when it also exists in the + :term:`DISTRO_FEATURES_BACKFILL` variable prevents the build system from + adding the feature to your configuration's :term:`DISTRO_FEATURES`, + effectively disabling the feature for that particular distro. - *The "rtc" machine feature option*: Previously, real time clock (RTC) support was enabled for all target devices. Because of this, the feature is backfilled and thus enabled for all machines through the - :term:`MACHINE_FEATURES_BACKFILL` variable in the - ``meta/conf/bitbake.conf`` file. However, 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 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` - list in the machine's ``.conf`` file. 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. + :term:`MACHINE_FEATURES_BACKFILL` variable in the ``meta/conf/bitbake.conf`` + file. However, if your target device does not have this capability, you can + disable RTC support for your device without affecting other machines + that need RTC support. You do this by adding the "rtc" feature to the + :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` list in your machine's ``.conf`` + file. So, adding the feature to this variable when it also exists in the + :term:`MACHINE_FEATURES_BACKFILL` variable prevents the build system from + adding the feature to your configuration's :term:`MACHINE_FEATURES`, + effectively disabling RTC support for that particular machine. diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst index c6a7239c7e..c45f9104a9 100644 --- a/documentation/ref-manual/images.rst +++ b/documentation/ref-manual/images.rst @@ -14,15 +14,17 @@ 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` @@ -30,7 +32,7 @@ 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 @@ -78,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 @@ -112,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/kickstart.rst b/documentation/ref-manual/kickstart.rst index cac9f2f491..297887805c 100644 --- a/documentation/ref-manual/kickstart.rst +++ b/documentation/ref-manual/kickstart.rst @@ -54,8 +54,9 @@ 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:: @@ -81,12 +82,12 @@ the ``part`` and ``partition`` commands: 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`` @@ -95,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. @@ -124,6 +125,8 @@ the ``part`` and ``partition`` commands: - ``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 @@ -174,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 @@ -208,15 +211,10 @@ 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 :term:`APPEND` or ``grub`` kernel command line. @@ -224,3 +222,13 @@ supports the following options: the bootloader. You can provide a full pathname for the file or a file located in the ``canned-wks`` folder. This option overrides all other bootloader options. + +- ``--ptable``: Specifies the partition table format. Valid values are: + + - ``msdos`` + + - ``gpt`` + +- ``--timeout``: Specifies the number of seconds before the + bootloader times out and boots the default option. + diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index 792c099d0c..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 @@ -154,7 +154,16 @@ Errors and Warnings ``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]`` @@ -527,7 +536,7 @@ Errors and Warnings 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.  @@ -570,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: @@ -581,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: @@ -593,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. @@ -604,18 +613,20 @@ 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 :term:`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: @@ -623,7 +634,7 @@ Errors and Warnings - ``<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. @@ -644,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 @@ -658,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. @@ -668,7 +679,7 @@ 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: @@ -718,7 +729,7 @@ Errors and Warnings 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:: @@ -739,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 =================================== @@ -749,7 +818,7 @@ 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:: diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst index ab143f7df0..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 @@ -87,15 +87,51 @@ stable release. 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 allow community members to 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 ============================= @@ -107,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 @@ -117,52 +153,44 @@ 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:: diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst index c942384662..4eaaca942e 100644 --- a/documentation/ref-manual/resources.rst +++ b/documentation/ref-manual/resources.rst @@ -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: @@ -46,8 +45,8 @@ your expectations). For a general procedure and guidelines on how to use Bugzilla to submit a bug against the Yocto Project, see the following: -- The ":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>` @@ -64,26 +63,31 @@ 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: @@ -104,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. 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 +- 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 5f00edb06c..e4d8b54bb9 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -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,10 +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 @@ -170,28 +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. @@ -213,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. @@ -231,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`` @@ -261,15 +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:: - 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 @@ -278,10 +293,10 @@ file, it uses ``sed`` to substitute final .. note:: - You can see how the ``TEMPLATECONF`` variable is used by looking at the + 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: @@ -289,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. @@ -300,34 +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:: - 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/`` @@ -366,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. @@ -389,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 @@ -402,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 @@ -411,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 @@ -420,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), @@ -467,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 @@ -479,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 @@ -492,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` @@ -507,7 +515,7 @@ 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. Since @@ -525,12 +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 @@ -545,7 +553,7 @@ section in the Yocto Project Overview and Concepts Manual. .. _structure-build-tmp-log: ``build/tmp/log/`` ------------------- +~~~~~~~~~~~~~~~~~~ This directory contains general logs that are not otherwise placed using the package's :term:`WORKDIR`. Examples of logs are the output from the @@ -555,7 +563,7 @@ 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 @@ -571,7 +579,7 @@ built within the Yocto Project. For this package, a work directory of ``tmp/work/qemux86-poky-linux/linux-yocto/3.0+git1+<.....>``, referred to as the :term:`WORKDIR`, is created. Within this directory, the source is unpacked to ``linux-qemux86-standard-build`` and then patched by Quilt. -(See the ":ref:`dev-manual/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 @@ -587,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, @@ -623,7 +631,7 @@ Here are key subdirectories 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 + :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. @@ -645,7 +653,7 @@ Here are key subdirectories 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 @@ -654,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: @@ -694,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 @@ -705,7 +714,7 @@ 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 @@ -717,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 @@ -742,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: diff --git a/documentation/ref-manual/svg/releases.svg b/documentation/ref-manual/svg/releases.svg new file mode 100644 index 0000000000..198d4632b1 --- /dev/null +++ b/documentation/ref-manual/svg/releases.svg @@ -0,0 +1,1744 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + version="1.1" + id="svg2" + width="2040.0006" + height="624.30518" + viewBox="0 0 2040.0006 624.30515" + 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="736.24703" + inkscape:cy="312.32629" + 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="325" /> + </sodipodi:namedview> + <g + inkscape:groupmode="layer" + inkscape:label="Image" + id="g10" + transform="translate(-289.99936,325.00004)"> + <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="g1379"> + <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="140.00003" + 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:#333333;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" + width="979.99994" + height="45.000004" + x="1320" + y="-285.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="1373.233" + y="-265.32928" + id="text1185-3-55-4-0-0-0-1-1-6"><tspan + sodipodi:role="line" + x="1373.233" + y="-265.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">Scarthgap</tspan><tspan + sodipodi:role="line" + x="1373.233" + y="-247.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">5.0</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-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> + <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 d12e8dfbe3..0fc92550a5 100644 --- a/documentation/ref-manual/system-requirements.rst +++ b/documentation/ref-manual/system-requirements.rst @@ -29,38 +29,70 @@ 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 20.04 (LTS) -- Ubuntu 16.04 (LTS) +- Ubuntu 22.04 (LTS) -- Ubuntu 18.04 (LTS) +- Fedora 38 -- Ubuntu 20.04 (LTS) +- CentOS Stream 8 -- Fedora 30 +- Debian GNU/Linux 11 (Bullseye) -- Fedora 31 +- Debian GNU/Linux 12 (Bookworm) -- Fedora 32 +- OpenSUSE Leap 15.4 -- CentOS 7.x +- AlmaLinux 8 -- CentOS 8.x +- AlmaLinux 9 -- Debian GNU/Linux 8.x (Jessie) +- Rocky 9 -- Debian GNU/Linux 9.x (Stretch) +The following distribution versions are still tested, even though the +organizations publishing them no longer make updates publicly available: -- Debian GNU/Linux 10.x (Buster) +- Ubuntu 18.04 (LTS) -- openSUSE Leap 15.1 +- 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:: @@ -78,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 ==================================== @@ -110,8 +147,10 @@ function. Ubuntu and Debian ----------------- -Here are 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:: @@ -123,122 +162,68 @@ supported Ubuntu or Debian Linux distribution: $ sudo apt build-dep qemu $ sudo apt remove oss4-dev - - For Debian-8, ``python3-git`` and ``pylint3`` are no longer - available via ``apt``. - :: - - $ sudo pip3 install GitPython pylint==1.9.5 - -- *Essentials:* Packages needed to build an image on a headless system:: - - $ sudo apt install &UBUNTU_HOST_PACKAGES_ESSENTIAL; - -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals:: - - $ sudo apt install make python3-pip - &PIP3_HOST_PACKAGES_DOC; +Here are the packages needed to build Project documentation manuals:: - .. 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 --------------- -Here are the required packages by function given a -supported Fedora Linux distribution: +Here are the packages needed to build an image on a headless system +with a supported Fedora Linux distribution:: -- *Essentials:* Packages needed to build an image for a headless - system:: + $ sudo dnf install &FEDORA_HOST_PACKAGES_ESSENTIAL; - $ sudo dnf install &FEDORA_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 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 ----------------- -Here are the required packages by function given a -supported openSUSE Linux distribution: +Here are the packages needed to build an image on a headless system +with a supported openSUSE distribution:: -- *Essentials:* Packages needed to build an image for a headless - system:: + $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; - $ sudo zypper install &OPENSUSE_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 zypper install git make python3-pip which inkscape texlive-fncychap + &PIP3_HOST_PACKAGES_DOC; - $ sudo zypper install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; +AlmaLinux Packages +------------------ -CentOS-7 Packages ------------------ +Here are the packages needed to build an image on a headless system +with a supported AlmaLinux distribution:: -Here are the required packages by function given a -supported CentOS-7 Linux distribution: + $ sudo dnf install &ALMALINUX_HOST_PACKAGES_ESSENTIAL; -- *Essentials:* Packages needed to build an image for a headless - system:: - - $ sudo yum install &CENTOS7_HOST_PACKAGES_ESSENTIAL; - - .. note:: - - - Extra Packages for Enterprise Linux (i.e. ``epel-release``) is - a collection of packages from Fedora built on RHEL/CentOS for - easy installation of packages not included in enterprise Linux - by default. You need to install these packages separately. - - - The ``makecache`` command consumes additional Metadata from - ``epel-release``. - -- *Documentation:* Packages needed if you are going to build out the - Yocto Project documentation manuals:: - - $ sudo yum install make python3-pip which - &PIP3_HOST_PACKAGES_DOC; - -CentOS-8 Packages ------------------ - -Here are 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: @@ -249,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: @@ -260,21 +247,26 @@ 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 \ @@ -283,7 +275,7 @@ installer and automatically installs the tools for you: --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. @@ -294,25 +286,29 @@ installer and automatically installs the tools for you: /path/to/poky/buildtools If your host development system needs the additional tools provided - in the ``buildtools-extended`` tarball, you can instead execute the + 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 + Alternatively if your host development system has a broken ``make`` + version such that you only need a known good version of ``make``, + you can use the ``--make-only`` option:: + + $ cd poky + $ scripts/install-buildtools --make-only + +#. Source the tools environment setup script by using a command like the following:: $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux - 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``. @@ -320,12 +316,14 @@ 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 +#. Execute the installation script. Here is an example for the traditional installer:: $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh @@ -334,51 +332,55 @@ steps: $ 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:: - - $ source /home/your_username/buildtools/environment-setup-i586-poky-linux +#. As instructed by the installer script, you will have to source the tools + environment setup script:: - 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 @@ -387,37 +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 +#. 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 299969dea4..2e4b23408d 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:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and -":ref:`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: @@ -58,7 +58,7 @@ The default behavior of this task is to run ``oe_runmake clean`` if a makefile (``Makefile``, ``makefile``, or ``GNUmakefile``) is found and :term:`CLEANBROKEN` is not set to "1". If no such file is found or the :term:`CLEANBROKEN` variable is set to "1", the -``do_configure`` task does nothing. +: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,19 +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:: 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" @@ -110,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: @@ -118,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: @@ -128,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. @@ -146,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`. @@ -168,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>`. @@ -187,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: @@ -212,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 @@ -225,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: @@ -260,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`` @@ -326,26 +315,24 @@ file as a patch file:: 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 +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: @@ -371,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. @@ -394,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"). @@ -408,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: @@ -417,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: @@ -449,7 +436,7 @@ 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 @@ -475,7 +462,7 @@ 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. @@ -483,9 +470,29 @@ 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: @@ -494,7 +501,7 @@ 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. @@ -503,13 +510,25 @@ 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:: @@ -524,7 +543,7 @@ scratch is guaranteed. 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 python development 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 ``pydevshell``. @@ -534,7 +553,7 @@ using ``pydevshell``. --------------- 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``. @@ -577,10 +596,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: @@ -599,7 +616,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: @@ -612,7 +629,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 @@ -659,7 +676,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. @@ -670,7 +687,7 @@ 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 @@ -688,7 +705,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 @@ -721,7 +738,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,4 +810,4 @@ After the kernel is unpacked but before it is patched, this task makes sure that the machine and metadata branches as specified by the :term:`SRCREV` variables actually exist on the specified branches. Otherwise, if :term:`AUTOREV` is not being used, the -``do_validate_branches`` task fails during the build. +: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 eccae91a1c..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,7 +21,7 @@ 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:appending other layers metadata with your layer`" + 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 @@ -64,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 + 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 Build Directory cannot be under - NFS. However, if you need the Build Directory to be under NFS, you can + 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 - Build Directory. + :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 @@ -134,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 @@ -175,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 @@ -188,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 @@ -213,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 @@ -253,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`). @@ -306,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 @@ -340,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 @@ -366,6 +474,42 @@ 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 per-recipe unit of execution for BitBake (e.g. :ref:`ref-tasks-compile`, @@ -387,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 cc55f33d98..3f37f42f21 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 @@ -56,7 +57,7 @@ system and gives an overview of their function and contents. 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` @@ -76,7 +77,7 @@ system and gives an overview of their function and contents. 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` @@ -92,7 +93,7 @@ system and gives an overview of their function and contents. 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` @@ -122,12 +123,10 @@ 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, @@ -135,20 +134,19 @@ system and gives an overview of their function and contents. 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 @@ -194,23 +192,15 @@ system and gives an overview of their function and contents. 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, + 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 :term:`SRCREV` is set to the value of this variable, it specifies to @@ -220,27 +210,20 @@ system and gives an overview of their function and contents. 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 :term:`PV`. Consequently, you need to change :term:`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 :term:`COMMON_LICENSE_DIR` and - :term:`LICENSE_PATH` have been done before :term:`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) @@ -250,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:`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>"" @@ -272,9 +254,9 @@ 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 + 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}" @@ -315,7 +297,7 @@ 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 :term:`BASE_LIB` applies only in the Multilib - context. See the ":ref:`dev-manual/common-tasks:combining multiple versions of library files into one image`" + 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. @@ -329,7 +311,7 @@ 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 :term:`BB_NO_NETWORK` is either not set @@ -337,8 +319,7 @@ system and gives an overview of their function and contents. - 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``. - :: + ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``:: BB_ALLOWED_NETWORKS = "*.gnu.org" @@ -366,6 +347,21 @@ system and gives an overview of their function and contents. host listed in :term:`SRC_URI` after a successful fetch from the :term:`PREMIRRORS` occurs. + :term:`BB_BASEHASH_IGNORE_VARS` + See :term:`bitbake:BB_BASEHASH_IGNORE_VARS` in the BitBake manual. + + :term:`BB_CACHEDIR` + See :term:`bitbake:BB_CACHEDIR` in the BitBake manual. + + :term:`BB_CHECK_SSL_CERTS` + See :term:`bitbake:BB_CHECK_SSL_CERTS` in the BitBake manual. + + :term:`BB_CONSOLELOG` + See :term:`bitbake:BB_CONSOLELOG` in the BitBake manual. + + :term:`BB_CURRENTTASK` + See :term:`bitbake:BB_CURRENTTASK` in the BitBake manual. + :term:`BB_DANGLINGAPPENDS_WARNONLY` Defines how BitBake handles situations where an append file (``.bbappend``) has no corresponding recipe file (``.bb``). This @@ -384,6 +380,12 @@ system and gives an overview of their function and contents. 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. @@ -400,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 @@ -438,7 +440,7 @@ 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 @@ -452,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. @@ -505,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 @@ -512,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" @@ -524,6 +537,52 @@ system and gives an overview of their function and contents. 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 @@ -539,9 +598,63 @@ system and gives an overview of their function and contents. 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 :term:`BB_SERVER_TIMEOUT` to determine how @@ -555,15 +668,45 @@ system and gives an overview of their function and contents. If you want the server to never be unloaded, set :term:`BB_SERVER_TIMEOUT` to "-1". + :term:`BB_SETSCENE_DEPVALID` + See :term:`bitbake:BB_SETSCENE_DEPVALID` in the BitBake manual. + + :term:`BB_SIGNATURE_EXCLUDE_FLAGS` + See :term:`bitbake:BB_SIGNATURE_EXCLUDE_FLAGS` in the BitBake manual. + + :term:`BB_SIGNATURE_HANDLER` + See :term:`bitbake:BB_SIGNATURE_HANDLER` in the BitBake manual. + + :term:`BB_SRCREV_POLICY` + See :term:`bitbake:BB_SRCREV_POLICY` in the BitBake manual. + + :term:`BB_STRICT_CHECKSUM` + See :term:`bitbake:BB_STRICT_CHECKSUM` in the BitBake manual. + + :term:`BB_TASK_IONICE_LEVEL` + See :term:`bitbake:BB_TASK_IONICE_LEVEL` in the BitBake manual. + + :term:`BB_TASK_NICE_LEVEL` + See :term:`bitbake:BB_TASK_NICE_LEVEL` in the BitBake manual. + + :term:`BB_TASKHASH` + See :term:`bitbake:BB_TASKHASH` in the BitBake manual. + + :term:`BB_VERBOSE_LOGS` + See :term:`bitbake:BB_VERBOSE_LOGS` in the BitBake manual. + + :term:`BB_WORKERCONTEXT` + See :term:`bitbake:BB_WORKERCONTEXT` in the BitBake manual. + :term:`BBCLASSEXTEND` Allows you to extend a recipe so that it builds variants of the software. There are common variants for recipes as "natives" like ``quilt-native``, which is a copy of Quilt built to run on the build system; "crosses" such as ``gcc-cross``, which is a compiler built to run on the build machine but produces binaries that run on the target - :term:`MACHINE`; "nativesdk", which targets the SDK - machine instead of :term:`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:: @@ -585,6 +728,9 @@ system and gives an overview of their function and contents. 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 @@ -602,7 +748,7 @@ 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 :term:`PV` value but for @@ -627,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. @@ -641,8 +787,10 @@ system and gives an overview of their function and contents. introduce a hard dependency on those other layers. Use the following form for :term:`BBFILES_DYNAMIC`: - collection_name:filename_pattern The following example identifies two - collection names and two filename patterns:: + ``collection_name:filename_pattern``. + + The following example identifies two collection names and two + filename patterns:: BBFILES_DYNAMIC += " \ clang-layer:${LAYERDIR}/bbappends/meta-clang/*/*/*.bbappend \ @@ -650,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 @@ -658,6 +806,9 @@ 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. @@ -682,6 +833,9 @@ 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. @@ -727,31 +881,19 @@ system and gives an overview of their function and contents. 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 :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 :term:`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, :term:`BBSERVER` points to the @@ -762,18 +904,20 @@ system and gives an overview of their function and contents. export BBSERVER=localhost:$port - By default, :term:`BBSERVER` also appears in :term:`BB_HASHBASE_WHITELIST`. + 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:: @@ -781,7 +925,7 @@ system and gives an overview of their function and contents. 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 @@ -798,10 +942,13 @@ 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 @@ -897,14 +1044,13 @@ system and gives an overview of their function and contents. :term:`BUILD_OS` Specifies the operating system in use on the build host (e.g. "linux"). The OpenEmbedded build system sets the value of - :term:`BUILD_OS` from the OS reported by the ``uname`` command - the + :term:`BUILD_OS` from the OS reported by the ``uname`` command --- the first word, converted to lower-case characters. :term:`BUILD_PREFIX` The toolchain binary prefix used for native recipes. The OpenEmbedded build system uses the :term:`BUILD_PREFIX` value to set the - :term:`TARGET_PREFIX` when building for - ``native`` recipes. + :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 @@ -915,7 +1061,7 @@ system and gives an overview of their function and contents. :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`, @@ -928,30 +1074,29 @@ system and gives an overview of their function and contents. 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 :term:`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 :term:`BUILDHISTORY_COMMIT_AUTHOR` variable to work, the :term:`BUILDHISTORY_COMMIT` variable must @@ -962,25 +1107,27 @@ system and gives an overview of their function and contents. 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: @@ -999,13 +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 @@ -1015,42 +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:`buildhistory <ref-classes-buildhistory>` + 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 ``buildhistory`` class sets the variable as follows:: + 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 - :term:`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, @@ -1077,8 +1227,7 @@ 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 + when you use and enable the :ref:`ref-classes-buildstats` class. The :term:`BUILDSTATS_BASE` directory defaults to ``${``\ :term:`TMPDIR`\ ``}/buildstats/``. @@ -1092,6 +1241,9 @@ system and gives an overview of their function and contents. 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 @@ -1121,9 +1273,8 @@ 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:: @@ -1165,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 @@ -1191,17 +1362,41 @@ 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 :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 :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 @@ -1216,6 +1411,11 @@ system and gives an overview of their function and contents. COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev' + .. note:: + + When installing complementary packages, recommends relationships + (set via :term:`RRECOMMENDS`) are always ignored. + :term:`COMPONENTS_DIR` Stores sysroot components for each recipe. The OpenEmbedded build system uses :term:`COMPONENTS_DIR` when constructing recipe-specific @@ -1267,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 :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` @@ -1296,8 +1496,7 @@ 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 :term:`CONFLICT_DISTRO_FEATURES` variable lists a feature that also @@ -1305,11 +1504,57 @@ system and gives an overview of their function and contents. the recipe will be skipped, and if the build system attempts to build the recipe then an error will be triggered. + :term:`CONVERSION_CMD` + This variable is used for storing image conversion commands. + Image conversion can convert an image into different objects like: + + - Compressed version of the image + + - Checksums for the image + + An example of :term:`CONVERSION_CMD` from :ref:`ref-classes-image_types` + class is:: + + CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}" + + :term:`COPY_LIC_DIRS` + If set to "1" along with the + :term:`COPY_LIC_MANIFEST` variable, the + OpenEmbedded build system copies into the image the license files, + which are located in ``/usr/share/common-licenses``, for each + package. The license files are placed in directories within the image + itself during build time. + + .. note:: + + The :term:`COPY_LIC_DIRS` does not offer a path for adding licenses for + newly installed packages to an image, which might be most suitable for + read-only filesystems that cannot be upgraded. See the + :term:`LICENSE_CREATE_PACKAGE` variable for additional information. + You can also reference the ":ref:`dev-manual/licenses:providing license text`" + section in the Yocto Project Development Tasks Manual for + information on providing license text. + + :term:`COPY_LIC_MANIFEST` + If set to "1", the OpenEmbedded build system copies the license + manifest for the image to + ``/usr/share/common-licenses/license.manifest`` within the image + itself during build time. + + .. note:: + + The :term:`COPY_LIC_MANIFEST` does not offer a path for adding licenses for + newly installed packages to an image, which might be most suitable for + read-only filesystems that cannot be upgraded. See the + :term:`LICENSE_CREATE_PACKAGE` variable for additional information. + You can also reference the ":ref:`dev-manual/licenses:providing license text`" + section in the Yocto Project Development Tasks Manual for + information on providing license text. + :term:`COPYLEFT_LICENSE_EXCLUDE` - A space-separated list of licenses to exclude from the source - archived by the :ref:`archiver <ref-classes-archiver>` class. In - other words, if a license in a recipe's - :term:`LICENSE` value is in the value of + 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. @@ -1320,92 +1565,54 @@ system and gives an overview of their function and contents. The default value, which is "CLOSED Proprietary", for :term:`COPYLEFT_LICENSE_EXCLUDE` is set by the - :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which - is inherited by the ``archiver`` class. + :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:`archiver <ref-classes-archiver>` class. In other + 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:`copyleft_filter <ref-classes-copyleft_filter>` class, which - is inherited by the ``archiver`` class. The default value includes - "GPL*", "LGPL*", and "AGPL*". + 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:`archiver <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` + :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:`copyleft_filter <ref-classes-copyleft_filter>` class, which - is inherited by the ``archiver`` class. + :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:`archiver <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` + :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:`copyleft_filter <ref-classes-copyleft_filter>` class, which - is inherited by the ``archiver`` class. + :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``, ``native``, ``nativesdk``, ``cross``, - ``crosssdk``, and ``cross-canadian``. + 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:`copyleft_filter <ref-classes-copyleft_filter>` - class, which is inherited by the ``archiver`` class. - - :term:`COPY_LIC_DIRS` - If set to "1" along with the - :term:`COPY_LIC_MANIFEST` variable, the - OpenEmbedded build system copies into the image the license files, - which are located in ``/usr/share/common-licenses``, for each - package. The license files are placed in directories within the image - itself during build time. - - .. note:: - - The :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`" - section in the Yocto Project Development Tasks Manual for - information on providing license text. - - :term:`COPY_LIC_MANIFEST` - If set to "1", the OpenEmbedded build system copies the license - manifest for the image to - ``/usr/share/common-licenses/license.manifest`` within the image - itself during build time. - - .. note:: - - The :term:`COPY_LIC_MANIFEST` does not offer a path for adding licenses for - newly installed packages to an image, which might be most suitable for - read-only filesystems that cannot be upgraded. See the - :term:`LICENSE_CREATE_PACKAGE` variable for additional information. - You can also reference the ":ref:`dev-manual/common-tasks:providing license text`" - section in the Yocto Project Development Tasks Manual for - information on providing license text. + 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 @@ -1471,22 +1678,39 @@ system and gives an overview of their function and contents. variable only in certain contexts (e.g. when building for kernel and kernel module recipes). - :term:`CVE_CHECK_PN_WHITELIST` + :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_CHECK_WHITELIST` - The list of CVE IDs which are ignored. Here is - an example from the :oe_layerindex:`Python3 recipe</layerindex/recipe/23823>`:: + :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. - # This is windows only issue. - CVE_CHECK_WHITELIST += "CVE-2020-15523" + :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`}. If it does not match the name in the NIST CVE + 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. @@ -1494,6 +1718,54 @@ system and gives an overview of their function and contents. 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. @@ -1540,7 +1812,7 @@ 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, + 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 @@ -1549,7 +1821,7 @@ system and gives an overview of their function and contents. DEBIAN_NOAUTONAME:fontconfig-utils = "1" :term:`DEBIANNAME` - When the :ref:`debian <ref-classes-debian>` class is inherited, + 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 @@ -1567,21 +1839,6 @@ system and gives an overview of their function and contents. compiling a system for debugging. This variable defaults to "-O -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe". - :term:`DEFAULT_PREFERENCE` - Specifies a weak bias for recipe selection priority. - - The most common usage of this is variable is to set it to "-1" within - a recipe for a development version of a piece of software. Using the - variable in this way causes the stable version of the recipe to build - by default in the absence of :term:`PREFERRED_VERSION` being used to - build the development version. - - .. note:: - - The bias provided by :term:`DEFAULT_PREFERENCE` is weak and is overridden - by :term:`BBFILE_PRIORITY` if that variable is different between two - layers that contain different versions of the same recipe. - :term:`DEBUG_PREFIX_MAP` Allows to set C compiler options, such as ``-fdebug-prefix-map``, ``-fmacro-prefix-map``, and ``-ffile-prefix-map``, which allow to @@ -1599,6 +1856,21 @@ system and gives an overview of their function and contents. This variable is set in the ``meta/conf/bitbake.conf`` file. It is not intended to be user-configurable. + :term:`DEFAULT_PREFERENCE` + Specifies a weak bias for recipe selection priority. + + The most common usage of this is variable is to set it to "-1" within + a recipe for a development version of a piece of software. Using the + variable in this way causes the stable version of the recipe to build + by default in the absence of :term:`PREFERRED_VERSION` being used to + build the development version. + + .. note:: + + The bias provided by :term:`DEFAULT_PREFERENCE` is weak and is overridden + by :term:`BBFILE_PRIORITY` if that variable is different between two + layers that contain different versions of the same recipe. + :term:`DEFAULTTUNE` The default CPU and Application Binary Interface (ABI) tunings (i.e. the "tune") used by the OpenEmbedded build system. The @@ -1620,16 +1892,15 @@ system and gives an overview of their function and contents. 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 :term:`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:: @@ -1645,7 +1916,7 @@ system and gives an overview of their function and contents. 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:: @@ -1675,22 +1946,21 @@ system and gives an overview of their function and contents. to the recipe that installs ``libbar``, other recipes might fail to link against ``libfoo``. - For information on runtime dependencies, see the - :term:`RDEPENDS` variable. You can also see the - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and - ":ref:`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 @@ -1700,9 +1970,8 @@ 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 :term:`DEPLOY_DIR_DEB` variable as a sub-folder of @@ -1710,7 +1979,7 @@ system and gives an overview of their function and contents. DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" - The :ref:`package_deb <ref-classes-package_deb>` class uses 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 @@ -1729,12 +1998,11 @@ system and gives an overview of their function and contents. 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:`deploy <ref-classes-deploy>` class or - with the contents of :term:`IMGDEPLOYDIR` by the :ref:`image - <ref-classes-image>` class. + :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 Build Directory, see - ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. + 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 @@ -1743,18 +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`:: DEPLOY_DIR_IPK = "${DEPLOY_DIR}/ipk" - The :ref:`package_ipk <ref-classes-package_ipk>` class uses the - :term:`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 @@ -1763,16 +2029,15 @@ 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`:: DEPLOY_DIR_RPM = "${DEPLOY_DIR}/rpm" - The :ref:`package_rpm <ref-classes-package_rpm>` class uses 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 @@ -1780,34 +2045,14 @@ system and gives an overview of their function and contents. ":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 - :term:`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 + 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 ``deploy`` class as follows:: + 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 + 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. @@ -1817,6 +2062,23 @@ system and gives an overview of their function and contents. :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` @@ -1850,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 @@ -1876,24 +2138,39 @@ system and gives an overview of their function and contents. 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 :term:`DISTRO_FEATURES` if not also present in - :term:`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 :term:`DISTRO_FEATURES_BACKFILL` that should not be - backfilled (i.e. added to :term:`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 @@ -1918,11 +2195,10 @@ system and gives an overview of their function and contents. :term:`DISTRO_FEATURES_FILTER_NATIVESDK` Specifies a list of features that if present in the target - :term:`DISTRO_FEATURES` value should be - included in :term:`DISTRO_FEATURES` when building 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 @@ -1935,10 +2211,9 @@ 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 @@ -1981,18 +2256,10 @@ system and gives an overview of their function and contents. 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 @@ -2005,8 +2272,7 @@ system and gives an overview of their function and contents. 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" @@ -2033,14 +2299,36 @@ 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 @@ -2048,9 +2336,14 @@ system and gives an overview of their function and contents. :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 @@ -2058,11 +2351,10 @@ 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``. @@ -2077,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 @@ -2144,39 +2498,52 @@ system and gives an overview of their function and contents. When kernel tools are available in the tree, they are preferred over any externally installed tools. Setting the :term:`EXTERNAL_KERNEL_TOOLS` variable tells the OpenEmbedded build system to prefer the installed - external tools. See the - :ref:`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>` + 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,31 +2565,31 @@ 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` @@ -2248,19 +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 @@ -2278,21 +2634,36 @@ system and gives an overview of their function and contents. :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 - :term:`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; \ @@ -2303,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:: @@ -2314,6 +2716,34 @@ 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`. @@ -2349,6 +2779,12 @@ 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 @@ -2365,7 +2801,7 @@ system and gives an overview of their function and contents. - 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. @@ -2397,12 +2833,11 @@ system and gives an overview of their function and contents. 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 :term:`FILESPATH` variable by using - :term:`FILESEXTRAPATHS`. + A colon-separated list to extend the search path the OpenEmbedded build + system uses when looking for files and patches as it processes recipes + and append files. The default directories BitBake uses when it processes + recipes are initially defined by the :term:`FILESPATH` variable. You can + extend :term:`FILESPATH` variable by using :term:`FILESEXTRAPATHS`. Best practices dictate that you accomplish this by using :term:`FILESEXTRAPATHS` from within a ``.bbappend`` file and that you @@ -2463,15 +2898,13 @@ system and gives an overview of their function and contents. recipe to correctly extend the path. :term:`FILESOVERRIDES` - 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: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 :term:`FILESOVERRIDES` variable is defined as:: @@ -2485,8 +2918,8 @@ system and gives an overview of their function and contents. 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 :term:`FILESPATH` in the specified order when looking for files and @@ -2494,7 +2927,7 @@ system and gives an overview of their function and contents. :term:`SRC_URI` statements. The default value for the :term:`FILESPATH` variable is defined in the - ``base.bbclass`` class found in ``meta/classes`` in the + :ref:`ref-classes-base` class found in ``meta/classes-global`` in the :term:`Source Directory`:: FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \ @@ -2537,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. @@ -2556,77 +2989,119 @@ system and gives an overview of their function and contents. 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 :term:`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 :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. @@ -2665,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. @@ -2679,13 +3168,79 @@ system and gives an overview of their function and contents. :term:`IMAGE_LINGUAS` appropriately. You can set :term:`GLIBC_GENERATE_LOCALES` in your ``local.conf`` file. - By default, all locales are generated. - :: + 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. @@ -2694,11 +3249,19 @@ system and gives an overview of their function and contents. GROUPADD_PARAM:${PN} = "-r netdev" + More than one group can be added by separating each set of different + groups' parameters with a semicolon. + + Here is an example adding multiple groups from the ``useradd-example.bb`` + file in the ``meta-skeleton`` layer:: + + GROUPADD_PARAM:${PN} = "-g 880 group1; -g 890 group2" + For information on the standard Linux shell command ``groupadd``, see https://linux.die.net/man/8/groupadd. :term:`GROUPMEMS_PARAM` - When inheriting the :ref:`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. @@ -2712,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` @@ -2721,7 +3284,7 @@ system and gives an overview of their function and contents. multiple options. The :term:`GRUB_OPTS` variable is optional. See the - :ref:`grub-efi <ref-classes-grub-efi>` class for more information + :ref:`ref-classes-grub-efi` class for more information on how this variable is used. :term:`GRUB_TIMEOUT` @@ -2729,16 +3292,18 @@ system and gives an overview of their function and contents. GNU GRand Unified Bootloader (GRUB). The :term:`GRUB_TIMEOUT` variable is optional. See the - :ref:`grub-efi <ref-classes-grub-efi>` class for more information + :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. @@ -2807,6 +3372,10 @@ 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 @@ -2827,14 +3396,20 @@ system and gives an overview of their function and contents. :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. :term:`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 @@ -2848,13 +3423,15 @@ system and gives an overview of their function and contents. :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 @@ -2883,75 +3460,31 @@ system and gives an overview of their function and contents. :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 @@ -2981,22 +3514,28 @@ 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 :term:`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 @@ -3011,8 +3550,8 @@ system and gives an overview of their function and contents. 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 @@ -3024,6 +3563,40 @@ system and gives an overview of their function and contents. 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 @@ -3040,7 +3613,7 @@ 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` @@ -3067,16 +3640,15 @@ system and gives an overview of their function and contents. :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 + through the :ref:`ref-classes-image` class. Use the :term:`IMAGE_INSTALL` variable with care to avoid ordering issues. Image recipes set :term:`IMAGE_INSTALL` to specify the packages to - install into an image through ``image.bbclass``. Additionally, - there are "helper" classes such as the - :ref:`core-image <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. + 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:: @@ -3093,26 +3665,26 @@ system and gives an overview of their function and contents. 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 + 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 initramfs, see the - ":ref:`dev-manual/common-tasks:building an initial ram filesystem (initramfs) image`" + For information on creating an :term:`Initramfs`, see the + ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section in the Yocto Project Development Tasks Manual. - Using :term:`IMAGE_INSTALL` with the - :ref:`+= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending (+=) and prepending (=+) with spaces>` + :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 :term:`IMAGE_INSTALL` to a default - value using the - :ref:`?= <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:setting a default value (?=)>` + 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 @@ -3139,11 +3711,34 @@ 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}" - IMAGE_LINK_NAME ?= "${IMAGE_BASENAME}-${MACHINE}" + .. note:: + It is possible to set this to "" to disable symlink creation, + however, you also need to set :term:`IMAGE_NAME` to still have + a reasonable value e.g.:: + + IMAGE_LINK_NAME = "" + IMAGE_NAME = "${IMAGE_BASENAME}${IMAGE_MACHINE_SUFFIX}${IMAGE_VERSION_SUFFIX}" + + :term:`IMAGE_MACHINE_SUFFIX` + Specifies the by default machine-specific suffix for image file names + (before the extension). The default value is set as follows:: + + IMAGE_MACHINE_SUFFIX ??= "-${MACHINE}" + + The default :term:`DEPLOY_DIR_IMAGE` already has a :term:`MACHINE` + subdirectory, so you may find it unnecessary to also include this suffix + in the name of every image file. If you prefer to remove the suffix you + can set this variable to an empty string:: + + IMAGE_MACHINE_SUFFIX = "" + + (Not to be confused with :term:`IMAGE_NAME_SUFFIX`.) :term:`IMAGE_MANIFEST` The manifest file for the image. This file lists all the installed @@ -3164,19 +3759,18 @@ system and gives an overview of their function and contents. 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 filename - 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 @@ -3209,19 +3803,11 @@ system and gives an overview of their function and contents. :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 ``package_tar`` class is broken and is not supported. It is - recommended that you do not use it. + the :ref:`ref-classes-package_deb`, :ref:`ref-classes-package_rpm`, + or :ref:`ref-classes-package_ipk` class. - The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and - :ref:`image <ref-classes-image>` classes use the :term:`IMAGE_PKGTYPE` - for packaging up images and SDKs. + The :ref:`ref-classes-populate-sdk-*` and :ref:`ref-classes-image` + classes use the :term:`IMAGE_PKGTYPE` for packaging up images and SDKs. You should not set the :term:`IMAGE_PKGTYPE` manually. Rather, the variable is set indirectly through the appropriate @@ -3239,9 +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 @@ -3252,9 +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 @@ -3318,7 +3904,7 @@ 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" @@ -3374,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 @@ -3385,106 +3971,84 @@ system and gives an overview of their function and contents. the build artifacts. :term:`IMGDEPLOYDIR` - When inheriting the :ref:`image <ref-classes-image>` class directly or - through the :ref:`core-image <ref-classes-core-image>` class, the + When inheriting the :ref:`ref-classes-image` class directly or + through the :ref:`ref-classes-core-image` class, the :term:`IMGDEPLOYDIR` points to a temporary work area for deployed files that is set in the ``image`` class as follows:: IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" - Recipes inheriting the ``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:`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 - :term:`INC_PR` variable inside the ``include`` files that the recipes - share and then expand the :term:`INC_PR` variable within the recipes to - help define the recipe revision. - - The following provides an example that shows how to use the - :term:`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 :term:`PR` values in each recipe. You - will notice that when you set a recipe's :term:`PR` you can provide more - granular revisioning by appending values to the :term:`INC_PR` variable:: - - recipes-graphics/xorg-font/xorg-font-common.inc:INC_PR = "r2" - recipes-graphics/xorg-font/encodings_1.0.4.bb:PR = "${INC_PR}.1" - recipes-graphics/xorg-font/font-util_1.3.0.bb:PR = "${INC_PR}.0" - recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" - - The - first line of the example establishes the baseline revision to be - used for all recipes that use the ``include`` file. The remaining - lines in the example are from individual recipes and show how the - :term:`PR` value is set. + 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:: - 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:: - - 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 :term:`INCOMPATIBLE_LICENSE` as:: - - INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}" - + :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:: - This will result in :term:`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 :term:`INHERIT` in individual recipes. + Classes inherited using :term:`INHERIT` must be located in the + ``classes-global/`` or ``classes/`` subdirectories. For more information on :term:`INHERIT`, see the - :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" - section in the Bitbake User Manual. + :ref:`bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" + section in the BitBake User Manual. :term:`INHERIT_DISTRO` Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable. + Classes specified in :term:`INHERIT_DISTRO` must be located in the + ``classes-global/`` or ``classes/`` subdirectories. + The default value of the variable is set as follows in the ``meta/conf/distro/defaultsetup.conf`` file:: - INHERIT_DISTRO ?= "debian devshell sstate license" + INHERIT_DISTRO ?= "debian devshell sstate license remove-libtool create-spdx" :term:`INHIBIT_DEFAULT_DEPS` Prevents the default dependencies, namely the C compiler and standard @@ -3529,10 +4093,9 @@ system and gives an overview of their function and contents. :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:: @@ -3542,30 +4105,65 @@ system and gives an overview of their function and contents. 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) + 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). @@ -3573,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 :term:`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 :term:`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 :term:`INITRAMFS_IMAGE` is empty, which is the default, then no - initramfs image is built. + :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` @@ -3599,37 +4197,36 @@ 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:: - Bundling the initramfs with the kernel conflates the code in the - initramfs with the GPLv2 licensed Linux kernel binary. Thus only GPLv2 - compatible software may be part of a bundled initramfs. + 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 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. + 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 :term:`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 + By default, the :ref:`ref-classes-kernel` class sets this variable to a null string as follows:: INITRAMFS_IMAGE_BUNDLE ?= "" @@ -3640,14 +4237,27 @@ system and gives an overview of their function and contents. 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 + set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows:: INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}" @@ -3661,24 +4271,32 @@ system and gives an overview of their function and contents. 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 + 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 :term:`INITRD` variable is an optional variable used with the - :ref:`image-live <ref-classes-image-live>` class. + :ref:`ref-classes-image-live` class. :term:`INITRD_IMAGE` When building a "live" bootable image (i.e. when @@ -3687,14 +4305,13 @@ system and gives an overview of their function and contents. 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` @@ -3702,7 +4319,7 @@ 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. @@ -3715,7 +4332,7 @@ 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 :term:`INITSCRIPT_PARAMS` is passed through to the ``update-rc.d`` command. For more information on valid parameters, @@ -3731,7 +4348,7 @@ system and gives an overview of their function and contents. 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` @@ -3776,24 +4393,23 @@ system and gives an overview of their function and contents. 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``. + ``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 :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. @@ -3809,9 +4425,9 @@ system and gives an overview of their function and contents. To use the variable, set it in the append file for your kernel recipe using the following form:: - KBUILD_DEFCONFIG_KMACHINE ?= defconfig_file + KBUILD_DEFCONFIG:<machine> ?= "defconfig_file" - Here is an example from a "raspberrypi2" :term:`KMACHINE` build that uses + Here is an example from a "raspberrypi2" :term:`MACHINE` build that uses a ``defconfig`` file named "bcm2709_defconfig":: KBUILD_DEFCONFIG:raspberrypi2 = "bcm2709_defconfig" @@ -3826,7 +4442,7 @@ system and gives an overview of their function and contents. section in the Yocto Project Linux Kernel Development Manual. :term:`KCONFIG_MODE` - When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>` + 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:: @@ -3862,11 +4478,10 @@ system and gives an overview of their function and contents. 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 @@ -3874,22 +4489,47 @@ system and gives an overview of their function and contents. variable. The value of :term:`KERNEL_ARTIFACT_NAME`, which is set in the - ``meta/classes/kernel-artifact-names.bbclass`` file, has 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. @@ -3900,13 +4540,22 @@ system and gives an overview of their function and contents. 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 + is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows:: KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" @@ -3922,24 +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 + 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. + + :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". - KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" + 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 @@ -3966,14 +4628,14 @@ system and gives an overview of their function and contents. 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`` + variable is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows:: KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}" @@ -3989,19 +4651,16 @@ 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`` + 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}" @@ -4029,15 +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 @@ -4045,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 :term:`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. @@ -4085,11 +4743,18 @@ 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. @@ -4101,9 +4766,8 @@ system and gives an overview of their function and contents. :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. @@ -4113,10 +4777,14 @@ system and gives an overview of their function and contents. 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. @@ -4126,7 +4794,7 @@ system and gives an overview of their function and contents. :term:`KERNELDEPMODDEPEND` does not control whether or not that data exists, but simply whether or not it is used. If you do not need to use the data, set the :term:`KERNELDEPMODDEPEND` variable in your - ``initramfs`` recipe. Setting the variable there when the data is not + :term:`Initramfs` recipe. Setting the variable there when the data is not needed avoids a potential dependency loop. :term:`KFEATURE_DESCRIPTION` @@ -4157,7 +4825,7 @@ system and gives an overview of their function and contents. 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}" + 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". @@ -4181,7 +4849,7 @@ 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` @@ -4206,6 +4874,9 @@ 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. @@ -4224,31 +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 :term:`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 :term:`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 @@ -4280,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. @@ -4296,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` @@ -4319,9 +4967,9 @@ system and gives an overview of their function and contents. 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 @@ -4336,8 +4984,8 @@ system and gives an overview of their function and contents. but has accompanying documentation licensed under the GNU Free Documentation License 1.2 could be specified as follows:: - LICENSE = "GFDL-1.2 & GPLv2" - LICENSE:${PN} = "GPLv2" + LICENSE = "GFDL-1.2 & GPL-2.0-only" + LICENSE:${PN} = "GPL-2.0.only" LICENSE:${PN}-doc = "GFDL-1.2" :term:`LICENSE_CREATE_PACKAGE` @@ -4360,30 +5008,46 @@ 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 :term:`COMMON_LICENSE_DIR` to define the @@ -4474,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. @@ -4617,19 +5280,27 @@ 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 :term:`MACHINE_FEATURES` if not also present in + 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 :term:`MACHINE_FEATURES_BACKFILL` that should not be - backfilled (i.e. added to :term:`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 @@ -4660,6 +5331,22 @@ system and gives an overview of their function and contents. :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`). @@ -4668,6 +5355,13 @@ 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 @@ -4676,32 +5370,31 @@ system and gives an overview of their function and contents. :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 :term:`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). + removed from a name (e.g. the :term:`BPN` variable). :term:`MLPREFIX` gets set when a prefix has been added to :term:`PN`. .. note:: - The "ML" in :term:`MLPREFIX` stands for "MultiLib". This representation is - historical and comes from a time when ``nativesdk`` was a suffix - rather than a prefix on the recipe name. When ``nativesdk`` was turned - into a prefix, it made sense to set :term:`MLPREFIX` for it as well. + 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 - ``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:: + :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" @@ -4724,7 +5417,7 @@ system and gives an overview of their function and contents. See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. :term:`module_conf` - Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`_ + Specifies `modprobe.d <https://linux.die.net/man/5/modprobe.d>`__ syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` file. @@ -4733,7 +5426,7 @@ 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:: @@ -4762,7 +5455,7 @@ 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}" @@ -4776,14 +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 @@ -4795,8 +5490,7 @@ system and gives an overview of their function and contents. ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} - Some classes (e.g. - :ref:`cross-canadian <ref-classes-cross-canadian>`) modify the + 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 @@ -4898,7 +5592,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 @@ -4906,11 +5600,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 @@ -4932,7 +5634,7 @@ system and gives an overview of their function and contents. 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 :term:`OE_TERMINAL` variable: @@ -4955,6 +5657,20 @@ system and gives an overview of their function and contents. 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 @@ -4965,6 +5681,89 @@ 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 @@ -4981,7 +5780,7 @@ system and gives an overview of their function and contents. 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. @@ -4999,7 +5798,7 @@ system and gives an overview of their function and contents. 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` @@ -5007,6 +5806,9 @@ system and gives an overview of their function and contents. ${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. @@ -5020,7 +5822,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` @@ -5062,15 +5864,9 @@ 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" - - .. note:: + variable:: - 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 @@ -5084,7 +5880,7 @@ 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 and package debug and source information @@ -5127,21 +5923,9 @@ system and gives an overview of their function and contents. use of the :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` variable. 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 + ":ref:`dev-manual/debugging:debugging with the gnu project debugger (gdb) remotely`" section in the Yocto Project Development Tasks Manual. - :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` - Prevents specific packages from being installed when you are - installing complementary packages. - - You might find that you want to prevent installing certain packages - when you are installing complementary packages. For example, if you - are using :term:`IMAGE_FEATURES` to install - ``dev-pkgs``, you might not want to install all packages from a - particular multilib. If you find yourself in this situation, you can - use the :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` variable to specify regular - expressions to match the packages you want to exclude. - :term:`PACKAGE_EXCLUDE` Lists packages that should not be installed into an image. For example:: @@ -5169,6 +5953,18 @@ system and gives an overview of their function and contents. :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 @@ -5186,8 +5982,8 @@ system and gives an overview of their function and contents. .. note:: You can use the :term:`PACKAGE_FEED_ARCHS` - variable to whitelist specific package architectures. If you do - not need to whitelist specific architectures, which is a common + 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. @@ -5284,9 +6080,9 @@ system and gives an overview of their function and contents. :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, + image. When working with an initial RAM filesystem (:term:`Initramfs`) image, use the :term:`PACKAGE_INSTALL` variable. 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:`PACKAGE_INSTALL_ATTEMPTONLY` @@ -5303,13 +6099,13 @@ 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 :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` @@ -5337,31 +6133,28 @@ system and gives an overview of their function and contents. 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 :term:`EXTRA_OECONF` or - :term:`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) :term:`PACKAGECONFIG` + #. Any conflicting (that is, mutually exclusive) :term:`PACKAGECONFIG` settings for this feature. Consider the following :term:`PACKAGECONFIG` block taken from the ``librsvg`` recipe. In this example the feature is ``gtk``, which has - three arguments that determine the feature's behavior. - :: + three arguments that determine the feature's behavior:: PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3" @@ -5402,20 +6195,51 @@ system and gives an overview of their function and contents. PACKAGECONFIG:append:pn-recipename = " f4" + Consider the following example of a :ref:`ref-classes-cmake` recipe with a systemd service + in which :term:`PACKAGECONFIG` is used to transform the systemd service + into a feature that can be easily enabled or disabled via :term:`PACKAGECONFIG`:: + + example.c + example.service + CMakeLists.txt + + The ``CMakeLists.txt`` file contains:: + + if(WITH_SYSTEMD) + install(FILES ${PROJECT_SOURCE_DIR}/example.service DESTINATION /etc/systemd/systemd) + endif(WITH_SYSTEMD) + + In order to enable the installation of ``example.service`` we need to + ensure that ``-DWITH_SYSTEMD=ON`` is passed to the ``cmake`` command + execution. Recipes that have ``CMakeLists.txt`` generally inherit the + :ref:`ref-classes-cmake` class, that runs ``cmake`` with + :term:`EXTRA_OECMAKE`, which :term:`PACKAGECONFIG_CONFARGS` will be + appended to. Now, knowing that :term:`PACKAGECONFIG_CONFARGS` is + automatically filled with either the first or second element of + :term:`PACKAGECONFIG` flag value, the recipe would be like:: + + inherit cmake + PACKAGECONFIG = "systemd" + PACKAGECONFIG[systemd] = "-DWITH_SYSTEMD=ON,-DWITH_SYSTEMD=OFF" + + A side note to this recipe is to check if ``systemd`` is in fact the used :term:`INIT_MANAGER` + or not:: + + PACKAGECONFIG = "${@'systemd' if d.getVar('INIT_MANAGER') == 'systemd' else ''}" + :term:`PACKAGECONFIG_CONFARGS` A space-separated list of configuration options generated from the :term:`PACKAGECONFIG` setting. - Classes such as :ref:`autotools <ref-classes-autotools>` and - :ref:`cmake <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 ``do_configure`` task, then you need to use + 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 + 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, @@ -5460,7 +6284,7 @@ system and gives an overview of their function and contents. 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` @@ -5474,17 +6298,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 :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. + 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. @@ -5492,10 +6319,10 @@ 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 :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 @@ -5505,27 +6332,28 @@ system and gives an overview of their function and contents. 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 :term:`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 + 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` @@ -5562,6 +6390,14 @@ system and gives an overview of their function and contents. :term:`PE` is the default value of the :term:`PKGE` variable. + :term:`PEP517_WHEEL_PATH` + When used by recipes that inherit the :ref:`ref-classes-python_pep517` + class, denotes the path to ``dist/`` (short for distribution) where the + binary archive ``wheel`` is built. + + :term:`PERSISTENT_DIR` + See :term:`bitbake:PERSISTENT_DIR` in the BitBake manual. + :term:`PF` Specifies the recipe or package name and includes all version and revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and @@ -5569,10 +6405,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. @@ -5584,9 +6421,8 @@ system and gives an overview of their function and contents. 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. @@ -5614,7 +6450,7 @@ system and gives an overview of their function and contents. 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`. @@ -5674,24 +6510,12 @@ system and gives an overview of their function and contents. 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 :term:`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 @@ -5701,9 +6525,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 @@ -5742,7 +6566,7 @@ system and gives an overview of their function and contents. 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` @@ -5759,13 +6583,13 @@ system and gives an overview of their function and contents. 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:: @@ -5776,6 +6600,9 @@ system and gives an overview of their function and contents. 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 @@ -5845,9 +6672,8 @@ system and gives an overview of their function and contents. source, and then locations specified by :term:`MIRRORS` in that order. - Assuming your distribution (:term:`DISTRO`) is "poky", - the default value for :term:`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 @@ -5855,10 +6681,10 @@ system and gives an overview of their function and contents. :term:`Build Directory`:: PREMIRRORS:prepend = "\ - git://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ - ftp://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ - http://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n \ - https://.*/.* &YOCTO_DL_URL;/mirror/sources/ \n" + 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 @@ -5922,7 +6748,7 @@ system and gives an overview of their function and contents. .. 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 @@ -5942,11 +6768,11 @@ 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:: @@ -5957,15 +6783,15 @@ 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 - :term:`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 + service <dev-manual/packages:working with a pr service>`. You can set :term:`PRSERV_HOST` to other values to use a remote PR service. @@ -5979,7 +6805,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 @@ -5995,37 +6821,45 @@ system and gives an overview of their function and contents. :term:`PV` is the default value of the :term:`PKGV` variable. + :term:`PYPI_PACKAGE` + When inheriting the :ref:`ref-classes-pypi` class, specifies the + `PyPI <https://pypi.org/>`__ package name to be built. The default value + is set based upon :term:`BPN` (stripping any "python-" or "python3-" + prefix off if present), however for some packages it will need to be set + explicitly if that will not match the package name (e.g. where the + package name has a prefix, underscores, uppercase letters etc.) + :term:`PYTHON_ABI` - When used by recipes that inherit the - :ref:`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. - :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, :term:`PYTHON_PN` would - be "python3". You do not have to set this variable as the - OpenEmbedded build system automatically sets it for you. + The default :term:`QA_EMPTY_DIRS` value is set in + :ref:`insane.bbclass <ref-classes-insane>`. - The variable allows recipes to use common infrastructure such as the - following:: + :term:`QA_EMPTY_DIRS_RECOMMENDATION` + Specifies a recommendation for why a directory must be empty, + which will be included in the error message if a specific directory + is found to contain files. Must be overridden with the directory + path to match on. + + If no recommendation is specified for a directory, then the default + "but it is expected to be empty" will be used. - DEPENDS += "${PYTHON_PN}-native" + An example message shows if files were present in '/dev':: - In the previous example, - the version of the dependency is :term:`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``. @@ -6079,7 +6913,7 @@ system and gives an overview of their function and contents. 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 @@ -6091,11 +6925,11 @@ system and gives an overview of their function and contents. 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 :term:`RDEPENDS` must be the - names of other packages - they cannot be recipe names. Although + names of other packages --- they cannot be recipe names. Although package names and recipe names usually match, the important point here is that you are providing package names within the :term:`RDEPENDS` variable. For an example of the default list of packages created from @@ -6126,7 +6960,7 @@ system and gives an overview of their function and contents. 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 :term:`RDEPENDS`, which makes sense as :term:`RDEPENDS` is meant to be independent of the package format used. @@ -6159,12 +6993,27 @@ system and gives an overview of their function and contents. RDEPENDS:${PN} = "foo (>= 1.2)" - For information on build-time dependencies, see the - :term:`DEPENDS` variable. You can also see the - ":ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:tasks`" and - ":ref:`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, @@ -6173,9 +7022,41 @@ system and gives an overview of their function and contents. 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 @@ -6196,10 +7077,9 @@ 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 @@ -6229,14 +7109,14 @@ system and gives an overview of their function and contents. Indicates a filesystem image to include as the root filesystem. The :term:`ROOTFS` variable is an optional variable used with the - :ref:`image-live <ref-classes-image-live>` class. + :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 @@ -6247,9 +7127,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 @@ -6262,9 +7142,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 @@ -6275,9 +7155,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 @@ -6285,6 +7165,9 @@ 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 @@ -6335,7 +7218,7 @@ system and gives an overview of their function and contents. In the example, the package name (``${PN}-dev``) must appear as it would in the :term:`PACKAGES` namespace before any renaming of the output package - by classes such as ``debian.bbclass``. + by classes such as :ref:`ref-classes-debian`. BitBake, which the OpenEmbedded build system uses, supports specifying versioned recommends. Although the syntax varies depending @@ -6402,6 +7285,11 @@ system and gives an overview of their function and contents. RSUGGESTS:${PN} = "useful_package another_package" + :term:`RUST_CHANNEL` + Specifies which version of Rust to build - "stable", "beta" or "nightly". + The default value is "stable". Set this at your own risk, as values other + than "stable" are not guaranteed to work at a given time. + :term:`S` The location in the :term:`Build Directory` where unpacked recipe source code resides. By default, this directory is @@ -6414,7 +7302,7 @@ system and gives an overview of their function and contents. 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:: @@ -6428,7 +7316,7 @@ system and gives an overview of their function and contents. 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` @@ -6452,16 +7340,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 :term:`SDK_CUSTOM_TEMPLATECONF` is set to - "1" and a ``conf/templateconf.conf`` file exists in the build directory + "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 - :term:`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" @@ -6533,76 +7434,17 @@ system and gives an overview of their function and contents. :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if :term:`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, :term:`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:`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. - :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 @@ -6633,7 +7475,9 @@ system and gives an overview of their function and contents. :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 @@ -6641,7 +7485,8 @@ 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 + 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}-". @@ -6650,10 +7495,10 @@ 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 :term:`SDK_RECRDEP_TASKS` variable, the above four tasks are always added @@ -6713,6 +7558,10 @@ system and gives an overview of their function and contents. 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 @@ -6732,6 +7581,11 @@ 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` @@ -6756,25 +7610,27 @@ system and gives an overview of their function and contents. $ bitbake -c populate_sdk imagename :term:`SDKMACHINE` - The machine for which the SDK is built. In other words, the SDK is - built such that it runs on the target you specify with the - :term:`SDKMACHINE` value. The value points to a corresponding ``.conf`` - file under ``conf/machine-sdk/``. - - 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 :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 @@ -6784,7 +7640,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 @@ -6799,43 +7655,34 @@ system and gives an overview of their function and contents. :term:`FULL_OPTIMIZATION` unless :term:`DEBUG_BUILD` = "1", in which case the value of :term:`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 :term:`SERIAL_CONSOLE` variable is deprecated. Please use the - :term:`SERIAL_CONSOLES` variable. - :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). Note that :term:`SERIAL_CONSOLES_CHECK` also requires - ``/etc/inittab`` to be writable when used with SysVinit. This makes it - incompatible with customizations such as the following:: + :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:: - EXTRA_IMAGE_FEATURES += "read-only-rootfs" + 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 @@ -6893,15 +7740,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:: @@ -6925,6 +7784,23 @@ system and gives an overview of their function and contents. You will see this variable referenced in the default values of ``FILES:${PN}-dev``. + :term:`SOURCE_DATE_EPOCH` + This defines a date expressed in number of seconds since + the UNIX EPOCH (01 Jan 1970 00:00:00 UTC), which is used by + multiple build systems to force a timestamp in built binaries. + Many upstream projects already support this variable. + + You will find more details in the `official specifications + <https://reproducible-builds.org/specs/source-date-epoch/>`__. + + A value for each recipe is computed from the sources by + :oe_git:`meta/lib/oe/reproducible.py </openembedded-core/tree/meta/lib/oe/reproducible.py>`. + + If a recipe wishes to override the default behavior, it should set its + own :term:`SOURCE_DATE_EPOCH` value:: + + SOURCE_DATE_EPOCH = "1613559011" + :term:`SOURCE_MIRROR_FETCH` When you are fetching files to create a mirror of sources (i.e. creating a source mirror), setting :term:`SOURCE_MIRROR_FETCH` to "1" in @@ -6949,7 +7825,7 @@ 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 + :ref:`ref-classes-own-mirrors` class and then provide the URL to your mirrors. Here is the general syntax:: INHERIT += "own-mirrors" @@ -6959,6 +7835,119 @@ system and gives an overview of their function and contents. You can specify only a single URL in :term:`SOURCE_MIRROR_URL`. + :term:`SPDX_ARCHIVE_PACKAGED` + This option allows to add to :term:`SPDX` output compressed archives + of the files in the generated target packages. + + Such archives are available in + ``tmp/deploy/spdx/MACHINE/packages/packagename.tar.zst`` + under the :term:`Build Directory`. + + Enable this option as follows:: + + SPDX_ARCHIVE_PACKAGED = "1" + + According to our tests on release 4.1 "langdale", building + ``core-image-minimal`` for the ``qemux86-64`` machine, enabling this + option multiplied the size of the ``tmp/deploy/spdx`` directory by a + factor of 13 (+1.6 GiB for this image), compared to just using the + :ref:`ref-classes-create-spdx` class with no option. + + Note that this option doesn't increase the size of :term:`SPDX` + files in ``tmp/deploy/images/MACHINE``. + + :term:`SPDX_ARCHIVE_SOURCES` + This option allows to add to :term:`SPDX` output compressed archives + of the sources for packages installed on the target. It currently + only works when :term:`SPDX_INCLUDE_SOURCES` is set. + + This is one way of fulfilling "source code access" license + requirements. + + Such source archives are available in + ``tmp/deploy/spdx/MACHINE/recipes/recipe-packagename.tar.zst`` + under the :term:`Build Directory`. + + Enable this option as follows:: + + SPDX_INCLUDE_SOURCES = "1" + SPDX_ARCHIVE_SOURCES = "1" + + According to our tests on release 4.1 "langdale", building + ``core-image-minimal`` for the ``qemux86-64`` machine, enabling + these options multiplied the size of the ``tmp/deploy/spdx`` + directory by a factor of 11 (+1.4 GiB for this image), + compared to just using the :ref:`ref-classes-create-spdx` + class with no option. + + Note that using this option only marginally increases the size + of the :term:`SPDX` output in ``tmp/deploy/images/MACHINE/`` + (+ 0.07\% with the tested image), compared to just enabling + :term:`SPDX_INCLUDE_SOURCES`. + + :term:`SPDX_CUSTOM_ANNOTATION_VARS` + This option allows to associate `SPDX annotations + <https://spdx.github.io/spdx-spec/v2.3/annotations/>`__ to a recipe, + using the values of variables in the recipe:: + + ANNOTATION1 = "First annotation for recipe" + ANNOTATION2 = "Second annotation for recipe" + SPDX_CUSTOM_ANNOTATION_VARS = "ANNOTATION1 ANNOTATION2" + + This will add a new block to the recipe ``.sdpx.json`` output:: + + "annotations": [ + { + "annotationDate": "2023-04-18T08:32:12Z", + "annotationType": "OTHER", + "annotator": "Tool: oe-spdx-creator - 1.0", + "comment": "ANNOTATION1=First annotation for recipe" + }, + { + "annotationDate": "2023-04-18T08:32:12Z", + "annotationType": "OTHER", + "annotator": "Tool: oe-spdx-creator - 1.0", + "comment": "ANNOTATION2=Second annotation for recipe" + } + ], + + :term:`SPDX_INCLUDE_SOURCES` + This option allows to add a description of the source files used to build + the host tools and the target packages, to the ``spdx.json`` files in + ``tmp/deploy/spdx/MACHINE/recipes/`` under the :term:`Build Directory`. + As a consequence, the ``spdx.json`` files under the ``by-namespace`` and + ``packages`` subdirectories in ``tmp/deploy/spdx/MACHINE`` are also + modified to include references to such source file descriptions. + + Enable this option as follows:: + + SPDX_INCLUDE_SOURCES = "1" + + According to our tests on release 4.1 "langdale", building + ``core-image-minimal`` for the ``qemux86-64`` machine, enabling + this option multiplied the total size of the ``tmp/deploy/spdx`` + directory by a factor of 3 (+291 MiB for this image), + and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in + ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this + image), compared to just using the :ref:`ref-classes-create-spdx` class + with no option. + + :term:`SPDX_NAMESPACE_PREFIX` + This option could be used in order to change the prefix of ``spdxDocument`` + and the prefix of ``documentNamespace``. It is set by default to + ``http://spdx.org/spdxdoc``. + + :term:`SPDX_PRETTY` + This option makes the SPDX output more human-readable, using + identation and newlines, instead of the default output in a + single line:: + + SPDX_PRETTY = "1" + + The generated SPDX files are approximately 20% bigger, but + this option is recommended if you want to inspect the SPDX + output files with a text editor. + :term:`SPDXLICENSEMAP` Maps commonly used license names to their SPDX counterparts found in ``meta/files/common-licenses/``. For the default :term:`SPDXLICENSEMAP` @@ -6996,163 +7985,123 @@ system and gives an overview of their function and contents. 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 :term:`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:`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. - 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_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. - - ``bzr://`` - Fetches files from a Bazaar revision control - repository. + :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. - - ``git://`` - Fetches files from a Git 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``. - - ``osc://`` - Fetches files from an OSC (openSUSE Build service) - 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``. - - ``repo://`` - Fetches files from a repo (Git) repository. + :term:`SPLASH_IMAGES` + This variable, used by the ``psplash`` recipe, allows to customize + the default splashscreen image. - - ``ccrc://`` - Fetches files from a ClearCase 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. - - ``http://`` - Fetches files from the Internet using ``http``. + 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:: - - ``https://`` - Fetches files from the Internet using ``https``. + meta-acme/recipes-core/psplash + ├── files + │  └── logo-acme.png + └── psplash_%.bbappend - - ``ftp://`` - Fetches files from the Internet using ``ftp``. + And here are the contents of the ``psplash_%.bbappend`` file in + this example:: - - ``cvs://`` - Fetches files from a CVS revision control - repository. + SPLASH_IMAGES = "file://logo-acme.png;outsuffix=default" + FILESEXTRAPATHS:prepend := "${THISDIR}/files:" - - ``hg://`` - Fetches files from a Mercurial (``hg``) revision - control repository. + You could even add specific configuration options for ``psplash``, + for example:: - - ``p4://`` - Fetches files from a Perforce (``p4``) revision - control repository. + EXTRA_OECONF += "--disable-startup-msg --enable-img-fullscreen" - - ``ssh://`` - Fetches files from a secure shell. + For information on append files, see the + ":ref:`dev-manual/layers:appending other layers metadata with your layer`" + section. - - ``svn://`` - Fetches files from a Subversion (``svn``) revision - control repository. + :term:`SRCREV_FORMAT` + See :term:`bitbake:SRCREV_FORMAT` in the BitBake manual. - - ``npm://`` - Fetches JavaScript modules from a registry. + :term:`SRC_URI` + + 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. - There are standard and recipe-specific options for :term:`SRC_URI`. Here are - standard ones: + 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 :term:`SRCDATE` is not later + - ``maxdate`` --- apply the patch only if :term:`SRCDATE` is not later than ``maxdate``. - - ``minrev`` - Apply the patch only if :term:`SRCREV` is equal to or + - ``minrev`` --- apply the patch only if :term:`SRCREV` is equal to or greater than ``minrev``. - - ``maxrev`` - Apply the patch only if :term:`SRCREV` is not later + - ``maxrev`` --- apply the patch only if :term:`SRCREV` is not later than ``maxrev``. - - ``rev`` - Apply the patch only if :term:`SRCREV` is equal to + - ``rev`` --- apply the patch only if :term:`SRCREV` is equal to ``rev``. - - ``notrev`` - Apply the patch only if :term:`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 :term:`WORKDIR` when the local (``file://``) - fetcher is used. - - - ``localdir`` - Places the file (or extracts its contents) into - the specified subdirectory of :term:`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 - :term:`SRC_URI` checksums or :term:`SRCREV` when you have more than one - file or git repository specified in :term:`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 @@ -7188,27 +8137,27 @@ system and gives an overview of their function and contents. that if you want to build a fixed revision and you want to avoid performing a query on the remote repository every time BitBake parses your recipe, you should specify a :term:`SRCREV` that is a full revision - identifier and not just a tag. + identifier (e.g. the full SHA hash in git) and not just a tag. .. note:: For information on limitations when inheriting the latest revision of software using :term:`SRCREV`, see the :term:`AUTOREV` variable description and the - ":ref:`dev-manual/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:`externalsrc <ref-classes-externalsrc>` + 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:`kernel-yocto <ref-classes-kernel-yocto>` - class file (formatted for aesthetics):: + defined in the :ref:`ref-classes-kernel-yocto` class file (formatted for + aesthetics):: SRCTREECOVEREDTASKS += "\ do_validate_branches \ @@ -7225,6 +8174,32 @@ system and gives an overview of their function and contents. :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 @@ -7250,23 +8225,31 @@ system and gives an overview of their function and contents. a different GCC version for native builds, you must configure :term:`SSTATE_MIRRORS` with a regular expression that maps local search paths to server paths. The paths need to take into account - :term:`NATIVELSBSTRING` set by the - :ref:`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 @@ -7280,11 +8263,9 @@ system and gives an overview of their function and contents. 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 @@ -7353,7 +8334,7 @@ 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, :term:`STAGING_DIR_HOST` can have the following values: @@ -7385,20 +8366,25 @@ system and gives an overview of their function and contents. for ``-native`` recipes, as they make use of host headers and libraries. + Check :term:`RECIPE_SYSROOT` and :term:`RECIPE_SYSROOT_NATIVE`. + :term:`STAGING_DIR_NATIVE` Specifies the path to the sysroot directory used when building components that run on the build host itself. + The default value is ``"${RECIPE_SYSROOT_NATIVE}"``, + check :term:`RECIPE_SYSROOT_NATIVE`. + :term:`STAGING_DIR_TARGET` Specifies the path to the sysroot used for the system for which the component generates code. For components that do not generate code, which is the majority, :term:`STAGING_DIR_TARGET` is set to match :term:`STAGING_DIR_HOST`. - Some recipes build binaries that can run on the target system but - those binaries in turn generate code for another different system - (e.g. 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 :term:`STAGING_DIR_HOST` variable points to the sysroot used @@ -7463,6 +8449,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``. @@ -7489,7 +8478,7 @@ system and gives an overview of their function and contents. 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` @@ -7497,14 +8486,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" @@ -7512,8 +8501,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" @@ -7523,7 +8512,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. @@ -7547,14 +8536,14 @@ system and gives an overview of their function and contents. /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:: - SYSROOT_DIRS_BLACKLIST = " \ + SYSROOT_DIRS_IGNORE = " \ ${mandir} \ ${docdir} \ ${infodir} \ @@ -7570,6 +8559,35 @@ system and gives an overview of their function and contents. ${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 @@ -7599,12 +8617,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" @@ -7614,10 +8632,10 @@ system and gives an overview of their function and contents. When :term:`EFI_PROVIDER` is set to "systemd-boot", the :term:`SYSTEMD_BOOT_CFG` variable specifies the configuration file that should be used. By default, the - :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the + :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/>`__. @@ -7626,9 +8644,8 @@ system and gives an overview of their function and contents. When :term:`EFI_PROVIDER` is set to "systemd-boot", the :term:`SYSTEMD_BOOT_ENTRIES` variable specifies a list of entry files (``*.conf``) to install that contain one boot - entry per file. By default, the - :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the - :term:`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 ?= "" @@ -7639,7 +8656,7 @@ system and gives an overview of their function and contents. When :term:`EFI_PROVIDER` is set to "systemd-boot", the :term:`SYSTEMD_BOOT_TIMEOUT` variable specifies the boot menu timeout in seconds. By default, the - :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the + :ref:`ref-classes-systemd-boot` class sets the :term:`SYSTEMD_BOOT_TIMEOUT` as follows:: SYSTEMD_BOOT_TIMEOUT ?= "10" @@ -7647,8 +8664,25 @@ system and gives an overview of their function and contents. 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 :term:`SYSTEMD_PACKAGES` variable is set such that the systemd unit files are assumed to @@ -7661,22 +8695,26 @@ system and gives an overview of their function and contents. 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:: 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 :term:`SYSVINIT_ENABLED_GETTYS` is "1" (i.e. only run a getty on the first virtual terminal). @@ -7775,6 +8813,10 @@ system and gives an overview of their function and contents. 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 @@ -7818,8 +8860,8 @@ system and gives an overview of their function and contents. - For native recipes, the build system sets the variable to the value of :term:`BUILD_PREFIX`. - - For native SDK recipes (``nativesdk``), the build system sets the - variable to the value of :term:`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 @@ -7848,18 +8890,16 @@ 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 :term:`TCLIBCAPPEND` is "-${TCLIBC}". However, distros such as poky, @@ -7880,12 +8920,10 @@ system and gives an overview of their function and contents. 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. + 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``) @@ -7898,16 +8936,41 @@ 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 @@ -7955,7 +9018,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` @@ -8010,8 +9073,7 @@ system and gives an overview of their function and contents. Alternatively, you can provide the "auto" option to have all applicable tests run against - the image. - :: + the image:: TEST_SUITES:append = " auto" @@ -8028,7 +9090,7 @@ system and gives an overview of their function and contents. 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` @@ -8047,7 +9109,7 @@ system and gives an overview of their function and contents. 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. @@ -8063,7 +9125,7 @@ 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` @@ -8100,9 +9162,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 @@ -8126,7 +9188,7 @@ system and gives an overview of their function and contents. #TMPDIR = "${TOPDIR}/tmp" An example use for this scenario is to set :term:`TMPDIR` to a local disk, - which does not use NFS, while having the Build Directory use NFS. + which does not use NFS, while having the :term:`Build Directory` use NFS. The filesystem used by :term:`TMPDIR` must have standard filesystem semantics (i.e. mixed-case files are unique, POSIX file locking, and @@ -8159,7 +9221,7 @@ system and gives an overview of their function and contents. :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 + in which case the :term:`TOOLCHAIN_HOST_TASK_ESDK` setting should be used instead. :term:`TOOLCHAIN_HOST_TASK_ESDK` @@ -8167,6 +9229,16 @@ system and gives an overview of their function and contents. 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 @@ -8197,9 +9269,7 @@ 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 @@ -8317,40 +9387,6 @@ system and gives an overview of their function and contents. 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 :term:`TUNEABI`, - :term:`TUNEABI_OVERRIDE`, and - :term:`TUNEABI_WHITELIST` variables to check - compatibility of tunings against their selection of libraries. - - If :term:`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 - :term:`TUNEABI_OVERRIDE`, :term:`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 - :term:`TUNEABI_WHITELIST` is not set, all tunes are allowed. Providers - that use prebuilt libraries can use the :term:`TUNEABI_WHITELIST`, - :term:`TUNEABI_OVERRIDE`, 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:`TUNECONFLICTS[feature]` Specifies CPU or Application Binary Interface (ABI) tuning features that conflict with feature. @@ -8375,51 +9411,152 @@ system and gives an overview of their function and contents. 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 - :term:`UBOOT_MACHINE`. The "sd" configuration defines - "mx6qsabreauto_config" as the value for :term:`UBOOT_MACHINE`, while the - "sdcard" specifies the :term:`IMAGE_FSTYPES` to use for the U-Boot image. + :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:`uboot-config <ref-classes-uboot-config>` - class. + :ref:`ref-classes-uboot-config` class. :term:`UBOOT_DTB_LOADADDRESS` Specifies the load address for the dtb image used by U-Boot. During FIT image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in - :ref:`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. + :ref:`ref-classes-kernel-fitimage` class to specify the load address to be + used in creating the dtb sections of Image Tree Source for the FIT image. :term:`UBOOT_DTBO_LOADADDRESS` Specifies the load address for the dtbo image used by U-Boot. During FIT image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in - :ref:`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. + :ref:`ref-classes-kernel-fitimage` class to specify the load address to be + used in creating the dtbo sections of Image Tree Source for the FIT image. :term:`UBOOT_ENTRYPOINT` Specifies the entry point for the U-Boot image. During U-Boot image creation, the :term:`UBOOT_ENTRYPOINT` variable is passed as a command-line parameter to the ``uboot-mkimage`` utility. + To pass a 64 bit address for FIT image creation, you will need to set: + - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. + - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. + + This variable is used by the :ref:`ref-classes-kernel-fitimage`, + :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, + :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` + classes. + + :term:`UBOOT_FIT_ADDRESS_CELLS` + Specifies the value of the ``#address-cells`` value for the + description of the U-Boot FIT image. + + The default value is set to "1" by the :ref:`ref-classes-uboot-sign` + class, which corresponds to 32 bit addresses. + + For platforms that need to set 64 bit addresses in + :term:`UBOOT_LOADADDRESS` and :term:`UBOOT_ENTRYPOINT`, you need to + set this value to "2", as two 32 bit values (cells) will be needed + to represent such addresses. + + Here is an example setting "0x400000000" as a load address:: + + UBOOT_FIT_ADDRESS_CELLS = "2" + UBOOT_LOADADDRESS= "0x04 0x00000000" + + See `more details about #address-cells <https://elinux.org/Device_Tree_Usage#How_Addressing_Works>`__. + + :term:`UBOOT_FIT_DESC` + Specifies the description string encoded into a U-Boot fitImage. The default + value is set by the :ref:`ref-classes-uboot-sign` class as follows:: + + UBOOT_FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" + + :term:`UBOOT_FIT_GENERATE_KEYS` + Decides whether to generate the keys for signing the U-Boot fitImage if + they don't already exist. The keys are created in :term:`SPL_SIGN_KEYDIR`. + The default value is "0". + + Enable this as follows:: + + UBOOT_FIT_GENERATE_KEYS = "1" + + This variable is used in the :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FIT_HASH_ALG` + Specifies the hash algorithm used in creating the U-Boot FIT Image. + It is set by default to ``sha256`` by the :ref:`ref-classes-uboot-sign` + class. + + :term:`UBOOT_FIT_KEY_GENRSA_ARGS` + Arguments to ``openssl genrsa`` for generating a RSA private key for + signing the U-Boot FIT image. The default value of this variable + is set to "-F4" by the :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FIT_KEY_REQ_ARGS` + Arguments to ``openssl req`` for generating a certificate for signing + the U-Boot FIT image. The default value is "-batch -new" by the + :ref:`ref-classes-uboot-sign` class, "batch" for + non interactive mode and "new" for generating new keys. + + :term:`UBOOT_FIT_KEY_SIGN_PKCS` + Format for the public key certificate used for signing the U-Boot FIT + image. The default value is set to "x509" by the + :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FIT_SIGN_ALG` + Specifies the signature algorithm used in creating the U-Boot FIT Image. + This variable is set by default to "rsa2048" by the + :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FIT_SIGN_NUMBITS` + Size of the private key used in signing the U-Boot FIT image, in number + of bits. The default value for this variable is set to "2048" + by the :ref:`ref-classes-uboot-sign` class. + + :term:`UBOOT_FITIMAGE_ENABLE` + This variable allows to generate a FIT image for U-Boot, which is one + of the ways to implement a verified boot process. + + Its default value is "0", so set it to "1" to enable this functionality:: + + UBOOT_FITIMAGE_ENABLE = "1" + + See the :ref:`ref-classes-uboot-sign` class for details. + :term:`UBOOT_LOADADDRESS` Specifies the load address for the U-Boot image. During U-Boot image creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a command-line parameter to the ``uboot-mkimage`` utility. + To pass a 64 bit address, you will also need to set: + + - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. + - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. + + This variable is used by the :ref:`ref-classes-kernel-fitimage`, + :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, + :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` + classes. + :term:`UBOOT_LOCALVERSION` Appends a string to the name of the local version of the U-Boot image. For example, assuming the version of the U-Boot image built @@ -8443,56 +9580,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 :term:`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 - :term:`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 - :term:`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`` @@ -8507,7 +9653,7 @@ 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 @@ -8517,16 +9663,16 @@ system and gives an overview of their function and contents. 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_WHITELIST`. + For these cases, the options are added to :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`. The configure arguments check that uses - :term:`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:`UPDATERCPN` For recipes inheriting the - :ref:`update-rc.d <ref-classes-update-rc.d>` class, :term:`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 @@ -8540,8 +9686,7 @@ system and gives an overview of their function and contents. 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`). - :: + by the recipe (:term:`SRCREV`):: UPSTREAM_CHECK_COMMITS = "1" @@ -8554,8 +9699,7 @@ system and gives an overview of their function and contents. 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" @@ -8563,8 +9707,7 @@ system and gives an overview of their function and contents. 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" @@ -8575,8 +9718,7 @@ system and gives an overview of their function and contents. determined by fetching the directory listing where the tarball is and attempting to find a later tarball. When this approach does not work, you can use :term:`UPSTREAM_CHECK_URI` to provide a different URI that - contains the link to the latest tarball. - :: + contains the link to the latest tarball:: UPSTREAM_CHECK_URI = "recipe_url" @@ -8587,8 +9729,7 @@ system and gives an overview of their function and contents. :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. - :: + to acknowledge that the check cannot be performed:: UPSTREAM_VERSION_UNKNOWN = "1" @@ -8598,16 +9739,15 @@ system and gives an overview of their function and contents. 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 :term:`USE_VT` is "1" when no default value is @@ -8618,15 +9758,24 @@ system and gives an overview of their function and contents. :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-prelink``, and so forth). + OpenEmbedded build system to enable extra features. + + Classes inherited using :term:`USER_CLASSES` must be located in the + ``classes-global/`` or ``classes/`` subdirectories. The default list is set in your ``local.conf`` file:: - USER_CLASSES ?= "buildstats image-prelink" + 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 @@ -8682,7 +9831,7 @@ 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. @@ -8699,7 +9848,7 @@ system and gives an overview of their function and contents. :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. @@ -8753,6 +9902,33 @@ 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. @@ -8761,19 +9937,40 @@ system and gives an overview of their function and contents. 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, 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. @@ -8793,7 +9990,7 @@ system and gives an overview of their function and contents. 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" @@ -8801,6 +9998,19 @@ 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 @@ -8816,13 +10026,13 @@ 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 @@ -8839,4 +10049,35 @@ system and gives an overview of their function and contents. 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: |
